Skip to content

Commit

Permalink
Add _initializableStorageSlot (#5337)
Browse files Browse the repository at this point in the history
Co-authored-by: Arr00 <13561405+arr00@users.noreply.github.com>
  • Loading branch information
ernestognw and arr00 authored Feb 24, 2025
1 parent 3bdc3a3 commit 2ed8956
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 1 deletion.
5 changes: 5 additions & 0 deletions .changeset/fast-coats-try.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'openzeppelin-solidity': minor
---

`Initializable`: Add `_initializableStorageSlot` function that returns a pointer to the storage struct. The function allows customizing with a custom storage slot with an `override`.
12 changes: 11 additions & 1 deletion contracts/proxy/utils/Initializable.sol
Original file line number Diff line number Diff line change
Expand Up @@ -216,13 +216,23 @@ abstract contract Initializable {
return _getInitializableStorage()._initializing;
}

/**
* @dev Pointer to storage slot. Allows integrators to override it with a custom storage location.
*
* NOTE: Consider following the ERC-7201 formula to derive storage locations.
*/
function _initializableStorageSlot() internal pure virtual returns (bytes32) {
return INITIALIZABLE_STORAGE;
}

/**
* @dev Returns a pointer to the storage namespace.
*/
// solhint-disable-next-line var-name-mixedcase
function _getInitializableStorage() private pure returns (InitializableStorage storage $) {
bytes32 slot = _initializableStorageSlot();
assembly {
$.slot := INITIALIZABLE_STORAGE
$.slot := slot
}
}
}

0 comments on commit 2ed8956

Please sign in to comment.