switch to namespaces

Author: frangio

.changeset/wet-bears-heal.md

@@ -0,0 +1,5 @@
+---
+'openzeppelin-solidity': major
+---
+
+Upgradeable contracts now use namespaced storage (EIP-7201).

.github/actions/setup/action.yml

@@ -5,7 +5,7 @@ runs:
   steps:
     - uses: actions/setup-node@v3
       with:
-        node-version: 14.x
+        node-version: 16.x
     - uses: actions/cache@v3
       id: cache
       with:

contracts/access/AccessControlUpgradeable.sol

@@ -58,10 +58,23 @@ abstract contract AccessControlUpgradeable is Initializable, ContextUpgradeable,
         bytes32 adminRole;
     }
 
-    mapping(bytes32 role => RoleData) private _roles;
 
     bytes32 public constant DEFAULT_ADMIN_ROLE = 0x00;
 
+    /// @custom:storage-location erc7201:openzeppelin.storage.AccessControl
+    struct AccessControlStorage {
+        mapping(bytes32 role => RoleData) _roles;
+    }
+
+    // keccak256(abi.encode(uint256(keccak256("openzeppelin.storage.AccessControl")) - 1))
+    bytes32 private constant AccessControlStorageLocation = 0x02dd7bc7dec4dceedda775e58dd541e08a116c6c53815c0bd028192f7b6268ef;
+
+    function _getAccessControlStorage() private pure returns (AccessControlStorage storage $) {
+        assembly {
+            $.slot := AccessControlStorageLocation
+        }
+    }
+
     /**
      * @dev Modifier that checks that an account has a specific role. Reverts
      * with an {AccessControlUnauthorizedAccount} error including the required role.
@@ -82,7 +95,8 @@ abstract contract AccessControlUpgradeable is Initializable, ContextUpgradeable,
      * @dev Returns `true` if `account` has been granted `role`.
      */
     function hasRole(bytes32 role, address account) public view virtual returns (bool) {
-        return _roles[role].hasRole[account];
+        AccessControlStorage storage $ = _getAccessControlStorage();
+        return $._roles[role].hasRole[account];
     }
 
     /**
@@ -110,7 +124,8 @@ abstract contract AccessControlUpgradeable is Initializable, ContextUpgradeable,
      * To change a role's admin, use {_setRoleAdmin}.
      */
     function getRoleAdmin(bytes32 role) public view virtual returns (bytes32) {
-        return _roles[role].adminRole;
+        AccessControlStorage storage $ = _getAccessControlStorage();
+        return $._roles[role].adminRole;
     }
 
     /**
@@ -174,8 +189,9 @@ abstract contract AccessControlUpgradeable is Initializable, ContextUpgradeable,
      * Emits a {RoleAdminChanged} event.
      */
     function _setRoleAdmin(bytes32 role, bytes32 adminRole) internal virtual {
+        AccessControlStorage storage $ = _getAccessControlStorage();
         bytes32 previousAdminRole = getRoleAdmin(role);
-        _roles[role].adminRole = adminRole;
+        $._roles[role].adminRole = adminRole;
         emit RoleAdminChanged(role, previousAdminRole, adminRole);
     }
 
@@ -187,8 +203,9 @@ abstract contract AccessControlUpgradeable is Initializable, ContextUpgradeable,
      * May emit a {RoleGranted} event.
      */
     function _grantRole(bytes32 role, address account) internal virtual returns (bool) {
+        AccessControlStorage storage $ = _getAccessControlStorage();
         if (!hasRole(role, account)) {
-            _roles[role].hasRole[account] = true;
+            $._roles[role].hasRole[account] = true;
             emit RoleGranted(role, account, _msgSender());
             return true;
         } else {
@@ -204,19 +221,13 @@ abstract contract AccessControlUpgradeable is Initializable, ContextUpgradeable,
      * May emit a {RoleRevoked} event.
      */
     function _revokeRole(bytes32 role, address account) internal virtual returns (bool) {
+        AccessControlStorage storage $ = _getAccessControlStorage();
         if (hasRole(role, account)) {
-            _roles[role].hasRole[account] = false;
+            $._roles[role].hasRole[account] = false;
             emit RoleRevoked(role, account, _msgSender());
             return true;
         } else {
             return false;
         }
     }
-
-    /**
-     * @dev This empty reserved space is put in place to allow future versions to add new
-     * variables without shifting down storage in the inheritance chain.
-     * See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
-     */
-    uint256[49] private __gap;
 }

contracts/access/Ownable2StepUpgradeable.sol

@@ -23,23 +23,37 @@ abstract contract Ownable2StepUpgradeable is Initializable, OwnableUpgradeable {
 
     function __Ownable2Step_init_unchained() internal onlyInitializing {
     }
-    address private _pendingOwner;
+    /// @custom:storage-location erc7201:openzeppelin.storage.Ownable2Step
+    struct Ownable2StepStorage {
+        address _pendingOwner;
+    }
+
+    // keccak256(abi.encode(uint256(keccak256("openzeppelin.storage.Ownable2Step")) - 1))
+    bytes32 private constant Ownable2StepStorageLocation = 0x237e158222e3e6968b72b9db0d8043aacf074ad9f650f0d1606b4d82ee432c4d;
+
+    function _getOwnable2StepStorage() private pure returns (Ownable2StepStorage storage $) {
+        assembly {
+            $.slot := Ownable2StepStorageLocation
+        }
+    }
 
     event OwnershipTransferStarted(address indexed previousOwner, address indexed newOwner);
 
     /**
      * @dev Returns the address of the pending owner.
      */
     function pendingOwner() public view virtual returns (address) {
-        return _pendingOwner;
+        Ownable2StepStorage storage $ = _getOwnable2StepStorage();
+        return $._pendingOwner;
     }
 
     /**
      * @dev Starts the ownership transfer of the contract to a new account. Replaces the pending transfer if there is one.
      * Can only be called by the current owner.
      */
     function transferOwnership(address newOwner) public virtual override onlyOwner {
-        _pendingOwner = newOwner;
+        Ownable2StepStorage storage $ = _getOwnable2StepStorage();
+        $._pendingOwner = newOwner;
         emit OwnershipTransferStarted(owner(), newOwner);
     }
 
@@ -48,7 +62,8 @@ abstract contract Ownable2StepUpgradeable is Initializable, OwnableUpgradeable {
      * Internal function without access restriction.
      */
     function _transferOwnership(address newOwner) internal virtual override {
-        delete _pendingOwner;
+        Ownable2StepStorage storage $ = _getOwnable2StepStorage();
+        delete $._pendingOwner;
         super._transferOwnership(newOwner);
     }
 
@@ -62,11 +77,4 @@ abstract contract Ownable2StepUpgradeable is Initializable, OwnableUpgradeable {
         }
         _transferOwnership(sender);
     }
-
-    /**
-     * @dev This empty reserved space is put in place to allow future versions to add new
-     * variables without shifting down storage in the inheritance chain.
-     * See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
-     */
-    uint256[49] private __gap;
 }

contracts/access/OwnableUpgradeable.sol

@@ -19,7 +19,19 @@ import "../proxy/utils/Initializable.sol";
  * the owner.
  */
 abstract contract OwnableUpgradeable is Initializable, ContextUpgradeable {
-    address private _owner;
+    /// @custom:storage-location erc7201:openzeppelin.storage.Ownable
+    struct OwnableStorage {
+        address _owner;
+    }
+
+    // keccak256(abi.encode(uint256(keccak256("openzeppelin.storage.Ownable")) - 1))
+    bytes32 private constant OwnableStorageLocation = 0x9016d09d72d40fdae2fd8ceac6b6234c7706214fd39c1cd1e609a0528c19938f;
+
+    function _getOwnableStorage() private pure returns (OwnableStorage storage $) {
+        assembly {
+            $.slot := OwnableStorageLocation
+        }
+    }
 
     /**
      * @dev The caller account is not authorized to perform an operation.
@@ -56,7 +68,8 @@ abstract contract OwnableUpgradeable is Initializable, ContextUpgradeable {
      * @dev Returns the address of the current owner.
      */
     function owner() public view virtual returns (address) {
-        return _owner;
+        OwnableStorage storage $ = _getOwnableStorage();
+        return $._owner;
     }
 
     /**
@@ -95,15 +108,9 @@ abstract contract OwnableUpgradeable is Initializable, ContextUpgradeable {
      * Internal function without access restriction.
      */
     function _transferOwnership(address newOwner) internal virtual {
-        address oldOwner = _owner;
-        _owner = newOwner;
+        OwnableStorage storage $ = _getOwnableStorage();
+        address oldOwner = $._owner;
+        $._owner = newOwner;
         emit OwnershipTransferred(oldOwner, newOwner);
     }
-
-    /**
-     * @dev This empty reserved space is put in place to allow future versions to add new
-     * variables without shifting down storage in the inheritance chain.
-     * See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
-     */
-    uint256[49] private __gap;
 }