Skip to content

Commit

Permalink
refactor: natspec + interfaces
Browse files Browse the repository at this point in the history 
refactor: natspec + interfaces

refactor: natspec + interfaces

docs: `RegistryCoordinator` natspec

chore: forge fmt

refactor: named mapping params

docs: natspec `BLSApkRegistry`

docs: natspec `BLSApkRegistry`

docs: natspec `BLSApkRegistry`

refactor: interface structure

refactor: separate `BLSSignatureChecker` storage

refactor: rename -> `IECDSAStakeRegistry`

docs: natspec

docs: natspec `ECDSAStakeRegistry`

docs: natspec `EjectionManager` + separate storage

docs: natspec

docs: natspec `IndexRegistry`

refactor: remove `IRegistry`

chore: forge fmt

chore: make storage-report

docs: natspec

refactor: remove `ISocketUpdater`

refactor: use

refactor: remove todo

refactor: `///` -> `/**`

refactor: improve comment

refactor: rename var

refactor: improve comment
  • Loading branch information
@0xClandestine
0xClandestine committed Jan 27, 2025
1 parent 57f70ba commit c84342a
Show file tree
Hide file tree
Showing 64 changed files with 3,519 additions and 1,925 deletions.
2 changes: 1 addition & 1 deletion .github/bin/storage-report.sh
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ for file in $(find src/ -name "*.sol" ! -path "*/interfaces/*" ! -path "*/librar
log "Processing contract: $contract_name"

# Run forge inspect and capture errors
if ! forge inspect "$contract_name" storage --pretty > "$OUTPUT_DIR/$contract_name.md"; then
if ! forge inspect "$contract_name" storage > "$OUTPUT_DIR/$contract_name.md"; then
error "Failed to generate storage report for contract: $contract_name"
else
log "Storage report generated for contract: $contract_name"
Expand Down
2 changes: 1 addition & 1 deletion bin/storage-report.sh
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ for file in $(find src/ -name "*.sol" ! -path "*/interfaces/*" ! -path "*/librar
log "Processing contract: $contract_name"

# Run forge inspect and capture errors
if ! forge inspect "$contract_name" storage --pretty > "$OUTPUT_DIR/$contract_name.md"; then
if ! forge inspect "$contract_name" storage > "$OUTPUT_DIR/$contract_name.md"; then
error "Failed to generate storage report for contract: $contract_name"
else
log "Storage report generated for contract: $contract_name"
Expand Down
6 changes: 3 additions & 3 deletions docs/RegistryCoordinator.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ These methods allow operators to register for/deregister from one or more quorum
function registerOperator(
bytes calldata quorumNumbers,
string calldata socket,
IBLSApkRegistry.PubkeyRegistrationParams calldata params,
IBLSApkRegistryTypes.PubkeyRegistrationParams calldata params,
SignatureWithSaltAndExpiry memory operatorSignature
)
external
Expand Down Expand Up @@ -88,7 +88,7 @@ If the Operator was not currently registered for any quorums, this method will r
function registerOperatorWithChurn(
bytes calldata quorumNumbers,
string calldata socket,
IBLSApkRegistry.PubkeyRegistrationParams calldata params,
IBLSApkRegistryTypes.PubkeyRegistrationParams calldata params,
OperatorKickParam[] calldata operatorKickParams,
SignatureWithSaltAndExpiry memory churnApproverSignature,
SignatureWithSaltAndExpiry memory operatorSignature
Expand Down Expand Up @@ -256,7 +256,7 @@ These methods are used by the Owner to configure the `RegistryCoordinator`:
function createQuorum(
OperatorSetParam memory operatorSetParams,
uint96 minimumStake,
IStakeRegistry.StrategyParams[] memory strategyParams
IStakeRegistryTypes.StrategyParams[] memory strategyParams
)
external
virtual
Expand Down
21 changes: 21 additions & 0 deletions docs/storage-report/BLSApkRegistry.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@

╭----------------------+-----------------------------------------------------------+------+--------+-------+---------------------------------------╮
| 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 |
|----------------------+-----------------------------------------------------------+------+--------+-------+---------------------------------------|
| __GAP | uint256[45] | 6 | 0 | 1440 | src/BLSApkRegistry.sol:BLSApkRegistry |
╰----------------------+-----------------------------------------------------------+------+--------+-------+---------------------------------------╯

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

╭----------------------+-----------------------------------------------------------+------+--------+-------+-----------------------------------------------------╮
| 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 |
|----------------------+-----------------------------------------------------------+------+--------+-------+-----------------------------------------------------|
| __GAP | uint256[45] | 6 | 0 | 1440 | src/BLSApkRegistryStorage.sol:BLSApkRegistryStorage |
╰----------------------+-----------------------------------------------------------+------+--------+-------+-----------------------------------------------------╯

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

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

2 changes: 1 addition & 1 deletion docs/storage-report/ECDSAStakeRegistry.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
|----------------------------+-----------------------------------------------------------+------+--------+-------+---------------------------------------------------------|
| _totalOperators | uint256 | 101 | 0 | 32 | src/unaudited/ECDSAStakeRegistry.sol:ECDSAStakeRegistry |
|----------------------------+-----------------------------------------------------------+------+--------+-------+---------------------------------------------------------|
| _quorum | struct Quorum | 102 | 0 | 32 | src/unaudited/ECDSAStakeRegistry.sol:ECDSAStakeRegistry |
| _quorum | struct IECDSAStakeRegistryTypes.Quorum | 102 | 0 | 32 | src/unaudited/ECDSAStakeRegistry.sol:ECDSAStakeRegistry |
|----------------------------+-----------------------------------------------------------+------+--------+-------+---------------------------------------------------------|
| _minimumWeight | uint256 | 103 | 0 | 32 | src/unaudited/ECDSAStakeRegistry.sol:ECDSAStakeRegistry |
|----------------------------+-----------------------------------------------------------+------+--------+-------+---------------------------------------------------------|
Expand Down
2 changes: 1 addition & 1 deletion docs/storage-report/ECDSAStakeRegistryEqualWeight.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
|----------------------------+-----------------------------------------------------------+------+--------+-------+----------------------------------------------------------------------------------------|
| _totalOperators | uint256 | 101 | 0 | 32 | src/unaudited/examples/ECDSAStakeRegistryEqualWeight.sol:ECDSAStakeRegistryEqualWeight |
|----------------------------+-----------------------------------------------------------+------+--------+-------+----------------------------------------------------------------------------------------|
| _quorum | struct Quorum | 102 | 0 | 32 | src/unaudited/examples/ECDSAStakeRegistryEqualWeight.sol:ECDSAStakeRegistryEqualWeight |
| _quorum | struct IECDSAStakeRegistryTypes.Quorum | 102 | 0 | 32 | src/unaudited/examples/ECDSAStakeRegistryEqualWeight.sol:ECDSAStakeRegistryEqualWeight |
|----------------------------+-----------------------------------------------------------+------+--------+-------+----------------------------------------------------------------------------------------|
| _minimumWeight | uint256 | 103 | 0 | 32 | src/unaudited/examples/ECDSAStakeRegistryEqualWeight.sol:ECDSAStakeRegistryEqualWeight |
|----------------------------+-----------------------------------------------------------+------+--------+-------+----------------------------------------------------------------------------------------|
Expand Down
2 changes: 1 addition & 1 deletion docs/storage-report/ECDSAStakeRegistryPermissioned.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
|----------------------------+-----------------------------------------------------------+------+--------+-------+------------------------------------------------------------------------------------------|
| _totalOperators | uint256 | 101 | 0 | 32 | src/unaudited/examples/ECDSAStakeRegistryPermissioned.sol:ECDSAStakeRegistryPermissioned |
|----------------------------+-----------------------------------------------------------+------+--------+-------+------------------------------------------------------------------------------------------|
| _quorum | struct Quorum | 102 | 0 | 32 | src/unaudited/examples/ECDSAStakeRegistryPermissioned.sol:ECDSAStakeRegistryPermissioned |
| _quorum | struct IECDSAStakeRegistryTypes.Quorum | 102 | 0 | 32 | src/unaudited/examples/ECDSAStakeRegistryPermissioned.sol:ECDSAStakeRegistryPermissioned |
|----------------------------+-----------------------------------------------------------+------+--------+-------+------------------------------------------------------------------------------------------|
| _minimumWeight | uint256 | 103 | 0 | 32 | src/unaudited/examples/ECDSAStakeRegistryPermissioned.sol:ECDSAStakeRegistryPermissioned |
|----------------------------+-----------------------------------------------------------+------+--------+-------+------------------------------------------------------------------------------------------|
Expand Down
2 changes: 1 addition & 1 deletion docs/storage-report/ECDSAStakeRegistryStorage.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
+========================================================================================================================================================================================+
| _totalOperators | uint256 | 0 | 0 | 32 | src/unaudited/ECDSAStakeRegistryStorage.sol:ECDSAStakeRegistryStorage |
|----------------------------+-----------------------------------------------------------+------+--------+-------+-----------------------------------------------------------------------|
| _quorum | struct Quorum | 1 | 0 | 32 | src/unaudited/ECDSAStakeRegistryStorage.sol:ECDSAStakeRegistryStorage |
| _quorum | struct IECDSAStakeRegistryTypes.Quorum | 1 | 0 | 32 | src/unaudited/ECDSAStakeRegistryStorage.sol:ECDSAStakeRegistryStorage |
|----------------------------+-----------------------------------------------------------+------+--------+-------+-----------------------------------------------------------------------|
| _minimumWeight | uint256 | 2 | 0 | 32 | src/unaudited/ECDSAStakeRegistryStorage.sol:ECDSAStakeRegistryStorage |
|----------------------------+-----------------------------------------------------------+------+--------+-------+-----------------------------------------------------------------------|
Expand Down
21 changes: 21 additions & 0 deletions docs/storage-report/EjectionManager.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@

╭-----------------------+---------------------------------------------------------------------+------+--------+-------+-----------------------------------------╮
| 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 |
╰-----------------------+---------------------------------------------------------------------+------+--------+-------+-----------------------------------------╯

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

╭-----------------------+---------------------------------------------------------------------+------+--------+-------+-------------------------------------------------------╮
| 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 |
╰-----------------------+---------------------------------------------------------------------+------+--------+-------+-------------------------------------------------------╯

Loading

0 comments on commit c84342a

Please sign in to comment.