From a0b0dcea2c8dff277d03a0322dbc05fcd8639fd0 Mon Sep 17 00:00:00 2001
From: steven <steven.nevins.js@gmail.com>
Date: Thu, 17 Oct 2024 14:07:15 -0400
Subject: [PATCH] ci: add workflow for checking storage

---
 .github/workflows/storage-checker.yaml | 46 ++++++++++++++++++++++++++
 1 file changed, 46 insertions(+)
 create mode 100644 .github/workflows/storage-checker.yaml

diff --git a/.github/workflows/storage-checker.yaml b/.github/workflows/storage-checker.yaml
new file mode 100644
index 00000000..4f41b61a
--- /dev/null
+++ b/.github/workflows/storage-checker.yaml
@@ -0,0 +1,46 @@
+name: Check Storage Layout
+on:
+  pull_request:
+    branches:
+      - master
+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"
+        run: |
+          cd contracts && mkdir pr
+          for file in $(find src -name '*.sol'); do
+              contract_name=$(basename "$file" .sol)
+              forge inspect "$contract_name" storage --pretty > pr/"$contract_name".md
+          done
+
+      - name: Checkout Base Branch
+        env:
+          BASE: ${{ github.event.pull_request.base.sha }}
+        run: |
+          git fetch origin $BASE
+          git checkout $BASE
+
+      - name: "Generate and prepare the contract artifacts"
+        run: |
+          cd contracts && mkdir base
+          for file in $(find src -name '*.sol'); do
+              contract_name=$(basename "$file" .sol)
+              forge inspect "$contract_name" storage --pretty > base/"$contract_name".md
+          done
+      - name: Compare outputs
+        run: |
+          if ! diff --unified contracts/pr contracts/base; then
+            # Note: We are only creating a warning because storage changes might be intentional but should be looked into
+            # reach out to steven if you see a warning on this workflow and need help validating if it is expected or not
+            echo "::warning::Differences found between PR and base storage layouts"
+          fi
\ No newline at end of file