Struct sc_transaction_pool :: ForkAwareTxPool Copy item path

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, ) -> (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, ) -> (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<Block, Client> LocalTransactionPool for ForkAwareTxPool<FullChainApi<Client, Block>, Block>
where Block: BlockT, <Block as BlockT>::Hash: Unpin, Client: ProvideRuntimeApi<Block> + BlockBackend<Block> + HeaderBackend<Block> + BlockIdTo<Block> + HeaderMetadata<Block, Error = Error> + 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: 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 remove_invalid( &self, hashes: &[TxHash<Self>], ) -> Vec<Arc<Self::InPoolTransaction>>

Intended to remove transactions identified by the given hashes, and any dependent transactions, from the pool. In current implementation this function only outputs the error. Seems that API change is needed here to make this call reasonable.

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.

Auto Trait Implementations§

impl<ChainApi, Block> !UnwindSafe for ForkAwareTxPool<ChainApi, Block>

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CheckedConversion for T

fn checked_from<T>(t: T) -> Option<Self>
where Self: TryFrom<T>,

Convert from a value of T into an equivalent instance of Option<Self>. Read more

fn checked_into<T>(self) -> Option<T>
where Self: TryInto<T>,

Consume self to return Some equivalent value of Option<T>. Read more

impl<T> Conv for T

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more

impl<T> FmtForward for T

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<Src, Dest> IntoTuple<Dest> for Src
where Dest: FromTuple<Src>,

fn into_tuple(self) -> Dest

impl<T, Outer> IsWrappedBy<Outer> for T
where Outer: AsRef<T> + AsMut<T> + From<T>, T: From<Outer>,

fn from_ref(outer: &Outer) -> &T

Get a reference to the inner from the outer.

fn from_mut(outer: &mut Outer) -> &mut T

Get a mutable reference to the inner from the outer.

impl<T> Pipe for T
where T: ?Sized,

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.

impl<T> Pointable for T

const ALIGN: usize = _

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> Same for T

type Output = T

Should always be Self

impl<T> SaturatedConversion for T

fn saturated_from<T>(t: T) -> Self
where Self: UniqueSaturatedFrom<T>,

Convert from a value of T into an equivalent instance of Self. Read more

fn saturated_into<T>(self) -> T
where Self: UniqueSaturatedInto<T>,

Consume self to return an equivalent value of T. Read more

impl<T> Tap for T

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more

fn tap_borrow(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow, B: ?Sized,

Immutable access to the Borrow of a value. Read more

fn tap_borrow_mut(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut, B: ?Sized,

Mutable access to the BorrowMut of a value. Read more

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.

fn tap_borrow_dbg(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.

fn tap_borrow_mut_dbg(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.

impl<T> TryConv for T

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more

impl<T, U> TryFrom for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

impl<T, U> TryInto for T
where U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<S, T> UncheckedInto<T> for S
where T: UncheckedFrom<S>,

fn unchecked_into(self) -> T

The counterpart to unchecked_from.

impl<T, S> UniqueSaturatedInto<T> for S
where T: Bounded, S: TryInto<T>,

fn unique_saturated_into(self) -> T

Consume self to return an equivalent value of T.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more