chainmon: fixup stale docs mentioning removed funding_txo params
What the developer wrote
Authored by Philip Kannegaard Hayes
chainmon: fixup stale docs mentioning removed funding_txo params
What changed, and why it matters
This commit only updates three stale documentation comments in the chain monitor code. The comments previously referred to old function parameters named `funding_txo` (a transaction output identifier) but the actual code now uses `channel_id`. There are no code behavior changes, no bug fixes, and no security implications.
No action required. This is a non-functional documentation cleanup.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff is a pure documentation correction in lightning/src/chain/chainmonitor.rs. Three doc comments are updated to reflect that methods now take or return channel_id instead of the removed funding_txo parameter. No executable code, signatures, logic, or data structures are modified.
Changed components
lightning/src/chain/chainmonitor.rs documentationInspect captured patch +3 / −3
diff --git a/lightning/src/chain/chainmonitor.rs b/lightning/src/chain/chainmonitor.rs
index 125f206..8644301 100644
--- a/lightning/src/chain/chainmonitor.rs
+++ b/lightning/src/chain/chainmonitor.rs
@@ -691,7 +691,7 @@ where
ret
}
- /// Gets the [`LockedChannelMonitor`] for a given funding outpoint, returning an `Err` if no
+ /// Gets the [`LockedChannelMonitor`] for a given channel ID, returning an `Err` if no
/// such [`ChannelMonitor`] is currently being monitored for.
///
/// Note that the result holds a mutex over our monitor set, and should not be held
@@ -707,7 +707,7 @@ where
}
}
- /// Lists the funding outpoint and channel ID of each [`ChannelMonitor`] being monitored.
+ /// Lists the channel ID of each [`ChannelMonitor`] being monitored.
///
/// Note that [`ChannelMonitor`]s are not removed when a channel is closed as they are always
/// monitoring for on-chain state resolutions.
@@ -764,7 +764,7 @@ where
/// Note that we don't care about calls to [`Persist::update_persisted_channel`] where no
/// [`ChannelMonitorUpdate`] was provided.
///
- /// Returns an [`APIError::APIMisuseError`] if `funding_txo` does not match any currently
+ /// Returns an [`APIError::APIMisuseError`] if `channel_id` does not match any currently
/// registered [`ChannelMonitor`]s.
pub fn channel_monitor_updated(
&self, channel_id: ChannelId, completed_update_id: u64,
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.