Update OnionMessage with link to BOLTs
What changed, and why it matters
This commit only updates documentation comments and a hyperlink. It replaces a temporary pull-request link for onion messages with the final BOLT-4 specification link and removes two TODO markers. No code behavior changes.
No action required. This is a non-functional documentation cleanup.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff is purely cosmetic: in lightning-types/src/features.rs the OnionMessages feature doc comment now points to BOLT-4 instead of a GitHub PR, and the TODO is removed. In lightning/src/ln/msgs.rs the OnionMessage struct doc comment is reformatted to use a Rustdoc intra-doc link to the same BOLT-4 anchor, removing another TODO. No logic, serialization, network parsing, or cryptographic code is modified.
Changed components
lightning-types/src/features.rs (documentation only)lightning/src/ln/msgs.rs (documentation only)Inspect captured patch +3 / −4
diff --git a/lightning-types/src/features.rs b/lightning-types/src/features.rs
index aca4bb6..77436a2 100644
--- a/lightning-types/src/features.rs
+++ b/lightning-types/src/features.rs
@@ -54,8 +54,7 @@
//! - `SimpleClose` - requires/supports simplified closing negotiation
//! (see [BOLT-2](https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#closing-negotiation-closing_complete-and-closing_sig) for more information).
//! - `OnionMessages` - requires/supports forwarding onion messages
-//! (see [BOLT-7](https://github.com/lightning/bolts/pull/759/files) for more information).
-// TODO: update link
+//! (see [BOLT-4](https://github.com/lightning/bolts/blob/master/04-onion-routing.md#onion-messages) for more information).
//! - `ChannelType` - node supports the channel_type field in open/accept
//! (see [BOLT-2](https://github.com/lightning/bolts/blob/master/02-peer-protocol.md) for more information).
//! - `SCIDPrivacy` - supply channel aliases for routing
diff --git a/lightning/src/ln/msgs.rs b/lightning/src/ln/msgs.rs
index 6d02529..9650b62 100644
--- a/lightning/src/ln/msgs.rs
+++ b/lightning/src/ln/msgs.rs
@@ -767,9 +767,9 @@ pub struct UpdateAddHTLC {
pub blinding_point: Option<PublicKey>,
}
-/// An onion message to be sent to or received from a peer.
+/// An [`onion message`] to be sent to or received from a peer.
///
-// TODO: update with link to OM when they are merged into the BOLTs
+/// [`onion message`]: https://github.com/lightning/bolts/blob/master/04-onion-routing.md#onion-messages
#[derive(Clone, Debug, Hash, PartialEq, Eq)]
pub struct OnionMessage {
/// Used in decrypting the onion packet's payload.
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.