Struct ForkAwareTxPool

pub struct ForkAwareTxPool<ChainApi, Block>
where
    Block: BlockT,
    ChainApi: ChainApi<Block = Block> + 'static,
{ /* private fields */ }

The fork-aware transaction pool.

It keeps track of every fork and provides the set of transactions that is valid for every fork.

Implementations

impl<ChainApi, Block> ForkAwareTxPool<ChainApi, Block>

where Block: BlockT, ChainApi: ChainApi<Block = Block> + 'static, <Block as BlockT>::Hash: Unpin,

pub fn new_test( pool_api: Arc<ChainApi>, best_block_hash: Block::Hash, finalized_hash: Block::Hash, finality_timeout_threshold: Option<usize>, ) -> (Self, ForkAwareTxPoolTask)

Create new fork aware transaction pool with provided shared instance of ChainApi intended for tests.

pub fn new_test_with_limits( pool_api: Arc<ChainApi>, best_block_hash: Block::Hash, finalized_hash: Block::Hash, ready_limits: PoolLimit, future_limits: PoolLimit, mempool_max_transactions_count: usize, finality_timeout_threshold: Option<usize>, ) -> (Self, ForkAwareTxPoolTask)

Create new fork aware transaction pool with given limits and with provided shared instance of ChainApi intended for tests.

pub fn new_with_background_worker( options: Options, is_validator: IsValidator, pool_api: Arc<ChainApi>, prometheus: Option<&PrometheusRegistry>, spawner: impl SpawnEssentialNamed, best_block_hash: Block::Hash, finalized_hash: Block::Hash, ) -> Self

Creates new fork aware transaction pool with the background revalidation worker.

The txpool essential tasks (including a revalidation worker) are spawned using provided spawner.

pub fn api(&self) -> &ChainApi

Get access to the underlying api

pub fn status_all(&self) -> HashMap<Block::Hash, PoolStatus>

Provides a status for all views at the tips of the forks.

pub fn active_views_count(&self) -> usize

Provides a number of views at the tips of the forks.

pub fn inactive_views_count(&self) -> usize

Provides a number of views at the tips of the forks.

pub fn has_view(&self, hash: &Block::Hash) -> bool

Checks if there is a view at the tip of the fork with given hash.

pub fn mempool_len(&self) -> (usize, usize)

Returns a number of unwatched and watched transactions in internal mempool.

Intended for use in unit tests.

pub fn futures_at( &self, at: Block::Hash, ) -> Option<Vec<Transaction<<<ChainApi as ChainApi>::Block as Block>::Hash, Arc<<<ChainApi as ChainApi>::Block as Block>::Extrinsic>>>>

Returns a set of future transactions for given block hash.

Intended for logging / tests.

pub async fn ready_at_light( &self, at: Block::Hash, ) -> Box<dyn ReadyTransactions<Item = Arc<Transaction<<<ChainApi as ChainApi>::Block as Block>::Hash, Arc<<<ChainApi as ChainApi>::Block as Block>::Extrinsic>>>> + Send>

Returns a best-effort set of ready transactions for a given block, without executing full maintain process.

The method attempts to build a temporary view and create an iterator of ready transactions for a specific at hash. If a valid view is found, it collects and prunes transactions already included in the blocks and returns the valid set.

Pruning is just rebuilding the underlying transactions graph, no validations are executed, so this process shall be fast.

impl<Block, Client> ForkAwareTxPool<FullChainApi<Client, Block>, Block>

where Block: BlockT, Client: ProvideRuntimeApi<Block> + BlockBackend<Block> + HeaderBackend<Block> + BlockIdTo<Block> + ExecutorProvider<Block> + UsageProvider<Block> + HeaderMetadata<Block, Error = Error> + Send + Sync + 'static, Client::Api: TaggedTransactionQueue<Block>, <Block as BlockT>::Hash: Unpin,

pub fn new_full( options: Options, is_validator: IsValidator, prometheus: Option<&PrometheusRegistry>, spawner: impl SpawnEssentialNamed, client: Arc<Client>, ) -> Self

Create new fork aware transaction pool for a full node with the provided api.

Trait Implementations

impl<ChainApi, Block> LocalTransactionPool for ForkAwareTxPool<ChainApi, Block>

where Block: BlockT, ChainApi: 'static + ChainApi<Block = Block>, <Block as BlockT>::Hash: Unpin,

type Block = Block

Block type.

type Hash = <<ChainApi as ChainApi>::Block as Block>::Hash

Transaction hash type.

type Error = <ChainApi as ChainApi>::Error

Error type.

fn submit_local( &self, _at: Block::Hash, xt: LocalTransactionFor<Self>, ) -> Result<Self::Hash, Self::Error>

Submits the given local unverified transaction to the pool blocking the current thread for any necessary pre-verification. NOTE: It MUST NOT be used for transactions that originate from the network or RPC, since the validation is performed with TransactionSource::Local.

impl<ChainApi, Block> MaintainedTransactionPool for ForkAwareTxPool<ChainApi, Block>

where Block: BlockT, ChainApi: 'static + ChainApi<Block = Block>, <Block as BlockT>::Hash: Unpin,

fn maintain<'life0, 'async_trait>( &'life0 self, event: ChainEvent<Self::Block>, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Executes the maintainance for the given chain event.

impl<ChainApi, Block> TransactionPool for ForkAwareTxPool<ChainApi, Block>

where Block: BlockT, ChainApi: 'static + ChainApi<Block = Block>, <Block as BlockT>::Hash: Unpin,

fn submit_at<'life0, 'async_trait>( &'life0 self, __arg1: <Self::Block as BlockT>::Hash, source: TransactionSource, xts: Vec<TransactionFor<Self>>, ) -> Pin<Box<dyn Future<Output = Result<Vec<Result<TxHash<Self>, Self::Error>>, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Submits multiple transactions and returns a future resolving to the submission results.

Actual transactions submission process is delegated to the ViewStore internal instance.

The internal limits of the pool are checked. The results of submissions to individual views are reduced to single result. Refer to reduce_multiview_result for more details.

fn submit_one<'life0, 'async_trait>( &'life0 self, _at: <Self::Block as BlockT>::Hash, source: TransactionSource, xt: TransactionFor<Self>, ) -> Pin<Box<dyn Future<Output = Result<TxHash<Self>, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Submits a single transaction and returns a future resolving to the submission results.

Actual transaction submission process is delegated to the submit_at function.

fn submit_and_watch<'life0, 'async_trait>( &'life0 self, at: <Self::Block as BlockT>::Hash, source: TransactionSource, xt: TransactionFor<Self>, ) -> Pin<Box<dyn Future<Output = Result<Pin<Box<TransactionStatusStreamFor<Self>>>, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Submits a transaction and starts to watch its progress in the pool, returning a stream of status updates.

Actual transaction submission process is delegated to the ViewStore internal instance.

fn report_invalid( &self, at: Option<<Self::Block as BlockT>::Hash>, invalid_tx_errors: TxInvalidityReportMap<TxHash<Self>>, ) -> Vec<Arc<Self::InPoolTransaction>>

Reports invalid transactions to the transaction pool.

This function takes an array of tuples, each consisting of a transaction hash and the corresponding error that occurred during transaction execution at given block.

The transaction pool implementation will determine which transactions should be removed from the pool. Transactions that depend on invalid transactions will also be removed.

fn status(&self) -> PoolStatus

Returns the pool status which includes information like the number of ready and future transactions.

Currently the status for the most recently notified best block is returned (for which maintain process was accomplished).

fn import_notification_stream( &self, ) -> ImportNotificationStream<<<ChainApi as ChainApi>::Block as Block>::Hash>

Return an event stream of notifications when transactions are imported to the pool.

Consumers of this stream should use the ready method to actually get the pending transactions in the right order.

fn hash_of(&self, xt: &TransactionFor<Self>) -> TxHash<Self>

Returns the hash of a given transaction.

fn on_broadcasted(&self, propagations: HashMap<TxHash<Self>, Vec<String>>)

Notifies the pool about the broadcasting status of transactions.

fn ready_transaction( &self, tx_hash: &TxHash<Self>, ) -> Option<Arc<Self::InPoolTransaction>>

Return specific ready transaction by hash, if there is one.

Currently the ready transaction is returned if it exists for the most recently notified best block (for which maintain process was accomplished).

fn ready_at<'life0, 'async_trait>( &'life0 self, at: <Self::Block as BlockT>::Hash, ) -> Pin<Box<dyn Future<Output = Box<dyn ReadyTransactions<Item = Arc<Transaction<<<ChainApi as ChainApi>::Block as Block>::Hash, Arc<<<ChainApi as ChainApi>::Block as Block>::Extrinsic>>>> + Send>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns an iterator for ready transactions at a specific block, ordered by priority.

fn ready( &self, ) -> Box<dyn ReadyTransactions<Item = Arc<Transaction<<<ChainApi as ChainApi>::Block as Block>::Hash, Arc<<<ChainApi as ChainApi>::Block as Block>::Extrinsic>>>> + Send>

Returns an iterator for ready transactions, ordered by priority.

Currently the set of ready transactions is returned if it exists for the most recently notified best block (for which maintain process was accomplished).

fn futures(&self) -> Vec<Self::InPoolTransaction>

Returns a list of future transactions in the pool.

Currently the set of future transactions is returned if it exists for the most recently notified best block (for which maintain process was accomplished).

fn ready_at_with_timeout<'life0, 'async_trait>( &'life0 self, at: <Self::Block as BlockT>::Hash, timeout: Duration, ) -> Pin<Box<dyn Future<Output = Box<dyn ReadyTransactions<Item = Arc<Transaction<<<ChainApi as ChainApi>::Block as Block>::Hash, Arc<<<ChainApi as ChainApi>::Block as Block>::Extrinsic>>>> + Send>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns a set of ready transactions at a given block within the specified timeout.

If the timeout expires before the maintain process is accomplished, a best-effort set of transactions is returned (refer to ready_at_light).

type Block = <ChainApi as ChainApi>::Block

Block type.

type Hash = <<ChainApi as ChainApi>::Block as Block>::Hash

Transaction hash type.

type InPoolTransaction = Transaction<<<ChainApi as ChainApi>::Block as Block>::Hash, Arc<<<ChainApi as ChainApi>::Block as Block>::Extrinsic>>

In-pool transaction type.

type Error = <ChainApi as ChainApi>::Error

Error type.