Module lightning::onion_message

Onion Messages: sending, receiving, forwarding, and ancillary utilities live here

Onion messages are multi-purpose messages sent between peers over the lightning network. In the near future, they will be used to communicate invoices for offers, unlocking use cases such as static invoices, refunds and proof of payer. Further, you will be able to accept payments without revealing your node id through the use of blinded paths.

LDK sends and receives onion messages via the OnionMessenger. See its documentation for more information on its usage.

Structs

• OnionMessenger
  A sender, receiver and forwarder of onion messages. In upcoming releases, this object will be used to retrieve invoices and fulfill invoice requests from offers. Currently, only sending and receiving custom onion messages is supported.

Enums

• Destination
  The destination of an onion message.
• OnionMessageContents
  The contents of an onion message. In the context of offers, this would be the invoice, invoice request, or invoice error.
• SendError
  Errors that may occur when sending an onion message.

Traits

• CustomOnionMessageContents
  The contents of a custom onion message.
• 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.

Type Definitions

• SimpleArcOnionMessenger
  Useful for simplifying the parameters of SimpleArcChannelManager and SimpleArcPeerManager. See their docs for more details.
• SimpleRefOnionMessenger
  Useful for simplifying the parameters of SimpleRefChannelManager and SimpleRefPeerManager. See their docs for more details.