Enum WalletEvent 

pub enum WalletEvent {
    FundsReceived {
        wallet_id: WalletId,
        asset: Option<AssetId>,
        amount: Amount,
        coin_id: String,
        confirmed_height: u32,
    },
    FundsSent {
        wallet_id: WalletId,
        asset: Option<AssetId>,
        amount: Amount,
        tx_id: String,
        confirmed_height: u32,
    },
    CoinStateChanged {
        coin_id: String,
        spent: bool,
        created_height: Option<u32>,
        spent_height: Option<u32>,
    },
    Confirmation {
        tx_id: String,
        height: u32,
    },
    TransactionFailed {
        tx_id: String,
        error: String,
    },
    NewTip {
        height: u32,
        header_hash: String,
    },
    SyncProgress {
        wallet_id: WalletId,
        state: SyncLifecycle,
        peak_height: u32,
        target_height: u32,
    },
    CatInfo {
        asset_id: AssetId,
        name: Option<String>,
    },
    DidInfo {
        launcher_id: String,
    },
    NftData {
        launcher_id: String,
    },
    Derivation {
        wallet_id: WalletId,
        index: u32,
    },
}

The event the engine emits and apps consume.

Tagged by type in snake_case on the wire ({"type":"funds_received",…}), so a machine consumer branches on a stable discriminant.

Variants

FundsReceived

Inbound value landed for a wallet.

Fields

wallet_id: WalletId

The wallet that received value.

asset: Option<AssetId>

The asset received; None = native XCH.

amount: Amount

The amount received.

coin_id: String

The receiving coin id (hex).

confirmed_height: u32

The confirmation height.

FundsSent

Outbound value confirmed for a wallet.

Fields

wallet_id: WalletId

The wallet that sent value.

asset: Option<AssetId>

The asset sent; None = native XCH.

amount: Amount

The amount sent.

tx_id: String

The transaction id (hex).

confirmed_height: u32

The confirmation height.

CoinStateChanged

A tracked coin changed state.

Fields

coin_id: String

The affected coin id (hex).

spent: bool

Whether the coin is now spent.

created_height: Option<u32>

The height it was created at, if known.

spent_height: Option<u32>

The height it was spent at, if spent.

Confirmation

A submitted transaction confirmed on-chain.

Fields

tx_id: String

The transaction id (hex).

height: u32

The confirmation height.

TransactionFailed

A submitted transaction failed (rejected or never confirmed).

Fields

tx_id: String

The transaction id (hex).

error: String

A human-readable failure reason.

NewTip

A new chain tip was observed.

Fields

height: u32

The tip height.

header_hash: String

The tip header hash (hex).

SyncProgress

Sync progress advanced for a wallet.

Fields

wallet_id: WalletId

The wallet whose sync advanced.

state: SyncLifecycle

The current lifecycle state.

peak_height: u32

The processed height.

target_height: u32

The tip height being synced toward.

CatInfo

CAT metadata for an asset became available.

Fields

asset_id: AssetId

The CAT asset id.

name: Option<String>

The resolved ticker/name.

DidInfo

DID metadata became available.

Fields

launcher_id: String

The DID launcher id (hex).

NftData

NFT data became available.

Fields

launcher_id: String

The NFT launcher id (hex).

Derivation

A new HD receive address became active.

Fields

wallet_id: WalletId

The wallet the address belongs to.

index: u32

The newly-active derivation index.

Implementations

impl WalletEvent

pub fn kind(&self) -> EventKind

The EventKind discriminant used for subscription filtering.

pub fn matches(&self, filter: EnumSet<EventKind>) -> bool

Whether this event passes a subscription filter (an EnumSet of kinds).

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<'de> Deserialize<'de> for WalletEvent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for WalletEvent

impl PartialEq for WalletEvent

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for WalletEvent

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for WalletEvent