Skip to content

Commit 7cd4601

Browse files
committed
Expand MessageForwardNode documentation
Document that MessageForwardNode must represent a node that supports the onion messages feature in order to be used in blinded reply paths.
1 parent 78fee88 commit 7cd4601

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

lightning/src/blinded_path/message.rs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -238,6 +238,12 @@ pub enum NextMessageHop {
238238
}
239239

240240
/// An intermediate node, and possibly a short channel id leading to the next node.
241+
///
242+
/// Note:
243+
/// [`MessageForwardNode`] must represent a node that supports [`supports_onion_messages`]
244+
/// in order to be included in valid blinded paths for onion messaging.
245+
///
246+
/// [`supports_onion_messages`]: crate::types::features::Features::supports_onion_messages
241247
#[derive(Clone, Copy, Debug, Hash, PartialEq, Eq)]
242248
pub struct MessageForwardNode {
243249
/// This node's pubkey.

0 commit comments

Comments
 (0)