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

index 893e5c3a6394274ff6e8893bdffc5af94a3a9271..a8942ceeca397dd1288fc2922fb936028355a0c0 100644 (file)
@@ -112,9 +112,21 @@ pub enum OffersContext {
        /// This variant is used when a message is sent without using a [`BlindedPath`] or over one
        /// created prior to LDK version 0.0.124.
        Unknown {},
-       /// Represents an outbound BOLT12 payment context.
+       /// Context used by a [`BlindedPath`] within a [`Refund`] or as a reply path for an
+       /// [`InvoiceRequest`].
+       ///
+       /// This variant is intended to be received when handling a [`Bolt12Invoice`] or an
+       /// [`InvoiceError`].
+       ///
+       /// [`Refund`]: crate::offers::refund::Refund
+       /// [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
+       /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
+       /// [`InvoiceError`]: crate::offers::invoice_error::InvoiceError
        OutboundPayment {
-               /// Payment ID of the outbound BOLT12 payment.
+               /// Payment ID used when creating a [`Refund`] or [`InvoiceRequest`].
+               ///
+               /// [`Refund`]: crate::offers::refund::Refund
+               /// [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
                payment_id: PaymentId
        },
 }