1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! Tests of our shutdown and closing_signed negotiation logic as well as some assorted force-close
13 use crate::sign::{EntropySource, SignerProvider};
14 use crate::chain::ChannelMonitorUpdateStatus;
15 use crate::chain::transaction::OutPoint;
16 use crate::events::{Event, MessageSendEvent, HTLCDestination, MessageSendEventsProvider, ClosureReason};
17 use crate::ln::channel_state::{ChannelDetails, ChannelShutdownState};
18 use crate::ln::channelmanager::{self, PaymentSendFailure, PaymentId, RecipientOnionFields, Retry};
19 use crate::routing::router::{PaymentParameters, get_route, RouteParameters};
21 use crate::ln::types::ChannelId;
22 use crate::ln::msgs::{ChannelMessageHandler, ErrorAction};
23 use crate::ln::onion_utils::INVALID_ONION_BLINDING;
24 use crate::ln::script::ShutdownScript;
25 use crate::util::test_utils;
26 use crate::util::test_utils::OnGetShutdownScriptpubkey;
27 use crate::util::errors::APIError;
28 use crate::util::config::UserConfig;
29 use crate::util::string::UntrustedString;
30 use crate::prelude::*;
32 use bitcoin::{Transaction, TxOut, WitnessProgram, WitnessVersion};
33 use bitcoin::amount::Amount;
34 use bitcoin::blockdata::locktime::absolute::LockTime;
35 use bitcoin::blockdata::script::Builder;
36 use bitcoin::blockdata::opcodes;
37 use bitcoin::network::Network;
38 use bitcoin::transaction::Version;
40 use crate::ln::functional_test_utils::*;
43 fn pre_funding_lock_shutdown_test() {
44 // Test sending a shutdown prior to channel_ready after funding generation
45 let chanmon_cfgs = create_chanmon_cfgs(2);
46 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
47 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
48 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
49 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0);
50 mine_transaction(&nodes[0], &tx);
51 mine_transaction(&nodes[1], &tx);
53 nodes[0].node.close_channel(&ChannelId::v1_from_funding_outpoint(OutPoint { txid: tx.txid(), index: 0 }), &nodes[1].node.get_our_node_id()).unwrap();
54 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
55 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
56 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
57 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
59 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
60 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
61 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
62 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
63 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
64 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
65 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
66 assert!(node_1_none.is_none());
68 assert!(nodes[0].node.list_channels().is_empty());
69 assert!(nodes[1].node.list_channels().is_empty());
70 check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 8000000);
71 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 8000000);
75 fn expect_channel_shutdown_state() {
76 // Test sending a shutdown prior to channel_ready after funding generation
77 let chanmon_cfgs = create_chanmon_cfgs(2);
78 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
79 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
80 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
81 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
83 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::NotShuttingDown);
85 nodes[0].node.close_channel(&chan_1.2, &nodes[1].node.get_our_node_id()).unwrap();
87 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::ShutdownInitiated);
88 expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::NotShuttingDown);
90 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
91 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
93 // node1 goes into NegotiatingClosingFee since there are no HTLCs in flight, note that it
94 // doesnt mean that node1 has sent/recved its closing signed message
95 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::ShutdownInitiated);
96 expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::NegotiatingClosingFee);
98 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
99 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
101 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::NegotiatingClosingFee);
102 expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::NegotiatingClosingFee);
104 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
105 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
106 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
107 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
108 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
109 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
110 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
111 assert!(node_1_none.is_none());
113 assert!(nodes[0].node.list_channels().is_empty());
114 assert!(nodes[1].node.list_channels().is_empty());
115 check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
116 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
120 fn expect_channel_shutdown_state_with_htlc() {
121 // Test sending a shutdown with outstanding updates pending.
122 let chanmon_cfgs = create_chanmon_cfgs(3);
123 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
124 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
125 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
126 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
127 let _chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
129 let (payment_preimage_0, payment_hash_0, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100_000);
131 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::NotShuttingDown);
132 expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::NotShuttingDown);
134 nodes[0].node.close_channel(&chan_1.2, &nodes[1].node.get_our_node_id()).unwrap();
136 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::ShutdownInitiated);
137 expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::NotShuttingDown);
139 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
140 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
142 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::ShutdownInitiated);
143 expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::ResolvingHTLCs);
145 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
146 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
148 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::ResolvingHTLCs);
149 expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::ResolvingHTLCs);
151 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
152 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
154 // Claim Funds on Node2
155 nodes[2].node.claim_funds(payment_preimage_0);
156 check_added_monitors!(nodes[2], 1);
157 expect_payment_claimed!(nodes[2], payment_hash_0, 100_000);
159 // Fulfil HTLCs on node1 and node0
160 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
161 assert!(updates.update_add_htlcs.is_empty());
162 assert!(updates.update_fail_htlcs.is_empty());
163 assert!(updates.update_fail_malformed_htlcs.is_empty());
164 assert!(updates.update_fee.is_none());
165 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
166 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
167 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), false, false);
168 check_added_monitors!(nodes[1], 1);
169 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
170 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
172 // Still in "resolvingHTLCs" on chan1 after htlc removed on chan2
173 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::ResolvingHTLCs);
174 expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::ResolvingHTLCs);
176 assert!(updates_2.update_add_htlcs.is_empty());
177 assert!(updates_2.update_fail_htlcs.is_empty());
178 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
179 assert!(updates_2.update_fee.is_none());
180 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
181 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
182 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
183 expect_payment_sent!(nodes[0], payment_preimage_0);
185 // all htlcs removed, chan1 advances to NegotiatingClosingFee
186 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::NegotiatingClosingFee);
187 expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::NegotiatingClosingFee);
189 // ClosingSignNegotion process
190 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
191 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
192 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
193 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
194 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
195 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
196 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
197 assert!(node_1_none.is_none());
198 check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
199 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
201 // Shutdown basically removes the channelDetails, testing of shutdowncomplete state unnecessary
202 assert!(nodes[0].node.list_channels().is_empty());
206 fn test_lnd_bug_6039() {
207 // LND sends a nonsense error message any time it gets a shutdown if there are still HTLCs
208 // pending. We currently swallow that error to work around LND's bug #6039. This test emulates
209 // the LND nonsense and ensures we at least kinda handle it.
210 let chanmon_cfgs = create_chanmon_cfgs(2);
211 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
212 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
213 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
214 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
216 let (payment_preimage, ..) = route_payment(&nodes[0], &[&nodes[1]], 100_000);
218 nodes[0].node.close_channel(&chan.2, &nodes[1].node.get_our_node_id()).unwrap();
219 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
220 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
222 // Generate an lnd-like error message and check that we respond by simply screaming louder to
223 // see if LND will accept our protocol compliance.
224 let err_msg = msgs::ErrorMessage { channel_id: chan.2, data: "link failed to shutdown".to_string() };
225 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &err_msg);
226 let node_a_responses = nodes[0].node.get_and_clear_pending_msg_events();
227 assert_eq!(node_a_responses[0], MessageSendEvent::SendShutdown {
228 node_id: nodes[1].node.get_our_node_id(),
229 msg: node_0_shutdown,
231 if let MessageSendEvent::HandleError { action: msgs::ErrorAction::SendWarningMessage { .. }, .. }
232 = node_a_responses[1] {} else { panic!(); }
234 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
236 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
237 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
239 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
241 // Assume that LND will eventually respond to our Shutdown if we clear all the remaining HTLCs
242 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
244 // ClosingSignNegotion process
245 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
246 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
247 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
248 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
249 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
250 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
251 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
252 assert!(node_1_none.is_none());
253 check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
254 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
256 // Shutdown basically removes the channelDetails, testing of shutdowncomplete state unnecessary
257 assert!(nodes[0].node.list_channels().is_empty());
261 fn shutdown_on_unfunded_channel() {
262 // Test receiving a shutdown prior to funding generation
263 let chanmon_cfgs = create_chanmon_cfgs(2);
264 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
265 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
266 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
268 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1_000_000, 100_000, 0, None, None).unwrap();
269 let open_chan = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
271 // Create a dummy P2WPKH script
272 let script = Builder::new().push_int(0)
273 .push_slice(&[0; 20])
276 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &msgs::Shutdown {
277 channel_id: open_chan.common_fields.temporary_channel_id, scriptpubkey: script,
279 check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyCoopClosedUnfundedChannel, [nodes[1].node.get_our_node_id()], 1_000_000);
283 fn close_on_unfunded_channel() {
284 // Test the user asking us to close prior to funding generation
285 let chanmon_cfgs = create_chanmon_cfgs(2);
286 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
287 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
288 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
290 let chan_id = nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1_000_000, 100_000, 0, None, None).unwrap();
291 let _open_chan = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
293 nodes[0].node.close_channel(&chan_id, &nodes[1].node.get_our_node_id()).unwrap();
294 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed, [nodes[1].node.get_our_node_id()], 1_000_000);
298 fn expect_channel_shutdown_state_with_force_closure() {
299 // Test sending a shutdown prior to channel_ready after funding generation
300 let chanmon_cfgs = create_chanmon_cfgs(2);
301 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
302 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
303 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
304 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
305 let error_message = "Channel force-closed";
307 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::NotShuttingDown);
308 expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::NotShuttingDown);
310 nodes[1].node.force_close_broadcasting_latest_txn(&chan_1.2, &nodes[0].node.get_our_node_id(), error_message.to_string()).unwrap();
311 check_closed_broadcast!(nodes[1], true);
312 check_added_monitors!(nodes[1], 1);
314 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::NotShuttingDown);
315 assert!(nodes[1].node.list_channels().is_empty());
317 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
318 assert_eq!(node_txn.len(), 1);
319 check_spends!(node_txn[0], chan_1.3);
320 mine_transaction(&nodes[0], &node_txn[0]);
321 check_added_monitors!(nodes[0], 1);
323 assert!(nodes[0].node.list_channels().is_empty());
324 assert!(nodes[1].node.list_channels().is_empty());
325 check_closed_broadcast!(nodes[0], true);
326 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed, [nodes[1].node.get_our_node_id()], 100000);
327 check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed, [nodes[0].node.get_our_node_id()], 100000);
331 fn updates_shutdown_wait() {
332 // Test sending a shutdown with outstanding updates pending
333 let chanmon_cfgs = create_chanmon_cfgs(3);
334 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
335 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
336 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
337 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
338 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
339 let logger = test_utils::TestLogger::new();
340 let scorer = test_utils::TestScorer::new();
341 let keys_manager = test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
342 let random_seed_bytes = keys_manager.get_secure_random_bytes();
344 let (payment_preimage_0, payment_hash_0, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100_000);
346 nodes[0].node.close_channel(&chan_1.2, &nodes[1].node.get_our_node_id()).unwrap();
347 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
348 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
349 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
350 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
352 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
353 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
355 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
357 let payment_params_1 = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id(), TEST_FINAL_CLTV)
358 .with_bolt11_features(nodes[1].node.bolt11_invoice_features()).unwrap();
359 let route_params = RouteParameters::from_payment_params_and_value(payment_params_1, 100_000);
360 let route_1 = get_route(&nodes[0].node.get_our_node_id(), &route_params,
361 &nodes[0].network_graph.read_only(), None, &logger, &scorer, &Default::default(), &random_seed_bytes).unwrap();
362 let payment_params_2 = PaymentParameters::from_node_id(nodes[0].node.get_our_node_id(), TEST_FINAL_CLTV)
363 .with_bolt11_features(nodes[0].node.bolt11_invoice_features()).unwrap();
364 let route_params = RouteParameters::from_payment_params_and_value(payment_params_2, 100_000);
365 let route_2 = get_route(&nodes[1].node.get_our_node_id(), &route_params,
366 &nodes[1].network_graph.read_only(), None, &logger, &scorer, &Default::default(), &random_seed_bytes).unwrap();
367 unwrap_send_err!(nodes[0].node.send_payment_with_route(&route_1, payment_hash,
368 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)
369 ), true, APIError::ChannelUnavailable {..}, {});
370 unwrap_send_err!(nodes[1].node.send_payment_with_route(&route_2, payment_hash,
371 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)
372 ), true, APIError::ChannelUnavailable {..}, {});
374 nodes[2].node.claim_funds(payment_preimage_0);
375 check_added_monitors!(nodes[2], 1);
376 expect_payment_claimed!(nodes[2], payment_hash_0, 100_000);
378 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
379 assert!(updates.update_add_htlcs.is_empty());
380 assert!(updates.update_fail_htlcs.is_empty());
381 assert!(updates.update_fail_malformed_htlcs.is_empty());
382 assert!(updates.update_fee.is_none());
383 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
384 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
385 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), false, false);
386 check_added_monitors!(nodes[1], 1);
387 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
388 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
390 assert!(updates_2.update_add_htlcs.is_empty());
391 assert!(updates_2.update_fail_htlcs.is_empty());
392 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
393 assert!(updates_2.update_fee.is_none());
394 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
395 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
396 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
397 expect_payment_sent!(nodes[0], payment_preimage_0);
399 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
400 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
401 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
402 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
403 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
404 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
405 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
406 assert!(node_1_none.is_none());
407 check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
408 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
410 assert!(nodes[0].node.list_channels().is_empty());
412 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
413 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
414 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
415 assert!(nodes[1].node.list_channels().is_empty());
416 assert!(nodes[2].node.list_channels().is_empty());
417 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[2].node.get_our_node_id()], 100000);
418 check_closed_event!(nodes[2], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
422 fn htlc_fail_async_shutdown() {
423 do_htlc_fail_async_shutdown(true);
424 do_htlc_fail_async_shutdown(false);
427 fn do_htlc_fail_async_shutdown(blinded_recipient: bool) {
428 // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
429 let chanmon_cfgs = create_chanmon_cfgs(3);
430 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
431 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
432 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
433 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
434 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
436 let amt_msat = 100000;
437 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash(&nodes[2], Some(amt_msat), None);
438 let route_params = if blinded_recipient {
439 crate::ln::blinded_payment_tests::get_blinded_route_parameters(
440 amt_msat, our_payment_secret, 1, 100000000,
441 nodes.iter().skip(1).map(|n| n.node.get_our_node_id()).collect(), &[&chan_2.0.contents],
442 &chanmon_cfgs[2].keys_manager)
444 RouteParameters::from_payment_params_and_value(
445 PaymentParameters::from_node_id(nodes[2].node.get_our_node_id(), TEST_FINAL_CLTV), amt_msat)
447 nodes[0].node.send_payment(our_payment_hash,
448 RecipientOnionFields::secret_only(our_payment_secret),
449 PaymentId(our_payment_hash.0), route_params, Retry::Attempts(0)).unwrap();
450 check_added_monitors!(nodes[0], 1);
451 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
452 assert_eq!(updates.update_add_htlcs.len(), 1);
453 assert!(updates.update_fulfill_htlcs.is_empty());
454 assert!(updates.update_fail_htlcs.is_empty());
455 assert!(updates.update_fail_malformed_htlcs.is_empty());
456 assert!(updates.update_fee.is_none());
458 nodes[1].node.close_channel(&chan_1.2, &nodes[0].node.get_our_node_id()).unwrap();
459 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
460 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
461 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
463 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
464 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
465 check_added_monitors!(nodes[1], 1);
466 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
467 commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false, false);
469 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
470 assert!(updates_2.update_add_htlcs.is_empty());
471 assert!(updates_2.update_fulfill_htlcs.is_empty());
472 assert_eq!(updates_2.update_fail_htlcs.len(), 1);
473 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
474 assert!(updates_2.update_fee.is_none());
476 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]);
477 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
479 if blinded_recipient {
480 expect_payment_failed_conditions(&nodes[0], our_payment_hash, false,
481 PaymentFailedConditions::new().expected_htlc_error_data(INVALID_ONION_BLINDING, &[0; 32]));
483 expect_payment_failed_with_update!(nodes[0], our_payment_hash, false, chan_2.0.contents.short_channel_id, true);
486 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
487 assert_eq!(msg_events.len(), 1);
488 let node_0_closing_signed = match msg_events[0] {
489 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
490 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
493 _ => panic!("Unexpected event"),
496 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
497 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
498 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
499 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
500 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
501 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
502 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
503 assert!(node_1_none.is_none());
505 assert!(nodes[0].node.list_channels().is_empty());
507 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
508 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
509 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
510 assert!(nodes[1].node.list_channels().is_empty());
511 assert!(nodes[2].node.list_channels().is_empty());
512 check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
513 let event1 = ExpectedCloseEvent {
514 channel_capacity_sats: Some(100000),
516 counterparty_node_id: Some(nodes[0].node.get_our_node_id()),
517 discard_funding: false,
518 reason: Some(ClosureReason::LocallyInitiatedCooperativeClosure),
519 channel_funding_txo: None,
520 user_channel_id: None,
522 let event2 = ExpectedCloseEvent {
523 channel_capacity_sats: Some(100000),
525 counterparty_node_id: Some(nodes[2].node.get_our_node_id()),
526 discard_funding: false,
527 reason: Some(ClosureReason::CounterpartyInitiatedCooperativeClosure),
528 channel_funding_txo: None,
529 user_channel_id: None,
531 check_closed_events(&nodes[1], &[event1, event2]);
532 check_closed_event!(nodes[2], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
535 fn do_test_shutdown_rebroadcast(recv_count: u8) {
536 // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
537 // messages delivered prior to disconnect
538 let chanmon_cfgs = create_chanmon_cfgs(3);
539 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
540 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
541 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
542 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
543 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
545 let (payment_preimage, payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100_000);
547 nodes[1].node.close_channel(&chan_1.2, &nodes[0].node.get_our_node_id()).unwrap();
548 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
550 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
551 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
553 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
557 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
558 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
560 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
561 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
563 let node_0_reestablish = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
564 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
565 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
567 let node_1_reestablish = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
569 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish);
570 let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
571 assert!(node_1_shutdown == node_1_2nd_shutdown);
573 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish);
574 let node_0_2nd_shutdown = if recv_count > 0 {
575 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
576 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
579 let node_0_chan_update = get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
580 assert_eq!(node_0_chan_update.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
581 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
582 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
584 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_2nd_shutdown);
586 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
587 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
589 nodes[2].node.claim_funds(payment_preimage);
590 check_added_monitors!(nodes[2], 1);
591 expect_payment_claimed!(nodes[2], payment_hash, 100_000);
593 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
594 assert!(updates.update_add_htlcs.is_empty());
595 assert!(updates.update_fail_htlcs.is_empty());
596 assert!(updates.update_fail_malformed_htlcs.is_empty());
597 assert!(updates.update_fee.is_none());
598 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
599 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
600 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), false, false);
601 check_added_monitors!(nodes[1], 1);
602 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
603 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
605 assert!(updates_2.update_add_htlcs.is_empty());
606 assert!(updates_2.update_fail_htlcs.is_empty());
607 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
608 assert!(updates_2.update_fee.is_none());
609 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
610 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
611 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
612 expect_payment_sent!(nodes[0], payment_preimage);
614 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
616 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
617 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
618 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
619 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
620 assert!(node_0_2nd_closing_signed.is_some());
623 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
624 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
626 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
627 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
629 let node_1_2nd_reestablish = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
630 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
631 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
634 // If all closing_signeds weren't delivered we can just resume where we left off...
635 let node_0_2nd_reestablish = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
637 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
638 let node_0_msgs = nodes[0].node.get_and_clear_pending_msg_events();
639 assert_eq!(node_0_msgs.len(), 2);
640 let node_0_2nd_closing_signed = match node_0_msgs[1] {
641 MessageSendEvent::SendClosingSigned { ref msg, .. } => {
642 assert_eq!(node_0_closing_signed, *msg);
648 let node_0_3rd_shutdown = match node_0_msgs[0] {
649 MessageSendEvent::SendShutdown { ref msg, .. } => {
650 assert_eq!(node_0_2nd_shutdown, *msg);
655 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
657 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
658 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
659 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
661 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_3rd_shutdown);
662 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
664 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_3rd_shutdown);
666 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed);
667 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
668 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
669 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
670 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
671 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
672 assert!(node_1_none.is_none());
673 check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
675 // If one node, however, received + responded with an identical closing_signed we end
676 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
677 // There isn't really anything better we can do simply, but in the future we might
678 // explore storing a set of recently-closed channels that got disconnected during
679 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
680 // give our counterparty enough time to (potentially) broadcast a cooperative closing
682 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
684 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
685 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
686 assert_eq!(msg_events.len(), 2);
687 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[1] {
689 &ErrorAction::SendErrorMessage { ref msg } => {
690 nodes[1].node.handle_error(&nodes[0].node.get_our_node_id(), &msg);
691 assert_eq!(msg.channel_id, chan_1.2);
693 _ => panic!("Unexpected event!"),
695 } else { panic!("Needed SendErrorMessage close"); }
697 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
698 // checks it, but in this case nodes[1] didn't ever get a chance to receive a
699 // closing_signed so we do it ourselves
700 check_closed_broadcast!(nodes[1], false);
701 check_added_monitors!(nodes[1], 1);
702 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyForceClosed { peer_msg: UntrustedString(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}", &nodes[1].node.get_our_node_id())) }
703 , [nodes[0].node.get_our_node_id()], 100000);
706 assert!(nodes[0].node.list_channels().is_empty());
708 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
709 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
710 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
711 assert!(nodes[1].node.list_channels().is_empty());
712 assert!(nodes[2].node.list_channels().is_empty());
713 check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
714 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[2].node.get_our_node_id()], 100000);
715 check_closed_event!(nodes[2], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
719 fn test_shutdown_rebroadcast() {
720 do_test_shutdown_rebroadcast(0);
721 do_test_shutdown_rebroadcast(1);
722 do_test_shutdown_rebroadcast(2);
726 fn test_upfront_shutdown_script() {
727 // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
728 // enforce it at shutdown message
730 let mut config = UserConfig::default();
731 config.channel_handshake_config.announced_channel = true;
732 config.channel_handshake_limits.force_announced_channel_preference = false;
733 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
734 let user_cfgs = [None, Some(config), None];
735 let chanmon_cfgs = create_chanmon_cfgs(3);
736 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
737 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
738 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
740 // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
741 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000);
742 nodes[0].node.close_channel(&chan.2, &nodes[2].node.get_our_node_id()).unwrap();
743 let node_0_orig_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
744 let mut node_0_shutdown = node_0_orig_shutdown.clone();
745 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
746 // Test we enforce upfront_scriptpbukey if by providing a different one at closing that we warn
747 // the peer and ignore the message.
748 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
749 assert!(regex::Regex::new(r"Got shutdown request with a scriptpubkey \([A-Fa-f0-9]+\) which did not match their previous scriptpubkey.")
750 .unwrap().is_match(&check_warn_msg!(nodes[2], nodes[0].node.get_our_node_id(), chan.2)));
751 // This allows nodes[2] to retry the shutdown message, which should get a response:
752 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_orig_shutdown);
753 get_event_msg!(nodes[2], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
755 // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
756 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000);
757 nodes[0].node.close_channel(&chan.2, &nodes[2].node.get_our_node_id()).unwrap();
758 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
759 // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
760 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
761 let events = nodes[2].node.get_and_clear_pending_msg_events();
762 assert_eq!(events.len(), 1);
764 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
765 _ => panic!("Unexpected event"),
768 // We test that if case of peer non-signaling we don't enforce committed script at channel opening
769 *nodes[0].override_init_features.borrow_mut() = Some(nodes[0].node.init_features().clear_upfront_shutdown_script());
770 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000);
771 nodes[0].node.close_channel(&chan.2, &nodes[1].node.get_our_node_id()).unwrap();
772 let node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
773 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_1_shutdown);
774 check_added_monitors!(nodes[1], 1);
775 let events = nodes[1].node.get_and_clear_pending_msg_events();
776 assert_eq!(events.len(), 1);
778 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
779 _ => panic!("Unexpected event"),
782 // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
783 // channel smoothly, opt-out is from channel initiator here
784 *nodes[0].override_init_features.borrow_mut() = None;
785 let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000);
786 nodes[1].node.close_channel(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
787 check_added_monitors!(nodes[1], 1);
788 let node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
789 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
790 let events = nodes[0].node.get_and_clear_pending_msg_events();
791 assert_eq!(events.len(), 1);
793 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
794 _ => panic!("Unexpected event"),
797 //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
798 //// channel smoothly
799 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000);
800 nodes[1].node.close_channel(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
801 check_added_monitors!(nodes[1], 1);
802 let node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
803 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
804 let events = nodes[0].node.get_and_clear_pending_msg_events();
805 assert_eq!(events.len(), 2);
807 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
808 _ => panic!("Unexpected event"),
811 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
812 _ => panic!("Unexpected event"),
817 fn test_unsupported_anysegwit_upfront_shutdown_script() {
818 let chanmon_cfgs = create_chanmon_cfgs(2);
819 let mut node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
820 // Clear shutdown_anysegwit on initiator
821 *node_cfgs[0].override_init_features.borrow_mut() = Some(channelmanager::provided_init_features(&test_default_channel_config()).clear_shutdown_anysegwit());
822 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
823 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
825 // Use a non-v0 segwit script supported by option_shutdown_anysegwit
826 let anysegwit_shutdown_script = Builder::new()
828 .push_slice(&[0, 40])
831 // Check script when handling an open_channel message
832 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None, None).unwrap();
833 let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
834 open_channel.common_fields.shutdown_scriptpubkey = Some(anysegwit_shutdown_script.clone());
835 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel);
837 let events = nodes[1].node.get_and_clear_pending_msg_events();
838 assert_eq!(events.len(), 1);
840 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
841 assert_eq!(node_id, nodes[0].node.get_our_node_id());
842 assert_eq!(msg.data, "Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: OP_PUSHNUM_16 OP_PUSHBYTES_2 0028");
844 _ => panic!("Unexpected event"),
847 let chanmon_cfgs = create_chanmon_cfgs(2);
848 let mut node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
849 // Clear shutdown_anysegwit on responder
850 *node_cfgs[1].override_init_features.borrow_mut() = Some(channelmanager::provided_init_features(&test_default_channel_config()).clear_shutdown_anysegwit());
851 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
852 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
854 // Check script when handling an accept_channel message
855 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None, None).unwrap();
856 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
857 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel);
858 let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
859 accept_channel.common_fields.shutdown_scriptpubkey = Some(anysegwit_shutdown_script.clone());
860 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel);
862 let events = nodes[0].node.get_and_clear_pending_msg_events();
863 assert_eq!(events.len(), 1);
865 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
866 assert_eq!(node_id, nodes[1].node.get_our_node_id());
867 assert_eq!(msg.data, "Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: OP_PUSHNUM_16 OP_PUSHBYTES_2 0028");
869 _ => panic!("Unexpected event"),
871 check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: "Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: OP_PUSHNUM_16 OP_PUSHBYTES_2 0028".to_string() }
872 , [nodes[1].node.get_our_node_id()], 100000);
876 fn test_invalid_upfront_shutdown_script() {
877 let chanmon_cfgs = create_chanmon_cfgs(2);
878 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
879 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
880 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
882 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None, None).unwrap();
884 // Use a segwit v0 script with an unsupported witness program
885 let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
886 open_channel.common_fields.shutdown_scriptpubkey = Some(Builder::new().push_int(0)
889 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel);
891 let events = nodes[1].node.get_and_clear_pending_msg_events();
892 assert_eq!(events.len(), 1);
894 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
895 assert_eq!(node_id, nodes[0].node.get_our_node_id());
896 assert_eq!(msg.data, "Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: OP_0 OP_PUSHBYTES_2 0000");
898 _ => panic!("Unexpected event"),
903 fn test_segwit_v0_shutdown_script() {
904 let mut config = UserConfig::default();
905 config.channel_handshake_config.announced_channel = true;
906 config.channel_handshake_limits.force_announced_channel_preference = false;
907 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
908 let user_cfgs = [None, Some(config), None];
909 let chanmon_cfgs = create_chanmon_cfgs(3);
910 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
911 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
912 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
914 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
915 nodes[1].node.close_channel(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
916 check_added_monitors!(nodes[1], 1);
918 // Use a segwit v0 script supported even without option_shutdown_anysegwit
919 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
920 node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
921 .push_slice(&[0; 20])
923 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
925 let events = nodes[0].node.get_and_clear_pending_msg_events();
926 assert_eq!(events.len(), 2);
928 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
929 _ => panic!("Unexpected event"),
932 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
933 _ => panic!("Unexpected event"),
938 fn test_anysegwit_shutdown_script() {
939 let mut config = UserConfig::default();
940 config.channel_handshake_config.announced_channel = true;
941 config.channel_handshake_limits.force_announced_channel_preference = false;
942 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
943 let user_cfgs = [None, Some(config), None];
944 let chanmon_cfgs = create_chanmon_cfgs(3);
945 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
946 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
947 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
949 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
950 nodes[1].node.close_channel(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
951 check_added_monitors!(nodes[1], 1);
953 // Use a non-v0 segwit script supported by option_shutdown_anysegwit
954 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
955 node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
958 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
960 let events = nodes[0].node.get_and_clear_pending_msg_events();
961 assert_eq!(events.len(), 2);
963 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
964 _ => panic!("Unexpected event"),
967 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
968 _ => panic!("Unexpected event"),
973 fn test_unsupported_anysegwit_shutdown_script() {
974 let mut config = UserConfig::default();
975 config.channel_handshake_config.announced_channel = true;
976 config.channel_handshake_limits.force_announced_channel_preference = false;
977 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
978 let user_cfgs = [None, Some(config), None];
979 let chanmon_cfgs = create_chanmon_cfgs(3);
980 let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
981 *node_cfgs[0].override_init_features.borrow_mut() = Some(channelmanager::provided_init_features(&config).clear_shutdown_anysegwit());
982 *node_cfgs[1].override_init_features.borrow_mut() = Some(channelmanager::provided_init_features(&config).clear_shutdown_anysegwit());
983 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
984 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
986 // Check that using an unsupported shutdown script fails and a supported one succeeds.
987 let supported_shutdown_script = chanmon_cfgs[1].keys_manager.get_shutdown_scriptpubkey().unwrap();
988 let unsupported_witness_program = WitnessProgram::new(WitnessVersion::V16, &[0, 40]).unwrap();
989 let unsupported_shutdown_script =
990 ShutdownScript::new_witness_program(&unsupported_witness_program).unwrap();
991 chanmon_cfgs[1].keys_manager
992 .expect(OnGetShutdownScriptpubkey { returns: unsupported_shutdown_script.clone() })
993 .expect(OnGetShutdownScriptpubkey { returns: supported_shutdown_script });
995 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
996 match nodes[1].node.close_channel(&chan.2, &nodes[0].node.get_our_node_id()) {
997 Err(APIError::IncompatibleShutdownScript { script }) => {
998 assert_eq!(script.into_inner(), unsupported_shutdown_script.clone().into_inner());
1000 Err(e) => panic!("Unexpected error: {:?}", e),
1001 Ok(_) => panic!("Expected error"),
1003 nodes[1].node.close_channel(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
1004 check_added_monitors!(nodes[1], 1);
1006 // Use a non-v0 segwit script unsupported without option_shutdown_anysegwit
1007 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1008 node_0_shutdown.scriptpubkey = unsupported_shutdown_script.into_inner();
1009 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
1011 assert_eq!(&check_warn_msg!(nodes[0], nodes[1].node.get_our_node_id(), chan.2),
1012 "Got a nonstandard scriptpubkey (60020028) from remote peer");
1016 fn test_invalid_shutdown_script() {
1017 let mut config = UserConfig::default();
1018 config.channel_handshake_config.announced_channel = true;
1019 config.channel_handshake_limits.force_announced_channel_preference = false;
1020 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
1021 let user_cfgs = [None, Some(config), None];
1022 let chanmon_cfgs = create_chanmon_cfgs(3);
1023 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1024 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
1025 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1027 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
1028 nodes[1].node.close_channel(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
1029 check_added_monitors!(nodes[1], 1);
1031 // Use a segwit v0 script with an unsupported witness program
1032 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1033 node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
1034 .push_slice(&[0, 0])
1036 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
1038 assert_eq!(&check_warn_msg!(nodes[0], nodes[1].node.get_our_node_id(), chan.2),
1039 "Got a nonstandard scriptpubkey (00020000) from remote peer");
1043 fn test_user_shutdown_script() {
1044 let mut config = test_default_channel_config();
1045 config.channel_handshake_config.announced_channel = true;
1046 config.channel_handshake_limits.force_announced_channel_preference = false;
1047 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
1048 let user_cfgs = [None, Some(config), None];
1049 let chanmon_cfgs = create_chanmon_cfgs(3);
1050 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1051 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
1052 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1054 // Segwit v0 script of the form OP_0 <20-byte hash>
1055 let script = Builder::new().push_int(0)
1056 .push_slice(&[0; 20])
1059 let shutdown_script = ShutdownScript::try_from(script.clone()).unwrap();
1061 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
1062 nodes[1].node.close_channel_with_feerate_and_script(&chan.2, &nodes[0].node.get_our_node_id(), None, Some(shutdown_script)).unwrap();
1063 check_added_monitors!(nodes[1], 1);
1065 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1067 assert_eq!(node_0_shutdown.scriptpubkey, script);
1071 fn test_already_set_user_shutdown_script() {
1072 let mut config = test_default_channel_config();
1073 config.channel_handshake_config.announced_channel = true;
1074 config.channel_handshake_limits.force_announced_channel_preference = false;
1075 let user_cfgs = [None, Some(config), None];
1076 let chanmon_cfgs = create_chanmon_cfgs(3);
1077 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1078 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
1079 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1081 // Segwit v0 script of the form OP_0 <20-byte hash>
1082 let script = Builder::new().push_int(0)
1083 .push_slice(&[0; 20])
1086 let shutdown_script = ShutdownScript::try_from(script).unwrap();
1088 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
1089 let result = nodes[1].node.close_channel_with_feerate_and_script(&chan.2, &nodes[0].node.get_our_node_id(), None, Some(shutdown_script));
1091 assert_eq!(result, Err(APIError::APIMisuseError { err: "Cannot override shutdown script for a channel with one already set".to_string() }));
1094 #[derive(PartialEq)]
1101 fn do_test_closing_signed_reinit_timeout(timeout_step: TimeoutStep) {
1102 // The range-based closing signed negotiation allows the funder to restart the process with a
1103 // new range if the previous range did not overlap. This allows implementations to request user
1104 // intervention allowing users to enter a new fee range. We do not implement the sending side
1105 // of this, instead opting to allow users to enter an explicit "willing to pay up to X to avoid
1106 // force-closing" value and relying on that instead.
1108 // Here we run test the fundee side of that restart mechanism, implementing the funder side of
1110 let chanmon_cfgs = create_chanmon_cfgs(2);
1111 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1112 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1113 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1114 let chan_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
1116 send_payment(&nodes[0], &[&nodes[1]], 8_000_000);
1118 nodes[0].node.close_channel(&chan_id, &nodes[1].node.get_our_node_id()).unwrap();
1119 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1120 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
1121 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1122 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
1125 // Now we set nodes[1] to require a relatively high feerate for closing. This should result
1126 // in it rejecting nodes[0]'s initial closing_signed, giving nodes[0] a chance to try
1128 let mut feerate_lock = chanmon_cfgs[1].fee_estimator.sat_per_kw.lock().unwrap();
1129 *feerate_lock *= 10;
1132 let mut node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1133 // nodes[0] should use a "reasonable" feerate, well under the 10 sat/vByte that nodes[1] thinks
1134 // is the current prevailing feerate.
1135 assert!(node_0_closing_signed.fee_satoshis <= 500);
1137 if timeout_step != TimeoutStep::AfterShutdown {
1138 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1139 assert!(check_warn_msg!(nodes[1], nodes[0].node.get_our_node_id(), chan_id)
1140 .starts_with("Unable to come to consensus about closing feerate"));
1142 // Now deliver a mutated closing_signed indicating a higher acceptable fee range, which
1143 // nodes[1] should happily accept and respond to.
1144 node_0_closing_signed.fee_range.as_mut().unwrap().max_fee_satoshis *= 10;
1146 let mut node_0_per_peer_lock;
1147 let mut node_0_peer_state_lock;
1148 get_channel_ref!(nodes[0], nodes[1], node_0_per_peer_lock, node_0_peer_state_lock, chan_id).context_mut().closing_fee_limits.as_mut().unwrap().1 *= 10;
1150 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1151 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
1152 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
1153 let node_0_2nd_closing_signed = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1154 if timeout_step == TimeoutStep::NoTimeout {
1155 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.1.unwrap());
1156 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
1158 check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
1161 if timeout_step != TimeoutStep::NoTimeout {
1162 assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
1164 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1167 nodes[1].node.timer_tick_occurred();
1168 nodes[1].node.timer_tick_occurred();
1170 let txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1171 assert_eq!(txn.len(), 1);
1172 assert_eq!(txn[0].output.len(), 2);
1174 if timeout_step != TimeoutStep::NoTimeout {
1175 assert!((txn[0].output[0].script_pubkey.is_p2wpkh() &&
1176 txn[0].output[1].script_pubkey.is_p2wsh()) ||
1177 (txn[0].output[1].script_pubkey.is_p2wpkh() &&
1178 txn[0].output[0].script_pubkey.is_p2wsh()));
1179 check_closed_broadcast!(nodes[1], true);
1180 check_added_monitors!(nodes[1], 1);
1181 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "closing_signed negotiation failed to finish within two timer ticks".to_string() }
1182 , [nodes[0].node.get_our_node_id()], 100000);
1184 assert!(txn[0].output[0].script_pubkey.is_p2wpkh());
1185 assert!(txn[0].output[1].script_pubkey.is_p2wpkh());
1187 let events = nodes[1].node.get_and_clear_pending_msg_events();
1188 assert_eq!(events.len(), 1);
1190 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1191 assert_eq!(msg.contents.flags & 2, 2);
1193 _ => panic!("Unexpected event"),
1199 fn test_closing_signed_reinit_timeout() {
1200 do_test_closing_signed_reinit_timeout(TimeoutStep::AfterShutdown);
1201 do_test_closing_signed_reinit_timeout(TimeoutStep::AfterClosingSigned);
1202 do_test_closing_signed_reinit_timeout(TimeoutStep::NoTimeout);
1205 fn do_simple_legacy_shutdown_test(high_initiator_fee: bool) {
1206 // A simpe test of the legacy shutdown fee negotiation logic.
1207 let chanmon_cfgs = create_chanmon_cfgs(2);
1208 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1209 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1210 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1212 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
1214 if high_initiator_fee {
1215 // If high_initiator_fee is set, set nodes[0]'s feerate significantly higher. This
1216 // shouldn't impact the flow at all given nodes[1] will happily accept the higher fee.
1217 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
1218 *feerate_lock *= 10;
1221 nodes[0].node.close_channel(&chan.2, &nodes[1].node.get_our_node_id()).unwrap();
1222 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1223 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
1224 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1225 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
1227 let mut node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1228 node_0_closing_signed.fee_range = None;
1229 if high_initiator_fee {
1230 assert!(node_0_closing_signed.fee_satoshis > 500);
1232 assert!(node_0_closing_signed.fee_satoshis < 500);
1235 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1236 let (_, mut node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1237 node_1_closing_signed.as_mut().unwrap().fee_range = None;
1239 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
1240 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1241 assert!(node_0_none.is_none());
1242 check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
1243 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
1247 fn simple_legacy_shutdown_test() {
1248 do_simple_legacy_shutdown_test(false);
1249 do_simple_legacy_shutdown_test(true);
1253 fn simple_target_feerate_shutdown() {
1254 // Simple test of target in `close_channel_with_target_feerate`.
1255 let chanmon_cfgs = create_chanmon_cfgs(2);
1256 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1257 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1258 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1260 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
1261 let chan_id = chan.2;
1263 nodes[0].node.close_channel_with_feerate_and_script(&chan_id, &nodes[1].node.get_our_node_id(), Some(253 * 10), None).unwrap();
1264 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1265 nodes[1].node.close_channel_with_feerate_and_script(&chan_id, &nodes[0].node.get_our_node_id(), Some(253 * 5), None).unwrap();
1266 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1268 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
1269 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
1271 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1272 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1273 let (_, node_1_closing_signed_opt) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1274 let node_1_closing_signed = node_1_closing_signed_opt.unwrap();
1276 // nodes[1] was passed a target which was larger than the current channel feerate, which it
1277 // should ignore in favor of the channel fee, as there is no use demanding a minimum higher
1278 // than what will be paid on a force-close transaction. Note that we have to consider rounding,
1279 // so only check that we're within 10 sats.
1280 assert!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis >=
1281 node_1_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis * 10 - 5);
1282 assert!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis <=
1283 node_1_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis * 10 + 5);
1285 // Further, because nodes[0]'s target fee is larger than the `Normal` fee estimation plus our
1286 // force-closure-avoidance buffer, min should equal max, and the nodes[1]-selected fee should
1287 // be the nodes[0] only available fee.
1288 assert_eq!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis,
1289 node_0_closing_signed.fee_range.as_ref().unwrap().max_fee_satoshis);
1290 assert_eq!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis,
1291 node_0_closing_signed.fee_satoshis);
1292 assert_eq!(node_0_closing_signed.fee_satoshis, node_1_closing_signed.fee_satoshis);
1294 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
1295 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1296 assert!(node_0_none.is_none());
1297 check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
1298 check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
1301 fn do_outbound_update_no_early_closing_signed(use_htlc: bool) {
1302 // Previously, if we have a pending inbound HTLC (or fee update) on a channel which has
1303 // initiated shutdown, we'd send our initial closing_signed immediately after receiving the
1304 // peer's last RAA to remove the HTLC/fee update, but before receiving their final
1305 // commitment_signed for a commitment without the HTLC/with the new fee. This caused at least
1306 // LDK peers to force-close as we initiated closing_signed prior to the channel actually being
1307 // fully empty of pending updates/HTLCs.
1308 let chanmon_cfgs = create_chanmon_cfgs(2);
1309 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1310 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1311 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1313 let chan_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
1315 send_payment(&nodes[0], &[&nodes[1]], 1_000_000);
1316 let payment_hash_opt = if use_htlc {
1317 Some(route_payment(&nodes[1], &[&nodes[0]], 10_000).1)
1323 nodes[0].node.fail_htlc_backwards(&payment_hash_opt.unwrap());
1324 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[0],
1325 [HTLCDestination::FailedPayment { payment_hash: payment_hash_opt.unwrap() }]);
1327 *chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap() *= 10;
1328 nodes[0].node.timer_tick_occurred();
1330 let updates = get_htlc_update_msgs(&nodes[0], &nodes[1].node.get_our_node_id());
1331 check_added_monitors(&nodes[0], 1);
1333 nodes[1].node.close_channel(&chan_id, &nodes[0].node.get_our_node_id()).unwrap();
1334 let node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1335 nodes[0].node.close_channel(&chan_id, &nodes[1].node.get_our_node_id()).unwrap();
1336 let node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1338 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
1339 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_1_shutdown);
1342 nodes[1].node.handle_update_fail_htlc(&nodes[0].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
1344 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &updates.update_fee.unwrap());
1346 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
1347 check_added_monitors(&nodes[1], 1);
1348 let (bs_raa, bs_cs) = get_revoke_commit_msgs(&nodes[1], &nodes[0].node.get_our_node_id());
1350 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1351 check_added_monitors(&nodes[0], 1);
1353 // At this point the Channel on nodes[0] has no record of any HTLCs but the latest
1354 // broadcastable commitment does contain the HTLC (but only the ChannelMonitor knows this).
1355 // Thus, the channel should not yet initiate closing_signed negotiation (but previously did).
1356 assert_eq!(nodes[0].node.get_and_clear_pending_msg_events(), Vec::new());
1358 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1359 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs);
1360 check_added_monitors(&nodes[0], 1);
1361 assert_eq!(nodes[0].node.get_and_clear_pending_msg_events(), Vec::new());
1363 expect_channel_shutdown_state!(nodes[0], chan_id, ChannelShutdownState::ResolvingHTLCs);
1364 assert_eq!(nodes[0].node.get_and_clear_pending_msg_events(), Vec::new());
1365 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_id).unwrap().clone();
1366 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1368 let as_raa_closing_signed = nodes[0].node.get_and_clear_pending_msg_events();
1369 assert_eq!(as_raa_closing_signed.len(), 2);
1371 if let MessageSendEvent::SendRevokeAndACK { msg, .. } = &as_raa_closing_signed[0] {
1372 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &msg);
1373 check_added_monitors(&nodes[1], 1);
1375 expect_payment_failed!(nodes[1], payment_hash_opt.unwrap(), true);
1377 } else { panic!("Unexpected message {:?}", as_raa_closing_signed[0]); }
1379 if let MessageSendEvent::SendClosingSigned { msg, .. } = &as_raa_closing_signed[1] {
1380 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &msg);
1381 } else { panic!("Unexpected message {:?}", as_raa_closing_signed[1]); }
1383 let bs_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
1384 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &bs_closing_signed);
1385 let (_, as_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1386 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &as_2nd_closing_signed.unwrap());
1387 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1388 assert!(node_1_none.is_none());
1390 check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
1391 check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
1395 fn outbound_update_no_early_closing_signed() {
1396 do_outbound_update_no_early_closing_signed(true);
1397 do_outbound_update_no_early_closing_signed(false);
1401 fn batch_funding_failure() {
1402 // Provides test coverage of batch funding failure, which previously deadlocked
1403 let chanmon_cfgs = create_chanmon_cfgs(4);
1404 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1405 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1406 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1408 let temp_chan_id_a = exchange_open_accept_chan(&nodes[0], &nodes[1], 1_000_000, 0);
1409 let temp_chan_id_b = exchange_open_accept_chan(&nodes[0], &nodes[2], 1_000_000, 0);
1411 let events = nodes[0].node.get_and_clear_pending_events();
1412 assert_eq!(events.len(), 2);
1413 // Build a transaction which only has the output for one of the two channels we're trying to
1414 // confirm. Previously this led to a deadlock in channel closure handling.
1415 let mut tx = Transaction { version: Version::TWO, lock_time: LockTime::ZERO, input: Vec::new(), output: Vec::new() };
1416 let mut chans = Vec::new();
1417 for (idx, ev) in events.iter().enumerate() {
1418 if let Event::FundingGenerationReady { temporary_channel_id, counterparty_node_id, output_script, .. } = ev {
1420 tx.output.push(TxOut { value: Amount::from_sat(1_000_000), script_pubkey: output_script.clone() });
1422 chans.push((temporary_channel_id, counterparty_node_id));
1423 } else { panic!(); }
1426 let err = "Error in transaction funding: Misuse error: No output matched the script_pubkey and value in the FundingGenerationReady event".to_string();
1427 let temp_err = "No output matched the script_pubkey and value in the FundingGenerationReady event".to_string();
1428 let post_funding_chan_id_a = ChannelId::v1_from_funding_txid(tx.txid().as_ref(), 0);
1430 ExpectedCloseEvent::from_id_reason(post_funding_chan_id_a, true, ClosureReason::ProcessingError { err: err.clone() }),
1431 ExpectedCloseEvent::from_id_reason(temp_chan_id_b, false, ClosureReason::ProcessingError { err: temp_err }),
1434 nodes[0].node.batch_funding_transaction_generated(&chans, tx).unwrap_err();
1436 let msgs = nodes[0].node.get_and_clear_pending_msg_events();
1437 assert_eq!(msgs.len(), 3);
1438 // We currently spuriously send `FundingCreated` for the first channel and then immediately
1439 // fail both channels, which isn't ideal but should be fine.
1440 assert!(msgs.iter().any(|msg| {
1441 if let MessageSendEvent::HandleError { action: msgs::ErrorAction::SendErrorMessage {
1442 msg: msgs::ErrorMessage { channel_id, .. }, ..
1444 *channel_id == temp_chan_id_b
1447 let funding_created_pos = msgs.iter().position(|msg| {
1448 if let MessageSendEvent::SendFundingCreated { msg: msgs::FundingCreated { temporary_channel_id, .. }, .. } = msg {
1449 assert_eq!(*temporary_channel_id, temp_chan_id_a);
1453 let funded_channel_close_pos = msgs.iter().position(|msg| {
1454 if let MessageSendEvent::HandleError { action: msgs::ErrorAction::SendErrorMessage {
1455 msg: msgs::ErrorMessage { channel_id, .. }, ..
1457 *channel_id == post_funding_chan_id_a
1461 // The error message uses the funded channel_id so must come after the funding_created
1462 assert!(funded_channel_close_pos > funding_created_pos);
1464 check_closed_events(&nodes[0], &close);
1465 assert_eq!(nodes[0].node.list_channels().len(), 0);