Merge branch 'master' into fix/erc1155/use-batch-hook-for-batches-of-1

Author: Amxx

.changeset/shaky-phones-mix.md

@@ -0,0 +1,5 @@
+---
+'openzeppelin-solidity': minor
+---
+
+`TrieProof`: Add library for verifying Ethereum Merkle-Patricia trie inclusion proofs.

.changeset/tender-pans-yawn.md

@@ -0,0 +1,5 @@
+---
+'openzeppelin-solidity': minor
+---
+
+`Bytes`: Add the `toNibbles` function that expands the nibbles (4 bits chunk) of a `bytes` buffer. Used for manipulating Patricia Merkle Trees keys and paths.

CHANGELOG.md

@@ -3,9 +3,9 @@
 ### Breaking changes
 
 - `ERC1155`: Performing batch transfers with exactly one id/value in the batch no-longer calls `IERC1155Receiver.onERC1155Received`. `IERC1155Receiver.onERC1155BatchReceived` is called instead (with arrays of length one). ([#6170](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/6170))
-- `ERC1967Proxy` and `TransparentUpgradeableProxy`: Mandate initialization during construction. Deployment now reverts with `ERC1967ProxyUninitialized` if an initialize call is not provided. Developers that rely on the previous behavior and want to disable this check can do so by overriding the internal `_unsafeAllowUninitialized` function to return true.
-- `ERC721` and `ERC1155`: Prevent setting an operator for `address(0)`. In the case of `ERC721` this type of operator allowance could lead to obfuscated mint permission.
-- `RLP`: The `encode(bytes32)` function now encodes `bytes32` as a fixed size item and not as a scalar in `encode(uint256)`. Users must replace calls to `encode(bytes32)` with `encode(uint256(bytes32))` to preserve the same behavior.
+- `ERC1967Proxy` and `TransparentUpgradeableProxy`: Mandate initialization during construction. Deployment now reverts with `ERC1967ProxyUninitialized` if an initialize call is not provided. Developers that rely on the previous behavior and want to disable this check can do so by overriding the internal `_unsafeAllowUninitialized` function to return true. ([#5906](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/5906))
+- `ERC721` and `ERC1155`: Prevent setting an operator for `address(0)`. In the case of `ERC721` this type of operator allowance could lead to obfuscated mint permission. ([#6171](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/6171))
+- `RLP`: The `encode(bytes32)` function now encodes `bytes32` as a fixed size item and not as a scalar in `encode(uint256)`. Users must replace calls to `encode(bytes32)` with `encode(uint256(bytes32))` to preserve the same behavior. ([#6167](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/6167))
 
 ## 5.5.0 (2025-10-31)
 
@@ -26,7 +26,7 @@
 
 ### Deprecation
 
-- `Initializable` and `UUPSUpgradeable` are no longer transpiled. An alias is present in the `@openzeppelin/contracts-upgradeable` package that redirect to the corresponding file in `@openzeppelin/contracts`. These alias will be removed in the next major release. Developers are advised to update their imports to get these files directly from the `@openzeppelin/contracts` package. [#5941](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/5941)
+- `Initializable` and `UUPSUpgradeable` are no longer transpiled. Aliases are present in the `@openzeppelin/contracts-upgradeable` package that redirect to the corresponding files in `@openzeppelin/contracts`. These aliases will be removed in the next major release. Developers are advised to update their imports to get these files directly from the `@openzeppelin/contracts` package. [#5941](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/5941)
 - `ECDSA` signature malleability protection is partly deprecated. See documentation for more details. [#5814](https://github.com/OpenZeppelin/openzeppelin-contracts/pull/5814)
 
 ### Changes by category
@@ -94,7 +94,7 @@
 
 ### Pragma changes
 
-- Reduced pragma requirement of interface files
+- Reduced pragma requirement of interface files.
 
 ### Changes by category
 

GUIDELINES.md

@@ -125,7 +125,7 @@ In addition to the official Solidity Style Guide we have a number of other conve
   ```
 
 * Contracts not intended to be used standalone should be marked abstract
-  so they are required to be inherited to other contracts.
+  so they are required to be inherited by other contracts.
 
   ```solidity
   abstract contract AccessControl is ..., {

contracts/access/AccessControl.sol

@@ -65,7 +65,7 @@ abstract contract AccessControl is Context, IAccessControl, ERC165 {
         _;
     }
 
-    /// @inheritdoc IERC165
+    /// @inheritdoc ERC165
     function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
         return interfaceId == type(IAccessControl).interfaceId || super.supportsInterface(interfaceId);
     }

contracts/access/extensions/AccessControlDefaultAdminRules.sol

@@ -315,7 +315,7 @@ abstract contract AccessControlDefaultAdminRules is IAccessControlDefaultAdminRu
     /**
      * @dev Setter of the tuple for pending admin and its schedule.
      *
-     * May emit a DefaultAdminTransferCanceled event.
+     * May emit a {DefaultAdminTransferCanceled} event.
      */
     function _setPendingDefaultAdmin(address newAdmin, uint48 newSchedule) private {
         (, uint48 oldSchedule) = pendingDefaultAdmin();
@@ -333,7 +333,7 @@ abstract contract AccessControlDefaultAdminRules is IAccessControlDefaultAdminRu
     /**
      * @dev Setter of the tuple for pending delay and its schedule.
      *
-     * May emit a DefaultAdminDelayChangeCanceled event.
+     * May emit a {DefaultAdminDelayChangeCanceled} event.
      */
     function _setPendingDelay(uint48 newDelay, uint48 newSchedule) private {
         uint48 oldSchedule = _pendingDelaySchedule;

contracts/access/extensions/IAccessControlDefaultAdminRules.sol

@@ -103,7 +103,7 @@ interface IAccessControlDefaultAdminRules is IAccessControl {
      *
      * - Only can be called by the current {defaultAdmin}.
      *
-     * Emits a DefaultAdminRoleChangeStarted event.
+     * Emits a {DefaultAdminTransferScheduled} event.
      */
     function beginDefaultAdminTransfer(address newAdmin) external;
 
@@ -116,7 +116,7 @@ interface IAccessControlDefaultAdminRules is IAccessControl {
      *
      * - Only can be called by the current {defaultAdmin}.
      *
-     * May emit a DefaultAdminTransferCanceled event.
+     * May emit a {DefaultAdminTransferCanceled} event.
      */
     function cancelDefaultAdminTransfer() external;
 
@@ -160,7 +160,7 @@ interface IAccessControlDefaultAdminRules is IAccessControl {
      *
      * - Only can be called by the current {defaultAdmin}.
      *
-     * Emits a DefaultAdminDelayChangeScheduled event and may emit a DefaultAdminDelayChangeCanceled event.
+     * Emits a {DefaultAdminDelayChangeScheduled} event and may emit a {DefaultAdminDelayChangeCanceled} event.
      */
     function changeDefaultAdminDelay(uint48 newDelay) external;
 
@@ -171,7 +171,7 @@ interface IAccessControlDefaultAdminRules is IAccessControl {
      *
      * - Only can be called by the current {defaultAdmin}.
      *
-     * May emit a DefaultAdminDelayChangeCanceled event.
+     * May emit a {DefaultAdminDelayChangeCanceled} event.
      */
     function rollbackDefaultAdminDelay() external;
 

contracts/access/manager/IAccessManager.sol

@@ -36,7 +36,7 @@ interface IAccessManager {
      *
      * NOTE: The meaning of the `since` argument depends on the `newMember` argument.
      * If the role is granted to a new member, the `since` argument indicates when the account becomes a member of the role,
-     * otherwise it indicates the execution delay for this account and roleId is updated.
+     * otherwise it indicates the timestamp when the execution delay update takes effect for this account and roleId.
      */
     event RoleGranted(uint64 indexed roleId, address indexed account, uint32 delay, uint48 since, bool newMember);
 
@@ -196,6 +196,7 @@ interface IAccessManager {
      * Requirements:
      *
      * - the caller must be a global admin
+     * - `roleId` must not be the `ADMIN_ROLE` or `PUBLIC_ROLE`
      *
      * Emits a {RoleLabel} event.
      */
@@ -254,6 +255,7 @@ interface IAccessManager {
      * Requirements:
      *
      * - the caller must be a global admin
+     * - `roleId` must not be the `ADMIN_ROLE` or `PUBLIC_ROLE`
      *
      * Emits a {RoleAdminChanged} event
      */
@@ -265,6 +267,7 @@ interface IAccessManager {
      * Requirements:
      *
      * - the caller must be a global admin
+     * - `roleId` must not be the `ADMIN_ROLE` or `PUBLIC_ROLE`
      *
      * Emits a {RoleGuardianChanged} event
      */
@@ -276,6 +279,7 @@ interface IAccessManager {
      * Requirements:
      *
      * - the caller must be a global admin
+     * - `roleId` must not be the `PUBLIC_ROLE`
      *
      * Emits a {RoleGrantDelayChanged} event.
      */

contracts/account/extensions/draft-AccountERC7579.sol

@@ -401,7 +401,7 @@ abstract contract AccountERC7579 is Account, IERC1271, IERC7579Execution, IERC75
      * actual copy. However, this would require `_installModule` to get a calldata bytes object instead of a memory
      * bytes object. This would prevent calling `_installModule` from a contract constructor and would force the use
      * of external initializers. That may change in the future, as most accounts will probably be deployed as
-     * clones/proxy/ERC-7702 delegates and therefore rely on initializers anyway.
+     * clones/proxy/EIP-7702 delegates and therefore rely on initializers anyway.
      */
     function _decodeFallbackData(
         bytes memory data

contracts/account/utils/EIP7702Utils.sol

@@ -6,7 +6,7 @@ pragma solidity ^0.8.20;
 /**
  * @dev Library with common EIP-7702 utility functions.
  *
- * See https://eips.ethereum.org/EIPS/eip-7702[ERC-7702].
+ * See https://eips.ethereum.org/EIPS/eip-7702[EIP-7702].
  */
 library EIP7702Utils {
     bytes3 internal constant EIP7702_PREFIX = 0xef0100;