Expand description
Events are returned from various bits in the library which indicate some action must be taken by the client.
Because we don’t have a built-in runtime, it’s up to the client to call events at a time in the future, as well as generate and broadcast funding transactions handle payment preimages and a few other things.
Re-exports§
pub use bump_transaction::BumpTransactionEvent;
Modules§
- bump_
transaction - Utilities for bumping transactions originating from
Events.
Structs§
- ClaimedHTLC
- Information about an HTLC that is part of a payment that can be claimed.
- Replay
Event - An error type that may be returned to LDK in order to safely abort event handling if it can’t currently succeed (e.g., due to a persistence failure).
Enums§
- Closure
Reason - The reason the channel was closed. See individual variants for more details.
- Event
- An Event which you should probably take some action in response to.
- Funding
Info FundingInfoholds information about a channel’s funding transaction.- HTLC
Handling Failure Reason - The reason for HTLC failures in
Event::HTLCHandlingFailed. - HTLC
Handling Failure Type - The type of HTLC handling performed in
Event::HTLCHandlingFailed. - Inbound
Channel Funds - Used to indicate the kind of funding for this channel by the channel acceptor (us).
- Paid
Bolt12 Invoice - The BOLT 12 invoice that was paid, surfaced in
Event::PaymentSent::bolt12_invoice. - Path
Failure - When the payment path failure took place and extra details about it.
PathFailure::OnPathmay contain aNetworkUpdatethat needs to be applied to theNetworkGraph. - Payment
Failure Reason - The reason the payment failed. Used in
Event::PaymentFailed. - Payment
Purpose - Some information provided on receipt of payment depends on whether the payment received is a spontaneous payment or a “conventional” lightning payment that’s paying an invoice.
Traits§
- Event
Handler - A trait implemented for objects handling events from
EventsProvider. - Events
Provider - A trait indicating an object may generate events.