Struct breez_sdk_liquid::lightning::onion_message::OnionMessenger

pub struct OnionMessenger<ES, NS, L, MR, OMH, CMH>
where
    ES: Deref,
    NS: Deref,
    L: Deref,
    MR: Deref,
    OMH: Deref,
    CMH: Deref,
    <ES as Deref>::Target: EntropySource,
    <NS as Deref>::Target: NodeSigner,
    <L as Deref>::Target: Logger,
    <MR as Deref>::Target: MessageRouter,
    <OMH as Deref>::Target: OffersMessageHandler,
    <CMH as Deref>::Target: CustomOnionMessageHandler,
{ /* private fields */ }

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.

Example

// Create the onion messenger. This must use the same `keys_manager` as is passed to your
// ChannelManager.
let onion_messenger = OnionMessenger::new(
    &keys_manager, &keys_manager, logger, message_router, &offers_message_handler,
    &custom_message_handler
);

impl Writeable for YourCustomMessage {
	fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
		// Write your custom onion message to `w`
	}
}
impl CustomOnionMessageContents for YourCustomMessage {
	fn tlv_type(&self) -> u64 {
		your_custom_message_type
	}
}
// Send a custom onion message to a node id.
let path = OnionMessagePath {
	intermediate_nodes: vec![hop_node_id1, hop_node_id2],
	destination: Destination::Node(destination_node_id),
};
let reply_path = None;
let message = OnionMessageContents::Custom(your_custom_message);
onion_messenger.send_onion_message(path, message, reply_path);

// Create a blinded path to yourself, for someone to send an onion message to.
let hops = [hop_node_id3, hop_node_id4, your_node_id];
let blinded_path = BlindedPath::new_for_message(&hops, &keys_manager, &secp_ctx).unwrap();

// Send a custom onion message to a blinded path.
let path = OnionMessagePath {
	intermediate_nodes: vec![hop_node_id1, hop_node_id2],
	destination: Destination::BlindedPath(blinded_path),
};
let reply_path = None;
let message = OnionMessageContents::Custom(your_custom_message);
onion_messenger.send_onion_message(path, message, reply_path);

Implementations

impl<ES, NS, L, MR, OMH, CMH> OnionMessenger<ES, NS, L, MR, OMH, CMH>

where ES: Deref, NS: Deref, L: Deref, MR: Deref, OMH: Deref, CMH: Deref, <ES as Deref>::Target: EntropySource, <NS as Deref>::Target: NodeSigner, <L as Deref>::Target: Logger, <MR as Deref>::Target: MessageRouter, <OMH as Deref>::Target: OffersMessageHandler, <CMH as Deref>::Target: CustomOnionMessageHandler,

pub fn new( entropy_source: ES, node_signer: NS, logger: L, message_router: MR, offers_handler: OMH, custom_handler: CMH, ) -> OnionMessenger<ES, NS, L, MR, OMH, CMH>

Constructs a new OnionMessenger to send, forward, and delegate received onion messages to their respective handlers.

pub fn send_onion_message<T>( &self, path: OnionMessagePath, message: OnionMessageContents<T>, reply_path: Option<BlindedPath>, ) -> Result<(), SendError>

where T: CustomOnionMessageContents,

Send an onion message with contents message to the destination of path.

See OnionMessenger for example usage.

Trait Implementations

impl<ES, NS, L, MR, OMH, CMH> OnionMessageHandler for OnionMessenger<ES, NS, L, MR, OMH, CMH>

where ES: Deref, NS: Deref, L: Deref, MR: Deref, OMH: Deref, CMH: Deref, <ES as Deref>::Target: EntropySource, <NS as Deref>::Target: NodeSigner, <L as Deref>::Target: Logger, <MR as Deref>::Target: MessageRouter, <OMH as Deref>::Target: OffersMessageHandler, <CMH as Deref>::Target: CustomOnionMessageHandler,

fn handle_onion_message(&self, _peer_node_id: &PublicKey, msg: &OnionMessage)

Handle an incoming onion message. Currently, if a message was destined for us we will log, but soon we’ll delegate the onion message to a handler that can generate invoices or send payments.

fn peer_connected( &self, their_node_id: &PublicKey, init: &Init, _inbound: bool, ) -> Result<(), ()>

Called when a connection is established with a peer. Can be used to track which peers advertise onion message support and are online.

fn peer_disconnected(&self, their_node_id: &PublicKey)

Indicates a connection to the peer failed/an existing connection was lost. Allows handlers to drop and refuse to forward onion messages to this peer.

fn provided_node_features(&self) -> Features<NodeContext>

Gets the node feature flags which this handler itself supports. All available handlers are queried similarly and their feature flags are OR’d together to form the NodeFeatures which are broadcasted in our NodeAnnouncement message.

fn provided_init_features( &self, _their_node_id: &PublicKey, ) -> Features<InitContext>

Gets the init feature flags which should be sent to the given peer. All available handlers are queried similarly and their feature flags are OR’d together to form the InitFeatures which are sent in our Init message.

impl<ES, NS, L, MR, OMH, CMH> OnionMessageProvider for OnionMessenger<ES, NS, L, MR, OMH, CMH>

where ES: Deref, NS: Deref, L: Deref, MR: Deref, OMH: Deref, CMH: Deref, <ES as Deref>::Target: EntropySource, <NS as Deref>::Target: NodeSigner, <L as Deref>::Target: Logger, <MR as Deref>::Target: MessageRouter, <OMH as Deref>::Target: OffersMessageHandler, <CMH as Deref>::Target: CustomOnionMessageHandler,

fn next_onion_message_for_peer( &self, peer_node_id: PublicKey, ) -> Option<OnionMessage>

Gets the next pending onion message for the peer with the given node id.