Skip to content

Commit dab08c1

Browse files
committed
Fix out-of-date create_inbound_payment() docs
1 parent 41a6c67 commit dab08c1

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

lightning/src/ln/channelmanager.rs

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5418,7 +5418,8 @@ where
54185418
/// [`PaymentHash`] and [`PaymentPreimage`] for you.
54195419
///
54205420
/// The [`PaymentPreimage`] will ultimately be returned to you in the [`PaymentClaimable`], which
5421-
/// will have the [`PaymentClaimable::payment_preimage`] field filled in. That should then be
5421+
/// will have the [`PaymentClaimable::purpose`] be [`PaymentPurpose::InvoicePayment`] with
5422+
/// its [`PaymentPurpose::InvoicePayment::payment_preimage`] field filled in. That should then be
54225423
/// passed directly to [`claim_funds`].
54235424
///
54245425
/// See [`create_inbound_payment_for_hash`] for detailed documentation on behavior and requirements.
@@ -5438,7 +5439,9 @@ where
54385439
///
54395440
/// [`claim_funds`]: Self::claim_funds
54405441
/// [`PaymentClaimable`]: events::Event::PaymentClaimable
5441-
/// [`PaymentClaimable::payment_preimage`]: events::Event::PaymentClaimable::payment_preimage
5442+
/// [`PaymentClaimable::purpose`]: events::Event::PaymentClaimable::purpose
5443+
/// [`PaymentPurpose::InvoicePayment`]: events::PaymentPurpose::InvoicePayment
5444+
/// [`PaymentPurpose::InvoicePayment::payment_preimage`]: events::PaymentPurpose::InvoicePayment::payment_preimage
54425445
/// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
54435446
pub fn create_inbound_payment(&self, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32,
54445447
min_final_cltv_expiry_delta: Option<u16>) -> Result<(PaymentHash, PaymentSecret), ()> {

0 commit comments

Comments
 (0)