Merge pull request #450 from bob-collective/feat/relayer

Add relayer binary
bob-collective · Jan 31, 2025 · ef5773c · ef5773c
2 parents 9217101 + 3ebd99e
commit ef5773c
Show file tree

Hide file tree

Showing 101 changed files with 91,694 additions and 58 deletions.
diff --git a/.github/workflows/test.yml → .github/workflows/contracts.yml b/.github/workflows/test.yml → .github/workflows/contracts.yml
@@ -1,64 +1,62 @@
-name: test
+name: Contracts
 
 on: [pull_request]
 
 env:
   FOUNDRY_PROFILE: ci
 
 jobs:
-  contracts:
-    name: Contracts
+  tests:
+    name: Tests
     runs-on: ubuntu-latest
     permissions:
       contents: write
+    defaults:
+      run:
+        working-directory: contracts
     steps:
       - uses: actions/checkout@v4
         with:
           submodules: recursive
-      - name: Install foundry
+      - name: Install Foundry
         uses: foundry-rs/foundry-toolchain@v1
-        with:
-          version: v0.3.0
-      - name: Run forge fmt
-        run: |
-          forge --version
-          forge fmt --check
-        id: fmt
-      - name: Run forge build
-        run: |
-          forge build --sizes --deny-warnings
-        id: build
+      - name: Install deps
+        run: forge install
       - name: Run forge tests
         # Currently forked tests are disabled to increase reliability of CI builds
         run: |
           forge test --no-match-contract Forked -vvv --deny-warnings
-        id: test
-      - name: Run forge docs
-        run: |
-          forge doc --out docs/docs/contracts
-          python3 docs/scripts/forge_doc_reformat.py
-      - name: Commit forge docs
-        uses: stefanzweifel/git-auto-commit-action@v5
-        with:
-          commit_message: "chore: Generate Foundry docs"
-          file_pattern: "./docs/"
 
-  sdk:
-    name: SDK
+  bindings:
+    name: Bindings
     runs-on: ubuntu-latest
+    permissions:
+      contents: write
     defaults:
       run:
-        working-directory: ./sdk
+        working-directory: contracts
     steps:
       - uses: actions/checkout@v4
-      - name: Setup node
-        uses: actions/setup-node@v4
         with:
-          node-version: "20"
-          registry-url: "https://registry.npmjs.org"
-          always-auth: true
-      - run: npm ci
-      - run: npx prettier --check {examples,src,test}
-      - run: npm run lint
-      - name: Run tests
-        run: npm test
+          submodules: recursive
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+      - name: Pull library deps
+        run: forge install
+      - name: Check fmt
+        run: forge fmt --check
+      - name: Build contracts before checking bindings are correct
+        run: forge build --sizes
+      - name: Versions
+        run: |
+          forge --version
+          git submodule status
+      - name: Run forge docs
+        run: |
+          forge doc --out ../docs/docs/contracts
+          python3 ../docs/scripts/forge_doc_reformat.py
+      - name: Commit forge docs
+        uses: stefanzweifel/git-auto-commit-action@v5
+        with:
+          commit_message: "chore: Generate Foundry docs"
+          file_pattern: "./docs/"
diff --git a/.github/workflows/sdk.yml b/.github/workflows/sdk.yml
@@ -0,0 +1,27 @@
+name: SDK
+
+on: [pull_request]
+
+env:
+  FOUNDRY_PROFILE: ci
+
+jobs:
+  tests:
+    name: Tests
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./sdk
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup node
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+          registry-url: "https://registry.npmjs.org"
+          always-auth: true
+      - run: npm ci
+      - run: npx prettier --check {examples,src,test}
+      - run: npm run lint
+      - name: Run tests
+        run: npm test
diff --git a/.gitignore b/.gitignore
@@ -41,3 +41,9 @@ node_modules/*
 
 # generated docs
 /docs/docs/api/*
+
+# Rust stuff
+/target
+out/
+cache/
+Cargo.lock
diff --git a/.gitmodules b/.gitmodules
@@ -1,15 +1,15 @@
 [submodule "lib/forge-std"]
-	path = lib/forge-std
+	path = contracts/lib/forge-std
 	url = https://github.com/foundry-rs/forge-std
 [submodule "lib/openzeppelin-contracts"]
-	path = lib/openzeppelin-contracts
+	path = contracts/lib/openzeppelin-contracts
 	url = https://github.com/OpenZeppelin/openzeppelin-contracts
 [submodule "lib/bitcoin-spv"]
-	path = lib/bitcoin-spv
+	path = contracts/lib/bitcoin-spv
 	url = https://github.com/bob-collective/bitcoin-spv
 [submodule "lib/account-abstraction"]
-	path = lib/account-abstraction
+	path = contracts/lib/account-abstraction
 	url = https://github.com/eth-infinitism/account-abstraction
 [submodule "lib/gsn"]
-	path = lib/gsn
+	path = contracts/lib/gsn
 	url = https://github.com/opengsn/gsn
diff --git a/Cargo.toml b/Cargo.toml
@@ -0,0 +1,5 @@
+[workspace]
+members = ["relayer", "crates/bindings"]
+
+[workspace.dependencies]
+bindings = { path = "crates/bindings" }
diff --git a/Makefile b/Makefile
@@ -0,0 +1,54 @@
+#!/usr/bin/make -f
+
+# Default target is build
+default: build
+
+# Define variables
+CARGO=cargo
+CRATES_FOLDER=crates
+CONTRACTS_PATH=./contracts
+BINDINGS_FOLDER=bindings
+BINDINGS_CRATES_FOLDER=$(CRATES_FOLDER)/$(BINDINGS_FOLDER)
+BINDINGS_OUT_PATH=$(CONTRACTS_PATH)/out/$(BINDINGS_FOLDER)
+
+# Target for generating bindings
+bindings:
+	rm -rf $(BINDINGS_CRATES_FOLDER)
+	rm -rf $(BINDINGS_OUT_PATH)
+
+# Generate new bindings
+	@forge bind --root $(CONTRACTS_PATH) --crate-name $(BINDINGS_FOLDER) --select FullRelay
+
+# Move bindings to the correct location
+	@mv -f $(BINDINGS_OUT_PATH) $(CRATES_FOLDER)
+
+# Target for building the project
+build: bindings
+	@$(CARGO) build
+
+# Target for building the project in release mode
+build-release: bindings
+	@$(CARGO) build --release
+
+# Target for cleaning the project
+clean:
+	@forge clean --root $(CONTRACTS_PATH)
+	@$(CARGO) clean
+
+# Target for formatting the code
+fmt:
+	@forge fmt --check --root $(CONTRACTS_PATH)
+	@$(CARGO) fmt
+
+# Target for running tests
+test:
+	@forge test --root $(CONTRACTS_PATH)
+	@$(CARGO) test
+
+# Target for installing forge dependencies
+setup:
+	@forge install --root $(CONTRACTS_PATH)
+
+
+# Declare phony targets
+.PHONY: build build-release clean fmt bindings
diff --git a/foundry.toml → contracts/foundry.toml b/foundry.toml → contracts/foundry.toml
@@ -1,5 +1,8 @@
 [profile.default]
-fs_permissions = [{ access = "read", path = "./optimized-out" }, { access = "read", path = "./test/fullRelay/testData/" }]
+fs_permissions = [
+    { access = "read", path = "./optimized-out" },
+    { access = "read", path = "./test/fullRelay/testData/" },
+]
 src = "src"
 out = "out"
 libs = ["lib"]

diff --git a/lib/account-abstraction → contracts/lib/account-abstraction b/lib/account-abstraction → contracts/lib/account-abstraction
diff --git a/lib/bitcoin-spv → contracts/lib/bitcoin-spv b/lib/bitcoin-spv → contracts/lib/bitcoin-spv
diff --git a/lib/forge-std → contracts/lib/forge-std b/lib/forge-std → contracts/lib/forge-std
diff --git a/lib/gsn → contracts/lib/gsn b/lib/gsn → contracts/lib/gsn
diff --git a/lib/openzeppelin-contracts → contracts/lib/openzeppelin-contracts b/lib/openzeppelin-contracts → contracts/lib/openzeppelin-contracts
diff --git a/remappings.txt → contracts/remappings.txt b/remappings.txt → contracts/remappings.txt
diff --git a/script/AATokenPaymaster.sol → contracts/script/AATokenPaymaster.sol b/script/AATokenPaymaster.sol → contracts/script/AATokenPaymaster.sol
diff --git a/script/Gsn.sol → contracts/script/Gsn.sol b/script/Gsn.sol → contracts/script/Gsn.sol
diff --git a/script/Marketplace.sol → contracts/script/Marketplace.sol b/script/Marketplace.sol → contracts/script/Marketplace.sol
diff --git a/script/OnboardingPaymaster.sol → contracts/script/OnboardingPaymaster.sol b/script/OnboardingPaymaster.sol → contracts/script/OnboardingPaymaster.sol
diff --git a/script/OracleTokenPaymaster.sol → contracts/script/OracleTokenPaymaster.sol b/script/OracleTokenPaymaster.sol → contracts/script/OracleTokenPaymaster.sol
diff --git a/script/RelayGenesis.s.sol → contracts/script/RelayGenesis.s.sol b/script/RelayGenesis.s.sol → contracts/script/RelayGenesis.s.sol
diff --git a/script/RelayRetarget.s.sol → contracts/script/RelayRetarget.s.sol b/script/RelayRetarget.s.sol → contracts/script/RelayRetarget.s.sol
diff --git a/script/TestingWbtc.sol → contracts/script/TestingWbtc.sol b/script/TestingWbtc.sol → contracts/script/TestingWbtc.sol
diff --git a/src/TestingErc20.sol → contracts/src/TestingErc20.sol b/src/TestingErc20.sol → contracts/src/TestingErc20.sol
diff --git a/src/faucet/Erc20Minter.sol → contracts/src/faucet/Erc20Minter.sol b/src/faucet/Erc20Minter.sol → contracts/src/faucet/Erc20Minter.sol
diff --git a/...s/AccountAbstraction/AATokenPaymaster.sol → ...s/AccountAbstraction/AATokenPaymaster.sol b/...s/AccountAbstraction/AATokenPaymaster.sol → ...s/AccountAbstraction/AATokenPaymaster.sol
diff --git a/...rs/AccountAbstraction/SafeTransferLib.sol → ...rs/AccountAbstraction/SafeTransferLib.sol b/...rs/AccountAbstraction/SafeTransferLib.sol → ...rs/AccountAbstraction/SafeTransferLib.sol
diff --git a/src/paymasters/OnboardingPaymaster.sol → ...ts/src/paymasters/OnboardingPaymaster.sol b/src/paymasters/OnboardingPaymaster.sol → ...ts/src/paymasters/OnboardingPaymaster.sol
diff --git a/src/paymasters/Oracle.sol → contracts/src/paymasters/Oracle.sol b/src/paymasters/Oracle.sol → contracts/src/paymasters/Oracle.sol
diff --git a/src/paymasters/OracleTokenPaymaster.sol → ...s/src/paymasters/OracleTokenPaymaster.sol b/src/paymasters/OracleTokenPaymaster.sol → ...s/src/paymasters/OracleTokenPaymaster.sol
diff --git a/src/relay/FullRelay.sol → contracts/src/relay/FullRelay.sol b/src/relay/FullRelay.sol → contracts/src/relay/FullRelay.sol
diff --git a/src/relay/FullRelayInterfaces.sol → contracts/src/relay/FullRelayInterfaces.sol b/src/relay/FullRelayInterfaces.sol → contracts/src/relay/FullRelayInterfaces.sol
diff --git a/src/relay/FullRelayWithVerify.sol → contracts/src/relay/FullRelayWithVerify.sol b/src/relay/FullRelayWithVerify.sol → contracts/src/relay/FullRelayWithVerify.sol
diff --git a/src/relay/IRelay.sol → contracts/src/relay/IRelay.sol b/src/relay/IRelay.sol → contracts/src/relay/IRelay.sol
diff --git a/src/relay/LightRelay.sol → contracts/src/relay/LightRelay.sol b/src/relay/LightRelay.sol → contracts/src/relay/LightRelay.sol
diff --git a/src/relay/TestLightRelay.sol → contracts/src/relay/TestLightRelay.sol b/src/relay/TestLightRelay.sol → contracts/src/relay/TestLightRelay.sol
diff --git a/src/swap/Btc_Marketplace.sol → contracts/src/swap/Btc_Marketplace.sol b/src/swap/Btc_Marketplace.sol → contracts/src/swap/Btc_Marketplace.sol
diff --git a/src/swap/Faucet.sol → contracts/src/swap/Faucet.sol b/src/swap/Faucet.sol → contracts/src/swap/Faucet.sol
diff --git a/src/swap/Marketplace.sol → contracts/src/swap/Marketplace.sol b/src/swap/Marketplace.sol → contracts/src/swap/Marketplace.sol
diff --git a/src/swap/Ord_Marketplace.sol → contracts/src/swap/Ord_Marketplace.sol b/src/swap/Ord_Marketplace.sol → contracts/src/swap/Ord_Marketplace.sol
diff --git a/src/swap/Wrapped.sol → contracts/src/swap/Wrapped.sol b/src/swap/Wrapped.sol → contracts/src/swap/Wrapped.sol
diff --git a/src/utils/BitcoinTx.sol → contracts/src/utils/BitcoinTx.sol b/src/utils/BitcoinTx.sol → contracts/src/utils/BitcoinTx.sol
diff --git a/src/utils/WitnessTx.sol → contracts/src/utils/WitnessTx.sol b/src/utils/WitnessTx.sol → contracts/src/utils/WitnessTx.sol
diff --git a/test/BitcoinTx.t.sol → contracts/test/BitcoinTx.t.sol b/test/BitcoinTx.t.sol → contracts/test/BitcoinTx.t.sol
diff --git a/test/LightRelay.t.sol → contracts/test/LightRelay.t.sol b/test/LightRelay.t.sol → contracts/test/LightRelay.t.sol
diff --git a/test/OnboardingPaymaster.t.sol → contracts/test/OnboardingPaymaster.t.sol b/test/OnboardingPaymaster.t.sol → contracts/test/OnboardingPaymaster.t.sol
diff --git a/test/WitnessTx.t.sol → contracts/test/WitnessTx.t.sol b/test/WitnessTx.t.sol → contracts/test/WitnessTx.t.sol
diff --git a/test/fullRelay/FullRelayAddHeaderTest.t.sol → ...st/fullRelay/FullRelayAddHeaderTest.t.sol b/test/fullRelay/FullRelayAddHeaderTest.t.sol → ...st/fullRelay/FullRelayAddHeaderTest.t.sol
diff --git a/.../FullRelayAddHeaderWithRetargetTest.t.sol → .../FullRelayAddHeaderWithRetargetTest.t.sol b/.../FullRelayAddHeaderWithRetargetTest.t.sol → .../FullRelayAddHeaderWithRetargetTest.t.sol
diff --git a/...fullRelay/FullRelayConstructionTest.t.sol → ...fullRelay/FullRelayConstructionTest.t.sol b/...fullRelay/FullRelayConstructionTest.t.sol → ...fullRelay/FullRelayConstructionTest.t.sol
diff --git a/...fullRelay/FullRelayFindAncestorTest.t.sol → ...fullRelay/FullRelayFindAncestorTest.t.sol b/...fullRelay/FullRelayFindAncestorTest.t.sol → ...fullRelay/FullRelayFindAncestorTest.t.sol
diff --git a/test/fullRelay/FullRelayFindHeightTest.t.sol → ...t/fullRelay/FullRelayFindHeightTest.t.sol b/test/fullRelay/FullRelayFindHeightTest.t.sol → ...t/fullRelay/FullRelayFindHeightTest.t.sol
diff --git a/...y/FullRelayHeaviestFromAncestorTest.t.sol → ...y/FullRelayHeaviestFromAncestorTest.t.sol b/...y/FullRelayHeaviestFromAncestorTest.t.sol → ...y/FullRelayHeaviestFromAncestorTest.t.sol
diff --git a/...eaviestFromAncestorWithRetargetTest.t.sol → ...eaviestFromAncestorWithRetargetTest.t.sol b/...eaviestFromAncestorWithRetargetTest.t.sol → ...eaviestFromAncestorWithRetargetTest.t.sol
diff --git a/test/fullRelay/FullRelayIsAncestorTest.t.sol → ...t/fullRelay/FullRelayIsAncestorTest.t.sol b/test/fullRelay/FullRelayIsAncestorTest.t.sol → ...t/fullRelay/FullRelayIsAncestorTest.t.sol
diff --git a/...llRelay/FullRelayIsMostAncestorTest.t.sol → ...llRelay/FullRelayIsMostAncestorTest.t.sol b/...llRelay/FullRelayIsMostAncestorTest.t.sol → ...llRelay/FullRelayIsMostAncestorTest.t.sol
diff --git a/...fullRelay/FullRelayMarkHeaviestTest.t.sol → ...fullRelay/FullRelayMarkHeaviestTest.t.sol b/...fullRelay/FullRelayMarkHeaviestTest.t.sol → ...fullRelay/FullRelayMarkHeaviestTest.t.sol
diff --git a/test/fullRelay/FullRelayTestUtils.sol → ...cts/test/fullRelay/FullRelayTestUtils.sol b/test/fullRelay/FullRelayTestUtils.sol → ...cts/test/fullRelay/FullRelayTestUtils.sol
diff --git a/test/fullRelay/FullRelayWithVerifyTest.t.sol → ...t/fullRelay/FullRelayWithVerifyTest.t.sol b/test/fullRelay/FullRelayWithVerifyTest.t.sol → ...t/fullRelay/FullRelayWithVerifyTest.t.sol
diff --git a/test/fullRelay/testData/headers.json → ...acts/test/fullRelay/testData/headers.json b/test/fullRelay/testData/headers.json → ...acts/test/fullRelay/testData/headers.json
diff --git a/...lay/testData/headersReorgAndRetarget.json → ...lay/testData/headersReorgAndRetarget.json b/...lay/testData/headersReorgAndRetarget.json → ...lay/testData/headersReorgAndRetarget.json
diff --git a/test/fullRelay/testData/headersVerify.json → ...est/fullRelay/testData/headersVerify.json b/test/fullRelay/testData/headersVerify.json → ...est/fullRelay/testData/headersVerify.json
diff --git a/...llRelay/testData/headersWithRetarget.json → ...llRelay/testData/headersWithRetarget.json b/...llRelay/testData/headersWithRetarget.json → ...llRelay/testData/headersWithRetarget.json
diff --git a/test/swap/Btc_Marketplace.t.sol → contracts/test/swap/Btc_Marketplace.t.sol b/test/swap/Btc_Marketplace.t.sol → contracts/test/swap/Btc_Marketplace.t.sol
diff --git a/test/swap/Marketplace.t.sol → contracts/test/swap/Marketplace.t.sol b/test/swap/Marketplace.t.sol → contracts/test/swap/Marketplace.t.sol
diff --git a/test/swap/Ord_Marketplace.t.sol → contracts/test/swap/Ord_Marketplace.t.sol b/test/swap/Ord_Marketplace.t.sol → contracts/test/swap/Ord_Marketplace.t.sol
diff --git a/test/swap/Utilities.sol → contracts/test/swap/Utilities.sol b/test/swap/Utilities.sol → contracts/test/swap/Utilities.sol
diff --git a/crates/bindings/Cargo.toml b/crates/bindings/Cargo.toml
@@ -0,0 +1,7 @@
+[package]
+name = "bindings"
+version = "0.1.0"
+edition = "2021"
+
+[dependencies]
+alloy = { git = "https://github.com/alloy-rs/alloy", features = ["sol-types", "contract"] }