Introduce CI Pipeline for Gas Optimization, Storage Safety, and Contract Integrity Validation

.github/workflows/4naly3er.yml

@@ -0,0 +1,33 @@
+name: 4naly3er Report
+
+on:
+    push:
+        branches: [main, master]
+    pull_request:
+        branches: [main, master]
+
+jobs:
+    analyzer_4naly3er:
+        name: 4naly3er Gas Optimization Report
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v4
+              with:
+                  submodules: recursive
+
+            - name: Setup Node.js
+              uses: actions/setup-node@v4
+              with:
+                  node-version: "18"
+
+            - name: Install 4naly3er
+              run: |
+                  git clone https://github.com/Picodes/4naly3er
+                  cd 4naly3er
+                  rm -f src/issues/NC/uselessOverride.ts || true
+                  yarn
+
+            - name: Run 4naly3er on src/
+              run: |
+                  cd 4naly3er
+                  yarn analyze ../src ../4naly3er-report.md

.github/workflows/abi-diff.yml

@@ -0,0 +1,65 @@
+name: ABI Diff Check
+
+on:
+    push:
+        branches: [main, master]
+    pull_request:
+        branches: [main, master]
+
+env:
+    FOUNDRY_PROFILE: ci
+
+jobs:
+    abi-diff:
+        name: ABI Diff Check
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v4
+              with:
+                  submodules: recursive
+
+            - name: Install Foundry
+              uses: foundry-rs/foundry-toolchain@v1
+
+            - name: Build contracts
+              run: forge build
+
+            - name: Generate ABIs and diff against baseline
+              run: |
+                  mkdir -p .abi-current
+                  CHANGED=0
+
+                  if [ ! -d .abi-baselines ]; then
+                    echo "No .abi-baselines directory. Skipping check."
+                    exit 0
+                  fi
+
+                  # Derive contract names from existing baselines to avoid placeholder drift.
+                  mapfile -t CONTRACTS < <(find .abi-baselines -type f -name '*.json' -exec basename {} .json \;)
+                  if [ "${#CONTRACTS[@]}" -eq 0 ]; then
+                    echo "No ABI baselines found in .abi-baselines/. Skipping ABI diff."
+                    exit 0
+                  fi
+
+                  for contract in "${CONTRACTS[@]}"; do
+                    if ! forge inspect "$contract" abi > ".abi-current/${contract}.json" 2>/dev/null; then
+                      echo "::error::Failed to generate ABI for $contract"
+                      CHANGED=1
+                      continue
+                    fi
+
+                    baseline=".abi-baselines/${contract}.json"
+                    if [ -f "$baseline" ]; then
+                      if ! diff -u "$baseline" ".abi-current/${contract}.json"; then
+                        echo "❌ ABI changed for $contract — this may be a breaking change!"
+                        CHANGED=1
+                      fi
+                    else
+                      echo "::error::No ABI baseline for $contract. Add .abi-baselines/${contract}.json"
+                      CHANGED=1
+                    fi
+                  done
+
+                  if [ "$CHANGED" -eq 1 ]; then
+                    exit 1
+                  fi

.github/workflows/contract-size.yml

@@ -0,0 +1,31 @@
+name: Contract Size Check
+
+on:
+    push:
+        branches: [main, master]
+    pull_request:
+        branches: [main, master]
+
+env:
+    FOUNDRY_PROFILE: ci
+
+jobs:
+    contract-size:
+        name: Contract Size Check
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v4
+              with:
+                  submodules: recursive
+
+            - name: Install Foundry
+              uses: foundry-rs/foundry-toolchain@v1
+
+            - name: Build and check contract sizes
+              run: |
+                  forge build --sizes 2>&1 | tee sizes.txt
+                  # Fail if any contract is >= 23616 bytes (warn zone before 24KB EIP-170 limit)
+                  if grep -E '^\s*\|.*\s([2-9][0-9]{3}|[1-9][0-9]{4})\s' sizes.txt; then
+                    echo "❌ One or more contracts are dangerously close to or over the 24KB limit."
+                    exit 1
+                  fi

.github/workflows/coverage.yml

@@ -0,0 +1,37 @@
+name: Coverage Report
+
+on:
+    push:
+        branches: [main, master]
+    pull_request:
+        branches: [main, master]
+
+env:
+    FOUNDRY_PROFILE: ci
+
+jobs:
+    coverage:
+        name: Coverage Report
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v4
+              with:
+                  submodules: recursive
+
+            - name: Install Foundry
+              uses: foundry-rs/foundry-toolchain@v1
+
+            - name: Install lcov
+              run: |
+                  sudo apt-get update
+                  sudo apt-get install -y lcov
+
+            - name: Generate coverage report
+              run: forge coverage --report lcov
+
+            - name: Upload to Codecov
+              uses: codecov/codecov-action@v4
+              with:
+                  files: ./lcov.info
+                  fail_ci_if_error: false
+                  token: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/gas-report.yml

@@ -0,0 +1,25 @@
+name: Gas Report
+
+on:
+    push:
+        branches: [main, master]
+    pull_request:
+        branches: [main, master]
+
+env:
+    FOUNDRY_PROFILE: ci
+
+jobs:
+    gas-report:
+        name: Gas Report on Test Run
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v4
+              with:
+                  submodules: recursive
+
+            - name: Install Foundry
+              uses: foundry-rs/foundry-toolchain@v1
+
+            - name: Run tests with gas report
+              run: forge test --gas-report

.github/workflows/gas-snapshot.yml

@@ -0,0 +1,34 @@
+name: Gas Snapshot Diff
+
+on:
+    push:
+        branches: [main, master]
+    pull_request:
+        branches: [main, master]
+
+env:
+    FOUNDRY_PROFILE: ci
+
+jobs:
+    gas-snapshot:
+        name: Gas Snapshot Diff
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v4
+              with:
+                  submodules: recursive
+
+            - name: Install Foundry
+              uses: foundry-rs/foundry-toolchain@v1
+
+            - name: Compare gas snapshot diff
+              run: |
+                  if [ ! -f .gas-snapshot ]; then
+                    echo "No .gas-snapshot found. Generating one now instead of diffing."
+                    forge snapshot
+                    exit 0
+                  fi
+                  if ! forge snapshot --diff .gas-snapshot; then
+                    echo "❌ Gas usage increased. Review the diff above."
+                    exit 1
+                  fi

.github/workflows/mythril.yml

@@ -0,0 +1,36 @@
+name: Mythril Security Scan
+
+on:
+    push:
+        branches: [main, master]
+    pull_request:
+        branches: [main, master]
+
+env:
+    FOUNDRY_PROFILE: ci
+
+jobs:
+    mythril:
+        name: Mythril Security Scan
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v4
+              with:
+                  submodules: recursive
+
+            - name: Install Foundry
+              uses: foundry-rs/foundry-toolchain@v1
+
+            - name: Build contracts
+              run: forge build
+
+            - name: Run Mythril on all contracts
+              run: |
+                  find src -name "*.sol" | while read contract; do
+                    echo "🔍 Scanning $contract ..."
+                    docker run --rm \
+                      -v "$(pwd):/project" \
+                      mythril/myth analyze "/project/$contract" \
+                      --solv 0.8.24 \
+                      --execution-timeout 60
+                  done

.github/workflows/storage-layout-diff.yml

@@ -0,0 +1,77 @@
+name: Storage Layout Diff
+
+on:
+    push:
+        branches: [main, master]
+    pull_request:
+        branches: [main, master]
+
+env:
+    FOUNDRY_PROFILE: ci
+
+jobs:
+    storage-layout-diff:
+        name: Storage Layout Diff
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v4
+              with:
+                  submodules: recursive
+
+            - name: Install Foundry
+              uses: foundry-rs/foundry-toolchain@v1
+
+            - name: Build contracts
+              run: forge build
+
+            - name: Generate storage layouts
+              run: |
+                  set -euo pipefail
+                  if [ ! -d .storage-baselines ]; then
+                    echo "No .storage-baselines directory. Skipping generation."
+                    exit 0
+                  fi
+
+                  mkdir -p .storage-layouts
+                  mapfile -t CONTRACTS < <(find .storage-baselines -type f -name '*.json' -exec basename {} .json \;)
+
+                  if [ "${#CONTRACTS[@]}" -eq 0 ]; then
+                    echo "No baselines found in .storage-baselines. Skipping generation."
+                    exit 0
+                  fi
+
+                  for contract in "${CONTRACTS[@]}"; do
+                    forge inspect "$contract" storage-layout > ".storage-layouts/${contract}.json"
+                  done
+
+            - name: Diff against baseline
+              run: |
+                  shopt -s nullglob
+                  CHANGED=0
+                  if [ ! -d .storage-layouts ]; then
+                    echo "No .storage-layouts generated. Skipping diff."
+                    exit 0
+                  fi
+                  files=(.storage-layouts/*.json)
+                  if [ ${#files[@]} -eq 0 ]; then
+                    echo "No storage layouts were generated. Skipping diff."
+                    exit 0
+                  fi
+
+                  for file in "${files[@]}"; do
+                    name=$(basename "$file")
+                    baseline=".storage-baselines/$name"
+                    if [ -f "$baseline" ]; then
+                      if ! diff -u "$baseline" "$file"; then
+                        echo "❌ Storage layout changed for $name"
+                        CHANGED=1
+                      fi
+                    else
+                      echo "❌ No baseline found for $name — add it to .storage-baselines/"
+                      CHANGED=1
+                    fi
+                  done
+
+                  if [ "$CHANGED" -eq 1 ]; then
+                    exit 1
+                  fi