Merge branch 'master' into lohann/efficient-log2-algorithm

OpenZeppelin · Oct 18, 2024 · 6e2bb8e · 6e2bb8e
2 parents 2a50166 + 0034c30
commit 6e2bb8e
Show file tree

Hide file tree

Showing 181 changed files with 1,203 additions and 383 deletions.
diff --git a/.changeset/chilled-walls-develop.md b/.changeset/chilled-walls-develop.md
diff --git a/.changeset/chilly-humans-warn.md b/.changeset/chilly-humans-warn.md
diff --git a/.changeset/cold-cheetahs-check.md b/.changeset/cold-cheetahs-check.md
diff --git a/.changeset/cool-mangos-compare.md b/.changeset/cool-mangos-compare.md
diff --git a/.changeset/curvy-crabs-repeat.md b/.changeset/curvy-crabs-repeat.md
diff --git a/.changeset/dirty-cobras-smile.md b/.changeset/dirty-cobras-smile.md
diff --git a/.changeset/eight-eyes-burn.md b/.changeset/eight-eyes-burn.md
diff --git a/.changeset/eighty-hounds-promise.md b/.changeset/eighty-hounds-promise.md
@@ -0,0 +1,5 @@
+---
+'openzeppelin-solidity': minor
+---
+
+`Strings`: Add `parseUint`, `parseInt`, `parseHexUint` and `parseAddress` to parse strings into numbers and addresses. Also provide variants of these functions that parse substrings, and `tryXxx` variants that do not revert on invalid input.
diff --git a/.changeset/eleven-planets-relax.md b/.changeset/eleven-planets-relax.md
diff --git a/.changeset/flat-turtles-repeat.md b/.changeset/flat-turtles-repeat.md
diff --git a/.changeset/fluffy-buses-jump.md b/.changeset/fluffy-buses-jump.md
diff --git a/.changeset/fluffy-steaks-exist.md b/.changeset/fluffy-steaks-exist.md
diff --git a/.changeset/forty-dodos-visit.md b/.changeset/forty-dodos-visit.md
diff --git a/.changeset/friendly-nails-push.md b/.changeset/friendly-nails-push.md
diff --git a/.changeset/gentle-bulldogs-turn.md b/.changeset/gentle-bulldogs-turn.md
diff --git a/.changeset/gorgeous-badgers-vanish.md b/.changeset/gorgeous-badgers-vanish.md
diff --git a/.changeset/great-pianos-work.md b/.changeset/great-pianos-work.md
diff --git a/.changeset/healthy-books-shout.md b/.changeset/healthy-books-shout.md
@@ -0,0 +1,5 @@
+---
+'openzeppelin-solidity': minor
+---
+
+`CAIP2` and `CAIP10`: Add libraries for formatting and parsing CAIP-2 and CAIP-10 identifiers.
diff --git a/.changeset/heavy-baboons-give.md b/.changeset/heavy-baboons-give.md
diff --git a/.changeset/kind-planets-cough.md b/.changeset/kind-planets-cough.md
diff --git a/.changeset/light-news-listen.md b/.changeset/light-news-listen.md
diff --git a/.changeset/lucky-crews-eat.md b/.changeset/lucky-crews-eat.md
diff --git a/.changeset/nervous-eyes-teach.md b/.changeset/nervous-eyes-teach.md
diff --git a/.changeset/nervous-pans-grow.md b/.changeset/nervous-pans-grow.md
diff --git a/.changeset/nice-paws-pull.md b/.changeset/nice-paws-pull.md
diff --git a/.changeset/odd-files-protect.md b/.changeset/odd-files-protect.md
diff --git a/.changeset/odd-lobsters-wash.md b/.changeset/odd-lobsters-wash.md
diff --git a/.changeset/poor-chefs-cheat.md b/.changeset/poor-chefs-cheat.md
diff --git a/.changeset/proud-planes-arrive.md b/.changeset/proud-planes-arrive.md
@@ -0,0 +1,5 @@
+---
+'openzeppelin-solidity': minor
+---
+
+`Bytes`: Add a library of common operation that operate on `bytes` objects.
diff --git a/.changeset/serious-carrots-provide.md b/.changeset/serious-carrots-provide.md
diff --git a/.changeset/shiny-poets-whisper.md b/.changeset/shiny-poets-whisper.md
diff --git a/.changeset/silver-swans-promise.md b/.changeset/silver-swans-promise.md
diff --git a/.changeset/smart-bugs-switch.md b/.changeset/smart-bugs-switch.md
diff --git a/.changeset/spotty-falcons-explain.md b/.changeset/spotty-falcons-explain.md
diff --git a/.changeset/spotty-queens-own.md b/.changeset/spotty-queens-own.md
diff --git a/.changeset/strong-singers-talk.md b/.changeset/strong-singers-talk.md
diff --git a/.changeset/thick-pumpkins-report.md b/.changeset/thick-pumpkins-report.md
diff --git a/.changeset/thin-walls-drop.md b/.changeset/thin-walls-drop.md
diff --git a/.changeset/twenty-feet-grin.md b/.changeset/twenty-feet-grin.md
diff --git a/.changeset/violet-moons-tell.md b/.changeset/violet-moons-tell.md
diff --git a/.changeset/warm-sheep-cover.md b/.changeset/warm-sheep-cover.md
diff --git a/.changeset/wise-bobcats-speak.md b/.changeset/wise-bobcats-speak.md
diff --git a/.changeset/witty-chicken-smile.md b/.changeset/witty-chicken-smile.md
diff --git a/.changeset/yellow-deers-walk.md b/.changeset/yellow-deers-walk.md
diff --git a/.changeset/yellow-moles-hammer.md b/.changeset/yellow-moles-hammer.md
diff --git a/.changeset/yellow-tables-sell.md b/.changeset/yellow-tables-sell.md
@@ -0,0 +1,5 @@
+---
+'openzeppelin-solidity': minor
+---
+
+`SafeERC20`: Document risks of `safeIncreaseAllowance` and `safeDecreaseAllowance` when associated with ERC-7674.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,11 +1,14 @@
 # Changelog
 
+
+## 5.1.0 (2024-10-17)
+
 ### 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
+#### Custom error changes
 
 This version comes with changes to the custom error identifiers. Contracts previously depending on the following errors should be replaced accordingly:
 
@@ -18,6 +21,82 @@ This version comes with changes to the custom error identifiers. Contracts previ
 - `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](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/5008))
+
+#### Access
+
+- `AccessControlEnumerable`: Add a `getRoleMembers` method to return all accounts that have `role`. ([#4546](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/4546))
+- `AccessManager`: Allow the `onlyAuthorized` modifier to restrict functions added to the manager. ([#5014](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/5014))
+
+#### Finance
+
+- `VestingWalletCliff`: Add an extension of the `VestingWallet` contract with an added cliff. ([#4870](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/4870))
+
+#### Governance
+
+- `GovernorCountingFractional`: Add a governor counting module that allows distributing voting power amongst 3 options (For, Against, Abstain). ([#5045](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/5045))
+- `Votes`: Set `_moveDelegateVotes` visibility to internal instead of private. ([#5007](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/5007))
+
+#### Proxy
+
+- `Clones`: Add version of `clone` and `cloneDeterministic` that support sending value at creation. ([#4936](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/4936))
+- `TransparentUpgradeableProxy`: Make internal `_proxyAdmin()` getter have `view` visibility. ([#4688](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/4688))
+- `ProxyAdmin`: Fixed documentation for `UPGRADE_INTERFACE_VERSION` getter. ([#5031](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/5031))
+
+#### Tokens
+
+- `ERC1363`: Add implementation of the token payable standard allowing execution of contract code after transfers and approvals. ([#4631](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/4631))
+- `ERC20TemporaryApproval`: Add an ERC-20 extension that implements temporary approval using transient storage, based on ERC7674 (draft). ([#5071](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/5071))
+- `SafeERC20`: Add "relaxed" function for interacting with ERC-1363 functions in a way that is compatible with EOAs. ([#4631](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/4631))
+- `SafeERC20`: Document risks of `safeIncreaseAllowance` and `safeDecreaseAllowance` when associated with ERC-7674. ([#5262](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/5262))
+- `ERC721Utils` and `ERC1155Utils`: Add reusable libraries with functions to perform acceptance checks on `IERC721Receiver` and `IERC1155Receiver` implementers. ([#4845](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/4845))
+- `ERC1363Utils`: Add helper similar to the existing ERC721Utils and ERC1155Utils. ([#5133](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/5133))
+
+#### Utils
+
+- `Arrays`: add a `sort` functions for `address[]`, `bytes32[]` and `uint256[]` memory arrays. ([#4846](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/4846))
+- `Arrays`: add new functions `lowerBound`, `upperBound`, `lowerBoundMemory` and `upperBoundMemory` for lookups in sorted arrays with potential duplicates. ([#4842](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/4842))
+- `Arrays`: deprecate `findUpperBound` in favor of the new `lowerBound`. ([#4842](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/4842))
+- `Base64`: Add `encodeURL` following section 5 of RFC4648 for URL encoding ([#4822](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/4822))
+- `Comparator`: A library of comparator functions, useful for customizing the behavior of the Heap structure. ([#5084](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/5084))
+- `Create2`: Bubbles up returndata from a deployed contract that reverted during construction. ([#5052](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/5052))
+- `Create2`, `Clones`: Mask `computeAddress` and `cloneDeterministic` outputs to produce a clean value for an `address` type (i.e. only use 20 bytes) ([#4941](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/4941))
+- `Errors`: New library of common custom errors. ([#4936](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/4936))
+- `Hashes`: A library with commonly used hash functions. ([#3617](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/3617))
+- `Packing`: Added a new utility for packing, extracting and replacing bytesXX values. ([#4992](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/4992))
+- `Panic`: Add a library for reverting with panic codes. ([#3298](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/3298))
+- `ReentrancyGuardTransient`: Added a variant of `ReentrancyGuard` that uses transient storage. ([#4988](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/4988))
+- `Strings`: Added a utility function for converting an address to checksummed string. ([#5067](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/5067))
+- `SlotDerivation`: Add a library of methods for derivating common storage slots. ([#4975](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/4975))
+- `TransientSlot`: Add primitives for operating on the transient storage space using a typed-slot representation. ([#4980](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/4980))
+
+##### Cryptography
+
+- `SignatureChecker`: refactor `isValidSignatureNow` to avoid validating ECDSA signatures if there is code deployed at the signer's address. ([#4951](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/4951))
+- `MerkleProof`: Add variations of `verify`, `processProof`, `multiProofVerify` and `processMultiProof` (and equivalent calldata version) with support for custom hashing functions. ([#4887](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/4887))
+- `P256`: Library for verification and public key recovery of P256 (aka secp256r1) signatures. ([#4881](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/4881))
+- `RSA`: Library to verify signatures according to RFC 8017 Signature Verification Operation ([#4952](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/4952))
+
+#### Math
+
+- `Math`: add an `invMod` function to get the modular multiplicative inverse of a number in Z/nZ. ([#4839](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/4839))
+- `Math`: Add `modExp` function that exposes the `EIP-198` precompile. Includes `uint256` and `bytes memory` versions. ([#3298](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/3298))
+- `Math`: Custom errors replaced with native panic codes. ([#3298](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/3298))
+- `Math`, `SignedMath`: Add a branchless `ternary` function that computes`cond ? a : b` in constant gas cost. ([#4976](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/4976))
+- `SafeCast`: Add `toUint(bool)` for operating on `bool` values as `uint256`. ([#4878](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/4878))
+
+#### Structures
+
+- `CircularBuffer`: Add a data structure that stores the last `N` values pushed to it. ([#4913](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/4913))
+- `DoubleEndedQueue`: Custom errors replaced with native panic codes. ([#4872](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/4872))
+- `EnumerableMap`: add `UintToBytes32Map`, `AddressToAddressMap`, `AddressToBytes32Map` and `Bytes32ToAddressMap`. ([#4843](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/4843))
+- `Heap`: A data structure that implements a heap-based priority queue. ([#5084](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/5084))
+- `MerkleTree`: A data structure that allows inserting elements into a merkle tree and updating its root hash. ([#3617](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/3617))
+
 ## 5.0.2 (2024-02-29)
 
 - `Base64`: Fix issue where dirty memory located just after the input buffer is affecting the result. ([#4926](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/4926))

diff --git a/contracts/access/IAccessControl.sol b/contracts/access/IAccessControl.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-// OpenZeppelin Contracts (last updated v5.0.0) (access/IAccessControl.sol)
+// OpenZeppelin Contracts (last updated v5.1.0) (access/IAccessControl.sol)
 
 pragma solidity ^0.8.20;
 

diff --git a/contracts/access/Ownable2Step.sol b/contracts/access/Ownable2Step.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-// OpenZeppelin Contracts (last updated v5.0.0) (access/Ownable2Step.sol)
+// OpenZeppelin Contracts (last updated v5.1.0) (access/Ownable2Step.sol)
 
 pragma solidity ^0.8.20;
 

diff --git a/contracts/access/extensions/AccessControlEnumerable.sol b/contracts/access/extensions/AccessControlEnumerable.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-// OpenZeppelin Contracts (last updated v5.0.0) (access/extensions/AccessControlEnumerable.sol)
+// OpenZeppelin Contracts (last updated v5.1.0) (access/extensions/AccessControlEnumerable.sol)
 
 pragma solidity ^0.8.20;