Skip to content

Commit 993cd1e

Browse files
arik-soarik-so
authored
Merge pull request #2889 from Sharmalm/2840
Allow for user-specified error message during force close channel
2 parents 7326334 + d17e759 commit 993cd1e

File tree

16 files changed

+135
-77
lines changed

16 files changed

+135
-77
lines changed

‎fuzz/src/full_stack.rs

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -220,6 +220,7 @@ struct MoneyLossDetector<'a> {
220220
height: usize,
221221
max_height: usize,
222222
blocks_connected: u32,
223+
error_message: String,
223224
}
224225
impl<'a> MoneyLossDetector<'a> {
225226
pub fn new(peers: &'a RefCell<[bool; 256]>,
@@ -238,6 +239,7 @@ impl<'a> MoneyLossDetector<'a> {
238239
height: 0,
239240
max_height: 0,
240241
blocks_connected: 0,
242+
error_message: "Channel force-closed".to_string(),
241243
}
242244
}
243245

@@ -292,7 +294,7 @@ impl<'a> Drop for MoneyLossDetector<'a> {
292294
}
293295

294296
// Force all channels onto the chain (and time out claim txn)
295-
self.manager.force_close_all_channels_broadcasting_latest_txn();
297+
self.manager.force_close_all_channels_broadcasting_latest_txn(self.error_message.to_string());
296298
}
297299
}
298300
}
@@ -735,9 +737,10 @@ pub fn do_test(mut data: &[u8], logger: &Arc<dyn Logger>) {
735737
14 => {
736738
let mut channels = channelmanager.list_channels();
737739
let channel_id = get_slice!(1)[0] as usize;
740+
let error_message = "Channel force-closed";
738741
if channel_id >= channels.len() { return; }
739742
channels.sort_by(|a, b| { a.channel_id.cmp(&b.channel_id) });
740-
channelmanager.force_close_broadcasting_latest_txn(&channels[channel_id].channel_id, &channels[channel_id].counterparty.node_id).unwrap();
743+
channelmanager.force_close_broadcasting_latest_txn(&channels[channel_id].channel_id, &channels[channel_id].counterparty.node_id, error_message.to_string()).unwrap();
741744
},
742745
// 15, 16, 17, 18 is above
743746
19 => {

‎lightning-background-processor/src/lib.rs

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1461,7 +1461,8 @@ mod tests {
14611461
}
14621462

14631463
// Force-close the channel.
1464-
nodes[0].node.force_close_broadcasting_latest_txn(&ChannelId::v1_from_funding_outpoint(OutPoint { txid: tx.txid(), index: 0 }), &nodes[1].node.get_our_node_id()).unwrap();
1464+
let error_message = "Channel force-closed";
1465+
nodes[0].node.force_close_broadcasting_latest_txn(&ChannelId::v1_from_funding_outpoint(OutPoint { txid: tx.txid(), index: 0 }), &nodes[1].node.get_our_node_id(), error_message.to_string()).unwrap();
14651466

14661467
// Check that the force-close updates are persisted.
14671468
check_persisted_data!(nodes[0].node, filepath.clone());
@@ -1657,7 +1658,8 @@ mod tests {
16571658
let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].no_gossip_sync(), nodes[0].peer_manager.clone(), nodes[0].logger.clone(), Some(nodes[0].scorer.clone()));
16581659

16591660
// Force close the channel and check that the SpendableOutputs event was handled.
1660-
nodes[0].node.force_close_broadcasting_latest_txn(&nodes[0].node.list_channels()[0].channel_id, &nodes[1].node.get_our_node_id()).unwrap();
1661+
let error_message = "Channel force-closed";
1662+
nodes[0].node.force_close_broadcasting_latest_txn(&nodes[0].node.list_channels()[0].channel_id, &nodes[1].node.get_our_node_id(), error_message.to_string()).unwrap();
16611663
let commitment_tx = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().pop().unwrap();
16621664
confirm_transaction_depth(&mut nodes[0], &commitment_tx, BREAKDOWN_TIMEOUT as u32);
16631665

‎lightning-persister/src/fs_store.rs

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -445,7 +445,8 @@ mod tests {
445445
let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
446446
let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
447447
let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
448-
nodes[1].node.force_close_broadcasting_latest_txn(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
448+
let error_message = "Channel force-closed";
449+
nodes[1].node.force_close_broadcasting_latest_txn(&chan.2, &nodes[0].node.get_our_node_id(), error_message.to_string()).unwrap();
449450
check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed, [nodes[0].node.get_our_node_id()], 100000);
450451
let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
451452

@@ -482,7 +483,8 @@ mod tests {
482483
let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
483484
let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
484485
let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
485-
nodes[1].node.force_close_broadcasting_latest_txn(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
486+
let error_message = "Channel force-closed";
487+
nodes[1].node.force_close_broadcasting_latest_txn(&chan.2, &nodes[0].node.get_our_node_id(), error_message.to_string()).unwrap();
486488
check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed, [nodes[0].node.get_our_node_id()], 100000);
487489
let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
488490
let update_map = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap();

‎lightning-persister/src/test_utils.rs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,8 @@ pub(crate) fn do_test_store<K: KVStore>(store_0: &K, store_1: &K) {
104104

105105
// Force close because cooperative close doesn't result in any persisted
106106
// updates.
107-
nodes[0].node.force_close_broadcasting_latest_txn(&nodes[0].node.list_channels()[0].channel_id, &nodes[1].node.get_our_node_id()).unwrap();
107+
let error_message = "Channel force-closed";
108+
nodes[0].node.force_close_broadcasting_latest_txn(&nodes[0].node.list_channels()[0].channel_id, &nodes[1].node.get_our_node_id(), error_message.to_string()).unwrap();
108109
check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed, [nodes[1].node.get_our_node_id()], 100000);
109110
check_closed_broadcast!(nodes[0], true);
110111
check_added_monitors!(nodes[0], 1);

‎lightning/src/ln/async_signer_tests.rs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -364,12 +364,13 @@ fn do_test_async_holder_signatures(anchors: bool, remote_commitment: bool) {
364364
// Route an HTLC and set the signer as unavailable.
365365
let (_, _, chan_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 1);
366366
route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
367+
let error_message = "Channel force-closed";
367368

368369
nodes[0].set_channel_signer_available(&nodes[1].node.get_our_node_id(), &chan_id, false);
369370

370371
if remote_commitment {
371372
// Make the counterparty broadcast its latest commitment.
372-
nodes[1].node.force_close_broadcasting_latest_txn(&chan_id, &nodes[0].node.get_our_node_id()).unwrap();
373+
nodes[1].node.force_close_broadcasting_latest_txn(&chan_id, &nodes[0].node.get_our_node_id(), error_message.to_string()).unwrap();
373374
check_added_monitors(&nodes[1], 1);
374375
check_closed_broadcast(&nodes[1], 1, true);
375376
check_closed_event(&nodes[1], 1, ClosureReason::HolderForceClosed, false, &[nodes[0].node.get_our_node_id()], 100_000);

‎lightning/src/ln/blinded_payment_tests.rs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -466,6 +466,7 @@ fn do_forward_fail_in_process_pending_htlc_fwds(check: ProcessPendingHTLCsCheck,
466466
(chan.0.contents, chan.2)
467467
};
468468

469+
let error_message = "Channel force-closed";
469470
let amt_msat = 5000;
470471
let (_, payment_hash, payment_secret) = get_payment_preimage_hash(&nodes[2], Some(amt_msat), None);
471472
let route_params = get_blinded_route_parameters(amt_msat, payment_secret, 1, 1_0000_0000,
@@ -498,7 +499,7 @@ fn do_forward_fail_in_process_pending_htlc_fwds(check: ProcessPendingHTLCsCheck,
498499
ProcessPendingHTLCsCheck::FwdChannelClosed => {
499500
// Force close the next-hop channel so when we go to forward in process_pending_htlc_forwards,
500501
// the intro node will error backwards.
501-
$curr_node.node.force_close_broadcasting_latest_txn(&$failed_chan_id, &$next_node.node.get_our_node_id()).unwrap();
502+
$curr_node.node.force_close_broadcasting_latest_txn(&$failed_chan_id, &$next_node.node.get_our_node_id(), error_message.to_string()).unwrap();
502503
let events = $curr_node.node.get_and_clear_pending_events();
503504
match events[0] {
504505
crate::events::Event::PendingHTLCsForwardable { .. } => {},

‎lightning/src/ln/chanmon_update_fail_tests.rs

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,8 @@ fn do_test_simple_monitor_temporary_update_fail(disconnect: bool) {
207207
}
208208

209209
// ...and make sure we can force-close a frozen channel
210-
nodes[0].node.force_close_broadcasting_latest_txn(&channel_id, &nodes[1].node.get_our_node_id()).unwrap();
210+
let error_message = "Channel force-closed";
211+
nodes[0].node.force_close_broadcasting_latest_txn(&channel_id, &nodes[1].node.get_our_node_id(), error_message.to_string()).unwrap();
211212
check_added_monitors!(nodes[0], 1);
212213
check_closed_broadcast!(nodes[0], true);
213214

@@ -3224,17 +3225,18 @@ fn do_test_durable_preimages_on_closed_channel(close_chans_before_reload: bool,
32243225
let _ = get_revoke_commit_msgs!(nodes[1], nodes[2].node.get_our_node_id());
32253226

32263227
let mon_bc = get_monitor!(nodes[1], chan_id_bc).encode();
3228+
let error_message = "Channel force-closed";
32273229

32283230
if close_chans_before_reload {
32293231
if !close_only_a {
32303232
chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
3231-
nodes[1].node.force_close_broadcasting_latest_txn(&chan_id_bc, &nodes[2].node.get_our_node_id()).unwrap();
3233+
nodes[1].node.force_close_broadcasting_latest_txn(&chan_id_bc, &nodes[2].node.get_our_node_id(), error_message.to_string()).unwrap();
32323234
check_closed_broadcast(&nodes[1], 1, true);
32333235
check_closed_event(&nodes[1], 1, ClosureReason::HolderForceClosed, false, &[nodes[2].node.get_our_node_id()], 100000);
32343236
}
32353237

32363238
chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
3237-
nodes[1].node.force_close_broadcasting_latest_txn(&chan_id_ab, &nodes[0].node.get_our_node_id()).unwrap();
3239+
nodes[1].node.force_close_broadcasting_latest_txn(&chan_id_ab, &nodes[0].node.get_our_node_id(), error_message.to_string()).unwrap();
32383240
check_closed_broadcast(&nodes[1], 1, true);
32393241
check_closed_event(&nodes[1], 1, ClosureReason::HolderForceClosed, false, &[nodes[0].node.get_our_node_id()], 100000);
32403242
}
@@ -3255,8 +3257,9 @@ fn do_test_durable_preimages_on_closed_channel(close_chans_before_reload: bool,
32553257
assert_eq!(bs_close_txn.len(), 3);
32563258
}
32573259
}
3260+
let error_message = "Channel force-closed";
32583261

3259-
nodes[0].node.force_close_broadcasting_latest_txn(&chan_id_ab, &nodes[1].node.get_our_node_id()).unwrap();
3262+
nodes[0].node.force_close_broadcasting_latest_txn(&chan_id_ab, &nodes[1].node.get_our_node_id(), error_message.to_string()).unwrap();
32603263
check_closed_event(&nodes[0], 1, ClosureReason::HolderForceClosed, false, &[nodes[1].node.get_our_node_id()], 100000);
32613264
let as_closing_tx = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
32623265
assert_eq!(as_closing_tx.len(), 1);
@@ -3393,10 +3396,11 @@ fn do_test_reload_mon_update_completion_actions(close_during_reload: bool) {
33933396
let manager_b = nodes[1].node.encode();
33943397
reload_node!(nodes[1], &manager_b, &[&mon_ab, &mon_bc], persister, new_chain_monitor, nodes_1_deserialized);
33953398

3399+
let error_message = "Channel force-closed";
33963400
if close_during_reload {
33973401
// Test that we still free the B<->C channel if the A<->B channel closed while we reloaded
33983402
// (as learned about during the on-reload block connection).
3399-
nodes[0].node.force_close_broadcasting_latest_txn(&chan_id_ab, &nodes[1].node.get_our_node_id()).unwrap();
3403+
nodes[0].node.force_close_broadcasting_latest_txn(&chan_id_ab, &nodes[1].node.get_our_node_id(), error_message.to_string()).unwrap();
34003404
check_added_monitors!(nodes[0], 1);
34013405
check_closed_broadcast!(nodes[0], true);
34023406
check_closed_event(&nodes[0], 1, ClosureReason::HolderForceClosed, false, &[nodes[1].node.get_our_node_id()], 100_000);

0 commit comments

Comments
 (0)