Skip to content
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

Jump to bottom

feat: ci storage reports #750

Merged
merged 7 commits into from
Sep 16, 2024
Merged

feat: ci storage reports #750

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
b41407c
feat: ci storage diff
0xClandestine Sep 16, 2024
19ebb06
fix: ci
0xClandestine Sep 16, 2024
00300b0
nit: ci name
0xClandestine Sep 16, 2024
de2b326
fix: ci
0xClandestine Sep 16, 2024
a483bc8
fix: ci
0xClandestine Sep 16, 2024
6320651
chore: remove generated report
0xClandestine Sep 16, 2024
ba9445d
fix: debug ci
0xClandestine Sep 16, 2024
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
39 changes: 39 additions & 0 deletions .github/workflows/storage-report.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: Check Storage Layout
on:
workflow_dispatch:
pull_request:
0xClandestine marked this conversation as resolved.
Show resolved Hide resolved
push:
branches:
- "dev"
jobs:
check_storage:
runs-on: "ubuntu-latest"
steps:
- uses: actions/checkout@v4
with:
submodules: recursive
- name: Install Foundry
uses: foundry-rs/foundry-toolchain@v1
with:
version: nightly

- name: "Generate and prepare the contract artifacts for current branch"
run: |
bash bin/storage-report.sh

- name: Checkout main
env:
MAIN: ${{ github.event.pull_request.base.sha }}
run: |
git fetch origin $MAIN
git checkout $MAIN

- name: "Generate and prepare the contract artifacts for main branch"
run: |
bash bin/storage-report.sh

- name: Compare outputs
run: |
0xClandestine marked this conversation as resolved.
Show resolved Hide resolved
if ! diff --unified pr main; then
echo "::warning::Differences found between PR and main storage layouts"
fi
3 changes: 3 additions & 0 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,3 +43,6 @@ all-in-docker:

gha-docker:
docker run -v $(PWD):/build -w /build --rm -i ${CONTAINER_NAME}:latest bash -c "make gha"

storage-report:
bash "bin/storage-report.sh"
6 changes: 6 additions & 0 deletions bin/storage-report.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
#!/bin/sh
mkdir docs/storage-report
for file in $(find src/contracts -name "*.sol" ! -path "src/contracts/interfaces/*" ! -path "src/contracts/libraries/*"); do
contract_name=$(basename "$file" .sol)
forge inspect "$contract_name" storage --pretty > docs/storage-report/"$contract_name".md
done
16 changes: 16 additions & 0 deletions docs/storage-report/AVSDirectory.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
| Name | Type | Slot | Offset | Bytes | Contract |
|---------------------|------------------------------------------------------------------------------------------|------|--------|-------|--------------------------------------------------|
| _initialized | uint8 | 0 | 0 | 1 | src/contracts/core/AVSDirectory.sol:AVSDirectory |
| _initializing | bool | 0 | 1 | 1 | src/contracts/core/AVSDirectory.sol:AVSDirectory |
| __gap | uint256[50] | 1 | 0 | 1600 | src/contracts/core/AVSDirectory.sol:AVSDirectory |
| _owner | address | 51 | 0 | 20 | src/contracts/core/AVSDirectory.sol:AVSDirectory |
| __gap | uint256[49] | 52 | 0 | 1568 | src/contracts/core/AVSDirectory.sol:AVSDirectory |
| pauserRegistry | contract IPauserRegistry | 101 | 0 | 20 | src/contracts/core/AVSDirectory.sol:AVSDirectory |
| _paused | uint256 | 102 | 0 | 32 | src/contracts/core/AVSDirectory.sol:AVSDirectory |
| __gap | uint256[48] | 103 | 0 | 1536 | src/contracts/core/AVSDirectory.sol:AVSDirectory |
| _DOMAIN_SEPARATOR | bytes32 | 151 | 0 | 32 | src/contracts/core/AVSDirectory.sol:AVSDirectory |
| avsOperatorStatus | mapping(address => mapping(address => enum IAVSDirectory.OperatorAVSRegistrationStatus)) | 152 | 0 | 32 | src/contracts/core/AVSDirectory.sol:AVSDirectory |
| operatorSaltIsSpent | mapping(address => mapping(bytes32 => bool)) | 153 | 0 | 32 | src/contracts/core/AVSDirectory.sol:AVSDirectory |
| __gap | uint256[47] | 154 | 0 | 1504 | src/contracts/core/AVSDirectory.sol:AVSDirectory |
| _status | uint256 | 201 | 0 | 32 | src/contracts/core/AVSDirectory.sol:AVSDirectory |
| __gap | uint256[49] | 202 | 0 | 1568 | src/contracts/core/AVSDirectory.sol:AVSDirectory |
6 changes: 6 additions & 0 deletions docs/storage-report/AVSDirectoryStorage.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 |
|---------------------|------------------------------------------------------------------------------------------|------|--------|-------|----------------------------------------------------------------|
| _DOMAIN_SEPARATOR | bytes32 | 0 | 0 | 32 | src/contracts/core/AVSDirectoryStorage.sol:AVSDirectoryStorage |
| avsOperatorStatus | mapping(address => mapping(address => enum IAVSDirectory.OperatorAVSRegistrationStatus)) | 1 | 0 | 32 | src/contracts/core/AVSDirectoryStorage.sol:AVSDirectoryStorage |
| operatorSaltIsSpent | mapping(address => mapping(bytes32 => bool)) | 2 | 0 | 32 | src/contracts/core/AVSDirectoryStorage.sol:AVSDirectoryStorage |
| __gap | uint256[47] | 3 | 0 | 1504 | src/contracts/core/AVSDirectoryStorage.sol:AVSDirectoryStorage |
28 changes: 28 additions & 0 deletions docs/storage-report/BackingEigen.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
| Name | Type | Slot | Offset | Bytes | Contract |
|-----------------------------------|---------------------------------------------------------------|------|--------|-------|---------------------------------------------------|
| _initialized | uint8 | 0 | 0 | 1 | src/contracts/token/BackingEigen.sol:BackingEigen |
| _initializing | bool | 0 | 1 | 1 | src/contracts/token/BackingEigen.sol:BackingEigen |
| __gap | uint256[50] | 1 | 0 | 1600 | src/contracts/token/BackingEigen.sol:BackingEigen |
| _owner | address | 51 | 0 | 20 | src/contracts/token/BackingEigen.sol:BackingEigen |
| __gap | uint256[49] | 52 | 0 | 1568 | src/contracts/token/BackingEigen.sol:BackingEigen |
| _balances | mapping(address => uint256) | 101 | 0 | 32 | src/contracts/token/BackingEigen.sol:BackingEigen |
| _allowances | mapping(address => mapping(address => uint256)) | 102 | 0 | 32 | src/contracts/token/BackingEigen.sol:BackingEigen |
| _totalSupply | uint256 | 103 | 0 | 32 | src/contracts/token/BackingEigen.sol:BackingEigen |
| _name | string | 104 | 0 | 32 | src/contracts/token/BackingEigen.sol:BackingEigen |
| _symbol | string | 105 | 0 | 32 | src/contracts/token/BackingEigen.sol:BackingEigen |
| __gap | uint256[45] | 106 | 0 | 1440 | src/contracts/token/BackingEigen.sol:BackingEigen |
| _hashedName | bytes32 | 151 | 0 | 32 | src/contracts/token/BackingEigen.sol:BackingEigen |
| _hashedVersion | bytes32 | 152 | 0 | 32 | src/contracts/token/BackingEigen.sol:BackingEigen |
| _name | string | 153 | 0 | 32 | src/contracts/token/BackingEigen.sol:BackingEigen |
| _version | string | 154 | 0 | 32 | src/contracts/token/BackingEigen.sol:BackingEigen |
| __gap | uint256[48] | 155 | 0 | 1536 | src/contracts/token/BackingEigen.sol:BackingEigen |
| _nonces | mapping(address => struct CountersUpgradeable.Counter) | 203 | 0 | 32 | src/contracts/token/BackingEigen.sol:BackingEigen |
| _PERMIT_TYPEHASH_DEPRECATED_SLOT | bytes32 | 204 | 0 | 32 | src/contracts/token/BackingEigen.sol:BackingEigen |
| __gap | uint256[49] | 205 | 0 | 1568 | src/contracts/token/BackingEigen.sol:BackingEigen |
| _delegates | mapping(address => address) | 254 | 0 | 32 | src/contracts/token/BackingEigen.sol:BackingEigen |
| _checkpoints | mapping(address => struct ERC20VotesUpgradeable.Checkpoint[]) | 255 | 0 | 32 | src/contracts/token/BackingEigen.sol:BackingEigen |
| _totalSupplyCheckpoints | struct ERC20VotesUpgradeable.Checkpoint[] | 256 | 0 | 32 | src/contracts/token/BackingEigen.sol:BackingEigen |
| __gap | uint256[47] | 257 | 0 | 1504 | src/contracts/token/BackingEigen.sol:BackingEigen |
| transferRestrictionsDisabledAfter | uint256 | 304 | 0 | 32 | src/contracts/token/BackingEigen.sol:BackingEigen |
| allowedFrom | mapping(address => bool) | 305 | 0 | 32 | src/contracts/token/BackingEigen.sol:BackingEigen |
| allowedTo | mapping(address => bool) | 306 | 0 | 32 | src/contracts/token/BackingEigen.sol:BackingEigen |
24 changes: 24 additions & 0 deletions docs/storage-report/DelegationManager.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
| Name | Type | Slot | Offset | Bytes | Contract |
|-------------------------------|---------------------------------------------------------------|------|--------|-------|------------------------------------------------------------|
| _initialized | uint8 | 0 | 0 | 1 | src/contracts/core/DelegationManager.sol:DelegationManager |
| _initializing | bool | 0 | 1 | 1 | src/contracts/core/DelegationManager.sol:DelegationManager |
| __gap | uint256[50] | 1 | 0 | 1600 | src/contracts/core/DelegationManager.sol:DelegationManager |
| _owner | address | 51 | 0 | 20 | src/contracts/core/DelegationManager.sol:DelegationManager |
| __gap | uint256[49] | 52 | 0 | 1568 | src/contracts/core/DelegationManager.sol:DelegationManager |
| pauserRegistry | contract IPauserRegistry | 101 | 0 | 20 | src/contracts/core/DelegationManager.sol:DelegationManager |
| _paused | uint256 | 102 | 0 | 32 | src/contracts/core/DelegationManager.sol:DelegationManager |
| __gap | uint256[48] | 103 | 0 | 1536 | src/contracts/core/DelegationManager.sol:DelegationManager |
| _DOMAIN_SEPARATOR | bytes32 | 151 | 0 | 32 | src/contracts/core/DelegationManager.sol:DelegationManager |
| operatorShares | mapping(address => mapping(contract IStrategy => uint256)) | 152 | 0 | 32 | src/contracts/core/DelegationManager.sol:DelegationManager |
| _operatorDetails | mapping(address => struct IDelegationManager.OperatorDetails) | 153 | 0 | 32 | src/contracts/core/DelegationManager.sol:DelegationManager |
| delegatedTo | mapping(address => address) | 154 | 0 | 32 | src/contracts/core/DelegationManager.sol:DelegationManager |
| stakerNonce | mapping(address => uint256) | 155 | 0 | 32 | src/contracts/core/DelegationManager.sol:DelegationManager |
| delegationApproverSaltIsSpent | mapping(address => mapping(bytes32 => bool)) | 156 | 0 | 32 | src/contracts/core/DelegationManager.sol:DelegationManager |
| minWithdrawalDelayBlocks | uint256 | 157 | 0 | 32 | src/contracts/core/DelegationManager.sol:DelegationManager |
| pendingWithdrawals | mapping(bytes32 => bool) | 158 | 0 | 32 | src/contracts/core/DelegationManager.sol:DelegationManager |
| cumulativeWithdrawalsQueued | mapping(address => uint256) | 159 | 0 | 32 | src/contracts/core/DelegationManager.sol:DelegationManager |
| __deprecated_stakeRegistry | address | 160 | 0 | 20 | src/contracts/core/DelegationManager.sol:DelegationManager |
| strategyWithdrawalDelayBlocks | mapping(contract IStrategy => uint256) | 161 | 0 | 32 | src/contracts/core/DelegationManager.sol:DelegationManager |
| __gap | uint256[39] | 162 | 0 | 1248 | src/contracts/core/DelegationManager.sol:DelegationManager |
| _status | uint256 | 201 | 0 | 32 | src/contracts/core/DelegationManager.sol:DelegationManager |
| __gap | uint256[49] | 202 | 0 | 1568 | src/contracts/core/DelegationManager.sol:DelegationManager |
14 changes: 14 additions & 0 deletions docs/storage-report/DelegationManagerStorage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
| Name | Type | Slot | Offset | Bytes | Contract |
|-------------------------------|---------------------------------------------------------------|------|--------|-------|--------------------------------------------------------------------------|
| _DOMAIN_SEPARATOR | bytes32 | 0 | 0 | 32 | src/contracts/core/DelegationManagerStorage.sol:DelegationManagerStorage |
| operatorShares | mapping(address => mapping(contract IStrategy => uint256)) | 1 | 0 | 32 | src/contracts/core/DelegationManagerStorage.sol:DelegationManagerStorage |
| _operatorDetails | mapping(address => struct IDelegationManager.OperatorDetails) | 2 | 0 | 32 | src/contracts/core/DelegationManagerStorage.sol:DelegationManagerStorage |
| delegatedTo | mapping(address => address) | 3 | 0 | 32 | src/contracts/core/DelegationManagerStorage.sol:DelegationManagerStorage |
| stakerNonce | mapping(address => uint256) | 4 | 0 | 32 | src/contracts/core/DelegationManagerStorage.sol:DelegationManagerStorage |
| delegationApproverSaltIsSpent | mapping(address => mapping(bytes32 => bool)) | 5 | 0 | 32 | src/contracts/core/DelegationManagerStorage.sol:DelegationManagerStorage |
| minWithdrawalDelayBlocks | uint256 | 6 | 0 | 32 | src/contracts/core/DelegationManagerStorage.sol:DelegationManagerStorage |
| pendingWithdrawals | mapping(bytes32 => bool) | 7 | 0 | 32 | src/contracts/core/DelegationManagerStorage.sol:DelegationManagerStorage |
| cumulativeWithdrawalsQueued | mapping(address => uint256) | 8 | 0 | 32 | src/contracts/core/DelegationManagerStorage.sol:DelegationManagerStorage |
| __deprecated_stakeRegistry | address | 9 | 0 | 20 | src/contracts/core/DelegationManagerStorage.sol:DelegationManagerStorage |
| strategyWithdrawalDelayBlocks | mapping(contract IStrategy => uint256) | 10 | 0 | 32 | src/contracts/core/DelegationManagerStorage.sol:DelegationManagerStorage |
| __gap | uint256[39] | 11 | 0 | 1248 | src/contracts/core/DelegationManagerStorage.sol:DelegationManagerStorage |
Loading
Loading