Skip to content

Commit a4f2721

Browse files
tnullTheBlueMatt
authored andcommitted
Fix doc breakage under dnssec feature
Backport of 1ca41b5
1 parent 4220388 commit a4f2721

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

lightning/src/ln/channelmanager.rs

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10472,7 +10472,7 @@ where
1047210472
}
1047310473

1047410474
/// Pays for an [`Offer`] looked up using [BIP 353] Human Readable Names resolved by the DNS
10475-
/// resolver(s) at `dns_resolvers` which resolve names according to bLIP 32.
10475+
/// resolver(s) at `dns_resolvers` which resolve names according to [bLIP 32].
1047610476
///
1047710477
/// If the wallet supports paying on-chain schemes, you should instead use
1047810478
/// [`OMNameResolver::resolve_name`] and [`OMNameResolver::handle_dnssec_proof_for_uri`] (by
@@ -10490,27 +10490,33 @@ where
1049010490
///
1049110491
/// To revoke the request, use [`ChannelManager::abandon_payment`] prior to receiving the
1049210492
/// invoice. If abandoned, or an invoice isn't received in a reasonable amount of time, the
10493-
/// payment will fail with an [`Event::InvoiceRequestFailed`].
10493+
/// payment will fail with an [`PaymentFailureReason::UserAbandoned`] or
10494+
/// [`PaymentFailureReason::InvoiceRequestExpired`], respectively.
1049410495
///
1049510496
/// # Privacy
1049610497
///
1049710498
/// For payer privacy, uses a derived payer id and uses [`MessageRouter::create_blinded_paths`]
10498-
/// to construct a [`BlindedPath`] for the reply path. For further privacy implications, see the
10499+
/// to construct a [`BlindedMessagePath`] for the reply path. For further privacy implications, see the
1049910500
/// docs of the parameterized [`Router`], which implements [`MessageRouter`].
1050010501
///
1050110502
/// # Limitations
1050210503
///
1050310504
/// Requires a direct connection to the given [`Destination`] as well as an introduction node in
10504-
/// [`Offer::paths`] or to [`Offer::signing_pubkey`], if empty. A similar restriction applies to
10505+
/// [`Offer::paths`] or to [`Offer::issuer_signing_pubkey`], if empty. A similar restriction applies to
1050510506
/// the responding [`Bolt12Invoice::payment_paths`].
1050610507
///
1050710508
/// # Errors
1050810509
///
1050910510
/// Errors if:
1051010511
/// - a duplicate `payment_id` is provided given the caveats in the aforementioned link,
1051110512
///
10513+
/// [BIP 353]: https://github.com/bitcoin/bips/blob/master/bip-0353.mediawiki
10514+
/// [bLIP 32]: https://github.com/lightning/blips/blob/master/blip-0032.md
1051210515
/// [`Bolt12Invoice::payment_paths`]: crate::offers::invoice::Bolt12Invoice::payment_paths
1051310516
/// [Avoiding Duplicate Payments]: #avoiding-duplicate-payments
10517+
/// [`BlindedMessagePath`]: crate::blinded_path::message::BlindedMessagePath
10518+
/// [`PaymentFailureReason::UserAbandoned`]: crate::events::PaymentFailureReason::UserAbandoned
10519+
/// [`PaymentFailureReason::InvoiceRequestRejected`]: crate::events::PaymentFailureReason::InvoiceRequestRejected
1051410520
#[cfg(feature = "dnssec")]
1051510521
pub fn pay_for_offer_from_human_readable_name(
1051610522
&self, name: HumanReadableName, amount_msats: u64, payment_id: PaymentId,

0 commit comments

Comments
 (0)