fix: storage layout compatibility (#7078)

Co-authored-by: Cursor Agent <[email protected]>

Author: yorhodes

.github/workflows/storage-analysis.yml

@@ -2,7 +2,8 @@ name: Check Storage Layout Changes
 
 on:
   pull_request:
-    branches: [main]
+    branches:
+      - '*'
     paths:
       - 'solidity/**'
   workflow_dispatch:
@@ -53,13 +54,30 @@ jobs:
         env:
           BASE_REF: ${{ github.event.inputs.base || github.event.pull_request.base.sha }}
         run: |
+          # Fetch the base reference
           git fetch origin $BASE_REF
-          git checkout $BASE_REF -- solidity/contracts
+          # Check if BASE_REF is a commit SHA (40 hex characters) or a branch name
+          if [[ "$BASE_REF" =~ ^[0-9a-f]{40}$ ]]; then
+            # For commit SHAs, checkout directly without origin/ prefix
+            git checkout $BASE_REF -- solidity/contracts
+          else
+            # For branch names, use origin/ prefix
+            git checkout origin/$BASE_REF -- solidity/contracts
+          fi
 
       # Run the command on the target branch
       - name: Run command on target branch
         run: yarn workspace @hyperlane-xyz/core storage base-storage
 
       # Compare outputs
-      - name: Compare outputs
-        run: diff --unified solidity/base-storage solidity/HEAD-storage
+      - name: Compare outputs (fail on removals only)
+        run: |
+          DIFF_OUTPUT=$(diff --unified solidity/base-storage solidity/HEAD-storage || true)
+          echo "$DIFF_OUTPUT"
+          # Fail only if there are removal lines in diff hunks (lines starting with '-' but not '---')
+          if echo "$DIFF_OUTPUT" | grep -E '^-([^-])' >/dev/null; then
+            echo "Detected storage removals in diff. Failing job."
+            exit 1
+          else
+            echo "No storage removals detected."
+          fi

solidity/storage.sh

@@ -15,7 +15,22 @@ do
         continue
     fi
 
-    contract=$(basename "$file" .sol)
-    echo "Generating storage layout of $contract"
-    forge inspect "$contract" storage > "$OUTPUT_PATH/$contract.md"
+    # Skip files that don't end in .sol
+    if [[ ! "$file" =~ \.sol$ ]]; then
+        continue
+    fi
+
+    # Extract all contract names from the file
+    contracts=$(grep -o '^contract [A-Za-z0-9_][A-Za-z0-9_]*' "$file" | sed 's/^contract //')
+
+    if [ -z "$contracts" ]; then
+        continue
+    fi
+
+    # Process each contract found in the file
+    for contract in $contracts; do
+        echo "Generating storage layout of $contract"
+        echo "slot  offset  label" > "$OUTPUT_PATH/$contract-layout.tsv"
+        forge inspect "$contract" storage --json | jq -r '.storage .[] | "\(.slot)\t\(.offset)\t\(.label)"' >> "$OUTPUT_PATH/$contract-layout.tsv"
+    done
 done