Mention the `bitcoin-payment-instructions` crate in docs
What the developer wrote
Authored by Matt Corallo
Mention the `bitcoin-payment-instructions` crate in docs
What changed, and why it matters
This commit only updates documentation comments in a single source file. It adds a reference to an external Rust crate called `bitcoin-payment-instructions` and slightly reorders existing documentation links. No code behavior changes, no security fixes, and no functional modifications are present.
No security action needed. Treat as a routine documentation update.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff is confined to rustdoc comments in lightning/src/ln/channelmanager.rs. It inserts a paragraph mentioning the bitcoin-payment-instructions crate as an alternative for decoding and resolving payment instructions, and updates the rustdoc link reference list. There are no logic, API, or configuration changes.
Changed components
lightning/src/ln/channelmanager.rs documentationInspect captured patch +4 / −1
diff --git a/lightning/src/ln/channelmanager.rs b/lightning/src/ln/channelmanager.rs
index e1b293a..a14d968 100644
--- a/lightning/src/ln/channelmanager.rs
+++ b/lightning/src/ln/channelmanager.rs
@@ -12538,6 +12538,9 @@ where
/// implementing [`DNSResolverMessageHandler`]) directly to look up a URI and then delegate to
/// your normal URI handling.
///
+ /// Alternatively, the [`bitcoin-payment-instructions`] crate provides an implementation of
+ /// much of this logic, and may be useful to decode and resolve payment instructions generally.
+ ///
/// # Payment
///
/// The provided `payment_id` is used to ensure that only one invoice is paid for the request
@@ -12560,9 +12563,9 @@ where
///
/// [BIP 353]: https://github.com/bitcoin/bips/blob/master/bip-0353.mediawiki
/// [bLIP 32]: https://github.com/lightning/blips/blob/master/blip-0032.md
- /// [`Bolt12Invoice::payment_paths`]: crate::offers::invoice::Bolt12Invoice::payment_paths
/// [`OMNameResolver::resolve_name`]: crate::onion_message::dns_resolution::OMNameResolver::resolve_name
/// [`OMNameResolver::handle_dnssec_proof_for_uri`]: crate::onion_message::dns_resolution::OMNameResolver::handle_dnssec_proof_for_uri
+ /// [`bitcoin-payment-instructions`]: https://docs.rs/bitcoin-payment-instructions/
/// [Avoiding Duplicate Payments]: #avoiding-duplicate-payments
/// [`BlindedMessagePath`]: crate::blinded_path::message::BlindedMessagePath
/// [`PaymentFailureReason::UserAbandoned`]: crate::events::PaymentFailureReason::UserAbandoned
Why this scored 15/100
Community notes
Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.
The AI analysis stands alone for now. Submit a note if you can add evidence or important context.