Enum SdkEvent 

pub enum SdkEvent {
    Synced,
    UnclaimedDeposits {
        unclaimed_deposits: Vec<DepositInfo>,
    },
    ClaimedDeposits {
        claimed_deposits: Vec<DepositInfo>,
    },
    PaymentSucceeded {
        payment: Payment,
    },
    PaymentPending {
        payment: Payment,
    },
    PaymentFailed {
        payment: Payment,
    },
    AutoOptimization {
        optimization_event: AutoOptimizationEvent,
    },
    LightningAddressChanged {
        lightning_address: Option<LightningAddressInfo>,
    },
    NewDeposits {
        new_deposits: Vec<DepositInfo>,
    },
    UnilateralExitStateChanged,
}

Events emitted by the SDK

Variants

Synced

Emitted when the wallet has been synchronized with the network

UnclaimedDeposits

Emitted when the SDK was unable to claim deposits. Each deposit carries a claim_error with the reason.

Fields

unclaimed_deposits: Vec<DepositInfo>

ClaimedDeposits

Emitted when deposits were claimed into the wallet. The resulting payment is emitted separately as PaymentSucceeded.

Fields

claimed_deposits: Vec<DepositInfo>

PaymentSucceeded

Emitted when a payment completed. The cached balance is refreshed before this event, so get_info returns the new value.

Fields

payment: Payment

PaymentPending

Emitted when a payment is in flight. The same payment is emitted again as succeeded or failed once it settles.

Fields

payment: Payment

PaymentFailed

Emitted when a payment failed.

Fields

payment: Payment

AutoOptimization

Emitted while the background auto-optimizer is running.

Only fired from the auto path (enabled via LeafOptimizationConfig::auto_enabled). Manually-triggered runs via BreezSdk::optimize_leaves do not emit events: they return an OptimizationOutcome instead.

Fields

optimization_event: AutoOptimizationEvent

LightningAddressChanged

Emitted when the Lightning address changed on another device. The address is unset when it was deleted.

Fields

lightning_address: Option<LightningAddressInfo>

NewDeposits

Emitted when on-chain deposits are detected. Only deposits whose is_mature is set have enough confirmations to be claimed.

Fields

new_deposits: Vec<DepositInfo>

UnilateralExitStateChanged

Emitted when the data a unilateral exit is built from has changed, so an exit state exported earlier is out of date and should be exported again.

Trait Implementations

impl Clone for SdkEvent

fn clone(&self) -> SdkEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SdkEvent

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

Formats the value using the given formatter.

impl Display for SdkEvent

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

Formats the value using the given formatter.

impl Serialize for SdkEvent

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

where __S: Serializer,

Serialize this value into the given Serde serializer.