From: Jeffrey Czyz <jkczyz@gmail.com>
Date: Tue, 9 Jul 2024 18:41:42 +0000 (-0500)
Subject: Expand OffersContext::OutboundPayment docs
X-Git-Tag: v0.0.124-beta~37^2~20
X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=commitdiff_plain;h=f546aad5dc2eb36a9c3a8349fc16430207fffc18;p=rust-lightning

Expand OffersContext::OutboundPayment docs
---

diff --git a/lightning/src/blinded_path/message.rs b/lightning/src/blinded_path/message.rs
index 893e5c3a6..a8942ceec 100644
--- a/lightning/src/blinded_path/message.rs
+++ b/lightning/src/blinded_path/message.rs
@@ -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
 	},
 }