ci: add Solidity contract size checks (#203)

Author: Chaitu-Tatipamula

.github/workflows/contract-size.yml

@@ -0,0 +1,31 @@
+name: Solidity Contract Size Check
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+    branches: ["main"]
+
+jobs:
+  check_contract_size:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+        with:
+          version: v1.2.3
+      
+      - name: Install Dependencies
+        run: forge install
+
+      - name: Install jq
+        run: sudo apt-get install -y jq
+
+      - name: Check contract size
+        run: make contract-size-check

Makefile

@@ -49,4 +49,10 @@ extract-abis:
 	@find out -type f -name '*.json' | while read file; do \
 	  name=$$(basename "$${file%.*}"); \
 	  jq '.abi' "$${file}" > "abi/$${name}.abi.json"; \
-	done
+	done
+
+# Contract size check
+.PHONY: contract-size-check
+contract-size-check:
+	@echo "Checking contract sizes..."
+	bash tools/check-contract-size.sh

tools/check-contract-size.sh

@@ -0,0 +1,96 @@
+#!/usr/bin/env bash
+# 
+# This script checks if any Solidity contract/library in the `src/` folder
+# exceeds the EIP-170 contract runtime size limit (24,576 bytes)
+# and the EIP-3860 init code size limit (49,152 bytes).
+# Intended for use in CI (e.g., GitHub Actions) with Foundry.
+# Exits 1 and prints the list of exceeding contracts if violations are found.
+# NOTE: This script requires Bash (not sh or dash) due to use of mapfile and [[ ... ]].
+
+set -euo pipefail
+
+command -v jq >/dev/null 2>&1 || { echo >&2 "jq is required but not installed."; exit 1; }
+command -v forge >/dev/null 2>&1 || { echo >&2 "forge is required but not installed."; exit 1; }
+
+# Gather contract and library names from src/
+# Only matches [A-Za-z0-9_] in contract/library names (no special characters)
+if [[ -d src/ ]]; then
+    mapfile -t contracts < <(grep -rE '^(contract|library) ' src/ 2>/dev/null | sed -E 's/.*(contract|library) ([A-Za-z0-9_]+).*/\2/')
+else 
+    contracts=()
+fi
+
+# Exit early if none found
+if [[ ${#contracts[@]} -eq 0 ]]; then
+    echo "No contracts or libraries found in src/."
+    exit 0
+fi
+
+# Build the contracts, get size info as JSON (ignore non-zero exit to always parse output)
+forge clean || true
+forge build --sizes --json | jq . > contract_sizes.json || true
+
+# Validate JSON output
+if ! jq empty contract_sizes.json 2>/dev/null; then
+    echo "forge build did not return valid JSON. Output:"
+    cat contract_sizes.json
+    exit 1
+fi
+
+if jq -e '. == {}' contract_sizes.json >/dev/null; then
+    echo "forge did not find any contracts. forge build:"
+    # This usually means build failure
+    forge build
+    exit 1
+fi
+
+json=$(cat contract_sizes.json)
+
+# Filter JSON: keep only contracts/libraries from src/
+json=$(echo "$json" | jq --argjson keys "$(printf '%s\n' "${contracts[@]}" | jq -R . | jq -s .)" '
+  to_entries
+  | map(select(.key as $k | $keys | index($k)))
+  | from_entries
+')
+
+# Find all that violate the EIP-170 runtime size limit (24,576 bytes)
+exceeding_runtime=$(echo "$json" | jq -r '
+  to_entries
+  | map(select(.value.runtime_size > 24576))
+  | .[]
+  | "\(.key): \(.value.runtime_size) bytes (runtime size)"'
+)
+
+# Find all that violate the EIP-3860 init code size limit (49,152 bytes)
+exceeding_initcode=$(echo "$json" | jq -r '
+  to_entries
+  | map(select(.value.init_size > 49152))
+  | .[]
+  | "\(.key): \(.value.init_size) bytes (init code size)"'
+)
+
+# Initialize status
+status=0
+
+if [[ -n "$exceeding_runtime" ]]; then
+  echo "ERROR: The following contracts exceed EIP-170 runtime size (24,576 bytes):"
+  echo "$exceeding_runtime"
+  status=1
+fi
+
+if [[ -n "$exceeding_initcode" ]]; then
+  echo "ERROR: The following contracts exceed EIP-3860 init code size (49,152 bytes):"
+  echo "$exceeding_initcode"
+  status=1
+fi
+
+if [[ $status -eq 0 ]]; then
+  echo "All contracts are within the EIP-170 runtime and EIP-3860 init code size limits."
+fi
+
+# Clean up temporary file
+rm -f contract_sizes.json
+
+# Exit with appropriate status
+exit $status
+