pub enum TransactionStatus<Hash, BlockHash> {
Future,
Ready,
Broadcast(Vec<String>),
InBlock((BlockHash, TxIndex)),
Retracted(BlockHash),
FinalityTimeout(BlockHash),
Finalized((BlockHash, TxIndex)),
Usurped(Hash),
Dropped,
Invalid,
}
Expand description
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:
- Entering/Moving within the pool:
-
Future
-Ready
- Inside
Ready
queue: -Broadcast
- 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.
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.
- 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.
- Transaction
Dropped
at one point, may later re-enter the pool if some other transactions are removed. Invalid
transaction may become valid at some point in the future. (Note that runtimes are encouraged to useUnknownValidity
to inform the pool about such case).Retracted
transactions might be included in some next block.
The stream is considered finished only when either 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 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. If you choose to wait for finality longer, you can
re-subscribe for a particular transaction hash manually again.
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.
Trait Implementations§
source§impl<Hash: Clone, BlockHash: Clone> Clone for TransactionStatus<Hash, BlockHash>
impl<Hash: Clone, BlockHash: Clone> Clone for TransactionStatus<Hash, BlockHash>
source§fn clone(&self) -> TransactionStatus<Hash, BlockHash>
fn clone(&self) -> TransactionStatus<Hash, BlockHash>
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl<'de, Hash, BlockHash> Deserialize<'de> for TransactionStatus<Hash, BlockHash>where
Hash: Deserialize<'de>,
BlockHash: Deserialize<'de>,
impl<'de, Hash, BlockHash> Deserialize<'de> for TransactionStatus<Hash, BlockHash>where Hash: Deserialize<'de>, BlockHash: Deserialize<'de>,
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,
source§impl<Hash: PartialEq, BlockHash: PartialEq> PartialEq<TransactionStatus<Hash, BlockHash>> for TransactionStatus<Hash, BlockHash>
impl<Hash: PartialEq, BlockHash: PartialEq> PartialEq<TransactionStatus<Hash, BlockHash>> for TransactionStatus<Hash, BlockHash>
source§fn eq(&self, other: &TransactionStatus<Hash, BlockHash>) -> bool
fn eq(&self, other: &TransactionStatus<Hash, BlockHash>) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl<Hash, BlockHash> Serialize for TransactionStatus<Hash, BlockHash>where
Hash: Serialize,
BlockHash: Serialize,
impl<Hash, BlockHash> Serialize for TransactionStatus<Hash, BlockHash>where Hash: Serialize, BlockHash: Serialize,
impl<Hash, BlockHash> StructuralPartialEq for TransactionStatus<Hash, BlockHash>
Auto Trait Implementations§
impl<Hash, BlockHash> RefUnwindSafe for TransactionStatus<Hash, BlockHash>where BlockHash: RefUnwindSafe, Hash: RefUnwindSafe,
impl<Hash, BlockHash> Send for TransactionStatus<Hash, BlockHash>where BlockHash: Send, Hash: Send,
impl<Hash, BlockHash> Sync for TransactionStatus<Hash, BlockHash>where BlockHash: Sync, Hash: Sync,
impl<Hash, BlockHash> Unpin for TransactionStatus<Hash, BlockHash>where BlockHash: Unpin, Hash: Unpin,
impl<Hash, BlockHash> UnwindSafe for TransactionStatus<Hash, BlockHash>where BlockHash: UnwindSafe, Hash: UnwindSafe,
Blanket Implementations§
source§impl<T> CheckedConversion for T
impl<T> CheckedConversion for T
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere T: Any,
§fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
§impl<T> SaturatedConversion for T
impl<T> SaturatedConversion for T
§fn saturated_from<T>(t: T) -> Selfwhere
Self: UniqueSaturatedFrom<T>,
fn saturated_from<T>(t: T) -> Selfwhere Self: UniqueSaturatedFrom<T>,
§fn saturated_into<T>(self) -> Twhere
Self: UniqueSaturatedInto<T>,
fn saturated_into<T>(self) -> Twhere Self: UniqueSaturatedInto<T>,
T
. Read more§impl<S, T> UncheckedInto<T> for Swhere
T: UncheckedFrom<S>,
impl<S, T> UncheckedInto<T> for Swhere T: UncheckedFrom<S>,
§fn unchecked_into(self) -> T
fn unchecked_into(self) -> T
unchecked_from
.§impl<T, S> UniqueSaturatedInto<T> for Swhere
T: Bounded,
S: TryInto<T>,
impl<T, S> UniqueSaturatedInto<T> for Swhere T: Bounded, S: TryInto<T>,
§fn unique_saturated_into(self) -> T
fn unique_saturated_into(self) -> T
T
.