refactor: use Foundry contracts with sol! macro for rpc tests (#262)

* move contracts into test-utils

* refactor existing rpc tests to use foundry contracts

* build-contracts as dep for build

* build-contracts as dep for test

* install foundry in CI

* setup foundry and build contracts for udeps CI

Author: haardikk21

.github/workflows/ci.yml

@@ -25,7 +25,7 @@ jobs:
       - uses: Swatinem/rust-cache@779680da715d629ac1d338a641029a2f4372abb5 # v2.8.2
         with:
           cache-on-failure: true
-          add-rust-environment-hash-key: 'false'
+          add-rust-environment-hash-key: "false"
           key: stable-${{ hashFiles('Cargo.lock') }}
       - name: Install just
         uses: extractions/setup-just@e33e0265a09d6d736e2ee1e0eb685ef1de4669ff # v3
@@ -41,19 +41,25 @@ jobs:
           egress-policy: audit
 
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          submodules: recursive
       - uses: dtolnay/rust-toolchain@4305c38b25d97ef35a8ad1f985ccf2d2242004f2 # stable
       - uses: rui314/setup-mold@725a8794d15fc7563f59595bd9556495c0564878 # v1
       - uses: Swatinem/rust-cache@779680da715d629ac1d338a641029a2f4372abb5 # v2.8.2
         with:
           cache-on-failure: true
-          add-rust-environment-hash-key: 'false'
+          add-rust-environment-hash-key: "false"
           key: stable-${{ hashFiles('Cargo.lock') }}
       - name: Install just
         uses: extractions/setup-just@e33e0265a09d6d736e2ee1e0eb685ef1de4669ff # v3
       - name: Install cargo-nextest
         uses: taiki-e/install-action@3575e532701a5fc614b0c842e4119af4cc5fd16d # v2.62.60
         with:
           tool: cargo-nextest
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@50d5a8956f2e319df19e6b57539d7e2acb9f8c1e # v1.5.0
+        with:
+          version: stable
       - name: Run tests
         run: just test
 
@@ -73,7 +79,7 @@ jobs:
       - uses: Swatinem/rust-cache@779680da715d629ac1d338a641029a2f4372abb5 # v2.8.2
         with:
           cache-on-failure: true
-          add-rust-environment-hash-key: 'false'
+          add-rust-environment-hash-key: "false"
           key: nightly-${{ hashFiles('Cargo.lock') }}
       - name: Install just
         uses: extractions/setup-just@e33e0265a09d6d736e2ee1e0eb685ef1de4669ff # v3
@@ -95,7 +101,7 @@ jobs:
       - uses: Swatinem/rust-cache@779680da715d629ac1d338a641029a2f4372abb5 # v2.8.2
         with:
           cache-on-failure: true
-          add-rust-environment-hash-key: 'false'
+          add-rust-environment-hash-key: "false"
           key: stable-${{ hashFiles('Cargo.lock') }}
       - name: Install just
         uses: extractions/setup-just@e33e0265a09d6d736e2ee1e0eb685ef1de4669ff # v3
@@ -140,11 +146,15 @@ jobs:
       - uses: Swatinem/rust-cache@779680da715d629ac1d338a641029a2f4372abb5 # v2.8.2
         with:
           cache-on-failure: true
-          add-rust-environment-hash-key: 'false'
+          add-rust-environment-hash-key: "false"
           key: nightly-${{ hashFiles('Cargo.lock') }}
       - uses: taiki-e/install-action@3575e532701a5fc614b0c842e4119af4cc5fd16d # v2.62.60
-        with: 
+        with:
           tool: cargo-udeps
       - name: Install just
         uses: extractions/setup-just@e33e0265a09d6d736e2ee1e0eb685ef1de4669ff # v3
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@50d5a8956f2e319df19e6b57539d7e2acb9f8c1e # v1.5.0
+        with:
+          version: stable
       - run: just check-udeps

.gitmodules

@@ -1,6 +1,6 @@
-[submodule "contracts/lib/forge-std"]
-	path = contracts/lib/forge-std
+[submodule "crates/test-utils/contracts/lib/forge-std"]
+	path = crates/test-utils/contracts/lib/forge-std
 	url = https://github.com/foundry-rs/forge-std
-[submodule "contracts/lib/solmate"]
-	path = contracts/lib/solmate
+[submodule "crates/test-utils/contracts/lib/solmate"]
+	path = crates/test-utils/contracts/lib/solmate
 	url = https://github.com/transmissions11/solmate

Cargo.lock

@@ -107,6 +107,9 @@ alloy-provider = { version = "1.0.41" }
 alloy-hardforks = "0.4.4"
 alloy-rpc-client = { version = "1.0.41" }
 alloy-serde = { version = "1.0.41" }
+alloy-sol-macro = { version = "1.4.1", features = ["json"] }
+alloy-sol-types = { version = "1.4.1" }
+alloy-contract = { version = "1.0.41" }
 
 # op-alloy
 op-alloy-rpc-types = { version = "0.22.0", default-features = false }

Cargo.toml

@@ -39,7 +39,7 @@ zepter-fix:
   zepter format features --fix
 
 # Runs tests across workspace with all features enabled
-test:
+test: build-contracts
     @command -v cargo-nextest >/dev/null 2>&1 || cargo install cargo-nextest
     RUSTFLAGS="-D warnings" cargo nextest run --workspace --all-features
 
@@ -80,17 +80,21 @@ build-maxperf:
 build-node:
     cargo build --bin base-reth-node
 
+# Build the contracts used for tests
+build-contracts:
+    cd crates/test-utils/contracts && forge build
+
 # Cleans the workspace
 clean:
     cargo clean
 
 # Checks if there are any unused dependencies
-check-udeps:
+check-udeps: build-contracts
   @command -v cargo-udeps >/dev/null 2>&1 || cargo install cargo-udeps
   cargo +nightly udeps --workspace --all-features --all-targets
 
 # Watches tests
-watch-test:
+watch-test: build-contracts
     cargo watch -x test
 
 # Watches checks

Justfile

@@ -76,6 +76,9 @@ futures-util.workspace = true
 alloy-rpc-types-eth.workspace = true
 alloy-rpc-types-engine.workspace = true
 alloy-provider.workspace = true
+alloy-sol-macro.workspace = true
+alloy-sol-types.workspace = true
+alloy-contract.workspace = true
 
 [package.metadata.cargo-udeps.ignore]
 normal = ["reth-optimism-cli"]