wire presim through flashpool

Author: akundaz

crates/op-rbuilder/src/launcher.rs

@@ -1,7 +1,4 @@
-use std::sync::Arc;
-
 use eyre::Result;
-use futures::FutureExt;
 use reth_optimism_rpc::OpEthApiBuilder;
 use tracing::info;
 
@@ -11,24 +8,22 @@ use crate::{
         BackrunBundleApiServer, BackrunBundleRpc, maintain_backrun_bundle_pool_future,
     },
     builder::{BuilderConfig, FlashblocksServiceBuilder},
-    metrics::{OpRBuilderMetrics, VERSION, record_flag_gauge_metrics},
+    metrics::{VERSION, record_flag_gauge_metrics},
     monitor_tx_pool::monitor_tx_pool,
     pool::FlashpoolBuilder,
-    presim::{TopOfBlockSimulator, maintain_pending_simulations, maintain_tip_state},
     revert_protection::{EthApiExtServer, RevertProtectionExt},
 };
 use moka::future::Cache;
 use reth::builder::{NodeBuilder, WithLaunchContext};
+use reth_chain_state::CanonStateSubscriptions;
 use reth_cli_commands::launcher::Launcher;
 use reth_db::mdbx::DatabaseEnv;
 use reth_optimism_chainspec::OpChainSpec;
 use reth_optimism_cli::chainspec::OpChainSpecParser;
-use reth_optimism_evm::OpEvmConfig;
 use reth_optimism_node::{
     OpNode,
     node::{OpAddOns, OpAddOnsBuilder, OpEngineValidatorBuilder},
 };
-use reth_provider::{CanonStateSubscriptions, ChainSpecProvider};
 use reth_transaction_pool::TransactionPool;
 pub fn launch() -> Result<()> {
     let cli = Cli::parsed();
@@ -100,18 +95,9 @@ impl Launcher<OpChainSpecParser, OpRbuilderArgs> for BuilderLauncher {
         let reverted_cache = Cache::builder().max_capacity(100).build();
         let reverted_cache_copy = reverted_cache.clone();
         let backrun_bundle_enabled = builder_args.backrun_bundle.backruns_enabled;
-        let block_time_secs = builder_config.block_time.as_millis() as u64 / 1000;
         let backrun_bundle_pool = builder_config.backrun_bundle_pool.clone();
         let backrun_bundle_pool_maintain = backrun_bundle_pool.clone();
 
-        let simulator = if builder_args.pre_simulate_bundles {
-            Some(Arc::new(TopOfBlockSimulator::new()))
-        } else {
-            None
-        };
-        let simulator_for_rpc = simulator.clone();
-        let simulator_for_maintenance = simulator.clone();
-
         let addons: OpAddOns<_, OpEthApiBuilder, OpEngineValidatorBuilder> =
             OpAddOnsBuilder::default()
                 .with_sequencer(rollup_args.sequencer.clone())
@@ -140,7 +126,6 @@ impl Launcher<OpChainSpecParser, OpRbuilderArgs> for BuilderLauncher {
                         provider,
                         ctx.registry.eth_api().clone(),
                         reverted_cache,
-                        simulator_for_rpc,
                     );
 
                     ctx.modules
@@ -185,34 +170,6 @@ impl Launcher<OpChainSpecParser, OpRbuilderArgs> for BuilderLauncher {
                         ));
                 }
 
-                if let Some(simulator) = simulator_for_maintenance {
-                    let metrics = Arc::new(OpRBuilderMetrics::default());
-                    let chain_events = ctx.provider.canonical_state_stream();
-                    let evm_config = OpEvmConfig::optimism(ctx.provider.chain_spec());
-                    ctx.task_executor.spawn_task(
-                        maintain_tip_state(
-                            simulator.clone(),
-                            ctx.provider.clone(),
-                            evm_config,
-                            block_time_secs,
-                            metrics.clone(),
-                            chain_events,
-                        )
-                        .boxed(),
-                    );
-
-                    let pending_events = ctx.pool.all_transactions_event_listener();
-                    ctx.task_executor.spawn_task(
-                        maintain_pending_simulations(
-                            simulator,
-                            ctx.pool.clone(),
-                            metrics,
-                            pending_events,
-                        )
-                        .boxed(),
-                    );
-                }
-
                 Ok(())
             })
             .launch()

crates/op-rbuilder/src/lib.rs

@@ -9,7 +9,6 @@ pub mod launcher;
 pub mod metrics;
 mod monitor_tx_pool;
 pub mod pool;
-pub mod presim;
 pub mod primitives;
 pub mod revert_protection;
 pub(crate) mod runtime_ext;

crates/op-rbuilder/src/metrics.rs

@@ -159,16 +159,6 @@ pub struct OpRBuilderMetrics {
     pub bundles_reverted: Histogram,
     /// Histogram of eth_sendBundle request duration
     pub bundle_receive_duration: Histogram,
-    /// Number of bundles dropped by pre-simulation (reverted)
-    pub bundle_pre_simulation_reverts: Counter,
-    /// Number of bundles that passed pre-simulation
-    pub bundle_pre_simulation_passes: Counter,
-    /// Histogram of bundle pre-simulation duration
-    pub bundle_pre_simulation_duration: Histogram,
-    /// Number of updates to the tip state for the top of block simulator
-    pub presim_tip_state_updates: Counter,
-    /// Number of pending txs evicted due to failing top of block simulation
-    pub presim_pending_evictions: Counter,
     /// Transactions rejected by per-tx DA size limit
     pub tx_da_size_exceeded_total: Counter,
     /// Transactions rejected by cumulative block DA limit

crates/op-rbuilder/src/pool/builder.rs

@@ -1,15 +1,36 @@
+use std::sync::Arc;
+
+use futures::FutureExt;
+use reth_chain_state::CanonStateSubscriptions;
 use reth_evm::ConfigureEvm;
 use reth_node_api::{FullNodeTypes, NodeTypes, PrimitivesTy, TxTy};
 use reth_node_builder::{BuilderContext, components::PoolBuilder};
+use reth_optimism_chainspec::OpChainSpec;
+use reth_optimism_evm::OpEvmConfig;
 use reth_optimism_forks::OpHardforks;
 use reth_optimism_node::OpPoolBuilder;
-use reth_optimism_txpool::{OpPooledTx, OpTransactionPool};
-use reth_transaction_pool::{EthPoolTransaction, blobstore::DiskFileBlobStore};
+use reth_optimism_txpool::{OpPooledTx, OpTransactionPool, OpTransactionValidator};
+use reth_primitives_traits::{Block, NodePrimitives};
+use reth_provider::{BlockReaderIdExt, ChainSpecProvider, NodePrimitivesProvider};
+use reth_transaction_pool::{
+    EthPoolTransaction, TransactionPool, TransactionValidationTaskExecutor,
+    blobstore::DiskFileBlobStore,
+};
 
-use crate::{args::OpRbuilderArgs, pool::Flashpool, tx::FBPooledTransaction};
+use crate::{
+    args::OpRbuilderArgs,
+    pool::{
+        Flashpool,
+        metrics::PoolMetrics,
+        presim::{TopOfBlockSimulator, maintain_pending_simulations, maintain_tip_state},
+    },
+    tx::FBPooledTransaction,
+};
 
 pub struct FlashpoolBuilder {
     op_pool_builder: OpPoolBuilder<FBPooledTransaction>,
+    pre_simulate_bundles: bool,
+    block_time_secs: u64,
 }
 
 impl FlashpoolBuilder {
@@ -22,26 +43,79 @@ impl FlashpoolBuilder {
                 rollup_args.enable_tx_conditional || builder_args.enable_revert_protection,
             );
 
-        Self { op_pool_builder }
+        Self {
+            op_pool_builder,
+            pre_simulate_bundles: builder_args.pre_simulate_bundles,
+            block_time_secs: builder_args.chain_block_time / 1000,
+        }
     }
 }
 
 impl<Node, Evm> PoolBuilder<Node, Evm> for FlashpoolBuilder
 where
     Node: FullNodeTypes<Types: NodeTypes<ChainSpec: OpHardforks>>,
+    Node::Provider: ChainSpecProvider<ChainSpec = OpChainSpec>
+        + BlockReaderIdExt<Header = alloy_consensus::Header>,
+    <Node::Provider as NodePrimitivesProvider>::Primitives:
+        NodePrimitives<Block: Block<Header = alloy_consensus::Header>>,
     FBPooledTransaction: EthPoolTransaction<Consensus = TxTy<Node::Types>> + OpPooledTx,
     Evm: ConfigureEvm<Primitives = PrimitivesTy<Node::Types>> + Clone + 'static,
 {
-    type Pool =
-        Flashpool<OpTransactionPool<Node::Provider, DiskFileBlobStore, Evm, FBPooledTransaction>>;
+    type Pool = Flashpool<
+        OpTransactionPool<Node::Provider, DiskFileBlobStore, Evm, FBPooledTransaction>,
+        TransactionValidationTaskExecutor<
+            OpTransactionValidator<Node::Provider, FBPooledTransaction, Evm>,
+        >,
+    >;
 
     async fn build_pool(
         self,
         ctx: &BuilderContext<Node>,
         evm_config: Evm,
     ) -> eyre::Result<Self::Pool> {
+        let inner_pool = self.op_pool_builder.build_pool(ctx, evm_config).await?;
+        let validator = inner_pool.validator().clone();
+        let metrics = Arc::new(PoolMetrics::default());
+
+        let simulator = if self.pre_simulate_bundles {
+            let simulator = Arc::new(TopOfBlockSimulator::new());
+
+            let chain_events = ctx.provider().canonical_state_stream();
+            let op_evm_config = OpEvmConfig::optimism(ctx.provider().chain_spec());
+            ctx.task_executor().spawn_task(
+                maintain_tip_state(
+                    simulator.clone(),
+                    ctx.provider().clone(),
+                    op_evm_config,
+                    self.block_time_secs,
+                    metrics.clone(),
+                    chain_events,
+                )
+                .boxed(),
+            );
+
+            let pending_events = inner_pool.all_transactions_event_listener();
+            ctx.task_executor().spawn_task(
+                maintain_pending_simulations(
+                    simulator.clone(),
+                    inner_pool.clone(),
+                    metrics.clone(),
+                    pending_events,
+                )
+                .boxed(),
+            );
+
+            Some(simulator)
+        } else {
+            None
+        };
+
         Ok(Flashpool {
-            inner: self.op_pool_builder.build_pool(ctx, evm_config).await?,
+            inner: inner_pool,
+            validator,
+            simulator,
+            task_executor: ctx.task_executor().clone(),
+            metrics,
         })
     }
 }

crates/op-rbuilder/src/pool/delegate.rs

@@ -13,15 +13,27 @@ use reth_transaction_pool::{
     BestTransactionsAttributes, BlockInfo, GetPooledTransactionLimit, NewBlobSidecar,
     NewTransactionEvent, PoolResult, PoolSize, PoolTransaction, PropagatedTransactions,
     TransactionEvents, TransactionListenerKind, TransactionOrigin, TransactionPool,
-    ValidPoolTransaction, blobstore::BlobStoreError,
+    TransactionValidator, ValidPoolTransaction, blobstore::BlobStoreError,
 };
 use tokio::sync::mpsc::Receiver;
 
 use crate::{pool::Flashpool, tx::FBPooledTransaction};
 
-impl<P: TransactionPool<Transaction = FBPooledTransaction>> TransactionPool for Flashpool<P> {
+impl<
+    P: TransactionPool<Transaction = FBPooledTransaction> + 'static,
+    V: TransactionValidator<Transaction = FBPooledTransaction> + Clone,
+> TransactionPool for Flashpool<P, V>
+{
     type Transaction = FBPooledTransaction;
 
+    fn add_transaction(
+        &self,
+        origin: TransactionOrigin,
+        transaction: Self::Transaction,
+    ) -> impl Future<Output = PoolResult<AddedTransactionOutcome>> + Send {
+        self.add_transaction_override(origin, transaction)
+    }
+
     delegate! {
         to self.inner {
             fn pool_size(&self) -> PoolSize;
@@ -31,11 +43,7 @@ impl<P: TransactionPool<Transaction = FBPooledTransaction>> TransactionPool for
                 origin: TransactionOrigin,
                 transaction: Self::Transaction,
             ) -> impl Future<Output = PoolResult<TransactionEvents>> + Send;
-            fn add_transaction(
-                &self,
-                origin: TransactionOrigin,
-                transaction: Self::Transaction,
-            ) -> impl Future<Output = PoolResult<AddedTransactionOutcome>> + Send;
+
             fn add_transactions_with_origins(
                 &self,
                 transactions: impl IntoIterator<Item = (TransactionOrigin, Self::Transaction)> + Send,

crates/op-rbuilder/src/pool/metrics.rs

@@ -0,0 +1,22 @@
+use metrics::{Counter, Histogram, counter};
+use reth_metrics::Metrics;
+
+#[derive(Metrics, Clone)]
+#[metrics(scope = "op_rbuilder.pool")]
+pub(super) struct PoolMetrics {
+    /// Histogram of bundle pre-simulation duration
+    pub presim_duration: Histogram,
+    /// Number of updates to the tip state for the top of block simulator
+    pub presim_tip_state_updates: Counter,
+    /// Number of pending txs evicted due to failing top of block simulation
+    pub presim_pending_evictions: Counter,
+}
+
+pub(super) fn increment_presim_count(sim_result: &eyre::Result<bool>) {
+    let label = match sim_result {
+        Ok(true) => "passed",
+        Ok(false) => "reverted",
+        Err(_) => "failed",
+    };
+    counter!("op_rbuilder.pool.presim_count", "result" => label).increment(1);
+}

crates/op-rbuilder/src/pool/mod.rs

@@ -1,13 +1,32 @@
 mod builder;
 mod delegate;
+mod metrics;
+mod overrides;
+mod presim;
 
 pub use builder::FlashpoolBuilder;
 
-use reth_transaction_pool::TransactionPool;
+use std::sync::Arc;
 
-use crate::tx::FBPooledTransaction;
+use reth_tasks::TaskExecutor;
+
+use crate::pool::{metrics::PoolMetrics, presim::TopOfBlockSimulator};
 
 #[derive(Debug, Clone)]
-pub struct Flashpool<P: TransactionPool<Transaction = FBPooledTransaction>> {
+pub struct Flashpool<P, V> {
+    /// The reth transaction pool we're wrapping around
     inner: P,
+
+    /// The transaction validator
+    validator: V,
+
+    /// Optional pre-simulator: when present, revert-protected txs are simulated
+    /// before being added to the pool; those that would revert are rejected.
+    simulator: Option<Arc<TopOfBlockSimulator>>,
+
+    /// Task executor for spawning presim tasks
+    task_executor: TaskExecutor,
+
+    /// Metrics
+    metrics: Arc<PoolMetrics>,
 }