Enum subxt::tx::TxStatus

pub enum TxStatus<T: Config, C> {
    Future,
    Ready,
    Broadcast(Vec<String>),
    InBlock(TxInBlock<T, C>),
    Retracted(T::Hash),
    FinalityTimeout(T::Hash),
    Finalized(TxInBlock<T, C>),
    Usurped(T::Hash),
    Dropped,
    Invalid,
}

Possible transaction statuses returned from our TxProgress::next_item() call.

These 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

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.

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 included in one block may later re-enter the pool or be marked as invalid.
2. A transaction that is Dropped at one point may later re-enter the pool if some other transactions are removed.
3. Invalid transactions may become valid at some point in the future. (Note that runtimes are encouraged to use UnknownValidity to inform the pool about such cases).
4. Retracted transactions might be included in a future block.

The stream is considered finished only when either the Finalized or FinalityTimeout event is triggered. You are however free to unsubscribe from notifications at any point. The first one will be emitted when the block in which the transaction was included gets finalized. 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.

Variants

Future

The transaction is part of the “future” queue.

Ready

The transaction is part of the “ready” queue.

Broadcast(Vec<String>)

The transaction has been broadcast to the given peers.

InBlock(TxInBlock<T, C>)

The transaction has been included in a block with given hash.

Retracted(T::Hash)

The block this transaction was included in has been retracted, probably because it did not make it onto the blocks which were finalized.

FinalityTimeout(T::Hash)

A block containing the transaction did not reach finality within 512 blocks, and so the subscription has ended.

Finalized(TxInBlock<T, C>)

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

Usurped(T::Hash)

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

Dropped

The transaction has been dropped from the pool because of the limit.

Invalid

The transaction is no longer valid in the current state.

Implementations

impl<T: Config, C> TxStatus<T, C>

pub fn as_finalized(&self) -> Option<&TxInBlock<T, C>>

A convenience method to return the Finalized details. Returns None if the enum variant is not TxStatus::Finalized.

pub fn as_in_block(&self) -> Option<&TxInBlock<T, C>>

A convenience method to return the InBlock details. Returns None if the enum variant is not TxStatus::InBlock.

Trait Implementations

impl<T: Config, C> Debug for TxStatus<T, C>where C: Debug,

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

Formats the value using the given formatter.