Rename update_channel_monitor to handle_new_monitor_update_locked_actions_handled_by_caller
What the developer wrote
Authored by Joost Jager
Rename update_channel_monitor to handle_new_monitor_update_locked_actions_handled_by_caller
The previous name didn't capture that this function is unusual and
requires the caller to handle post-update actions manually. The new
name makes it clear that callers are responsible for handling locked
actions themselves, reducing the risk of misuse.
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
What changed, and why it matters
This commit is a pure rename of an internal Rust function in the Lightning Dev Kit codebase. The function `update_channel_monitor` is renamed to `handle_new_monitor_update_locked_actions_handled_by_caller` because its old name did not make clear that callers must manually handle certain follow-up actions after the monitor update. No logic, behavior, or security properties of the code change. It is a code-quality and maintainability improvement intended to reduce the risk of future misuse by developers working on LDK itself.
No action required. Treat as a normal maintainability/refactor commit.
Security signals we found
No security-relevant code changes
Pure identifier rename with identical call signatures
No changes to cryptography, network parsing, state machine logic, or error handling
Evidence from the diff
The diff renames a single private method in lightning/src/ln/channelmanager.rs and updates all call sites. The function signature, parameters, return type, and body are unchanged. The new name emphasizes that post-update ‘locked actions’ must be handled by the caller. This is a non-functional refactor with no runtime effect.
Changed components
lightning/src/ln/channelmanager.rsInspect captured patch +19 / −17
diff --git a/lightning/src/ln/channelmanager.rs b/lightning/src/ln/channelmanager.rs
index ce5e88e..54f2cf4 100644
--- a/lightning/src/ln/channelmanager.rs
+++ b/lightning/src/ln/channelmanager.rs
@@ -4467,7 +4467,7 @@ where
log_error!(logger, "Closed channel due to close-required error: {}", msg);
if let Some((_, funding_txo, _, update)) = shutdown_res.monitor_update.take() {
- self.update_channel_monitor(
+ self.handle_new_monitor_update_locked_actions_handled_by_caller(
in_flight_monitor_updates,
chan.context.channel_id(),
funding_txo,
@@ -9581,7 +9581,7 @@ This indicates a bug inside LDK. Please report this error at https://github.com/
/// Returns a tuple of `(update_completed, all_updates_completed)`:
/// - `update_completed`: whether this specific monitor update finished persisting
/// - `all_updates_completed`: whether all in-flight updates for this channel are now complete
- fn update_channel_monitor(
+ fn handle_new_monitor_update_locked_actions_handled_by_caller(
&self,
in_flight_monitor_updates: &mut BTreeMap<ChannelId, (OutPoint, Vec<ChannelMonitorUpdate>)>,
channel_id: ChannelId, funding_txo: OutPoint, counterparty_node_id: PublicKey,
@@ -9647,13 +9647,14 @@ This indicates a bug inside LDK. Please report this error at https://github.com/
funding_txo: OutPoint, update: ChannelMonitorUpdate, counterparty_node_id: PublicKey,
channel_id: ChannelId,
) -> Option<Vec<MonitorUpdateCompletionAction>> {
- let (_update_completed, all_updates_complete) = self.update_channel_monitor(
- in_flight_monitor_updates,
- channel_id,
- funding_txo,
- counterparty_node_id,
- update,
- );
+ let (_update_completed, all_updates_complete) = self
+ .handle_new_monitor_update_locked_actions_handled_by_caller(
+ in_flight_monitor_updates,
+ channel_id,
+ funding_txo,
+ counterparty_node_id,
+ update,
+ );
if all_updates_complete {
Some(monitor_update_blocked_actions.remove(&channel_id).unwrap_or(Vec::new()))
} else {
@@ -9767,13 +9768,14 @@ This indicates a bug inside LDK. Please report this error at https://github.com/
let chan_id = chan.context.channel_id();
let counterparty_node_id = chan.context.get_counterparty_node_id();
- let (update_completed, all_updates_complete) = self.update_channel_monitor(
- in_flight_monitor_updates,
- chan_id,
- funding_txo,
- counterparty_node_id,
- update,
- );
+ let (update_completed, all_updates_complete) = self
+ .handle_new_monitor_update_locked_actions_handled_by_caller(
+ in_flight_monitor_updates,
+ chan_id,
+ funding_txo,
+ counterparty_node_id,
+ update,
+ );
let completion_data = if all_updates_complete {
Some(self.try_resume_channel_post_monitor_update(
@@ -14993,7 +14995,7 @@ where
insert_short_channel_id!(short_to_chan_info, funded_channel);
if let Some(monitor_update) = monitor_update_opt {
- self.update_channel_monitor(
+ self.handle_new_monitor_update_locked_actions_handled_by_caller(
&mut peer_state.in_flight_monitor_updates,
funded_channel.context.channel_id(),
funding_txo,
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.