Doc and comment fixes from #4167
What changed, and why it matters
This commit only fixes documentation comments and a typo in a test-only assertion message. It does not change any executable code, cryptographic logic, or network behavior. There is no security issue here.
No action needed. This is a non-security documentation/comment cleanup commit.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff updates two doc/comment-only strings. In chan_utils.rs, a rustdoc link is corrected from ChannelSigner::pubkeys to ChannelSigner::new_funding_pubkey. In test_channel_signer.rs, a typo in a clone() assertion comment is fixed and a sentence is reworded for clarity. No functional code is modified.
Changed components
lightning/src/ln/chan_utils.rs (documentation only)lightning/src/util/test_channel_signer.rs (comments only)Inspect captured patch +6 / −6
diff --git a/lightning/src/ln/chan_utils.rs b/lightning/src/ln/chan_utils.rs
index eeb785e..acf459b 100644
--- a/lightning/src/ln/chan_utils.rs
+++ b/lightning/src/ln/chan_utils.rs
@@ -1018,11 +1018,11 @@ pub struct ChannelTransactionParameters {
/// If a channel was funded with transaction A, and later spliced with transaction B, this field
/// tracks the txid of transaction A.
///
- /// See [`compute_funding_key_tweak`] and [`ChannelSigner::pubkeys`] for more context on how
- /// this may be used.
+ /// See [`compute_funding_key_tweak`] and [`ChannelSigner::new_funding_pubkey`] for more context
+ /// on how this may be used.
///
/// [`compute_funding_key_tweak`]: crate::sign::compute_funding_key_tweak
- /// [`ChannelSigner::pubkeys`]: crate::sign::ChannelSigner::pubkeys
+ /// [`ChannelSigner::new_funding_pubkey`]: crate::sign::ChannelSigner::new_funding_pubkey
pub splice_parent_funding_txid: Option<Txid>,
/// This channel's type, as negotiated during channel open. For old objects where this field
/// wasn't serialized, it will default to static_remote_key at deserialization.
diff --git a/lightning/src/util/test_channel_signer.rs b/lightning/src/util/test_channel_signer.rs
index bad00f6..3bacd76 100644
--- a/lightning/src/util/test_channel_signer.rs
+++ b/lightning/src/util/test_channel_signer.rs
@@ -83,15 +83,15 @@ impl Clone for TestChannelSigner {
fn clone(&self) -> Self {
// Generally, a signer should only ever be cloned when a ChannelMonitor is cloned (which
// doesn't fetch the pubkeys at all). This isn't really a critical test, but if it
- // it ever does fail we should make sure the clone is hapening in a sensible place.
+ // ever does fail we should make sure the clone is happening in a sensible place.
assert!(!self.have_fetched_pubkeys.load(Ordering::Acquire));
Self {
inner: self.inner.clone(),
state: Arc::clone(&self.state),
disable_revocation_policy_check: self.disable_revocation_policy_check,
disable_all_state_policy_checks: self.disable_all_state_policy_checks,
- // In some tests we clone a `ChannelMonitor` multiple times, so have to initialize with
- // `!have_fetched_pubkeys` to ensure the above assertion passes.
+ // In some tests we clone a `ChannelMonitor` multiple times, so we have to initialize
+ // with `!have_fetched_pubkeys` to ensure the above assertion passes.
have_fetched_pubkeys: AtomicBool::new(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.