Add additional documentation on when to use `NodeIdMessageRouter`
What the developer wrote
Authored by Matt Corallo
Add additional documentation on when to use `NodeIdMessageRouter`
What changed, and why it matters
This commit only adds a three-line documentation comment explaining when developers might want to use a specific message-routing helper. It does not change any code behavior, fix a bug, or alter security logic.
No action needed; this is a documentation-only change with no security relevance.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff adds a doc comment to NodeIdMessageRouter in lightning/src/onion_message/messenger.rs describing its usefulness for long-lived blinded paths when channels may close but peer connections remain stable. No code, types, or control flow were modified.
Changed components
lightning/src/onion_message/messenger.rs documentationInspect captured patch +3 / −0
diff --git a/lightning/src/onion_message/messenger.rs b/lightning/src/onion_message/messenger.rs
index a61abae..dbeab39 100644
--- a/lightning/src/onion_message/messenger.rs
+++ b/lightning/src/onion_message/messenger.rs
@@ -772,6 +772,9 @@ where
/// [`DefaultMessageRouter`] for deciding when to add additional dummy hops to the generated blinded
/// paths.
///
+/// This may be useful in cases where you want a long-lived blinded path and anticipate channel(s)
+/// may close, but connections to specific peers will remain stable.
+///
/// This message router can only route to a directly connected [`Destination`].
///
/// # Privacy
Why this scored 15/100
Community notes
Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.
The AI analysis stands alone for now. Submit a note if you can add evidence or important context.