Enum ldk_node::Event

pub enum Event {
    PaymentSuccessful {
        payment_hash: PaymentHash,
    },
    PaymentFailed {
        payment_hash: PaymentHash,
    },
    PaymentReceived {
        payment_hash: PaymentHash,
        amount_msat: u64,
    },
    ChannelPending {
        channel_id: ChannelId,
        user_channel_id: UserChannelId,
        former_temporary_channel_id: ChannelId,
        counterparty_node_id: PublicKey,
        funding_txo: OutPoint,
    },
    ChannelReady {
        channel_id: ChannelId,
        user_channel_id: UserChannelId,
        counterparty_node_id: Option<PublicKey>,
    },
    ChannelClosed {
        channel_id: ChannelId,
        user_channel_id: UserChannelId,
        counterparty_node_id: Option<PublicKey>,
    },
}

An event emitted by Node, which should be handled by the user.

Variants

PaymentSuccessful

Fields

payment_hash: PaymentHash

The hash of the payment.

A sent payment was successful.

PaymentFailed

Fields

payment_hash: PaymentHash

The hash of the payment.

A sent payment has failed.

PaymentReceived

Fields

payment_hash: PaymentHash

The hash of the payment.

amount_msat: u64

The value, in thousandths of a satoshi, that has been received.

A payment has been received.

ChannelPending

Fields

channel_id: ChannelId

The channel_id of the channel.

user_channel_id: UserChannelId

The user_channel_id of the channel.

former_temporary_channel_id: ChannelId

The temporary_channel_id this channel used to be known by during channel establishment.

counterparty_node_id: PublicKey

The node_id of the channel counterparty.

funding_txo: OutPoint

The outpoint of the channel’s funding transaction.

A channel has been created and is pending confirmation on-chain.

ChannelReady

Fields

channel_id: ChannelId

The channel_id of the channel.

user_channel_id: UserChannelId

The user_channel_id of the channel.

counterparty_node_id: Option<PublicKey>

The node_id of the channel counterparty.

This will be None for events serialized by LDK Node XXX TODO and prior.

A channel is ready to be used.

ChannelClosed

Fields

channel_id: ChannelId

The channel_id of the channel.

user_channel_id: UserChannelId

The user_channel_id of the channel.

counterparty_node_id: Option<PublicKey>

The node_id of the channel counterparty.

This will be None for events serialized by LDK Node XXX TODO and prior.

A channel has been closed.

Trait Implementations

impl Clone for Event

fn clone(&self) -> Event

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Event

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

Formats the value using the given formatter.

impl PartialEq for Event

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Readable for Event

fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError>

Reads a Self in from the given Read.

impl Writeable for Event

fn write<W: Writer>(&self, writer: &mut W) -> Result<(), Error>

Writes self out to the given Writer.

fn encode(&self) -> Vec<u8>

Writes self out to a Vec<u8>.

fn serialized_length(&self) -> usize

Gets the length of this object after it has been serialized. This can be overridden to optimize cases where we prepend an object with its length.

impl Eq for Event

impl StructuralEq for Event

impl StructuralPartialEq for Event