Add privacy section to pay_for_offer docs
authorJeffrey Czyz <jkczyz@gmail.com>
Thu, 19 Oct 2023 14:45:30 +0000 (09:45 -0500)
committerJeffrey Czyz <jkczyz@gmail.com>
Fri, 20 Oct 2023 14:49:57 +0000 (09:49 -0500)
lightning/src/ln/channelmanager.rs

index d28270db5bb6b49542434064cdd8cbcc8dce6c83..13b0a815ec148693491b35c43e91feea9e06399c 100644 (file)
@@ -7361,7 +7361,7 @@ where
        /// # Privacy
        ///
        /// Uses a one-hop [`BlindedPath`] for the refund with [`ChannelManager::get_our_node_id`] as
-       /// the introduction node and a derived payer id for sender privacy. As such, currently, the
+       /// the introduction node and a derived payer id for payer privacy. As such, currently, the
        /// node must be announced. Otherwise, there is no way to find a path to the introduction node
        /// in order to send the [`Bolt12Invoice`].
        ///
@@ -7421,6 +7421,13 @@ where
        /// invoice. If abandoned, or an invoice isn't received in a reasonable amount of time, the
        /// payment will fail with an [`Event::InvoiceRequestFailed`].
        ///
+       /// # Privacy
+       ///
+       /// Uses a one-hop [`BlindedPath`] for the reply path with [`ChannelManager::get_our_node_id`]
+       /// as the introduction node and a derived payer id for payer privacy. As such, currently, the
+       /// node must be announced. Otherwise, there is no way to find a path to the introduction node
+       /// in order to send the [`Bolt12Invoice`].
+       ///
        /// # Errors
        ///
        /// Errors if a duplicate `payment_id` is provided given the caveats in the aforementioned link