Static invoice server: fix incorrect comment
What the developer wrote
Authored by Valentine Wallace
Static invoice server: fix incorrect comment
The comment stated we need peers to be connected in order to send certain onion
messages, but we actually need those peers available in order to create reply
paths.
What changed, and why it matters
This is a one-word documentation comment correction. It changes a comment from saying peers must be connected to 'send' onion messages to saying they must be connected to 'receive' onion messages. No code behavior changes.
No action required. This is a non-functional documentation fix.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The commit modifies an inline comment in channelmanager.rs. The original comment incorrectly described the reason for refreshing the AsyncReceiveOfferCache on peer connection as needing peers to send onion messages; the corrected comment states the need is to receive onion messages (to create reply paths). The diff changes only the word ‘send’ to ‘receive’ in a comment. No executable code, logic, or data flow is altered.
Changed components
lightning/src/ln/channelmanager.rs (comment only)Inspect captured patch +1 / −1
diff --git a/lightning/src/ln/channelmanager.rs b/lightning/src/ln/channelmanager.rs
index 923632a..8846f1c 100644
--- a/lightning/src/ln/channelmanager.rs
+++ b/lightning/src/ln/channelmanager.rs
@@ -12853,7 +12853,7 @@ where
// While we usually refresh the AsyncReceiveOfferCache on a timer, we also want to start
// interactively building offers as soon as we can after startup. We can't start building offers
- // until we have some peer connection(s) to send onion messages over, so as a minor optimization
+ // until we have some peer connection(s) to receive onion messages over, so as a minor optimization
// refresh the cache when a peer connects.
#[cfg(async_payments)]
self.check_refresh_async_receive_offer_cache(false);
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.