Skip to content

Commit 7b71590

Browse files
committed
Fix doc breakage under dnssec feature
1 parent 0f75233 commit 7b71590

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
@@ -10707,7 +10707,7 @@ where
1070710707
}
1070810708

1070910709
/// Pays for an [`Offer`] looked up using [BIP 353] Human Readable Names resolved by the DNS
10710-
/// resolver(s) at `dns_resolvers` which resolve names according to bLIP 32.
10710+
/// resolver(s) at `dns_resolvers` which resolve names according to [bLIP 32].
1071110711
///
1071210712
/// If the wallet supports paying on-chain schemes, you should instead use
1071310713
/// [`OMNameResolver::resolve_name`] and [`OMNameResolver::handle_dnssec_proof_for_uri`] (by
@@ -10727,27 +10727,33 @@ where
1072710727
///
1072810728
/// To revoke the request, use [`ChannelManager::abandon_payment`] prior to receiving the
1072910729
/// invoice. If abandoned, or an invoice isn't received in a reasonable amount of time, the
10730-
/// payment will fail with an [`Event::InvoiceRequestFailed`].
10730+
/// payment will fail with an [`PaymentFailureReason::UserAbandoned`] or
10731+
/// [`PaymentFailureReason::InvoiceRequestExpired`], respectively.
1073110732
///
1073210733
/// # Privacy
1073310734
///
1073410735
/// For payer privacy, uses a derived payer id and uses [`MessageRouter::create_blinded_paths`]
10735-
/// to construct a [`BlindedPath`] for the reply path. For further privacy implications, see the
10736+
/// to construct a [`BlindedMessagePath`] for the reply path. For further privacy implications, see the
1073610737
/// docs of the parameterized [`Router`], which implements [`MessageRouter`].
1073710738
///
1073810739
/// # Limitations
1073910740
///
1074010741
/// Requires a direct connection to the given [`Destination`] as well as an introduction node in
10741-
/// [`Offer::paths`] or to [`Offer::signing_pubkey`], if empty. A similar restriction applies to
10742+
/// [`Offer::paths`] or to [`Offer::issuer_signing_pubkey`], if empty. A similar restriction applies to
1074210743
/// the responding [`Bolt12Invoice::payment_paths`].
1074310744
///
1074410745
/// # Errors
1074510746
///
1074610747
/// Errors if:
1074710748
/// - a duplicate `payment_id` is provided given the caveats in the aforementioned link,
1074810749
///
10750+
/// [BIP 353]: https://github.com/bitcoin/bips/blob/master/bip-0353.mediawiki
10751+
/// [bLIP 32]: https://github.com/lightning/blips/blob/master/blip-0032.md
1074910752
/// [`Bolt12Invoice::payment_paths`]: crate::offers::invoice::Bolt12Invoice::payment_paths
1075010753
/// [Avoiding Duplicate Payments]: #avoiding-duplicate-payments
10754+
/// [`BlindedMessagePath`]: crate::blinded_path::message::BlindedMessagePath
10755+
/// [`PaymentFailureReason::UserAbandoned`]: crate::events::PaymentFailureReason::UserAbandoned
10756+
/// [`PaymentFailureReason::InvoiceRequestRejected`]: crate::events::PaymentFailureReason::InvoiceRequestRejected
1075110757
#[cfg(feature = "dnssec")]
1075210758
pub fn pay_for_offer_from_human_readable_name(
1075310759
&self, name: HumanReadableName, amount_msats: u64, payment_id: PaymentId, payer_note: Option<String>,

0 commit comments

Comments
 (0)