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};
19 use crate::ln::{ChannelId, msgs};
20 use crate::ln::msgs::{ChannelMessageHandler, ErrorAction};
21 use crate::ln::onion_utils::INVALID_ONION_BLINDING;
22 use crate::ln::script::ShutdownScript;
23 use crate::util::test_utils;
24 use crate::util::test_utils::OnGetShutdownScriptpubkey;
25 use crate::util::errors::APIError;
26 use crate::util::config::UserConfig;
27 use crate::util::string::UntrustedString;
28 use crate::prelude::*;
30 use bitcoin::{Transaction, TxOut};
31 use bitcoin::blockdata::locktime::absolute::LockTime;
32 use bitcoin::blockdata::script::Builder;
33 use bitcoin::blockdata::opcodes;
34 use bitcoin::network::constants::Network;
35 use bitcoin::address::{WitnessProgram, WitnessVersion};
37 use crate::ln::functional_test_utils::*;
40 fn pre_funding_lock_shutdown_test() {
41 // Test sending a shutdown prior to channel_ready after funding generation
42 let chanmon_cfgs = create_chanmon_cfgs(2);
43 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
44 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
45 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
46 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0);
47 mine_transaction(&nodes[0], &tx);
48 mine_transaction(&nodes[1], &tx);
50 nodes[0].node.close_channel(&ChannelId::v1_from_funding_outpoint(OutPoint { txid: tx.txid(), index: 0 }), &nodes[1].node.get_our_node_id()).unwrap();
51 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
52 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
53 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
54 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
56 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
57 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
58 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
59 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
60 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
61 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
62 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
63 assert!(node_1_none.is_none());
65 assert!(nodes[0].node.list_channels().is_empty());
66 assert!(nodes[1].node.list_channels().is_empty());
67 check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 8000000);
68 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 8000000);
72 fn expect_channel_shutdown_state() {
73 // Test sending a shutdown prior to channel_ready after funding generation
74 let chanmon_cfgs = create_chanmon_cfgs(2);
75 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
76 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
77 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
78 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
80 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::NotShuttingDown);
82 nodes[0].node.close_channel(&chan_1.2, &nodes[1].node.get_our_node_id()).unwrap();
84 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::ShutdownInitiated);
85 expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::NotShuttingDown);
87 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
88 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
90 // node1 goes into NegotiatingClosingFee since there are no HTLCs in flight, note that it
91 // doesnt mean that node1 has sent/recved its closing signed message
92 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::ShutdownInitiated);
93 expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::NegotiatingClosingFee);
95 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
96 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
98 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::NegotiatingClosingFee);
99 expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::NegotiatingClosingFee);
101 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
102 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
103 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
104 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
105 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
106 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
107 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
108 assert!(node_1_none.is_none());
110 assert!(nodes[0].node.list_channels().is_empty());
111 assert!(nodes[1].node.list_channels().is_empty());
112 check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
113 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
117 fn expect_channel_shutdown_state_with_htlc() {
118 // Test sending a shutdown with outstanding updates pending.
119 let chanmon_cfgs = create_chanmon_cfgs(3);
120 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
121 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
122 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
123 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
124 let _chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
126 let (payment_preimage_0, payment_hash_0, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100_000);
128 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::NotShuttingDown);
129 expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::NotShuttingDown);
131 nodes[0].node.close_channel(&chan_1.2, &nodes[1].node.get_our_node_id()).unwrap();
133 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::ShutdownInitiated);
134 expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::NotShuttingDown);
136 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
137 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
139 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::ShutdownInitiated);
140 expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::ResolvingHTLCs);
142 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
143 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
145 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::ResolvingHTLCs);
146 expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::ResolvingHTLCs);
148 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
149 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
151 // Claim Funds on Node2
152 nodes[2].node.claim_funds(payment_preimage_0);
153 check_added_monitors!(nodes[2], 1);
154 expect_payment_claimed!(nodes[2], payment_hash_0, 100_000);
156 // Fulfil HTLCs on node1 and node0
157 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
158 assert!(updates.update_add_htlcs.is_empty());
159 assert!(updates.update_fail_htlcs.is_empty());
160 assert!(updates.update_fail_malformed_htlcs.is_empty());
161 assert!(updates.update_fee.is_none());
162 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
163 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
164 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), false, false);
165 check_added_monitors!(nodes[1], 1);
166 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
167 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
169 // Still in "resolvingHTLCs" on chan1 after htlc removed on chan2
170 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::ResolvingHTLCs);
171 expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::ResolvingHTLCs);
173 assert!(updates_2.update_add_htlcs.is_empty());
174 assert!(updates_2.update_fail_htlcs.is_empty());
175 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
176 assert!(updates_2.update_fee.is_none());
177 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
178 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
179 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
180 expect_payment_sent!(nodes[0], payment_preimage_0);
182 // all htlcs removed, chan1 advances to NegotiatingClosingFee
183 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::NegotiatingClosingFee);
184 expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::NegotiatingClosingFee);
186 // ClosingSignNegotion process
187 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
188 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
189 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
190 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
191 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
192 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
193 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
194 assert!(node_1_none.is_none());
195 check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
196 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
198 // Shutdown basically removes the channelDetails, testing of shutdowncomplete state unnecessary
199 assert!(nodes[0].node.list_channels().is_empty());
203 fn test_lnd_bug_6039() {
204 // LND sends a nonsense error message any time it gets a shutdown if there are still HTLCs
205 // pending. We currently swallow that error to work around LND's bug #6039. This test emulates
206 // the LND nonsense and ensures we at least kinda handle it.
207 let chanmon_cfgs = create_chanmon_cfgs(2);
208 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
209 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
210 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
211 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
213 let (payment_preimage, ..) = route_payment(&nodes[0], &[&nodes[1]], 100_000);
215 nodes[0].node.close_channel(&chan.2, &nodes[1].node.get_our_node_id()).unwrap();
216 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
217 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
219 // Generate an lnd-like error message and check that we respond by simply screaming louder to
220 // see if LND will accept our protocol compliance.
221 let err_msg = msgs::ErrorMessage { channel_id: chan.2, data: "link failed to shutdown".to_string() };
222 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &err_msg);
223 let node_a_responses = nodes[0].node.get_and_clear_pending_msg_events();
224 assert_eq!(node_a_responses[0], MessageSendEvent::SendShutdown {
225 node_id: nodes[1].node.get_our_node_id(),
226 msg: node_0_shutdown,
228 if let MessageSendEvent::HandleError { action: msgs::ErrorAction::SendWarningMessage { .. }, .. }
229 = node_a_responses[1] {} else { panic!(); }
231 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
233 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
234 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
236 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
238 // Assume that LND will eventually respond to our Shutdown if we clear all the remaining HTLCs
239 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
241 // ClosingSignNegotion process
242 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
243 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
244 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
245 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
246 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
247 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
248 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
249 assert!(node_1_none.is_none());
250 check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
251 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
253 // Shutdown basically removes the channelDetails, testing of shutdowncomplete state unnecessary
254 assert!(nodes[0].node.list_channels().is_empty());
258 fn shutdown_on_unfunded_channel() {
259 // Test receiving a shutdown prior to funding generation
260 let chanmon_cfgs = create_chanmon_cfgs(2);
261 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
262 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
263 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
265 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1_000_000, 100_000, 0, None, None).unwrap();
266 let open_chan = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
268 // Create a dummy P2WPKH script
269 let script = Builder::new().push_int(0)
270 .push_slice(&[0; 20])
273 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &msgs::Shutdown {
274 channel_id: open_chan.common_fields.temporary_channel_id, scriptpubkey: script,
276 check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyCoopClosedUnfundedChannel, [nodes[1].node.get_our_node_id()], 1_000_000);
280 fn close_on_unfunded_channel() {
281 // Test the user asking us to close prior to funding generation
282 let chanmon_cfgs = create_chanmon_cfgs(2);
283 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
284 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
285 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
287 let chan_id = nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1_000_000, 100_000, 0, None, None).unwrap();
288 let _open_chan = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
290 nodes[0].node.close_channel(&chan_id, &nodes[1].node.get_our_node_id()).unwrap();
291 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed, [nodes[1].node.get_our_node_id()], 1_000_000);
295 fn expect_channel_shutdown_state_with_force_closure() {
296 // Test sending a shutdown prior to channel_ready after funding generation
297 let chanmon_cfgs = create_chanmon_cfgs(2);
298 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
299 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
300 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
301 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
303 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::NotShuttingDown);
304 expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::NotShuttingDown);
306 nodes[1].node.force_close_broadcasting_latest_txn(&chan_1.2, &nodes[0].node.get_our_node_id()).unwrap();
307 check_closed_broadcast!(nodes[1], true);
308 check_added_monitors!(nodes[1], 1);
310 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::NotShuttingDown);
311 assert!(nodes[1].node.list_channels().is_empty());
313 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
314 assert_eq!(node_txn.len(), 1);
315 check_spends!(node_txn[0], chan_1.3);
316 mine_transaction(&nodes[0], &node_txn[0]);
317 check_added_monitors!(nodes[0], 1);
319 assert!(nodes[0].node.list_channels().is_empty());
320 assert!(nodes[1].node.list_channels().is_empty());
321 check_closed_broadcast!(nodes[0], true);
322 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed, [nodes[1].node.get_our_node_id()], 100000);
323 check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed, [nodes[0].node.get_our_node_id()], 100000);
327 fn updates_shutdown_wait() {
328 // Test sending a shutdown with outstanding updates pending
329 let chanmon_cfgs = create_chanmon_cfgs(3);
330 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
331 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
332 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
333 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
334 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
335 let logger = test_utils::TestLogger::new();
336 let scorer = test_utils::TestScorer::new();
337 let keys_manager = test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
338 let random_seed_bytes = keys_manager.get_secure_random_bytes();
340 let (payment_preimage_0, payment_hash_0, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100_000);
342 nodes[0].node.close_channel(&chan_1.2, &nodes[1].node.get_our_node_id()).unwrap();
343 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
344 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
345 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
346 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
348 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
349 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
351 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
353 let payment_params_1 = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id(), TEST_FINAL_CLTV)
354 .with_bolt11_features(nodes[1].node.bolt11_invoice_features()).unwrap();
355 let route_params = RouteParameters::from_payment_params_and_value(payment_params_1, 100_000);
356 let route_1 = get_route(&nodes[0].node.get_our_node_id(), &route_params,
357 &nodes[0].network_graph.read_only(), None, &logger, &scorer, &Default::default(), &random_seed_bytes).unwrap();
358 let payment_params_2 = PaymentParameters::from_node_id(nodes[0].node.get_our_node_id(), TEST_FINAL_CLTV)
359 .with_bolt11_features(nodes[0].node.bolt11_invoice_features()).unwrap();
360 let route_params = RouteParameters::from_payment_params_and_value(payment_params_2, 100_000);
361 let route_2 = get_route(&nodes[1].node.get_our_node_id(), &route_params,
362 &nodes[1].network_graph.read_only(), None, &logger, &scorer, &Default::default(), &random_seed_bytes).unwrap();
363 unwrap_send_err!(nodes[0].node.send_payment_with_route(&route_1, payment_hash,
364 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)
365 ), true, APIError::ChannelUnavailable {..}, {});
366 unwrap_send_err!(nodes[1].node.send_payment_with_route(&route_2, payment_hash,
367 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)
368 ), true, APIError::ChannelUnavailable {..}, {});
370 nodes[2].node.claim_funds(payment_preimage_0);
371 check_added_monitors!(nodes[2], 1);
372 expect_payment_claimed!(nodes[2], payment_hash_0, 100_000);
374 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
375 assert!(updates.update_add_htlcs.is_empty());
376 assert!(updates.update_fail_htlcs.is_empty());
377 assert!(updates.update_fail_malformed_htlcs.is_empty());
378 assert!(updates.update_fee.is_none());
379 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
380 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
381 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), false, false);
382 check_added_monitors!(nodes[1], 1);
383 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
384 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
386 assert!(updates_2.update_add_htlcs.is_empty());
387 assert!(updates_2.update_fail_htlcs.is_empty());
388 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
389 assert!(updates_2.update_fee.is_none());
390 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
391 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
392 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
393 expect_payment_sent!(nodes[0], payment_preimage_0);
395 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
396 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
397 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
398 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
399 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
400 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
401 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
402 assert!(node_1_none.is_none());
403 check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
404 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
406 assert!(nodes[0].node.list_channels().is_empty());
408 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
409 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
410 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
411 assert!(nodes[1].node.list_channels().is_empty());
412 assert!(nodes[2].node.list_channels().is_empty());
413 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[2].node.get_our_node_id()], 100000);
414 check_closed_event!(nodes[2], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
418 fn htlc_fail_async_shutdown() {
419 do_htlc_fail_async_shutdown(true);
420 do_htlc_fail_async_shutdown(false);
423 fn do_htlc_fail_async_shutdown(blinded_recipient: bool) {
424 // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
425 let chanmon_cfgs = create_chanmon_cfgs(3);
426 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
427 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
428 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
429 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
430 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
432 let amt_msat = 100000;
433 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash(&nodes[2], Some(amt_msat), None);
434 let route_params = if blinded_recipient {
435 crate::ln::blinded_payment_tests::get_blinded_route_parameters(
436 amt_msat, our_payment_secret, 1, 100000000,
437 nodes.iter().skip(1).map(|n| n.node.get_our_node_id()).collect(), &[&chan_2.0.contents],
438 &chanmon_cfgs[2].keys_manager)
440 RouteParameters::from_payment_params_and_value(
441 PaymentParameters::from_node_id(nodes[2].node.get_our_node_id(), TEST_FINAL_CLTV), amt_msat)
443 nodes[0].node.send_payment(our_payment_hash,
444 RecipientOnionFields::secret_only(our_payment_secret),
445 PaymentId(our_payment_hash.0), route_params, Retry::Attempts(0)).unwrap();
446 check_added_monitors!(nodes[0], 1);
447 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
448 assert_eq!(updates.update_add_htlcs.len(), 1);
449 assert!(updates.update_fulfill_htlcs.is_empty());
450 assert!(updates.update_fail_htlcs.is_empty());
451 assert!(updates.update_fail_malformed_htlcs.is_empty());
452 assert!(updates.update_fee.is_none());
454 nodes[1].node.close_channel(&chan_1.2, &nodes[0].node.get_our_node_id()).unwrap();
455 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
456 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
457 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
459 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
460 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
461 check_added_monitors!(nodes[1], 1);
462 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
463 commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false, false);
465 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
466 assert!(updates_2.update_add_htlcs.is_empty());
467 assert!(updates_2.update_fulfill_htlcs.is_empty());
468 assert_eq!(updates_2.update_fail_htlcs.len(), 1);
469 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
470 assert!(updates_2.update_fee.is_none());
472 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]);
473 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
475 if blinded_recipient {
476 expect_payment_failed_conditions(&nodes[0], our_payment_hash, false,
477 PaymentFailedConditions::new().expected_htlc_error_data(INVALID_ONION_BLINDING, &[0; 32]));
479 expect_payment_failed_with_update!(nodes[0], our_payment_hash, false, chan_2.0.contents.short_channel_id, true);
482 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
483 assert_eq!(msg_events.len(), 1);
484 let node_0_closing_signed = match msg_events[0] {
485 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
486 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
489 _ => panic!("Unexpected event"),
492 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
493 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
494 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
495 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
496 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
497 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
498 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
499 assert!(node_1_none.is_none());
501 assert!(nodes[0].node.list_channels().is_empty());
503 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
504 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
505 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
506 assert!(nodes[1].node.list_channels().is_empty());
507 assert!(nodes[2].node.list_channels().is_empty());
508 check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
509 let event1 = ExpectedCloseEvent {
510 channel_capacity_sats: Some(100000),
512 counterparty_node_id: Some(nodes[0].node.get_our_node_id()),
513 discard_funding: false,
514 reason: Some(ClosureReason::LocallyInitiatedCooperativeClosure),
515 channel_funding_txo: None,
516 user_channel_id: None,
518 let event2 = ExpectedCloseEvent {
519 channel_capacity_sats: Some(100000),
521 counterparty_node_id: Some(nodes[2].node.get_our_node_id()),
522 discard_funding: false,
523 reason: Some(ClosureReason::CounterpartyInitiatedCooperativeClosure),
524 channel_funding_txo: None,
525 user_channel_id: None,
527 check_closed_events(&nodes[1], &[event1, event2]);
528 check_closed_event!(nodes[2], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
531 fn do_test_shutdown_rebroadcast(recv_count: u8) {
532 // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
533 // messages delivered prior to disconnect
534 let chanmon_cfgs = create_chanmon_cfgs(3);
535 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
536 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
537 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
538 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
539 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
541 let (payment_preimage, payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100_000);
543 nodes[1].node.close_channel(&chan_1.2, &nodes[0].node.get_our_node_id()).unwrap();
544 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
546 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
547 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
549 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
553 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
554 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
556 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
557 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
559 let node_0_reestablish = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
560 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
561 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
563 let node_1_reestablish = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
565 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish);
566 let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
567 assert!(node_1_shutdown == node_1_2nd_shutdown);
569 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish);
570 let node_0_2nd_shutdown = if recv_count > 0 {
571 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
572 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
575 let node_0_chan_update = get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
576 assert_eq!(node_0_chan_update.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
577 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
578 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
580 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_2nd_shutdown);
582 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
583 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
585 nodes[2].node.claim_funds(payment_preimage);
586 check_added_monitors!(nodes[2], 1);
587 expect_payment_claimed!(nodes[2], payment_hash, 100_000);
589 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
590 assert!(updates.update_add_htlcs.is_empty());
591 assert!(updates.update_fail_htlcs.is_empty());
592 assert!(updates.update_fail_malformed_htlcs.is_empty());
593 assert!(updates.update_fee.is_none());
594 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
595 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
596 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), false, false);
597 check_added_monitors!(nodes[1], 1);
598 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
599 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
601 assert!(updates_2.update_add_htlcs.is_empty());
602 assert!(updates_2.update_fail_htlcs.is_empty());
603 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
604 assert!(updates_2.update_fee.is_none());
605 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
606 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
607 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
608 expect_payment_sent!(nodes[0], payment_preimage);
610 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
612 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
613 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
614 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
615 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
616 assert!(node_0_2nd_closing_signed.is_some());
619 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
620 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
622 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
623 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
625 let node_1_2nd_reestablish = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
626 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
627 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
630 // If all closing_signeds weren't delivered we can just resume where we left off...
631 let node_0_2nd_reestablish = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
633 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
634 let node_0_msgs = nodes[0].node.get_and_clear_pending_msg_events();
635 assert_eq!(node_0_msgs.len(), 2);
636 let node_0_2nd_closing_signed = match node_0_msgs[1] {
637 MessageSendEvent::SendClosingSigned { ref msg, .. } => {
638 assert_eq!(node_0_closing_signed, *msg);
644 let node_0_3rd_shutdown = match node_0_msgs[0] {
645 MessageSendEvent::SendShutdown { ref msg, .. } => {
646 assert_eq!(node_0_2nd_shutdown, *msg);
651 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
653 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
654 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
655 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
657 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_3rd_shutdown);
658 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
660 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_3rd_shutdown);
662 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed);
663 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
664 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
665 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
666 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
667 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
668 assert!(node_1_none.is_none());
669 check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
671 // If one node, however, received + responded with an identical closing_signed we end
672 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
673 // There isn't really anything better we can do simply, but in the future we might
674 // explore storing a set of recently-closed channels that got disconnected during
675 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
676 // give our counterparty enough time to (potentially) broadcast a cooperative closing
678 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
680 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
681 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
682 assert_eq!(msg_events.len(), 2);
683 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[1] {
685 &ErrorAction::SendErrorMessage { ref msg } => {
686 nodes[1].node.handle_error(&nodes[0].node.get_our_node_id(), &msg);
687 assert_eq!(msg.channel_id, chan_1.2);
689 _ => panic!("Unexpected event!"),
691 } else { panic!("Needed SendErrorMessage close"); }
693 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
694 // checks it, but in this case nodes[1] didn't ever get a chance to receive a
695 // closing_signed so we do it ourselves
696 check_closed_broadcast!(nodes[1], false);
697 check_added_monitors!(nodes[1], 1);
698 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())) }
699 , [nodes[0].node.get_our_node_id()], 100000);
702 assert!(nodes[0].node.list_channels().is_empty());
704 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
705 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
706 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
707 assert!(nodes[1].node.list_channels().is_empty());
708 assert!(nodes[2].node.list_channels().is_empty());
709 check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
710 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[2].node.get_our_node_id()], 100000);
711 check_closed_event!(nodes[2], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
715 fn test_shutdown_rebroadcast() {
716 do_test_shutdown_rebroadcast(0);
717 do_test_shutdown_rebroadcast(1);
718 do_test_shutdown_rebroadcast(2);
722 fn test_upfront_shutdown_script() {
723 // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
724 // enforce it at shutdown message
726 let mut config = UserConfig::default();
727 config.channel_handshake_config.announced_channel = true;
728 config.channel_handshake_limits.force_announced_channel_preference = false;
729 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
730 let user_cfgs = [None, Some(config), None];
731 let chanmon_cfgs = create_chanmon_cfgs(3);
732 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
733 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
734 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
736 // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
737 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000);
738 nodes[0].node.close_channel(&chan.2, &nodes[2].node.get_our_node_id()).unwrap();
739 let node_0_orig_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
740 let mut node_0_shutdown = node_0_orig_shutdown.clone();
741 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
742 // Test we enforce upfront_scriptpbukey if by providing a different one at closing that we warn
743 // the peer and ignore the message.
744 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
745 assert!(regex::Regex::new(r"Got shutdown request with a scriptpubkey \([A-Fa-f0-9]+\) which did not match their previous scriptpubkey.")
746 .unwrap().is_match(&check_warn_msg!(nodes[2], nodes[0].node.get_our_node_id(), chan.2)));
747 // This allows nodes[2] to retry the shutdown message, which should get a response:
748 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_orig_shutdown);
749 get_event_msg!(nodes[2], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
751 // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
752 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000);
753 nodes[0].node.close_channel(&chan.2, &nodes[2].node.get_our_node_id()).unwrap();
754 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
755 // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
756 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
757 let events = nodes[2].node.get_and_clear_pending_msg_events();
758 assert_eq!(events.len(), 1);
760 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
761 _ => panic!("Unexpected event"),
764 // We test that if case of peer non-signaling we don't enforce committed script at channel opening
765 *nodes[0].override_init_features.borrow_mut() = Some(nodes[0].node.init_features().clear_upfront_shutdown_script());
766 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000);
767 nodes[0].node.close_channel(&chan.2, &nodes[1].node.get_our_node_id()).unwrap();
768 let node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
769 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_1_shutdown);
770 check_added_monitors!(nodes[1], 1);
771 let events = nodes[1].node.get_and_clear_pending_msg_events();
772 assert_eq!(events.len(), 1);
774 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
775 _ => panic!("Unexpected event"),
778 // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
779 // channel smoothly, opt-out is from channel initiator here
780 *nodes[0].override_init_features.borrow_mut() = None;
781 let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000);
782 nodes[1].node.close_channel(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
783 check_added_monitors!(nodes[1], 1);
784 let node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
785 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
786 let events = nodes[0].node.get_and_clear_pending_msg_events();
787 assert_eq!(events.len(), 1);
789 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
790 _ => panic!("Unexpected event"),
793 //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
794 //// channel smoothly
795 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000);
796 nodes[1].node.close_channel(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
797 check_added_monitors!(nodes[1], 1);
798 let node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
799 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
800 let events = nodes[0].node.get_and_clear_pending_msg_events();
801 assert_eq!(events.len(), 2);
803 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
804 _ => panic!("Unexpected event"),
807 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
808 _ => panic!("Unexpected event"),
813 fn test_unsupported_anysegwit_upfront_shutdown_script() {
814 let chanmon_cfgs = create_chanmon_cfgs(2);
815 let mut node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
816 // Clear shutdown_anysegwit on initiator
817 *node_cfgs[0].override_init_features.borrow_mut() = Some(channelmanager::provided_init_features(&test_default_channel_config()).clear_shutdown_anysegwit());
818 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
819 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
821 // Use a non-v0 segwit script supported by option_shutdown_anysegwit
822 let anysegwit_shutdown_script = Builder::new()
824 .push_slice(&[0, 40])
827 // Check script when handling an open_channel message
828 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None, None).unwrap();
829 let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
830 open_channel.common_fields.shutdown_scriptpubkey = Some(anysegwit_shutdown_script.clone());
831 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel);
833 let events = nodes[1].node.get_and_clear_pending_msg_events();
834 assert_eq!(events.len(), 1);
836 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
837 assert_eq!(node_id, nodes[0].node.get_our_node_id());
838 assert_eq!(msg.data, "Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: OP_PUSHNUM_16 OP_PUSHBYTES_2 0028");
840 _ => panic!("Unexpected event"),
843 let chanmon_cfgs = create_chanmon_cfgs(2);
844 let mut node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
845 // Clear shutdown_anysegwit on responder
846 *node_cfgs[1].override_init_features.borrow_mut() = Some(channelmanager::provided_init_features(&test_default_channel_config()).clear_shutdown_anysegwit());
847 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
848 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
850 // Check script when handling an accept_channel message
851 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None, None).unwrap();
852 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
853 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel);
854 let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
855 accept_channel.common_fields.shutdown_scriptpubkey = Some(anysegwit_shutdown_script.clone());
856 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel);
858 let events = nodes[0].node.get_and_clear_pending_msg_events();
859 assert_eq!(events.len(), 1);
861 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
862 assert_eq!(node_id, nodes[1].node.get_our_node_id());
863 assert_eq!(msg.data, "Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: OP_PUSHNUM_16 OP_PUSHBYTES_2 0028");
865 _ => panic!("Unexpected event"),
867 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() }
868 , [nodes[1].node.get_our_node_id()], 100000);
872 fn test_invalid_upfront_shutdown_script() {
873 let chanmon_cfgs = create_chanmon_cfgs(2);
874 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
875 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
876 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
878 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None, None).unwrap();
880 // Use a segwit v0 script with an unsupported witness program
881 let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
882 open_channel.common_fields.shutdown_scriptpubkey = Some(Builder::new().push_int(0)
885 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel);
887 let events = nodes[1].node.get_and_clear_pending_msg_events();
888 assert_eq!(events.len(), 1);
890 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
891 assert_eq!(node_id, nodes[0].node.get_our_node_id());
892 assert_eq!(msg.data, "Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: OP_0 OP_PUSHBYTES_2 0000");
894 _ => panic!("Unexpected event"),
899 fn test_segwit_v0_shutdown_script() {
900 let mut config = UserConfig::default();
901 config.channel_handshake_config.announced_channel = true;
902 config.channel_handshake_limits.force_announced_channel_preference = false;
903 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
904 let user_cfgs = [None, Some(config), None];
905 let chanmon_cfgs = create_chanmon_cfgs(3);
906 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
907 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
908 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
910 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
911 nodes[1].node.close_channel(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
912 check_added_monitors!(nodes[1], 1);
914 // Use a segwit v0 script supported even without option_shutdown_anysegwit
915 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
916 node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
917 .push_slice(&[0; 20])
919 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
921 let events = nodes[0].node.get_and_clear_pending_msg_events();
922 assert_eq!(events.len(), 2);
924 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
925 _ => panic!("Unexpected event"),
928 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
929 _ => panic!("Unexpected event"),
934 fn test_anysegwit_shutdown_script() {
935 let mut config = UserConfig::default();
936 config.channel_handshake_config.announced_channel = true;
937 config.channel_handshake_limits.force_announced_channel_preference = false;
938 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
939 let user_cfgs = [None, Some(config), None];
940 let chanmon_cfgs = create_chanmon_cfgs(3);
941 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
942 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
943 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
945 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
946 nodes[1].node.close_channel(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
947 check_added_monitors!(nodes[1], 1);
949 // Use a non-v0 segwit script supported by option_shutdown_anysegwit
950 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
951 node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
954 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
956 let events = nodes[0].node.get_and_clear_pending_msg_events();
957 assert_eq!(events.len(), 2);
959 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
960 _ => panic!("Unexpected event"),
963 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
964 _ => panic!("Unexpected event"),
969 fn test_unsupported_anysegwit_shutdown_script() {
970 let mut config = UserConfig::default();
971 config.channel_handshake_config.announced_channel = true;
972 config.channel_handshake_limits.force_announced_channel_preference = false;
973 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
974 let user_cfgs = [None, Some(config), None];
975 let chanmon_cfgs = create_chanmon_cfgs(3);
976 let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
977 *node_cfgs[0].override_init_features.borrow_mut() = Some(channelmanager::provided_init_features(&config).clear_shutdown_anysegwit());
978 *node_cfgs[1].override_init_features.borrow_mut() = Some(channelmanager::provided_init_features(&config).clear_shutdown_anysegwit());
979 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
980 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
982 // Check that using an unsupported shutdown script fails and a supported one succeeds.
983 let supported_shutdown_script = chanmon_cfgs[1].keys_manager.get_shutdown_scriptpubkey().unwrap();
984 let unsupported_witness_program = WitnessProgram::new(WitnessVersion::V16, &[0, 40]).unwrap();
985 let unsupported_shutdown_script =
986 ShutdownScript::new_witness_program(&unsupported_witness_program).unwrap();
987 chanmon_cfgs[1].keys_manager
988 .expect(OnGetShutdownScriptpubkey { returns: unsupported_shutdown_script.clone() })
989 .expect(OnGetShutdownScriptpubkey { returns: supported_shutdown_script });
991 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
992 match nodes[1].node.close_channel(&chan.2, &nodes[0].node.get_our_node_id()) {
993 Err(APIError::IncompatibleShutdownScript { script }) => {
994 assert_eq!(script.into_inner(), unsupported_shutdown_script.clone().into_inner());
996 Err(e) => panic!("Unexpected error: {:?}", e),
997 Ok(_) => panic!("Expected error"),
999 nodes[1].node.close_channel(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
1000 check_added_monitors!(nodes[1], 1);
1002 // Use a non-v0 segwit script unsupported without option_shutdown_anysegwit
1003 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1004 node_0_shutdown.scriptpubkey = unsupported_shutdown_script.into_inner();
1005 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
1007 assert_eq!(&check_warn_msg!(nodes[0], nodes[1].node.get_our_node_id(), chan.2),
1008 "Got a nonstandard scriptpubkey (60020028) from remote peer");
1012 fn test_invalid_shutdown_script() {
1013 let mut config = UserConfig::default();
1014 config.channel_handshake_config.announced_channel = true;
1015 config.channel_handshake_limits.force_announced_channel_preference = false;
1016 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
1017 let user_cfgs = [None, Some(config), None];
1018 let chanmon_cfgs = create_chanmon_cfgs(3);
1019 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1020 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
1021 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1023 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
1024 nodes[1].node.close_channel(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
1025 check_added_monitors!(nodes[1], 1);
1027 // Use a segwit v0 script with an unsupported witness program
1028 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1029 node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
1030 .push_slice(&[0, 0])
1032 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
1034 assert_eq!(&check_warn_msg!(nodes[0], nodes[1].node.get_our_node_id(), chan.2),
1035 "Got a nonstandard scriptpubkey (00020000) from remote peer");
1039 fn test_user_shutdown_script() {
1040 let mut config = test_default_channel_config();
1041 config.channel_handshake_config.announced_channel = true;
1042 config.channel_handshake_limits.force_announced_channel_preference = false;
1043 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
1044 let user_cfgs = [None, Some(config), None];
1045 let chanmon_cfgs = create_chanmon_cfgs(3);
1046 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1047 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
1048 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1050 // Segwit v0 script of the form OP_0 <20-byte hash>
1051 let script = Builder::new().push_int(0)
1052 .push_slice(&[0; 20])
1055 let shutdown_script = ShutdownScript::try_from(script.clone()).unwrap();
1057 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
1058 nodes[1].node.close_channel_with_feerate_and_script(&chan.2, &nodes[0].node.get_our_node_id(), None, Some(shutdown_script)).unwrap();
1059 check_added_monitors!(nodes[1], 1);
1061 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1063 assert_eq!(node_0_shutdown.scriptpubkey, script);
1067 fn test_already_set_user_shutdown_script() {
1068 let mut config = test_default_channel_config();
1069 config.channel_handshake_config.announced_channel = true;
1070 config.channel_handshake_limits.force_announced_channel_preference = false;
1071 let user_cfgs = [None, Some(config), None];
1072 let chanmon_cfgs = create_chanmon_cfgs(3);
1073 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1074 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
1075 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1077 // Segwit v0 script of the form OP_0 <20-byte hash>
1078 let script = Builder::new().push_int(0)
1079 .push_slice(&[0; 20])
1082 let shutdown_script = ShutdownScript::try_from(script).unwrap();
1084 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
1085 let result = nodes[1].node.close_channel_with_feerate_and_script(&chan.2, &nodes[0].node.get_our_node_id(), None, Some(shutdown_script));
1087 assert_eq!(result, Err(APIError::APIMisuseError { err: "Cannot override shutdown script for a channel with one already set".to_string() }));
1090 #[derive(PartialEq)]
1097 fn do_test_closing_signed_reinit_timeout(timeout_step: TimeoutStep) {
1098 // The range-based closing signed negotiation allows the funder to restart the process with a
1099 // new range if the previous range did not overlap. This allows implementations to request user
1100 // intervention allowing users to enter a new fee range. We do not implement the sending side
1101 // of this, instead opting to allow users to enter an explicit "willing to pay up to X to avoid
1102 // force-closing" value and relying on that instead.
1104 // Here we run test the fundee side of that restart mechanism, implementing the funder side of
1106 let chanmon_cfgs = create_chanmon_cfgs(2);
1107 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1108 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1109 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1110 let chan_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
1112 send_payment(&nodes[0], &[&nodes[1]], 8_000_000);
1114 nodes[0].node.close_channel(&chan_id, &nodes[1].node.get_our_node_id()).unwrap();
1115 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1116 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
1117 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1118 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
1121 // Now we set nodes[1] to require a relatively high feerate for closing. This should result
1122 // in it rejecting nodes[0]'s initial closing_signed, giving nodes[0] a chance to try
1124 let mut feerate_lock = chanmon_cfgs[1].fee_estimator.sat_per_kw.lock().unwrap();
1125 *feerate_lock *= 10;
1128 let mut node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1129 // nodes[0] should use a "reasonable" feerate, well under the 10 sat/vByte that nodes[1] thinks
1130 // is the current prevailing feerate.
1131 assert!(node_0_closing_signed.fee_satoshis <= 500);
1133 if timeout_step != TimeoutStep::AfterShutdown {
1134 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1135 assert!(check_warn_msg!(nodes[1], nodes[0].node.get_our_node_id(), chan_id)
1136 .starts_with("Unable to come to consensus about closing feerate"));
1138 // Now deliver a mutated closing_signed indicating a higher acceptable fee range, which
1139 // nodes[1] should happily accept and respond to.
1140 node_0_closing_signed.fee_range.as_mut().unwrap().max_fee_satoshis *= 10;
1142 let mut node_0_per_peer_lock;
1143 let mut node_0_peer_state_lock;
1144 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;
1146 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1147 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
1148 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
1149 let node_0_2nd_closing_signed = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1150 if timeout_step == TimeoutStep::NoTimeout {
1151 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.1.unwrap());
1152 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
1154 check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
1157 if timeout_step != TimeoutStep::NoTimeout {
1158 assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
1160 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1163 nodes[1].node.timer_tick_occurred();
1164 nodes[1].node.timer_tick_occurred();
1166 let txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1167 assert_eq!(txn.len(), 1);
1168 assert_eq!(txn[0].output.len(), 2);
1170 if timeout_step != TimeoutStep::NoTimeout {
1171 assert!((txn[0].output[0].script_pubkey.is_v0_p2wpkh() &&
1172 txn[0].output[1].script_pubkey.is_v0_p2wsh()) ||
1173 (txn[0].output[1].script_pubkey.is_v0_p2wpkh() &&
1174 txn[0].output[0].script_pubkey.is_v0_p2wsh()));
1175 check_closed_broadcast!(nodes[1], true);
1176 check_added_monitors!(nodes[1], 1);
1177 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "closing_signed negotiation failed to finish within two timer ticks".to_string() }
1178 , [nodes[0].node.get_our_node_id()], 100000);
1180 assert!(txn[0].output[0].script_pubkey.is_v0_p2wpkh());
1181 assert!(txn[0].output[1].script_pubkey.is_v0_p2wpkh());
1183 let events = nodes[1].node.get_and_clear_pending_msg_events();
1184 assert_eq!(events.len(), 1);
1186 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1187 assert_eq!(msg.contents.flags & 2, 2);
1189 _ => panic!("Unexpected event"),
1195 fn test_closing_signed_reinit_timeout() {
1196 do_test_closing_signed_reinit_timeout(TimeoutStep::AfterShutdown);
1197 do_test_closing_signed_reinit_timeout(TimeoutStep::AfterClosingSigned);
1198 do_test_closing_signed_reinit_timeout(TimeoutStep::NoTimeout);
1201 fn do_simple_legacy_shutdown_test(high_initiator_fee: bool) {
1202 // A simpe test of the legacy shutdown fee negotiation logic.
1203 let chanmon_cfgs = create_chanmon_cfgs(2);
1204 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1205 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1206 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1208 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
1210 if high_initiator_fee {
1211 // If high_initiator_fee is set, set nodes[0]'s feerate significantly higher. This
1212 // shouldn't impact the flow at all given nodes[1] will happily accept the higher fee.
1213 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
1214 *feerate_lock *= 10;
1217 nodes[0].node.close_channel(&chan.2, &nodes[1].node.get_our_node_id()).unwrap();
1218 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1219 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
1220 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1221 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
1223 let mut node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1224 node_0_closing_signed.fee_range = None;
1225 if high_initiator_fee {
1226 assert!(node_0_closing_signed.fee_satoshis > 500);
1228 assert!(node_0_closing_signed.fee_satoshis < 500);
1231 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1232 let (_, mut node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1233 node_1_closing_signed.as_mut().unwrap().fee_range = None;
1235 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
1236 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1237 assert!(node_0_none.is_none());
1238 check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
1239 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
1243 fn simple_legacy_shutdown_test() {
1244 do_simple_legacy_shutdown_test(false);
1245 do_simple_legacy_shutdown_test(true);
1249 fn simple_target_feerate_shutdown() {
1250 // Simple test of target in `close_channel_with_target_feerate`.
1251 let chanmon_cfgs = create_chanmon_cfgs(2);
1252 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1253 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1254 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1256 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
1257 let chan_id = chan.2;
1259 nodes[0].node.close_channel_with_feerate_and_script(&chan_id, &nodes[1].node.get_our_node_id(), Some(253 * 10), None).unwrap();
1260 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1261 nodes[1].node.close_channel_with_feerate_and_script(&chan_id, &nodes[0].node.get_our_node_id(), Some(253 * 5), None).unwrap();
1262 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1264 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
1265 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
1267 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1268 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1269 let (_, node_1_closing_signed_opt) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1270 let node_1_closing_signed = node_1_closing_signed_opt.unwrap();
1272 // nodes[1] was passed a target which was larger than the current channel feerate, which it
1273 // should ignore in favor of the channel fee, as there is no use demanding a minimum higher
1274 // than what will be paid on a force-close transaction. Note that we have to consider rounding,
1275 // so only check that we're within 10 sats.
1276 assert!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis >=
1277 node_1_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis * 10 - 5);
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);
1281 // Further, because nodes[0]'s target fee is larger than the `Normal` fee estimation plus our
1282 // force-closure-avoidance buffer, min should equal max, and the nodes[1]-selected fee should
1283 // be the nodes[0] only available fee.
1284 assert_eq!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis,
1285 node_0_closing_signed.fee_range.as_ref().unwrap().max_fee_satoshis);
1286 assert_eq!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis,
1287 node_0_closing_signed.fee_satoshis);
1288 assert_eq!(node_0_closing_signed.fee_satoshis, node_1_closing_signed.fee_satoshis);
1290 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
1291 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1292 assert!(node_0_none.is_none());
1293 check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
1294 check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
1297 fn do_outbound_update_no_early_closing_signed(use_htlc: bool) {
1298 // Previously, if we have a pending inbound HTLC (or fee update) on a channel which has
1299 // initiated shutdown, we'd send our initial closing_signed immediately after receiving the
1300 // peer's last RAA to remove the HTLC/fee update, but before receiving their final
1301 // commitment_signed for a commitment without the HTLC/with the new fee. This caused at least
1302 // LDK peers to force-close as we initiated closing_signed prior to the channel actually being
1303 // fully empty of pending updates/HTLCs.
1304 let chanmon_cfgs = create_chanmon_cfgs(2);
1305 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1306 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1307 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1309 let chan_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
1311 send_payment(&nodes[0], &[&nodes[1]], 1_000_000);
1312 let payment_hash_opt = if use_htlc {
1313 Some(route_payment(&nodes[1], &[&nodes[0]], 10_000).1)
1319 nodes[0].node.fail_htlc_backwards(&payment_hash_opt.unwrap());
1320 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[0],
1321 [HTLCDestination::FailedPayment { payment_hash: payment_hash_opt.unwrap() }]);
1323 *chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap() *= 10;
1324 nodes[0].node.timer_tick_occurred();
1326 let updates = get_htlc_update_msgs(&nodes[0], &nodes[1].node.get_our_node_id());
1327 check_added_monitors(&nodes[0], 1);
1329 nodes[1].node.close_channel(&chan_id, &nodes[0].node.get_our_node_id()).unwrap();
1330 let node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1331 nodes[0].node.close_channel(&chan_id, &nodes[1].node.get_our_node_id()).unwrap();
1332 let node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1334 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
1335 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_1_shutdown);
1338 nodes[1].node.handle_update_fail_htlc(&nodes[0].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
1340 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &updates.update_fee.unwrap());
1342 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
1343 check_added_monitors(&nodes[1], 1);
1344 let (bs_raa, bs_cs) = get_revoke_commit_msgs(&nodes[1], &nodes[0].node.get_our_node_id());
1346 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1347 check_added_monitors(&nodes[0], 1);
1349 // At this point the Channel on nodes[0] has no record of any HTLCs but the latest
1350 // broadcastable commitment does contain the HTLC (but only the ChannelMonitor knows this).
1351 // Thus, the channel should not yet initiate closing_signed negotiation (but previously did).
1352 assert_eq!(nodes[0].node.get_and_clear_pending_msg_events(), Vec::new());
1354 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1355 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs);
1356 check_added_monitors(&nodes[0], 1);
1357 assert_eq!(nodes[0].node.get_and_clear_pending_msg_events(), Vec::new());
1359 expect_channel_shutdown_state!(nodes[0], chan_id, ChannelShutdownState::ResolvingHTLCs);
1360 assert_eq!(nodes[0].node.get_and_clear_pending_msg_events(), Vec::new());
1361 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_id).unwrap().clone();
1362 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1364 let as_raa_closing_signed = nodes[0].node.get_and_clear_pending_msg_events();
1365 assert_eq!(as_raa_closing_signed.len(), 2);
1367 if let MessageSendEvent::SendRevokeAndACK { msg, .. } = &as_raa_closing_signed[0] {
1368 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &msg);
1369 check_added_monitors(&nodes[1], 1);
1371 expect_payment_failed!(nodes[1], payment_hash_opt.unwrap(), true);
1373 } else { panic!("Unexpected message {:?}", as_raa_closing_signed[0]); }
1375 if let MessageSendEvent::SendClosingSigned { msg, .. } = &as_raa_closing_signed[1] {
1376 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &msg);
1377 } else { panic!("Unexpected message {:?}", as_raa_closing_signed[1]); }
1379 let bs_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
1380 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &bs_closing_signed);
1381 let (_, as_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1382 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &as_2nd_closing_signed.unwrap());
1383 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1384 assert!(node_1_none.is_none());
1386 check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
1387 check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
1391 fn outbound_update_no_early_closing_signed() {
1392 do_outbound_update_no_early_closing_signed(true);
1393 do_outbound_update_no_early_closing_signed(false);
1397 fn batch_funding_failure() {
1398 // Provides test coverage of batch funding failure, which previously deadlocked
1399 let chanmon_cfgs = create_chanmon_cfgs(4);
1400 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1401 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1402 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1404 exchange_open_accept_chan(&nodes[0], &nodes[1], 1_000_000, 0);
1405 exchange_open_accept_chan(&nodes[0], &nodes[2], 1_000_000, 0);
1407 let events = nodes[0].node.get_and_clear_pending_events();
1408 assert_eq!(events.len(), 2);
1409 // Build a transaction which only has the output for one of the two channels we're trying to
1410 // confirm. Previously this led to a deadlock in channel closure handling.
1411 let mut tx = Transaction { version: 2, lock_time: LockTime::ZERO, input: Vec::new(), output: Vec::new() };
1412 let mut chans = Vec::new();
1413 for (idx, ev) in events.iter().enumerate() {
1414 if let Event::FundingGenerationReady { temporary_channel_id, counterparty_node_id, output_script, .. } = ev {
1416 tx.output.push(TxOut { value: 1_000_000, script_pubkey: output_script.clone() });
1418 chans.push((temporary_channel_id, counterparty_node_id));
1419 } else { panic!(); }
1422 // We should probably end up with an error for both channels, but currently we don't generate
1423 // an error for the failing channel itself.
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 close = [ExpectedCloseEvent::from_id_reason(ChannelId::v1_from_funding_txid(tx.txid().as_ref(), 0), true, ClosureReason::ProcessingError { err })];
1427 nodes[0].node.batch_funding_transaction_generated(&chans, tx).unwrap_err();
1429 get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
1430 check_closed_events(&nodes[0], &close);
1431 assert_eq!(nodes[0].node.list_channels().len(), 0);