Skip to content

Commit 010e5a2

Browse files
committed
Expand OffersContext::OutboundPayment docs
1 parent 8c7022c commit 010e5a2

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

lightning/src/blinded_path/message.rs

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -112,9 +112,16 @@ pub enum OffersContext {
112112
/// This variant is used when a message is sent without using a [`BlindedPath`] or over one
113113
/// created prior to LDK version 0.0.124.
114114
Unknown {},
115-
/// Represents an outbound BOLT12 payment context.
115+
/// Context used by a [`BlindedPath`] within a [`Refund`] or as a reply path for an
116+
/// [`InvoiceRequest`].
117+
///
118+
/// [`Refund`]: crate::offers::refund::Refund
119+
/// [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
116120
OutboundPayment {
117-
/// Payment ID of the outbound BOLT12 payment.
121+
/// Payment ID used when creating a [`Refund`] or [`InvoiceRequest`].
122+
///
123+
/// [`Refund`]: crate::offers::refund::Refund
124+
/// [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
118125
payment_id: PaymentId
119126
},
120127
}

0 commit comments

Comments
 (0)