Correctly refer to `pay_for_offer_from_hrn` in `pay_for_offer` docs
What the developer wrote
Authored by Matt Corallo
Correctly refer to `pay_for_offer_from_hrn` in `pay_for_offer` docs
If a `pay_for_offer` call comes in that was for an HRN, downstream
code should instead call `pay_for_offer_from_hrn`, not
`pay_for_offer`.
What changed, and why it matters
This commit is a tiny documentation fix. It updates the comment above the `pay_for_offer` function to tell developers to use a related function, `pay_for_offer_from_hrn`, when handling human-readable payment names. No code behavior changed.
No action required. This is a documentation-only change with no security relevance.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff changes one line of Rust documentation in lightning/src/ln/channelmanager.rs. The doc comment for ChannelManager::pay_for_offer now correctly references Self::pay_for_offer_from_hrn for cases where BOLT 12 offers are resolved through a human-readable name (HRN). There are no logic, API, or safety changes.
Changed components
lightning/src/ln/channelmanager.rs documentationInspect captured patch +2 / −1
diff --git a/lightning/src/ln/channelmanager.rs b/lightning/src/ln/channelmanager.rs
index 6608754..9d93f44 100644
--- a/lightning/src/ln/channelmanager.rs
+++ b/lightning/src/ln/channelmanager.rs
@@ -14573,7 +14573,8 @@ impl<
/// [`bitcoin-payment-instructions` crate](https://docs.rs/bitcoin-payment-instructions/) to
/// resolve payment instructions strings (e.g. from QR codes, link opens, pasted instructions,
/// or typed instructions) into payment instructions and use this when the instructions resolve
- /// to a BOLT 12 offer.
+ /// to a BOLT 12 offer or [`Self::pay_for_offer_from_hrn`] when they resolve to a BOLT 12 offer
+ /// via a human-readable name.
///
/// [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
/// [`InvoiceRequestBuilder`]: crate::offers::invoice_request::InvoiceRequestBuilder
Why this scored 16/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.