Skip to content

Commit 1ca41b5

Browse files
tnullelnosh
authored andcommitted
Fix doc breakage under dnssec feature
1 parent ba837a1 commit 1ca41b5

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
@@ -10547,7 +10547,7 @@ where
1054710547
}
1054810548

1054910549
/// Pays for an [`Offer`] looked up using [BIP 353] Human Readable Names resolved by the DNS
10550-
/// resolver(s) at `dns_resolvers` which resolve names according to bLIP 32.
10550+
/// resolver(s) at `dns_resolvers` which resolve names according to [bLIP 32].
1055110551
///
1055210552
/// If the wallet supports paying on-chain schemes, you should instead use
1055310553
/// [`OMNameResolver::resolve_name`] and [`OMNameResolver::handle_dnssec_proof_for_uri`] (by
@@ -10567,29 +10567,35 @@ where
1056710567
///
1056810568
/// To revoke the request, use [`ChannelManager::abandon_payment`] prior to receiving the
1056910569
/// invoice. If abandoned, or an invoice isn't received in a reasonable amount of time, the
10570-
/// payment will fail with an [`Event::InvoiceRequestFailed`].
10570+
/// payment will fail with an [`PaymentFailureReason::UserAbandoned`] or
10571+
/// [`PaymentFailureReason::InvoiceRequestExpired`], respectively.
1057110572
///
1057210573
/// # Privacy
1057310574
///
1057410575
/// For payer privacy, uses a derived payer id and uses [`MessageRouter::create_blinded_paths`]
10575-
/// to construct a [`BlindedPath`] for the reply path. For further privacy implications, see the
10576+
/// to construct a [`BlindedMessagePath`] for the reply path. For further privacy implications, see the
1057610577
/// docs of the parameterized [`Router`], which implements [`MessageRouter`].
1057710578
///
1057810579
/// # Limitations
1057910580
///
1058010581
/// Requires a direct connection to the given [`Destination`] as well as an introduction node in
10581-
/// [`Offer::paths`] or to [`Offer::signing_pubkey`], if empty. A similar restriction applies to
10582+
/// [`Offer::paths`] or to [`Offer::issuer_signing_pubkey`], if empty. A similar restriction applies to
1058210583
/// the responding [`Bolt12Invoice::payment_paths`].
1058310584
///
1058410585
/// # Errors
1058510586
///
1058610587
/// Errors if:
1058710588
/// - a duplicate `payment_id` is provided given the caveats in the aforementioned link,
1058810589
///
10590+
/// [BIP 353]: https://github.com/bitcoin/bips/blob/master/bip-0353.mediawiki
10591+
/// [bLIP 32]: https://github.com/lightning/blips/blob/master/blip-0032.md
1058910592
/// [`Bolt12Invoice::payment_paths`]: crate::offers::invoice::Bolt12Invoice::payment_paths
1059010593
/// [`OMNameResolver::resolve_name`]: crate::onion_message::dns_resolution::OMNameResolver::resolve_name
1059110594
/// [`OMNameResolver::handle_dnssec_proof_for_uri`]: crate::onion_message::dns_resolution::OMNameResolver::handle_dnssec_proof_for_uri
1059210595
/// [Avoiding Duplicate Payments]: #avoiding-duplicate-payments
10596+
/// [`BlindedMessagePath`]: crate::blinded_path::message::BlindedMessagePath
10597+
/// [`PaymentFailureReason::UserAbandoned`]: crate::events::PaymentFailureReason::UserAbandoned
10598+
/// [`PaymentFailureReason::InvoiceRequestRejected`]: crate::events::PaymentFailureReason::InvoiceRequestRejected
1059310599
#[cfg(feature = "dnssec")]
1059410600
pub fn pay_for_offer_from_human_readable_name(
1059510601
&self, name: HumanReadableName, amount_msats: u64, payment_id: PaymentId, payer_note: Option<String>,

0 commit comments

Comments
 (0)