chore(deps): update dependency @openzeppelin/contracts to v5.3.0 #125
Conversation
This file contains hidden or 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
Signed-off-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
![renovate-approve-2[bot]](https://avatars.githubusercontent.com/in/62175?s=60&v=4){kind=small}
![renovate-approve[bot]](https://avatars.githubusercontent.com/in/7394?s=60&v=4){kind=small}
Reviewer's Guide by SourceryThis pull request updates the Updated class diagram for GovernorCountingOverridable.VoteReceiptclassDiagram
class VoteReceipt {
-bool hasOverridden
-uint256 overriddenWeight
+bool hasOverriden
+uint256 overridenWeight
}
note for VoteReceipt "'hasOverriden' and 'overridenWeight' have been renamed to 'hasOverridden' and 'overriddenWeight' respectively."
Updated class diagram for AccessControlclassDiagram
class AccessControl {
<<custom error>>
-AccessControlNonRevokable
+AccessControlNonRevocable
}
note for AccessControl "'AccessControlNonRevokable' has been renamed to 'AccessControlNonRevocable'."
Updated class diagram for GovernorclassDiagram
class Governor {
<<custom error>>
-GovernorAlreadyOverridenVote
+GovernorAlreadyOverriddenVote
-GovernorOnlyProposer
+GovernorUnableToCancel
}
note for Governor "'GovernorAlreadyOverridenVote' has been renamed to 'GovernorAlreadyOverriddenVote'. 'GovernorOnlyProposer' has been renamed to 'GovernorUnableToCancel'."
Class diagram for GovernorProposalGuardianclassDiagram
class GovernorProposalGuardian {
+function cancel(uint256 proposalId)
}
Governor --|> GovernorProposalGuardian : extends
note for GovernorProposalGuardian "Adds a governance extension that defines a proposal guardian who can cancel proposals at any stage in their lifecycle."
Class diagram for GovernorSequentialProposalIdclassDiagram
class GovernorSequentialProposalId {
+function getProposalId(uint256 proposalNumber) uint256
}
Governor --|> GovernorSequentialProposalId : extends
note for GovernorSequentialProposalId "Adds a Governor extension that sequentially numbers proposal ids instead of using the hash."
Class diagram for GovernorSuperQuorumclassDiagram
class GovernorSuperQuorum {
+function hasSuperQuorum(uint256 proposalId) bool
}
Governor --|> GovernorSuperQuorum : extends
note for GovernorSuperQuorum "Adds a governance extension to support a super quorum. Proposals that meet the super quorum advance to the Succeeded state before the proposal deadline."
Class diagram for GovernorVotesSuperQuorumFractionclassDiagram
class GovernorVotesSuperQuorumFraction {
+function superQuorumThreshold() uint256
}
Governor --|> GovernorVotesSuperQuorumFraction : extends
note for GovernorVotesSuperQuorumFraction "Adds a variant of the GovernorSuperQuorum extensions where the super quorum is expressed as a fraction of the total supply."
Class diagram for EnumerableSetclassDiagram
class EnumerableSet {
+function clear()
}
note for EnumerableSet "Adds clear function to EnumerableSets which deletes all values in the set."
Class diagram for EnumerableMapclassDiagram
class EnumerableMap {
+function clear()
}
note for EnumerableMap "Adds clear function to EnumerableMaps which deletes all entries in the map."
Class diagram for MerkleTreeclassDiagram
class MerkleTree {
+function update(bytes32 leaf, bytes32 newValue)
}
note for MerkleTree "Adds an update function that replaces a previously inserted leaf with a new value, updating the tree root along the way."
Class diagram for IERC6909classDiagram
class IERC6909 {
<<interface>>
+function balanceOf(address account, uint256 id) external view returns (uint256)
+function balance0fBatch(address[] accounts, uint256[] ids) external view returns (uint256[])
+function safeTransfer(address from, address to, uint256 id, uint256 amount, bytes data) external
+function safeTransferBatch(address from, address to, uint256[] ids, uint256[] amounts, bytes data) external
}
note for IERC6909 "Adds the interface for ERC-6909."
Class diagram for ERC6909classDiagram
class ERC6909 {
// Standard implementation of ERC6909
}
note for ERC6909 "Adds a standard implementation of ERC6909."
Class diagram for ERC6909TokenSupplyclassDiagram
class ERC6909TokenSupply {
// Extension of ERC6909 which tracks total supply for each token id
}
ERC6909 --|> ERC6909TokenSupply : extends
note for ERC6909TokenSupply "Adds an extension of ERC6909 which tracks total supply for each token id."
Class diagram for ERC6909MetadataclassDiagram
class ERC6909Metadata {
// Extension of ERC6909 which adds metadata functionality
}
ERC6909 --|> ERC6909Metadata : extends
note for ERC6909Metadata "Adds an extension of ERC6909 which adds metadata functionality."
Class diagram for ERC6909ContentURIclassDiagram
class ERC6909ContentURI {
// Extension of ERC6909 which adds content URI functionality
}
ERC6909 --|> ERC6909ContentURI : extends
note for ERC6909ContentURI "Adds an extension of ERC6909 which adds content URI functionality."
Class diagram for SafeERC20classDiagram
class SafeERC20 {
+function trySafeTransfer(IERC20 token, address to, uint256 value) (bool, bytes memory)
+function trySafeTransferFrom(IERC20 token, address from, address to, uint256 value) (bool, bytes memory)
}
note for SafeERC20 "Adds trySafeTransfer and trySafeTransferFrom that do not revert and return false if the transfer is not successful."
Class diagram for CalldataclassDiagram
class Calldata {
+function emptyBytes() bytes
+function emptyString() string
}
note for Calldata "Library with emptyBytes and emptyString functions to generate empty bytes and string calldata types."
Class diagram for ERC2771ForwarderclassDiagram
class ERC2771Forwarder {
#function _isTrustedByTarget(address target) internal view returns (bool)
}
note for ERC2771Forwarder "Expose the _isTrustedByTarget internal function to check whether a target trusts the forwarder."
Class diagram for HashesclassDiagram
class Hashes {
+function efficientKeccak256(bytes32 a, bytes32 b) pure returns (bytes32)
}
note for Hashes "Expose efficientKeccak256 for hashing non-commutative pairs of bytes32 without allocating extra memory."
Class diagram for InitializableclassDiagram
class Initializable {
+function _initializableStorageSlot() internal pure returns (bytes32)
}
note for Initializable "Adds _initializableStorageSlot function that returns a pointer to the storage struct. The function allows customizing with a custom storage slot with an override."
Class diagram for MathclassDiagram
class Math {
+function add512(uint256 a, uint256 b) internal pure returns (uint256)
+function mul512(uint256 a, uint256 b) internal pure returns (uint256)
+function mulShr(uint256 x, uint256 y, uint256 shift) internal pure returns (uint256)
+function saturatingAdd(uint256 a, uint256 b) internal pure returns (uint256)
+function saturatingSub(uint256 a, uint256 b) internal pure returns (uint256)
+function saturatingMul(uint256 a, uint256 b) internal pure returns (uint256)
}
note for Math "Adds add512, mul512 and mulShr. Adds saturating arithmetic operations saturatingAdd, saturatingSub and saturatingMul."
Class diagram for MessageHashUtilsclassDiagram
class MessageHashUtils {
+function toDataWithIntendedValidatorHash(address validator, bytes32 messageHash) internal pure returns (bytes memory)
}
note for MessageHashUtils "Adds toDataWithIntendedValidatorHash(address, bytes32)."
Class diagram for StringsclassDiagram
class Strings {
+function escapeJSON(string memory str) internal pure returns (string memory)
}
note for Strings "Adds espaceJSON that escapes special characters in JSON strings."
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
📦 Packages
|
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.
This PR contains the following updates:
5.2.0->5.3.0Release Notes
OpenZeppelin/openzeppelin-contracts (@openzeppelin/contracts)
v5.3.0Compare Source
Breaking Changes
GovernorCountingOverridable.VoteReceiptstruct parameter member nameshasOverridenandoverridenWeightforhasOverriddenandoverriddenWeightrespectively.Custom error changes
AccessControlNonRevokablewithAccessControlNonRevocable.GovernorAlreadyOverridenVotewithGovernorAlreadyOverriddenVote.GovernorOnlyProposerwithGovernorUnableToCancel.Changes by category
Account
ERC4337Utils: Update thehashfunction to callgetUserOpHashon the specified entrypoint and add anENTRYPOINT_V08constant. (#5614)ERC7579Utils: Add ABI decoding checks on calldata bounds withindecodeBatch. (#5371)ERC7579Utils: Replaceaddress(0)withaddress(this)during execution for calldata compression efficiency. (#5614)Governance
IGovernor: Add thegetProposalIdfunction to the governor interface. (#5290)GovernorProposalGuardian: Add a governance extension that defines a proposal guardian who can cancel proposals at any stage in their lifecycle. (#5303)GovernorSequentialProposalId: Adds aGovernorextension that sequentially numbers proposal ids instead of using the hash. (#5290)GovernorSuperQuorum: Add a governance extension to support a super quorum. Proposals that meet the super quorum (and have a majority of for votes) advance to theSucceededstate before the proposal deadline. (#5526)GovernorVotesSuperQuorumFraction: Add a variant of theGovernorSuperQuorumextensions where the super quorum is expressed as a fraction of the total supply. (#5526)TimelockController: Receive function is now virtual. (#5509)Structures
EnumerableSet: Addclearfunction to EnumerableSets which deletes all values in the set. (#5486)EnumerableMap: Addclearfunction to EnumerableMaps which deletes all entries in the map. (#5486)MerkleTree: Add an update function that replaces a previously inserted leaf with a new value, updating the tree root along the way. (#5526)Tokens
ERC4626: Use theassetgetter intotalAssets,_depositand_withdraw. (#5322)IERC6909: Add the interface for ERC-6909. (#5343)ERC6909: Add a standard implementation of ERC6909. (#5394)ERC6909TokenSupply: Add an extension of ERC6909 which tracks total supply for each token id. (#5394)ERC6909Metadata: Add an extension of ERC6909 which adds metadata functionality. (#5394)ERC6909ContentURI: Add an extension of ERC6909 which adds content URI functionality. (#5394)SafeERC20: AddtrySafeTransferandtrySafeTransferFromthat do not revert and return false if the transfer is not successful. (#5483)Other
Address: bubble up revert data onsendValuefailed call. (#5379)Calldata: Library withemptyBytesandemptyStringfunctions to generate emptybytesandstringcalldata types. (#5422)ERC2771Forwarder: Expose the_isTrustedByTargetinternal function to check whether a target trusts the forwarder. (#5416)Hashes: ExposeefficientKeccak256for hashing non-commutative pairs of bytes32 without allocating extra memory. (#5442)Initializable: Add_initializableStorageSlotfunction that returns a pointer to the storage struct. The function allows customizing with a custom storage slot with anoverride. (#5526)Math: Addadd512,mul512andmulShr. (#5526)Math: Add saturating arithmetic operationssaturatingAdd,saturatingSubandsaturatingMul. (#5526)MessageHashUtils: AddtoDataWithIntendedValidatorHash(address, bytes32). (#5526)P256: Adjust precompile detection inverifyNativeto consider emptyreturndataon invalid verification. Previously, invalid signatures would've reverted with aMissingPrecompileerror in chains with RIP-7212 support. (#5620)Pausable: Stop explicitly settingpausedtofalseduring construction. (#5448)Strings: AddespaceJSONthat escapes special characters in JSON strings. (#5526)Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Enabled.
♻ Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR was generated by Mend Renovate. View the repository job log.
Summary by Sourcery
Update OpenZeppelin Contracts dependency to version 5.3.0, incorporating various improvements and new features across governance, tokens, and utility contracts
New Features:
Enhancements:
Chores: