Module onion_message
Expand description
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§
- Default
Message Router - A
MessageRouterthat can only route to a directly connectedDestination. - Onion
Message Path - A path for sending an
OnionMessage. - Onion
Messenger - A sender, receiver and forwarder of
OnionMessages. - Packet
- Packet of hop data for next peer
- Pending
Onion Message - An
OnionMessageforOnionMessengerto send.
Enums§
- Destination
- The destination of an onion message.
- Offers
Message - Possible BOLT 12 Offers messages sent and received via an
OnionMessage. - Parsed
Onion Message Contents - The contents of an
OnionMessageas read from the wire. - Peeled
Onion - A processed incoming onion message, containing either a Forward (another onion message) or a Receive payload with decrypted contents.
- Send
Error - Errors that may occur when sending an onion message.
Traits§
- Custom
Onion Message Handler - Handler for custom onion messages. If you are using
SimpleArcOnionMessenger,SimpleRefOnionMessenger, or prefer to ignore inbound custom onion messages,IgnoringMessageHandlermust be provided toOnionMessenger::new. Otherwise, a custom implementation of this trait must be provided, withCustomMessagespecifying the supported message types. - Message
Router - A trait defining behavior for routing an
OnionMessage. - Offers
Message Handler - A handler for an
OnionMessagecontaining a BOLT 12 Offers message as its payload. - Onion
Message Contents - The contents of an onion message.
Type Aliases§
- Simple
ArcOnion Messenger - Useful for simplifying the parameters of
SimpleArcChannelManagerandSimpleArcPeerManager. See their docs for more details. - Simple
RefOnion Messenger - Useful for simplifying the parameters of
SimpleRefChannelManagerandSimpleRefPeerManager. See their docs for more details.