Struct sc_transaction_pool::BasicPool

pub struct BasicPool<PoolApi, Block>where
    Block: BlockT,
    PoolApi: ChainApi<Block = Block>,{ /* private fields */ }

Basic implementation of transaction pool that can be customized by providing PoolApi.

Implementations

impl<PoolApi, Block> BasicPool<PoolApi, Block>where
    Block: BlockT,
    PoolApi: ChainApi<Block = Block> + 'static,

pub fn new_test(
    pool_api: Arc<PoolApi>
) -> (Self, Pin<Box<dyn Future<Output = ()> + Send>>)

Create new basic transaction pool with provided api, for tests.

pub fn with_revalidation_type(
    options: Options,
    is_validator: IsValidator,
    pool_api: Arc<PoolApi>,
    prometheus: Option<&PrometheusRegistry>,
    revalidation_type: RevalidationType,
    spawner: impl SpawnEssentialNamed,
    best_block_number: NumberFor<Block>
) -> Self

Create new basic transaction pool with provided api and custom revalidation type.

pub fn pool(&self) -> &Arc<Pool<PoolApi>>

Gets shared reference to the underlying pool.

pub fn api(&self) -> &PoolApi

Get access to the underlying api

impl<Block, Client> BasicPool<FullChainApi<Client, Block>, Block>where
    Block: BlockT,
    Client: ProvideRuntimeApi<Block> + BlockBackend<Block> + HeaderBackend<Block> + BlockIdTo<Block> + ExecutorProvider<Block> + UsageProvider<Block> + Send + Sync + 'static,
    Client::Api: TaggedTransactionQueue<Block>,

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

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

Trait Implementations

impl<Block, Client> LocalTransactionPool for BasicPool<FullChainApi<Client, Block>, Block>where
    Block: BlockT,
    Client: ProvideRuntimeApi<Block> + BlockBackend<Block> + HeaderBackend<Block> + BlockIdTo<Block> + Send + Sync + 'static,
    Client::Api: TaggedTransactionQueue<Block>,

type Block = Block

Block type.

type Hash = <<FullChainApi<Client, Block> as ChainApi>::Block as Block>::Hash

Transaction hash type.

type Error = <FullChainApi<Client, Block> as ChainApi>::Error

Error type.

fn submit_local(
    &self,
    at: &BlockId<Self::Block>,
    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<PoolApi, Block> MaintainedTransactionPool for BasicPool<PoolApi, Block>where
    Block: BlockT,
    PoolApi: 'static + ChainApi<Block = Block>,

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

Perform maintenance

impl<PoolApi, Block> MallocSizeOf for BasicPool<PoolApi, Block>where
    PoolApi: ChainApi<Block = Block>,
    Block: BlockT,

fn size_of(&self, ops: &mut MallocSizeOfOps) -> usize

Measure the heap usage of all descendant heap-allocated structures, but not the space taken up by the value itself. If T::size_of is a constant, consider implementing constant_size as well.

fn constant_size() -> Option<usize>where
    Self: Sized,

Used to optimize MallocSizeOf implementation for collections like Vec and HashMap to avoid iterating over them unnecessarily. The Self: Sized bound is for object safety.

impl<PoolApi, Block> TransactionPool for BasicPool<PoolApi, Block>where
    Block: BlockT,
    PoolApi: 'static + ChainApi<Block = Block>,

type Block = <PoolApi as ChainApi>::Block

Block type.

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

Transaction hash type.

type InPoolTransaction = Transaction<<BasicPool<PoolApi, Block> as TransactionPool>::Hash, <<BasicPool<PoolApi, Block> as TransactionPool>::Block as Block>::Extrinsic>

In-pool transaction type.

type Error = <PoolApi as ChainApi>::Error

Error type.

fn submit_at(
    &self,
    at: &BlockId<Self::Block>,
    source: TransactionSource,
    xts: Vec<TransactionFor<Self>>
) -> PoolFuture<Vec<Result<TxHash<Self>, Self::Error>>, Self::Error>

Returns a future that imports a bunch of unverified transactions to the pool.

fn submit_one(
    &self,
    at: &BlockId<Self::Block>,
    source: TransactionSource,
    xt: TransactionFor<Self>
) -> PoolFuture<TxHash<Self>, Self::Error>

Returns a future that imports one unverified transaction to the pool.

fn submit_and_watch(
    &self,
    at: &BlockId<Self::Block>,
    source: TransactionSource,
    xt: TransactionFor<Self>
) -> PoolFuture<Pin<Box<TransactionStatusStreamFor<Self>>>, Self::Error>

Returns a future that import a single transaction and starts to watch their progress in the pool.

fn remove_invalid(
    &self,
    hashes: &[TxHash<Self>]
) -> Vec<Arc<Self::InPoolTransaction>>

Remove transactions identified by given hashes (and dependent transactions) from the pool.

fn status(&self) -> PoolStatus

Returns pool status.

fn import_notification_stream(&self) -> ImportNotificationStream<TxHash<Self>>

Return an event stream of transactions imported to the pool.

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

Returns transaction hash

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

Notify the pool about transactions broadcast.

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

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

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

Get an iterator for ready transactions ordered by priority.

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

Get an iterator for ready transactions ordered by priority.