Skip to content

Commit c1db452

Browse files
committed
Clean up MessageContext docs
1 parent 893c8b2 commit c1db452

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

lightning/src/blinded_path/message.rs

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -85,20 +85,20 @@ impl Writeable for ReceiveTlvs {
8585
}
8686
}
8787

88-
/// Represents additional data included by the recipient in a [`BlindedPath`].
88+
/// Additional data included by the recipient in a [`BlindedPath`].
8989
///
90-
/// This data is encrypted by the recipient and remains invisible to anyone else.
91-
/// It is included in the [`BlindedPath`], making it accessible again to the recipient
92-
/// whenever the [`BlindedPath`] is used.
93-
/// The recipient can authenticate the message and utilize it for further processing
94-
/// if needed.
90+
/// This data is encrypted by the recipient and will be given to the corresponding message handler
91+
/// when handling a message sent over the [`BlindedPath`]. The recipient can use this data to
92+
/// authenticate the message or for further processing if needed.
9593
#[derive(Clone, Debug)]
9694
pub enum MessageContext {
97-
/// Represents the data specific to [`OffersMessage`]
95+
/// Context specific to an [`OffersMessage`].
9896
///
9997
/// [`OffersMessage`]: crate::onion_message::offers::OffersMessage
10098
Offers(OffersContext),
101-
/// Represents custom data received in a Custom Onion Message.
99+
/// Context specific to a [`CustomOnionMessageHandler::CustomMessage`].
100+
///
101+
/// [`CustomOnionMessageHandler::CustomMessage`]: crate::onion_message::messenger::CustomOnionMessageHandler::CustomMessage
102102
Custom(Vec<u8>),
103103
}
104104

0 commit comments

Comments
 (0)