Fix create_onion_message return type documentation
authorJeffrey Czyz <jkczyz@gmail.com>
Fri, 8 Dec 2023 04:25:25 +0000 (22:25 -0600)
committerJeffrey Czyz <jkczyz@gmail.com>
Fri, 8 Dec 2023 04:25:25 +0000 (22:25 -0600)
lightning/src/onion_message/messenger.rs

index 05ea7a2853cd6bf6c415bde58c4dea0e32acb999..52acc20d477614fc536ca9db770b18d96715ea76 100644 (file)
@@ -459,7 +459,8 @@ pub enum PeeledOnion<T: OnionMessageContents> {
 /// Creates an [`OnionMessage`] with the given `contents` for sending to the destination of
 /// `path`.
 ///
-/// Returns both the node id of the peer to send the message to and the message itself.
+/// Returns the node id of the peer to send the message to, the message itself, and any addresses
+/// need to connect to the first node.
 pub fn create_onion_message<ES: Deref, NS: Deref, T: OnionMessageContents>(
        entropy_source: &ES, node_signer: &NS, secp_ctx: &Secp256k1<secp256k1::All>,
        path: OnionMessagePath, contents: T, reply_path: Option<BlindedPath>,