Skip to content

chore: set up storage reports #552

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nadir-akhtar wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

chore: set up storage reports #552

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/storage-report.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,9 @@ jobs:

- name: Compare outputs
run: |
if diff --unified pr target; then
if diff --unified target pr; then
echo "No differences found"
else
echo "::error::Differences found between PR and target branch storage layouts"
echo "::error::Differences found between target and PR branch storage layouts"
exit 1
fi
Empty file modified bin/storage-report.sh
100644 → 100755
View file
Open in desktop
Empty file.
23 changes: 23 additions & 0 deletions docs/storage-report/BLSApkRegistry.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@

╭----------------------+-----------------------------------------------------------+------+--------+-------+---------------------------------------╮
| Name | Type | Slot | Offset | Bytes | Contract |
+==================================================================================================================================================+
| _initialized | uint8 | 0 | 0 | 1 | src/BLSApkRegistry.sol:BLSApkRegistry |
|----------------------+-----------------------------------------------------------+------+--------+-------+---------------------------------------|
| _initializing | bool | 0 | 1 | 1 | src/BLSApkRegistry.sol:BLSApkRegistry |
|----------------------+-----------------------------------------------------------+------+--------+-------+---------------------------------------|
| operatorToPubkeyHash | mapping(address => bytes32) | 1 | 0 | 32 | src/BLSApkRegistry.sol:BLSApkRegistry |
|----------------------+-----------------------------------------------------------+------+--------+-------+---------------------------------------|
| pubkeyHashToOperator | mapping(bytes32 => address) | 2 | 0 | 32 | src/BLSApkRegistry.sol:BLSApkRegistry |
|----------------------+-----------------------------------------------------------+------+--------+-------+---------------------------------------|
| operatorToPubkey | mapping(address => struct BN254.G1Point) | 3 | 0 | 32 | src/BLSApkRegistry.sol:BLSApkRegistry |
|----------------------+-----------------------------------------------------------+------+--------+-------+---------------------------------------|
| apkHistory | mapping(uint8 => struct IBLSApkRegistryTypes.ApkUpdate[]) | 4 | 0 | 32 | src/BLSApkRegistry.sol:BLSApkRegistry |
|----------------------+-----------------------------------------------------------+------+--------+-------+---------------------------------------|
| currentApk | mapping(uint8 => struct BN254.G1Point) | 5 | 0 | 32 | src/BLSApkRegistry.sol:BLSApkRegistry |
|----------------------+-----------------------------------------------------------+------+--------+-------+---------------------------------------|
| operatorToPubkeyG2 | mapping(address => struct BN254.G2Point) | 6 | 0 | 32 | src/BLSApkRegistry.sol:BLSApkRegistry |
|----------------------+-----------------------------------------------------------+------+--------+-------+---------------------------------------|
| __GAP | uint256[44] | 7 | 0 | 1408 | src/BLSApkRegistry.sol:BLSApkRegistry |
╰----------------------+-----------------------------------------------------------+------+--------+-------+---------------------------------------╯

23 changes: 23 additions & 0 deletions docs/storage-report/BLSApkRegistryStorage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@

╭----------------------+-----------------------------------------------------------+------+--------+-------+-----------------------------------------------------╮
| Name | Type | Slot | Offset | Bytes | Contract |
+================================================================================================================================================================+
| _initialized | uint8 | 0 | 0 | 1 | src/BLSApkRegistryStorage.sol:BLSApkRegistryStorage |
|----------------------+-----------------------------------------------------------+------+--------+-------+-----------------------------------------------------|
| _initializing | bool | 0 | 1 | 1 | src/BLSApkRegistryStorage.sol:BLSApkRegistryStorage |
|----------------------+-----------------------------------------------------------+------+--------+-------+-----------------------------------------------------|
| operatorToPubkeyHash | mapping(address => bytes32) | 1 | 0 | 32 | src/BLSApkRegistryStorage.sol:BLSApkRegistryStorage |
|----------------------+-----------------------------------------------------------+------+--------+-------+-----------------------------------------------------|
| pubkeyHashToOperator | mapping(bytes32 => address) | 2 | 0 | 32 | src/BLSApkRegistryStorage.sol:BLSApkRegistryStorage |
|----------------------+-----------------------------------------------------------+------+--------+-------+-----------------------------------------------------|
| operatorToPubkey | mapping(address => struct BN254.G1Point) | 3 | 0 | 32 | src/BLSApkRegistryStorage.sol:BLSApkRegistryStorage |
|----------------------+-----------------------------------------------------------+------+--------+-------+-----------------------------------------------------|
| apkHistory | mapping(uint8 => struct IBLSApkRegistryTypes.ApkUpdate[]) | 4 | 0 | 32 | src/BLSApkRegistryStorage.sol:BLSApkRegistryStorage |
|----------------------+-----------------------------------------------------------+------+--------+-------+-----------------------------------------------------|
| currentApk | mapping(uint8 => struct BN254.G1Point) | 5 | 0 | 32 | src/BLSApkRegistryStorage.sol:BLSApkRegistryStorage |
|----------------------+-----------------------------------------------------------+------+--------+-------+-----------------------------------------------------|
| operatorToPubkeyG2 | mapping(address => struct BN254.G2Point) | 6 | 0 | 32 | src/BLSApkRegistryStorage.sol:BLSApkRegistryStorage |
|----------------------+-----------------------------------------------------------+------+--------+-------+-----------------------------------------------------|
| __GAP | uint256[44] | 7 | 0 | 1408 | src/BLSApkRegistryStorage.sol:BLSApkRegistryStorage |
╰----------------------+-----------------------------------------------------------+------+--------+-------+-----------------------------------------------------╯

9 changes: 9 additions & 0 deletions docs/storage-report/BLSSignatureChecker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@

╭-----------------------------------+-------------+------+--------+-------+-------------------------------------------------╮
| Name | Type | Slot | Offset | Bytes | Contract |
+===========================================================================================================================+
| __deprecated_staleStakesForbidden | bool | 0 | 0 | 1 | src/BLSSignatureChecker.sol:BLSSignatureChecker |
|-----------------------------------+-------------+------+--------+-------+-------------------------------------------------|
| __GAP | uint256[49] | 1 | 0 | 1568 | src/BLSSignatureChecker.sol:BLSSignatureChecker |
╰-----------------------------------+-------------+------+--------+-------+-------------------------------------------------╯

9 changes: 9 additions & 0 deletions docs/storage-report/BLSSignatureCheckerStorage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@

╭-----------------------------------+-------------+------+--------+-------+---------------------------------------------------------------╮
| Name | Type | Slot | Offset | Bytes | Contract |
+=========================================================================================================================================+
| __deprecated_staleStakesForbidden | bool | 0 | 0 | 1 | src/BLSSignatureCheckerStorage.sol:BLSSignatureCheckerStorage |
|-----------------------------------+-------------+------+--------+-------+---------------------------------------------------------------|
| __GAP | uint256[49] | 1 | 0 | 1568 | src/BLSSignatureCheckerStorage.sol:BLSSignatureCheckerStorage |
╰-----------------------------------+-------------+------+--------+-------+---------------------------------------------------------------╯

23 changes: 23 additions & 0 deletions docs/storage-report/EjectionManager.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@

╭-----------------------+---------------------------------------------------------------------+------+--------+-------+-----------------------------------------╮
| Name | Type | Slot | Offset | Bytes | Contract |
+===============================================================================================================================================================+
| _initialized | uint8 | 0 | 0 | 1 | src/EjectionManager.sol:EjectionManager |
|-----------------------+---------------------------------------------------------------------+------+--------+-------+-----------------------------------------|
| _initializing | bool | 0 | 1 | 1 | src/EjectionManager.sol:EjectionManager |
|-----------------------+---------------------------------------------------------------------+------+--------+-------+-----------------------------------------|
| __gap | uint256[50] | 1 | 0 | 1600 | src/EjectionManager.sol:EjectionManager |
|-----------------------+---------------------------------------------------------------------+------+--------+-------+-----------------------------------------|
| _owner | address | 51 | 0 | 20 | src/EjectionManager.sol:EjectionManager |
|-----------------------+---------------------------------------------------------------------+------+--------+-------+-----------------------------------------|
| __gap | uint256[49] | 52 | 0 | 1568 | src/EjectionManager.sol:EjectionManager |
|-----------------------+---------------------------------------------------------------------+------+--------+-------+-----------------------------------------|
| isEjector | mapping(address => bool) | 101 | 0 | 32 | src/EjectionManager.sol:EjectionManager |
|-----------------------+---------------------------------------------------------------------+------+--------+-------+-----------------------------------------|
| stakeEjectedForQuorum | mapping(uint8 => struct IEjectionManagerTypes.StakeEjection[]) | 102 | 0 | 32 | src/EjectionManager.sol:EjectionManager |
|-----------------------+---------------------------------------------------------------------+------+--------+-------+-----------------------------------------|
| quorumEjectionParams | mapping(uint8 => struct IEjectionManagerTypes.QuorumEjectionParams) | 103 | 0 | 32 | src/EjectionManager.sol:EjectionManager |
|-----------------------+---------------------------------------------------------------------+------+--------+-------+-----------------------------------------|
| __gap | uint256[47] | 104 | 0 | 1504 | src/EjectionManager.sol:EjectionManager |
╰-----------------------+---------------------------------------------------------------------+------+--------+-------+-----------------------------------------╯

13 changes: 13 additions & 0 deletions docs/storage-report/EjectionManagerStorage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@

╭-----------------------+---------------------------------------------------------------------+------+--------+-------+-------------------------------------------------------╮
| Name | Type | Slot | Offset | Bytes | Contract |
+=============================================================================================================================================================================+
| isEjector | mapping(address => bool) | 0 | 0 | 32 | src/EjectionManagerStorage.sol:EjectionManagerStorage |
|-----------------------+---------------------------------------------------------------------+------+--------+-------+-------------------------------------------------------|
| stakeEjectedForQuorum | mapping(uint8 => struct IEjectionManagerTypes.StakeEjection[]) | 1 | 0 | 32 | src/EjectionManagerStorage.sol:EjectionManagerStorage |
|-----------------------+---------------------------------------------------------------------+------+--------+-------+-------------------------------------------------------|
| quorumEjectionParams | mapping(uint8 => struct IEjectionManagerTypes.QuorumEjectionParams) | 2 | 0 | 32 | src/EjectionManagerStorage.sol:EjectionManagerStorage |
|-----------------------+---------------------------------------------------------------------+------+--------+-------+-------------------------------------------------------|
| __gap | uint256[47] | 3 | 0 | 1504 | src/EjectionManagerStorage.sol:EjectionManagerStorage |
╰-----------------------+---------------------------------------------------------------------+------+--------+-------+-------------------------------------------------------╯

17 changes: 17 additions & 0 deletions docs/storage-report/IndexRegistry.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@

╭-----------------------+----------------------------------------------------------------------------------+------+--------+-------+-------------------------------------╮
| Name | Type | Slot | Offset | Bytes | Contract |
+========================================================================================================================================================================+
| _initialized | uint8 | 0 | 0 | 1 | src/IndexRegistry.sol:IndexRegistry |
|-----------------------+----------------------------------------------------------------------------------+------+--------+-------+-------------------------------------|
| _initializing | bool | 0 | 1 | 1 | src/IndexRegistry.sol:IndexRegistry |
|-----------------------+----------------------------------------------------------------------------------+------+--------+-------+-------------------------------------|
| currentOperatorIndex | mapping(uint8 => mapping(bytes32 => uint32)) | 1 | 0 | 32 | src/IndexRegistry.sol:IndexRegistry |
|-----------------------+----------------------------------------------------------------------------------+------+--------+-------+-------------------------------------|
| _operatorIndexHistory | mapping(uint8 => mapping(uint32 => struct IIndexRegistryTypes.OperatorUpdate[])) | 2 | 0 | 32 | src/IndexRegistry.sol:IndexRegistry |
|-----------------------+----------------------------------------------------------------------------------+------+--------+-------+-------------------------------------|
| _operatorCountHistory | mapping(uint8 => struct IIndexRegistryTypes.QuorumUpdate[]) | 3 | 0 | 32 | src/IndexRegistry.sol:IndexRegistry |
|-----------------------+----------------------------------------------------------------------------------+------+--------+-------+-------------------------------------|
| __GAP | uint256[47] | 4 | 0 | 1504 | src/IndexRegistry.sol:IndexRegistry |
╰-----------------------+----------------------------------------------------------------------------------+------+--------+-------+-------------------------------------╯

17 changes: 17 additions & 0 deletions docs/storage-report/IndexRegistryStorage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@

╭-----------------------+----------------------------------------------------------------------------------+------+--------+-------+---------------------------------------------------╮
| Name | Type | Slot | Offset | Bytes | Contract |
+======================================================================================================================================================================================+
| _initialized | uint8 | 0 | 0 | 1 | src/IndexRegistryStorage.sol:IndexRegistryStorage |
|-----------------------+----------------------------------------------------------------------------------+------+--------+-------+---------------------------------------------------|
| _initializing | bool | 0 | 1 | 1 | src/IndexRegistryStorage.sol:IndexRegistryStorage |
|-----------------------+----------------------------------------------------------------------------------+------+--------+-------+---------------------------------------------------|
| currentOperatorIndex | mapping(uint8 => mapping(bytes32 => uint32)) | 1 | 0 | 32 | src/IndexRegistryStorage.sol:IndexRegistryStorage |
|-----------------------+----------------------------------------------------------------------------------+------+--------+-------+---------------------------------------------------|
| _operatorIndexHistory | mapping(uint8 => mapping(uint32 => struct IIndexRegistryTypes.OperatorUpdate[])) | 2 | 0 | 32 | src/IndexRegistryStorage.sol:IndexRegistryStorage |
|-----------------------+----------------------------------------------------------------------------------+------+--------+-------+---------------------------------------------------|
| _operatorCountHistory | mapping(uint8 => struct IIndexRegistryTypes.QuorumUpdate[]) | 3 | 0 | 32 | src/IndexRegistryStorage.sol:IndexRegistryStorage |
|-----------------------+----------------------------------------------------------------------------------+------+--------+-------+---------------------------------------------------|
| __GAP | uint256[47] | 4 | 0 | 1504 | src/IndexRegistryStorage.sol:IndexRegistryStorage |
╰-----------------------+----------------------------------------------------------------------------------+------+--------+-------+---------------------------------------------------╯

6 changes: 6 additions & 0 deletions docs/storage-report/OperatorStateRetriever.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@

╭------+------+------+--------+-------+----------╮
| Name | Type | Slot | Offset | Bytes | Contract |
+================================================+
╰------+------+------+--------+-------+----------╯

Loading