fix(deps): update dependency @openzeppelin/contracts-4.5.0 to v5 #3344

renovate · 2024-10-28T15:52:00Z

This PR contains the following updates:

Package	Change	Age	Adoption	Passing	Confidence
@openzeppelin/contracts-4.5.0 (source)	`4.5.0` -> `5.1.0`

Warning

Some dependencies could not be looked up. Check the Dependency Dashboard for more information.

Release Notes

OpenZeppelin/openzeppelin-contracts (@openzeppelin/contracts-4.5.0)

`v5.1.0`

Compare Source

Breaking changes

ERC1967Utils: Removed duplicate declaration of the Upgraded, AdminChanged and BeaconUpgraded events. These events are still available through the IERC1967 interface located under the contracts/interfaces/ directory. Minimum pragma version is now 0.8.21.
Governor, GovernorCountingSimple: The _countVote virtual function now returns an uint256 with the total votes casted. This change allows for more flexibility for partial and fractional voting. Upgrading users may get a compilation error that can be fixed by adding a return statement to the _countVote function.

Custom error changes

This version comes with changes to the custom error identifiers. Contracts previously depending on the following errors should be replaced accordingly:

Replace Address.FailedInnerCall with Errors.FailedCall
Replace Address.AddressInsufficientBalance with Errors.InsufficientBalance
Replace Clones.Create2InsufficientBalance with Errors.InsufficientBalance
Replace Clones.ERC1167FailedCreateClone with Errors.FailedDeployment
Replace Clones.Create2FailedDeployment with Errors.FailedDeployment
SafeERC20: Replace Address.AddressEmptyCode with SafeERC20FailedOperation if there is no code at the token's address.
SafeERC20: Replace generic Error(string) with SafeERC20FailedOperation if the returned data can't be decoded as bool.
SafeERC20: Replace generic SafeERC20FailedOperation with the revert message from the contract call if it fails.

Changes by category

General

AccessManager, VestingWallet, TimelockController and ERC2771Forwarder: Added a public initializer function in their corresponding upgradeable variants. (#5008)

Access

AccessControlEnumerable: Add a getRoleMembers method to return all accounts that have role. (#4546)
AccessManager: Allow the onlyAuthorized modifier to restrict functions added to the manager. (#5014)

Finance

VestingWalletCliff: Add an extension of the VestingWallet contract with an added cliff. (#4870)

Governance

GovernorCountingFractional: Add a governor counting module that allows distributing voting power amongst 3 options (For, Against, Abstain). (#5045)
Votes: Set _moveDelegateVotes visibility to internal instead of private. (#5007)

Proxy

Clones: Add version of clone and cloneDeterministic that support sending value at creation. (#4936)
TransparentUpgradeableProxy: Make internal _proxyAdmin() getter have view visibility. (#4688)
ProxyAdmin: Fixed documentation for UPGRADE_INTERFACE_VERSION getter. (#5031)

Tokens

ERC1363: Add implementation of the token payable standard allowing execution of contract code after transfers and approvals. (#4631)
ERC20TemporaryApproval: Add an ERC-20 extension that implements temporary approval using transient storage, based on ERC7674 (draft). (#5071)
SafeERC20: Add "relaxed" function for interacting with ERC-1363 functions in a way that is compatible with EOAs. (#4631)
SafeERC20: Document risks of safeIncreaseAllowance and safeDecreaseAllowance when associated with ERC-7674. (#5262)
ERC721Utils and ERC1155Utils: Add reusable libraries with functions to perform acceptance checks on IERC721Receiver and IERC1155Receiver implementers. (#4845)
ERC1363Utils: Add helper similar to the existing ERC721Utils and ERC1155Utils. (#5133)

Utils

Arrays: add a sort functions for address[], bytes32[] and uint256[] memory arrays. (#4846)
Arrays: add new functions lowerBound, upperBound, lowerBoundMemory and upperBoundMemory for lookups in sorted arrays with potential duplicates. (#4842)
Arrays: deprecate findUpperBound in favor of the new lowerBound. (#4842)
Base64: Add encodeURL following section 5 of RFC4648 for URL encoding (#4822)
Comparator: A library of comparator functions, useful for customizing the behavior of the Heap structure. (#5084)
Create2: Bubbles up returndata from a deployed contract that reverted during construction. (#5052)
Create2, Clones: Mask computeAddress and cloneDeterministic outputs to produce a clean value for an address type (i.e. only use 20 bytes) (#4941)
Errors: New library of common custom errors. (#4936)
Hashes: A library with commonly used hash functions. (#3617)
Packing: Added a new utility for packing, extracting and replacing bytesXX values. (#4992)
Panic: Add a library for reverting with panic codes. (#3298)
ReentrancyGuardTransient: Added a variant of ReentrancyGuard that uses transient storage. (#4988)
Strings: Added a utility function for converting an address to checksummed string. (#5067)
SlotDerivation: Add a library of methods for derivating common storage slots. (#4975)
TransientSlot: Add primitives for operating on the transient storage space using a typed-slot representation. (#4980)

Cryptography

SignatureChecker: refactor isValidSignatureNow to avoid validating ECDSA signatures if there is code deployed at the signer's address. (#4951)
MerkleProof: Add variations of verify, processProof, multiProofVerify and processMultiProof (and equivalent calldata version) with support for custom hashing functions. (#4887)
P256: Library for verification and public key recovery of P256 (aka secp256r1) signatures. (#4881)
RSA: Library to verify signatures according to RFC 8017 Signature Verification Operation (#4952)

Math

Math: add an invMod function to get the modular multiplicative inverse of a number in Z/nZ. (#4839)
Math: Add modExp function that exposes the EIP-198 precompile. Includes uint256 and bytes memory versions. (#3298)
Math: Custom errors replaced with native panic codes. (#3298)
Math, SignedMath: Add a branchless ternary function that computescond ? a : b in constant gas cost. (#4976)
SafeCast: Add toUint(bool) for operating on bool values as uint256. (#4878)

Structures

CircularBuffer: Add a data structure that stores the last N values pushed to it. (#4913)
DoubleEndedQueue: Custom errors replaced with native panic codes. (#4872)
EnumerableMap: add UintToBytes32Map, AddressToAddressMap, AddressToBytes32Map and Bytes32ToAddressMap. (#4843)
Heap: A data structure that implements a heap-based priority queue. (#5084)
MerkleTree: A data structure that allows inserting elements into a merkle tree and updating its root hash. (#3617)

`v5.0.2`

Compare Source

Base64: Fix issue where dirty memory located just after the input buffer is affecting the result. (#4926)

`v5.0.1`

Compare Source

ERC2771Context and Context: Introduce a _contextPrefixLength() getter, used to trim extra information appended to msg.data.
Multicall: Make aware of non-canonical context (i.e. msg.sender is not _msgSender()), allowing compatibility with ERC2771Context.

`v5.0.0`

Compare Source

Additions Summary

The following contracts and libraries were added:

AccessManager: A consolidated system for managing access control in complex systems.
- AccessManaged: A module for connecting a contract to an authority in charge of its access control.
- GovernorTimelockAccess: An adapter for time-locking governance proposals using an AccessManager.
- AuthorityUtils: A library of utilities for interacting with authority contracts.
GovernorStorage: A Governor module that stores proposal details in storage.
ERC2771Forwarder: An ERC2771 forwarder for meta transactions.
ERC1967Utils: A library with ERC1967 events, errors and getters.
Nonces: An abstraction for managing account nonces.
MessageHashUtils: A library for producing digests for ECDSA operations.
Time: A library with helpers for manipulating time-related objects.

Removals Summary

The following contracts, libraries, and functions were removed:

Address.isContract (because of its ambiguous nature and potential for misuse)
Checkpoints.History
Counters
ERC20Snapshot
ERC20VotesComp
ERC165Storage (in favor of inheritance based approach)
ERC777
ERC1820Implementer
GovernorVotesComp
GovernorProposalThreshold (deprecated since 4.4)
PaymentSplitter
PullPayment
SafeMath
SignedSafeMath
Timers
TokenTimelock (in favor of VestingWallet)
All escrow contracts (Escrow, ConditionalEscrow and RefundEscrow)
All cross-chain contracts, including AccessControlCrossChain and all the vendored bridge interfaces
All presets in favor of OpenZeppelin Contracts Wizard

These removals were implemented in the following PRs: #3637, #3880, #3945, #4258, #4276, #4289

Changes by category

General

Replaced revert strings and require statements with custom errors. (#4261)
Bumped minimum compiler version required to 0.8.20 (#4288, #4489)
Use of abi.encodeCall in place of abi.encodeWithSelector and abi.encodeWithSignature for improved type-checking of parameters (#4293)
Replaced some uses of abi.encodePacked with clearer alternatives (e.g. bytes.concat, string.concat). (#4504) (#4296)
Overrides are now used internally for a number of functions that were previously hardcoded to their default implementation in certain locations: ERC1155Supply.totalSupply, ERC721.ownerOf, ERC721.balanceOf and ERC721.totalSupply in ERC721Enumerable, ERC20.totalSupply in ERC20FlashMint, and ERC1967._getImplementation in ERC1967Proxy. (#4299)
Removed the override specifier from functions that only override a single interface function. (#4315)
Switched to using explicit Solidity import statements. Some previously available symbols may now have to be separately imported. (#4399)
Governor, Initializable, and UUPSUpgradeable: Use internal functions in modifiers to optimize bytecode size. (#4472)
Upgradeable contracts now use namespaced storage (EIP-7201). (#4534)
Upgradeable contracts no longer transpile interfaces and libraries. (#4628)

Access

Ownable: Added an initialOwner parameter to the constructor, making the ownership initialization explicit. (#4267)
Ownable: Prevent using address(0) as the initial owner. (#4531)
AccessControl: Added a boolean return value to the internal _grantRole and _revokeRole functions indicating whether the role was granted or revoked. (#4241)
access: Moved AccessControl extensions to a dedicated directory. (#4359)
AccessManager: Added a new contract for managing access control of complex systems in a consolidated location. (#4121)
AccessManager, AccessManaged, GovernorTimelockAccess: Ensure that calldata shorter than 4 bytes is not padded to 4 bytes. (#4624)
AccessManager: Use named return parameters in functions that return multiple values. (#4624)
AccessManager: Make schedule and execute more conservative when delay is 0. (#4644)

Finance

VestingWallet: Fixed revert during 1 second time window when duration is 0. (#4502)
VestingWallet: Use Ownable instead of an immutable beneficiary. (#4508)

Governance

Governor: Optimized use of storage for proposal data (#4268)
Governor: Added validation in ERC1155 and ERC721 receiver hooks to ensure Governor is the executor. (#4314)
Governor: Refactored internals to implement common queuing logic in the core module of the Governor. Added queue and _queueOperations functions that act at different levels. Modules that implement queuing via timelocks are expected to override _queueOperations to implement the timelock-specific logic. Added _executeOperations as the equivalent for execution. (#4360)
Governor: Added voter and nonce parameters in signed ballots, to avoid forging signatures for random addresses, prevent signature replay, and allow invalidating signatures. Add voter as a new parameter in the castVoteBySig and castVoteWithReasonAndParamsBySig functions. (#4378)
Governor: Added support for casting votes with ERC-1271 signatures by using a bytes memory signature instead of r, s and v arguments in the castVoteBySig and castVoteWithReasonAndParamsBySig functions. (#4418)
Governor: Added a mechanism to restrict the address of the proposer using a suffix in the description.
GovernorStorage: Added a new governor extension that stores the proposal details in storage, with an interface that operates on proposalId, as well as proposal enumerability. This replaces the old GovernorCompatibilityBravo module. (#4360)
GovernorTimelockAccess: Added a module to connect a governor with an instance of AccessManager, allowing the governor to make calls that are delay-restricted by the manager using the normal queue workflow. (#4523)
GovernorTimelockControl: Clean up timelock id on execution for gas refund. (#4118)
GovernorTimelockControl: Added the Governor instance address as part of the TimelockController operation salt to avoid operation id collisions between governors using the same TimelockController. (#4432)
TimelockController: Changed the role architecture to use DEFAULT_ADMIN_ROLE as the admin for all roles, instead of the bespoke TIMELOCK_ADMIN_ROLE that was used previously. This aligns with the general recommendation for AccessControl and makes the addition of new roles easier. Accordingly, the admin parameter and timelock will now be granted DEFAULT_ADMIN_ROLE instead of TIMELOCK_ADMIN_ROLE. (#3799)
TimelockController: Added a state getter that returns an OperationState enum. (#4358)
Votes: Use Trace208 for checkpoints. This enables EIP-6372 clock support for keys but reduces the max supported voting power to uint208. (#4539)

Metatx

ERC2771Forwarder: Added deadline for expiring transactions, batching, and more secure handling of msg.value. (#4346)
ERC2771Context: Return the forwarder address whenever the msg.data of a call originating from a trusted forwarder is not long enough to contain the request signer address (i.e. msg.data.length is less than 20 bytes), as specified by ERC-2771. (#4481)
ERC2771Context: Prevent revert in _msgData() when a call originating from a trusted forwarder is not long enough to contain the request signer address (i.e. msg.data.length is less than 20 bytes). Return the full calldata in that case. (#4484)

Proxy

ProxyAdmin: Removed getProxyAdmin and getProxyImplementation getters. (#3820)
TransparentUpgradeableProxy: Removed admin and implementation getters, which were only callable by the proxy owner and thus not very useful. (#3820)
ERC1967Utils: Refactored the ERC1967Upgrade abstract contract as a library. (#4325)
TransparentUpgradeableProxy: Admin is now stored in an immutable variable (set during construction) to avoid unnecessary storage reads on every proxy call. This removed the ability to ever change the admin. Transfer of the upgrade capability is exclusively handled through the ownership of the ProxyAdmin. (#4354)
Moved the logic to validate ERC-1822 during an upgrade from ERC1967Utils to UUPSUpgradeable. (#4356)
UUPSUpgradeable, TransparentUpgradeableProxy and ProxyAdmin: Removed upgradeTo and upgrade functions, and made upgradeToAndCall and upgradeAndCall ignore the data argument if it is empty. It is no longer possible to invoke the receive function (or send value with empty data) along with an upgrade. (#4382)
BeaconProxy: Reject value in initialization unless a payable function is explicitly invoked. (#4382)
Proxy: Removed redundant receive function. (#4434)
BeaconProxy: Use an immutable variable to store the address of the beacon. It is no longer possible for a BeaconProxy to upgrade by changing to another beacon. (#4435)
Initializable: Use the namespaced storage pattern to avoid putting critical variables in slot 0. Allow reinitializer versions greater than 256. (#4460)
Initializable: Use intermediate variables to improve readability. (#4576)

Token

ERC20, ERC721, ERC1155: Deleted _beforeTokenTransfer and _afterTokenTransfer hooks, added a new internal _update function for customizations, and refactored all extensions using those hooks to use _update instead. (#3838, #3876, #4377)
ERC20: Removed Approval event previously emitted in transferFrom to indicate that part of the allowance was consumed. With this change, allowances are no longer reconstructible from events. See the code for guidelines on how to re-enable this event if needed. (#4370)
ERC20: Removed the non-standard increaseAllowance and decreaseAllowance functions. (#4585)
ERC20Votes: Changed internal vote accounting to reusable Votes module previously used by ERC721Votes. Removed implicit ERC20Permit inheritance. Note that the DOMAIN_SEPARATOR getter was previously guaranteed to be available for ERC20Votes contracts, but is no longer available unless ERC20Permit is explicitly used; ERC-5267 support is included in ERC20Votes with EIP712 and is recommended as an alternative. (#3816)
SafeERC20: Refactored safeDecreaseAllowance and safeIncreaseAllowance to support USDT-like tokens. (#4260)
SafeERC20: Removed safePermit in favor of documentation-only permit recommendations. Based on recommendations from @trust1995 (#4582)
ERC721: _approve no longer allows approving the owner of the tokenId. (#4377) _setApprovalForAll no longer allows setting address(0) as an operator. (#4377)
ERC721: Renamed _requireMinted to _requireOwned and added a return value with the current owner. Implemented ownerOf in terms of _requireOwned. (#4566)
ERC721Consecutive: Added a _firstConsecutiveId internal function that can be overridden to change the id of the first token minted through _mintConsecutive. (#4097)
ERC721URIStorage: Allow setting the token URI prior to minting. (#4559)
ERC721URIStorage, ERC721Royalty: Stop resetting token-specific URI and royalties when burning. (#4561)
ERC1155: Optimized array allocation. (#4196)
ERC1155: Removed check for address zero in balanceOf. (#4263)
ERC1155: Optimized array accesses by skipping bounds checking when unnecessary. (#4300)
ERC1155: Bubble errors triggered in the onERC1155Received and onERC1155BatchReceived hooks. (#4314)
ERC1155Supply: Added a totalSupply() function that returns the total amount of token circulating, this change will restrict the total tokens minted across all ids to 2**256-1 . (#3962)
ERC1155Receiver: Removed in favor of ERC1155Holder. (#4450)

Utils

Address: Removed the ability to customize error messages. A common custom error is always used if the underlying revert reason cannot be bubbled up. (#4502)
Arrays: Added unsafeMemoryAccess helpers to read from a memory array without checking the length. (#4300)
Arrays: Optimized findUpperBound by removing redundant SLOAD. (#4442)
Checkpoints: Library moved from utils to utils/structs (#4275)
DoubleEndedQueue: Refactored internal structure to use uint128 instead of int128. This has no effect on the library interface. (#4150)
ECDSA: Use unchecked arithmetic for the tryRecover function that receives the r and vs short-signature fields separately. (#4301)
EIP712: Added internal getters for the name and version strings (#4303)
Math: Makes ceilDiv to revert on 0 division even if the numerator is 0 (#4348)
Math: Optimized stack operations in mulDiv. (#4494)
Math: Renamed members of Rounding enum, and added a new rounding mode for "away from zero". (#4455)
MerkleProof: Use custom error to report invalid multiproof instead of reverting with overflow panic. (#4564)
MessageHashUtils: Added a new library for creating message digest to be used along with signing or recovery such as ECDSA or ERC-1271. These functions are moved from the ECDSA library. (#4430)
Nonces: Added a new contract to keep track of user nonces. Used for signatures in ERC20Permit, ERC20Votes, and ERC721Votes. (#3816)
ReentrancyGuard, Pausable: Moved to utils directory. (#4551)
Strings: Renamed toString(int256) to toStringSigned(int256). (#4330)
Optimized Strings.equal (#4262)

How to migrate from 4.x

ERC20, ERC721, and ERC1155

These breaking changes will require modifications to ERC20, ERC721, and ERC1155 contracts, since the _afterTokenTransfer and _beforeTokenTransfer functions were removed. Thus, any customization made through those hooks should now be done overriding the new _update function instead.

Minting and burning are implemented by _update and customizations should be done by overriding this function as well. _transfer, _mint and _burn are no longer virtual (meaning they are not overridable) to guard against possible inconsistencies.

For example, a contract using ERC20's _beforeTokenTransfer hook would have to be changed in the following way.

-function _beforeTokenTransfer(
+function _update(
   address from,
   address to,
   uint256 amount
 ) internal virtual override {
-  super._beforeTokenTransfer(from, to, amount);
   require(!condition(), "ERC20: wrong condition");
+  super._update(from, to, amount);
 }

More about ERC721

In the case of ERC721, the _update function does not include a from parameter, as the sender is implicitly the previous owner of the tokenId. The address of this previous owner is returned by the _update function, so it can be used for a posteriori checks. In addition to to and tokenId, a third parameter (auth) is present in this function. This parameter enabled an optional check that the caller/spender is approved to do the transfer. This check cannot be performed after the transfer (because the transfer resets the approval), and doing it before _update would require a duplicate call to _ownerOf.

In this logic of removing hidden SLOADs, the _isApprovedOrOwner function was removed in favor of a new _isAuthorized function. Overrides that used to target the _isApprovedOrOwner should now be performed on the _isAuthorized function. Calls to _isApprovedOrOwner that preceded a call to _transfer, _burn or _approve should be removed in favor of using the auth argument in _update and _approve. This is showcased in ERC721Burnable.burn and in ERC721Wrapper.withdrawTo.

The _exists function was removed. Calls to this function can be replaced by _ownerOf(tokenId) != address(0).

More about ERC1155

Batch transfers will now emit TransferSingle if the batch consists of a single token, while in previous versions the TransferBatch event would be used for all transfers initiated through safeBatchTransferFrom. Both behaviors are compliant with the ERC-1155 specification.

ERC165Storage

Users that were registering EIP-165 interfaces with _registerInterface from ERC165Storage should instead do so by overriding the supportsInterface function as seen below:

function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
  return interfaceId == type(MyInterface).interfaceId || super.supportsInterface(interfaceId);
}

SafeMath

Methods in SafeMath superseded by native overflow checks in Solidity 0.8.0 were removed along with operations providing an interface for revert strings. The remaining methods were moved to utils/Math.sol.

- import "@&#8203;openzeppelin/contracts/utils/math/SafeMath.sol";
+ import "@&#8203;openzeppelin/contracts/utils/math/Math.sol";

 function tryOperations(uint256 x, uint256 y) external view {
-  (bool overflowsAdd, uint256 resultAdd) = SafeMath.tryAdd(x, y);
+  (bool overflowsAdd, uint256 resultAdd) = Math.tryAdd(x, y);
-  (bool overflowsSub, uint256 resultSub) = SafeMath.trySub(x, y);
+  (bool overflowsSub, uint256 resultSub) = Math.trySub(x, y);
-  (bool overflowsMul, uint256 resultMul) = SafeMath.tryMul(x, y);
+  (bool overflowsMul, uint256 resultMul) = Math.tryMul(x, y);
-  (bool overflowsDiv, uint256 resultDiv) = SafeMath.tryDiv(x, y);
+  (bool overflowsDiv, uint256 resultDiv) = Math.tryDiv(x, y);
   // ...
 }

Adapting Governor modules

Custom Governor modules that override internal functions may require modifications if migrated to v5. In particular, the new internal functions _queueOperations and _executeOperations may need to be used. If assistance with this migration is needed reach out via the OpenZeppelin Support Forum.

ECDSA and MessageHashUtils

The ECDSA library is now focused on signer recovery. Previously it also included utility methods for producing digests to be used with signing or recovery. These utilities have been moved to the MessageHashUtils library and should be imported if needed:

 import {ECDSA} from "@&#8203;openzeppelin/contracts/utils/cryptography/ECDSA.sol";
+import {MessageHashUtils} from "@&#8203;openzeppelin/contracts/utils/cryptography/MessageHashUtils.sol";

 contract Verifier {
   using ECDSA for bytes32;
+  using MessageHashUtils for bytes32;

   function _verify(bytes32 data, bytes memory signature, address account) internal pure returns (bool) {
     return data
       .toEthSignedMessageHash()
       .recover(signature) == account;
   }
 }

Interfaces and libraries in upgradeable contracts

The upgradeable version of the contracts library used to include a variant suffixed with Upgradeable for every contract. These variants, which are produced automatically, mainly include changes for dealing with storage that don't apply to libraries and interfaces.

The upgradeable library no longer includes upgradeable variants for libraries and interfaces. Projects migrating to 5.0 should replace their library and interface imports with their corresponding non-upgradeable version:

 // Libraries
-import {AddressUpgradeable} from '@&#8203;openzeppelin/contracts-upgradeable/utils/AddressUpgradeable.sol';
+import {Address} from '@&#8203;openzeppelin/contracts/utils/Address.sol';

 // Interfaces
-import {IERC20Upgradeable} from '@&#8203;openzeppelin/contracts-upgradeable/interfaces/IERC20.sol';
+import {IERC20} from '@&#8203;openzeppelin/contracts/interfaces/IERC20.sol';

Offchain Considerations

Some changes may affect offchain systems if they rely on assumptions that are changed along with these new breaking changes. These cases are:

Relying on revert strings for processing errors

A concrete example is AccessControl, where it was previously advised to catch revert reasons using the following regex:

/^AccessControl: account (0x[0-9a-f]{40}) is missing role (0x[0-9a-f]{64})$/

Instead, contracts now revert with custom errors. Systems that interact with smart contracts outside of the network should consider reliance on revert strings and possibly support the new custom errors.

Relying on storage locations for retrieving data

After 5.0, the storage location of some variables were changed. This is the case for Initializable and all the upgradeable contracts since they now use namespaced storaged locations. Any system relying on storage locations for retrieving data or detecting capabilities should be updated to support these new locations.

`v4.9.6`

Compare Source

Base64: Fix issue where dirty memory located just after the input buffer is affecting the result. (#4929)

`v4.9.5`

Compare Source

Multicall: Make aware of non-canonical context (i.e. msg.sender is not _msgSender()), allowing compatibility with ERC2771Context. Patch duplicated Address.functionDelegateCall in v4.9.4 (removed).

`v4.9.4`

Compare Source

ERC2771Context and Context: Introduce a _contextPrefixLength() getter, used to trim extra information appended to msg.data.
Multicall: Make aware of non-canonical context (i.e. msg.sender is not _msgSender()), allowing compatibility with ERC2771Context.

`v4.9.3`

Compare Source

Note
This release contains a fix for GHSA-g4vp-m682-qqmp.

ERC2771Context: Return the forwarder address whenever the msg.data of a call originating from a trusted forwarder is not long enough to contain the request signer address (i.e. msg.data.length is less than 20 bytes), as specified by ERC-2771. (#4481)
ERC2771Context: Prevent revert in _msgData() when a call originating from a trusted forwarder is not long enough to contain the request signer address (i.e. msg.data.length is less than 20 bytes). Return the full calldata in that case. (#4484)

`v4.9.2`

Compare Source

MerkleProof: Fix a bug in processMultiProof and processMultiProofCalldata that allows proving arbitrary leaves if the tree contains a node with value 0 at depth 1.

`v4.9.1`

Compare Source

Governor: Add a mechanism to restrict the address of the proposer using a suffix in the description.

`v4.9.0`

Compare Source

ReentrancyGuard: Add a _reentrancyGuardEntered function to expose the guard status. (#3714)
ERC721Wrapper: add a new extension of the ERC721 token which wraps an underlying token. Deposit and withdraw guarantee that the ownership of each token is backed by a corresponding underlying token with the same identifier. (#3863)
EnumerableMap: add a keys() function that returns an array containing all the keys. (#3920)
Governor: add a public cancel(uint256) function. (#3983)
Governor: Enable timestamp operation for blockchains without a stable block time. This is achieved by connecting a Governor's internal clock to match a voting token's EIP-6372 interface. (#3934)
Strings: add equal method. (#3774)
IERC5313: Add an interface for EIP-5313 that is now final. (#4013)
IERC4906: Add an interface for ERC-4906 that is now Final. (#4012)
StorageSlot: Add support for string and bytes. (#4008)
Votes, ERC20Votes, ERC721Votes: support timestamp checkpointing using EIP-6372. (#3934)
ERC4626: Add mitigation to the inflation attack through virtual shares and assets. (#3979)
Strings: add toString method for signed integers. (#3773)
ERC20Wrapper: Make the underlying variable private and add a public accessor. (#4029)
EIP712: add EIP-5267 support for better domain discovery. (#3969)
AccessControlDefaultAdminRules: Add an extension of AccessControl with additional security rules for the DEFAULT_ADMIN_ROLE. (#4009)
SignatureChecker: Add isValidERC1271SignatureNow for checking a signature directly against a smart contract using ERC-1271. (#3932)
SafeERC20: Add a forceApprove function to improve compatibility with tokens behaving like USDT. (#4067)
ERC1967Upgrade: removed contract-wide oz-upgrades-unsafe-allow delegatecall annotation, replaced by granular annotation in UUPSUpgradeable. (#3971)
ERC20Wrapper: self wrapping and deposit by the wrapper itself are now explicitly forbidden. (#4100)
ECDSA: optimize bytes32 computation by using assembly instead of abi.encodePacked. (#3853)
ERC721URIStorage: Emit ERC-4906 MetadataUpdate in _setTokenURI. (#4012)
ShortStrings: Added a library for handling short strings in a gas efficient way, with fallback to storage for longer strings. (#4023)
SignatureChecker: Allow return data length greater than 32 from EIP-1271 signers. (#4038)
UUPSUpgradeable: added granular oz-upgrades-unsafe-allow-reachable annotation to improve upgrade safety checks on latest version of the Upgrades Plugins (starting with @openzeppelin/[email protected]). (#3971)
Initializable: optimize _disableInitializers by using != instead of <. (#3787)
Ownable2Step: make acceptOwnership public virtual to enable usecases that require overriding it. (#3960)
UUPSUpgradeable.sol: Change visibility to the functions upgradeTo and upgradeToAndCall from external to public. (#3959)
TimelockController: Add the CallSalt event to emit on operation schedule. (#4001)
Reformatted codebase with latest version of Prettier Solidity. (#3898)
Math: optimize log256 rounding check. (#3745)
ERC20Votes: optimize by using unchecked arithmetic. (#3748)
Multicall: annotate multicall function as upgrade safe to not raise a flag for its delegatecall. (#3961)
ERC20Pausable, ERC721Pausable, ERC1155Pausable: Add note regarding missing public pausing functionality (#4007)
ECDSA: Add a function toDataWithIntendedValidatorHash that encodes data with version 0x00 following EIP-191. (#4063)
MerkleProof: optimize by using unchecked arithmetic. (#3745)

Breaking changes

EIP712: Addition of ERC5267 support requires support for user defined value types, which was released in Solidity version 0.8.8. This requires a pragma change from ^0.8.0 to ^0.8.8.
EIP712: Optimization of the cache for the upgradeable version affects the way name and version are set. This is no longer done through an initializer, and is instead part of the implementation's constructor. As a consequence, all proxies using the same implementation will necessarily share the same name and version. Additionally, an implementation upgrade risks changing the EIP712 domain unless the same name and version are used when deploying the new implementation contract.

Deprecations

ERC20Permit: Added the file IERC20Permit.sol and ERC20Permit.sol and deprecated draft-IERC20Permit.sol and draft-ERC20Permit.sol since EIP-2612 is no longer a Draft. Developers are encouraged to update their imports. (#3793)
Timers: The Timers library is now deprecated and will be removed in the next major release. (#4062)
ERC777: The ERC777 token standard is no longer supported by OpenZeppelin. Our implementation is now deprecated and will be removed in the next major release. The corresponding standard interfaces remain available. (#4066)
ERC1820Implementer: The ERC1820 pseudo-introspection mechanism is no longer supported by OpenZeppelin. Our implementation is now deprecated and will be removed in the next major release. The corresponding standard interfaces remain available. (#4066)

`v4.8.3`

Compare Source

GovernorCompatibilityBravo: Fix encoding of proposal data when signatures are missing.
TransparentUpgradeableProxy: Fix transparency in case of selector clash with non-decodable calldata or payable mutability. (#4154)

`v4.8.2`

Compare Source

ERC721Consecutive: Fixed a bug when _mintConsecutive is used for batches of size 1 that could lead to balance overflow. Refer to the breaking changes section in the changelog for a note on the behavior of ERC721._beforeTokenTransfer.

Breaking changes

ERC721: The internal function _beforeTokenTransfer no longer updates balances, which it previously did when batchSize was greater than 1. This change has no consequence unless a custom ERC721 extension is explicitly invoking _beforeTokenTransfer. Balance updates in extensions must now be done explicitly using __unsafe_increaseBalance, with a name that indicates that there is an invariant that has to be manually verified.

`v4.8.1`

Compare Source

ERC4626: Use staticcall instead of call when fetching underlying ERC-20 decimals. (#3943)

`v4.8.0`

Compare Source

TimelockController: Added a new admin constructor parameter that is assigned the admin role instead of the deployer account. (#3722)
Initializable: add internal functions _getInitializedVersion and _isInitializing (#3598)
ERC165Checker: add supportsERC165InterfaceUnchecked for consulting individual interfaces without the full ERC165 protocol. (#3339)
Address: optimize functionCall by calling functionCallWithValue directly. (#3468)
Address: optimize functionCall functions by checking contract size only if there is no returned data. (#3469)
Governor: make the relay function payable, and add support for EOA payments. (#3730)
GovernorCompatibilityBravo: remove unused using statements. (#3506)
ERC20: optimize _transfer, _mint and _burn by using unchecked arithmetic when possible. (#3513)
ERC20Votes, ERC721Votes: optimize getPastVotes for looking up recent checkpoints. (#3673)
ERC20FlashMint: add an internal _flashFee function for overriding. (#3551)
ERC4626: use the same decimals() as the underlying asset by default (if available). (#3639)
ERC4626: add internal _initialConvertToShares and _initialConvertToAssets functions to customize empty vaults behavior. (#3639)
ERC721: optimize transfers by making approval clearing implicit instead of emitting an event. (#3481)
ERC721: optimize burn by making approval clearing implicit instead of emitting an event. (#3538)
ERC721: Fix balance accounting when a custom _beforeTokenTransfer hook results in a transfer of the token under consideration. (#3611)
ERC721: use unchecked arithmetic for balance updates. (#3524)
ERC721Consecutive: Implementation of EIP-2309 that allows batch minting of ERC721 tokens during construction. (#3311)
ReentrancyGuard: Reduce code size impact of the modifier by using internal functions. (#3515)
SafeCast: optimize downcasting of signed integers. (#3565)
ECDSA: Remove redundant che

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

coderabbitai · 2024-10-28T15:52:08Z

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

| datasource | package | from | to | | ---------- | ----------------------- | ----- | ----- | | npm | @openzeppelin/contracts | 4.5.0 | 5.1.0 | Signed-off-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

cloudflare-workers-and-pages · 2024-10-28T15:56:48Z

Deploying sanguine-fe with Cloudflare Pages

Latest commit:	`b04dcd7`
Status:	✅ Deploy successful!
Preview URL:	https://afbbf824.sanguine-fe.pages.dev
Branch Preview URL:	https://renovate-contracts-rfq-openz-ihfs.sanguine-fe.pages.dev

View logs

codecov · 2024-10-28T16:06:45Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 34.25005%. Comparing base (5a12fed) to head (b04dcd7).
Report is 4 commits behind head on master.

Additional details and impacted files

@@                 Coverage Diff                 @@
##              master       #3344         +/-   ##
===================================================
+ Coverage   33.23174%   34.25005%   +1.01830%     
===================================================
  Files            543         523         -20     
  Lines          34780       33489       -1291     
  Branches          82          82                 
===================================================
- Hits           11558       11470         -88     
+ Misses         22198       20998       -1200     
+ Partials        1024        1021          -3

Flag	Coverage Δ
packages	`90.44834% <ø> (ø)`
promexporter	`?`

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

renovate · 2024-10-28T16:33:52Z

Renovate Ignore Notification

Because you closed this PR without merging, Renovate will ignore this update. You will not get PRs for any future 5.x releases. But if you manually upgrade to 5.x then Renovate will re-enable minor and patch updates automatically.

If you accidentally closed this PR, or if you changed your mind: rename this PR to get a fresh replacement PR.

renovate bot added the dependencies label Oct 28, 2024

renovate bot assigned abtestingalpha, bigboydiamonds, ChiTimesChi and trajan0x Oct 28, 2024

github-actions bot added M-deps size/xs labels Oct 28, 2024

renovate bot force-pushed the renovate/contracts-rfq-openzeppelin-contracts-4.5.0-5.x branch from 5f00869 to b04dcd7 Compare October 28, 2024 15:56

ChiTimesChi closed this Oct 28, 2024

github-actions bot deleted the renovate/contracts-rfq-openzeppelin-contracts-4.5.0-5.x branch October 28, 2024 16:30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(deps): update dependency @openzeppelin/contracts-4.5.0 to v5 #3344

fix(deps): update dependency @openzeppelin/contracts-4.5.0 to v5 #3344

renovate bot commented Oct 28, 2024

coderabbitai bot commented Oct 28, 2024

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

cloudflare-workers-and-pages bot commented Oct 28, 2024 •

edited

Loading

codecov bot commented Oct 28, 2024 •

edited

Loading

renovate bot commented Oct 28, 2024

fix(deps): update dependency @openzeppelin/contracts-4.5.0 to v5 #3344

fix(deps): update dependency @openzeppelin/contracts-4.5.0 to v5 #3344

Conversation

renovate bot commented Oct 28, 2024

Release Notes

Breaking changes

Custom error changes

Changes by category

General

Access

Finance

Governance

Proxy

Tokens

Utils

Cryptography

Math

Structures

Additions Summary

Removals Summary

Changes by category

General

Access

Finance

Governance

Metatx

Proxy

Token

Utils

How to migrate from 4.x

ERC20, ERC721, and ERC1155

More about ERC721

More about ERC1155

ERC165Storage

SafeMath

Adapting Governor modules

ECDSA and MessageHashUtils

Interfaces and libraries in upgradeable contracts

Offchain Considerations

Relying on revert strings for processing errors

Relying on storage locations for retrieving data

Breaking changes

Deprecations

Breaking changes

Configuration

coderabbitai bot commented Oct 28, 2024

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

cloudflare-workers-and-pages bot commented Oct 28, 2024 • edited Loading

Deploying sanguine-fe with Cloudflare Pages

codecov bot commented Oct 28, 2024 • edited Loading

Codecov Report

renovate bot commented Oct 28, 2024

Renovate Ignore Notification

cloudflare-workers-and-pages bot commented Oct 28, 2024 •

edited

Loading

codecov bot commented Oct 28, 2024 •

edited

Loading