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::channelmanager::{self, PaymentSendFailure, PaymentId, RecipientOnionFields, Retry, ChannelShutdownState, ChannelDetails};
18 use crate::routing::router::{PaymentParameters, get_route, RouteParameters};
20 use crate::ln::types::ChannelId;
21 use crate::ln::msgs::{ChannelMessageHandler, ErrorAction};
22 use crate::ln::onion_utils::INVALID_ONION_BLINDING;
23 use crate::ln::script::ShutdownScript;
24 use crate::util::test_utils;
25 use crate::util::test_utils::OnGetShutdownScriptpubkey;
26 use crate::util::errors::APIError;
27 use crate::util::config::UserConfig;
28 use crate::util::string::UntrustedString;
29 use crate::prelude::*;
31 use bitcoin::{Transaction, TxOut, WitnessProgram, WitnessVersion};
32 use bitcoin::amount::Amount;
33 use bitcoin::blockdata::locktime::absolute::LockTime;
34 use bitcoin::blockdata::script::Builder;
35 use bitcoin::blockdata::opcodes;
36 use bitcoin::network::Network;
37 use bitcoin::transaction::Version;
39 use crate::ln::functional_test_utils::*;
42 fn pre_funding_lock_shutdown_test() {
43 // Test sending a shutdown prior to channel_ready after funding generation
44 let chanmon_cfgs = create_chanmon_cfgs(2);
45 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
46 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
47 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
48 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0);
49 mine_transaction(&nodes[0], &tx);
50 mine_transaction(&nodes[1], &tx);
52 nodes[0].node.close_channel(&ChannelId::v1_from_funding_outpoint(OutPoint { txid: tx.txid(), index: 0 }), &nodes[1].node.get_our_node_id()).unwrap();
53 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
54 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
55 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
56 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
58 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
59 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
60 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
61 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
62 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
63 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
64 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
65 assert!(node_1_none.is_none());
67 assert!(nodes[0].node.list_channels().is_empty());
68 assert!(nodes[1].node.list_channels().is_empty());
69 check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 8000000);
70 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 8000000);
74 fn expect_channel_shutdown_state() {
75 // Test sending a shutdown prior to channel_ready after funding generation
76 let chanmon_cfgs = create_chanmon_cfgs(2);
77 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
78 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
79 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
80 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
82 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::NotShuttingDown);
84 nodes[0].node.close_channel(&chan_1.2, &nodes[1].node.get_our_node_id()).unwrap();
86 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::ShutdownInitiated);
87 expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::NotShuttingDown);
89 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
90 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
92 // node1 goes into NegotiatingClosingFee since there are no HTLCs in flight, note that it
93 // doesnt mean that node1 has sent/recved its closing signed message
94 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::ShutdownInitiated);
95 expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::NegotiatingClosingFee);
97 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
98 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
100 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::NegotiatingClosingFee);
101 expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::NegotiatingClosingFee);
103 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
104 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
105 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
106 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
107 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
108 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
109 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
110 assert!(node_1_none.is_none());
112 assert!(nodes[0].node.list_channels().is_empty());
113 assert!(nodes[1].node.list_channels().is_empty());
114 check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
115 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
119 fn expect_channel_shutdown_state_with_htlc() {
120 // Test sending a shutdown with outstanding updates pending.
121 let chanmon_cfgs = create_chanmon_cfgs(3);
122 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
123 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
124 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
125 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
126 let _chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
128 let (payment_preimage_0, payment_hash_0, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100_000);
130 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::NotShuttingDown);
131 expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::NotShuttingDown);
133 nodes[0].node.close_channel(&chan_1.2, &nodes[1].node.get_our_node_id()).unwrap();
135 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::ShutdownInitiated);
136 expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::NotShuttingDown);
138 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
139 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
141 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::ShutdownInitiated);
142 expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::ResolvingHTLCs);
144 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
145 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
147 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::ResolvingHTLCs);
148 expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::ResolvingHTLCs);
150 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
151 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
153 // Claim Funds on Node2
154 nodes[2].node.claim_funds(payment_preimage_0);
155 check_added_monitors!(nodes[2], 1);
156 expect_payment_claimed!(nodes[2], payment_hash_0, 100_000);
158 // Fulfil HTLCs on node1 and node0
159 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
160 assert!(updates.update_add_htlcs.is_empty());
161 assert!(updates.update_fail_htlcs.is_empty());
162 assert!(updates.update_fail_malformed_htlcs.is_empty());
163 assert!(updates.update_fee.is_none());
164 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
165 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
166 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), false, false);
167 check_added_monitors!(nodes[1], 1);
168 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
169 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
171 // Still in "resolvingHTLCs" on chan1 after htlc removed on chan2
172 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::ResolvingHTLCs);
173 expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::ResolvingHTLCs);
175 assert!(updates_2.update_add_htlcs.is_empty());
176 assert!(updates_2.update_fail_htlcs.is_empty());
177 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
178 assert!(updates_2.update_fee.is_none());
179 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
180 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
181 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
182 expect_payment_sent!(nodes[0], payment_preimage_0);
184 // all htlcs removed, chan1 advances to NegotiatingClosingFee
185 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::NegotiatingClosingFee);
186 expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::NegotiatingClosingFee);
188 // ClosingSignNegotion process
189 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
190 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
191 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
192 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
193 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
194 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
195 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
196 assert!(node_1_none.is_none());
197 check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
198 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
200 // Shutdown basically removes the channelDetails, testing of shutdowncomplete state unnecessary
201 assert!(nodes[0].node.list_channels().is_empty());
205 fn test_lnd_bug_6039() {
206 // LND sends a nonsense error message any time it gets a shutdown if there are still HTLCs
207 // pending. We currently swallow that error to work around LND's bug #6039. This test emulates
208 // the LND nonsense and ensures we at least kinda handle it.
209 let chanmon_cfgs = create_chanmon_cfgs(2);
210 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
211 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
212 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
213 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
215 let (payment_preimage, ..) = route_payment(&nodes[0], &[&nodes[1]], 100_000);
217 nodes[0].node.close_channel(&chan.2, &nodes[1].node.get_our_node_id()).unwrap();
218 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
219 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
221 // Generate an lnd-like error message and check that we respond by simply screaming louder to
222 // see if LND will accept our protocol compliance.
223 let err_msg = msgs::ErrorMessage { channel_id: chan.2, data: "link failed to shutdown".to_string() };
224 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &err_msg);
225 let node_a_responses = nodes[0].node.get_and_clear_pending_msg_events();
226 assert_eq!(node_a_responses[0], MessageSendEvent::SendShutdown {
227 node_id: nodes[1].node.get_our_node_id(),
228 msg: node_0_shutdown,
230 if let MessageSendEvent::HandleError { action: msgs::ErrorAction::SendWarningMessage { .. }, .. }
231 = node_a_responses[1] {} else { panic!(); }
233 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
235 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
236 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
238 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
240 // Assume that LND will eventually respond to our Shutdown if we clear all the remaining HTLCs
241 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
243 // ClosingSignNegotion process
244 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
245 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
246 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
247 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
248 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
249 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
250 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
251 assert!(node_1_none.is_none());
252 check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
253 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
255 // Shutdown basically removes the channelDetails, testing of shutdowncomplete state unnecessary
256 assert!(nodes[0].node.list_channels().is_empty());
260 fn shutdown_on_unfunded_channel() {
261 // Test receiving a shutdown prior to funding generation
262 let chanmon_cfgs = create_chanmon_cfgs(2);
263 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
264 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
265 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
267 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1_000_000, 100_000, 0, None, None).unwrap();
268 let open_chan = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
270 // Create a dummy P2WPKH script
271 let script = Builder::new().push_int(0)
272 .push_slice(&[0; 20])
275 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &msgs::Shutdown {
276 channel_id: open_chan.common_fields.temporary_channel_id, scriptpubkey: script,
278 check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyCoopClosedUnfundedChannel, [nodes[1].node.get_our_node_id()], 1_000_000);
282 fn close_on_unfunded_channel() {
283 // Test the user asking us to close prior to funding generation
284 let chanmon_cfgs = create_chanmon_cfgs(2);
285 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
286 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
287 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
289 let chan_id = nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1_000_000, 100_000, 0, None, None).unwrap();
290 let _open_chan = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
292 nodes[0].node.close_channel(&chan_id, &nodes[1].node.get_our_node_id()).unwrap();
293 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed, [nodes[1].node.get_our_node_id()], 1_000_000);
297 fn expect_channel_shutdown_state_with_force_closure() {
298 // Test sending a shutdown prior to channel_ready after funding generation
299 let chanmon_cfgs = create_chanmon_cfgs(2);
300 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
301 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
302 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
303 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
305 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::NotShuttingDown);
306 expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::NotShuttingDown);
308 nodes[1].node.force_close_broadcasting_latest_txn(&chan_1.2, &nodes[0].node.get_our_node_id()).unwrap();
309 check_closed_broadcast!(nodes[1], true);
310 check_added_monitors!(nodes[1], 1);
312 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::NotShuttingDown);
313 assert!(nodes[1].node.list_channels().is_empty());
315 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
316 assert_eq!(node_txn.len(), 1);
317 check_spends!(node_txn[0], chan_1.3);
318 mine_transaction(&nodes[0], &node_txn[0]);
319 check_added_monitors!(nodes[0], 1);
321 assert!(nodes[0].node.list_channels().is_empty());
322 assert!(nodes[1].node.list_channels().is_empty());
323 check_closed_broadcast!(nodes[0], true);
324 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed, [nodes[1].node.get_our_node_id()], 100000);
325 check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed, [nodes[0].node.get_our_node_id()], 100000);
329 fn updates_shutdown_wait() {
330 // Test sending a shutdown with outstanding updates pending
331 let chanmon_cfgs = create_chanmon_cfgs(3);
332 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
333 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
334 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
335 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
336 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
337 let logger = test_utils::TestLogger::new();
338 let scorer = test_utils::TestScorer::new();
339 let keys_manager = test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
340 let random_seed_bytes = keys_manager.get_secure_random_bytes();
342 let (payment_preimage_0, payment_hash_0, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100_000);
344 nodes[0].node.close_channel(&chan_1.2, &nodes[1].node.get_our_node_id()).unwrap();
345 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
346 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
347 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
348 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
350 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
351 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
353 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
355 let payment_params_1 = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id(), TEST_FINAL_CLTV)
356 .with_bolt11_features(nodes[1].node.bolt11_invoice_features()).unwrap();
357 let route_params = RouteParameters::from_payment_params_and_value(payment_params_1, 100_000);
358 let route_1 = get_route(&nodes[0].node.get_our_node_id(), &route_params,
359 &nodes[0].network_graph.read_only(), None, &logger, &scorer, &Default::default(), &random_seed_bytes).unwrap();
360 let payment_params_2 = PaymentParameters::from_node_id(nodes[0].node.get_our_node_id(), TEST_FINAL_CLTV)
361 .with_bolt11_features(nodes[0].node.bolt11_invoice_features()).unwrap();
362 let route_params = RouteParameters::from_payment_params_and_value(payment_params_2, 100_000);
363 let route_2 = get_route(&nodes[1].node.get_our_node_id(), &route_params,
364 &nodes[1].network_graph.read_only(), None, &logger, &scorer, &Default::default(), &random_seed_bytes).unwrap();
365 unwrap_send_err!(nodes[0].node.send_payment_with_route(&route_1, payment_hash,
366 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)
367 ), true, APIError::ChannelUnavailable {..}, {});
368 unwrap_send_err!(nodes[1].node.send_payment_with_route(&route_2, payment_hash,
369 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)
370 ), true, APIError::ChannelUnavailable {..}, {});
372 nodes[2].node.claim_funds(payment_preimage_0);
373 check_added_monitors!(nodes[2], 1);
374 expect_payment_claimed!(nodes[2], payment_hash_0, 100_000);
376 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
377 assert!(updates.update_add_htlcs.is_empty());
378 assert!(updates.update_fail_htlcs.is_empty());
379 assert!(updates.update_fail_malformed_htlcs.is_empty());
380 assert!(updates.update_fee.is_none());
381 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
382 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
383 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), false, false);
384 check_added_monitors!(nodes[1], 1);
385 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
386 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
388 assert!(updates_2.update_add_htlcs.is_empty());
389 assert!(updates_2.update_fail_htlcs.is_empty());
390 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
391 assert!(updates_2.update_fee.is_none());
392 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
393 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
394 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
395 expect_payment_sent!(nodes[0], payment_preimage_0);
397 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
398 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
399 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
400 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
401 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
402 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
403 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
404 assert!(node_1_none.is_none());
405 check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
406 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
408 assert!(nodes[0].node.list_channels().is_empty());
410 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
411 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
412 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
413 assert!(nodes[1].node.list_channels().is_empty());
414 assert!(nodes[2].node.list_channels().is_empty());
415 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[2].node.get_our_node_id()], 100000);
416 check_closed_event!(nodes[2], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
420 fn htlc_fail_async_shutdown() {
421 do_htlc_fail_async_shutdown(true);
422 do_htlc_fail_async_shutdown(false);
425 fn do_htlc_fail_async_shutdown(blinded_recipient: bool) {
426 // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
427 let chanmon_cfgs = create_chanmon_cfgs(3);
428 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
429 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
430 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
431 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
432 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
434 let amt_msat = 100000;
435 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash(&nodes[2], Some(amt_msat), None);
436 let route_params = if blinded_recipient {
437 crate::ln::blinded_payment_tests::get_blinded_route_parameters(
438 amt_msat, our_payment_secret, 1, 100000000,
439 nodes.iter().skip(1).map(|n| n.node.get_our_node_id()).collect(), &[&chan_2.0.contents],
440 &chanmon_cfgs[2].keys_manager)
442 RouteParameters::from_payment_params_and_value(
443 PaymentParameters::from_node_id(nodes[2].node.get_our_node_id(), TEST_FINAL_CLTV), amt_msat)
445 nodes[0].node.send_payment(our_payment_hash,
446 RecipientOnionFields::secret_only(our_payment_secret),
447 PaymentId(our_payment_hash.0), route_params, Retry::Attempts(0)).unwrap();
448 check_added_monitors!(nodes[0], 1);
449 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
450 assert_eq!(updates.update_add_htlcs.len(), 1);
451 assert!(updates.update_fulfill_htlcs.is_empty());
452 assert!(updates.update_fail_htlcs.is_empty());
453 assert!(updates.update_fail_malformed_htlcs.is_empty());
454 assert!(updates.update_fee.is_none());
456 nodes[1].node.close_channel(&chan_1.2, &nodes[0].node.get_our_node_id()).unwrap();
457 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
458 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
459 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
461 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
462 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
463 check_added_monitors!(nodes[1], 1);
464 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
465 commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false, false);
467 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
468 assert!(updates_2.update_add_htlcs.is_empty());
469 assert!(updates_2.update_fulfill_htlcs.is_empty());
470 assert_eq!(updates_2.update_fail_htlcs.len(), 1);
471 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
472 assert!(updates_2.update_fee.is_none());
474 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]);
475 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
477 if blinded_recipient {
478 expect_payment_failed_conditions(&nodes[0], our_payment_hash, false,
479 PaymentFailedConditions::new().expected_htlc_error_data(INVALID_ONION_BLINDING, &[0; 32]));
481 expect_payment_failed_with_update!(nodes[0], our_payment_hash, false, chan_2.0.contents.short_channel_id, true);
484 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
485 assert_eq!(msg_events.len(), 1);
486 let node_0_closing_signed = match msg_events[0] {
487 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
488 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
491 _ => panic!("Unexpected event"),
494 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
495 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
496 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
497 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
498 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
499 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
500 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
501 assert!(node_1_none.is_none());
503 assert!(nodes[0].node.list_channels().is_empty());
505 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
506 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
507 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
508 assert!(nodes[1].node.list_channels().is_empty());
509 assert!(nodes[2].node.list_channels().is_empty());
510 check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
511 let event1 = ExpectedCloseEvent {
512 channel_capacity_sats: Some(100000),
514 counterparty_node_id: Some(nodes[0].node.get_our_node_id()),
515 discard_funding: false,
516 reason: Some(ClosureReason::LocallyInitiatedCooperativeClosure),
517 channel_funding_txo: None,
518 user_channel_id: None,
520 let event2 = ExpectedCloseEvent {
521 channel_capacity_sats: Some(100000),
523 counterparty_node_id: Some(nodes[2].node.get_our_node_id()),
524 discard_funding: false,
525 reason: Some(ClosureReason::CounterpartyInitiatedCooperativeClosure),
526 channel_funding_txo: None,
527 user_channel_id: None,
529 check_closed_events(&nodes[1], &[event1, event2]);
530 check_closed_event!(nodes[2], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
533 fn do_test_shutdown_rebroadcast(recv_count: u8) {
534 // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
535 // messages delivered prior to disconnect
536 let chanmon_cfgs = create_chanmon_cfgs(3);
537 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
538 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
539 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
540 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
541 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
543 let (payment_preimage, payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100_000);
545 nodes[1].node.close_channel(&chan_1.2, &nodes[0].node.get_our_node_id()).unwrap();
546 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
548 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
549 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
551 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
555 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
556 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
558 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
559 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
561 let node_0_reestablish = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
562 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
563 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
565 let node_1_reestablish = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
567 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish);
568 let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
569 assert!(node_1_shutdown == node_1_2nd_shutdown);
571 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish);
572 let node_0_2nd_shutdown = if recv_count > 0 {
573 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
574 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
577 let node_0_chan_update = get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
578 assert_eq!(node_0_chan_update.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
579 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
580 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
582 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_2nd_shutdown);
584 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
585 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
587 nodes[2].node.claim_funds(payment_preimage);
588 check_added_monitors!(nodes[2], 1);
589 expect_payment_claimed!(nodes[2], payment_hash, 100_000);
591 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
592 assert!(updates.update_add_htlcs.is_empty());
593 assert!(updates.update_fail_htlcs.is_empty());
594 assert!(updates.update_fail_malformed_htlcs.is_empty());
595 assert!(updates.update_fee.is_none());
596 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
597 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
598 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), false, false);
599 check_added_monitors!(nodes[1], 1);
600 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
601 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
603 assert!(updates_2.update_add_htlcs.is_empty());
604 assert!(updates_2.update_fail_htlcs.is_empty());
605 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
606 assert!(updates_2.update_fee.is_none());
607 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
608 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
609 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
610 expect_payment_sent!(nodes[0], payment_preimage);
612 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
614 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
615 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
616 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
617 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
618 assert!(node_0_2nd_closing_signed.is_some());
621 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
622 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
624 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
625 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
627 let node_1_2nd_reestablish = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
628 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
629 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
632 // If all closing_signeds weren't delivered we can just resume where we left off...
633 let node_0_2nd_reestablish = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
635 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
636 let node_0_msgs = nodes[0].node.get_and_clear_pending_msg_events();
637 assert_eq!(node_0_msgs.len(), 2);
638 let node_0_2nd_closing_signed = match node_0_msgs[1] {
639 MessageSendEvent::SendClosingSigned { ref msg, .. } => {
640 assert_eq!(node_0_closing_signed, *msg);
646 let node_0_3rd_shutdown = match node_0_msgs[0] {
647 MessageSendEvent::SendShutdown { ref msg, .. } => {
648 assert_eq!(node_0_2nd_shutdown, *msg);
653 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
655 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
656 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
657 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
659 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_3rd_shutdown);
660 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
662 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_3rd_shutdown);
664 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed);
665 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
666 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
667 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
668 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
669 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
670 assert!(node_1_none.is_none());
671 check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
673 // If one node, however, received + responded with an identical closing_signed we end
674 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
675 // There isn't really anything better we can do simply, but in the future we might
676 // explore storing a set of recently-closed channels that got disconnected during
677 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
678 // give our counterparty enough time to (potentially) broadcast a cooperative closing
680 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
682 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
683 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
684 assert_eq!(msg_events.len(), 2);
685 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[1] {
687 &ErrorAction::SendErrorMessage { ref msg } => {
688 nodes[1].node.handle_error(&nodes[0].node.get_our_node_id(), &msg);
689 assert_eq!(msg.channel_id, chan_1.2);
691 _ => panic!("Unexpected event!"),
693 } else { panic!("Needed SendErrorMessage close"); }
695 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
696 // checks it, but in this case nodes[1] didn't ever get a chance to receive a
697 // closing_signed so we do it ourselves
698 check_closed_broadcast!(nodes[1], false);
699 check_added_monitors!(nodes[1], 1);
700 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())) }
701 , [nodes[0].node.get_our_node_id()], 100000);
704 assert!(nodes[0].node.list_channels().is_empty());
706 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
707 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
708 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
709 assert!(nodes[1].node.list_channels().is_empty());
710 assert!(nodes[2].node.list_channels().is_empty());
711 check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
712 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[2].node.get_our_node_id()], 100000);
713 check_closed_event!(nodes[2], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
717 fn test_shutdown_rebroadcast() {
718 do_test_shutdown_rebroadcast(0);
719 do_test_shutdown_rebroadcast(1);
720 do_test_shutdown_rebroadcast(2);
724 fn test_upfront_shutdown_script() {
725 // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
726 // enforce it at shutdown message
728 let mut config = UserConfig::default();
729 config.channel_handshake_config.announced_channel = true;
730 config.channel_handshake_limits.force_announced_channel_preference = false;
731 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
732 let user_cfgs = [None, Some(config), None];
733 let chanmon_cfgs = create_chanmon_cfgs(3);
734 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
735 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
736 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
738 // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
739 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000);
740 nodes[0].node.close_channel(&chan.2, &nodes[2].node.get_our_node_id()).unwrap();
741 let node_0_orig_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
742 let mut node_0_shutdown = node_0_orig_shutdown.clone();
743 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
744 // Test we enforce upfront_scriptpbukey if by providing a different one at closing that we warn
745 // the peer and ignore the message.
746 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
747 assert!(regex::Regex::new(r"Got shutdown request with a scriptpubkey \([A-Fa-f0-9]+\) which did not match their previous scriptpubkey.")
748 .unwrap().is_match(&check_warn_msg!(nodes[2], nodes[0].node.get_our_node_id(), chan.2)));
749 // This allows nodes[2] to retry the shutdown message, which should get a response:
750 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_orig_shutdown);
751 get_event_msg!(nodes[2], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
753 // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
754 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000);
755 nodes[0].node.close_channel(&chan.2, &nodes[2].node.get_our_node_id()).unwrap();
756 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
757 // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
758 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
759 let events = nodes[2].node.get_and_clear_pending_msg_events();
760 assert_eq!(events.len(), 1);
762 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
763 _ => panic!("Unexpected event"),
766 // We test that if case of peer non-signaling we don't enforce committed script at channel opening
767 *nodes[0].override_init_features.borrow_mut() = Some(nodes[0].node.init_features().clear_upfront_shutdown_script());
768 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000);
769 nodes[0].node.close_channel(&chan.2, &nodes[1].node.get_our_node_id()).unwrap();
770 let node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
771 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_1_shutdown);
772 check_added_monitors!(nodes[1], 1);
773 let events = nodes[1].node.get_and_clear_pending_msg_events();
774 assert_eq!(events.len(), 1);
776 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
777 _ => panic!("Unexpected event"),
780 // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
781 // channel smoothly, opt-out is from channel initiator here
782 *nodes[0].override_init_features.borrow_mut() = None;
783 let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000);
784 nodes[1].node.close_channel(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
785 check_added_monitors!(nodes[1], 1);
786 let node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
787 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
788 let events = nodes[0].node.get_and_clear_pending_msg_events();
789 assert_eq!(events.len(), 1);
791 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
792 _ => panic!("Unexpected event"),
795 //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
796 //// channel smoothly
797 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000);
798 nodes[1].node.close_channel(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
799 check_added_monitors!(nodes[1], 1);
800 let node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
801 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
802 let events = nodes[0].node.get_and_clear_pending_msg_events();
803 assert_eq!(events.len(), 2);
805 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
806 _ => panic!("Unexpected event"),
809 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
810 _ => panic!("Unexpected event"),
815 fn test_unsupported_anysegwit_upfront_shutdown_script() {
816 let chanmon_cfgs = create_chanmon_cfgs(2);
817 let mut node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
818 // Clear shutdown_anysegwit on initiator
819 *node_cfgs[0].override_init_features.borrow_mut() = Some(channelmanager::provided_init_features(&test_default_channel_config()).clear_shutdown_anysegwit());
820 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
821 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
823 // Use a non-v0 segwit script supported by option_shutdown_anysegwit
824 let anysegwit_shutdown_script = Builder::new()
826 .push_slice(&[0, 40])
829 // Check script when handling an open_channel message
830 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None, None).unwrap();
831 let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
832 open_channel.common_fields.shutdown_scriptpubkey = Some(anysegwit_shutdown_script.clone());
833 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel);
835 let events = nodes[1].node.get_and_clear_pending_msg_events();
836 assert_eq!(events.len(), 1);
838 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
839 assert_eq!(node_id, nodes[0].node.get_our_node_id());
840 assert_eq!(msg.data, "Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: OP_PUSHNUM_16 OP_PUSHBYTES_2 0028");
842 _ => panic!("Unexpected event"),
845 let chanmon_cfgs = create_chanmon_cfgs(2);
846 let mut node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
847 // Clear shutdown_anysegwit on responder
848 *node_cfgs[1].override_init_features.borrow_mut() = Some(channelmanager::provided_init_features(&test_default_channel_config()).clear_shutdown_anysegwit());
849 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
850 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
852 // Check script when handling an accept_channel message
853 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None, None).unwrap();
854 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
855 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel);
856 let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
857 accept_channel.common_fields.shutdown_scriptpubkey = Some(anysegwit_shutdown_script.clone());
858 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel);
860 let events = nodes[0].node.get_and_clear_pending_msg_events();
861 assert_eq!(events.len(), 1);
863 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
864 assert_eq!(node_id, nodes[1].node.get_our_node_id());
865 assert_eq!(msg.data, "Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: OP_PUSHNUM_16 OP_PUSHBYTES_2 0028");
867 _ => panic!("Unexpected event"),
869 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() }
870 , [nodes[1].node.get_our_node_id()], 100000);
874 fn test_invalid_upfront_shutdown_script() {
875 let chanmon_cfgs = create_chanmon_cfgs(2);
876 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
877 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
878 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
880 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None, None).unwrap();
882 // Use a segwit v0 script with an unsupported witness program
883 let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
884 open_channel.common_fields.shutdown_scriptpubkey = Some(Builder::new().push_int(0)
887 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel);
889 let events = nodes[1].node.get_and_clear_pending_msg_events();
890 assert_eq!(events.len(), 1);
892 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
893 assert_eq!(node_id, nodes[0].node.get_our_node_id());
894 assert_eq!(msg.data, "Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: OP_0 OP_PUSHBYTES_2 0000");
896 _ => panic!("Unexpected event"),
901 fn test_segwit_v0_shutdown_script() {
902 let mut config = UserConfig::default();
903 config.channel_handshake_config.announced_channel = true;
904 config.channel_handshake_limits.force_announced_channel_preference = false;
905 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
906 let user_cfgs = [None, Some(config), None];
907 let chanmon_cfgs = create_chanmon_cfgs(3);
908 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
909 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
910 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
912 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
913 nodes[1].node.close_channel(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
914 check_added_monitors!(nodes[1], 1);
916 // Use a segwit v0 script supported even without option_shutdown_anysegwit
917 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
918 node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
919 .push_slice(&[0; 20])
921 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
923 let events = nodes[0].node.get_and_clear_pending_msg_events();
924 assert_eq!(events.len(), 2);
926 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
927 _ => panic!("Unexpected event"),
930 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
931 _ => panic!("Unexpected event"),
936 fn test_anysegwit_shutdown_script() {
937 let mut config = UserConfig::default();
938 config.channel_handshake_config.announced_channel = true;
939 config.channel_handshake_limits.force_announced_channel_preference = false;
940 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
941 let user_cfgs = [None, Some(config), None];
942 let chanmon_cfgs = create_chanmon_cfgs(3);
943 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
944 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
945 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
947 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
948 nodes[1].node.close_channel(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
949 check_added_monitors!(nodes[1], 1);
951 // Use a non-v0 segwit script supported by option_shutdown_anysegwit
952 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
953 node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
956 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
958 let events = nodes[0].node.get_and_clear_pending_msg_events();
959 assert_eq!(events.len(), 2);
961 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
962 _ => panic!("Unexpected event"),
965 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
966 _ => panic!("Unexpected event"),
971 fn test_unsupported_anysegwit_shutdown_script() {
972 let mut config = UserConfig::default();
973 config.channel_handshake_config.announced_channel = true;
974 config.channel_handshake_limits.force_announced_channel_preference = false;
975 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
976 let user_cfgs = [None, Some(config), None];
977 let chanmon_cfgs = create_chanmon_cfgs(3);
978 let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
979 *node_cfgs[0].override_init_features.borrow_mut() = Some(channelmanager::provided_init_features(&config).clear_shutdown_anysegwit());
980 *node_cfgs[1].override_init_features.borrow_mut() = Some(channelmanager::provided_init_features(&config).clear_shutdown_anysegwit());
981 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
982 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
984 // Check that using an unsupported shutdown script fails and a supported one succeeds.
985 let supported_shutdown_script = chanmon_cfgs[1].keys_manager.get_shutdown_scriptpubkey().unwrap();
986 let unsupported_witness_program = WitnessProgram::new(WitnessVersion::V16, &[0, 40]).unwrap();
987 let unsupported_shutdown_script =
988 ShutdownScript::new_witness_program(&unsupported_witness_program).unwrap();
989 chanmon_cfgs[1].keys_manager
990 .expect(OnGetShutdownScriptpubkey { returns: unsupported_shutdown_script.clone() })
991 .expect(OnGetShutdownScriptpubkey { returns: supported_shutdown_script });
993 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
994 match nodes[1].node.close_channel(&chan.2, &nodes[0].node.get_our_node_id()) {
995 Err(APIError::IncompatibleShutdownScript { script }) => {
996 assert_eq!(script.into_inner(), unsupported_shutdown_script.clone().into_inner());
998 Err(e) => panic!("Unexpected error: {:?}", e),
999 Ok(_) => panic!("Expected error"),
1001 nodes[1].node.close_channel(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
1002 check_added_monitors!(nodes[1], 1);
1004 // Use a non-v0 segwit script unsupported without option_shutdown_anysegwit
1005 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1006 node_0_shutdown.scriptpubkey = unsupported_shutdown_script.into_inner();
1007 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
1009 assert_eq!(&check_warn_msg!(nodes[0], nodes[1].node.get_our_node_id(), chan.2),
1010 "Got a nonstandard scriptpubkey (60020028) from remote peer");
1014 fn test_invalid_shutdown_script() {
1015 let mut config = UserConfig::default();
1016 config.channel_handshake_config.announced_channel = true;
1017 config.channel_handshake_limits.force_announced_channel_preference = false;
1018 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
1019 let user_cfgs = [None, Some(config), None];
1020 let chanmon_cfgs = create_chanmon_cfgs(3);
1021 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1022 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
1023 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1025 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
1026 nodes[1].node.close_channel(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
1027 check_added_monitors!(nodes[1], 1);
1029 // Use a segwit v0 script with an unsupported witness program
1030 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1031 node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
1032 .push_slice(&[0, 0])
1034 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
1036 assert_eq!(&check_warn_msg!(nodes[0], nodes[1].node.get_our_node_id(), chan.2),
1037 "Got a nonstandard scriptpubkey (00020000) from remote peer");
1041 fn test_user_shutdown_script() {
1042 let mut config = test_default_channel_config();
1043 config.channel_handshake_config.announced_channel = true;
1044 config.channel_handshake_limits.force_announced_channel_preference = false;
1045 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
1046 let user_cfgs = [None, Some(config), None];
1047 let chanmon_cfgs = create_chanmon_cfgs(3);
1048 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1049 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
1050 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1052 // Segwit v0 script of the form OP_0 <20-byte hash>
1053 let script = Builder::new().push_int(0)
1054 .push_slice(&[0; 20])
1057 let shutdown_script = ShutdownScript::try_from(script.clone()).unwrap();
1059 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
1060 nodes[1].node.close_channel_with_feerate_and_script(&chan.2, &nodes[0].node.get_our_node_id(), None, Some(shutdown_script)).unwrap();
1061 check_added_monitors!(nodes[1], 1);
1063 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1065 assert_eq!(node_0_shutdown.scriptpubkey, script);
1069 fn test_already_set_user_shutdown_script() {
1070 let mut config = test_default_channel_config();
1071 config.channel_handshake_config.announced_channel = true;
1072 config.channel_handshake_limits.force_announced_channel_preference = false;
1073 let user_cfgs = [None, Some(config), None];
1074 let chanmon_cfgs = create_chanmon_cfgs(3);
1075 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1076 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
1077 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1079 // Segwit v0 script of the form OP_0 <20-byte hash>
1080 let script = Builder::new().push_int(0)
1081 .push_slice(&[0; 20])
1084 let shutdown_script = ShutdownScript::try_from(script).unwrap();
1086 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
1087 let result = nodes[1].node.close_channel_with_feerate_and_script(&chan.2, &nodes[0].node.get_our_node_id(), None, Some(shutdown_script));
1089 assert_eq!(result, Err(APIError::APIMisuseError { err: "Cannot override shutdown script for a channel with one already set".to_string() }));
1092 #[derive(PartialEq)]
1099 fn do_test_closing_signed_reinit_timeout(timeout_step: TimeoutStep) {
1100 // The range-based closing signed negotiation allows the funder to restart the process with a
1101 // new range if the previous range did not overlap. This allows implementations to request user
1102 // intervention allowing users to enter a new fee range. We do not implement the sending side
1103 // of this, instead opting to allow users to enter an explicit "willing to pay up to X to avoid
1104 // force-closing" value and relying on that instead.
1106 // Here we run test the fundee side of that restart mechanism, implementing the funder side of
1108 let chanmon_cfgs = create_chanmon_cfgs(2);
1109 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1110 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1111 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1112 let chan_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
1114 send_payment(&nodes[0], &[&nodes[1]], 8_000_000);
1116 nodes[0].node.close_channel(&chan_id, &nodes[1].node.get_our_node_id()).unwrap();
1117 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1118 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
1119 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1120 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
1123 // Now we set nodes[1] to require a relatively high feerate for closing. This should result
1124 // in it rejecting nodes[0]'s initial closing_signed, giving nodes[0] a chance to try
1126 let mut feerate_lock = chanmon_cfgs[1].fee_estimator.sat_per_kw.lock().unwrap();
1127 *feerate_lock *= 10;
1130 let mut node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1131 // nodes[0] should use a "reasonable" feerate, well under the 10 sat/vByte that nodes[1] thinks
1132 // is the current prevailing feerate.
1133 assert!(node_0_closing_signed.fee_satoshis <= 500);
1135 if timeout_step != TimeoutStep::AfterShutdown {
1136 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1137 assert!(check_warn_msg!(nodes[1], nodes[0].node.get_our_node_id(), chan_id)
1138 .starts_with("Unable to come to consensus about closing feerate"));
1140 // Now deliver a mutated closing_signed indicating a higher acceptable fee range, which
1141 // nodes[1] should happily accept and respond to.
1142 node_0_closing_signed.fee_range.as_mut().unwrap().max_fee_satoshis *= 10;
1144 let mut node_0_per_peer_lock;
1145 let mut node_0_peer_state_lock;
1146 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;
1148 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1149 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
1150 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
1151 let node_0_2nd_closing_signed = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1152 if timeout_step == TimeoutStep::NoTimeout {
1153 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.1.unwrap());
1154 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
1156 check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
1159 if timeout_step != TimeoutStep::NoTimeout {
1160 assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
1162 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1165 nodes[1].node.timer_tick_occurred();
1166 nodes[1].node.timer_tick_occurred();
1168 let txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1169 assert_eq!(txn.len(), 1);
1170 assert_eq!(txn[0].output.len(), 2);
1172 if timeout_step != TimeoutStep::NoTimeout {
1173 assert!((txn[0].output[0].script_pubkey.is_p2wpkh() &&
1174 txn[0].output[1].script_pubkey.is_p2wsh()) ||
1175 (txn[0].output[1].script_pubkey.is_p2wpkh() &&
1176 txn[0].output[0].script_pubkey.is_p2wsh()));
1177 check_closed_broadcast!(nodes[1], true);
1178 check_added_monitors!(nodes[1], 1);
1179 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "closing_signed negotiation failed to finish within two timer ticks".to_string() }
1180 , [nodes[0].node.get_our_node_id()], 100000);
1182 assert!(txn[0].output[0].script_pubkey.is_p2wpkh());
1183 assert!(txn[0].output[1].script_pubkey.is_p2wpkh());
1185 let events = nodes[1].node.get_and_clear_pending_msg_events();
1186 assert_eq!(events.len(), 1);
1188 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1189 assert_eq!(msg.contents.flags & 2, 2);
1191 _ => panic!("Unexpected event"),
1197 fn test_closing_signed_reinit_timeout() {
1198 do_test_closing_signed_reinit_timeout(TimeoutStep::AfterShutdown);
1199 do_test_closing_signed_reinit_timeout(TimeoutStep::AfterClosingSigned);
1200 do_test_closing_signed_reinit_timeout(TimeoutStep::NoTimeout);
1203 fn do_simple_legacy_shutdown_test(high_initiator_fee: bool) {
1204 // A simpe test of the legacy shutdown fee negotiation logic.
1205 let chanmon_cfgs = create_chanmon_cfgs(2);
1206 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1207 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1208 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1210 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
1212 if high_initiator_fee {
1213 // If high_initiator_fee is set, set nodes[0]'s feerate significantly higher. This
1214 // shouldn't impact the flow at all given nodes[1] will happily accept the higher fee.
1215 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
1216 *feerate_lock *= 10;
1219 nodes[0].node.close_channel(&chan.2, &nodes[1].node.get_our_node_id()).unwrap();
1220 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1221 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
1222 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1223 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
1225 let mut node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1226 node_0_closing_signed.fee_range = None;
1227 if high_initiator_fee {
1228 assert!(node_0_closing_signed.fee_satoshis > 500);
1230 assert!(node_0_closing_signed.fee_satoshis < 500);
1233 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1234 let (_, mut node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1235 node_1_closing_signed.as_mut().unwrap().fee_range = None;
1237 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
1238 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1239 assert!(node_0_none.is_none());
1240 check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
1241 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
1245 fn simple_legacy_shutdown_test() {
1246 do_simple_legacy_shutdown_test(false);
1247 do_simple_legacy_shutdown_test(true);
1251 fn simple_target_feerate_shutdown() {
1252 // Simple test of target in `close_channel_with_target_feerate`.
1253 let chanmon_cfgs = create_chanmon_cfgs(2);
1254 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1255 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1256 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1258 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
1259 let chan_id = chan.2;
1261 nodes[0].node.close_channel_with_feerate_and_script(&chan_id, &nodes[1].node.get_our_node_id(), Some(253 * 10), None).unwrap();
1262 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1263 nodes[1].node.close_channel_with_feerate_and_script(&chan_id, &nodes[0].node.get_our_node_id(), Some(253 * 5), None).unwrap();
1264 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1266 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
1267 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
1269 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1270 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1271 let (_, node_1_closing_signed_opt) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1272 let node_1_closing_signed = node_1_closing_signed_opt.unwrap();
1274 // nodes[1] was passed a target which was larger than the current channel feerate, which it
1275 // should ignore in favor of the channel fee, as there is no use demanding a minimum higher
1276 // than what will be paid on a force-close transaction. Note that we have to consider rounding,
1277 // so only check that we're within 10 sats.
1278 assert!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis >=
1279 node_1_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis * 10 - 5);
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);
1283 // Further, because nodes[0]'s target fee is larger than the `Normal` fee estimation plus our
1284 // force-closure-avoidance buffer, min should equal max, and the nodes[1]-selected fee should
1285 // be the nodes[0] only available fee.
1286 assert_eq!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis,
1287 node_0_closing_signed.fee_range.as_ref().unwrap().max_fee_satoshis);
1288 assert_eq!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis,
1289 node_0_closing_signed.fee_satoshis);
1290 assert_eq!(node_0_closing_signed.fee_satoshis, node_1_closing_signed.fee_satoshis);
1292 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
1293 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1294 assert!(node_0_none.is_none());
1295 check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
1296 check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
1299 fn do_outbound_update_no_early_closing_signed(use_htlc: bool) {
1300 // Previously, if we have a pending inbound HTLC (or fee update) on a channel which has
1301 // initiated shutdown, we'd send our initial closing_signed immediately after receiving the
1302 // peer's last RAA to remove the HTLC/fee update, but before receiving their final
1303 // commitment_signed for a commitment without the HTLC/with the new fee. This caused at least
1304 // LDK peers to force-close as we initiated closing_signed prior to the channel actually being
1305 // fully empty of pending updates/HTLCs.
1306 let chanmon_cfgs = create_chanmon_cfgs(2);
1307 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1308 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1309 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1311 let chan_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
1313 send_payment(&nodes[0], &[&nodes[1]], 1_000_000);
1314 let payment_hash_opt = if use_htlc {
1315 Some(route_payment(&nodes[1], &[&nodes[0]], 10_000).1)
1321 nodes[0].node.fail_htlc_backwards(&payment_hash_opt.unwrap());
1322 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[0],
1323 [HTLCDestination::FailedPayment { payment_hash: payment_hash_opt.unwrap() }]);
1325 *chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap() *= 10;
1326 nodes[0].node.timer_tick_occurred();
1328 let updates = get_htlc_update_msgs(&nodes[0], &nodes[1].node.get_our_node_id());
1329 check_added_monitors(&nodes[0], 1);
1331 nodes[1].node.close_channel(&chan_id, &nodes[0].node.get_our_node_id()).unwrap();
1332 let node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1333 nodes[0].node.close_channel(&chan_id, &nodes[1].node.get_our_node_id()).unwrap();
1334 let node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1336 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
1337 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_1_shutdown);
1340 nodes[1].node.handle_update_fail_htlc(&nodes[0].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
1342 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &updates.update_fee.unwrap());
1344 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
1345 check_added_monitors(&nodes[1], 1);
1346 let (bs_raa, bs_cs) = get_revoke_commit_msgs(&nodes[1], &nodes[0].node.get_our_node_id());
1348 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1349 check_added_monitors(&nodes[0], 1);
1351 // At this point the Channel on nodes[0] has no record of any HTLCs but the latest
1352 // broadcastable commitment does contain the HTLC (but only the ChannelMonitor knows this).
1353 // Thus, the channel should not yet initiate closing_signed negotiation (but previously did).
1354 assert_eq!(nodes[0].node.get_and_clear_pending_msg_events(), Vec::new());
1356 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1357 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs);
1358 check_added_monitors(&nodes[0], 1);
1359 assert_eq!(nodes[0].node.get_and_clear_pending_msg_events(), Vec::new());
1361 expect_channel_shutdown_state!(nodes[0], chan_id, ChannelShutdownState::ResolvingHTLCs);
1362 assert_eq!(nodes[0].node.get_and_clear_pending_msg_events(), Vec::new());
1363 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_id).unwrap().clone();
1364 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1366 let as_raa_closing_signed = nodes[0].node.get_and_clear_pending_msg_events();
1367 assert_eq!(as_raa_closing_signed.len(), 2);
1369 if let MessageSendEvent::SendRevokeAndACK { msg, .. } = &as_raa_closing_signed[0] {
1370 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &msg);
1371 check_added_monitors(&nodes[1], 1);
1373 expect_payment_failed!(nodes[1], payment_hash_opt.unwrap(), true);
1375 } else { panic!("Unexpected message {:?}", as_raa_closing_signed[0]); }
1377 if let MessageSendEvent::SendClosingSigned { msg, .. } = &as_raa_closing_signed[1] {
1378 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &msg);
1379 } else { panic!("Unexpected message {:?}", as_raa_closing_signed[1]); }
1381 let bs_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
1382 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &bs_closing_signed);
1383 let (_, as_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1384 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &as_2nd_closing_signed.unwrap());
1385 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1386 assert!(node_1_none.is_none());
1388 check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
1389 check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
1393 fn outbound_update_no_early_closing_signed() {
1394 do_outbound_update_no_early_closing_signed(true);
1395 do_outbound_update_no_early_closing_signed(false);
1399 fn batch_funding_failure() {
1400 // Provides test coverage of batch funding failure, which previously deadlocked
1401 let chanmon_cfgs = create_chanmon_cfgs(4);
1402 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1403 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1404 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1406 let temp_chan_id_a = exchange_open_accept_chan(&nodes[0], &nodes[1], 1_000_000, 0);
1407 let temp_chan_id_b = exchange_open_accept_chan(&nodes[0], &nodes[2], 1_000_000, 0);
1409 let events = nodes[0].node.get_and_clear_pending_events();
1410 assert_eq!(events.len(), 2);
1411 // Build a transaction which only has the output for one of the two channels we're trying to
1412 // confirm. Previously this led to a deadlock in channel closure handling.
1413 let mut tx = Transaction { version: Version::TWO, lock_time: LockTime::ZERO, input: Vec::new(), output: Vec::new() };
1414 let mut chans = Vec::new();
1415 for (idx, ev) in events.iter().enumerate() {
1416 if let Event::FundingGenerationReady { temporary_channel_id, counterparty_node_id, output_script, .. } = ev {
1418 tx.output.push(TxOut { value: Amount::from_sat(1_000_000), script_pubkey: output_script.clone() });
1420 chans.push((temporary_channel_id, counterparty_node_id));
1421 } else { panic!(); }
1424 let err = "Error in transaction funding: Misuse error: No output matched the script_pubkey and value in the FundingGenerationReady event".to_string();
1425 let temp_err = "No output matched the script_pubkey and value in the FundingGenerationReady event".to_string();
1426 let post_funding_chan_id_a = ChannelId::v1_from_funding_txid(tx.txid().as_ref(), 0);
1428 ExpectedCloseEvent::from_id_reason(post_funding_chan_id_a, true, ClosureReason::ProcessingError { err: err.clone() }),
1429 ExpectedCloseEvent::from_id_reason(temp_chan_id_b, false, ClosureReason::ProcessingError { err: temp_err }),
1432 nodes[0].node.batch_funding_transaction_generated(&chans, tx).unwrap_err();
1434 let msgs = nodes[0].node.get_and_clear_pending_msg_events();
1435 assert_eq!(msgs.len(), 3);
1436 // We currently spuriously send `FundingCreated` for the first channel and then immediately
1437 // fail both channels, which isn't ideal but should be fine.
1438 assert!(msgs.iter().any(|msg| {
1439 if let MessageSendEvent::HandleError { action: msgs::ErrorAction::SendErrorMessage {
1440 msg: msgs::ErrorMessage { channel_id, .. }, ..
1442 *channel_id == temp_chan_id_b
1445 let funding_created_pos = msgs.iter().position(|msg| {
1446 if let MessageSendEvent::SendFundingCreated { msg: msgs::FundingCreated { temporary_channel_id, .. }, .. } = msg {
1447 assert_eq!(*temporary_channel_id, temp_chan_id_a);
1451 let funded_channel_close_pos = msgs.iter().position(|msg| {
1452 if let MessageSendEvent::HandleError { action: msgs::ErrorAction::SendErrorMessage {
1453 msg: msgs::ErrorMessage { channel_id, .. }, ..
1455 *channel_id == post_funding_chan_id_a
1459 // The error message uses the funded channel_id so must come after the funding_created
1460 assert!(funded_channel_close_pos > funding_created_pos);
1462 check_closed_events(&nodes[0], &close);
1463 assert_eq!(nodes[0].node.list_channels().len(), 0);