Skip to main content

reth_transaction_pool/
traits.rs

1//! Transaction Pool Traits and Types
2//!
3//! This module defines the core abstractions for transaction pool implementations,
4//! handling the complexity of different transaction representations across the
5//! network, mempool, and the chain itself.
6//!
7//! ## Key Concepts
8//!
9//! ### Transaction Representations
10//!
11//! Transactions exist in different formats throughout their lifecycle:
12//!
13//! 1. **Consensus Format** ([`PoolTransaction::Consensus`])
14//!    - The canonical format stored in blocks
15//!    - Minimal size for efficient storage
16//!    - Example: EIP-4844 transactions store only blob hashes: ([`TransactionSigned::Eip4844`])
17//!
18//! 2. **Pooled Format** ([`PoolTransaction::Pooled`])
19//!    - Extended format for network propagation
20//!    - Includes additional validation data
21//!    - Example: EIP-4844 transactions include full blob sidecars: ([`PooledTransactionVariant`])
22//!
23//! ### Type Relationships
24//!
25//! ```text
26//! NodePrimitives::SignedTx  ←──   NetworkPrimitives::BroadcastedTransaction
27//!        │                              │
28//!        │ (consensus format)           │ (announced to peers)
29//!        │                              │
30//!        └──────────┐  ┌────────────────┘
31//!                   ▼  ▼
32//!            PoolTransaction::Consensus
33//!                   │ ▲
34//!                   │ │ from pooled (always succeeds)
35//!                   │ │
36//!                   ▼ │ try_from consensus (may fail)
37//!            PoolTransaction::Pooled  ←──→  NetworkPrimitives::PooledTransaction
38//!                                             (sent on request)
39//! ```
40//!
41//! ### Special Cases
42//!
43//! #### EIP-4844 Blob Transactions
44//! - Consensus format: Only blob hashes (32 bytes each)
45//! - Pooled format: Full blobs + commitments + proofs (large data per blob)
46//! - Network behavior: Not broadcast automatically, only sent on explicit request
47//!
48//! #### Optimism Deposit Transactions
49//! - Only exist in consensus format
50//! - Never enter the mempool (system transactions)
51//! - Conversion from consensus to pooled always fails
52
53use crate::{
54    blobstore::{BlobStore, BlobStoreError},
55    error::{InvalidPoolTransactionError, PoolError, PoolResult},
56    pool::{
57        state::SubPool, BestTransactionFilter, NewTransactionEvent, TransactionEvents,
58        TransactionListenerKind,
59    },
60    validate::ValidPoolTransaction,
61    AddedTransactionOutcome, AllTransactionsEvents,
62};
63use alloy_consensus::{error::ValueError, transaction::TxHashRef, BlockHeader, Signed, Typed2718};
64use alloy_eips::{
65    eip2718::{Encodable2718, WithEncoded},
66    eip2930::AccessList,
67    eip4844::{
68        env_settings::KzgSettings, BlobAndProofV1, BlobAndProofV2, BlobCellsAndProofsV1,
69        BlobTransactionValidationError,
70    },
71    eip7594::BlobTransactionSidecarVariant,
72    eip7702::SignedAuthorization,
73};
74use alloy_primitives::{
75    map::{AddressSet, B256Map},
76    Address, Bytes, TxHash, TxKind, B128, B256, U256,
77};
78use futures_util::{ready, Stream};
79use reth_eth_wire_types::HandleMempoolData;
80use reth_ethereum_primitives::{PooledTransactionVariant, TransactionSigned};
81use reth_execution_types::ChangedAccount;
82use reth_primitives_traits::{Block, InMemorySize, Recovered, SealedBlock, SignedTransaction};
83use serde::{Deserialize, Serialize};
84use std::{
85    fmt,
86    fmt::Debug,
87    future::Future,
88    pin::Pin,
89    sync::Arc,
90    task::{Context, Poll},
91};
92use tokio::sync::mpsc::Receiver;
93
94/// The `PeerId` type.
95pub type PeerId = alloy_primitives::B512;
96
97/// Helper type alias to access [`PoolTransaction`] for a given [`TransactionPool`].
98pub type PoolTx<P> = <P as TransactionPool>::Transaction;
99/// Helper type alias to access [`PoolTransaction::Consensus`] for a given [`TransactionPool`].
100pub type PoolConsensusTx<P> = <<P as TransactionPool>::Transaction as PoolTransaction>::Consensus;
101
102/// Helper type alias to access [`PoolTransaction::Pooled`] for a given [`TransactionPool`].
103pub type PoolPooledTx<P> = <<P as TransactionPool>::Transaction as PoolTransaction>::Pooled;
104
105/// General purpose abstraction of a transaction-pool.
106///
107/// This is intended to be used by API-consumers such as RPC that need inject new incoming,
108/// unverified transactions. And by block production that needs to get transactions to execute in a
109/// new block.
110///
111/// Note: This requires `Clone` for convenience, since it is assumed that this will be implemented
112/// for a wrapped `Arc` type, see also [`Pool`](crate::Pool).
113#[auto_impl::auto_impl(&, Arc)]
114pub trait TransactionPool: Clone + Debug + Send + Sync {
115    /// The transaction type of the pool
116    type Transaction: EthPoolTransaction;
117
118    /// Returns stats about the pool and all sub-pools.
119    fn pool_size(&self) -> PoolSize;
120
121    /// Returns the block the pool is currently tracking.
122    ///
123    /// This tracks the block that the pool has last seen.
124    fn block_info(&self) -> BlockInfo;
125
126    /// Imports an _external_ transaction.
127    ///
128    /// This is intended to be used by the network to insert incoming transactions received over the
129    /// p2p network.
130    ///
131    /// Consumer: P2P
132    fn add_external_transaction(
133        &self,
134        transaction: Self::Transaction,
135    ) -> impl Future<Output = PoolResult<AddedTransactionOutcome>> + Send {
136        self.add_transaction(TransactionOrigin::External, transaction)
137    }
138
139    /// Imports all _external_ transactions
140    ///
141    /// Consumer: Utility
142    fn add_external_transactions(
143        &self,
144        transactions: Vec<Self::Transaction>,
145    ) -> impl Future<Output = Vec<PoolResult<AddedTransactionOutcome>>> + Send {
146        self.add_transactions(TransactionOrigin::External, transactions)
147    }
148
149    /// Adds an _unvalidated_ transaction into the pool and subscribe to state changes.
150    ///
151    /// This is the same as [`TransactionPool::add_transaction`] but returns an event stream for the
152    /// given transaction.
153    ///
154    /// Consumer: Custom
155    fn add_transaction_and_subscribe(
156        &self,
157        origin: TransactionOrigin,
158        transaction: Self::Transaction,
159    ) -> impl Future<Output = PoolResult<TransactionEvents>> + Send;
160
161    /// Adds an _unvalidated_ transaction into the pool.
162    ///
163    /// Consumer: RPC
164    fn add_transaction(
165        &self,
166        origin: TransactionOrigin,
167        transaction: Self::Transaction,
168    ) -> impl Future<Output = PoolResult<AddedTransactionOutcome>> + Send;
169
170    /// Adds the given _unvalidated_ transactions into the pool.
171    ///
172    /// All transactions will use the same `origin`.
173    ///
174    /// Returns a list of results.
175    ///
176    /// Consumer: RPC
177    fn add_transactions(
178        &self,
179        origin: TransactionOrigin,
180        transactions: Vec<Self::Transaction>,
181    ) -> impl Future<Output = Vec<PoolResult<AddedTransactionOutcome>>> + Send;
182
183    /// Adds the given _unvalidated_ transactions into the pool.
184    ///
185    /// Each transaction is paired with its own [`TransactionOrigin`].
186    ///
187    /// Returns a list of results.
188    ///
189    /// Consumer: RPC
190    fn add_transactions_with_origins(
191        &self,
192        transactions: Vec<(TransactionOrigin, Self::Transaction)>,
193    ) -> impl Future<Output = Vec<PoolResult<AddedTransactionOutcome>>> + Send;
194
195    /// Submit a consensus transaction directly to the pool
196    fn add_consensus_transaction(
197        &self,
198        tx: Recovered<<Self::Transaction as PoolTransaction>::Consensus>,
199        origin: TransactionOrigin,
200    ) -> impl Future<Output = PoolResult<AddedTransactionOutcome>> + Send {
201        async move {
202            let tx_hash = *tx.tx_hash();
203
204            let pool_transaction = match Self::Transaction::try_from_consensus(tx) {
205                Ok(tx) => tx,
206                Err(e) => return Err(PoolError::other(tx_hash, e.to_string())),
207            };
208
209            self.add_transaction(origin, pool_transaction).await
210        }
211    }
212
213    /// Submit a consensus transaction and subscribe to event stream
214    fn add_consensus_transaction_and_subscribe(
215        &self,
216        tx: Recovered<<Self::Transaction as PoolTransaction>::Consensus>,
217        origin: TransactionOrigin,
218    ) -> impl Future<Output = PoolResult<TransactionEvents>> + Send {
219        async move {
220            let tx_hash = *tx.tx_hash();
221
222            let pool_transaction = match Self::Transaction::try_from_consensus(tx) {
223                Ok(tx) => tx,
224                Err(e) => return Err(PoolError::other(tx_hash, e.to_string())),
225            };
226
227            self.add_transaction_and_subscribe(origin, pool_transaction).await
228        }
229    }
230
231    /// Returns a new transaction change event stream for the given transaction.
232    ///
233    /// Returns `None` if the transaction is not in the pool.
234    fn transaction_event_listener(&self, tx_hash: TxHash) -> Option<TransactionEvents>;
235
236    /// Returns a new transaction change event stream for _all_ transactions in the pool.
237    fn all_transactions_event_listener(&self) -> AllTransactionsEvents<Self::Transaction>;
238
239    /// Returns a new Stream that yields transactions hashes for new __pending__ transactions
240    /// inserted into the pool that are allowed to be propagated.
241    ///
242    /// Note: This is intended for networking and will __only__ yield transactions that are allowed
243    /// to be propagated over the network, see also [`TransactionListenerKind`].
244    ///
245    /// Consumer: RPC/P2P
246    fn pending_transactions_listener(&self) -> Receiver<TxHash> {
247        self.pending_transactions_listener_for(TransactionListenerKind::PropagateOnly)
248    }
249
250    /// Returns a new [Receiver] that yields transactions hashes for new __pending__ transactions
251    /// inserted into the pending pool depending on the given [`TransactionListenerKind`] argument.
252    fn pending_transactions_listener_for(&self, kind: TransactionListenerKind) -> Receiver<TxHash>;
253
254    /// Returns a new stream that yields new valid transactions added to the pool.
255    fn new_transactions_listener(&self) -> Receiver<NewTransactionEvent<Self::Transaction>> {
256        self.new_transactions_listener_for(TransactionListenerKind::PropagateOnly)
257    }
258
259    /// Returns a new [Receiver] that yields blob "sidecars" (blobs w/ assoc. kzg
260    /// commitments/proofs) for eip-4844 transactions inserted into the pool
261    fn blob_transaction_sidecars_listener(&self) -> Receiver<NewBlobSidecar>;
262
263    /// Returns a new stream that yields new valid transactions added to the pool
264    /// depending on the given [`TransactionListenerKind`] argument.
265    fn new_transactions_listener_for(
266        &self,
267        kind: TransactionListenerKind,
268    ) -> Receiver<NewTransactionEvent<Self::Transaction>>;
269
270    /// Returns a new Stream that yields new transactions added to the pending sub-pool.
271    ///
272    /// This is a convenience wrapper around [`Self::new_transactions_listener`] that filters for
273    /// [`SubPool::Pending`](crate::SubPool).
274    fn new_pending_pool_transactions_listener(
275        &self,
276    ) -> NewSubpoolTransactionStream<Self::Transaction> {
277        NewSubpoolTransactionStream::new(
278            self.new_transactions_listener_for(TransactionListenerKind::PropagateOnly),
279            SubPool::Pending,
280        )
281    }
282
283    /// Returns a new Stream that yields new transactions added to the basefee sub-pool.
284    ///
285    /// This is a convenience wrapper around [`Self::new_transactions_listener`] that filters for
286    /// [`SubPool::BaseFee`](crate::SubPool).
287    fn new_basefee_pool_transactions_listener(
288        &self,
289    ) -> NewSubpoolTransactionStream<Self::Transaction> {
290        NewSubpoolTransactionStream::new(self.new_transactions_listener(), SubPool::BaseFee)
291    }
292
293    /// Returns a new Stream that yields new transactions added to the queued-pool.
294    ///
295    /// This is a convenience wrapper around [`Self::new_transactions_listener`] that filters for
296    /// [`SubPool::Queued`](crate::SubPool).
297    fn new_queued_transactions_listener(&self) -> NewSubpoolTransactionStream<Self::Transaction> {
298        NewSubpoolTransactionStream::new(self.new_transactions_listener(), SubPool::Queued)
299    }
300
301    /// Returns a new Stream that yields new transactions added to the blob sub-pool.
302    ///
303    /// This is a convenience wrapper around [`Self::new_transactions_listener`] that filters for
304    /// [`SubPool::Blob`](crate::SubPool).
305    fn new_blob_pool_transactions_listener(
306        &self,
307    ) -> NewSubpoolTransactionStream<Self::Transaction> {
308        NewSubpoolTransactionStream::new(self.new_transactions_listener(), SubPool::Blob)
309    }
310
311    /// Returns the _hashes_ of all transactions in the pool that are allowed to be propagated.
312    ///
313    /// This excludes hashes that aren't allowed to be propagated.
314    ///
315    /// Note: This returns a `Vec` but should guarantee that all hashes are unique.
316    ///
317    /// Consumer: P2P
318    fn pooled_transaction_hashes(&self) -> Vec<TxHash>;
319
320    /// Returns only the first `max` hashes of transactions in the pool.
321    ///
322    /// Consumer: P2P
323    fn pooled_transaction_hashes_max(&self, max: usize) -> Vec<TxHash>;
324
325    /// Returns the _full_ transaction objects all transactions in the pool that are allowed to be
326    /// propagated.
327    ///
328    /// This is intended to be used by the network for the initial exchange of pooled transaction
329    /// _hashes_
330    ///
331    /// Note: This returns a `Vec` but should guarantee that all transactions are unique.
332    ///
333    /// Caution: In case of blob transactions, this does not include the sidecar.
334    ///
335    /// Consumer: P2P
336    fn pooled_transactions(&self) -> Vec<Arc<ValidPoolTransaction<Self::Transaction>>>;
337
338    /// Returns only the first `max` transactions in the pool.
339    ///
340    /// Consumer: P2P
341    fn pooled_transactions_max(
342        &self,
343        max: usize,
344    ) -> Vec<Arc<ValidPoolTransaction<Self::Transaction>>>;
345
346    /// Returns converted [`PooledTransactionVariant`] for the given transaction hashes that are
347    /// allowed to be propagated.
348    ///
349    /// This adheres to the expected behavior of
350    /// [`GetPooledTransactions`](https://github.com/ethereum/devp2p/blob/master/caps/eth.md#getpooledtransactions-0x09):
351    ///
352    /// The transactions must be in same order as in the request, but it is OK to skip transactions
353    /// which are not available.
354    ///
355    /// If the transaction is a blob transaction, the sidecar will be included.
356    ///
357    /// Consumer: P2P
358    fn get_pooled_transaction_elements(
359        &self,
360        tx_hashes: Vec<TxHash>,
361        limit: GetPooledTransactionLimit,
362    ) -> Vec<<Self::Transaction as PoolTransaction>::Pooled>;
363
364    /// Extends the given vector with pooled transactions for the given hashes that are allowed to
365    /// be propagated.
366    ///
367    /// This adheres to the expected behavior of [`Self::get_pooled_transaction_elements`].
368    ///
369    /// Consumer: P2P
370    fn append_pooled_transaction_elements(
371        &self,
372        tx_hashes: &[TxHash],
373        limit: GetPooledTransactionLimit,
374        out: &mut Vec<<Self::Transaction as PoolTransaction>::Pooled>,
375    ) {
376        out.extend(self.get_pooled_transaction_elements(tx_hashes.to_vec(), limit));
377    }
378
379    /// Returns the pooled transaction variant for the given transaction hash.
380    ///
381    /// This adheres to the expected behavior of
382    /// [`GetPooledTransactions`](https://github.com/ethereum/devp2p/blob/master/caps/eth.md#getpooledtransactions-0x09):
383    ///
384    /// If the transaction is a blob transaction, the sidecar will be included.
385    ///
386    /// It is expected that this variant represents the valid p2p format for full transactions.
387    /// E.g. for EIP-4844 transactions this is the consensus transaction format with the blob
388    /// sidecar.
389    ///
390    /// Consumer: P2P
391    fn get_pooled_transaction_element(
392        &self,
393        tx_hash: TxHash,
394    ) -> Option<Recovered<<Self::Transaction as PoolTransaction>::Pooled>>;
395
396    /// Returns an iterator that yields transactions that are ready for block production.
397    ///
398    /// Consumer: Block production
399    fn best_transactions(
400        &self,
401    ) -> Box<dyn BestTransactions<Item = Arc<ValidPoolTransaction<Self::Transaction>>>>;
402
403    /// Returns an iterator that yields transactions that are ready for block production with the
404    /// given base fee and optional blob fee attributes.
405    ///
406    /// Consumer: Block production
407    fn best_transactions_with_attributes(
408        &self,
409        best_transactions_attributes: BestTransactionsAttributes,
410    ) -> Box<dyn BestTransactions<Item = Arc<ValidPoolTransaction<Self::Transaction>>>>;
411
412    /// Returns all transactions that can be included in the next block.
413    ///
414    /// This is primarily used for the `txpool_` RPC namespace:
415    /// <https://geth.ethereum.org/docs/interacting-with-geth/rpc/ns-txpool> which distinguishes
416    /// between `pending` and `queued` transactions, where `pending` are transactions ready for
417    /// inclusion in the next block and `queued` are transactions that are ready for inclusion in
418    /// future blocks.
419    ///
420    /// Consumer: RPC
421    fn pending_transactions(&self) -> Vec<Arc<ValidPoolTransaction<Self::Transaction>>>;
422
423    /// Returns a pending transaction if it exists and is ready for immediate execution
424    /// (i.e., has the lowest nonce among the sender's pending transactions).
425    fn get_pending_transaction_by_sender_and_nonce(
426        &self,
427        sender: Address,
428        nonce: u64,
429    ) -> Option<Arc<ValidPoolTransaction<Self::Transaction>>> {
430        self.best_transactions().find(|tx| tx.sender() == sender && tx.nonce() == nonce)
431    }
432
433    /// Returns first `max` transactions that can be included in the next block.
434    /// See <https://github.com/paradigmxyz/reth/issues/12767#issuecomment-2493223579>
435    ///
436    /// Consumer: Block production
437    fn pending_transactions_max(
438        &self,
439        max: usize,
440    ) -> Vec<Arc<ValidPoolTransaction<Self::Transaction>>>;
441
442    /// Returns all transactions that can be included in _future_ blocks.
443    ///
444    /// This and [`Self::pending_transactions`] are mutually exclusive.
445    ///
446    /// Consumer: RPC
447    fn queued_transactions(&self) -> Vec<Arc<ValidPoolTransaction<Self::Transaction>>>;
448
449    /// Returns the number of transactions that are ready for inclusion in the next block and the
450    /// number of transactions that are ready for inclusion in future blocks: `(pending, queued)`.
451    fn pending_and_queued_txn_count(&self) -> (usize, usize);
452
453    /// Returns all transactions that are currently in the pool grouped by whether they are ready
454    /// for inclusion in the next block or not.
455    ///
456    /// This is primarily used for the `txpool_` namespace: <https://geth.ethereum.org/docs/interacting-with-geth/rpc/ns-txpool>
457    ///
458    /// Consumer: RPC
459    fn all_transactions(&self) -> AllPoolTransactions<Self::Transaction>;
460
461    /// Returns the _hashes_ of all transactions regardless of whether they can be propagated or
462    /// not.
463    ///
464    /// Unlike [`Self::pooled_transaction_hashes`] this doesn't consider whether the transaction can
465    /// be propagated or not.
466    ///
467    /// Note: This returns a `Vec` but should guarantee that all hashes are unique.
468    ///
469    /// Consumer: Utility
470    fn all_transaction_hashes(&self) -> Vec<TxHash>;
471
472    /// Removes a single transaction corresponding to the given hash.
473    ///
474    /// Note: This removes the transaction as if it got discarded (_not_ mined).
475    ///
476    /// Returns the removed transaction if it was found in the pool.
477    ///
478    /// Consumer: Utility
479    fn remove_transaction(
480        &self,
481        hash: TxHash,
482    ) -> Option<Arc<ValidPoolTransaction<Self::Transaction>>> {
483        self.remove_transactions(vec![hash]).pop()
484    }
485
486    /// Removes all transactions corresponding to the given hashes.
487    ///
488    /// Note: This removes the transactions as if they got discarded (_not_ mined).
489    ///
490    /// Consumer: Utility
491    fn remove_transactions(
492        &self,
493        hashes: Vec<TxHash>,
494    ) -> Vec<Arc<ValidPoolTransaction<Self::Transaction>>>;
495
496    /// Removes all transactions corresponding to the given hashes.
497    ///
498    /// Also removes all _dependent_ transactions.
499    ///
500    /// Consumer: Utility
501    fn remove_transactions_and_descendants(
502        &self,
503        hashes: Vec<TxHash>,
504    ) -> Vec<Arc<ValidPoolTransaction<Self::Transaction>>>;
505
506    /// Removes all transactions from the given sender
507    ///
508    /// Consumer: Utility
509    fn remove_transactions_by_sender(
510        &self,
511        sender: Address,
512    ) -> Vec<Arc<ValidPoolTransaction<Self::Transaction>>>;
513
514    /// Prunes a single transaction from the pool.
515    ///
516    /// This is similar to [`Self::remove_transaction`] but treats the transaction as _mined_
517    /// rather than discarded. The key difference is that pruning does **not** park descendant
518    /// transactions: their nonce requirements are considered satisfied, so they remain in whatever
519    /// sub-pool they currently occupy and can be included in the next block.
520    ///
521    /// In contrast, [`Self::remove_transaction`] treats the removal as a discard, which
522    /// introduces a nonce gap and moves all descendant transactions to the queued (parked)
523    /// sub-pool.
524    ///
525    /// Returns the pruned transaction if it existed in the pool.
526    ///
527    /// Consumer: Utility
528    fn prune_transaction(
529        &self,
530        hash: TxHash,
531    ) -> Option<Arc<ValidPoolTransaction<Self::Transaction>>> {
532        self.prune_transactions(vec![hash]).pop()
533    }
534
535    /// Prunes all transactions corresponding to the given hashes from the pool.
536    ///
537    /// This behaves like [`Self::prune_transaction`] but for multiple transactions at once.
538    /// Each transaction is removed as if it was mined: descendant transactions are **not** parked
539    /// and their nonce requirements are considered satisfied.
540    ///
541    /// This is useful for scenarios like Flashblocks where transactions are committed across
542    /// multiple partial blocks without a canonical state update: previously committed transactions
543    /// can be pruned so that the best-transactions iterator yields their descendants in the
544    /// correct priority order.
545    ///
546    /// Consumer: Utility
547    fn prune_transactions(
548        &self,
549        hashes: Vec<TxHash>,
550    ) -> Vec<Arc<ValidPoolTransaction<Self::Transaction>>>;
551
552    /// Retains only those hashes that are unknown to the pool.
553    ///
554    /// In other words, removes all transactions from the given set that are currently present in
555    /// the pool.
556    ///
557    /// Consumer: P2P
558    fn retain_unknown<A>(&self, announcement: &mut A)
559    where
560        A: HandleMempoolData;
561
562    /// Retains only those hashes that are known to the pool.
563    ///
564    /// In other words, removes all transactions from the given set that are not currently present
565    /// in the pool.
566    ///
567    /// Consumer: P2P
568    fn retain_contains<A>(&self, announcement: &mut A)
569    where
570        A: HandleMempoolData;
571
572    /// Returns if the transaction for the given hash is already included in this pool.
573    fn contains(&self, tx_hash: &TxHash) -> bool {
574        self.get(tx_hash).is_some()
575    }
576
577    /// Returns the transaction for the given hash.
578    fn get(&self, tx_hash: &TxHash) -> Option<Arc<ValidPoolTransaction<Self::Transaction>>>;
579
580    /// Returns all transaction objects for the given hashes.
581    ///
582    /// Caution: In case of blob transactions, this does not include the sidecar.
583    fn get_all(&self, txs: Vec<TxHash>) -> Vec<Arc<ValidPoolTransaction<Self::Transaction>>>;
584
585    /// Notify the pool about transactions that are propagated to peers.
586    ///
587    /// Consumer: P2P
588    fn on_propagated(&self, txs: PropagatedTransactions);
589
590    /// Returns all transactions sent by a given user
591    fn get_transactions_by_sender(
592        &self,
593        sender: Address,
594    ) -> Vec<Arc<ValidPoolTransaction<Self::Transaction>>>;
595
596    /// Returns all pending transactions filtered by predicate
597    fn get_pending_transactions_with_predicate(
598        &self,
599        predicate: impl FnMut(&ValidPoolTransaction<Self::Transaction>) -> bool,
600    ) -> Vec<Arc<ValidPoolTransaction<Self::Transaction>>>;
601
602    /// Returns all pending transactions sent by a given user
603    fn get_pending_transactions_by_sender(
604        &self,
605        sender: Address,
606    ) -> Vec<Arc<ValidPoolTransaction<Self::Transaction>>>;
607
608    /// Returns all queued transactions sent by a given user
609    fn get_queued_transactions_by_sender(
610        &self,
611        sender: Address,
612    ) -> Vec<Arc<ValidPoolTransaction<Self::Transaction>>>;
613
614    /// Returns the highest transaction sent by a given user
615    fn get_highest_transaction_by_sender(
616        &self,
617        sender: Address,
618    ) -> Option<Arc<ValidPoolTransaction<Self::Transaction>>>;
619
620    /// Returns the transaction with the highest nonce that is executable given the on chain nonce.
621    /// In other words the highest non nonce gapped transaction.
622    ///
623    /// Note: The next pending pooled transaction must have the on chain nonce.
624    ///
625    /// For example, for a given on chain nonce of `5`, the next transaction must have that nonce.
626    /// If the pool contains txs `[5,6,7]` this returns tx `7`.
627    /// If the pool contains txs `[6,7]` this returns `None` because the next valid nonce (5) is
628    /// missing, which means txs `[6,7]` are nonce gapped.
629    fn get_highest_consecutive_transaction_by_sender(
630        &self,
631        sender: Address,
632        on_chain_nonce: u64,
633    ) -> Option<Arc<ValidPoolTransaction<Self::Transaction>>>;
634
635    /// Returns a transaction sent by a given user and a nonce
636    fn get_transaction_by_sender_and_nonce(
637        &self,
638        sender: Address,
639        nonce: u64,
640    ) -> Option<Arc<ValidPoolTransaction<Self::Transaction>>>;
641
642    /// Returns all transactions that where submitted with the given [`TransactionOrigin`]
643    fn get_transactions_by_origin(
644        &self,
645        origin: TransactionOrigin,
646    ) -> Vec<Arc<ValidPoolTransaction<Self::Transaction>>>;
647
648    /// Returns all pending transactions filtered by [`TransactionOrigin`]
649    fn get_pending_transactions_by_origin(
650        &self,
651        origin: TransactionOrigin,
652    ) -> Vec<Arc<ValidPoolTransaction<Self::Transaction>>>;
653
654    /// Returns all transactions that where submitted as [`TransactionOrigin::Local`]
655    fn get_local_transactions(&self) -> Vec<Arc<ValidPoolTransaction<Self::Transaction>>> {
656        self.get_transactions_by_origin(TransactionOrigin::Local)
657    }
658
659    /// Returns all transactions that where submitted as [`TransactionOrigin::Private`]
660    fn get_private_transactions(&self) -> Vec<Arc<ValidPoolTransaction<Self::Transaction>>> {
661        self.get_transactions_by_origin(TransactionOrigin::Private)
662    }
663
664    /// Returns all transactions that where submitted as [`TransactionOrigin::External`]
665    fn get_external_transactions(&self) -> Vec<Arc<ValidPoolTransaction<Self::Transaction>>> {
666        self.get_transactions_by_origin(TransactionOrigin::External)
667    }
668
669    /// Returns all pending transactions that where submitted as [`TransactionOrigin::Local`]
670    fn get_local_pending_transactions(&self) -> Vec<Arc<ValidPoolTransaction<Self::Transaction>>> {
671        self.get_pending_transactions_by_origin(TransactionOrigin::Local)
672    }
673
674    /// Returns all pending transactions that where submitted as [`TransactionOrigin::Private`]
675    fn get_private_pending_transactions(
676        &self,
677    ) -> Vec<Arc<ValidPoolTransaction<Self::Transaction>>> {
678        self.get_pending_transactions_by_origin(TransactionOrigin::Private)
679    }
680
681    /// Returns all pending transactions that where submitted as [`TransactionOrigin::External`]
682    fn get_external_pending_transactions(
683        &self,
684    ) -> Vec<Arc<ValidPoolTransaction<Self::Transaction>>> {
685        self.get_pending_transactions_by_origin(TransactionOrigin::External)
686    }
687
688    /// Returns a set of all senders of transactions in the pool
689    fn unique_senders(&self) -> AddressSet;
690
691    /// Returns the [`BlobTransactionSidecarVariant`] for the given transaction hash if it exists in
692    /// the blob store.
693    fn get_blob(
694        &self,
695        tx_hash: TxHash,
696    ) -> Result<Option<Arc<BlobTransactionSidecarVariant>>, BlobStoreError>;
697
698    /// Returns all [`BlobTransactionSidecarVariant`] for the given transaction hashes if they
699    /// exists in the blob store.
700    ///
701    /// This only returns the blobs that were found in the store.
702    /// If there's no blob it will not be returned.
703    fn get_all_blobs(
704        &self,
705        tx_hashes: Vec<TxHash>,
706    ) -> Result<Vec<(TxHash, Arc<BlobTransactionSidecarVariant>)>, BlobStoreError>;
707
708    /// Returns the exact [`BlobTransactionSidecarVariant`] for the given transaction hashes in the
709    /// order they were requested.
710    ///
711    /// Returns an error if any of the blobs are not found in the blob store.
712    fn get_all_blobs_exact(
713        &self,
714        tx_hashes: Vec<TxHash>,
715    ) -> Result<Vec<Arc<BlobTransactionSidecarVariant>>, BlobStoreError>;
716
717    /// Return the [`BlobAndProofV1`]s for a list of blob versioned hashes.
718    fn get_blobs_for_versioned_hashes_v1(
719        &self,
720        versioned_hashes: &[B256],
721    ) -> Result<Vec<Option<BlobAndProofV1>>, BlobStoreError>;
722
723    /// Return the [`BlobAndProofV2`]s for a list of blob versioned hashes.
724    /// Blobs and proofs are returned only if they are present for _all_ of the requested versioned
725    /// hashes.
726    fn get_blobs_for_versioned_hashes_v2(
727        &self,
728        versioned_hashes: &[B256],
729    ) -> Result<Option<Vec<BlobAndProofV2>>, BlobStoreError>;
730
731    /// Return the [`BlobAndProofV2`]s for a list of blob versioned hashes.
732    ///
733    /// The response is always the same length as the request. Missing or older-version blobs are
734    /// returned as `None` elements.
735    fn get_blobs_for_versioned_hashes_v3(
736        &self,
737        versioned_hashes: &[B256],
738    ) -> Result<Vec<Option<BlobAndProofV2>>, BlobStoreError>;
739
740    /// Return the [`BlobCellsAndProofsV1`]s for a list of blob versioned hashes and requested cell
741    /// indices.
742    ///
743    /// The response is always the same length as the request. Missing or older-version blobs are
744    /// returned as `None` elements.
745    fn get_blobs_for_versioned_hashes_v4(
746        &self,
747        versioned_hashes: &[B256],
748        indices_bitarray: B128,
749    ) -> Result<Vec<Option<BlobCellsAndProofsV1>>, BlobStoreError>;
750
751    /// Returns the blob store used by the pool.
752    fn blob_store(&self) -> Box<dyn BlobStore>;
753}
754
755/// Extension for [`TransactionPool`] trait that allows to set the current block info.
756#[auto_impl::auto_impl(&, Arc)]
757pub trait TransactionPoolExt: TransactionPool {
758    /// The block type used for chain tip updates.
759    type Block: Block;
760
761    /// Sets the current block info for the pool.
762    fn set_block_info(&self, info: BlockInfo);
763
764    /// Event listener for when the pool needs to be updated.
765    ///
766    /// Implementers need to update the pool accordingly:
767    ///
768    /// ## Fee changes
769    ///
770    /// The [`CanonicalStateUpdate`] includes the base and blob fee of the pending block, which
771    /// affects the dynamic fee requirement of pending transactions in the pool.
772    ///
773    /// ## EIP-4844 Blob transactions
774    ///
775    /// Mined blob transactions need to be removed from the pool, but from the pool only. The blob
776    /// sidecar must not be removed from the blob store. Only after a blob transaction is
777    /// finalized, its sidecar is removed from the blob store. This ensures that in case of a reorg,
778    /// the sidecar is still available.
779    fn on_canonical_state_change(&self, update: CanonicalStateUpdate<'_, Self::Block>);
780
781    /// Updates the accounts in the pool
782    fn update_accounts(&self, accounts: Vec<ChangedAccount>);
783
784    /// Deletes the blob sidecar for the given transaction from the blob store
785    fn delete_blob(&self, tx: B256);
786
787    /// Deletes multiple blob sidecars from the blob store
788    fn delete_blobs(&self, txs: Vec<B256>);
789
790    /// Maintenance function to cleanup blobs that are no longer needed.
791    fn cleanup_blobs(&self);
792}
793
794/// A Helper type that bundles all transactions in the pool.
795#[derive(Debug, Clone)]
796pub struct AllPoolTransactions<T: PoolTransaction> {
797    /// Transactions that are ready for inclusion in the next block.
798    pub pending: Vec<Arc<ValidPoolTransaction<T>>>,
799    /// Transactions that are ready for inclusion in _future_ blocks, but are currently parked,
800    /// because they depend on other transactions that are not yet included in the pool (nonce gap)
801    /// or otherwise blocked.
802    pub queued: Vec<Arc<ValidPoolTransaction<T>>>,
803}
804
805// === impl AllPoolTransactions ===
806
807impl<T: PoolTransaction> AllPoolTransactions<T> {
808    /// Returns the combined number of all transactions.
809    pub const fn count(&self) -> usize {
810        self.pending.len() + self.queued.len()
811    }
812
813    /// Returns an iterator over all pending and queued transactions.
814    pub fn iter(&self) -> impl Iterator<Item = &Arc<ValidPoolTransaction<T>>> + '_ {
815        self.pending.iter().chain(self.queued.iter())
816    }
817
818    /// Returns an iterator over all pending [`Recovered`] transactions.
819    pub fn pending_recovered(&self) -> impl Iterator<Item = Recovered<T::Consensus>> + '_ {
820        self.pending.iter().map(|tx| tx.to_consensus())
821    }
822
823    /// Returns an iterator over all queued [`Recovered`] transactions.
824    pub fn queued_recovered(&self) -> impl Iterator<Item = Recovered<T::Consensus>> + '_ {
825        self.queued.iter().map(|tx| tx.to_consensus())
826    }
827
828    /// Returns an iterator over all transactions, both pending and queued.
829    pub fn all(&self) -> impl Iterator<Item = Recovered<T::Consensus>> + '_ {
830        self.pending.iter().chain(self.queued.iter()).map(|tx| tx.to_consensus())
831    }
832}
833
834impl<T: PoolTransaction> Default for AllPoolTransactions<T> {
835    fn default() -> Self {
836        Self { pending: Default::default(), queued: Default::default() }
837    }
838}
839
840impl<T: PoolTransaction> IntoIterator for AllPoolTransactions<T> {
841    type Item = Arc<ValidPoolTransaction<T>>;
842    type IntoIter = std::iter::Chain<
843        std::vec::IntoIter<Arc<ValidPoolTransaction<T>>>,
844        std::vec::IntoIter<Arc<ValidPoolTransaction<T>>>,
845    >;
846
847    fn into_iter(self) -> Self::IntoIter {
848        self.pending.into_iter().chain(self.queued)
849    }
850}
851
852/// Represents transactions that were propagated over the network.
853#[derive(Debug, Clone, Eq, PartialEq, Default)]
854pub struct PropagatedTransactions(pub B256Map<Vec<PropagateKind>>);
855
856impl PropagatedTransactions {
857    /// Records a propagation of a transaction to a peer.
858    pub fn record(&mut self, hash: TxHash, kind: PropagateKind) {
859        self.0.entry(hash).or_default().push(kind);
860    }
861
862    /// Returns the number of distinct transactions that were propagated.
863    pub fn len(&self) -> usize {
864        self.0.len()
865    }
866
867    /// Returns true if no transactions were propagated.
868    pub fn is_empty(&self) -> bool {
869        self.0.is_empty()
870    }
871
872    /// Returns the propagation info for a specific transaction.
873    pub fn get(&self, hash: &TxHash) -> Option<&[PropagateKind]> {
874        self.0.get(hash).map(Vec::as_slice)
875    }
876}
877
878impl IntoIterator for PropagatedTransactions {
879    type Item = (TxHash, Vec<PropagateKind>);
880    type IntoIter = alloy_primitives::map::hash_map::IntoIter<TxHash, Vec<PropagateKind>>;
881
882    fn into_iter(self) -> Self::IntoIter {
883        self.0.into_iter()
884    }
885}
886
887/// Represents how a transaction was propagated over the network.
888#[derive(Debug, Copy, Clone, Eq, PartialEq)]
889#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
890pub enum PropagateKind {
891    /// The full transaction object was sent to the peer.
892    ///
893    /// This is equivalent to the `Transaction` message
894    Full(PeerId),
895    /// Only the Hash was propagated to the peer.
896    Hash(PeerId),
897}
898
899// === impl PropagateKind ===
900
901impl PropagateKind {
902    /// Returns the peer the transaction was sent to
903    pub const fn peer(&self) -> &PeerId {
904        match self {
905            Self::Full(peer) | Self::Hash(peer) => peer,
906        }
907    }
908
909    /// Returns true if the transaction was sent as a full transaction
910    pub const fn is_full(&self) -> bool {
911        matches!(self, Self::Full(_))
912    }
913
914    /// Returns true if the transaction was sent as a hash
915    pub const fn is_hash(&self) -> bool {
916        matches!(self, Self::Hash(_))
917    }
918}
919
920impl From<PropagateKind> for PeerId {
921    fn from(value: PropagateKind) -> Self {
922        match value {
923            PropagateKind::Full(peer) | PropagateKind::Hash(peer) => peer,
924        }
925    }
926}
927
928/// This type represents a new blob sidecar that has been stored in the transaction pool's
929/// blobstore; it includes the `TransactionHash` of the blob transaction along with the assoc.
930/// sidecar (blobs, commitments, proofs)
931#[derive(Debug, Clone)]
932pub struct NewBlobSidecar {
933    /// hash of the EIP-4844 transaction.
934    pub tx_hash: TxHash,
935    /// the blob transaction sidecar.
936    pub sidecar: Arc<BlobTransactionSidecarVariant>,
937}
938
939/// Where the transaction originates from.
940///
941/// Depending on where the transaction was picked up, it affects how the transaction is handled
942/// internally, e.g. limits for simultaneous transaction of one sender.
943#[derive(Debug, Copy, Clone, PartialEq, Eq, Default, Deserialize, Serialize)]
944pub enum TransactionOrigin {
945    /// Transaction is coming from a local source.
946    #[default]
947    Local,
948    /// Transaction has been received externally.
949    ///
950    /// This is usually considered an "untrusted" source, for example received from another in the
951    /// network.
952    External,
953    /// Transaction is originated locally and is intended to remain private.
954    ///
955    /// This type of transaction should not be propagated to the network. It's meant for
956    /// private usage within the local node only.
957    Private,
958}
959
960// === impl TransactionOrigin ===
961
962impl TransactionOrigin {
963    /// Whether the transaction originates from a local source.
964    pub const fn is_local(&self) -> bool {
965        matches!(self, Self::Local)
966    }
967
968    /// Whether the transaction originates from an external source.
969    pub const fn is_external(&self) -> bool {
970        matches!(self, Self::External)
971    }
972    /// Whether the transaction originates from a private source.
973    pub const fn is_private(&self) -> bool {
974        matches!(self, Self::Private)
975    }
976}
977
978/// Represents the kind of update to the canonical state.
979#[derive(Debug, Clone, Copy, PartialEq, Eq)]
980pub enum PoolUpdateKind {
981    /// The update was due to a block commit.
982    Commit,
983    /// The update was due to a reorganization.
984    Reorg,
985}
986
987/// Represents changes after a new canonical block or range of canonical blocks was added to the
988/// chain.
989///
990/// It is expected that this is only used if the added blocks are canonical to the pool's last known
991/// block hash. In other words, the first added block of the range must be the child of the last
992/// known block hash.
993///
994/// This is used to update the pool state accordingly.
995#[derive(Clone, Debug)]
996pub struct CanonicalStateUpdate<'a, B: Block> {
997    /// Hash of the tip block.
998    pub new_tip: &'a SealedBlock<B>,
999    /// EIP-1559 Base fee of the _next_ (pending) block
1000    ///
1001    /// The base fee of a block depends on the utilization of the last block and its base fee.
1002    pub pending_block_base_fee: u64,
1003    /// EIP-4844 blob fee of the _next_ (pending) block
1004    ///
1005    /// Only after Cancun
1006    pub pending_block_blob_fee: Option<u128>,
1007    /// A set of changed accounts across a range of blocks.
1008    pub changed_accounts: Vec<ChangedAccount>,
1009    /// All mined transactions in the block range.
1010    pub mined_transactions: Vec<B256>,
1011    /// The kind of update to the canonical state.
1012    pub update_kind: PoolUpdateKind,
1013}
1014
1015impl<B> CanonicalStateUpdate<'_, B>
1016where
1017    B: Block,
1018{
1019    /// Returns the number of the tip block.
1020    pub fn number(&self) -> u64 {
1021        self.new_tip.number()
1022    }
1023
1024    /// Returns the hash of the tip block.
1025    pub fn hash(&self) -> B256 {
1026        self.new_tip.hash()
1027    }
1028
1029    /// Timestamp of the latest chain update
1030    pub fn timestamp(&self) -> u64 {
1031        self.new_tip.timestamp()
1032    }
1033
1034    /// Returns the block info for the tip block.
1035    pub fn block_info(&self) -> BlockInfo {
1036        BlockInfo {
1037            block_gas_limit: self.new_tip.gas_limit(),
1038            last_seen_block_hash: self.hash(),
1039            last_seen_block_number: self.number(),
1040            pending_basefee: self.pending_block_base_fee,
1041            pending_blob_fee: self.pending_block_blob_fee,
1042        }
1043    }
1044}
1045
1046impl<B> fmt::Display for CanonicalStateUpdate<'_, B>
1047where
1048    B: Block,
1049{
1050    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1051        f.debug_struct("CanonicalStateUpdate")
1052            .field("hash", &self.hash())
1053            .field("number", &self.number())
1054            .field("pending_block_base_fee", &self.pending_block_base_fee)
1055            .field("pending_block_blob_fee", &self.pending_block_blob_fee)
1056            .field("changed_accounts", &self.changed_accounts.len())
1057            .field("mined_transactions", &self.mined_transactions.len())
1058            .finish()
1059    }
1060}
1061
1062/// Alias to restrict the [`BestTransactions`] items to the pool's transaction type.
1063pub type BestTransactionsFor<Pool> = Box<
1064    dyn BestTransactions<Item = Arc<ValidPoolTransaction<<Pool as TransactionPool>::Transaction>>>,
1065>;
1066
1067/// An `Iterator` that only returns transactions that are ready to be executed.
1068///
1069/// This makes no assumptions about the order of the transactions, but expects that _all_
1070/// transactions are valid (no nonce gaps.) for the tracked state of the pool.
1071///
1072/// Note: this iterator will always return the best transaction that it currently knows.
1073/// There is no guarantee transactions will be returned sequentially in decreasing
1074/// priority order.
1075pub trait BestTransactions: Iterator + Send {
1076    /// Mark the transaction as invalid.
1077    ///
1078    /// Implementers must ensure all subsequent transaction _don't_ depend on this transaction.
1079    /// In other words, this must remove the given transaction _and_ drain all transaction that
1080    /// depend on it.
1081    fn mark_invalid(&mut self, transaction: &Self::Item, kind: InvalidPoolTransactionError);
1082
1083    /// An iterator may be able to receive additional pending transactions that weren't present it
1084    /// the pool when it was created.
1085    ///
1086    /// This ensures that iterator will return the best transaction that it currently knows and not
1087    /// listen to pool updates.
1088    fn no_updates(&mut self);
1089
1090    /// Convenience function for [`Self::no_updates`] that returns the iterator again.
1091    fn without_updates(mut self) -> Self
1092    where
1093        Self: Sized,
1094    {
1095        self.no_updates();
1096        self
1097    }
1098
1099    /// Skip all blob transactions.
1100    ///
1101    /// There's only limited blob space available in a block, once exhausted, EIP-4844 transactions
1102    /// can no longer be included.
1103    ///
1104    /// If called then the iterator will no longer yield blob transactions.
1105    ///
1106    /// Note: this will also exclude any transactions that depend on blob transactions.
1107    fn skip_blobs(&mut self) {
1108        self.set_skip_blobs(true);
1109    }
1110
1111    /// Controls whether the iterator skips blob transactions or not.
1112    ///
1113    /// If set to true, no blob transactions will be returned.
1114    fn set_skip_blobs(&mut self, skip_blobs: bool);
1115
1116    /// Convenience function for [`Self::skip_blobs`] that returns the iterator again.
1117    fn without_blobs(mut self) -> Self
1118    where
1119        Self: Sized,
1120    {
1121        self.skip_blobs();
1122        self
1123    }
1124
1125    /// Creates an iterator which uses a closure to determine whether a transaction should be
1126    /// returned by the iterator.
1127    ///
1128    /// All items the closure returns false for are marked as invalid via [`Self::mark_invalid`] and
1129    /// descendant transactions will be skipped.
1130    fn filter_transactions<P>(self, predicate: P) -> BestTransactionFilter<Self, P>
1131    where
1132        P: FnMut(&Self::Item) -> bool,
1133        Self: Sized,
1134    {
1135        BestTransactionFilter::new(self, predicate)
1136    }
1137}
1138
1139impl<T> BestTransactions for Box<T>
1140where
1141    T: BestTransactions + ?Sized,
1142{
1143    fn mark_invalid(&mut self, transaction: &Self::Item, kind: InvalidPoolTransactionError) {
1144        (**self).mark_invalid(transaction, kind)
1145    }
1146
1147    fn no_updates(&mut self) {
1148        (**self).no_updates();
1149    }
1150
1151    fn skip_blobs(&mut self) {
1152        (**self).skip_blobs();
1153    }
1154
1155    fn set_skip_blobs(&mut self, skip_blobs: bool) {
1156        (**self).set_skip_blobs(skip_blobs);
1157    }
1158}
1159
1160/// A no-op implementation that yields no transactions.
1161impl<T> BestTransactions for std::iter::Empty<T> {
1162    fn mark_invalid(&mut self, _tx: &T, _kind: InvalidPoolTransactionError) {}
1163
1164    fn no_updates(&mut self) {}
1165
1166    fn skip_blobs(&mut self) {}
1167
1168    fn set_skip_blobs(&mut self, _skip_blobs: bool) {}
1169}
1170
1171/// A filter that allows to check if a transaction satisfies a set of conditions
1172pub trait TransactionFilter {
1173    /// The type of the transaction to check.
1174    type Transaction;
1175
1176    /// Returns true if the transaction satisfies the conditions.
1177    fn is_valid(&self, transaction: &Self::Transaction) -> bool;
1178}
1179
1180/// A no-op implementation of [`TransactionFilter`] which
1181/// marks all transactions as valid.
1182#[derive(Debug, Clone)]
1183pub struct NoopTransactionFilter<T>(std::marker::PhantomData<T>);
1184
1185// We can't derive Default because this forces T to be
1186// Default as well, which isn't necessary.
1187impl<T> Default for NoopTransactionFilter<T> {
1188    fn default() -> Self {
1189        Self(std::marker::PhantomData)
1190    }
1191}
1192
1193impl<T> TransactionFilter for NoopTransactionFilter<T> {
1194    type Transaction = T;
1195
1196    fn is_valid(&self, _transaction: &Self::Transaction) -> bool {
1197        true
1198    }
1199}
1200
1201/// A Helper type that bundles the best transactions attributes together.
1202#[derive(Debug, Copy, Clone, PartialEq, Eq)]
1203pub struct BestTransactionsAttributes {
1204    /// The base fee attribute for best transactions.
1205    pub basefee: u64,
1206    /// The blob fee attribute for best transactions.
1207    pub blob_fee: Option<u64>,
1208}
1209
1210// === impl BestTransactionsAttributes ===
1211
1212impl BestTransactionsAttributes {
1213    /// Creates a new `BestTransactionsAttributes` with the given basefee and blob fee.
1214    pub const fn new(basefee: u64, blob_fee: Option<u64>) -> Self {
1215        Self { basefee, blob_fee }
1216    }
1217
1218    /// Creates a new `BestTransactionsAttributes` with the given basefee.
1219    pub const fn base_fee(basefee: u64) -> Self {
1220        Self::new(basefee, None)
1221    }
1222
1223    /// Sets the given blob fee.
1224    pub const fn with_blob_fee(mut self, blob_fee: u64) -> Self {
1225        self.blob_fee = Some(blob_fee);
1226        self
1227    }
1228}
1229
1230/// Trait for transaction types stored in the transaction pool.
1231///
1232/// This trait represents the actual transaction object stored in the mempool, which includes not
1233/// only the transaction data itself but also additional metadata needed for efficient pool
1234/// operations. Implementations typically cache values that are frequently accessed during
1235/// transaction ordering, validation, and eviction.
1236///
1237/// ## Key Responsibilities
1238///
1239/// 1. **Metadata Caching**: Store computed values like address, cost and encoded size
1240/// 2. **Representation Conversion**: Handle conversions between consensus and pooled
1241///    representations
1242/// 3. **Validation Support**: Provide methods for pool-specific validation rules
1243///
1244/// ## Cached Metadata
1245///
1246/// Implementations should cache frequently accessed values to avoid recomputation:
1247/// - **Address**: Recovered sender address of the transaction
1248/// - **Cost**: Max amount spendable (gas × price + value + blob costs)
1249/// - **Size**: RLP encoded length for mempool size limits
1250///
1251/// See [`EthPooledTransaction`] for a reference implementation.
1252///
1253/// ## Transaction Representations
1254///
1255/// This trait abstracts over the different representations a transaction can have:
1256///
1257/// 1. **Consensus representation** (`Consensus` associated type): The canonical form included in
1258///    blocks
1259///    - Compact representation without networking metadata
1260///    - For EIP-4844: includes only blob hashes, not the actual blobs
1261///    - Used for block execution and state transitions
1262///
1263/// 2. **Pooled representation** (`Pooled` associated type): The form used for network propagation
1264///    - May include additional data for validation
1265///    - For EIP-4844: includes full blob sidecars (blobs, commitments, proofs)
1266///    - Used for mempool validation and p2p gossiping
1267///
1268/// ## Why Two Representations?
1269///
1270/// This distinction is necessary because:
1271///
1272/// - **EIP-4844 blob transactions**: Require large blob sidecars for validation that would bloat
1273///   blocks if included. Only blob hashes are stored on-chain.
1274///
1275/// - **Network efficiency**: Blob transactions are not broadcast to all peers automatically but
1276///   must be explicitly requested to reduce bandwidth usage.
1277///
1278/// - **Special transactions**: Some transactions (like OP deposit transactions) exist only in
1279///   consensus format and are never in the mempool.
1280///
1281/// ## Conversion Rules
1282///
1283/// - `Consensus` → `Pooled`: May fail for transactions that cannot be pooled (e.g., OP deposit
1284///   transactions, blob transactions without sidecars)
1285/// - `Pooled` → `Consensus`: Always succeeds (pooled is a superset)
1286pub trait PoolTransaction:
1287    alloy_consensus::Transaction + InMemorySize + Debug + Send + Sync + Clone
1288{
1289    /// Associated error type for the `try_from_consensus` method.
1290    type TryFromConsensusError: fmt::Display;
1291
1292    /// Associated type representing the raw consensus variant of the transaction.
1293    type Consensus: SignedTransaction + From<Self::Pooled>;
1294
1295    /// Associated type representing the recovered pooled variant of the transaction.
1296    type Pooled: TryFrom<Self::Consensus, Error = Self::TryFromConsensusError> + SignedTransaction;
1297
1298    /// Define a method to convert from the `Consensus` type to `Self`
1299    ///
1300    /// This conversion may fail for transactions that are valid for inclusion in blocks
1301    /// but cannot exist in the transaction pool. Examples include:
1302    ///
1303    /// - **OP Deposit transactions**: These are special system transactions that are directly
1304    ///   included in blocks by the sequencer/validator and never enter the mempool
1305    /// - **Blob transactions without sidecars**: After being included in a block, the sidecar data
1306    ///   is pruned, making the consensus transaction unpoolable
1307    fn try_from_consensus(
1308        tx: Recovered<Self::Consensus>,
1309    ) -> Result<Self, Self::TryFromConsensusError> {
1310        let (tx, signer) = tx.into_parts();
1311        Ok(Self::from_pooled(Recovered::new_unchecked(tx.try_into()?, signer)))
1312    }
1313
1314    /// Clone the transaction into a consensus variant.
1315    ///
1316    /// This method is preferred when the [`PoolTransaction`] already wraps the consensus variant.
1317    fn clone_into_consensus(&self) -> Recovered<Self::Consensus> {
1318        self.clone().into_consensus()
1319    }
1320
1321    /// Returns a reference to the consensus transaction with the recovered sender.
1322    fn consensus_ref(&self) -> Recovered<&Self::Consensus>;
1323
1324    /// Define a method to convert from the `Self` type to `Consensus`
1325    fn into_consensus(self) -> Recovered<Self::Consensus>;
1326
1327    /// Converts the transaction into consensus format while preserving the EIP-2718 encoded bytes.
1328    /// This is used to optimize transaction execution by reusing cached encoded bytes instead of
1329    /// re-encoding the transaction. The cached bytes are particularly useful in payload building
1330    /// where the same transaction may be executed multiple times.
1331    fn into_consensus_with2718(self) -> WithEncoded<Recovered<Self::Consensus>> {
1332        self.into_consensus().into_encoded()
1333    }
1334
1335    /// Define a method to convert from the `Pooled` type to `Self`
1336    fn from_pooled(pooled: Recovered<Self::Pooled>) -> Self;
1337
1338    /// Tries to convert the `Consensus` type into the `Pooled` type.
1339    fn try_into_pooled(self) -> Result<Recovered<Self::Pooled>, Self::TryFromConsensusError> {
1340        let consensus = self.into_consensus();
1341        let (tx, signer) = consensus.into_parts();
1342        Ok(Recovered::new_unchecked(tx.try_into()?, signer))
1343    }
1344
1345    /// Clones the consensus transactions and tries to convert the `Consensus` type into the
1346    /// `Pooled` type.
1347    fn clone_into_pooled(&self) -> Result<Recovered<Self::Pooled>, Self::TryFromConsensusError> {
1348        let consensus = self.clone_into_consensus();
1349        let (tx, signer) = consensus.into_parts();
1350        Ok(Recovered::new_unchecked(tx.try_into()?, signer))
1351    }
1352
1353    /// Converts the `Pooled` type into the `Consensus` type.
1354    fn pooled_into_consensus(tx: Self::Pooled) -> Self::Consensus {
1355        tx.into()
1356    }
1357
1358    /// Hash of the transaction.
1359    fn hash(&self) -> &TxHash;
1360
1361    /// The Sender of the transaction.
1362    fn sender(&self) -> Address;
1363
1364    /// Reference to the Sender of the transaction.
1365    fn sender_ref(&self) -> &Address;
1366
1367    /// Returns the cost that this transaction is allowed to consume:
1368    ///
1369    /// For EIP-1559 transactions: `max_fee_per_gas * gas_limit + tx_value`.
1370    /// For legacy transactions: `gas_price * gas_limit + tx_value`.
1371    /// For EIP-4844 blob transactions: `max_fee_per_gas * gas_limit + tx_value +
1372    /// max_blob_fee_per_gas * blob_gas_used`.
1373    fn cost(&self) -> &U256;
1374
1375    /// Returns the length of the rlp encoded transaction object
1376    ///
1377    /// Note: Implementations should cache this value.
1378    fn encoded_length(&self) -> usize;
1379
1380    /// Ensures that the transaction's code size does not exceed the provided `max_init_code_size`.
1381    ///
1382    /// This is specifically relevant for contract creation transactions ([`TxKind::Create`]),
1383    /// where the input data contains the initialization code. If the input code size exceeds
1384    /// the configured limit, an [`InvalidPoolTransactionError::ExceedsMaxInitCodeSize`] error is
1385    /// returned.
1386    fn ensure_max_init_code_size(
1387        &self,
1388        max_init_code_size: usize,
1389    ) -> Result<(), InvalidPoolTransactionError> {
1390        let input_len = self.input().len();
1391        if self.is_create() && input_len > max_init_code_size {
1392            Err(InvalidPoolTransactionError::ExceedsMaxInitCodeSize(input_len, max_init_code_size))
1393        } else {
1394            Ok(())
1395        }
1396    }
1397
1398    /// Allows to communicate to the pool that the transaction doesn't require a nonce check.
1399    fn requires_nonce_check(&self) -> bool {
1400        true
1401    }
1402}
1403
1404/// Super trait for transactions that can be converted to and from Eth transactions intended for the
1405/// ethereum style pool.
1406///
1407/// This extends the [`PoolTransaction`] trait with additional methods that are specific to the
1408/// Ethereum pool.
1409pub trait EthPoolTransaction: PoolTransaction {
1410    /// Extracts the blob sidecar from the transaction.
1411    fn take_blob(&mut self) -> EthBlobTransactionSidecar;
1412
1413    /// A specialization for the EIP-4844 transaction type.
1414    /// Tries to reattach the blob sidecar to the transaction.
1415    ///
1416    /// This returns an option, but callers should ensure that the transaction is an EIP-4844
1417    /// transaction: [`Typed2718::is_eip4844`].
1418    fn try_into_pooled_eip4844(
1419        self,
1420        sidecar: Arc<BlobTransactionSidecarVariant>,
1421    ) -> Option<Recovered<Self::Pooled>>;
1422
1423    /// Tries to convert the `Consensus` type with a blob sidecar into the `Pooled` type.
1424    ///
1425    /// Returns `None` if passed transaction is not a blob transaction.
1426    fn try_from_eip4844(
1427        tx: Recovered<Self::Consensus>,
1428        sidecar: BlobTransactionSidecarVariant,
1429    ) -> Option<Self>;
1430
1431    /// Validates the blob sidecar of the transaction with the given settings.
1432    fn validate_blob(
1433        &self,
1434        blob: &BlobTransactionSidecarVariant,
1435        settings: &KzgSettings,
1436    ) -> Result<(), BlobTransactionValidationError>;
1437}
1438
1439/// The default [`PoolTransaction`] for the [Pool](crate::Pool) for Ethereum.
1440///
1441/// This type wraps a consensus transaction with additional cached data that's
1442/// frequently accessed by the pool for transaction ordering and validation:
1443///
1444/// - `cost`: Pre-calculated max cost (gas * price + value + blob costs)
1445/// - `encoded_length`: Cached RLP encoding length for size limits
1446/// - `blob_sidecar`: Blob data state (None/Missing/Present)
1447///
1448/// This avoids recalculating these values repeatedly during pool operations.
1449#[derive(Debug, Clone, PartialEq, Eq)]
1450pub struct EthPooledTransaction<T = TransactionSigned> {
1451    /// `EcRecovered` transaction, the consensus format.
1452    pub transaction: Recovered<T>,
1453
1454    /// For EIP-1559 transactions: `max_fee_per_gas * gas_limit + tx_value`.
1455    /// For legacy transactions: `gas_price * gas_limit + tx_value`.
1456    /// For EIP-4844 blob transactions: `max_fee_per_gas * gas_limit + tx_value +
1457    /// max_blob_fee_per_gas * blob_gas_used`.
1458    pub cost: U256,
1459
1460    /// This is the RLP length of the transaction, computed when the transaction is added to the
1461    /// pool.
1462    pub encoded_length: usize,
1463
1464    /// The blob side car for this transaction
1465    pub blob_sidecar: EthBlobTransactionSidecar,
1466}
1467
1468impl<T: SignedTransaction> EthPooledTransaction<T> {
1469    /// Create new instance of [Self].
1470    ///
1471    /// Caution: In case of blob transactions, this marks the blob sidecar as
1472    /// [`EthBlobTransactionSidecar::Missing`]
1473    pub fn new(transaction: Recovered<T>, encoded_length: usize) -> Self {
1474        let mut blob_sidecar = EthBlobTransactionSidecar::None;
1475
1476        let gas_cost = U256::from(transaction.max_fee_per_gas())
1477            .saturating_mul(U256::from(transaction.gas_limit()));
1478
1479        let mut cost = gas_cost.saturating_add(transaction.value());
1480
1481        if let (Some(blob_gas_used), Some(max_fee_per_blob_gas)) =
1482            (transaction.blob_gas_used(), transaction.max_fee_per_blob_gas())
1483        {
1484            // Add max blob cost using saturating math to avoid overflow
1485            cost = cost.saturating_add(U256::from(
1486                max_fee_per_blob_gas.saturating_mul(blob_gas_used as u128),
1487            ));
1488
1489            // because the blob sidecar is not included in this transaction variant, mark it as
1490            // missing
1491            blob_sidecar = EthBlobTransactionSidecar::Missing;
1492        }
1493
1494        Self { transaction, cost, encoded_length, blob_sidecar }
1495    }
1496
1497    /// Return the reference to the underlying transaction.
1498    pub const fn transaction(&self) -> &Recovered<T> {
1499        &self.transaction
1500    }
1501}
1502
1503impl PoolTransaction for EthPooledTransaction {
1504    type TryFromConsensusError = ValueError<TransactionSigned>;
1505
1506    type Consensus = TransactionSigned;
1507
1508    type Pooled = PooledTransactionVariant;
1509
1510    fn clone_into_consensus(&self) -> Recovered<Self::Consensus> {
1511        self.transaction().clone()
1512    }
1513
1514    fn consensus_ref(&self) -> Recovered<&Self::Consensus> {
1515        Recovered::new_unchecked(&*self.transaction, self.transaction.signer())
1516    }
1517
1518    fn into_consensus(self) -> Recovered<Self::Consensus> {
1519        self.transaction
1520    }
1521
1522    fn from_pooled(tx: Recovered<Self::Pooled>) -> Self {
1523        let encoded_length = tx.encode_2718_len();
1524        let (tx, signer) = tx.into_parts();
1525        match tx {
1526            PooledTransactionVariant::Eip4844(tx) => {
1527                // include the blob sidecar
1528                let (tx, sig, hash) = tx.into_parts();
1529                let (tx, blob) = tx.into_parts();
1530                let tx = Signed::new_unchecked(tx, sig, hash);
1531                let tx = TransactionSigned::from(tx);
1532                let tx = Recovered::new_unchecked(tx, signer);
1533                let mut pooled = Self::new(tx, encoded_length);
1534                pooled.blob_sidecar = EthBlobTransactionSidecar::Present(blob);
1535                pooled
1536            }
1537            tx => {
1538                // no blob sidecar
1539                let tx = Recovered::new_unchecked(tx.into(), signer);
1540                Self::new(tx, encoded_length)
1541            }
1542        }
1543    }
1544
1545    /// Returns hash of the transaction.
1546    fn hash(&self) -> &TxHash {
1547        self.transaction.tx_hash()
1548    }
1549
1550    /// Returns the Sender of the transaction.
1551    fn sender(&self) -> Address {
1552        self.transaction.signer()
1553    }
1554
1555    /// Returns a reference to the Sender of the transaction.
1556    fn sender_ref(&self) -> &Address {
1557        self.transaction.signer_ref()
1558    }
1559
1560    /// Returns the cost that this transaction is allowed to consume:
1561    ///
1562    /// For EIP-1559 transactions: `max_fee_per_gas * gas_limit + tx_value`.
1563    /// For legacy transactions: `gas_price * gas_limit + tx_value`.
1564    /// For EIP-4844 blob transactions: `max_fee_per_gas * gas_limit + tx_value +
1565    /// max_blob_fee_per_gas * blob_gas_used`.
1566    fn cost(&self) -> &U256 {
1567        &self.cost
1568    }
1569
1570    /// Returns the length of the rlp encoded object
1571    fn encoded_length(&self) -> usize {
1572        self.encoded_length
1573    }
1574}
1575
1576impl<T: Typed2718> Typed2718 for EthPooledTransaction<T> {
1577    fn ty(&self) -> u8 {
1578        self.transaction.ty()
1579    }
1580}
1581
1582impl<T: InMemorySize> InMemorySize for EthPooledTransaction<T> {
1583    fn size(&self) -> usize {
1584        self.transaction.size()
1585    }
1586}
1587
1588impl<T: alloy_consensus::Transaction> alloy_consensus::Transaction for EthPooledTransaction<T> {
1589    fn chain_id(&self) -> Option<alloy_primitives::ChainId> {
1590        self.transaction.chain_id()
1591    }
1592
1593    fn nonce(&self) -> u64 {
1594        self.transaction.nonce()
1595    }
1596
1597    fn gas_limit(&self) -> u64 {
1598        self.transaction.gas_limit()
1599    }
1600
1601    fn gas_price(&self) -> Option<u128> {
1602        self.transaction.gas_price()
1603    }
1604
1605    fn max_fee_per_gas(&self) -> u128 {
1606        self.transaction.max_fee_per_gas()
1607    }
1608
1609    fn max_priority_fee_per_gas(&self) -> Option<u128> {
1610        self.transaction.max_priority_fee_per_gas()
1611    }
1612
1613    fn max_fee_per_blob_gas(&self) -> Option<u128> {
1614        self.transaction.max_fee_per_blob_gas()
1615    }
1616
1617    fn priority_fee_or_price(&self) -> u128 {
1618        self.transaction.priority_fee_or_price()
1619    }
1620
1621    fn effective_gas_price(&self, base_fee: Option<u64>) -> u128 {
1622        self.transaction.effective_gas_price(base_fee)
1623    }
1624
1625    fn is_dynamic_fee(&self) -> bool {
1626        self.transaction.is_dynamic_fee()
1627    }
1628
1629    fn kind(&self) -> TxKind {
1630        self.transaction.kind()
1631    }
1632
1633    fn is_create(&self) -> bool {
1634        self.transaction.is_create()
1635    }
1636
1637    fn value(&self) -> U256 {
1638        self.transaction.value()
1639    }
1640
1641    fn input(&self) -> &Bytes {
1642        self.transaction.input()
1643    }
1644
1645    fn access_list(&self) -> Option<&AccessList> {
1646        self.transaction.access_list()
1647    }
1648
1649    fn blob_versioned_hashes(&self) -> Option<&[B256]> {
1650        self.transaction.blob_versioned_hashes()
1651    }
1652
1653    fn authorization_list(&self) -> Option<&[SignedAuthorization]> {
1654        self.transaction.authorization_list()
1655    }
1656}
1657
1658impl EthPoolTransaction for EthPooledTransaction {
1659    fn take_blob(&mut self) -> EthBlobTransactionSidecar {
1660        if self.is_eip4844() {
1661            std::mem::replace(&mut self.blob_sidecar, EthBlobTransactionSidecar::Missing)
1662        } else {
1663            EthBlobTransactionSidecar::None
1664        }
1665    }
1666
1667    fn try_into_pooled_eip4844(
1668        self,
1669        sidecar: Arc<BlobTransactionSidecarVariant>,
1670    ) -> Option<Recovered<Self::Pooled>> {
1671        let (signed_transaction, signer) = self.into_consensus().into_parts();
1672        let pooled_transaction =
1673            signed_transaction.try_into_pooled_eip4844(Arc::unwrap_or_clone(sidecar)).ok()?;
1674
1675        Some(Recovered::new_unchecked(pooled_transaction, signer))
1676    }
1677
1678    fn try_from_eip4844(
1679        tx: Recovered<Self::Consensus>,
1680        sidecar: BlobTransactionSidecarVariant,
1681    ) -> Option<Self> {
1682        let (tx, signer) = tx.into_parts();
1683        tx.try_into_pooled_eip4844(sidecar)
1684            .ok()
1685            .map(|tx| tx.with_signer(signer))
1686            .map(Self::from_pooled)
1687    }
1688
1689    fn validate_blob(
1690        &self,
1691        sidecar: &BlobTransactionSidecarVariant,
1692        settings: &KzgSettings,
1693    ) -> Result<(), BlobTransactionValidationError> {
1694        match self.transaction.inner().as_eip4844() {
1695            Some(tx) => tx.tx().validate_blob(sidecar, settings),
1696            _ => Err(BlobTransactionValidationError::NotBlobTransaction(self.ty())),
1697        }
1698    }
1699}
1700
1701/// Represents the blob sidecar of the [`EthPooledTransaction`].
1702///
1703/// EIP-4844 blob transactions require additional data (blobs, commitments, proofs)
1704/// for validation that is not included in the consensus format. This enum tracks
1705/// the sidecar state throughout the transaction's lifecycle in the pool.
1706#[derive(Debug, Clone, PartialEq, Eq)]
1707pub enum EthBlobTransactionSidecar {
1708    /// This transaction does not have a blob sidecar
1709    /// (applies to all non-EIP-4844 transaction types)
1710    None,
1711    /// This transaction has a blob sidecar (EIP-4844) but it is missing.
1712    ///
1713    /// This can happen when:
1714    /// - The sidecar was extracted after the transaction was added to the pool
1715    /// - The transaction was re-injected after a reorg without its sidecar
1716    /// - The transaction was recovered from the consensus format (e.g., from a block)
1717    Missing,
1718    /// The EIP-4844 transaction was received from the network with its complete sidecar.
1719    ///
1720    /// This sidecar contains:
1721    /// - The actual blob data (large data per blob)
1722    /// - KZG commitments for each blob
1723    /// - KZG proofs for validation
1724    ///
1725    /// The sidecar is required for validating the transaction but is not included
1726    /// in blocks (only the blob hashes are included in the consensus format).
1727    Present(BlobTransactionSidecarVariant),
1728}
1729
1730impl EthBlobTransactionSidecar {
1731    /// Returns the blob sidecar if it is present
1732    pub const fn maybe_sidecar(&self) -> Option<&BlobTransactionSidecarVariant> {
1733        match self {
1734            Self::Present(sidecar) => Some(sidecar),
1735            _ => None,
1736        }
1737    }
1738}
1739
1740/// Represents the current status of the pool.
1741#[derive(Debug, Clone, Copy, Default)]
1742pub struct PoolSize {
1743    /// Number of transactions in the _pending_ sub-pool.
1744    pub pending: usize,
1745    /// Reported size of transactions in the _pending_ sub-pool.
1746    pub pending_size: usize,
1747    /// Number of transactions in the _blob_ pool.
1748    pub blob: usize,
1749    /// Reported size of transactions in the _blob_ pool.
1750    pub blob_size: usize,
1751    /// Number of transactions in the _basefee_ pool.
1752    pub basefee: usize,
1753    /// Reported size of transactions in the _basefee_ sub-pool.
1754    pub basefee_size: usize,
1755    /// Number of transactions in the _queued_ sub-pool.
1756    pub queued: usize,
1757    /// Reported size of transactions in the _queued_ sub-pool.
1758    pub queued_size: usize,
1759    /// Number of all transactions of all sub-pools
1760    ///
1761    /// Note: this is the sum of ```pending + basefee + queued + blob```
1762    pub total: usize,
1763}
1764
1765// === impl PoolSize ===
1766
1767impl PoolSize {
1768    /// Asserts that the invariants of the pool size are met.
1769    #[cfg(test)]
1770    pub(crate) fn assert_invariants(&self) {
1771        assert_eq!(self.total, self.pending + self.basefee + self.queued + self.blob);
1772    }
1773}
1774
1775/// Represents the current status of the pool.
1776#[derive(Default, Debug, Clone, Copy, Eq, PartialEq)]
1777pub struct BlockInfo {
1778    /// Hash for the currently tracked block.
1779    pub last_seen_block_hash: B256,
1780    /// Currently tracked block.
1781    pub last_seen_block_number: u64,
1782    /// Current block gas limit for the latest block.
1783    pub block_gas_limit: u64,
1784    /// Currently enforced base fee: the threshold for the basefee sub-pool.
1785    ///
1786    /// Note: this is the derived base fee of the _next_ block that builds on the block the pool is
1787    /// currently tracking.
1788    pub pending_basefee: u64,
1789    /// Currently enforced blob fee: the threshold for eip-4844 blob transactions.
1790    ///
1791    /// Note: this is the derived blob fee of the _next_ block that builds on the block the pool is
1792    /// currently tracking
1793    pub pending_blob_fee: Option<u128>,
1794}
1795
1796/// The limit to enforce for [`TransactionPool::get_pooled_transaction_elements`].
1797#[derive(Debug, Clone, Copy, Eq, PartialEq)]
1798pub enum GetPooledTransactionLimit {
1799    /// No limit, return all transactions.
1800    None,
1801    /// Enforce a size limit on the returned transactions, for example 2MB
1802    ResponseSizeSoftLimit(usize),
1803}
1804
1805impl GetPooledTransactionLimit {
1806    /// Returns true if the given size exceeds the limit.
1807    #[inline]
1808    pub const fn exceeds(&self, size: usize) -> bool {
1809        match self {
1810            Self::None => false,
1811            Self::ResponseSizeSoftLimit(limit) => size > *limit,
1812        }
1813    }
1814}
1815
1816/// A Stream that yields full transactions the subpool
1817#[must_use = "streams do nothing unless polled"]
1818#[derive(Debug)]
1819pub struct NewSubpoolTransactionStream<Tx: PoolTransaction> {
1820    st: Receiver<NewTransactionEvent<Tx>>,
1821    subpool: SubPool,
1822}
1823
1824// === impl NewSubpoolTransactionStream ===
1825
1826impl<Tx: PoolTransaction> NewSubpoolTransactionStream<Tx> {
1827    /// Create a new stream that yields full transactions from the subpool
1828    pub const fn new(st: Receiver<NewTransactionEvent<Tx>>, subpool: SubPool) -> Self {
1829        Self { st, subpool }
1830    }
1831
1832    /// Tries to receive the next value for this stream.
1833    pub fn try_recv(
1834        &mut self,
1835    ) -> Result<NewTransactionEvent<Tx>, tokio::sync::mpsc::error::TryRecvError> {
1836        loop {
1837            let event = self.st.try_recv()?;
1838            if event.subpool == self.subpool {
1839                return Ok(event)
1840            }
1841        }
1842    }
1843}
1844
1845impl<Tx: PoolTransaction> Stream for NewSubpoolTransactionStream<Tx> {
1846    type Item = NewTransactionEvent<Tx>;
1847
1848    fn poll_next(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
1849        loop {
1850            match ready!(self.st.poll_recv(cx)) {
1851                Some(event) => {
1852                    if event.subpool == self.subpool {
1853                        return Poll::Ready(Some(event))
1854                    }
1855                }
1856                None => return Poll::Ready(None),
1857            }
1858        }
1859    }
1860}
1861
1862#[cfg(test)]
1863mod tests {
1864    use super::*;
1865    use alloy_consensus::{
1866        EthereumTxEnvelope, SignableTransaction, TxEip1559, TxEip2930, TxEip4844, TxEip7702,
1867        TxEnvelope, TxLegacy,
1868    };
1869    use alloy_eips::eip4844::DATA_GAS_PER_BLOB;
1870    use alloy_primitives::Signature;
1871
1872    #[test]
1873    fn test_pool_size_invariants() {
1874        let pool_size = PoolSize {
1875            pending: 10,
1876            pending_size: 1000,
1877            blob: 5,
1878            blob_size: 500,
1879            basefee: 8,
1880            basefee_size: 800,
1881            queued: 7,
1882            queued_size: 700,
1883            total: 10 + 5 + 8 + 7, // Correct total
1884        };
1885
1886        // Call the assert_invariants method to check if the invariants are correct
1887        pool_size.assert_invariants();
1888    }
1889
1890    #[test]
1891    #[should_panic]
1892    fn test_pool_size_invariants_fail() {
1893        let pool_size = PoolSize {
1894            pending: 10,
1895            pending_size: 1000,
1896            blob: 5,
1897            blob_size: 500,
1898            basefee: 8,
1899            basefee_size: 800,
1900            queued: 7,
1901            queued_size: 700,
1902            total: 10 + 5 + 8, // Incorrect total
1903        };
1904
1905        // Call the assert_invariants method, which should panic
1906        pool_size.assert_invariants();
1907    }
1908
1909    #[test]
1910    fn test_eth_pooled_transaction_new_legacy() {
1911        // Create a legacy transaction with specific parameters
1912        let tx = TxEnvelope::Legacy(
1913            TxLegacy {
1914                gas_price: 10,
1915                gas_limit: 1000,
1916                value: U256::from(100),
1917                ..Default::default()
1918            }
1919            .into_signed(Signature::test_signature()),
1920        );
1921        let transaction = Recovered::new_unchecked(tx, Default::default());
1922        let pooled_tx = EthPooledTransaction::new(transaction.clone(), 200);
1923
1924        // Check that the pooled transaction is created correctly
1925        assert_eq!(pooled_tx.transaction, transaction);
1926        assert_eq!(pooled_tx.encoded_length, 200);
1927        assert_eq!(pooled_tx.blob_sidecar, EthBlobTransactionSidecar::None);
1928        assert_eq!(pooled_tx.cost, U256::from(100) + U256::from(10 * 1000));
1929    }
1930
1931    #[test]
1932    fn test_eth_pooled_transaction_new_eip2930() {
1933        // Create an EIP-2930 transaction with specific parameters
1934        let tx = TxEnvelope::Eip2930(
1935            TxEip2930 {
1936                gas_price: 10,
1937                gas_limit: 1000,
1938                value: U256::from(100),
1939                ..Default::default()
1940            }
1941            .into_signed(Signature::test_signature()),
1942        );
1943        let transaction = Recovered::new_unchecked(tx, Default::default());
1944        let pooled_tx = EthPooledTransaction::new(transaction.clone(), 200);
1945        let expected_cost = U256::from(100) + (U256::from(10 * 1000));
1946
1947        assert_eq!(pooled_tx.transaction, transaction);
1948        assert_eq!(pooled_tx.encoded_length, 200);
1949        assert_eq!(pooled_tx.blob_sidecar, EthBlobTransactionSidecar::None);
1950        assert_eq!(pooled_tx.cost, expected_cost);
1951    }
1952
1953    #[test]
1954    fn test_eth_pooled_transaction_new_eip1559() {
1955        // Create an EIP-1559 transaction with specific parameters
1956        let tx = TxEnvelope::Eip1559(
1957            TxEip1559 {
1958                max_fee_per_gas: 10,
1959                gas_limit: 1000,
1960                value: U256::from(100),
1961                ..Default::default()
1962            }
1963            .into_signed(Signature::test_signature()),
1964        );
1965        let transaction = Recovered::new_unchecked(tx, Default::default());
1966        let pooled_tx = EthPooledTransaction::new(transaction.clone(), 200);
1967
1968        // Check that the pooled transaction is created correctly
1969        assert_eq!(pooled_tx.transaction, transaction);
1970        assert_eq!(pooled_tx.encoded_length, 200);
1971        assert_eq!(pooled_tx.blob_sidecar, EthBlobTransactionSidecar::None);
1972        assert_eq!(pooled_tx.cost, U256::from(100) + U256::from(10 * 1000));
1973    }
1974
1975    #[test]
1976    fn test_eth_pooled_transaction_new_eip4844() {
1977        // Create an EIP-4844 transaction with specific parameters
1978        let tx = EthereumTxEnvelope::Eip4844(
1979            TxEip4844 {
1980                max_fee_per_gas: 10,
1981                gas_limit: 1000,
1982                value: U256::from(100),
1983                max_fee_per_blob_gas: 5,
1984                blob_versioned_hashes: vec![B256::default()],
1985                ..Default::default()
1986            }
1987            .into_signed(Signature::test_signature()),
1988        );
1989        let transaction = Recovered::new_unchecked(tx, Default::default());
1990        let pooled_tx = EthPooledTransaction::new(transaction.clone(), 300);
1991
1992        // Check that the pooled transaction is created correctly
1993        assert_eq!(pooled_tx.transaction, transaction);
1994        assert_eq!(pooled_tx.encoded_length, 300);
1995        assert_eq!(pooled_tx.blob_sidecar, EthBlobTransactionSidecar::Missing);
1996        let expected_cost =
1997            U256::from(100) + U256::from(10 * 1000) + U256::from(5 * DATA_GAS_PER_BLOB);
1998        assert_eq!(pooled_tx.cost, expected_cost);
1999    }
2000
2001    #[test]
2002    fn test_eth_pooled_transaction_new_eip7702() {
2003        // Init an EIP-7702 transaction with specific parameters
2004        let tx = EthereumTxEnvelope::<TxEip4844>::Eip7702(
2005            TxEip7702 {
2006                max_fee_per_gas: 10,
2007                gas_limit: 1000,
2008                value: U256::from(100),
2009                ..Default::default()
2010            }
2011            .into_signed(Signature::test_signature()),
2012        );
2013        let transaction = Recovered::new_unchecked(tx, Default::default());
2014        let pooled_tx = EthPooledTransaction::new(transaction.clone(), 200);
2015
2016        // Check that the pooled transaction is created correctly
2017        assert_eq!(pooled_tx.transaction, transaction);
2018        assert_eq!(pooled_tx.encoded_length, 200);
2019        assert_eq!(pooled_tx.blob_sidecar, EthBlobTransactionSidecar::None);
2020        assert_eq!(pooled_tx.cost, U256::from(100) + U256::from(10 * 1000));
2021    }
2022
2023    #[test]
2024    fn test_pooled_transaction_limit() {
2025        // No limit should never exceed
2026        let limit_none = GetPooledTransactionLimit::None;
2027        // Any size should return false
2028        assert!(!limit_none.exceeds(1000));
2029
2030        // Size limit of 2MB (2 * 1024 * 1024 bytes)
2031        let size_limit_2mb = GetPooledTransactionLimit::ResponseSizeSoftLimit(2 * 1024 * 1024);
2032
2033        // Test with size below the limit
2034        // 1MB is below 2MB, should return false
2035        assert!(!size_limit_2mb.exceeds(1024 * 1024));
2036
2037        // Test with size exactly at the limit
2038        // 2MB equals the limit, should return false
2039        assert!(!size_limit_2mb.exceeds(2 * 1024 * 1024));
2040
2041        // Test with size exceeding the limit
2042        // 3MB is above the 2MB limit, should return true
2043        assert!(size_limit_2mb.exceeds(3 * 1024 * 1024));
2044    }
2045}