Move ethcontract_errors into contracts crate (#3111)

# Description Moves some helper functions for `ethcontract` errors into the `contracts` crate to further reduce the scope of the `shared` crate. Only if you include the `contracts` crate should these helper functions be relevant to you.
cowprotocol · Nov 5, 2024 · 46244b5 · 46244b5
1 parent f953439
commit 46244b5
Show file tree

Hide file tree

Showing 10 changed files with 29 additions and 34 deletions.
diff --git a/crates/shared/src/ethcontract_error.rs → crates/contracts/src/errors.rs b/crates/shared/src/ethcontract_error.rs → crates/contracts/src/errors.rs
@@ -45,7 +45,7 @@ impl AsExecutionError for ExecutionError {
 pub fn testing_node_error() -> MethodError {
     MethodError {
         signature: String::new(),
-        inner: ExecutionError::Web3(web3::Error::Internal),
+        inner: ExecutionError::Web3(ethcontract::web3::Error::Internal),
     }
 }
 

diff --git a/crates/contracts/src/lib.rs b/crates/contracts/src/lib.rs
@@ -1,6 +1,7 @@
 #![allow(clippy::let_unit_value)]
 
 pub use ethcontract;
+pub mod errors;
 use {
     anyhow::{anyhow, bail, Result},
     ethcontract::{

diff --git a/crates/shared/src/bad_token/token_owner_finder.rs b/crates/shared/src/bad_token/token_owner_finder.rs
@@ -25,14 +25,13 @@ use {
             token_owner_list::TokenOwnerList,
         },
         baseline_solver::BaseTokens,
-        ethcontract_error::EthcontractErrorType,
         ethrpc::{Web3, MAX_BATCH_SIZE},
         http_client::HttpClientFactory,
         sources::uniswap_v2::pair_provider::PairProvider,
     },
     anyhow::{Context, Result},
     chain::Chain,
-    contracts::{BalancerV2Vault, IUniswapV3Factory, ERC20},
+    contracts::{errors::EthcontractErrorType, BalancerV2Vault, IUniswapV3Factory, ERC20},
     ethcontract::U256,
     futures::{Stream, StreamExt as _},
     primitive_types::H160,

diff --git a/crates/shared/src/code_simulation.rs b/crates/shared/src/code_simulation.rs
@@ -1,11 +1,9 @@
 //! Abstraction for simulating calls with overrides.
 
 use {
-    crate::{
-        ethcontract_error::EthcontractErrorType,
-        tenderly_api::{SimulationKind, SimulationRequest, StateObject, TenderlyApi},
-    },
+    crate::tenderly_api::{SimulationKind, SimulationRequest, StateObject, TenderlyApi},
     anyhow::{ensure, Context as _, Result},
+    contracts::errors::EthcontractErrorType,
     ethcontract::{errors::ExecutionError, H256},
     ethrpc::{
         extensions::{EthExt as _, StateOverride, StateOverrides},

diff --git a/crates/shared/src/lib.rs b/crates/shared/src/lib.rs
@@ -11,7 +11,6 @@ pub mod conversions;
 pub mod current_block;
 pub mod db_order_conversions;
 pub mod encoded_settlement;
-pub mod ethcontract_error;
 pub mod ethrpc;
 pub mod event_handling;
 pub mod event_storing_helpers;

diff --git a/crates/shared/src/signature_validator/simulation.rs b/crates/shared/src/signature_validator/simulation.rs
@@ -5,9 +5,8 @@
 
 use {
     super::{SignatureCheck, SignatureValidating, SignatureValidationError},
-    crate::ethcontract_error::EthcontractErrorType,
     anyhow::Result,
-    contracts::ERC1271SignatureValidator,
+    contracts::{errors::EthcontractErrorType, ERC1271SignatureValidator},
     ethcontract::Bytes,
     ethrpc::Web3,
     futures::future,

diff --git a/crates/shared/src/sources/balancer_v2/pool_fetching/registry.rs b/crates/shared/src/sources/balancer_v2/pool_fetching/registry.rs
@@ -4,7 +4,6 @@
 use {
     super::{internal::InternalPoolFetching, pool_storage::PoolStorage},
     crate::{
-        ethcontract_error::EthcontractErrorType,
         event_handling::{EventHandler, EventRetrieving},
         maintenance::Maintaining,
         recent_block_cache::Block,
@@ -16,7 +15,11 @@ use {
         },
     },
     anyhow::Result,
-    contracts::{balancer_v2_base_pool_factory, BalancerV2BasePoolFactory},
+    contracts::{
+        balancer_v2_base_pool_factory,
+        errors::EthcontractErrorType,
+        BalancerV2BasePoolFactory,
+    },
     ethcontract::{dyns::DynAllEventsBuilder, errors::MethodError, BlockId, Instance, H256},
     ethrpc::{
         block_stream::{BlockNumberHash, BlockRetrieving},
@@ -156,13 +159,11 @@ fn is_contract_error(err: &anyhow::Error) -> bool {
 mod tests {
     use {
         super::*,
-        crate::{
-            ethcontract_error,
-            sources::balancer_v2::{
-                pools::{weighted, PoolKind},
-                swap::fixed_point::Bfp,
-            },
+        crate::sources::balancer_v2::{
+            pools::{weighted, PoolKind},
+            swap::fixed_point::Bfp,
         },
+        contracts::errors::{testing_contract_error, testing_node_error},
     };
 
     #[tokio::test]
@@ -177,14 +178,14 @@ mod tests {
                 }),
             })),
             Ok(PoolStatus::Paused),
-            Err(ethcontract_error::testing_contract_error().into()),
+            Err(testing_contract_error().into()),
         ];
         assert_eq!(collect_pool_results(results).unwrap().len(), 1);
     }
 
     #[tokio::test]
     async fn collecting_results_forwards_node_error() {
-        let node_err = Err(ethcontract_error::testing_node_error().into());
+        let node_err = Err(testing_node_error().into());
         assert!(collect_pool_results(vec![node_err]).is_err());
     }
 }
diff --git a/crates/shared/src/sources/swapr/reader.rs b/crates/shared/src/sources/swapr/reader.rs
@@ -53,11 +53,11 @@ mod tests {
     use {
         super::*,
         crate::{
-            ethcontract_error,
             ethrpc::{create_env_test_transport, Web3},
             recent_block_cache::Block,
             sources::{uniswap_v2, BaselineSource},
         },
+        contracts::errors::testing_contract_error,
         ethcontract::H160,
         maplit::hashset,
     };
@@ -93,7 +93,7 @@ mod tests {
         let address = H160::from_low_u64_be(1);
         assert!(handle_results(
             Ok(Some(Pool::uniswap(address, tokens, (0, 0)))),
-            Err(ethcontract_error::testing_contract_error()),
+            Err(testing_contract_error()),
         )
         .unwrap()
         .is_none());

diff --git a/crates/shared/src/sources/uniswap_v2/pool_fetching.rs b/crates/shared/src/sources/uniswap_v2/pool_fetching.rs
@@ -1,13 +1,8 @@
 use {
     super::pair_provider::PairProvider,
-    crate::{
-        baseline_solver::BaselineSolvable,
-        ethcontract_error::EthcontractErrorType,
-        ethrpc::Web3,
-        recent_block_cache::Block,
-    },
+    crate::{baseline_solver::BaselineSolvable, ethrpc::Web3, recent_block_cache::Block},
     anyhow::Result,
-    contracts::{IUniswapLikePair, ERC20},
+    contracts::{errors::EthcontractErrorType, IUniswapLikePair, ERC20},
     ethcontract::{errors::MethodError, BlockId, H160, U256},
     futures::{
         future::{self, BoxFuture},
@@ -366,7 +361,10 @@ pub mod test_util {
 
 #[cfg(test)]
 mod tests {
-    use {super::*, crate::ethcontract_error};
+    use {
+        super::*,
+        contracts::errors::{testing_contract_error, testing_node_error},
+    };
 
     #[test]
     fn test_get_amounts_out() {
@@ -499,7 +497,7 @@ mod tests {
     #[test]
     fn pool_fetcher_forwards_node_error() {
         let fetched_pool = FetchedPool {
-            reserves: Err(ethcontract_error::testing_node_error()),
+            reserves: Err(testing_node_error()),
             pair: Default::default(),
             token0_balance: Ok(1.into()),
             token1_balance: Ok(1.into()),
@@ -511,7 +509,7 @@ mod tests {
     #[test]
     fn pool_fetcher_skips_contract_error() {
         let fetched_pool = FetchedPool {
-            reserves: Err(ethcontract_error::testing_contract_error()),
+            reserves: Err(testing_contract_error()),
             pair: Default::default(),
             token0_balance: Ok(1.into()),
             token1_balance: Ok(1.into()),

diff --git a/crates/shared/src/token_info.rs b/crates/shared/src/token_info.rs
@@ -1,9 +1,9 @@
 use {
-    crate::{ethcontract_error::EthcontractErrorType, ethrpc::Web3},
     anyhow::Result,
     async_trait::async_trait,
-    contracts::ERC20,
+    contracts::{errors::EthcontractErrorType, ERC20},
     ethcontract::{errors::MethodError, H160},
+    ethrpc::Web3,
     futures::{
         future::{BoxFuture, Shared},
         FutureExt,