Struct sc_transaction_pool::BasicPool

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

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

Methods

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

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

Create new basic transaction pool with provided api.

It will also optionally return background task that might be started by the caller.

pub fn with_revalidation_type(
    options: Options,
    pool_api: Arc<PoolApi>,
    revalidation_type: RevalidationType
) -> (Self, Option<Pin<Box<dyn Future<Output = ()> + Send>>>)

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.

Trait Implementations

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

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, Hash = Block::Hash>,
    PoolApi::Hash: MallocSizeOf,
    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.

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

type Block = PoolApi::Block

Block type.

type Hash = ExHash<PoolApi>

Transaction hash type.

type InPoolTransaction = Transaction<TxHash<Self>, TransactionFor<Self>>

In-pool transaction type.

type Error = PoolApi::Error

Error type.

fn submit_at(
    &self,
    at: &BlockId<Self::Block>,
    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>,
    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>,
    xt: TransactionFor<Self>
) -> PoolFuture<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 ready(&self) -> Box<dyn Iterator<Item = Arc<Self::InPoolTransaction>>>

Get an iterator for ready transactions ordered by priority

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.