]> git.bitcoin.ninja Git - rust-lightning/commitdiff
Clean up MessageContext docs
authorJeffrey Czyz <jkczyz@gmail.com>
Tue, 9 Jul 2024 18:31:34 +0000 (13:31 -0500)
committerJeffrey Czyz <jkczyz@gmail.com>
Mon, 22 Jul 2024 16:34:02 +0000 (11:34 -0500)
lightning/src/blinded_path/message.rs

index fe1a8b7668189dce908aa439a49b7eecc7d6fca9..08e556a9c28c4e345e52c771033eb4f189c9182b 100644 (file)
@@ -85,20 +85,20 @@ impl Writeable for ReceiveTlvs {
        }
 }
 
-/// Represents additional data included by the recipient in a [`BlindedPath`].
+/// Additional data included by the recipient in a [`BlindedPath`].
 ///
-/// This data is encrypted by the recipient and remains invisible to anyone else.
-/// It is included in the [`BlindedPath`], making it accessible again to the recipient
-/// whenever the [`BlindedPath`] is used.
-/// The recipient can authenticate the message and utilize it for further processing
-/// if needed.
+/// This data is encrypted by the recipient and will be given to the corresponding message handler
+/// when handling a message sent over the [`BlindedPath`]. The recipient can use this data to
+/// authenticate the message or for further processing if needed.
 #[derive(Clone, Debug)]
 pub enum MessageContext {
-       /// Represents the data specific to [`OffersMessage`]
+       /// Context specific to an [`OffersMessage`].
        ///
        /// [`OffersMessage`]: crate::onion_message::offers::OffersMessage
        Offers(OffersContext),
-       /// Represents custom data received in a Custom Onion Message.
+       /// Context specific to a [`CustomOnionMessageHandler::CustomMessage`].
+       ///
+       /// [`CustomOnionMessageHandler::CustomMessage`]: crate::onion_message::messenger::CustomOnionMessageHandler::CustomMessage
        Custom(Vec<u8>),
 }