Enum WalletEvent

#[non_exhaustive]
pub enum WalletEvent {
    ChainTipChanged {
        old_tip: BlockId,
        new_tip: BlockId,
    },
    TxConfirmed {
        txid: Arc<Txid>,
        tx: Arc<Transaction>,
        block_time: ConfirmationBlockTime,
        old_block_time: Option<ConfirmationBlockTime>,
    },
    TxUnconfirmed {
        txid: Arc<Txid>,
        tx: Arc<Transaction>,
        old_block_time: Option<ConfirmationBlockTime>,
    },
    TxReplaced {
        txid: Arc<Txid>,
        tx: Arc<Transaction>,
        conflicts: Vec<Conflict>,
    },
    TxDropped {
        txid: Arc<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: Arc<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: Arc<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: Arc<Txid>

Transaction id.

tx: Arc<Transaction>

Transaction.

conflicts: Vec<Conflict>

Conflicting transactions.

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: Arc<Txid>

Transaction id.

tx: Arc<Transaction>

Transaction.

Trait Implementations

impl Clone for WalletEvent

fn clone(&self) -> WalletEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<UT> ConvertError<UT> for WalletEvent

fn try_convert_unexpected_callback_error( e: UnexpectedUniFFICallbackError, ) -> Result<Self>

impl Debug for WalletEvent

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

Formats the value using the given formatter.

impl Display for WalletEvent

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

Formats the value using the given formatter.

impl<UT> FfiConverter<UT> for WalletEvent

const TYPE_ID_META: MetadataBuffer

Type ID metadata, serialized into a [MetadataBuffer].

type FfiType = RustBuffer

The low-level type used for passing values of this type over the FFI.

fn lower(v: Self) -> RustBuffer

Lower a rust value of the target type, into an FFI value of type Self::FfiType.

fn try_lift(buf: RustBuffer) -> Result<Self>

Lift a rust value of the target type, from an FFI value of type Self::FfiType.

fn write(obj: Self, buf: &mut Vec<u8>)

Write a rust value into a buffer, to send over the FFI in serialized form.

fn try_read(buf: &mut &[u8]) -> Result<Self>

Read a rust value from a buffer, received over the FFI in serialized form.

impl From<WalletEvent> for WalletEvent

fn from(event: BdkWalletEvent) -> Self

Converts to this type from the input type.

impl<UT> Lift<UT> for WalletEvent

type FfiType = <WalletEvent as FfiConverter<UT>>::FfiType

fn try_lift(v: Self::FfiType) -> Result<Self>

fn try_read(buf: &mut &[u8]) -> Result<Self>

fn try_lift_from_rust_buffer(v: RustBuffer) -> Result<Self, Error>

Convenience method

impl<UT> LiftRef<UT> for WalletEvent

type LiftType = WalletEvent

impl<UT> LiftReturn<UT> for WalletEvent

type ReturnType = <WalletEvent as Lift<UT>>::FfiType

FFI return type for trait interfaces

fn try_lift_successful_return(v: Self::ReturnType) -> Result<Self>

Lift a successfully returned value from a trait interface

fn lift_foreign_return( ffi_return: Self::ReturnType, call_status: RustCallStatus, ) -> Self

Lift a foreign returned value from a trait interface

fn lift_error(_buf: RustBuffer) -> Self

Lift a Rust value for a callback interface method error result

fn handle_callback_unexpected_error(e: UnexpectedUniFFICallbackError) -> Self

Lift a Rust value for an unexpected callback interface error

impl<UT> Lower<UT> for WalletEvent

type FfiType = <WalletEvent as FfiConverter<UT>>::FfiType

fn lower(obj: Self) -> Self::FfiType

fn write(obj: Self, buf: &mut Vec<u8>)

fn lower_into_rust_buffer(obj: Self) -> RustBuffer

Convenience method

impl<UT> LowerError<UT> for WalletEvent

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for WalletEvent

type ReturnType = <WalletEvent as Lower<UT>>::FfiType

The type that should be returned by scaffolding functions for this type.

fn lower_return(v: Self) -> Result<Self::ReturnType, RustCallError>

Lower the return value from an scaffolding call

fn handle_failed_lift( error: LiftArgsError, ) -> Result<Self::ReturnType, RustCallError>

Lower the return value for failed argument lifts

impl<UT> TypeId<UT> for WalletEvent

const TYPE_ID_META: MetadataBuffer