chore: make check_bundle_tx_list public (#219)

* make check_bundle_tx_list public

* version bump to rc 17

* fix ProviderStateSource impl

Author: Fraser999

Cargo.toml

@@ -3,7 +3,7 @@ members = ["crates/*"]
 resolver = "2"
 
 [workspace.package]
-version = "0.16.0-rc.16"
+version = "0.16.0-rc.17"
 edition = "2021"
 rust-version = "1.87"
 authors = ["init4"]
@@ -34,19 +34,19 @@ debug = false
 incremental = false
 
 [workspace.dependencies]
-signet-bundle = { version = "0.16.0-rc.16", path = "crates/bundle" }
-signet-constants = { version = "0.16.0-rc.16", path = "crates/constants" }
-signet-evm = { version = "0.16.0-rc.16", path = "crates/evm" }
-signet-extract = { version = "0.16.0-rc.16", path = "crates/extract" }
-signet-journal = { version = "0.16.0-rc.16", path = "crates/journal" }
-signet-node = { version = "0.16.0-rc.16", path = "crates/node" }
-signet-orders = { version = "0.16.0-rc.16", path = "crates/orders" }
-signet-sim = { version = "0.16.0-rc.16", path = "crates/sim" }
-signet-types = { version = "0.16.0-rc.16", path = "crates/types" }
-signet-tx-cache = { version = "0.16.0-rc.16", path = "crates/tx-cache" }
-signet-zenith = { version = "0.16.0-rc.16", path = "crates/zenith" }
+signet-bundle = { version = "0.16.0-rc.17", path = "crates/bundle" }
+signet-constants = { version = "0.16.0-rc.17", path = "crates/constants" }
+signet-evm = { version = "0.16.0-rc.17", path = "crates/evm" }
+signet-extract = { version = "0.16.0-rc.17", path = "crates/extract" }
+signet-journal = { version = "0.16.0-rc.17", path = "crates/journal" }
+signet-node = { version = "0.16.0-rc.17", path = "crates/node" }
+signet-orders = { version = "0.16.0-rc.17", path = "crates/orders" }
+signet-sim = { version = "0.16.0-rc.17", path = "crates/sim" }
+signet-types = { version = "0.16.0-rc.17", path = "crates/types" }
+signet-tx-cache = { version = "0.16.0-rc.17", path = "crates/tx-cache" }
+signet-zenith = { version = "0.16.0-rc.17", path = "crates/zenith" }
 
-signet-test-utils = { version = "0.16.0-rc.16", path = "crates/test-utils" }
+signet-test-utils = { version = "0.16.0-rc.17", path = "crates/test-utils" }
 
 # trevm
 trevm = { version = "0.34.1", features = ["full_env_cfg", "asyncdb"] }

crates/bundle/src/send/driver.rs

@@ -247,7 +247,7 @@ where
                         Ok(htrevm.accept_state())
                     })
                     .map_err(|err| {
-                        error!(err = %err.error(), err_dbg = ?err.error(), "error while running host transaction");
+                        debug!(err = %err.error(), err_dbg = ?err.error(), "error while running host transaction");
                         SignetEthBundleError::HostSimulation("host simulation error")
                     }),
                 trevm

crates/sim/src/cache/item.rs

@@ -1,15 +1,17 @@
-use crate::{cache::StateSource, CacheError, SimItemValidity};
+use crate::{
+    cache::{check_bundle_tx_list, StateSource},
+    CacheError, SimItemValidity,
+};
 use alloy::{
     consensus::{
         transaction::{Recovered, SignerRecoverable},
         Transaction, TxEnvelope,
     },
-    primitives::{Address, TxHash, U256},
+    primitives::{TxHash, U256},
 };
 use signet_bundle::{RecoveredBundle, SignetEthBundle, TxRequirement};
 use std::{
     borrow::{Borrow, Cow},
-    collections::BTreeMap,
     hash::Hash,
     sync::Arc,
 };
@@ -168,7 +170,7 @@ impl SimItem {
     where
         S: StateSource,
     {
-        Self::check_bundle_tx_list(items, source).await
+        check_bundle_tx_list(items, source).await
     }
 
     #[instrument(level = "trace", skip_all)]
@@ -179,79 +181,7 @@ impl SimItem {
     where
         S: StateSource,
     {
-        Self::check_bundle_tx_list(items, source).await
-    }
-
-    async fn check_bundle_tx_list<S>(
-        items: impl Iterator<Item = TxRequirement>,
-        source: &S,
-    ) -> Result<SimItemValidity, S::Error>
-    where
-        S: StateSource,
-    {
-        // For bundles, we want to check the nonce of each transaction. To do
-        // this, we build a small in memory cache so that if the same signer
-        // appears, we can reuse the nonce info. We do not check balances after
-        // the first tx, as they may have changed due to prior txs in the
-        // bundle.
-
-        let mut nonce_cache: BTreeMap<Address, u64> = BTreeMap::new();
-        let mut items = items.peekable();
-
-        // Peek to perform the balance check for the first tx
-        if let Some(first) = items.peek() {
-            let info = source.account_details(&first.signer).await?;
-
-            // check balance for the first tx is sufficient
-            if first.balance > info.balance {
-                trace!(
-                    required = %first.balance,
-                    available = %info.balance,
-                    signer = %first.signer,
-                    "insufficient balance",
-                );
-                return Ok(SimItemValidity::Future);
-            }
-
-            // Cache the nonce. This will be used for the first tx.
-            nonce_cache.insert(first.signer, info.nonce);
-        }
-
-        for requirement in items {
-            let state_nonce = match nonce_cache.get(&requirement.signer) {
-                Some(cached_nonce) => *cached_nonce,
-                None => {
-                    let nonce = source.nonce(&requirement.signer).await?;
-                    nonce_cache.insert(requirement.signer, nonce);
-                    nonce
-                }
-            };
-
-            let _guard = trace_span!(
-                "check_bundle_tx",
-                signer = %requirement.signer,
-                item_nonce = requirement.nonce,
-                expected_nonce = state_nonce,
-            )
-            .entered();
-
-            if requirement.nonce < state_nonce {
-                trace!("nonce too low");
-                return Ok(SimItemValidity::Never);
-            }
-            if requirement.nonce > state_nonce {
-                trace!("nonce too high");
-                return Ok(SimItemValidity::Future);
-            }
-
-            // Increment the cached nonce for the next transaction from this
-            // signer. Map _must_ have the entry as we just either loaded or
-            // stored it above
-            nonce_cache.entry(requirement.signer).and_modify(|n| *n += 1);
-        }
-
-        // All transactions passed
-        Ok(SimItemValidity::Now)
+        check_bundle_tx_list(items, source).await
     }
 
     async fn check_bundle<S, S2>(

crates/sim/src/cache/mod.rs

@@ -5,10 +5,10 @@ mod item;
 pub use item::{SimIdentifier, SimItem};
 
 mod state;
-pub use state::{AcctInfo, StateSource};
+pub use state::{AcctInfo, ProviderStateSource, StateSource};
 
 mod store;
 pub use store::SimCache;
 
 mod validity;
-pub use validity::SimItemValidity;
+pub use validity::{check_bundle_tx_list, SimItemValidity};

crates/sim/src/cache/state.rs

@@ -1,4 +1,8 @@
-use alloy::primitives::{Address, U256};
+use alloy::{
+    primitives::{Address, U256},
+    providers::Provider,
+    transports::TransportError,
+};
 use core::future::Future;
 use trevm::revm::database_interface::async_db::DatabaseAsyncRef;
 
@@ -62,3 +66,25 @@ where
         Ok(AcctInfo { nonce: info.nonce, balance: info.balance, has_code })
     }
 }
+
+/// A wrapper that implements [`StateSource`] for any alloy [`Provider`].
+///
+/// This allows using an alloy provider as a state source for bundle tx list
+/// validation via [`check_bundle_tx_list`].
+///
+/// [`check_bundle_tx_list`]: crate::check_bundle_tx_list
+#[derive(Debug, Clone)]
+pub struct ProviderStateSource<P>(pub P);
+
+impl<P: Provider> StateSource for ProviderStateSource<P> {
+    type Error = TransportError;
+
+    async fn account_details(&self, address: &Address) -> Result<AcctInfo, Self::Error> {
+        let (nonce, balance, code) = tokio::join!(
+            self.0.get_transaction_count(*address),
+            self.0.get_balance(*address),
+            self.0.get_code_at(*address),
+        );
+        Ok(AcctInfo { nonce: nonce?, balance: balance?, has_code: !code?.is_empty() })
+    }
+}

crates/sim/src/cache/validity.rs

@@ -1,4 +1,9 @@
+use crate::cache::StateSource;
+use alloy::primitives::Address;
 use core::fmt::{self, Display, Formatter};
+use signet_bundle::TxRequirement;
+use std::collections::BTreeMap;
+use tracing::{trace, trace_span};
 
 /// The validity status of a simulation item.
 ///
@@ -43,3 +48,80 @@ impl Display for SimItemValidity {
         }
     }
 }
+
+/// Check a list of bundle transactions for validity against a state source.
+///
+/// Validates nonces sequentially, building a per-signer nonce cache so that
+/// multiple transactions from the same signer are checked with incrementing
+/// nonces. The first transaction's balance is also checked.
+pub async fn check_bundle_tx_list<S>(
+    items: impl Iterator<Item = TxRequirement>,
+    source: &S,
+) -> Result<SimItemValidity, S::Error>
+where
+    S: StateSource,
+{
+    // For bundles, we want to check the nonce of each transaction. To do
+    // this, we build a small in memory cache so that if the same signer
+    // appears, we can reuse the nonce info. We do not check balances after
+    // the first tx, as they may have changed due to prior txs in the
+    // bundle.
+
+    let mut nonce_cache: BTreeMap<Address, u64> = BTreeMap::new();
+    let mut items = items.peekable();
+
+    // Peek to perform the balance check for the first tx
+    if let Some(first) = items.peek() {
+        let info = source.account_details(&first.signer).await?;
+
+        // check balance for the first tx is sufficient
+        if first.balance > info.balance {
+            trace!(
+                required = %first.balance,
+                available = %info.balance,
+                signer = %first.signer,
+                "insufficient balance",
+            );
+            return Ok(SimItemValidity::Future);
+        }
+
+        // Cache the nonce. This will be used for the first tx.
+        nonce_cache.insert(first.signer, info.nonce);
+    }
+
+    for requirement in items {
+        let state_nonce = match nonce_cache.get(&requirement.signer) {
+            Some(cached_nonce) => *cached_nonce,
+            None => {
+                let nonce = source.nonce(&requirement.signer).await?;
+                nonce_cache.insert(requirement.signer, nonce);
+                nonce
+            }
+        };
+
+        let _guard = trace_span!(
+            "check_bundle_tx",
+            signer = %requirement.signer,
+            item_nonce = requirement.nonce,
+            expected_nonce = state_nonce,
+        )
+        .entered();
+
+        if requirement.nonce < state_nonce {
+            trace!("nonce too low");
+            return Ok(SimItemValidity::Never);
+        }
+        if requirement.nonce > state_nonce {
+            trace!("nonce too high");
+            return Ok(SimItemValidity::Future);
+        }
+
+        // Increment the cached nonce for the next transaction from this
+        // signer. Map _must_ have the entry as we just either loaded or
+        // stored it above
+        nonce_cache.entry(requirement.signer).and_modify(|n| *n += 1);
+    }
+
+    // All transactions passed
+    Ok(SimItemValidity::Now)
+}

crates/sim/src/lib.rs

@@ -20,7 +20,8 @@ pub use built::BuiltBlock;
 
 mod cache;
 pub use cache::{
-    AcctInfo, CacheError, SimCache, SimIdentifier, SimItem, SimItemValidity, StateSource,
+    check_bundle_tx_list, AcctInfo, CacheError, ProviderStateSource, SimCache, SimIdentifier,
+    SimItem, SimItemValidity, StateSource,
 };
 
 mod env;

crates/tx-cache/Cargo.toml

@@ -18,7 +18,7 @@ signet-types.workspace = true
 alloy.workspace = true
 futures-util.workspace = true
 
-reqwest.workspace = true
+reqwest = { workspace = true, features = ["json"] }
 serde = { workspace = true, features = ["derive"] }
 tracing.workspace = true
 uuid = { workspace = true, features = ["serde"] }