Module lightning::events

source ·
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.

Enums

  • ClosureReason
    The reason the channel was closed. See individual variants more details.
  • Event
    An Event which you should probably take some action in response to.
  • HTLCDestination
    Intended destination of a failed HTLC as indicated in Event::HTLCHandlingFailed.
  • 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