Skip to content

Commit 69f2c37

Browse files
committed
f - update docs
1 parent 667e4d2 commit 69f2c37

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

lightning/src/offers/refund.rs

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -191,12 +191,15 @@ macro_rules! refund_builder_methods { (
191191
///
192192
/// Also, sets the metadata when [`RefundBuilder::build`] is called such that it can be used by
193193
/// [`Bolt12Invoice::verify`] to determine if the invoice was produced for the refund given an
194-
/// [`ExpandedKey`].
194+
/// [`ExpandedKey`]. However, if [`RefundBuilder::path`] is called, then the metadata must be
195+
/// included in each [`BlindedPath`] instead. In this case, use
196+
/// [`Bolt12Invoice::verify_using_payer_data`].
195197
///
196198
/// The `payment_id` is encrypted in the metadata and should be unique. This ensures that only
197199
/// one invoice will be paid for the refund and that payments can be uniquely identified.
198200
///
199201
/// [`Bolt12Invoice::verify`]: crate::offers::invoice::Bolt12Invoice::verify
202+
/// [`Bolt12Invoice::verify_using_payer_data`]: crate::offers::invoice::Bolt12Invoice::verify_using_payer_data
200203
/// [`ExpandedKey`]: crate::ln::inbound_payment::ExpandedKey
201204
pub fn deriving_payer_id(
202205
node_id: PublicKey, expanded_key: &ExpandedKey, nonce: Nonce,

0 commit comments

Comments
 (0)