Enum WalletEvent

#[non_exhaustive]
pub enum WalletEvent {
    ChainTipChanged {
        old_tip: BlockId,
        new_tip: BlockId,
    },
    TxConfirmed {
        txid: Txid,
        tx: Arc<Transaction>,
        block_time: ConfirmationBlockTime,
        old_block_time: Option<ConfirmationBlockTime>,
    },
    TxUnconfirmed {
        txid: Txid,
        tx: Arc<Transaction>,
        old_block_time: Option<ConfirmationBlockTime>,
    },
    TxReplaced {
        txid: Txid,
        tx: Arc<Transaction>,
        conflicts: Vec<(usize, Txid)>,
    },
    TxDropped {
        txid: Txid,
        tx: Arc<Transaction>,
    },
}

Events representing changes to wallet transactions.

Returned after calling Wallet::apply_update_events.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

ChainTipChanged

The latest chain tip known to the wallet changed.

Fields

old_tip: BlockId

Previous chain tip.

new_tip: BlockId

New chain tip.

TxConfirmed

A transaction is now confirmed.

If the transaction was previously unconfirmed old_block_time will be None.

If a confirmed transaction is now re-confirmed in a new block old_block_time will contain the block id and the time it was previously confirmed. This can happen after a chain reorg.

Fields

txid: Txid

Transaction id.

tx: Arc<Transaction>

Transaction.

block_time: ConfirmationBlockTime

Confirmation block time.

old_block_time: Option<ConfirmationBlockTime>

Old confirmation block and time if previously confirmed in a different block.

TxUnconfirmed

A transaction is now unconfirmed.

If the transaction is first seen in the mempool old_block_time will be None.

If a previously confirmed transaction is now seen in the mempool old_block_time will contain the block id and the time it was previously confirmed. This can happen after a chain reorg.

Fields

txid: Txid

Transaction id.

tx: Arc<Transaction>

Transaction.

old_block_time: Option<ConfirmationBlockTime>

Old confirmation block and time, if previously confirmed.

TxReplaced

An unconfirmed transaction was replaced.

This can happen after an RBF is broadcast or if a third party double spends an input of a received payment transaction before it is confirmed.

The conflicts field contains the txid and vin (in which it conflicts) of the conflicting transactions.

Fields

txid: Txid

Transaction id.

tx: Arc<Transaction>

Transaction.

conflicts: Vec<(usize, Txid)>

Conflicting transaction ids.

TxDropped

Unconfirmed transaction dropped.

The transaction was dropped from the local mempool. This is generally due to the fee rate being too low. The transaction can still reappear in the mempool in the future resulting in a WalletEvent::TxUnconfirmed event.

Fields

txid: Txid

Transaction id.

tx: Arc<Transaction>

Transaction.

Trait Implementations

impl Clone for WalletEvent

fn clone(&self) -> WalletEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WalletEvent

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

Formats the value using the given formatter.

impl PartialEq for WalletEvent

fn eq(&self, other: &WalletEvent) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for WalletEvent

impl StructuralPartialEq for WalletEvent