Implement build.rs bindings generation (#3827)

jmg-duarte · web-flow · commit bcb5e34c08ed · 2025-11-26T16:06:04.000Z
# Description
Implements bindings generation in `build.rs`, adding this allows
1.  Generated code to be inspected manually and "cmd-click"ed into
2. Faster incremental compilation since the code can be cached unlike
macros

# Changes
&lt;!-- List of detailed changes (how the change is accomplished) --&gt;

- [ ] New contracts-generate crate to simplify build.rs code
- [ ] Generate bindings in contracts build.rs
- [ ] Migrate everything without changing any module paths
- [ ] Moved away from the Provider re-export
(`contracts::alloy::Provider` -&gt; `alloy::providers::DynProvider`)
- [ ] Removes the ethcontract re-export from the contracts crate
- [ ] Removes now unused code (some inconsistent tests and dummy legacy
things)

## How to test
Run existing tests &amp; compile

&lt;!--
## Related Issues

Fixes #
--&gt;
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -99,6 +99,13 @@ tower-http = "0.4"
 tracing-opentelemetry = "0.31"
 tracing-serde = "0.2"
 vergen = "8"
+walkdir = "2.5.0"
+quote = "1.0.41"
+syn = "2.0.108"
+prettyplease = "0.2.37"
+proc-macro2 = "1.0.103"
+alloy-sol-macro-input = "1.4.1"
+alloy-sol-macro-expander = "1.4.1"
 
 [workspace.lints]
 clippy.cast_possible_wrap = "deny"
diff --git a/crates/autopilot/src/boundary/events/settlement.rs b/crates/autopilot/src/boundary/events/settlement.rs
@@ -28,7 +28,7 @@ impl AlloyEventRetrieving for GPv2SettlementContract {
         Filter::new().address(self.address)
     }
 
-    fn provider(&self) -> &contracts::alloy::Provider {
+    fn provider(&self) -> &alloy::providers::DynProvider {
         &self.provider
     }
 }
diff --git a/crates/autopilot/src/database/ethflow_events/event_retriever.rs b/crates/autopilot/src/database/ethflow_events/event_retriever.rs
@@ -29,7 +29,7 @@ impl EthFlowRefundRetriever {
 impl AlloyEventRetrieving for EthFlowRefundRetriever {
     type Event = CoWSwapEthFlow::CoWSwapEthFlowEvents;
 
-    fn provider(&self) -> &contracts::alloy::Provider {
+    fn provider(&self) -> &alloy::providers::DynProvider {
         &self.web3.alloy
     }
 
diff --git a/crates/autopilot/src/database/onchain_order_events/event_retriever.rs b/crates/autopilot/src/database/onchain_order_events/event_retriever.rs
@@ -42,7 +42,7 @@ impl AlloyEventRetrieving for CoWSwapOnchainOrdersContract {
             ]))
     }
 
-    fn provider(&self) -> &contracts::alloy::Provider {
+    fn provider(&self) -> &alloy::providers::DynProvider {
         &self.web3.alloy
     }
 }
diff --git a/crates/autopilot/src/database/onchain_order_events/mod.rs b/crates/autopilot/src/database/onchain_order_events/mod.rs
@@ -786,7 +786,7 @@ mod test {
         super::*,
         crate::database::Config,
         alloy::primitives::U256,
-        contracts::alloy::{CoWSwapOnchainOrders, InstanceExt},
+        contracts::alloy::CoWSwapOnchainOrders,
         database::{byte_array::ByteArray, onchain_broadcasted_orders::OnchainOrderPlacement},
         ethcontract::H160,
         ethrpc::Web3,
diff --git a/crates/autopilot/src/infra/blockchain/contracts.rs b/crates/autopilot/src/infra/blockchain/contracts.rs
@@ -6,7 +6,6 @@ use {
         GPv2AllowListAuthentication,
         GPv2Settlement,
         HooksTrampoline,
-        InstanceExt,
         WETH9,
         support::Balances,
     },
diff --git a/crates/autopilot/src/run.rs b/crates/autopilot/src/run.rs
@@ -27,7 +27,7 @@ use {
     alloy::eips::BlockNumberOrTag,
     chain::Chain,
     clap::Parser,
-    contracts::alloy::{BalancerV2Vault, GPv2Settlement, IUniswapV3Factory, InstanceExt, WETH9},
+    contracts::alloy::{BalancerV2Vault, GPv2Settlement, IUniswapV3Factory, WETH9},
     ethcontract::H160,
     ethrpc::{
         Web3,
diff --git a/crates/contracts/.gitignore b/crates/contracts/.gitignore
@@ -0,0 +1,2 @@
+# Generated by build.rs, will contain the contract bindings
+src/alloy
diff --git a/crates/contracts/Cargo.toml b/crates/contracts/Cargo.toml
@@ -22,8 +22,9 @@ bin = [
 
 [dependencies]
 alloy = { workspace = true, features = ["sol-types", "json", "contract", "json-abi"] }
-paste = { workspace = true }
 ethcontract = { workspace = true }
+paste = { workspace = true }
+serde = { workspace = true }
 serde_json = { workspace = true }
 
 # [bin-dependencies]
@@ -33,8 +34,14 @@ tracing = { workspace = true, optional = true }
 tracing-subscriber = { workspace = true, features = ["env-filter", "fmt"], optional = true }
 
 [build-dependencies]
-ethcontract = { workspace = true }
-ethcontract-generate = { workspace = true }
+anyhow = { workspace = true }
+alloy-sol-macro-expander = {workspace = true}
+alloy-sol-macro-input = {workspace = true, features = ["json"]}
+prettyplease = {workspace = true}
+proc-macro2 = {workspace = true}
+quote = {workspace = true}
+syn = {workspace = true}
+walkdir = {workspace = true}
 
 [lints]
 workspace = true
diff --git a/crates/contracts/build.rs b/crates/contracts/build.rs
diff --git a/crates/contracts/src/alloy.rs b/crates/contracts/src/alloy.rs
diff --git a/crates/contracts/src/lib.rs b/crates/contracts/src/lib.rs
@@ -1,88 +1,11 @@
 #![allow(clippy::let_unit_value)]
 
-pub use ethcontract;
+// This module get's auto-generated by the contracts build.rs
+#[rustfmt::skip]
 pub mod alloy;
-pub mod errors;
-use {
-    anyhow::{Result, anyhow, bail},
-    ethcontract::{
-        Contract,
-        common::{DeploymentInformation, contract::Network},
-    },
-};
-
-pub fn deployment(contract: &Contract, chain_id: u64) -> Result<&Network> {
-    contract
-        .networks
-        .get(&chain_id.to_string())
-        // Note that we are conflating network IDs with chain IDs. In general
-        // they cannot be considered the same, but for the networks that we
-        // support (xDAI, Görli and Mainnet) they are.
-        .ok_or_else(|| anyhow!("missing {} deployment for {}", contract.name, chain_id))
-}
-
-pub fn deployment_block(contract: &Contract, chain_id: u64) -> Result<u64> {
-    let deployment_info = deployment(contract, chain_id)?
-        .deployment_information
-        .ok_or_else(|| anyhow!("missing deployment information for {}", contract.name))?;
 
-    match deployment_info {
-        DeploymentInformation::BlockNumber(block) => Ok(block),
-        DeploymentInformation::TransactionHash(tx) => {
-            bail!("missing deployment block number for {}", tx)
-        }
-    }
-}
-
-#[macro_use]
-mod macros;
+pub mod errors;
 
 #[cfg(feature = "bin")]
 pub mod paths;
 pub mod vault;
-pub mod web3;
-
-#[cfg(test)]
-mod tests {
-    use {
-        super::*,
-        crate::alloy::networks::{ARBITRUM_ONE, GNOSIS, MAINNET, SEPOLIA},
-    };
-
-    #[test]
-    fn deployment_addresses() {
-        for network in &[MAINNET, GNOSIS, SEPOLIA, ARBITRUM_ONE] {
-            assert!(
-                alloy::BalancerV2NoProtocolFeeLiquidityBootstrappingPoolFactory::deployment_address(network).is_some()
-            )
-        }
-        for network in &[MAINNET, ARBITRUM_ONE] {
-            assert!(
-                alloy::BalancerV2WeightedPool2TokensFactory::deployment_address(network).is_some()
-            );
-            assert!(
-                alloy::BalancerV2LiquidityBootstrappingPoolFactory::deployment_address(network)
-                    .is_some()
-            );
-        }
-
-        assert!(alloy::BalancerV2WeightedPoolFactory::deployment_address(&MAINNET).is_some());
-
-        for network in &[MAINNET, GNOSIS, ARBITRUM_ONE] {
-            assert!(alloy::BalancerV2StablePoolFactoryV2::deployment_address(network).is_some());
-        }
-    }
-
-    #[test]
-    fn deployment_information() {
-        assert!(alloy::BalancerV2WeightedPoolFactory::deployment_address(&MAINNET).is_some());
-        for network in &[MAINNET, ARBITRUM_ONE] {
-            assert!(
-                alloy::BalancerV2WeightedPool2TokensFactory::deployment_address(network).is_some()
-            );
-        }
-        for network in &[MAINNET, GNOSIS, ARBITRUM_ONE] {
-            assert!(alloy::BalancerV2StablePoolFactoryV2::deployment_address(network).is_some());
-        }
-    }
-}
diff --git a/crates/contracts/src/macros.rs b/crates/contracts/src/macros.rs
diff --git a/crates/contracts/src/web3.rs b/crates/contracts/src/web3.rs
diff --git a/crates/driver/src/boundary/liquidity/zeroex.rs b/crates/driver/src/boundary/liquidity/zeroex.rs
@@ -7,7 +7,6 @@ use {
         infra::{self, Ethereum},
     },
     anyhow::anyhow,
-    contracts::alloy::InstanceExt,
     ethrpc::block_stream::CurrentBlockWatcher,
     shared::{
         http_client::HttpClientFactory,
diff --git a/crates/e2e/src/setup/deploy.rs b/crates/e2e/src/setup/deploy.rs
@@ -7,7 +7,6 @@ use {
         GPv2AllowListAuthentication,
         GPv2Settlement,
         HooksTrampoline,
-        InstanceExt,
         UniswapV2Factory,
         UniswapV2Router02,
         WETH9,
diff --git a/crates/e2e/src/setup/onchain_components/safe.rs b/crates/e2e/src/setup/onchain_components/safe.rs
@@ -182,8 +182,10 @@ impl Safe {
         to: alloy::primitives::Address,
         data: Vec<u8>,
         nonce: alloy::primitives::U256,
-    ) -> alloy::contract::CallBuilder<&contracts::alloy::Provider, PhantomData<execTransactionCall>>
-    {
+    ) -> alloy::contract::CallBuilder<
+        &alloy::providers::DynProvider,
+        PhantomData<execTransactionCall>,
+    > {
         let signature = self.sign({
             // `SafeTx` struct hash computation ported from the Safe Solidity code:
             // <https://etherscan.io/address/0xd9Db270c1B5E3Bd161E8c8503c55cEABeE709552#code#F1#L377>
diff --git a/crates/e2e/tests/e2e/liquidity.rs b/crates/e2e/tests/e2e/liquidity.rs
@@ -4,7 +4,7 @@ use {
         providers::ext::{AnvilApi, ImpersonateConfig},
     },
     chrono::{NaiveDateTime, Utc},
-    contracts::alloy::{ERC20, IZeroex, InstanceExt},
+    contracts::alloy::{ERC20, IZeroex},
     driver::domain::eth::H160,
     e2e::{
         api::zeroex::{Eip712TypedZeroExOrder, ZeroExApi},
diff --git a/crates/e2e/tests/e2e/liquidity_source_notification.rs b/crates/e2e/tests/e2e/liquidity_source_notification.rs
@@ -5,7 +5,7 @@ use {
         signers::{SignerSync, local::PrivateKeySigner},
     },
     chrono::Utc,
-    contracts::alloy::{ERC20, InstanceExt, LiquoriceSettlement},
+    contracts::alloy::{ERC20, LiquoriceSettlement},
     driver::infra,
     e2e::{
         api,
diff --git a/crates/orderbook/src/run.rs b/crates/orderbook/src/run.rs
@@ -19,7 +19,6 @@ use {
         GPv2Settlement,
         HooksTrampoline,
         IUniswapV3Factory,
-        InstanceExt,
         WETH9,
         support::Balances,
     },
diff --git a/crates/shared/src/bad_token/trace_call.rs b/crates/shared/src/bad_token/trace_call.rs
@@ -399,7 +399,7 @@ mod tests {
         },
         alloy::primitives::address,
         chain::Chain,
-        contracts::alloy::{BalancerV2Vault, GPv2Settlement, IUniswapV3Factory, InstanceExt},
+        contracts::alloy::{BalancerV2Vault, GPv2Settlement, IUniswapV3Factory},
         ethrpc::{Web3, alloy::conversions::IntoLegacy},
         std::{env, time::Duration},
         web3::types::{
diff --git a/crates/shared/src/event_handling.rs b/crates/shared/src/event_handling.rs
@@ -773,7 +773,7 @@ mod tests {
     use {
         super::*,
         alloy::eips::BlockNumberOrTag,
-        contracts::alloy::{GPv2Settlement, InstanceExt},
+        contracts::alloy::GPv2Settlement,
         ethcontract::{BlockNumber, H256},
         ethrpc::{Web3, block_stream::block_number_to_block_number_hash},
         std::str::FromStr,
@@ -786,7 +786,7 @@ mod tests {
             Filter::new().address(*self.address())
         }
 
-        fn provider(&self) -> &contracts::alloy::Provider {
+        fn provider(&self) -> &alloy::providers::DynProvider {
             self.provider()
         }
     }
diff --git a/crates/shared/src/sources/balancer_v2/pool_fetching/mod.rs b/crates/shared/src/sources/balancer_v2/pool_fetching/mod.rs
@@ -47,7 +47,6 @@ use {
         BalancerV2WeightedPoolFactory,
         BalancerV2WeightedPoolFactoryV3,
         BalancerV2WeightedPoolFactoryV4,
-        InstanceExt,
     },
     ethcontract::{BlockId, H160, H256},
     ethrpc::block_stream::{BlockRetrieving, CurrentBlockWatcher},
diff --git a/crates/solvers/src/boundary/liquidity/concentrated.rs b/crates/solvers/src/boundary/liquidity/concentrated.rs
@@ -1,12 +1,10 @@
 use {
     alloy::primitives::aliases::U24,
-    contracts::{
-        alloy::UniswapV3QuoterV2::IQuoterV2::{
-            QuoteExactInputSingleParams,
-            QuoteExactOutputSingleParams,
-        },
-        ethcontract::{H160, U256},
+    contracts::alloy::UniswapV3QuoterV2::IQuoterV2::{
+        QuoteExactInputSingleParams,
+        QuoteExactOutputSingleParams,
     },
+    ethcontract::{H160, U256},
     ethrpc::alloy::conversions::{IntoAlloy, IntoLegacy},
     model::TokenPair,
     shared::baseline_solver::BaselineSolvable,
diff --git a/crates/solvers/src/boundary/liquidity/limit_order.rs b/crates/solvers/src/boundary/liquidity/limit_order.rs
@@ -1,6 +1,6 @@
 use {
     crate::domain::liquidity::limit_order::LimitOrder,
-    contracts::ethcontract::{H160, U256},
+    ethcontract::{H160, U256},
     shared::{baseline_solver::BaselineSolvable, price_estimation::gas::GAS_PER_ZEROEX_ORDER},
 };
 
@@ -50,7 +50,7 @@ mod tests {
     use {
         super::*,
         crate::domain::{eth, liquidity::limit_order::TakerAmount},
-        contracts::ethcontract::U256,
+        ethcontract::U256,
         shared::addr,
     };
 
diff --git a/crates/solvers/src/domain/solver.rs b/crates/solvers/src/domain/solver.rs
@@ -18,7 +18,6 @@ use {
         },
         infra::metrics,
     },
-    contracts::alloy::InstanceExt,
     ethereum_types::U256,
     reqwest::Url,
     std::{cmp, collections::HashSet, sync::Arc},

Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ impl AlloyEventRetrieving for GPv2SettlementContract {`
`28`	`28`	`Filter::new().address(self.address)`
`29`	`29`	`}`
`30`	`30`
`31`		`- fn provider(&self) -> &contracts::alloy::Provider {`
	`31`	`+ fn provider(&self) -> &alloy::providers::DynProvider {`
`32`	`32`	`&self.provider`
`33`	`33`	`}`
`34`	`34`	`}`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ impl EthFlowRefundRetriever {`
`29`	`29`	`impl AlloyEventRetrieving for EthFlowRefundRetriever {`
`30`	`30`	`type Event = CoWSwapEthFlow::CoWSwapEthFlowEvents;`
`31`	`31`
`32`		`- fn provider(&self) -> &contracts::alloy::Provider {`
	`32`	`+ fn provider(&self) -> &alloy::providers::DynProvider {`
`33`	`33`	`&self.web3.alloy`
`34`	`34`	`}`
`35`	`35`
Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,7 @@ impl AlloyEventRetrieving for CoWSwapOnchainOrdersContract {`
`42`	`42`	`]))`
`43`	`43`	`}`
`44`	`44`
`45`		`- fn provider(&self) -> &contracts::alloy::Provider {`
	`45`	`+ fn provider(&self) -> &alloy::providers::DynProvider {`
`46`	`46`	`&self.web3.alloy`
`47`	`47`	`}`
`48`	`48`	`}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+# Generated by build.rs, will contain the contract bindings`
	`2`	`+src/alloy`