txpool POC

Author: SozinM

Cargo.lock

@@ -79,6 +79,7 @@ derive_more.workspace = true
 metrics.workspace = true
 serde_json.workspace = true
 tokio-util.workspace = true
+auto_impl.workspace = true
 
 time = { version = "0.3.36", features = ["macros", "formatting", "parsing"] }
 chrono = "0.4"

crates/op-rbuilder/Cargo.toml

@@ -28,6 +28,7 @@ mod primitives;
 mod tester;
 mod tx_signer;
 use monitor_tx_pool::monitor_tx_pool;
+mod txpool_trait;
 
 fn main() {
     Cli::<OpChainSpecParser, args::OpRbuilderArgs>::parse()

crates/op-rbuilder/src/main.rs

@@ -1,3 +1,4 @@
+use crate::txpool_trait::{CustomPool, CustomTransactionPool};
 use crate::{
     generator::{BlockCell, BlockPayloadJobGenerator, BuildArguments, PayloadBuilder},
     metrics::OpRBuilderMetrics,
@@ -194,7 +195,7 @@ where
 impl<Pool, Client, EvmConfig, N, Txs> reth_basic_payload_builder::PayloadBuilder
     for OpPayloadBuilderVanilla<Pool, Client, EvmConfig, N, Txs>
 where
-    Pool: Clone + Send + Sync,
+    Pool: TransactionPool + Clone + Send + Sync,
     Client: Clone + Send + Sync,
     EvmConfig: Clone + Send + Sync,
     N: NodePrimitives,
@@ -223,13 +224,19 @@ where
 
 /// Optimism's payload builder
 #[derive(Debug, Clone)]
-pub struct OpPayloadBuilderVanilla<Pool, Client, EvmConfig, N: NodePrimitives, Txs = ()> {
+pub struct OpPayloadBuilderVanilla<
+    Pool: TransactionPool,
+    Client,
+    EvmConfig,
+    N: NodePrimitives,
+    Txs = (),
+> {
     /// The type responsible for creating the evm.
     pub evm_config: EvmConfig,
     /// The builder's signer key to use for an end of block tx
     pub builder_signer: Option<Signer>,
     /// The transaction pool
-    pub pool: Pool,
+    pub pool: CustomPool<Pool>,
     /// Node client
     pub client: Client,
     /// Settings for the builder, e.g. DA settings.
@@ -247,7 +254,7 @@ pub struct OpPayloadBuilderVanilla<Pool, Client, EvmConfig, N: NodePrimitives, T
     pub supervisor_safety_level: SafetyLevel,
 }
 
-impl<Pool, Client, EvmConfig, N: NodePrimitives>
+impl<Pool: TransactionPool, Client, EvmConfig, N: NodePrimitives>
     OpPayloadBuilderVanilla<Pool, Client, EvmConfig, N>
 {
     /// `OpPayloadBuilder` constructor.
@@ -298,6 +305,7 @@ impl<Pool, Client, EvmConfig, N: NodePrimitives>
                 serde_json::from_str(level.as_str()).expect("parsing supervisor_safety_level")
             })
             .unwrap_or(SafetyLevel::CrossUnsafe);
+        let pool = CustomPool::new(pool.clone());
         Self {
             pool,
             client,
@@ -772,30 +780,30 @@ impl<Txs> OpBuilder<'_, Txs> {
 pub trait OpPayloadTransactions<Transaction>: Clone + Send + Sync + Unpin + 'static {
     /// Returns an iterator that yields the transaction in the order they should get included in the
     /// new payload.
-    fn best_transactions<Pool: TransactionPool<Transaction = Transaction>>(
+    fn best_transactions<Pool: CustomTransactionPool<Transaction = Transaction>>(
         &self,
         pool: Pool,
         attr: BestTransactionsAttributes,
     ) -> impl PayloadTransactions<Transaction = Transaction>;
 
     /// Removes invalid transactions from the tx pool
-    fn remove_invalid<Pool: TransactionPool<Transaction = Transaction>>(
+    fn remove_invalid<Pool: CustomTransactionPool<Transaction = Transaction>>(
         &self,
         pool: Pool,
         hashes: Vec<TxHash>,
     );
 }
 
 impl<T: PoolTransaction> OpPayloadTransactions<T> for () {
-    fn best_transactions<Pool: TransactionPool<Transaction = T>>(
+    fn best_transactions<Pool: CustomTransactionPool<Transaction = T>>(
         &self,
         pool: Pool,
         attr: BestTransactionsAttributes,
     ) -> impl PayloadTransactions<Transaction = T> {
         BestPayloadTransactions::new(pool.best_transactions_with_attributes(attr))
     }
 
-    fn remove_invalid<Pool: TransactionPool<Transaction = T>>(
+    fn remove_invalid<Pool: CustomTransactionPool<Transaction = T>>(
         &self,
         pool: Pool,
         hashes: Vec<TxHash>,

crates/op-rbuilder/src/payload_builder_vanilla.rs

@@ -0,0 +1,80 @@
+use alloy_primitives::TxHash;
+use reth_transaction_pool::TransactionPool;
+use reth_transaction_pool::{
+    BestTransactions, BestTransactionsAttributes, BlobStore, EthPoolTransaction, Pool,
+    PoolTransaction, TransactionOrdering, TransactionValidator, ValidPoolTransaction,
+};
+use std::sync::Arc;
+#[auto_impl::auto_impl(&, Arc)]
+pub trait CustomTransactionPool: Send + Sync + Clone {
+    /// The transaction type of the pool
+    type Transaction: EthPoolTransaction;
+
+    /// Returns an iterator that yields transactions that are ready for block production with the
+    /// given base fee and optional blob fee attributes.
+    ///
+    /// Consumer: Block production
+    fn best_transactions_with_attributes(
+        &self,
+        best_transactions_attributes: BestTransactionsAttributes,
+    ) -> Box<dyn BestTransactions<Item = Arc<ValidPoolTransaction<Self::Transaction>>>>;
+
+    /// Removes all transactions corresponding to the given hashes.
+    ///
+    /// Consumer: Utility
+    fn remove_transactions(
+        &self,
+        hashes: Vec<TxHash>,
+    ) -> Vec<Arc<ValidPoolTransaction<Self::Transaction>>>;
+}
+
+#[derive(Debug)]
+pub struct CustomPool<Pool>
+where
+    Pool: TransactionPool,
+    Pool::Transaction: PoolTransaction,
+{
+    pool: Arc<Pool>,
+}
+
+impl<Pool> CustomPool<Pool>
+where
+    Pool: TransactionPool,
+    Pool::Transaction: PoolTransaction,
+{
+    pub fn new(pool: Pool) -> Self {
+        Self {
+            pool: Arc::new(pool),
+        }
+    }
+}
+
+impl<Pool> CustomTransactionPool for CustomPool<Pool>
+where
+    Pool: TransactionPool,
+    Pool::Transaction: PoolTransaction,
+{
+    type Transaction = Pool::Transaction;
+
+    fn best_transactions_with_attributes(
+        &self,
+        best_transactions_attributes: BestTransactionsAttributes,
+    ) -> Box<dyn BestTransactions<Item = Arc<ValidPoolTransaction<Self::Transaction>>>> {
+        TransactionPool::best_transactions_with_attributes(&self.pool, best_transactions_attributes)
+    }
+
+    fn remove_transactions(
+        &self,
+        hashes: Vec<TxHash>,
+    ) -> Vec<Arc<ValidPoolTransaction<Self::Transaction>>> {
+        TransactionPool::remove_transactions(&self.pool, hashes)
+    }
+}
+
+impl<Pool: TransactionPool> Clone for CustomPool<Pool> {
+    fn clone(&self) -> Self {
+        Self {
+            pool: Arc::clone(&self.pool),
+        }
+    }
+}