Skip to content

Store channel alongside channel monitor #4151

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from
Draft

Store channel alongside channel monitor #4151

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
8a46e8e
Extract monitor update res handling to fn
valentinewallace Oct 1, 2025
d3db9c4
Extract macro for initial monitor persist
valentinewallace Oct 1, 2025
1c82b17
Extract post-close monitor update macro
valentinewallace Oct 1, 2025
c58cccf
Extract util for XXX
valentinewallace Oct 1, 2025
c7e5c70
Extract _internal macro for new mon update handling
valentinewallace Oct 1, 2025
dd9d6db
store channel with monitor
joostjager Oct 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions lightning/src/chain/chainmonitor.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ pub trait Persist<ChannelSigner: EcdsaChannelSigner> {
/// [`Writeable::write`]: crate::util::ser::Writeable::write
fn update_persisted_channel(
&self, monitor_name: MonitorName, monitor_update: Option<&ChannelMonitorUpdate>,
monitor: &ChannelMonitor<ChannelSigner>,
encoded_channel: Option<&[u8]>, monitor: &ChannelMonitor<ChannelSigner>,
) -> ChannelMonitorUpdateStatus;
/// Prevents the channel monitor from being loaded on startup.
///
Expand Down Expand Up @@ -320,6 +320,7 @@ where

fn update_persisted_channel(
&self, monitor_name: MonitorName, monitor_update: Option<&ChannelMonitorUpdate>,
encoded_channel: Option<&[u8]>,
monitor: &ChannelMonitor<<SP::Target as SignerProvider>::EcdsaSigner>,
) -> ChannelMonitorUpdateStatus {
self.persister.spawn_async_update_persisted_channel(monitor_name, monitor_update, monitor);
Expand Down Expand Up @@ -579,8 +580,12 @@ where
// `ChannelMonitorUpdate` after a channel persist for a channel with the same
// `latest_update_id`.
let _pending_monitor_updates = monitor_state.pending_monitor_updates.lock().unwrap();
match self.persister.update_persisted_channel(monitor.persistence_key(), None, monitor)
{
match self.persister.update_persisted_channel(
monitor.persistence_key(),
None,
None,
monitor,
) {
ChannelMonitorUpdateStatus::Completed => log_trace!(
logger,
"Finished syncing Channel Monitor for channel {} for block-data",
Expand Down Expand Up @@ -944,6 +949,7 @@ where
self.persister.update_persisted_channel(
monitor_holder.monitor.persistence_key(),
None,
None,
&monitor_holder.monitor,
);
}
Expand Down Expand Up @@ -1392,7 +1398,7 @@ where
}

fn update_channel(
&self, channel_id: ChannelId, update: &ChannelMonitorUpdate,
&self, channel_id: ChannelId, update: &ChannelMonitorUpdate, encoded_channel: Option<&[u8]>,
) -> ChannelMonitorUpdateStatus {
// `ChannelMonitorUpdate`'s `channel_id` is `None` prior to 0.0.121 and all channels in those
// versions are V1-established. For 0.0.121+ the `channel_id` fields is always `Some`.
Expand Down Expand Up @@ -1445,12 +1451,14 @@ where
self.persister.update_persisted_channel(
monitor.persistence_key(),
None,
encoded_channel,
monitor,
)
} else {
self.persister.update_persisted_channel(
monitor.persistence_key(),
Some(update),
encoded_channel,
monitor,
)
};
Expand Down
2 changes: 1 addition & 1 deletion lightning/src/chain/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -326,7 +326,7 @@ pub trait Watch<ChannelSigner: EcdsaChannelSigner> {
///
/// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
fn update_channel(
&self, channel_id: ChannelId, update: &ChannelMonitorUpdate,
&self, channel_id: ChannelId, update: &ChannelMonitorUpdate, encoded_channel: Option<&[u8]>,
) -> ChannelMonitorUpdateStatus;

/// Returns any monitor events since the last call. Subsequent calls must only return new
Expand Down
2 changes: 1 addition & 1 deletion lightning/src/ln/async_payments_tests.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2188,7 +2188,7 @@ fn offer_cache_round_trip_ser() {
// offers.
let cached_offers_pre_ser = recipient.node.flow.test_get_async_receive_offers();
let config = test_default_channel_config();
let serialized_monitor = get_monitor!(recipient, chan_id).encode();
let serialized_monitor = get_monitor_and_channel(recipient, chan_id);
reload_node!(
nodes[1],
config,
Expand Down
52 changes: 26 additions & 26 deletions lightning/src/ln/chanmon_update_fail_tests.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ fn test_monitor_and_persister_update_fail() {
// Check that the persister returns InProgress (and will never actually complete)
// as the monitor update errors.
if let ChannelMonitorUpdateStatus::InProgress =
chain_mon.chain_monitor.update_channel(chan.2, &update)
chain_mon.chain_monitor.update_channel(chan.2, &update, None)
{
} else {
panic!("Expected monitor paused");
Expand All @@ -158,7 +158,7 @@ fn test_monitor_and_persister_update_fail() {
// Apply the monitor update to the original ChainMonitor, ensuring the
// ChannelManager and ChannelMonitor aren't out of sync.
assert_eq!(
nodes[0].chain_monitor.update_channel(chan.2, &update),
nodes[0].chain_monitor.update_channel(chan.2, &update, None),
ChannelMonitorUpdateStatus::Completed
);
} else {
Expand Down Expand Up @@ -2702,7 +2702,7 @@ fn do_channel_holding_cell_serialize(disconnect: bool, reload_a: bool) {
nodes[0].node.send_payment_with_route(route, payment_hash_2, onion_2, id_2).unwrap();
check_added_monitors!(nodes[0], 0);

let chan_0_monitor_serialized = get_monitor!(nodes[0], chan_id).encode();
let chan_0_monitor_serialized = get_monitor_and_channel(&nodes[0], chan_id);
chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
nodes[0].node.claim_funds(payment_preimage_0);
Expand All @@ -2723,7 +2723,7 @@ fn do_channel_holding_cell_serialize(disconnect: bool, reload_a: bool) {
// deserializing a ChannelManager in this state causes an assertion failure.
if reload_a {
let node_ser = nodes[0].node.encode();
let mons = &[&chan_0_monitor_serialized[..]];
let mons = &[&chan_0_monitor_serialized];
reload_node!(nodes[0], &node_ser, mons, persister, new_chain_mon, nodes_0_reload);
persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
Expand Down Expand Up @@ -3503,10 +3503,10 @@ fn do_test_blocked_chan_preimage_release(completion_mode: BlockedUpdateComplMode
assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
if completion_mode == BlockedUpdateComplMode::AtReload {
let node_ser = nodes[1].node.encode();
let chan_mon_0 = get_monitor!(nodes[1], chan_id_1).encode();
let chan_mon_1 = get_monitor!(nodes[1], chan_id_2).encode();
let chan_mon_0 = get_monitor_and_channel(&nodes[1], chan_id_1);
let chan_mon_1 = get_monitor_and_channel(&nodes[1], chan_id_2);

let mons = &[&chan_mon_0[..], &chan_mon_1[..]];
let mons = &[&chan_mon_0, &chan_mon_1];
reload_node!(nodes[1], &node_ser, mons, persister, new_chain_mon, nodes_1_reload);

nodes[0].node.peer_disconnected(node_b_id);
Expand Down Expand Up @@ -3617,7 +3617,7 @@ fn do_test_inverted_mon_completion_order(
let (payment_preimage, payment_hash, ..) =
route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100_000);

let mon_ab = get_monitor!(nodes[1], chan_id_ab).encode();
let mon_ab = get_monitor_and_channel(&nodes[1], chan_id_ab);
let mut manager_b = Vec::new();
if !with_latest_manager {
manager_b = nodes[1].node.encode();
Expand Down Expand Up @@ -3663,7 +3663,7 @@ fn do_test_inverted_mon_completion_order(
manager_b = nodes[1].node.encode();
}

let mon_bc = get_monitor!(nodes[1], chan_id_bc).encode();
let mon_bc = get_monitor_and_channel(&nodes[1], chan_id_bc);
reload_node!(nodes[1], &manager_b, &[&mon_ab, &mon_bc], persister, chain_mon, node_b_reload);

nodes[0].node.peer_disconnected(node_b_id);
Expand Down Expand Up @@ -3809,7 +3809,7 @@ fn do_test_durable_preimages_on_closed_channel(
let (payment_preimage, payment_hash, ..) =
route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000);

let mon_ab = get_monitor!(nodes[1], chan_id_ab).encode();
let mon_ab = get_monitor_and_channel(&nodes[1], chan_id_ab);

nodes[2].node.claim_funds(payment_preimage);
check_added_monitors(&nodes[2], 1);
Expand All @@ -3831,7 +3831,7 @@ fn do_test_durable_preimages_on_closed_channel(
check_added_monitors(&nodes[1], 1);
let _ = get_revoke_commit_msgs!(nodes[1], node_c_id);

let mon_bc = get_monitor!(nodes[1], chan_id_bc).encode();
let mon_bc = get_monitor_and_channel(&nodes[1], chan_id_bc);

if close_chans_before_reload {
if !close_only_a {
Expand Down Expand Up @@ -4036,8 +4036,8 @@ fn do_test_reload_mon_update_completion_actions(close_during_reload: bool) {
// Finally, reload node B and check that after we call `process_pending_events` once we realize
// we've completed the A<->B preimage-including monitor update and so can release the B<->C
// preimage-removing monitor update.
let mon_ab = get_monitor!(nodes[1], chan_id_ab).encode();
let mon_bc = get_monitor!(nodes[1], chan_id_bc).encode();
let mon_ab = get_monitor_and_channel(&nodes[1], chan_id_ab);
let mon_bc = get_monitor_and_channel(&nodes[1], chan_id_bc);
let manager_b = nodes[1].node.encode();
reload_node!(nodes[1], &manager_b, &[&mon_ab, &mon_bc], persister, chain_mon, node_b_reload);

Expand Down Expand Up @@ -4271,7 +4271,7 @@ fn do_test_partial_claim_mon_update_compl_actions(reload_a: bool, reload_b: bool
send_along_route_with_secret(&nodes[0], route, paths, 200_000, payment_hash, payment_secret);

// Store the monitor for channel 4 without the preimage to use on reload
let chan_4_monitor_serialized = get_monitor!(nodes[3], chan_4_id).encode();
let chan_4_monitor_serialized = get_monitor_and_channel(&nodes[3], chan_4_id);
// Claim along both paths, but only complete one of the two monitor updates.
chanmon_cfgs[3].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
chanmon_cfgs[3].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
Expand Down Expand Up @@ -4312,8 +4312,8 @@ fn do_test_partial_claim_mon_update_compl_actions(reload_a: bool, reload_b: bool
// After a reload (with the monitor not yet fully updated), the RAA should still be blocked
// waiting until the monitor update completes.
let node_ser = nodes[3].node.encode();
let chan_3_monitor_serialized = get_monitor!(nodes[3], chan_3_id).encode();
let mons = &[&chan_3_monitor_serialized[..], &chan_4_monitor_serialized[..]];
let chan_3_monitor_serialized = get_monitor_and_channel(&nodes[3], chan_3_id);
let mons = &[&chan_3_monitor_serialized, &chan_4_monitor_serialized];
reload_node!(nodes[3], &node_ser, mons, persister, new_chain_mon, nodes_3_reload);
// The final update to channel 4 should be replayed.
persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
Expand Down Expand Up @@ -4391,9 +4391,9 @@ fn do_test_partial_claim_mon_update_compl_actions(reload_a: bool, reload_b: bool
// reload once the HTLCs for the first payment have been removed and the monitors
// completed.
let node_ser = nodes[3].node.encode();
let chan_3_monitor_serialized = get_monitor!(nodes[3], chan_3_id).encode();
let chan_4_monitor_serialized = get_monitor!(nodes[3], chan_4_id).encode();
let mons = &[&chan_3_monitor_serialized[..], &chan_4_monitor_serialized[..]];
let chan_3_monitor_serialized = get_monitor_and_channel(&nodes[3], chan_3_id);
let chan_4_monitor_serialized = get_monitor_and_channel(&nodes[3], chan_4_id);
let mons = &[&chan_3_monitor_serialized, &chan_4_monitor_serialized];
reload_node!(nodes[3], &node_ser, mons, persister_2, new_chain_mon_2, nodes_3_reload_2);
check_added_monitors(&nodes[3], 0);

Expand All @@ -4418,9 +4418,9 @@ fn do_test_partial_claim_mon_update_compl_actions(reload_a: bool, reload_b: bool
// reload once the HTLCs for the first payment have been removed and the monitors
// completed, even if only one of the two monitors still knows about the first payment.
let node_ser = nodes[3].node.encode();
let chan_3_monitor_serialized = get_monitor!(nodes[3], chan_3_id).encode();
let chan_4_monitor_serialized = get_monitor!(nodes[3], chan_4_id).encode();
let mons = &[&chan_3_monitor_serialized[..], &chan_4_monitor_serialized[..]];
let chan_3_monitor_serialized = get_monitor_and_channel(&nodes[3], chan_3_id);
let chan_4_monitor_serialized = get_monitor_and_channel(&nodes[3], chan_4_id);
let mons = &[&chan_3_monitor_serialized, &chan_4_monitor_serialized];
reload_node!(nodes[3], &node_ser, mons, persister_3, new_chain_mon_3, nodes_3_reload_3);
check_added_monitors(&nodes[3], 0);

Expand Down Expand Up @@ -4961,10 +4961,10 @@ fn native_async_persist() {

// Now test two async `ChannelMonitorUpdate`s in flight at once, completing them in-order but
// separately.
let update_status = async_chain_monitor.update_channel(chan_id, &updates[0]);
let update_status = async_chain_monitor.update_channel(chan_id, &updates[0], None);
assert_eq!(update_status, ChannelMonitorUpdateStatus::InProgress);

let update_status = async_chain_monitor.update_channel(chan_id, &updates[1]);
let update_status = async_chain_monitor.update_channel(chan_id, &updates[1], None);
assert_eq!(update_status, ChannelMonitorUpdateStatus::InProgress);

persist_futures.poll_futures();
Expand Down Expand Up @@ -5010,10 +5010,10 @@ fn native_async_persist() {
// Finally, test two async `ChanelMonitorUpdate`s in flight at once, completing them
// out-of-order and ensuring that no `MonitorEvent::Completed` is generated until they are both
// completed (and that it marks both as completed when it is generated).
let update_status = async_chain_monitor.update_channel(chan_id, &updates[2]);
let update_status = async_chain_monitor.update_channel(chan_id, &updates[2], None);
assert_eq!(update_status, ChannelMonitorUpdateStatus::InProgress);

let update_status = async_chain_monitor.update_channel(chan_id, &updates[3]);
let update_status = async_chain_monitor.update_channel(chan_id, &updates[3], None);
assert_eq!(update_status, ChannelMonitorUpdateStatus::InProgress);

persist_futures.poll_futures();
Expand Down
Loading