Skip to content

Commit 5892fd6

Browse files
committed
Fix create_onion_message return type documentation
1 parent 2d26679 commit 5892fd6

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

lightning/src/onion_message/messenger.rs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -459,7 +459,8 @@ pub enum PeeledOnion<T: OnionMessageContents> {
459459
/// Creates an [`OnionMessage`] with the given `contents` for sending to the destination of
460460
/// `path`.
461461
///
462-
/// Returns both the node id of the peer to send the message to and the message itself.
462+
/// Returns the node id of the peer to send the message to, the message itself, and any addresses
463+
/// need to connect to the first node.
463464
pub fn create_onion_message<ES: Deref, NS: Deref, T: OnionMessageContents>(
464465
entropy_source: &ES, node_signer: &NS, secp_ctx: &Secp256k1<secp256k1::All>,
465466
path: OnionMessagePath, contents: T, reply_path: Option<BlindedPath>,

0 commit comments

Comments
 (0)