Struct sc_transaction_graph::base_pool::BasePool

pub struct BasePool<Hash: Hash + Eq, Ex> { /* private fields */ }

Transaction pool.

Builds a dependency graph for all transactions in the pool and returns the ones that are currently ready to be executed.

General note: If function returns some transactions it usually means that importing them as-is for the second time will fail or produce unwanted results. Most likely it is required to revalidate them and recompute set of required tags.

Implementations

impl<Hash: Hash + Member + Serialize, Ex: Debug> BasePool<Hash, Ex>

pub fn new(reject_future_transactions: bool) -> Self

Create new pool given reject_future_transactions flag.

pub fn is_imported(&self, tx_hash: &Hash) -> bool

Returns if the transaction for the given hash is already imported.

pub fn import(
    &mut self,
    tx: Transaction<Hash, Ex>
) -> Result<Imported<Hash, Ex>>

Imports transaction to the pool.

The pool consists of two parts: Future and Ready. The former contains transactions that require some tags that are not yet provided by other transactions in the pool. The latter contains transactions that have all the requirements satisfied and are ready to be included in the block.

pub fn ready(&self) -> impl Iterator<Item = Arc<Transaction<Hash, Ex>>>

Returns an iterator over ready transactions in the pool.

pub fn futures(&self) -> impl Iterator<Item = &Transaction<Hash, Ex>>

Returns an iterator over future transactions in the pool.

pub fn by_hashes(
    &self,
    hashes: &[Hash]
) -> Vec<Option<Arc<Transaction<Hash, Ex>>>>

Returns pool transactions given list of hashes.

Includes both ready and future pool. For every hash in the hashes iterator an Option is produced (so the resulting Vec always have the same length).

pub fn ready_by_hash(&self, hash: &Hash) -> Option<Arc<Transaction<Hash, Ex>>>

Returns pool transaction by hash.

pub fn enforce_limits(
    &mut self,
    ready: &Limit,
    future: &Limit
) -> Vec<Arc<Transaction<Hash, Ex>>>

Makes sure that the transactions in the queues stay within provided limits.

Removes and returns worst transactions from the queues and all transactions that depend on them. Technically the worst transaction should be evaluated by computing the entire pending set. We use a simplified approach to remove the transaction that occupies the pool for the longest time.

pub fn remove_subtree(
    &mut self,
    hashes: &[Hash]
) -> Vec<Arc<Transaction<Hash, Ex>>>

Removes all transactions represented by the hashes and all other transactions that depend on them.

Returns a list of actually removed transactions. NOTE some transactions might still be valid, but were just removed because they were part of a chain, you may attempt to re-import them later. NOTE If you want to remove ready transactions that were already used and you don’t want them to be stored in the pool use prune_tags method.

pub fn clear_future(&mut self) -> Vec<Arc<Transaction<Hash, Ex>>>

Removes and returns all transactions from the future queue.

pub fn prune_tags(
    &mut self,
    tags: impl IntoIterator<Item = Tag>
) -> PruneStatus<Hash, Ex>

Prunes transactions that provide given list of tags.

This will cause all transactions that provide these tags to be removed from the pool, but unlike remove_subtree, dependent transactions are not touched. Additional transactions from future queue might be promoted to ready if you satisfy tags that the pool didn’t previously know about.

pub fn status(&self) -> PoolStatus

Get pool status.

Trait Implementations

impl<Hash: Debug + Hash + Eq, Ex: Debug> Debug for BasePool<Hash, Ex>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<Hash: Hash + Member + Serialize, Ex: Debug> Default for BasePool<Hash, Ex>

fn default() -> Self

Returns the “default value” for a type.

impl<Hash: Hash + Eq, Ex> MallocSizeOf for BasePool<Hash, Ex> where
    Hash: MallocSizeOf,
    Ex: MallocSizeOf, 

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>

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.