Module events

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.

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.

ReplayEvent

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

BumpTransactionEvent

Represents the different types of transactions, originating from LDK, to be bumped.

ClosureReason

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.

FundingInfo

FundingInfo holds information about a channel’s funding transaction.

HTLCDestination

Intended destination of a failed HTLC as indicated in Event::HTLCHandlingFailed.

InboundChannelFunds

Used to indicate the kind of funding for this channel by the channel acceptor (us).

MessageSendEvent

An event generated by ChannelManager which indicates a message should be sent to a peer (or broadcast to most peers). These events are handled by PeerManager::process_events if you are using a PeerManager.

PathFailure

When the payment path failure took place and extra details about it. PathFailure::OnPath may contain a NetworkUpdate that needs to be applied to the NetworkGraph.

PaymentFailureReason

The reason the payment failed. Used in Event::PaymentFailed.

PaymentPurpose

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

EventHandler

A trait implemented for objects handling events from EventsProvider.

EventsProvider

A trait indicating an object may generate events.

MessageSendEventsProvider

A trait indicating an object may generate message send events