Enum sc_transaction_pool_api::TransactionStatus

pub enum TransactionStatus<Hash, BlockHash> {
    Future,
    Ready,
    Broadcast(Vec<String>),
    InBlock((BlockHash, TxIndex)),
    Retracted(BlockHash),
    FinalityTimeout(BlockHash),
    Finalized((BlockHash, TxIndex)),
    Usurped(Hash),
    Dropped,
    Invalid,
}

Possible transaction status events.

This events are being emitted by TransactionPool watchers, which are also exposed over RPC.

The status events can be grouped based on their kinds as:

1. Entering/Moving within the pool: - Future - Ready
2. Inside Ready queue: - Broadcast
3. Leaving the pool: - InBlock - Invalid - Usurped - Dropped 4. Re-entering the pool: - Retracted 5. Block finalized: - Finalized - FinalityTimeout

Transactions are first placed in either the Ready or Future queues of the transaction pool. Substrate validates the transaction before it enters the pool.

A transaction is placed in the Future queue if it will become valid at a future time. For example, submitting a transaction with a higher account nonce than the current expected nonce will place the transaction in the Future queue.

The events will always be received in the order described above, however there might be cases where transactions alternate between Future and Ready pool, and are Broadcast in the meantime.

There is also only single event causing the transaction to leave the pool. I.e. only one of the listed ones should be triggered.

Note that there are conditions that may cause transactions to reappear in the pool.

1. Due to possible forks, the transaction that ends up being in included in one block, may later re-enter the pool or be marked as invalid.
2. Transaction Dropped at one point, may later re-enter the pool if some other transactions are removed. A Dropped transaction may re-enter the pool only if it is resubmitted.
3. Invalid transaction may become valid at some point in the future. (Note that runtimes are encouraged to use UnknownValidity to inform the pool about such case). An Invalid transaction may re-enter the pool only if it is resubmitted.
4. Retracted transactions might be included in some next block.

The FinalityTimeout event will be emitted when the block did not reach finality within 512 blocks. This either indicates that finality is not available for your chain, or that finality gadget is lagging behind. If you choose to wait for finality longer, you can re-subscribe for a particular transaction hash manually again.

Last Event

The stream is considered finished when one of the following events happen:

• Finalized
• FinalityTimeout
• Usurped
• Invalid
• Dropped

See TransactionStatus::is_final for more details.

Resubmit Transactions

Users might resubmit the transaction at a later time for the following events:

• FinalityTimeout
• Invalid
• Dropped

See TransactionStatus::is_retriable for more details.

Variants

Future

Transaction is part of the future queue.

Ready

Transaction is part of the ready queue.

Broadcast(Vec<String>)

The transaction has been broadcast to the given peers.

InBlock((BlockHash, TxIndex))

Transaction has been included in block with given hash at the given position.

Retracted(BlockHash)

The block this transaction was included in has been retracted.

FinalityTimeout(BlockHash)

Maximum number of finality watchers has been reached, old watchers are being removed.

Finalized((BlockHash, TxIndex))

Transaction has been finalized by a finality-gadget, e.g GRANDPA.

Usurped(Hash)

Transaction has been replaced in the pool, by another transaction that provides the same tags. (e.g. same (sender, nonce)).

Dropped

Transaction has been dropped from the pool because of the limit.

Invalid

Transaction is no longer valid in the current state.

Implementations

impl<Hash, BlockHash> TransactionStatus<Hash, BlockHash>

pub fn is_final(&self) -> bool

Returns true if this is the last event emitted by TransactionStatusStream.

pub fn is_retriable(&self) -> bool

Returns true if the transaction could be re-submitted to the pool in the future.

For example, TransactionStatus::Dropped is retriable, because the transaction may enter the pool if there is space for it in the future.

Trait Implementations

impl<Hash: Clone, BlockHash: Clone> Clone for TransactionStatus<Hash, BlockHash>

fn clone(&self) -> TransactionStatus<Hash, BlockHash>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<Hash: Debug, BlockHash: Debug> Debug for TransactionStatus<Hash, BlockHash>

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

Formats the value using the given formatter.

impl<'de, Hash, BlockHash> Deserialize<'de> for TransactionStatus<Hash, BlockHash>

where Hash: Deserialize<'de>, BlockHash: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<Hash: PartialEq, BlockHash: PartialEq> PartialEq for TransactionStatus<Hash, BlockHash>

fn eq(&self, other: &TransactionStatus<Hash, BlockHash>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<Hash, BlockHash> Serialize for TransactionStatus<Hash, BlockHash>

where Hash: Serialize, BlockHash: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<Hash, BlockHash> StructuralPartialEq for TransactionStatus<Hash, BlockHash>