Struct Pool

pub struct Pool {
    inner: RwLock<PoolInner>,
    transaction_listener: Mutex<Vec<Sender<TxHash>>>,
}

Transaction pool that performs validation.

Fields

inner: RwLock<PoolInner>

processes all pending transactions

transaction_listener: Mutex<Vec<Sender<TxHash>>>

listeners for new ready transactions

Implementations

impl Pool

pub fn ready_transactions(&self) -> TransactionsIterator

Returns an iterator that yields all transactions that are currently ready

pub fn pending_transactions(&self) -> Vec<Arc<PoolTransaction>>

Returns all transactions that are not ready to be included in a block yet

pub fn get_transaction(&self, hash: TxHash) -> Option<PendingTransaction>

Returns the pending transaction for that hash if it exists in the mempool

pub fn txpool_status(&self) -> TxpoolStatus

Returns the number of tx that are ready and queued for further execution

pub fn on_mined_block(&self, outcome: MinedBlockOutcome) -> PruneResult

Invoked when a set of transactions (Self::ready_transactions()) was executed.

This will remove the transactions from the pool.

pub fn prune_markers( &self, block_number: U64, markers: impl IntoIterator<Item = TxMarker>, ) -> PruneResult

Removes ready transactions for the given iterator of identifying markers.

For each marker we can remove transactions in the pool that either provide the marker directly or are a dependency of the transaction associated with that marker.

pub fn add_transaction( &self, tx: PoolTransaction, ) -> Result<AddedTransaction, PoolError>

Adds a new transaction to the pool

pub fn add_ready_listener(&self) -> Receiver<TxHash>

Adds a new transaction listener to the pool that gets notified about every new ready transaction

pub fn contains(&self, tx_hash: &TxHash) -> bool

Returns true if this pool already contains the transaction

pub fn remove_invalid( &self, tx_hashes: Vec<TxHash>, ) -> Vec<Arc<PoolTransaction>>

Remove the given transactions from the pool

pub fn remove_transactions_by_address( &self, sender: Address, ) -> Vec<Arc<PoolTransaction>>

Remove transactions by sender

pub fn drop_transaction(&self, tx: TxHash) -> Option<Arc<PoolTransaction>>

Removes a single transaction from the pool

This is similar to [Pool::remove_invalid()] but for a single transaction.

Note: this will also drop any transaction that depend on the tx

pub fn clear(&self)

Removes all transactions from the pool

fn notify_listener(&self, hash: TxHash)

notifies all listeners about the transaction

Trait Implementations

impl Default for Pool

fn default() -> Pool

Returns the “default value” for a type.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 240 bytes