Skip to content

Commit 9215242

Browse files
committed
f - document payment_id parameter
1 parent e778e36 commit 9215242

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

lightning/src/offers/refund.rs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,9 @@ impl<'a, T: secp256k1::Signing> RefundBuilder<'a, T> {
148148
/// Also, sets the metadata when [`RefundBuilder::build`] is called such that it can be used to
149149
/// verify that an [`InvoiceRequest`] was produced for the refund given an [`ExpandedKey`].
150150
///
151+
/// The `payment_id` is encrypted in the metadata and should be unique. This ensures that only
152+
/// one invoice will be paid for the refund and that payments can be uniquely identified.
153+
///
151154
/// [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
152155
/// [`ExpandedKey`]: crate::ln::inbound_payment::ExpandedKey
153156
pub fn deriving_payer_id<ES: Deref>(

0 commit comments

Comments
 (0)