1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! Tests of our shutdown and closing_signed negotiation logic as well as some assorted force-close
13 use crate::sign::{EntropySource, SignerProvider};
14 use crate::chain::ChannelMonitorUpdateStatus;
15 use crate::chain::transaction::OutPoint;
16 use crate::events::{Event, MessageSendEvent, HTLCDestination, MessageSendEventsProvider, ClosureReason};
17 use crate::ln::channel_state::{ChannelDetails, ChannelShutdownState};
18 use crate::ln::channelmanager::{self, PaymentSendFailure, PaymentId, RecipientOnionFields, Retry};
19 use crate::routing::router::{PaymentParameters, get_route, RouteParameters};
21 use crate::ln::types::ChannelId;
22 use crate::ln::msgs::{ChannelMessageHandler, ErrorAction};
23 use crate::ln::onion_utils::INVALID_ONION_BLINDING;
24 use crate::ln::script::ShutdownScript;
25 use crate::util::test_utils;
26 use crate::util::test_utils::OnGetShutdownScriptpubkey;
27 use crate::util::errors::APIError;
28 use crate::util::config::UserConfig;
29 use crate::util::string::UntrustedString;
30 use crate::prelude::*;
32 use bitcoin::{Transaction, TxOut, WitnessProgram, WitnessVersion};
33 use bitcoin::amount::Amount;
34 use bitcoin::blockdata::locktime::absolute::LockTime;
35 use bitcoin::blockdata::script::Builder;
36 use bitcoin::blockdata::opcodes;
37 use bitcoin::network::Network;
38 use bitcoin::transaction::Version;
40 use crate::ln::functional_test_utils::*;
43 fn pre_funding_lock_shutdown_test() {
44 // Test sending a shutdown prior to channel_ready after funding generation
45 let chanmon_cfgs = create_chanmon_cfgs(2);
46 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
47 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
48 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
49 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0);
50 mine_transaction(&nodes[0], &tx);
51 mine_transaction(&nodes[1], &tx);
53 nodes[0].node.close_channel(&ChannelId::v1_from_funding_outpoint(OutPoint { txid: tx.txid(), index: 0 }), &nodes[1].node.get_our_node_id()).unwrap();
54 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
55 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
56 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
57 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
59 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
60 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
61 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
62 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
63 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
64 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
65 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
66 assert!(node_1_none.is_none());
68 assert!(nodes[0].node.list_channels().is_empty());
69 assert!(nodes[1].node.list_channels().is_empty());
70 check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 8000000);
71 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 8000000);
75 fn expect_channel_shutdown_state() {
76 // Test sending a shutdown prior to channel_ready after funding generation
77 let chanmon_cfgs = create_chanmon_cfgs(2);
78 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
79 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
80 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
81 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
83 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::NotShuttingDown);
85 nodes[0].node.close_channel(&chan_1.2, &nodes[1].node.get_our_node_id()).unwrap();
87 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::ShutdownInitiated);
88 expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::NotShuttingDown);
90 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
91 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
93 // node1 goes into NegotiatingClosingFee since there are no HTLCs in flight, note that it
94 // doesnt mean that node1 has sent/recved its closing signed message
95 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::ShutdownInitiated);
96 expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::NegotiatingClosingFee);
98 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
99 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
101 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::NegotiatingClosingFee);
102 expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::NegotiatingClosingFee);
104 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
105 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
106 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
107 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
108 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
109 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
110 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
111 assert!(node_1_none.is_none());
113 assert!(nodes[0].node.list_channels().is_empty());
114 assert!(nodes[1].node.list_channels().is_empty());
115 check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
116 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
120 fn expect_channel_shutdown_state_with_htlc() {
121 // Test sending a shutdown with outstanding updates pending.
122 let chanmon_cfgs = create_chanmon_cfgs(3);
123 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
124 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
125 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
126 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
127 let _chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
129 let (payment_preimage_0, payment_hash_0, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100_000);
131 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::NotShuttingDown);
132 expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::NotShuttingDown);
134 nodes[0].node.close_channel(&chan_1.2, &nodes[1].node.get_our_node_id()).unwrap();
136 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::ShutdownInitiated);
137 expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::NotShuttingDown);
139 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
140 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
142 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::ShutdownInitiated);
143 expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::ResolvingHTLCs);
145 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
146 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
148 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::ResolvingHTLCs);
149 expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::ResolvingHTLCs);
151 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
152 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
154 // Claim Funds on Node2
155 nodes[2].node.claim_funds(payment_preimage_0);
156 check_added_monitors!(nodes[2], 1);
157 expect_payment_claimed!(nodes[2], payment_hash_0, 100_000);
159 // Fulfil HTLCs on node1 and node0
160 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
161 assert!(updates.update_add_htlcs.is_empty());
162 assert!(updates.update_fail_htlcs.is_empty());
163 assert!(updates.update_fail_malformed_htlcs.is_empty());
164 assert!(updates.update_fee.is_none());
165 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
166 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
167 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), false, false);
168 check_added_monitors!(nodes[1], 1);
169 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
170 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
172 // Still in "resolvingHTLCs" on chan1 after htlc removed on chan2
173 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::ResolvingHTLCs);
174 expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::ResolvingHTLCs);
176 assert!(updates_2.update_add_htlcs.is_empty());
177 assert!(updates_2.update_fail_htlcs.is_empty());
178 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
179 assert!(updates_2.update_fee.is_none());
180 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
181 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
182 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
183 expect_payment_sent!(nodes[0], payment_preimage_0);
185 // all htlcs removed, chan1 advances to NegotiatingClosingFee
186 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::NegotiatingClosingFee);
187 expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::NegotiatingClosingFee);
189 // ClosingSignNegotion process
190 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
191 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
192 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
193 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
194 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
195 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
196 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
197 assert!(node_1_none.is_none());
198 check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
199 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
201 // Shutdown basically removes the channelDetails, testing of shutdowncomplete state unnecessary
202 assert!(nodes[0].node.list_channels().is_empty());
206 fn test_lnd_bug_6039() {
207 // LND sends a nonsense error message any time it gets a shutdown if there are still HTLCs
208 // pending. We currently swallow that error to work around LND's bug #6039. This test emulates
209 // the LND nonsense and ensures we at least kinda handle it.
210 let chanmon_cfgs = create_chanmon_cfgs(2);
211 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
212 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
213 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
214 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
216 let (payment_preimage, ..) = route_payment(&nodes[0], &[&nodes[1]], 100_000);
218 nodes[0].node.close_channel(&chan.2, &nodes[1].node.get_our_node_id()).unwrap();
219 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
220 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
222 // Generate an lnd-like error message and check that we respond by simply screaming louder to
223 // see if LND will accept our protocol compliance.
224 let err_msg = msgs::ErrorMessage { channel_id: chan.2, data: "link failed to shutdown".to_string() };
225 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &err_msg);
226 let node_a_responses = nodes[0].node.get_and_clear_pending_msg_events();
227 assert_eq!(node_a_responses[0], MessageSendEvent::SendShutdown {
228 node_id: nodes[1].node.get_our_node_id(),
229 msg: node_0_shutdown,
231 if let MessageSendEvent::HandleError { action: msgs::ErrorAction::SendWarningMessage { .. }, .. }
232 = node_a_responses[1] {} else { panic!(); }
234 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
236 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
237 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
239 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
241 // Assume that LND will eventually respond to our Shutdown if we clear all the remaining HTLCs
242 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
244 // ClosingSignNegotion process
245 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
246 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
247 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
248 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
249 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
250 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
251 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
252 assert!(node_1_none.is_none());
253 check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
254 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
256 // Shutdown basically removes the channelDetails, testing of shutdowncomplete state unnecessary
257 assert!(nodes[0].node.list_channels().is_empty());
261 fn shutdown_on_unfunded_channel() {
262 // Test receiving a shutdown prior to funding generation
263 let chanmon_cfgs = create_chanmon_cfgs(2);
264 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
265 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
266 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
268 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1_000_000, 100_000, 0, None, None).unwrap();
269 let open_chan = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
271 // Create a dummy P2WPKH script
272 let script = Builder::new().push_int(0)
273 .push_slice(&[0; 20])
276 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &msgs::Shutdown {
277 channel_id: open_chan.common_fields.temporary_channel_id, scriptpubkey: script,
279 check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyCoopClosedUnfundedChannel, [nodes[1].node.get_our_node_id()], 1_000_000);
283 fn close_on_unfunded_channel() {
284 // Test the user asking us to close prior to funding generation
285 let chanmon_cfgs = create_chanmon_cfgs(2);
286 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
287 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
288 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
290 let chan_id = nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1_000_000, 100_000, 0, None, None).unwrap();
291 let _open_chan = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
293 nodes[0].node.close_channel(&chan_id, &nodes[1].node.get_our_node_id()).unwrap();
294 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed, [nodes[1].node.get_our_node_id()], 1_000_000);
298 fn expect_channel_shutdown_state_with_force_closure() {
299 // Test sending a shutdown prior to channel_ready after funding generation
300 let chanmon_cfgs = create_chanmon_cfgs(2);
301 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
302 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
303 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
304 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
306 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::NotShuttingDown);
307 expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::NotShuttingDown);
309 nodes[1].node.force_close_broadcasting_latest_txn(&chan_1.2, &nodes[0].node.get_our_node_id()).unwrap();
310 check_closed_broadcast!(nodes[1], true);
311 check_added_monitors!(nodes[1], 1);
313 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::NotShuttingDown);
314 assert!(nodes[1].node.list_channels().is_empty());
316 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
317 assert_eq!(node_txn.len(), 1);
318 check_spends!(node_txn[0], chan_1.3);
319 mine_transaction(&nodes[0], &node_txn[0]);
320 check_added_monitors!(nodes[0], 1);
322 assert!(nodes[0].node.list_channels().is_empty());
323 assert!(nodes[1].node.list_channels().is_empty());
324 check_closed_broadcast!(nodes[0], true);
325 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed, [nodes[1].node.get_our_node_id()], 100000);
326 check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed, [nodes[0].node.get_our_node_id()], 100000);
330 fn updates_shutdown_wait() {
331 // Test sending a shutdown with outstanding updates pending
332 let chanmon_cfgs = create_chanmon_cfgs(3);
333 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
334 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
335 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
336 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
337 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
338 let logger = test_utils::TestLogger::new();
339 let scorer = test_utils::TestScorer::new();
340 let keys_manager = test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
341 let random_seed_bytes = keys_manager.get_secure_random_bytes();
343 let (payment_preimage_0, payment_hash_0, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100_000);
345 nodes[0].node.close_channel(&chan_1.2, &nodes[1].node.get_our_node_id()).unwrap();
346 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
347 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
348 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
349 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
351 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
352 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
354 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
356 let payment_params_1 = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id(), TEST_FINAL_CLTV)
357 .with_bolt11_features(nodes[1].node.bolt11_invoice_features()).unwrap();
358 let route_params = RouteParameters::from_payment_params_and_value(payment_params_1, 100_000);
359 let route_1 = get_route(&nodes[0].node.get_our_node_id(), &route_params,
360 &nodes[0].network_graph.read_only(), None, &logger, &scorer, &Default::default(), &random_seed_bytes).unwrap();
361 let payment_params_2 = PaymentParameters::from_node_id(nodes[0].node.get_our_node_id(), TEST_FINAL_CLTV)
362 .with_bolt11_features(nodes[0].node.bolt11_invoice_features()).unwrap();
363 let route_params = RouteParameters::from_payment_params_and_value(payment_params_2, 100_000);
364 let route_2 = get_route(&nodes[1].node.get_our_node_id(), &route_params,
365 &nodes[1].network_graph.read_only(), None, &logger, &scorer, &Default::default(), &random_seed_bytes).unwrap();
366 unwrap_send_err!(nodes[0].node.send_payment_with_route(&route_1, payment_hash,
367 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)
368 ), true, APIError::ChannelUnavailable {..}, {});
369 unwrap_send_err!(nodes[1].node.send_payment_with_route(&route_2, payment_hash,
370 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)
371 ), true, APIError::ChannelUnavailable {..}, {});
373 nodes[2].node.claim_funds(payment_preimage_0);
374 check_added_monitors!(nodes[2], 1);
375 expect_payment_claimed!(nodes[2], payment_hash_0, 100_000);
377 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
378 assert!(updates.update_add_htlcs.is_empty());
379 assert!(updates.update_fail_htlcs.is_empty());
380 assert!(updates.update_fail_malformed_htlcs.is_empty());
381 assert!(updates.update_fee.is_none());
382 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
383 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
384 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), false, false);
385 check_added_monitors!(nodes[1], 1);
386 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
387 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
389 assert!(updates_2.update_add_htlcs.is_empty());
390 assert!(updates_2.update_fail_htlcs.is_empty());
391 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
392 assert!(updates_2.update_fee.is_none());
393 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
394 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
395 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
396 expect_payment_sent!(nodes[0], payment_preimage_0);
398 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
399 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
400 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
401 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
402 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
403 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
404 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
405 assert!(node_1_none.is_none());
406 check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
407 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
409 assert!(nodes[0].node.list_channels().is_empty());
411 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
412 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
413 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
414 assert!(nodes[1].node.list_channels().is_empty());
415 assert!(nodes[2].node.list_channels().is_empty());
416 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[2].node.get_our_node_id()], 100000);
417 check_closed_event!(nodes[2], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
421 fn htlc_fail_async_shutdown() {
422 do_htlc_fail_async_shutdown(true);
423 do_htlc_fail_async_shutdown(false);
426 fn do_htlc_fail_async_shutdown(blinded_recipient: bool) {
427 // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
428 let chanmon_cfgs = create_chanmon_cfgs(3);
429 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
430 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
431 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
432 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
433 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
435 let amt_msat = 100000;
436 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash(&nodes[2], Some(amt_msat), None);
437 let route_params = if blinded_recipient {
438 crate::ln::blinded_payment_tests::get_blinded_route_parameters(
439 amt_msat, our_payment_secret, 1, 100000000,
440 nodes.iter().skip(1).map(|n| n.node.get_our_node_id()).collect(), &[&chan_2.0.contents],
441 &chanmon_cfgs[2].keys_manager)
443 RouteParameters::from_payment_params_and_value(
444 PaymentParameters::from_node_id(nodes[2].node.get_our_node_id(), TEST_FINAL_CLTV), amt_msat)
446 nodes[0].node.send_payment(our_payment_hash,
447 RecipientOnionFields::secret_only(our_payment_secret),
448 PaymentId(our_payment_hash.0), route_params, Retry::Attempts(0)).unwrap();
449 check_added_monitors!(nodes[0], 1);
450 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
451 assert_eq!(updates.update_add_htlcs.len(), 1);
452 assert!(updates.update_fulfill_htlcs.is_empty());
453 assert!(updates.update_fail_htlcs.is_empty());
454 assert!(updates.update_fail_malformed_htlcs.is_empty());
455 assert!(updates.update_fee.is_none());
457 nodes[1].node.close_channel(&chan_1.2, &nodes[0].node.get_our_node_id()).unwrap();
458 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
459 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
460 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
462 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
463 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
464 check_added_monitors!(nodes[1], 1);
465 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
466 commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false, false);
468 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
469 assert!(updates_2.update_add_htlcs.is_empty());
470 assert!(updates_2.update_fulfill_htlcs.is_empty());
471 assert_eq!(updates_2.update_fail_htlcs.len(), 1);
472 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
473 assert!(updates_2.update_fee.is_none());
475 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]);
476 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
478 if blinded_recipient {
479 expect_payment_failed_conditions(&nodes[0], our_payment_hash, false,
480 PaymentFailedConditions::new().expected_htlc_error_data(INVALID_ONION_BLINDING, &[0; 32]));
482 expect_payment_failed_with_update!(nodes[0], our_payment_hash, false, chan_2.0.contents.short_channel_id, true);
485 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
486 assert_eq!(msg_events.len(), 1);
487 let node_0_closing_signed = match msg_events[0] {
488 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
489 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
492 _ => panic!("Unexpected event"),
495 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
496 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
497 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
498 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
499 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
500 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
501 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
502 assert!(node_1_none.is_none());
504 assert!(nodes[0].node.list_channels().is_empty());
506 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
507 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
508 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
509 assert!(nodes[1].node.list_channels().is_empty());
510 assert!(nodes[2].node.list_channels().is_empty());
511 check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
512 let event1 = ExpectedCloseEvent {
513 channel_capacity_sats: Some(100000),
515 counterparty_node_id: Some(nodes[0].node.get_our_node_id()),
516 discard_funding: false,
517 reason: Some(ClosureReason::LocallyInitiatedCooperativeClosure),
518 channel_funding_txo: None,
519 user_channel_id: None,
521 let event2 = ExpectedCloseEvent {
522 channel_capacity_sats: Some(100000),
524 counterparty_node_id: Some(nodes[2].node.get_our_node_id()),
525 discard_funding: false,
526 reason: Some(ClosureReason::CounterpartyInitiatedCooperativeClosure),
527 channel_funding_txo: None,
528 user_channel_id: None,
530 check_closed_events(&nodes[1], &[event1, event2]);
531 check_closed_event!(nodes[2], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
534 fn do_test_shutdown_rebroadcast(recv_count: u8) {
535 // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
536 // messages delivered prior to disconnect
537 let chanmon_cfgs = create_chanmon_cfgs(3);
538 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
539 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
540 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
541 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
542 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
544 let (payment_preimage, payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100_000);
546 nodes[1].node.close_channel(&chan_1.2, &nodes[0].node.get_our_node_id()).unwrap();
547 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
549 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
550 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
552 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
556 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
557 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
559 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
560 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
562 let node_0_reestablish = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
563 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
564 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
566 let node_1_reestablish = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
568 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish);
569 let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
570 assert!(node_1_shutdown == node_1_2nd_shutdown);
572 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish);
573 let node_0_2nd_shutdown = if recv_count > 0 {
574 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
575 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
578 let node_0_chan_update = get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
579 assert_eq!(node_0_chan_update.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
580 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
581 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
583 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_2nd_shutdown);
585 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
586 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
588 nodes[2].node.claim_funds(payment_preimage);
589 check_added_monitors!(nodes[2], 1);
590 expect_payment_claimed!(nodes[2], payment_hash, 100_000);
592 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
593 assert!(updates.update_add_htlcs.is_empty());
594 assert!(updates.update_fail_htlcs.is_empty());
595 assert!(updates.update_fail_malformed_htlcs.is_empty());
596 assert!(updates.update_fee.is_none());
597 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
598 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
599 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), false, false);
600 check_added_monitors!(nodes[1], 1);
601 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
602 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
604 assert!(updates_2.update_add_htlcs.is_empty());
605 assert!(updates_2.update_fail_htlcs.is_empty());
606 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
607 assert!(updates_2.update_fee.is_none());
608 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
609 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
610 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
611 expect_payment_sent!(nodes[0], payment_preimage);
613 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
615 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
616 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
617 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
618 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
619 assert!(node_0_2nd_closing_signed.is_some());
622 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
623 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
625 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
626 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
628 let node_1_2nd_reestablish = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
629 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
630 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
633 // If all closing_signeds weren't delivered we can just resume where we left off...
634 let node_0_2nd_reestablish = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
636 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
637 let node_0_msgs = nodes[0].node.get_and_clear_pending_msg_events();
638 assert_eq!(node_0_msgs.len(), 2);
639 let node_0_2nd_closing_signed = match node_0_msgs[1] {
640 MessageSendEvent::SendClosingSigned { ref msg, .. } => {
641 assert_eq!(node_0_closing_signed, *msg);
647 let node_0_3rd_shutdown = match node_0_msgs[0] {
648 MessageSendEvent::SendShutdown { ref msg, .. } => {
649 assert_eq!(node_0_2nd_shutdown, *msg);
654 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
656 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
657 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
658 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
660 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_3rd_shutdown);
661 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
663 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_3rd_shutdown);
665 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed);
666 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
667 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
668 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
669 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
670 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
671 assert!(node_1_none.is_none());
672 check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
674 // If one node, however, received + responded with an identical closing_signed we end
675 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
676 // There isn't really anything better we can do simply, but in the future we might
677 // explore storing a set of recently-closed channels that got disconnected during
678 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
679 // give our counterparty enough time to (potentially) broadcast a cooperative closing
681 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
683 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
684 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
685 assert_eq!(msg_events.len(), 2);
686 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[1] {
688 &ErrorAction::SendErrorMessage { ref msg } => {
689 nodes[1].node.handle_error(&nodes[0].node.get_our_node_id(), &msg);
690 assert_eq!(msg.channel_id, chan_1.2);
692 _ => panic!("Unexpected event!"),
694 } else { panic!("Needed SendErrorMessage close"); }
696 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
697 // checks it, but in this case nodes[1] didn't ever get a chance to receive a
698 // closing_signed so we do it ourselves
699 check_closed_broadcast!(nodes[1], false);
700 check_added_monitors!(nodes[1], 1);
701 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())) }
702 , [nodes[0].node.get_our_node_id()], 100000);
705 assert!(nodes[0].node.list_channels().is_empty());
707 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
708 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
709 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
710 assert!(nodes[1].node.list_channels().is_empty());
711 assert!(nodes[2].node.list_channels().is_empty());
712 check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
713 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[2].node.get_our_node_id()], 100000);
714 check_closed_event!(nodes[2], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
718 fn test_shutdown_rebroadcast() {
719 do_test_shutdown_rebroadcast(0);
720 do_test_shutdown_rebroadcast(1);
721 do_test_shutdown_rebroadcast(2);
725 fn test_upfront_shutdown_script() {
726 // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
727 // enforce it at shutdown message
729 let mut config = UserConfig::default();
730 config.channel_handshake_config.announced_channel = true;
731 config.channel_handshake_limits.force_announced_channel_preference = false;
732 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
733 let user_cfgs = [None, Some(config), None];
734 let chanmon_cfgs = create_chanmon_cfgs(3);
735 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
736 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
737 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
739 // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
740 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000);
741 nodes[0].node.close_channel(&chan.2, &nodes[2].node.get_our_node_id()).unwrap();
742 let node_0_orig_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
743 let mut node_0_shutdown = node_0_orig_shutdown.clone();
744 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
745 // Test we enforce upfront_scriptpbukey if by providing a different one at closing that we warn
746 // the peer and ignore the message.
747 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
748 assert!(regex::Regex::new(r"Got shutdown request with a scriptpubkey \([A-Fa-f0-9]+\) which did not match their previous scriptpubkey.")
749 .unwrap().is_match(&check_warn_msg!(nodes[2], nodes[0].node.get_our_node_id(), chan.2)));
750 // This allows nodes[2] to retry the shutdown message, which should get a response:
751 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_orig_shutdown);
752 get_event_msg!(nodes[2], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
754 // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
755 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000);
756 nodes[0].node.close_channel(&chan.2, &nodes[2].node.get_our_node_id()).unwrap();
757 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
758 // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
759 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
760 let events = nodes[2].node.get_and_clear_pending_msg_events();
761 assert_eq!(events.len(), 1);
763 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
764 _ => panic!("Unexpected event"),
767 // We test that if case of peer non-signaling we don't enforce committed script at channel opening
768 *nodes[0].override_init_features.borrow_mut() = Some(nodes[0].node.init_features().clear_upfront_shutdown_script());
769 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000);
770 nodes[0].node.close_channel(&chan.2, &nodes[1].node.get_our_node_id()).unwrap();
771 let node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
772 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_1_shutdown);
773 check_added_monitors!(nodes[1], 1);
774 let events = nodes[1].node.get_and_clear_pending_msg_events();
775 assert_eq!(events.len(), 1);
777 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
778 _ => panic!("Unexpected event"),
781 // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
782 // channel smoothly, opt-out is from channel initiator here
783 *nodes[0].override_init_features.borrow_mut() = None;
784 let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000);
785 nodes[1].node.close_channel(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
786 check_added_monitors!(nodes[1], 1);
787 let node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
788 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
789 let events = nodes[0].node.get_and_clear_pending_msg_events();
790 assert_eq!(events.len(), 1);
792 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
793 _ => panic!("Unexpected event"),
796 //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
797 //// channel smoothly
798 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000);
799 nodes[1].node.close_channel(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
800 check_added_monitors!(nodes[1], 1);
801 let node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
802 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
803 let events = nodes[0].node.get_and_clear_pending_msg_events();
804 assert_eq!(events.len(), 2);
806 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
807 _ => panic!("Unexpected event"),
810 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
811 _ => panic!("Unexpected event"),
816 fn test_unsupported_anysegwit_upfront_shutdown_script() {
817 let chanmon_cfgs = create_chanmon_cfgs(2);
818 let mut node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
819 // Clear shutdown_anysegwit on initiator
820 *node_cfgs[0].override_init_features.borrow_mut() = Some(channelmanager::provided_init_features(&test_default_channel_config()).clear_shutdown_anysegwit());
821 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
822 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
824 // Use a non-v0 segwit script supported by option_shutdown_anysegwit
825 let anysegwit_shutdown_script = Builder::new()
827 .push_slice(&[0, 40])
830 // Check script when handling an open_channel message
831 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None, None).unwrap();
832 let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
833 open_channel.common_fields.shutdown_scriptpubkey = Some(anysegwit_shutdown_script.clone());
834 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel);
836 let events = nodes[1].node.get_and_clear_pending_msg_events();
837 assert_eq!(events.len(), 1);
839 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
840 assert_eq!(node_id, nodes[0].node.get_our_node_id());
841 assert_eq!(msg.data, "Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: OP_PUSHNUM_16 OP_PUSHBYTES_2 0028");
843 _ => panic!("Unexpected event"),
846 let chanmon_cfgs = create_chanmon_cfgs(2);
847 let mut node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
848 // Clear shutdown_anysegwit on responder
849 *node_cfgs[1].override_init_features.borrow_mut() = Some(channelmanager::provided_init_features(&test_default_channel_config()).clear_shutdown_anysegwit());
850 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
851 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
853 // Check script when handling an accept_channel message
854 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None, None).unwrap();
855 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
856 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel);
857 let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
858 accept_channel.common_fields.shutdown_scriptpubkey = Some(anysegwit_shutdown_script.clone());
859 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel);
861 let events = nodes[0].node.get_and_clear_pending_msg_events();
862 assert_eq!(events.len(), 1);
864 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
865 assert_eq!(node_id, nodes[1].node.get_our_node_id());
866 assert_eq!(msg.data, "Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: OP_PUSHNUM_16 OP_PUSHBYTES_2 0028");
868 _ => panic!("Unexpected event"),
870 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() }
871 , [nodes[1].node.get_our_node_id()], 100000);
875 fn test_invalid_upfront_shutdown_script() {
876 let chanmon_cfgs = create_chanmon_cfgs(2);
877 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
878 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
879 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
881 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None, None).unwrap();
883 // Use a segwit v0 script with an unsupported witness program
884 let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
885 open_channel.common_fields.shutdown_scriptpubkey = Some(Builder::new().push_int(0)
888 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel);
890 let events = nodes[1].node.get_and_clear_pending_msg_events();
891 assert_eq!(events.len(), 1);
893 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
894 assert_eq!(node_id, nodes[0].node.get_our_node_id());
895 assert_eq!(msg.data, "Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: OP_0 OP_PUSHBYTES_2 0000");
897 _ => panic!("Unexpected event"),
902 fn test_segwit_v0_shutdown_script() {
903 let mut config = UserConfig::default();
904 config.channel_handshake_config.announced_channel = true;
905 config.channel_handshake_limits.force_announced_channel_preference = false;
906 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
907 let user_cfgs = [None, Some(config), None];
908 let chanmon_cfgs = create_chanmon_cfgs(3);
909 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
910 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
911 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
913 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
914 nodes[1].node.close_channel(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
915 check_added_monitors!(nodes[1], 1);
917 // Use a segwit v0 script supported even without option_shutdown_anysegwit
918 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
919 node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
920 .push_slice(&[0; 20])
922 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
924 let events = nodes[0].node.get_and_clear_pending_msg_events();
925 assert_eq!(events.len(), 2);
927 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
928 _ => panic!("Unexpected event"),
931 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
932 _ => panic!("Unexpected event"),
937 fn test_anysegwit_shutdown_script() {
938 let mut config = UserConfig::default();
939 config.channel_handshake_config.announced_channel = true;
940 config.channel_handshake_limits.force_announced_channel_preference = false;
941 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
942 let user_cfgs = [None, Some(config), None];
943 let chanmon_cfgs = create_chanmon_cfgs(3);
944 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
945 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
946 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
948 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
949 nodes[1].node.close_channel(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
950 check_added_monitors!(nodes[1], 1);
952 // Use a non-v0 segwit script supported by option_shutdown_anysegwit
953 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
954 node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
957 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
959 let events = nodes[0].node.get_and_clear_pending_msg_events();
960 assert_eq!(events.len(), 2);
962 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
963 _ => panic!("Unexpected event"),
966 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
967 _ => panic!("Unexpected event"),
972 fn test_unsupported_anysegwit_shutdown_script() {
973 let mut config = UserConfig::default();
974 config.channel_handshake_config.announced_channel = true;
975 config.channel_handshake_limits.force_announced_channel_preference = false;
976 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
977 let user_cfgs = [None, Some(config), None];
978 let chanmon_cfgs = create_chanmon_cfgs(3);
979 let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
980 *node_cfgs[0].override_init_features.borrow_mut() = Some(channelmanager::provided_init_features(&config).clear_shutdown_anysegwit());
981 *node_cfgs[1].override_init_features.borrow_mut() = Some(channelmanager::provided_init_features(&config).clear_shutdown_anysegwit());
982 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
983 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
985 // Check that using an unsupported shutdown script fails and a supported one succeeds.
986 let supported_shutdown_script = chanmon_cfgs[1].keys_manager.get_shutdown_scriptpubkey().unwrap();
987 let unsupported_witness_program = WitnessProgram::new(WitnessVersion::V16, &[0, 40]).unwrap();
988 let unsupported_shutdown_script =
989 ShutdownScript::new_witness_program(&unsupported_witness_program).unwrap();
990 chanmon_cfgs[1].keys_manager
991 .expect(OnGetShutdownScriptpubkey { returns: unsupported_shutdown_script.clone() })
992 .expect(OnGetShutdownScriptpubkey { returns: supported_shutdown_script });
994 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
995 match nodes[1].node.close_channel(&chan.2, &nodes[0].node.get_our_node_id()) {
996 Err(APIError::IncompatibleShutdownScript { script }) => {
997 assert_eq!(script.into_inner(), unsupported_shutdown_script.clone().into_inner());
999 Err(e) => panic!("Unexpected error: {:?}", e),
1000 Ok(_) => panic!("Expected error"),
1002 nodes[1].node.close_channel(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
1003 check_added_monitors!(nodes[1], 1);
1005 // Use a non-v0 segwit script unsupported without option_shutdown_anysegwit
1006 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1007 node_0_shutdown.scriptpubkey = unsupported_shutdown_script.into_inner();
1008 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
1010 assert_eq!(&check_warn_msg!(nodes[0], nodes[1].node.get_our_node_id(), chan.2),
1011 "Got a nonstandard scriptpubkey (60020028) from remote peer");
1015 fn test_invalid_shutdown_script() {
1016 let mut config = UserConfig::default();
1017 config.channel_handshake_config.announced_channel = true;
1018 config.channel_handshake_limits.force_announced_channel_preference = false;
1019 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
1020 let user_cfgs = [None, Some(config), None];
1021 let chanmon_cfgs = create_chanmon_cfgs(3);
1022 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1023 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
1024 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1026 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
1027 nodes[1].node.close_channel(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
1028 check_added_monitors!(nodes[1], 1);
1030 // Use a segwit v0 script with an unsupported witness program
1031 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1032 node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
1033 .push_slice(&[0, 0])
1035 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
1037 assert_eq!(&check_warn_msg!(nodes[0], nodes[1].node.get_our_node_id(), chan.2),
1038 "Got a nonstandard scriptpubkey (00020000) from remote peer");
1042 fn test_user_shutdown_script() {
1043 let mut config = test_default_channel_config();
1044 config.channel_handshake_config.announced_channel = true;
1045 config.channel_handshake_limits.force_announced_channel_preference = false;
1046 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
1047 let user_cfgs = [None, Some(config), None];
1048 let chanmon_cfgs = create_chanmon_cfgs(3);
1049 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1050 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
1051 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1053 // Segwit v0 script of the form OP_0 <20-byte hash>
1054 let script = Builder::new().push_int(0)
1055 .push_slice(&[0; 20])
1058 let shutdown_script = ShutdownScript::try_from(script.clone()).unwrap();
1060 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
1061 nodes[1].node.close_channel_with_feerate_and_script(&chan.2, &nodes[0].node.get_our_node_id(), None, Some(shutdown_script)).unwrap();
1062 check_added_monitors!(nodes[1], 1);
1064 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1066 assert_eq!(node_0_shutdown.scriptpubkey, script);
1070 fn test_already_set_user_shutdown_script() {
1071 let mut config = test_default_channel_config();
1072 config.channel_handshake_config.announced_channel = true;
1073 config.channel_handshake_limits.force_announced_channel_preference = false;
1074 let user_cfgs = [None, Some(config), None];
1075 let chanmon_cfgs = create_chanmon_cfgs(3);
1076 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1077 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
1078 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1080 // Segwit v0 script of the form OP_0 <20-byte hash>
1081 let script = Builder::new().push_int(0)
1082 .push_slice(&[0; 20])
1085 let shutdown_script = ShutdownScript::try_from(script).unwrap();
1087 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
1088 let result = nodes[1].node.close_channel_with_feerate_and_script(&chan.2, &nodes[0].node.get_our_node_id(), None, Some(shutdown_script));
1090 assert_eq!(result, Err(APIError::APIMisuseError { err: "Cannot override shutdown script for a channel with one already set".to_string() }));
1093 #[derive(PartialEq)]
1100 fn do_test_closing_signed_reinit_timeout(timeout_step: TimeoutStep) {
1101 // The range-based closing signed negotiation allows the funder to restart the process with a
1102 // new range if the previous range did not overlap. This allows implementations to request user
1103 // intervention allowing users to enter a new fee range. We do not implement the sending side
1104 // of this, instead opting to allow users to enter an explicit "willing to pay up to X to avoid
1105 // force-closing" value and relying on that instead.
1107 // Here we run test the fundee side of that restart mechanism, implementing the funder side of
1109 let chanmon_cfgs = create_chanmon_cfgs(2);
1110 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1111 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1112 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1113 let chan_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
1115 send_payment(&nodes[0], &[&nodes[1]], 8_000_000);
1117 nodes[0].node.close_channel(&chan_id, &nodes[1].node.get_our_node_id()).unwrap();
1118 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1119 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
1120 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1121 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
1124 // Now we set nodes[1] to require a relatively high feerate for closing. This should result
1125 // in it rejecting nodes[0]'s initial closing_signed, giving nodes[0] a chance to try
1127 let mut feerate_lock = chanmon_cfgs[1].fee_estimator.sat_per_kw.lock().unwrap();
1128 *feerate_lock *= 10;
1131 let mut node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1132 // nodes[0] should use a "reasonable" feerate, well under the 10 sat/vByte that nodes[1] thinks
1133 // is the current prevailing feerate.
1134 assert!(node_0_closing_signed.fee_satoshis <= 500);
1136 if timeout_step != TimeoutStep::AfterShutdown {
1137 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1138 assert!(check_warn_msg!(nodes[1], nodes[0].node.get_our_node_id(), chan_id)
1139 .starts_with("Unable to come to consensus about closing feerate"));
1141 // Now deliver a mutated closing_signed indicating a higher acceptable fee range, which
1142 // nodes[1] should happily accept and respond to.
1143 node_0_closing_signed.fee_range.as_mut().unwrap().max_fee_satoshis *= 10;
1145 let mut node_0_per_peer_lock;
1146 let mut node_0_peer_state_lock;
1147 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;
1149 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1150 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
1151 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
1152 let node_0_2nd_closing_signed = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1153 if timeout_step == TimeoutStep::NoTimeout {
1154 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.1.unwrap());
1155 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
1157 check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
1160 if timeout_step != TimeoutStep::NoTimeout {
1161 assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
1163 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1166 nodes[1].node.timer_tick_occurred();
1167 nodes[1].node.timer_tick_occurred();
1169 let txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1170 assert_eq!(txn.len(), 1);
1171 assert_eq!(txn[0].output.len(), 2);
1173 if timeout_step != TimeoutStep::NoTimeout {
1174 assert!((txn[0].output[0].script_pubkey.is_p2wpkh() &&
1175 txn[0].output[1].script_pubkey.is_p2wsh()) ||
1176 (txn[0].output[1].script_pubkey.is_p2wpkh() &&
1177 txn[0].output[0].script_pubkey.is_p2wsh()));
1178 check_closed_broadcast!(nodes[1], true);
1179 check_added_monitors!(nodes[1], 1);
1180 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "closing_signed negotiation failed to finish within two timer ticks".to_string() }
1181 , [nodes[0].node.get_our_node_id()], 100000);
1183 assert!(txn[0].output[0].script_pubkey.is_p2wpkh());
1184 assert!(txn[0].output[1].script_pubkey.is_p2wpkh());
1186 let events = nodes[1].node.get_and_clear_pending_msg_events();
1187 assert_eq!(events.len(), 1);
1189 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1190 assert_eq!(msg.contents.flags & 2, 2);
1192 _ => panic!("Unexpected event"),
1198 fn test_closing_signed_reinit_timeout() {
1199 do_test_closing_signed_reinit_timeout(TimeoutStep::AfterShutdown);
1200 do_test_closing_signed_reinit_timeout(TimeoutStep::AfterClosingSigned);
1201 do_test_closing_signed_reinit_timeout(TimeoutStep::NoTimeout);
1204 fn do_simple_legacy_shutdown_test(high_initiator_fee: bool) {
1205 // A simpe test of the legacy shutdown fee negotiation logic.
1206 let chanmon_cfgs = create_chanmon_cfgs(2);
1207 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1208 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1209 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1211 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
1213 if high_initiator_fee {
1214 // If high_initiator_fee is set, set nodes[0]'s feerate significantly higher. This
1215 // shouldn't impact the flow at all given nodes[1] will happily accept the higher fee.
1216 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
1217 *feerate_lock *= 10;
1220 nodes[0].node.close_channel(&chan.2, &nodes[1].node.get_our_node_id()).unwrap();
1221 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1222 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
1223 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1224 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
1226 let mut node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1227 node_0_closing_signed.fee_range = None;
1228 if high_initiator_fee {
1229 assert!(node_0_closing_signed.fee_satoshis > 500);
1231 assert!(node_0_closing_signed.fee_satoshis < 500);
1234 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1235 let (_, mut node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1236 node_1_closing_signed.as_mut().unwrap().fee_range = None;
1238 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
1239 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1240 assert!(node_0_none.is_none());
1241 check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
1242 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
1246 fn simple_legacy_shutdown_test() {
1247 do_simple_legacy_shutdown_test(false);
1248 do_simple_legacy_shutdown_test(true);
1252 fn simple_target_feerate_shutdown() {
1253 // Simple test of target in `close_channel_with_target_feerate`.
1254 let chanmon_cfgs = create_chanmon_cfgs(2);
1255 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1256 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1257 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1259 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
1260 let chan_id = chan.2;
1262 nodes[0].node.close_channel_with_feerate_and_script(&chan_id, &nodes[1].node.get_our_node_id(), Some(253 * 10), None).unwrap();
1263 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1264 nodes[1].node.close_channel_with_feerate_and_script(&chan_id, &nodes[0].node.get_our_node_id(), Some(253 * 5), None).unwrap();
1265 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1267 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
1268 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
1270 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1271 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1272 let (_, node_1_closing_signed_opt) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1273 let node_1_closing_signed = node_1_closing_signed_opt.unwrap();
1275 // nodes[1] was passed a target which was larger than the current channel feerate, which it
1276 // should ignore in favor of the channel fee, as there is no use demanding a minimum higher
1277 // than what will be paid on a force-close transaction. Note that we have to consider rounding,
1278 // so only check that we're within 10 sats.
1279 assert!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis >=
1280 node_1_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis * 10 - 5);
1281 assert!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis <=
1282 node_1_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis * 10 + 5);
1284 // Further, because nodes[0]'s target fee is larger than the `Normal` fee estimation plus our
1285 // force-closure-avoidance buffer, min should equal max, and the nodes[1]-selected fee should
1286 // be the nodes[0] only available fee.
1287 assert_eq!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis,
1288 node_0_closing_signed.fee_range.as_ref().unwrap().max_fee_satoshis);
1289 assert_eq!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis,
1290 node_0_closing_signed.fee_satoshis);
1291 assert_eq!(node_0_closing_signed.fee_satoshis, node_1_closing_signed.fee_satoshis);
1293 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
1294 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1295 assert!(node_0_none.is_none());
1296 check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
1297 check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
1300 fn do_outbound_update_no_early_closing_signed(use_htlc: bool) {
1301 // Previously, if we have a pending inbound HTLC (or fee update) on a channel which has
1302 // initiated shutdown, we'd send our initial closing_signed immediately after receiving the
1303 // peer's last RAA to remove the HTLC/fee update, but before receiving their final
1304 // commitment_signed for a commitment without the HTLC/with the new fee. This caused at least
1305 // LDK peers to force-close as we initiated closing_signed prior to the channel actually being
1306 // fully empty of pending updates/HTLCs.
1307 let chanmon_cfgs = create_chanmon_cfgs(2);
1308 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1309 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1310 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1312 let chan_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
1314 send_payment(&nodes[0], &[&nodes[1]], 1_000_000);
1315 let payment_hash_opt = if use_htlc {
1316 Some(route_payment(&nodes[1], &[&nodes[0]], 10_000).1)
1322 nodes[0].node.fail_htlc_backwards(&payment_hash_opt.unwrap());
1323 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[0],
1324 [HTLCDestination::FailedPayment { payment_hash: payment_hash_opt.unwrap() }]);
1326 *chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap() *= 10;
1327 nodes[0].node.timer_tick_occurred();
1329 let updates = get_htlc_update_msgs(&nodes[0], &nodes[1].node.get_our_node_id());
1330 check_added_monitors(&nodes[0], 1);
1332 nodes[1].node.close_channel(&chan_id, &nodes[0].node.get_our_node_id()).unwrap();
1333 let node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1334 nodes[0].node.close_channel(&chan_id, &nodes[1].node.get_our_node_id()).unwrap();
1335 let node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1337 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
1338 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_1_shutdown);
1341 nodes[1].node.handle_update_fail_htlc(&nodes[0].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
1343 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &updates.update_fee.unwrap());
1345 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
1346 check_added_monitors(&nodes[1], 1);
1347 let (bs_raa, bs_cs) = get_revoke_commit_msgs(&nodes[1], &nodes[0].node.get_our_node_id());
1349 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1350 check_added_monitors(&nodes[0], 1);
1352 // At this point the Channel on nodes[0] has no record of any HTLCs but the latest
1353 // broadcastable commitment does contain the HTLC (but only the ChannelMonitor knows this).
1354 // Thus, the channel should not yet initiate closing_signed negotiation (but previously did).
1355 assert_eq!(nodes[0].node.get_and_clear_pending_msg_events(), Vec::new());
1357 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1358 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs);
1359 check_added_monitors(&nodes[0], 1);
1360 assert_eq!(nodes[0].node.get_and_clear_pending_msg_events(), Vec::new());
1362 expect_channel_shutdown_state!(nodes[0], chan_id, ChannelShutdownState::ResolvingHTLCs);
1363 assert_eq!(nodes[0].node.get_and_clear_pending_msg_events(), Vec::new());
1364 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_id).unwrap().clone();
1365 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1367 let as_raa_closing_signed = nodes[0].node.get_and_clear_pending_msg_events();
1368 assert_eq!(as_raa_closing_signed.len(), 2);
1370 if let MessageSendEvent::SendRevokeAndACK { msg, .. } = &as_raa_closing_signed[0] {
1371 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &msg);
1372 check_added_monitors(&nodes[1], 1);
1374 expect_payment_failed!(nodes[1], payment_hash_opt.unwrap(), true);
1376 } else { panic!("Unexpected message {:?}", as_raa_closing_signed[0]); }
1378 if let MessageSendEvent::SendClosingSigned { msg, .. } = &as_raa_closing_signed[1] {
1379 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &msg);
1380 } else { panic!("Unexpected message {:?}", as_raa_closing_signed[1]); }
1382 let bs_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
1383 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &bs_closing_signed);
1384 let (_, as_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1385 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &as_2nd_closing_signed.unwrap());
1386 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1387 assert!(node_1_none.is_none());
1389 check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
1390 check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
1394 fn outbound_update_no_early_closing_signed() {
1395 do_outbound_update_no_early_closing_signed(true);
1396 do_outbound_update_no_early_closing_signed(false);
1400 fn batch_funding_failure() {
1401 // Provides test coverage of batch funding failure, which previously deadlocked
1402 let chanmon_cfgs = create_chanmon_cfgs(4);
1403 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1404 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1405 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1407 let temp_chan_id_a = exchange_open_accept_chan(&nodes[0], &nodes[1], 1_000_000, 0);
1408 let temp_chan_id_b = exchange_open_accept_chan(&nodes[0], &nodes[2], 1_000_000, 0);
1410 let events = nodes[0].node.get_and_clear_pending_events();
1411 assert_eq!(events.len(), 2);
1412 // Build a transaction which only has the output for one of the two channels we're trying to
1413 // confirm. Previously this led to a deadlock in channel closure handling.
1414 let mut tx = Transaction { version: Version::TWO, lock_time: LockTime::ZERO, input: Vec::new(), output: Vec::new() };
1415 let mut chans = Vec::new();
1416 for (idx, ev) in events.iter().enumerate() {
1417 if let Event::FundingGenerationReady { temporary_channel_id, counterparty_node_id, output_script, .. } = ev {
1419 tx.output.push(TxOut { value: Amount::from_sat(1_000_000), script_pubkey: output_script.clone() });
1421 chans.push((temporary_channel_id, counterparty_node_id));
1422 } else { panic!(); }
1425 let err = "Error in transaction funding: Misuse error: No output matched the script_pubkey and value in the FundingGenerationReady event".to_string();
1426 let temp_err = "No output matched the script_pubkey and value in the FundingGenerationReady event".to_string();
1427 let post_funding_chan_id_a = ChannelId::v1_from_funding_txid(tx.txid().as_ref(), 0);
1429 ExpectedCloseEvent::from_id_reason(post_funding_chan_id_a, true, ClosureReason::ProcessingError { err: err.clone() }),
1430 ExpectedCloseEvent::from_id_reason(temp_chan_id_b, false, ClosureReason::ProcessingError { err: temp_err }),
1433 nodes[0].node.batch_funding_transaction_generated(&chans, tx).unwrap_err();
1435 let msgs = nodes[0].node.get_and_clear_pending_msg_events();
1436 assert_eq!(msgs.len(), 3);
1437 // We currently spuriously send `FundingCreated` for the first channel and then immediately
1438 // fail both channels, which isn't ideal but should be fine.
1439 assert!(msgs.iter().any(|msg| {
1440 if let MessageSendEvent::HandleError { action: msgs::ErrorAction::SendErrorMessage {
1441 msg: msgs::ErrorMessage { channel_id, .. }, ..
1443 *channel_id == temp_chan_id_b
1446 let funding_created_pos = msgs.iter().position(|msg| {
1447 if let MessageSendEvent::SendFundingCreated { msg: msgs::FundingCreated { temporary_channel_id, .. }, .. } = msg {
1448 assert_eq!(*temporary_channel_id, temp_chan_id_a);
1452 let funded_channel_close_pos = msgs.iter().position(|msg| {
1453 if let MessageSendEvent::HandleError { action: msgs::ErrorAction::SendErrorMessage {
1454 msg: msgs::ErrorMessage { channel_id, .. }, ..
1456 *channel_id == post_funding_chan_id_a
1460 // The error message uses the funded channel_id so must come after the funding_created
1461 assert!(funded_channel_close_pos > funding_created_pos);
1463 check_closed_events(&nodes[0], &close);
1464 assert_eq!(nodes[0].node.list_channels().len(), 0);