Module lightning::onion_message::messenger

LDK sends, receives, and forwards onion messages via this OnionMessenger, which lives here, as well as various types, traits, and utilities that it uses.

Structs

• DefaultMessageRouter
  A MessageRouter that can only route to a directly connected Destination.
• OnionMessagePath
  A path for sending an OnionMessage.
• OnionMessenger
  A sender, receiver and forwarder of OnionMessages.
• PendingOnionMessageNon-c_bindings
  An OnionMessage for OnionMessenger to send.

Enums

• Destination
  The destination of an onion message.
• PeeledOnion
  A processed incoming onion message, containing either a Forward (another onion message) or a Receive payload with decrypted contents.
• SendError
  Errors that may occur when sending an onion message.
• SendSuccess
  Result of successfully sending an onion message.

Traits

• CustomOnionMessageHandler
  Handler for custom onion messages. If you are using SimpleArcOnionMessenger, SimpleRefOnionMessenger, or prefer to ignore inbound custom onion messages, IgnoringMessageHandler must be provided to OnionMessenger::new. Otherwise, a custom implementation of this trait must be provided, with CustomMessage specifying the supported message types.
• MessageRouter
  A trait defining behavior for routing an OnionMessage.

Functions

• create_onion_message
  Creates an OnionMessage with the given contents for sending to the destination of path.
• create_onion_message_resolving_destination
  Creates an OnionMessage with the given contents for sending to the destination of path, first calling Destination::resolve on path.destination with the given ReadOnlyNetworkGraph.
• peel_onion_message
  Decode one layer of an incoming OnionMessage.

Type Aliases

• SimpleArcOnionMessengerNon-c_bindings
  Useful for simplifying the parameters of SimpleArcChannelManager and SimpleArcPeerManager. See their docs for more details.
• SimpleRefOnionMessengerNon-c_bindings
  Useful for simplifying the parameters of SimpleRefChannelManager and SimpleRefPeerManager. See their docs for more details.