[Snyk] Upgrade @openzeppelin/contracts from 5.0.0 to 5.1.0 #5
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Snyk has created this PR to upgrade @openzeppelin/contracts from 5.0.0 to 5.1.0. See this package in npm: @openzeppelin/contracts See this project in Snyk: https://app.snyk.io/org/doperiddle/project/e6eeea92-015c-4201-84a4-6c294c68c1a6?utm_source=github&utm_medium=referral&page=upgrade-pr
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Snyk has created this PR to upgrade @openzeppelin/contracts from 5.0.0 to 5.1.0.
ℹ️ Keep your dependencies up-to-date. This makes it easier to fix existing vulnerabilities and to more quickly identify and fix newly disclosed vulnerabilities when they affect your project.
The recommended version is 5 versions ahead of your current version.
The recommended version was released on 23 days ago.
Issues fixed by the recommended upgrade:
SNYK-JS-OPENZEPPELINCONTRACTS-6346765
Release notes
Package name: @openzeppelin/contracts
Breaking changes
ERC1967Utils: Removed duplicate declaration of theUpgraded,AdminChangedandBeaconUpgradedevents. These events are still available through theIERC1967interface located under thecontracts/interfaces/directory. Minimum pragma version is now 0.8.21.Governor,GovernorCountingSimple: The_countVotevirtual function now returns anuint256with 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_countVotefunction.Custom error changes
This version comes with changes to the custom error identifiers. Contracts previously depending on the following errors should be replaced accordingly:
Address.FailedInnerCallwithErrors.FailedCallAddress.AddressInsufficientBalancewithErrors.InsufficientBalanceClones.Create2InsufficientBalancewithErrors.InsufficientBalanceClones.ERC1167FailedCreateClonewithErrors.FailedDeploymentClones.Create2FailedDeploymentwithErrors.FailedDeploymentSafeERC20: ReplaceAddress.AddressEmptyCodewithSafeERC20FailedOperationif there is no code at the token's address.SafeERC20: Replace genericError(string)withSafeERC20FailedOperationif the returned data can't be decoded asbool.SafeERC20: Replace genericSafeERC20FailedOperationwith the revert message from the contract call if it fails.Changes by category
General
AccessManager,VestingWallet,TimelockControllerandERC2771Forwarder: Added a publicinitializerfunction in their corresponding upgradeable variants. (#5008)Access
AccessControlEnumerable: Add agetRoleMembersmethod to return all accounts that haverole. (#4546)AccessManager: Allow theonlyAuthorizedmodifier to restrict functions added to the manager. (#5014)Finance
VestingWalletCliff: Add an extension of theVestingWalletcontract 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_moveDelegateVotesvisibility to internal instead of private. (#5007)Proxy
Clones: Add version ofcloneandcloneDeterministicthat support sending value at creation. (#4936)TransparentUpgradeableProxy: Make internal_proxyAdmin()getter haveviewvisibility. (#4688)ProxyAdmin: Fixed documentation forUPGRADE_INTERFACE_VERSIONgetter. (#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 ofsafeIncreaseAllowanceandsafeDecreaseAllowancewhen associated with ERC-7674. (#5262)ERC721UtilsandERC1155Utils: Add reusable libraries with functions to perform acceptance checks onIERC721ReceiverandIERC1155Receiverimplementers. (#4845)ERC1363Utils: Add helper similar to the existing ERC721Utils and ERC1155Utils. (#5133)Utils
Arrays: add asortfunctions foraddress[],bytes32[]anduint256[]memory arrays. (#4846)Arrays: add new functionslowerBound,upperBound,lowerBoundMemoryandupperBoundMemoryfor lookups in sorted arrays with potential duplicates. (#4842)Arrays: deprecatefindUpperBoundin favor of the newlowerBound. (#4842)Base64: AddencodeURLfollowing 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: MaskcomputeAddressandcloneDeterministicoutputs to produce a clean value for anaddresstype (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 ofReentrancyGuardthat 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: refactorisValidSignatureNowto avoid validating ECDSA signatures if there is code deployed at the signer's address. (#4951)MerkleProof: Add variations ofverify,processProof,multiProofVerifyandprocessMultiProof(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 aninvModfunction to get the modular multiplicative inverse of a number in Z/nZ. (#4839)Math: AddmodExpfunction that exposes theEIP-198precompile. Includesuint256andbytes memoryversions. (#3298)Math: Custom errors replaced with native panic codes. (#3298)Math,SignedMath: Add a branchlessternaryfunction that computescond ? a : bin constant gas cost. (#4976)SafeCast: AddtoUint(bool)for operating onboolvalues asuint256. (#4878)Structures
CircularBuffer: Add a data structure that stores the lastNvalues pushed to it. (#4913)DoubleEndedQueue: Custom errors replaced with native panic codes. (#4872)EnumerableMap: addUintToBytes32Map,AddressToAddressMap,AddressToBytes32MapandBytes32ToAddressMap. (#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)Co-authored-by: github-actions[bot] <github-actions[bot]@ users.noreply.github.com>
Breaking changes
ERC1967Utils: Removed duplicate declaration of theUpgraded,AdminChangedandBeaconUpgradedevents. These events are still available through theIERC1967interface located under thecontracts/interfaces/directory. Minimum pragma version is now 0.8.21.Governor,GovernorCountingSimple: The_countVotesvirtual function now returns anuint256with 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_countVotesfunction.Custom error changes
This version comes with changes to the custom error identifiers. Contracts previously depending on the following errors should be replaced accordingly:
Address.FailedInnerCallwithErrors.FailedCallAddress.AddressInsufficientBalancewithErrors.InsufficientBalanceClones.Create2InsufficientBalancewithErrors.InsufficientBalanceClones.ERC1167FailedCreateClonewithErrors.FailedDeploymentClones.Create2FailedDeploymentwithErrors.FailedDeploymentSafeERC20: ReplaceAddress.AddressEmptyCodewithSafeERC20FailedOperationif there is no code at the token's address.SafeERC20: Replace genericError(string)withSafeERC20FailedOperationif the returned data can't be decoded asbool.SafeERC20: Replace genericSafeERC20FailedOperationwith the revert message from the contract call if it fails.Changes by category
General
AccessManager,VestingWallet,TimelockControllerandERC2771Forwarder: Added a publicinitializerfunction in their corresponding upgradeable variants. (#5008)Access
AccessControlEnumerable: Add agetRoleMembersmethod to return all accounts that haverole. (#4546)AccessManager: Allow theonlyAuthorizedmodifier to restrict functions added to the manager. (#5014)Finance
VestingWalletCliff: Add an extension of theVestingWalletcontract 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_moveDelegateVotesvisibility to internal instead of private. (#5007)Proxy
Clones: Add version ofcloneandcloneDeterministicthat support sending value at creation. (#4936)TransparentUpgradeableProxy: Make internal_proxyAdmin()getter haveviewvisibility. (#4688)ProxyAdmin: Fixed documentation forUPGRADE_INTERFACE_VERSIONgetter. (#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)ERC721UtilsandERC1155Utils: Add reusable libraries with functions to perform acceptance checks onIERC721ReceiverandIERC1155Receiverimplementers. (#4845)ERC1363Utils: Add helper similar to the existing ERC721Utils and ERC1155Utils. (#5133)Utils
Arrays: add asortfunctions foraddress[],bytes32[]anduint256[]memory arrays. (#4846)Arrays: add new functionslowerBound,upperBound,lowerBoundMemoryandupperBoundMemoryfor lookups in sorted arrays with potential duplicates. (#4842)Arrays: deprecatefindUpperBoundin favor of the newlowerBound. (#4842)Base64: AddencodeURLfollowing 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: MaskcomputeAddressandcloneDeterministicoutputs to produce a clean value for anaddresstype (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 ofReentrancyGuardthat 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)StorageSlot: Add primitives for operating on the transient storage space using a typed-slot representation. (#4980)Cryptography
SignatureChecker: refactorisValidSignatureNowto avoid validating ECDSA signatures if there is code deployed at the signer's address. (#4951)MerkleProof: Add variations ofverify,processProof,multiProofVerifyandprocessMultiProof(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 aninvModfunction to get the modular multiplicative inverse of a number in Z/nZ. (#4839)Math: AddmodExpfunction that exposes theEIP-198precompile. Includesuint256andbytes memoryversions. (#3298)Math: Custom errors replaced with native panic codes. (#3298)Math,SignedMath: Add a branchlessternaryfunction that computescond ? a : bin constant gas cost. (#4976)SafeCast: AddtoUint(bool)for operating onboolvalues asuint256. (#4878)Structures
CircularBuffer: Add a data structure that stores the lastNvalues pushed to it. (#4913)DoubleEndedQueue: Custom errors replaced with native panic codes. (#4872)EnumerableMap: addUintToBytes32Map,AddressToAddressMap,AddressToBytes32MapandBytes32ToAddressMap. (#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)Base64: Fix issue where dirty memory located just after the input buffer is affecting the result. (#4926)ERC2771ContextandContext: Introduce a_contextPrefixLength()getter, used to trim extra information appended tomsg.data.Multicall: Make aware of non-canonical context (i.e.msg.senderis not_msgSender()), allowing compatibility withERC2771Context.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 anAccessManager.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.HistoryCountersERC20SnapshotERC20VotesCompERC165Storage(in favor of inheritance based approach)ERC777ERC1820ImplementerGovernorVotesCompGovernorProposalThreshold(deprecated since 4.4)PaymentSplitterPullPaymentSafeMathSignedSafeMathTimersTokenTimelock(in favor ofVestingWallet)Escrow,ConditionalEscrowandRefundEscrow)AccessControlCrossChainand all the vendored bridge interfacesThese removals were implemented in the following PRs: #3637, #3880, #3945, #4258, #4276, #4289
Changes by category
General
abi.encodeCallin place ofabi.encodeWithSelectorandabi.encodeWithSignaturefor improved type-checking of parameters (#4293)abi.encodePackedwith clearer alternatives (e.g.bytes.concat,string.concat). (#4504) (#4296)ERC1155Supply.totalSupply,ERC721.ownerOf,ERC721.balanceOfandERC721.totalSupplyinERC721Enumerable,ERC20.totalSupplyinERC20FlashMint, andERC1967._getImplementationinERC1967Proxy. (#4299)overridespecifier from functions that only override a single interface function. (#4315)Governor,Initializable, andUUPSUpgradeable: Use internal functions in modifiers to optimize bytecode size. (#4472)Access
Ownable: Added aninitialOwnerparameter 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_grantRoleand_revokeRolefunctions indicating whether the role was granted or revoked. (#4241)access: MovedAccessControlextensions 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: Makescheduleandexecutemore conservative when delay is 0. (#4644)Finance
VestingWallet: Fixed revert during 1 second time window when duration is 0. (#4502)VestingWallet: UseOwnableinstead of an immutablebeneficiary. (#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. Addedqueueand_queueOperationsfunctions that act at different levels. Modules that implement queuing via timelocks are expected to override_queueOperationsto implement the timelock-specific logic. Added_executeOperationsas the equivalent for execution. (#4360)Governor: Addedvoterandnonceparameters in signed ballots, to avoid forging signatures for random addresses, prevent signature replay, and allow invalidating signatures. Addvoteras a new parameter in thecastVoteBySigandcastVoteWithReasonAndParamsBySigfunctions. (#4378)Governor: Added support for casting votes with ERC-1271 signatures by using abytes memory signatureinstead ofr,sandvarguments in thecastVoteBySigandcastVoteWithReasonAndParamsBySigfunctions. (#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 onproposalId, as well as proposal enumerability. This replaces the oldGovernorCompatibilityBravomodule. (#4360)GovernorTimelockAccess: Added a module to connect a governor with an instance ofAccessManager, allowing the governor to make calls that are delay-restricted by the manager using the normalqueueworkflow. (#4523)GovernorTimelockControl: Clean up timelock id on execution for gas refund. (#4118)GovernorTimelockControl: Added the Governor instance address as part of the TimelockController operationsaltto avoid operation id collisions between governors using the same TimelockController. (#4432)TimelockController: Changed the role architecture to useDEFAULT_ADMIN_ROLEas the admin for all roles, instead of the bespokeTIMELOCK_ADMIN_ROLEthat was used previously. This aligns with the general recommendation forAccessControland makes the addition of new roles easier. Accordingly, theadminparameter and timelock will now be grantedDEFAULT_ADMIN_ROLEinstead ofTIMELOCK_ADMIN_ROLE. (#3799)TimelockController: Added a state getter that returns anOperationStateenum. (#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: Addeddeadlinefor expiring transactions, batching, and more secure handling ofmsg.value. (#4346)ERC2771Context: Return the forwarder address whenever themsg.dataof a call originating from a trusted forwarder is not long enough to contain the request signer address (i.e.msg.data.lengthis 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.lengthis less than 20 bytes). Return the full calldata in that case. (#4484)Proxy
ProxyAdmin: RemovedgetProxyAdminandgetProxyImplementationgetters. (#3820)TransparentUpgradeableProxy: Removedadminandimplementationgetters, which were only callable by the proxy owner and thus not very useful. (#3820)ERC1967Utils: Refactored theERC1967Upgradeabstract 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 theProxyAdmin. (#4354)ERC1967UtilstoUUPSUpgradeable. (#4356)UUPSUpgradeable,TransparentUpgradeableProxyandProxyAdmin: RemovedupgradeToandupgradefunctions, and madeupgradeToAndCallandupgradeAndCallignore 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 redundantreceivefunction. (#4434)BeaconProxy: Use an immutable variable to store the address of the beacon. It is no longer possible for aBeaconProxyto 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_beforeTokenTransferand_afterTokenTransferhooks, added a new internal_updatefunction for customizations, and refactored all extensions using those hooks to use_updateinstead. (#3838, #3876, #4377)ERC20: RemovedApprovalevent previously emitted intransferFromto 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-standardincreaseAllowanceanddecreaseAllowancefunctions. (#4585)ERC20Votes: Changed internal vote accounting to reusableVotesmodule previously used byERC721Votes. Removed implicitERC20Permitinheritance. Note that theDOMAIN_SEPARATORgetter was previously guaranteed to be available forERC20Votescontracts, but is no longer available unlessERC20Permitis explicitly used; ERC-5267 support is included inERC20VoteswithEIP712and is recommended as an alternative. (#3816)SafeERC20: RefactoredsafeDecreaseAllowanceandsafeIncreaseAllowanceto support USDT-like tokens. (#4260)SafeERC20: RemovedsafePermitin favor of documentation-onlypermitrecommendations. Based on recommendations from @ trust1995 (#4582)ERC721:_approveno longer allows approving the owner of the tokenId. (#4377)_setApprovalForAllno longer allows setting address(0) as an operator. (#4377)ERC721: Renamed_requireMintedto_requireOwnedand added a return value with the current owner. ImplementedownerOfin terms of_requireOwned. (#4566)ERC721Consecutive: Added a_firstConsecutiveIdinternal 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 inbalanceOf. (#4263)ERC1155: Optimized array accesses by skipping bounds checking when unnecessary. (#4300)ERC1155: Bubble errors triggered in theonERC1155ReceivedandonERC1155BatchReceivedhooks. (#4314)ERC1155Supply: Added atotalSupply()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 ofERC1155Holder. (#4450)