feat: from scratch scripts

.github/bin/storage-report.sh

@@ -0,0 +1,45 @@
+#!/bin/sh
+
+# Default output directory
+OUTPUT_DIR=${1:-docs/storage-report}
+
+# Function to print messages
+log() {
+    echo "$(date '+%Y-%m-%d %H:%M:%S') [INFO] $1"
+}
+
+# Function to print error messages
+error() {
+    echo "$(date '+%Y-%m-%d %H:%M:%S') [ERROR] $1" >&2
+}
+
+log "Starting the storage report generation."
+
+# Create the output directory if it doesn't exist
+if ! mkdir -p "$OUTPUT_DIR"; then
+    error "Failed to create output directory: $OUTPUT_DIR"
+    exit 1
+fi
+
+log "Output directory is set to: $OUTPUT_DIR"
+
+# Loop through Solidity files and generate storage report
+# NOTE: Ignores `src/interfaces` & `src/libraries` since they "should" not contain storage logic.
+for file in $(find src/ -name "*.sol" ! -path "*/interfaces/*" ! -path "*/libraries/*"); do
+    contract_name=$(basename "$file" .sol)
+
+    # Check if the file exists and is readable
+    if [ ! -r "$file" ]; then
+        error "Cannot read file: $file"
+        continue
+    fi
+
+    log "Processing contract: $contract_name"
+
+    # Run forge inspect and capture errors
+    if ! forge inspect "$contract_name" storage --pretty > "$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"
+    fi
+done

.github/workflows/storage-report.yml

@@ -0,0 +1,48 @@
+name: Storage Layout
+
+on:
+  push:
+    branches:
+      - master
+      - mainnet
+      - testnet-goerli
+      - dev
+  pull_request:
+
+jobs:
+  check_storage:
+    name: CI
+    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 storage reports for current branch"
+        run: |
+          bash .github/bin/storage-report.sh pr
+
+      - name: Checkout dev
+        env:
+          TARGET: ${{ github.event.pull_request.base.sha }}
+        run: |
+          git fetch origin $TARGET
+          git checkout $TARGET
+
+      - name: "Generate and prepare the storage reports for target branch"
+        run: |
+          bash .github/bin/storage-report.sh target
+
+      - name: Compare outputs
+        run: |
+          if diff --unified pr target; then
+            echo "No differences found"
+          else
+            echo "::error::Differences found between PR and target branch storage layouts"
+            exit 1
+          fi

.github/workflows/tests.yml

@@ -13,9 +13,6 @@ on:
       - dev
   pull_request:
 
-env:
-  FOUNDRY_PROFILE: ci
-
 jobs:
   check:
     strategy:
@@ -42,7 +39,7 @@ jobs:
       - name: Run tests
         shell: bash
         run: |
-          forge test --no-match-contract FFI
+          forge test --no-match-contract "FFI|ForkTest"
 
         env:
           RPC_MAINNET: ${{ secrets.RPC_MAINNET }}

Makefile

@@ -0,0 +1,2 @@
+storage-report:
+	bash ".github/bin/storage-report.sh" "docs/storage-report/"

README.md

@@ -15,6 +15,7 @@ EigenLayer is a set of smart contracts deployed on Ethereum that enable restakin
 ## Branching
 
 The main branches we use are:
+
 * [`dev (default)`](https://github.com/Layr-Labs/eigenlayer-middleware/tree/dev): The most up-to-date branch, containing the work-in-progress code for upcoming releases
 * [`testnet-holesky`](https://github.com/Layr-Labs/eigenlayer-middleware/tree/testnet-holesky): Our current testnet deployment
 * [`mainnet`](https://github.com/Layr-Labs/eigenlayer-middleware/tree/mainnet): Our current mainnet deployment
@@ -24,6 +25,7 @@ The main branches we use are:
 ### Basics
 
 To get a basic understanding of EigenLayer, check out [You Could've Invented EigenLayer](https://www.blog.eigenlayer.xyz/ycie/). Note that some of the document's content describes features that do not exist yet (like the Slasher). To understand more about how restakers and operators interact with EigenLayer, check out these guides:
+
 * [Restaking User Guide](https://docs.eigenlayer.xyz/restaking-guides/restaking-user-guide)
 * [Operator Guide](https://docs.eigenlayer.xyz/operator-guides/operator-introduction)
 
@@ -32,10 +34,25 @@ Most of this content is intro-level and describes user interactions with the Eig
 ### Deep Dive
 
 For shadowy super-coders:
+
 * The most up-to-date technical documentation can be found in [/docs](/docs).
 * To get an idea of how users interact with these contracts, check out the integration tests: [/test/integration](./test/integration)
 * To explore the EigenLayer core contracts, check out the core repo technical docs [here][core-docs-dev].
 
+### Note On Slashing
+
+The middleware contracts are available for testnet integration and experimentation. As with the rest of the testnet code, these contracts have not yet been fully audited. Internal security reviews are in progress, and we're preparing to engage external auditors. We're providing these now so AVSs can begin testing slashing conditions, Operator Sets, and related functionality, and so Operators can simulate slashing and test allocations. For more details, see [ELIP-002](https://github.com/eigenfoundation/ELIPs/blob/main/ELIPs/ELIP-002.md).
+
+For Operators:
+
+We provide scripts to deploy a mock service manager and allocate some stake to a mock Operator Set in [these scripts](https://github.com/Layr-Labs/eigenlayer-middleware/pull/335).
+We've reduced various safety delays on testnet to better simulate operational flows. Additional information on these delays is in [ELIP-002](https://github.com/eigenfoundation/ELIPs/blob/main/ELIPs/ELIP-002.md).
+For AVSs:
+
+We provide a migration path for existing M2 environments (LINK). While this requires understanding the provided script, the Developer Experience will improve before Mainnet launch. Note that this is a gradual migration process to new Operator Sets, not a direct upgrade of existing Operator Sets.
+We also provide scripts to spin up new service managers from scratch.
+In all cases, you’ll need to register existing Operators or spin up new Operators and allocate funds to them. These testing flows will improve as we refine the scripts and contracts. Stay tuned for updates, and feel free to reach out with any questions.
+
 ## Building and Running Tests
 
 This repository uses Foundry. See the [Foundry docs](https://book.getfoundry.sh/) for more info on installation and usage. If you already have foundry, you can build this project and run tests with these commands:
@@ -80,4 +97,3 @@ The current testnet deployment is on holesky, is from our M2 beta release. You c
 [`ServiceManagerRouter`](https://github.com/Layr-Labs/eigenlayer-middleware/blob/testnet-holesky/src/ServiceManagerRouter.sol) | - | [`0x4463...5a37`](https://holesky.etherscan.io/address/0x44632dfBdCb6D3E21EF613B0ca8A6A0c618F5a37#code) | |
 [`ProxyAdmin`](https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.7.1/contracts/proxy/transparent/ProxyAdmin.sol) | - | [`0xB043...5c15`](https://holesky.etherscan.io/address/0xB043055dd967A382577c2f5261fA6428f2905c15) | |
 [`eigenda/EigenDAServiceManager`](https://github.com/Layr-Labs/eigenda/blob/a33b41561cc3fb4cd6d50a8738e4c5dca43ec0a5/contracts/src/core/EigenDAServiceManager.sol) | [`0xD4A7E1Bd8015057293f0D0A557088c286942e84b`](https://holesky.etherscan.io/address/0xD4A7E1Bd8015057293f0D0A557088c286942e84b) | [`0xa722...67f3`](https://holesky.etherscan.io/address/0xa7227485e6C693AC4566fe168C5E3647c5c267f3) | Proxy: [`[email protected]`](https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.7.1/contracts/proxy/transparent/TransparentUpgradeableProxy.sol) |
-

bin/storage-report.sh

@@ -0,0 +1,45 @@
+#!/bin/sh
+
+# Default output directory
+OUTPUT_DIR=${1:-docs/storage-report}
+
+# Function to print messages
+log() {
+    echo "$(date '+%Y-%m-%d %H:%M:%S') [INFO] $1"
+}
+
+# Function to print error messages
+error() {
+    echo "$(date '+%Y-%m-%d %H:%M:%S') [ERROR] $1" >&2
+}
+
+log "Starting the storage report generation."
+
+# Create the output directory if it doesn't exist
+if ! mkdir -p "$OUTPUT_DIR"; then
+    error "Failed to create output directory: $OUTPUT_DIR"
+    exit 1
+fi
+
+log "Output directory is set to: $OUTPUT_DIR"
+
+# Loop through Solidity files and generate storage report
+# NOTE: Ignores `src/interfaces` & `src/libraries` since they "should" not contain storage logic.
+for file in $(find src/ -name "*.sol" ! -path "*/interfaces/*" ! -path "*/libraries/*"); do
+    contract_name=$(basename "$file" .sol)
+
+    # Check if the file exists and is readable
+    if [ ! -r "$file" ]; then
+        error "Cannot read file: $file"
+        continue
+    fi
+
+    log "Processing contract: $contract_name"
+
+    # Run forge inspect and capture errors
+    if ! forge inspect "$contract_name" storage --pretty > "$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"
+    fi
+done

docs/storage-report/AVSRegistrar.md

@@ -0,0 +1,6 @@
+
+╭------+------+------+--------+-------+----------╮
+| Name | Type | Slot | Offset | Bytes | Contract |
++================================================+
+╰------+------+------+--------+-------+----------╯
+

docs/storage-report/BLSApkRegistry.md

@@ -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 IBLSApkRegistry.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 |
+╰----------------------+------------------------------------------------------+------+--------+-------+---------------------------------------╯
+

docs/storage-report/BLSApkRegistryStorage.md

@@ -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 IBLSApkRegistry.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 |
+╰----------------------+------------------------------------------------------+------+--------+-------+-----------------------------------------------------╯
+

docs/storage-report/BLSSignatureChecker.md

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

docs/storage-report/ECDSAServiceManagerBase.md

@@ -0,0 +1,19 @@
+
+╭------------------+-------------+------+--------+-------+-------------------------------------------------------------------╮
+| Name             | Type        | Slot | Offset | Bytes | Contract                                                          |
++============================================================================================================================+
+| _initialized     | uint8       | 0    | 0      | 1     | src/unaudited/ECDSAServiceManagerBase.sol:ECDSAServiceManagerBase |
+|------------------+-------------+------+--------+-------+-------------------------------------------------------------------|
+| _initializing    | bool        | 0    | 1      | 1     | src/unaudited/ECDSAServiceManagerBase.sol:ECDSAServiceManagerBase |
+|------------------+-------------+------+--------+-------+-------------------------------------------------------------------|
+| __gap            | uint256[50] | 1    | 0      | 1600  | src/unaudited/ECDSAServiceManagerBase.sol:ECDSAServiceManagerBase |
+|------------------+-------------+------+--------+-------+-------------------------------------------------------------------|
+| _owner           | address     | 51   | 0      | 20    | src/unaudited/ECDSAServiceManagerBase.sol:ECDSAServiceManagerBase |
+|------------------+-------------+------+--------+-------+-------------------------------------------------------------------|
+| __gap            | uint256[49] | 52   | 0      | 1568  | src/unaudited/ECDSAServiceManagerBase.sol:ECDSAServiceManagerBase |
+|------------------+-------------+------+--------+-------+-------------------------------------------------------------------|
+| rewardsInitiator | address     | 101  | 0      | 20    | src/unaudited/ECDSAServiceManagerBase.sol:ECDSAServiceManagerBase |
+|------------------+-------------+------+--------+-------+-------------------------------------------------------------------|
+| __GAP            | uint256[49] | 102  | 0      | 1568  | src/unaudited/ECDSAServiceManagerBase.sol:ECDSAServiceManagerBase |
+╰------------------+-------------+------+--------+-------+-------------------------------------------------------------------╯
+