1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! Tests of our shutdown and closing_signed negotiation logic as well as some assorted force-close
13 use crate::sign::{EntropySource, SignerProvider};
14 use crate::chain::ChannelMonitorUpdateStatus;
15 use crate::chain::transaction::OutPoint;
16 use crate::events::{Event, MessageSendEvent, HTLCDestination, MessageSendEventsProvider, ClosureReason};
17 use crate::ln::channelmanager::{self, PaymentSendFailure, PaymentId, RecipientOnionFields, Retry, ChannelShutdownState, ChannelDetails};
18 use crate::routing::router::{PaymentParameters, get_route, RouteParameters};
20 use crate::ln::types::ChannelId;
21 use crate::ln::msgs::{ChannelMessageHandler, ErrorAction};
22 use crate::ln::onion_utils::INVALID_ONION_BLINDING;
23 use crate::ln::script::ShutdownScript;
24 use crate::util::test_utils;
25 use crate::util::test_utils::OnGetShutdownScriptpubkey;
26 use crate::util::errors::APIError;
27 use crate::util::config::UserConfig;
28 use crate::util::string::UntrustedString;
29 use crate::prelude::*;
31 use bitcoin::{Transaction, TxOut};
32 use bitcoin::blockdata::locktime::absolute::LockTime;
33 use bitcoin::blockdata::script::Builder;
34 use bitcoin::blockdata::opcodes;
35 use bitcoin::network::constants::Network;
36 use bitcoin::address::{WitnessProgram, WitnessVersion};
38 use crate::ln::functional_test_utils::*;
41 fn pre_funding_lock_shutdown_test() {
42 // Test sending a shutdown prior to channel_ready after funding generation
43 let chanmon_cfgs = create_chanmon_cfgs(2);
44 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
45 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
46 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
47 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0);
48 mine_transaction(&nodes[0], &tx);
49 mine_transaction(&nodes[1], &tx);
51 nodes[0].node.close_channel(&ChannelId::v1_from_funding_outpoint(OutPoint { txid: tx.txid(), index: 0 }), &nodes[1].node.get_our_node_id()).unwrap();
52 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
53 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
54 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
55 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
57 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
58 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
59 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
60 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
61 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
62 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
63 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
64 assert!(node_1_none.is_none());
66 assert!(nodes[0].node.list_channels().is_empty());
67 assert!(nodes[1].node.list_channels().is_empty());
68 check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 8000000);
69 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 8000000);
73 fn expect_channel_shutdown_state() {
74 // Test sending a shutdown prior to channel_ready after funding generation
75 let chanmon_cfgs = create_chanmon_cfgs(2);
76 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
77 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
78 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
79 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
81 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::NotShuttingDown);
83 nodes[0].node.close_channel(&chan_1.2, &nodes[1].node.get_our_node_id()).unwrap();
85 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::ShutdownInitiated);
86 expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::NotShuttingDown);
88 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
89 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
91 // node1 goes into NegotiatingClosingFee since there are no HTLCs in flight, note that it
92 // doesnt mean that node1 has sent/recved its closing signed message
93 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::ShutdownInitiated);
94 expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::NegotiatingClosingFee);
96 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
97 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
99 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::NegotiatingClosingFee);
100 expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::NegotiatingClosingFee);
102 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
103 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
104 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
105 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
106 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
107 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
108 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
109 assert!(node_1_none.is_none());
111 assert!(nodes[0].node.list_channels().is_empty());
112 assert!(nodes[1].node.list_channels().is_empty());
113 check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
114 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
118 fn expect_channel_shutdown_state_with_htlc() {
119 // Test sending a shutdown with outstanding updates pending.
120 let chanmon_cfgs = create_chanmon_cfgs(3);
121 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
122 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
123 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
124 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
125 let _chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
127 let (payment_preimage_0, payment_hash_0, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100_000);
129 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::NotShuttingDown);
130 expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::NotShuttingDown);
132 nodes[0].node.close_channel(&chan_1.2, &nodes[1].node.get_our_node_id()).unwrap();
134 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::ShutdownInitiated);
135 expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::NotShuttingDown);
137 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
138 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
140 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::ShutdownInitiated);
141 expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::ResolvingHTLCs);
143 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
144 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
146 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::ResolvingHTLCs);
147 expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::ResolvingHTLCs);
149 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
150 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
152 // Claim Funds on Node2
153 nodes[2].node.claim_funds(payment_preimage_0);
154 check_added_monitors!(nodes[2], 1);
155 expect_payment_claimed!(nodes[2], payment_hash_0, 100_000);
157 // Fulfil HTLCs on node1 and node0
158 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
159 assert!(updates.update_add_htlcs.is_empty());
160 assert!(updates.update_fail_htlcs.is_empty());
161 assert!(updates.update_fail_malformed_htlcs.is_empty());
162 assert!(updates.update_fee.is_none());
163 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
164 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
165 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), false, false);
166 check_added_monitors!(nodes[1], 1);
167 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
168 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
170 // Still in "resolvingHTLCs" on chan1 after htlc removed on chan2
171 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::ResolvingHTLCs);
172 expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::ResolvingHTLCs);
174 assert!(updates_2.update_add_htlcs.is_empty());
175 assert!(updates_2.update_fail_htlcs.is_empty());
176 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
177 assert!(updates_2.update_fee.is_none());
178 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
179 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
180 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
181 expect_payment_sent!(nodes[0], payment_preimage_0);
183 // all htlcs removed, chan1 advances to NegotiatingClosingFee
184 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::NegotiatingClosingFee);
185 expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::NegotiatingClosingFee);
187 // ClosingSignNegotion process
188 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
189 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
190 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
191 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
192 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
193 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
194 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
195 assert!(node_1_none.is_none());
196 check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
197 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
199 // Shutdown basically removes the channelDetails, testing of shutdowncomplete state unnecessary
200 assert!(nodes[0].node.list_channels().is_empty());
204 fn test_lnd_bug_6039() {
205 // LND sends a nonsense error message any time it gets a shutdown if there are still HTLCs
206 // pending. We currently swallow that error to work around LND's bug #6039. This test emulates
207 // the LND nonsense and ensures we at least kinda handle it.
208 let chanmon_cfgs = create_chanmon_cfgs(2);
209 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
210 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
211 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
212 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
214 let (payment_preimage, ..) = route_payment(&nodes[0], &[&nodes[1]], 100_000);
216 nodes[0].node.close_channel(&chan.2, &nodes[1].node.get_our_node_id()).unwrap();
217 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
218 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
220 // Generate an lnd-like error message and check that we respond by simply screaming louder to
221 // see if LND will accept our protocol compliance.
222 let err_msg = msgs::ErrorMessage { channel_id: chan.2, data: "link failed to shutdown".to_string() };
223 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &err_msg);
224 let node_a_responses = nodes[0].node.get_and_clear_pending_msg_events();
225 assert_eq!(node_a_responses[0], MessageSendEvent::SendShutdown {
226 node_id: nodes[1].node.get_our_node_id(),
227 msg: node_0_shutdown,
229 if let MessageSendEvent::HandleError { action: msgs::ErrorAction::SendWarningMessage { .. }, .. }
230 = node_a_responses[1] {} else { panic!(); }
232 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
234 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
235 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
237 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
239 // Assume that LND will eventually respond to our Shutdown if we clear all the remaining HTLCs
240 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
242 // ClosingSignNegotion process
243 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
244 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
245 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
246 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
247 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
248 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
249 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
250 assert!(node_1_none.is_none());
251 check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
252 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
254 // Shutdown basically removes the channelDetails, testing of shutdowncomplete state unnecessary
255 assert!(nodes[0].node.list_channels().is_empty());
259 fn shutdown_on_unfunded_channel() {
260 // Test receiving a shutdown prior to funding generation
261 let chanmon_cfgs = create_chanmon_cfgs(2);
262 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
263 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
264 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
266 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1_000_000, 100_000, 0, None, None).unwrap();
267 let open_chan = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
269 // Create a dummy P2WPKH script
270 let script = Builder::new().push_int(0)
271 .push_slice(&[0; 20])
274 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &msgs::Shutdown {
275 channel_id: open_chan.common_fields.temporary_channel_id, scriptpubkey: script,
277 check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyCoopClosedUnfundedChannel, [nodes[1].node.get_our_node_id()], 1_000_000);
281 fn close_on_unfunded_channel() {
282 // Test the user asking us to close prior to funding generation
283 let chanmon_cfgs = create_chanmon_cfgs(2);
284 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
285 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
286 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
288 let chan_id = nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1_000_000, 100_000, 0, None, None).unwrap();
289 let _open_chan = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
291 nodes[0].node.close_channel(&chan_id, &nodes[1].node.get_our_node_id()).unwrap();
292 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed, [nodes[1].node.get_our_node_id()], 1_000_000);
296 fn expect_channel_shutdown_state_with_force_closure() {
297 // Test sending a shutdown prior to channel_ready after funding generation
298 let chanmon_cfgs = create_chanmon_cfgs(2);
299 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
300 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
301 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
302 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
304 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::NotShuttingDown);
305 expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::NotShuttingDown);
307 nodes[1].node.force_close_broadcasting_latest_txn(&chan_1.2, &nodes[0].node.get_our_node_id()).unwrap();
308 check_closed_broadcast!(nodes[1], true);
309 check_added_monitors!(nodes[1], 1);
311 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::NotShuttingDown);
312 assert!(nodes[1].node.list_channels().is_empty());
314 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
315 assert_eq!(node_txn.len(), 1);
316 check_spends!(node_txn[0], chan_1.3);
317 mine_transaction(&nodes[0], &node_txn[0]);
318 check_added_monitors!(nodes[0], 1);
320 assert!(nodes[0].node.list_channels().is_empty());
321 assert!(nodes[1].node.list_channels().is_empty());
322 check_closed_broadcast!(nodes[0], true);
323 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed, [nodes[1].node.get_our_node_id()], 100000);
324 check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed, [nodes[0].node.get_our_node_id()], 100000);
328 fn updates_shutdown_wait() {
329 // Test sending a shutdown with outstanding updates pending
330 let chanmon_cfgs = create_chanmon_cfgs(3);
331 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
332 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
333 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
334 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
335 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
336 let logger = test_utils::TestLogger::new();
337 let scorer = test_utils::TestScorer::new();
338 let keys_manager = test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
339 let random_seed_bytes = keys_manager.get_secure_random_bytes();
341 let (payment_preimage_0, payment_hash_0, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100_000);
343 nodes[0].node.close_channel(&chan_1.2, &nodes[1].node.get_our_node_id()).unwrap();
344 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
345 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
346 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
347 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
349 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
350 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
352 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
354 let payment_params_1 = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id(), TEST_FINAL_CLTV)
355 .with_bolt11_features(nodes[1].node.bolt11_invoice_features()).unwrap();
356 let route_params = RouteParameters::from_payment_params_and_value(payment_params_1, 100_000);
357 let route_1 = get_route(&nodes[0].node.get_our_node_id(), &route_params,
358 &nodes[0].network_graph.read_only(), None, &logger, &scorer, &Default::default(), &random_seed_bytes).unwrap();
359 let payment_params_2 = PaymentParameters::from_node_id(nodes[0].node.get_our_node_id(), TEST_FINAL_CLTV)
360 .with_bolt11_features(nodes[0].node.bolt11_invoice_features()).unwrap();
361 let route_params = RouteParameters::from_payment_params_and_value(payment_params_2, 100_000);
362 let route_2 = get_route(&nodes[1].node.get_our_node_id(), &route_params,
363 &nodes[1].network_graph.read_only(), None, &logger, &scorer, &Default::default(), &random_seed_bytes).unwrap();
364 unwrap_send_err!(nodes[0].node.send_payment_with_route(&route_1, payment_hash,
365 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)
366 ), true, APIError::ChannelUnavailable {..}, {});
367 unwrap_send_err!(nodes[1].node.send_payment_with_route(&route_2, payment_hash,
368 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)
369 ), true, APIError::ChannelUnavailable {..}, {});
371 nodes[2].node.claim_funds(payment_preimage_0);
372 check_added_monitors!(nodes[2], 1);
373 expect_payment_claimed!(nodes[2], payment_hash_0, 100_000);
375 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
376 assert!(updates.update_add_htlcs.is_empty());
377 assert!(updates.update_fail_htlcs.is_empty());
378 assert!(updates.update_fail_malformed_htlcs.is_empty());
379 assert!(updates.update_fee.is_none());
380 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
381 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
382 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), false, false);
383 check_added_monitors!(nodes[1], 1);
384 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
385 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
387 assert!(updates_2.update_add_htlcs.is_empty());
388 assert!(updates_2.update_fail_htlcs.is_empty());
389 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
390 assert!(updates_2.update_fee.is_none());
391 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
392 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
393 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
394 expect_payment_sent!(nodes[0], payment_preimage_0);
396 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
397 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
398 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
399 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
400 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
401 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
402 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
403 assert!(node_1_none.is_none());
404 check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
405 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
407 assert!(nodes[0].node.list_channels().is_empty());
409 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
410 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
411 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
412 assert!(nodes[1].node.list_channels().is_empty());
413 assert!(nodes[2].node.list_channels().is_empty());
414 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[2].node.get_our_node_id()], 100000);
415 check_closed_event!(nodes[2], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
419 fn htlc_fail_async_shutdown() {
420 do_htlc_fail_async_shutdown(true);
421 do_htlc_fail_async_shutdown(false);
424 fn do_htlc_fail_async_shutdown(blinded_recipient: bool) {
425 // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
426 let chanmon_cfgs = create_chanmon_cfgs(3);
427 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
428 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
429 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
430 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
431 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
433 let amt_msat = 100000;
434 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash(&nodes[2], Some(amt_msat), None);
435 let route_params = if blinded_recipient {
436 crate::ln::blinded_payment_tests::get_blinded_route_parameters(
437 amt_msat, our_payment_secret, 1, 100000000,
438 nodes.iter().skip(1).map(|n| n.node.get_our_node_id()).collect(), &[&chan_2.0.contents],
439 &chanmon_cfgs[2].keys_manager)
441 RouteParameters::from_payment_params_and_value(
442 PaymentParameters::from_node_id(nodes[2].node.get_our_node_id(), TEST_FINAL_CLTV), amt_msat)
444 nodes[0].node.send_payment(our_payment_hash,
445 RecipientOnionFields::secret_only(our_payment_secret),
446 PaymentId(our_payment_hash.0), route_params, Retry::Attempts(0)).unwrap();
447 check_added_monitors!(nodes[0], 1);
448 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
449 assert_eq!(updates.update_add_htlcs.len(), 1);
450 assert!(updates.update_fulfill_htlcs.is_empty());
451 assert!(updates.update_fail_htlcs.is_empty());
452 assert!(updates.update_fail_malformed_htlcs.is_empty());
453 assert!(updates.update_fee.is_none());
455 nodes[1].node.close_channel(&chan_1.2, &nodes[0].node.get_our_node_id()).unwrap();
456 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
457 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
458 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
460 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
461 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
462 check_added_monitors!(nodes[1], 1);
463 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
464 commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false, false);
466 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
467 assert!(updates_2.update_add_htlcs.is_empty());
468 assert!(updates_2.update_fulfill_htlcs.is_empty());
469 assert_eq!(updates_2.update_fail_htlcs.len(), 1);
470 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
471 assert!(updates_2.update_fee.is_none());
473 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]);
474 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
476 if blinded_recipient {
477 expect_payment_failed_conditions(&nodes[0], our_payment_hash, false,
478 PaymentFailedConditions::new().expected_htlc_error_data(INVALID_ONION_BLINDING, &[0; 32]));
480 expect_payment_failed_with_update!(nodes[0], our_payment_hash, false, chan_2.0.contents.short_channel_id, true);
483 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
484 assert_eq!(msg_events.len(), 1);
485 let node_0_closing_signed = match msg_events[0] {
486 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
487 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
490 _ => panic!("Unexpected event"),
493 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
494 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
495 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
496 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
497 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
498 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
499 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
500 assert!(node_1_none.is_none());
502 assert!(nodes[0].node.list_channels().is_empty());
504 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
505 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
506 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
507 assert!(nodes[1].node.list_channels().is_empty());
508 assert!(nodes[2].node.list_channels().is_empty());
509 check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
510 let event1 = ExpectedCloseEvent {
511 channel_capacity_sats: Some(100000),
513 counterparty_node_id: Some(nodes[0].node.get_our_node_id()),
514 discard_funding: false,
515 reason: Some(ClosureReason::LocallyInitiatedCooperativeClosure),
516 channel_funding_txo: None,
517 user_channel_id: None,
519 let event2 = ExpectedCloseEvent {
520 channel_capacity_sats: Some(100000),
522 counterparty_node_id: Some(nodes[2].node.get_our_node_id()),
523 discard_funding: false,
524 reason: Some(ClosureReason::CounterpartyInitiatedCooperativeClosure),
525 channel_funding_txo: None,
526 user_channel_id: None,
528 check_closed_events(&nodes[1], &[event1, event2]);
529 check_closed_event!(nodes[2], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
532 fn do_test_shutdown_rebroadcast(recv_count: u8) {
533 // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
534 // messages delivered prior to disconnect
535 let chanmon_cfgs = create_chanmon_cfgs(3);
536 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
537 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
538 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
539 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
540 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
542 let (payment_preimage, payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100_000);
544 nodes[1].node.close_channel(&chan_1.2, &nodes[0].node.get_our_node_id()).unwrap();
545 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
547 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
548 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
550 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
554 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
555 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
557 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
558 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
560 let node_0_reestablish = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
561 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
562 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
564 let node_1_reestablish = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
566 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish);
567 let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
568 assert!(node_1_shutdown == node_1_2nd_shutdown);
570 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish);
571 let node_0_2nd_shutdown = if recv_count > 0 {
572 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
573 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
576 let node_0_chan_update = get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
577 assert_eq!(node_0_chan_update.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
578 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
579 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
581 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_2nd_shutdown);
583 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
584 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
586 nodes[2].node.claim_funds(payment_preimage);
587 check_added_monitors!(nodes[2], 1);
588 expect_payment_claimed!(nodes[2], payment_hash, 100_000);
590 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
591 assert!(updates.update_add_htlcs.is_empty());
592 assert!(updates.update_fail_htlcs.is_empty());
593 assert!(updates.update_fail_malformed_htlcs.is_empty());
594 assert!(updates.update_fee.is_none());
595 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
596 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
597 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), false, false);
598 check_added_monitors!(nodes[1], 1);
599 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
600 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
602 assert!(updates_2.update_add_htlcs.is_empty());
603 assert!(updates_2.update_fail_htlcs.is_empty());
604 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
605 assert!(updates_2.update_fee.is_none());
606 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
607 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
608 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
609 expect_payment_sent!(nodes[0], payment_preimage);
611 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
613 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
614 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
615 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
616 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
617 assert!(node_0_2nd_closing_signed.is_some());
620 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
621 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
623 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
624 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
626 let node_1_2nd_reestablish = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
627 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
628 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
631 // If all closing_signeds weren't delivered we can just resume where we left off...
632 let node_0_2nd_reestablish = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
634 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
635 let node_0_msgs = nodes[0].node.get_and_clear_pending_msg_events();
636 assert_eq!(node_0_msgs.len(), 2);
637 let node_0_2nd_closing_signed = match node_0_msgs[1] {
638 MessageSendEvent::SendClosingSigned { ref msg, .. } => {
639 assert_eq!(node_0_closing_signed, *msg);
645 let node_0_3rd_shutdown = match node_0_msgs[0] {
646 MessageSendEvent::SendShutdown { ref msg, .. } => {
647 assert_eq!(node_0_2nd_shutdown, *msg);
652 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
654 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
655 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
656 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
658 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_3rd_shutdown);
659 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
661 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_3rd_shutdown);
663 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed);
664 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
665 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
666 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
667 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
668 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
669 assert!(node_1_none.is_none());
670 check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
672 // If one node, however, received + responded with an identical closing_signed we end
673 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
674 // There isn't really anything better we can do simply, but in the future we might
675 // explore storing a set of recently-closed channels that got disconnected during
676 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
677 // give our counterparty enough time to (potentially) broadcast a cooperative closing
679 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
681 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
682 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
683 assert_eq!(msg_events.len(), 2);
684 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[1] {
686 &ErrorAction::SendErrorMessage { ref msg } => {
687 nodes[1].node.handle_error(&nodes[0].node.get_our_node_id(), &msg);
688 assert_eq!(msg.channel_id, chan_1.2);
690 _ => panic!("Unexpected event!"),
692 } else { panic!("Needed SendErrorMessage close"); }
694 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
695 // checks it, but in this case nodes[1] didn't ever get a chance to receive a
696 // closing_signed so we do it ourselves
697 check_closed_broadcast!(nodes[1], false);
698 check_added_monitors!(nodes[1], 1);
699 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())) }
700 , [nodes[0].node.get_our_node_id()], 100000);
703 assert!(nodes[0].node.list_channels().is_empty());
705 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
706 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
707 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
708 assert!(nodes[1].node.list_channels().is_empty());
709 assert!(nodes[2].node.list_channels().is_empty());
710 check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
711 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[2].node.get_our_node_id()], 100000);
712 check_closed_event!(nodes[2], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
716 fn test_shutdown_rebroadcast() {
717 do_test_shutdown_rebroadcast(0);
718 do_test_shutdown_rebroadcast(1);
719 do_test_shutdown_rebroadcast(2);
723 fn test_upfront_shutdown_script() {
724 // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
725 // enforce it at shutdown message
727 let mut config = UserConfig::default();
728 config.channel_handshake_config.announced_channel = true;
729 config.channel_handshake_limits.force_announced_channel_preference = false;
730 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
731 let user_cfgs = [None, Some(config), None];
732 let chanmon_cfgs = create_chanmon_cfgs(3);
733 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
734 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
735 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
737 // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
738 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000);
739 nodes[0].node.close_channel(&chan.2, &nodes[2].node.get_our_node_id()).unwrap();
740 let node_0_orig_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
741 let mut node_0_shutdown = node_0_orig_shutdown.clone();
742 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
743 // Test we enforce upfront_scriptpbukey if by providing a different one at closing that we warn
744 // the peer and ignore the message.
745 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
746 assert!(regex::Regex::new(r"Got shutdown request with a scriptpubkey \([A-Fa-f0-9]+\) which did not match their previous scriptpubkey.")
747 .unwrap().is_match(&check_warn_msg!(nodes[2], nodes[0].node.get_our_node_id(), chan.2)));
748 // This allows nodes[2] to retry the shutdown message, which should get a response:
749 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_orig_shutdown);
750 get_event_msg!(nodes[2], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
752 // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
753 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000);
754 nodes[0].node.close_channel(&chan.2, &nodes[2].node.get_our_node_id()).unwrap();
755 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
756 // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
757 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
758 let events = nodes[2].node.get_and_clear_pending_msg_events();
759 assert_eq!(events.len(), 1);
761 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
762 _ => panic!("Unexpected event"),
765 // We test that if case of peer non-signaling we don't enforce committed script at channel opening
766 *nodes[0].override_init_features.borrow_mut() = Some(nodes[0].node.init_features().clear_upfront_shutdown_script());
767 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000);
768 nodes[0].node.close_channel(&chan.2, &nodes[1].node.get_our_node_id()).unwrap();
769 let node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
770 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_1_shutdown);
771 check_added_monitors!(nodes[1], 1);
772 let events = nodes[1].node.get_and_clear_pending_msg_events();
773 assert_eq!(events.len(), 1);
775 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
776 _ => panic!("Unexpected event"),
779 // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
780 // channel smoothly, opt-out is from channel initiator here
781 *nodes[0].override_init_features.borrow_mut() = None;
782 let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000);
783 nodes[1].node.close_channel(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
784 check_added_monitors!(nodes[1], 1);
785 let node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
786 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
787 let events = nodes[0].node.get_and_clear_pending_msg_events();
788 assert_eq!(events.len(), 1);
790 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
791 _ => panic!("Unexpected event"),
794 //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
795 //// channel smoothly
796 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000);
797 nodes[1].node.close_channel(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
798 check_added_monitors!(nodes[1], 1);
799 let node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
800 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
801 let events = nodes[0].node.get_and_clear_pending_msg_events();
802 assert_eq!(events.len(), 2);
804 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
805 _ => panic!("Unexpected event"),
808 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
809 _ => panic!("Unexpected event"),
814 fn test_unsupported_anysegwit_upfront_shutdown_script() {
815 let chanmon_cfgs = create_chanmon_cfgs(2);
816 let mut node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
817 // Clear shutdown_anysegwit on initiator
818 *node_cfgs[0].override_init_features.borrow_mut() = Some(channelmanager::provided_init_features(&test_default_channel_config()).clear_shutdown_anysegwit());
819 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
820 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
822 // Use a non-v0 segwit script supported by option_shutdown_anysegwit
823 let anysegwit_shutdown_script = Builder::new()
825 .push_slice(&[0, 40])
828 // Check script when handling an open_channel message
829 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None, None).unwrap();
830 let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
831 open_channel.common_fields.shutdown_scriptpubkey = Some(anysegwit_shutdown_script.clone());
832 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel);
834 let events = nodes[1].node.get_and_clear_pending_msg_events();
835 assert_eq!(events.len(), 1);
837 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
838 assert_eq!(node_id, nodes[0].node.get_our_node_id());
839 assert_eq!(msg.data, "Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: OP_PUSHNUM_16 OP_PUSHBYTES_2 0028");
841 _ => panic!("Unexpected event"),
844 let chanmon_cfgs = create_chanmon_cfgs(2);
845 let mut node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
846 // Clear shutdown_anysegwit on responder
847 *node_cfgs[1].override_init_features.borrow_mut() = Some(channelmanager::provided_init_features(&test_default_channel_config()).clear_shutdown_anysegwit());
848 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
849 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
851 // Check script when handling an accept_channel message
852 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None, None).unwrap();
853 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
854 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel);
855 let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
856 accept_channel.common_fields.shutdown_scriptpubkey = Some(anysegwit_shutdown_script.clone());
857 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel);
859 let events = nodes[0].node.get_and_clear_pending_msg_events();
860 assert_eq!(events.len(), 1);
862 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
863 assert_eq!(node_id, nodes[1].node.get_our_node_id());
864 assert_eq!(msg.data, "Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: OP_PUSHNUM_16 OP_PUSHBYTES_2 0028");
866 _ => panic!("Unexpected event"),
868 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() }
869 , [nodes[1].node.get_our_node_id()], 100000);
873 fn test_invalid_upfront_shutdown_script() {
874 let chanmon_cfgs = create_chanmon_cfgs(2);
875 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
876 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
877 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
879 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None, None).unwrap();
881 // Use a segwit v0 script with an unsupported witness program
882 let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
883 open_channel.common_fields.shutdown_scriptpubkey = Some(Builder::new().push_int(0)
886 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel);
888 let events = nodes[1].node.get_and_clear_pending_msg_events();
889 assert_eq!(events.len(), 1);
891 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
892 assert_eq!(node_id, nodes[0].node.get_our_node_id());
893 assert_eq!(msg.data, "Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: OP_0 OP_PUSHBYTES_2 0000");
895 _ => panic!("Unexpected event"),
900 fn test_segwit_v0_shutdown_script() {
901 let mut config = UserConfig::default();
902 config.channel_handshake_config.announced_channel = true;
903 config.channel_handshake_limits.force_announced_channel_preference = false;
904 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
905 let user_cfgs = [None, Some(config), None];
906 let chanmon_cfgs = create_chanmon_cfgs(3);
907 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
908 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
909 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
911 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
912 nodes[1].node.close_channel(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
913 check_added_monitors!(nodes[1], 1);
915 // Use a segwit v0 script supported even without option_shutdown_anysegwit
916 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
917 node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
918 .push_slice(&[0; 20])
920 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
922 let events = nodes[0].node.get_and_clear_pending_msg_events();
923 assert_eq!(events.len(), 2);
925 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
926 _ => panic!("Unexpected event"),
929 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
930 _ => panic!("Unexpected event"),
935 fn test_anysegwit_shutdown_script() {
936 let mut config = UserConfig::default();
937 config.channel_handshake_config.announced_channel = true;
938 config.channel_handshake_limits.force_announced_channel_preference = false;
939 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
940 let user_cfgs = [None, Some(config), None];
941 let chanmon_cfgs = create_chanmon_cfgs(3);
942 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
943 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
944 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
946 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
947 nodes[1].node.close_channel(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
948 check_added_monitors!(nodes[1], 1);
950 // Use a non-v0 segwit script supported by option_shutdown_anysegwit
951 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
952 node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
955 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
957 let events = nodes[0].node.get_and_clear_pending_msg_events();
958 assert_eq!(events.len(), 2);
960 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
961 _ => panic!("Unexpected event"),
964 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
965 _ => panic!("Unexpected event"),
970 fn test_unsupported_anysegwit_shutdown_script() {
971 let mut config = UserConfig::default();
972 config.channel_handshake_config.announced_channel = true;
973 config.channel_handshake_limits.force_announced_channel_preference = false;
974 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
975 let user_cfgs = [None, Some(config), None];
976 let chanmon_cfgs = create_chanmon_cfgs(3);
977 let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
978 *node_cfgs[0].override_init_features.borrow_mut() = Some(channelmanager::provided_init_features(&config).clear_shutdown_anysegwit());
979 *node_cfgs[1].override_init_features.borrow_mut() = Some(channelmanager::provided_init_features(&config).clear_shutdown_anysegwit());
980 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
981 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
983 // Check that using an unsupported shutdown script fails and a supported one succeeds.
984 let supported_shutdown_script = chanmon_cfgs[1].keys_manager.get_shutdown_scriptpubkey().unwrap();
985 let unsupported_witness_program = WitnessProgram::new(WitnessVersion::V16, &[0, 40]).unwrap();
986 let unsupported_shutdown_script =
987 ShutdownScript::new_witness_program(&unsupported_witness_program).unwrap();
988 chanmon_cfgs[1].keys_manager
989 .expect(OnGetShutdownScriptpubkey { returns: unsupported_shutdown_script.clone() })
990 .expect(OnGetShutdownScriptpubkey { returns: supported_shutdown_script });
992 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
993 match nodes[1].node.close_channel(&chan.2, &nodes[0].node.get_our_node_id()) {
994 Err(APIError::IncompatibleShutdownScript { script }) => {
995 assert_eq!(script.into_inner(), unsupported_shutdown_script.clone().into_inner());
997 Err(e) => panic!("Unexpected error: {:?}", e),
998 Ok(_) => panic!("Expected error"),
1000 nodes[1].node.close_channel(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
1001 check_added_monitors!(nodes[1], 1);
1003 // Use a non-v0 segwit script unsupported without option_shutdown_anysegwit
1004 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1005 node_0_shutdown.scriptpubkey = unsupported_shutdown_script.into_inner();
1006 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
1008 assert_eq!(&check_warn_msg!(nodes[0], nodes[1].node.get_our_node_id(), chan.2),
1009 "Got a nonstandard scriptpubkey (60020028) from remote peer");
1013 fn test_invalid_shutdown_script() {
1014 let mut config = UserConfig::default();
1015 config.channel_handshake_config.announced_channel = true;
1016 config.channel_handshake_limits.force_announced_channel_preference = false;
1017 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
1018 let user_cfgs = [None, Some(config), None];
1019 let chanmon_cfgs = create_chanmon_cfgs(3);
1020 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1021 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
1022 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1024 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
1025 nodes[1].node.close_channel(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
1026 check_added_monitors!(nodes[1], 1);
1028 // Use a segwit v0 script with an unsupported witness program
1029 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1030 node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
1031 .push_slice(&[0, 0])
1033 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
1035 assert_eq!(&check_warn_msg!(nodes[0], nodes[1].node.get_our_node_id(), chan.2),
1036 "Got a nonstandard scriptpubkey (00020000) from remote peer");
1040 fn test_user_shutdown_script() {
1041 let mut config = test_default_channel_config();
1042 config.channel_handshake_config.announced_channel = true;
1043 config.channel_handshake_limits.force_announced_channel_preference = false;
1044 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
1045 let user_cfgs = [None, Some(config), None];
1046 let chanmon_cfgs = create_chanmon_cfgs(3);
1047 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1048 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
1049 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1051 // Segwit v0 script of the form OP_0 <20-byte hash>
1052 let script = Builder::new().push_int(0)
1053 .push_slice(&[0; 20])
1056 let shutdown_script = ShutdownScript::try_from(script.clone()).unwrap();
1058 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
1059 nodes[1].node.close_channel_with_feerate_and_script(&chan.2, &nodes[0].node.get_our_node_id(), None, Some(shutdown_script)).unwrap();
1060 check_added_monitors!(nodes[1], 1);
1062 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1064 assert_eq!(node_0_shutdown.scriptpubkey, script);
1068 fn test_already_set_user_shutdown_script() {
1069 let mut config = test_default_channel_config();
1070 config.channel_handshake_config.announced_channel = true;
1071 config.channel_handshake_limits.force_announced_channel_preference = false;
1072 let user_cfgs = [None, Some(config), None];
1073 let chanmon_cfgs = create_chanmon_cfgs(3);
1074 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1075 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
1076 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1078 // Segwit v0 script of the form OP_0 <20-byte hash>
1079 let script = Builder::new().push_int(0)
1080 .push_slice(&[0; 20])
1083 let shutdown_script = ShutdownScript::try_from(script).unwrap();
1085 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
1086 let result = nodes[1].node.close_channel_with_feerate_and_script(&chan.2, &nodes[0].node.get_our_node_id(), None, Some(shutdown_script));
1088 assert_eq!(result, Err(APIError::APIMisuseError { err: "Cannot override shutdown script for a channel with one already set".to_string() }));
1091 #[derive(PartialEq)]
1098 fn do_test_closing_signed_reinit_timeout(timeout_step: TimeoutStep) {
1099 // The range-based closing signed negotiation allows the funder to restart the process with a
1100 // new range if the previous range did not overlap. This allows implementations to request user
1101 // intervention allowing users to enter a new fee range. We do not implement the sending side
1102 // of this, instead opting to allow users to enter an explicit "willing to pay up to X to avoid
1103 // force-closing" value and relying on that instead.
1105 // Here we run test the fundee side of that restart mechanism, implementing the funder side of
1107 let chanmon_cfgs = create_chanmon_cfgs(2);
1108 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1109 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1110 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1111 let chan_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
1113 send_payment(&nodes[0], &[&nodes[1]], 8_000_000);
1115 nodes[0].node.close_channel(&chan_id, &nodes[1].node.get_our_node_id()).unwrap();
1116 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1117 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
1118 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1119 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
1122 // Now we set nodes[1] to require a relatively high feerate for closing. This should result
1123 // in it rejecting nodes[0]'s initial closing_signed, giving nodes[0] a chance to try
1125 let mut feerate_lock = chanmon_cfgs[1].fee_estimator.sat_per_kw.lock().unwrap();
1126 *feerate_lock *= 10;
1129 let mut node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1130 // nodes[0] should use a "reasonable" feerate, well under the 10 sat/vByte that nodes[1] thinks
1131 // is the current prevailing feerate.
1132 assert!(node_0_closing_signed.fee_satoshis <= 500);
1134 if timeout_step != TimeoutStep::AfterShutdown {
1135 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1136 assert!(check_warn_msg!(nodes[1], nodes[0].node.get_our_node_id(), chan_id)
1137 .starts_with("Unable to come to consensus about closing feerate"));
1139 // Now deliver a mutated closing_signed indicating a higher acceptable fee range, which
1140 // nodes[1] should happily accept and respond to.
1141 node_0_closing_signed.fee_range.as_mut().unwrap().max_fee_satoshis *= 10;
1143 let mut node_0_per_peer_lock;
1144 let mut node_0_peer_state_lock;
1145 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;
1147 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1148 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
1149 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
1150 let node_0_2nd_closing_signed = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1151 if timeout_step == TimeoutStep::NoTimeout {
1152 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.1.unwrap());
1153 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
1155 check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
1158 if timeout_step != TimeoutStep::NoTimeout {
1159 assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
1161 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1164 nodes[1].node.timer_tick_occurred();
1165 nodes[1].node.timer_tick_occurred();
1167 let txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1168 assert_eq!(txn.len(), 1);
1169 assert_eq!(txn[0].output.len(), 2);
1171 if timeout_step != TimeoutStep::NoTimeout {
1172 assert!((txn[0].output[0].script_pubkey.is_v0_p2wpkh() &&
1173 txn[0].output[1].script_pubkey.is_v0_p2wsh()) ||
1174 (txn[0].output[1].script_pubkey.is_v0_p2wpkh() &&
1175 txn[0].output[0].script_pubkey.is_v0_p2wsh()));
1176 check_closed_broadcast!(nodes[1], true);
1177 check_added_monitors!(nodes[1], 1);
1178 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "closing_signed negotiation failed to finish within two timer ticks".to_string() }
1179 , [nodes[0].node.get_our_node_id()], 100000);
1181 assert!(txn[0].output[0].script_pubkey.is_v0_p2wpkh());
1182 assert!(txn[0].output[1].script_pubkey.is_v0_p2wpkh());
1184 let events = nodes[1].node.get_and_clear_pending_msg_events();
1185 assert_eq!(events.len(), 1);
1187 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1188 assert_eq!(msg.contents.flags & 2, 2);
1190 _ => panic!("Unexpected event"),
1196 fn test_closing_signed_reinit_timeout() {
1197 do_test_closing_signed_reinit_timeout(TimeoutStep::AfterShutdown);
1198 do_test_closing_signed_reinit_timeout(TimeoutStep::AfterClosingSigned);
1199 do_test_closing_signed_reinit_timeout(TimeoutStep::NoTimeout);
1202 fn do_simple_legacy_shutdown_test(high_initiator_fee: bool) {
1203 // A simpe test of the legacy shutdown fee negotiation logic.
1204 let chanmon_cfgs = create_chanmon_cfgs(2);
1205 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1206 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1207 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1209 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
1211 if high_initiator_fee {
1212 // If high_initiator_fee is set, set nodes[0]'s feerate significantly higher. This
1213 // shouldn't impact the flow at all given nodes[1] will happily accept the higher fee.
1214 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
1215 *feerate_lock *= 10;
1218 nodes[0].node.close_channel(&chan.2, &nodes[1].node.get_our_node_id()).unwrap();
1219 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1220 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
1221 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1222 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
1224 let mut node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1225 node_0_closing_signed.fee_range = None;
1226 if high_initiator_fee {
1227 assert!(node_0_closing_signed.fee_satoshis > 500);
1229 assert!(node_0_closing_signed.fee_satoshis < 500);
1232 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1233 let (_, mut node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1234 node_1_closing_signed.as_mut().unwrap().fee_range = None;
1236 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
1237 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1238 assert!(node_0_none.is_none());
1239 check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
1240 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
1244 fn simple_legacy_shutdown_test() {
1245 do_simple_legacy_shutdown_test(false);
1246 do_simple_legacy_shutdown_test(true);
1250 fn simple_target_feerate_shutdown() {
1251 // Simple test of target in `close_channel_with_target_feerate`.
1252 let chanmon_cfgs = create_chanmon_cfgs(2);
1253 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1254 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1255 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1257 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
1258 let chan_id = chan.2;
1260 nodes[0].node.close_channel_with_feerate_and_script(&chan_id, &nodes[1].node.get_our_node_id(), Some(253 * 10), None).unwrap();
1261 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1262 nodes[1].node.close_channel_with_feerate_and_script(&chan_id, &nodes[0].node.get_our_node_id(), Some(253 * 5), None).unwrap();
1263 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1265 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
1266 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
1268 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1269 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1270 let (_, node_1_closing_signed_opt) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1271 let node_1_closing_signed = node_1_closing_signed_opt.unwrap();
1273 // nodes[1] was passed a target which was larger than the current channel feerate, which it
1274 // should ignore in favor of the channel fee, as there is no use demanding a minimum higher
1275 // than what will be paid on a force-close transaction. Note that we have to consider rounding,
1276 // so only check that we're within 10 sats.
1277 assert!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis >=
1278 node_1_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis * 10 - 5);
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);
1282 // Further, because nodes[0]'s target fee is larger than the `Normal` fee estimation plus our
1283 // force-closure-avoidance buffer, min should equal max, and the nodes[1]-selected fee should
1284 // be the nodes[0] only available fee.
1285 assert_eq!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis,
1286 node_0_closing_signed.fee_range.as_ref().unwrap().max_fee_satoshis);
1287 assert_eq!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis,
1288 node_0_closing_signed.fee_satoshis);
1289 assert_eq!(node_0_closing_signed.fee_satoshis, node_1_closing_signed.fee_satoshis);
1291 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
1292 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1293 assert!(node_0_none.is_none());
1294 check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
1295 check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
1298 fn do_outbound_update_no_early_closing_signed(use_htlc: bool) {
1299 // Previously, if we have a pending inbound HTLC (or fee update) on a channel which has
1300 // initiated shutdown, we'd send our initial closing_signed immediately after receiving the
1301 // peer's last RAA to remove the HTLC/fee update, but before receiving their final
1302 // commitment_signed for a commitment without the HTLC/with the new fee. This caused at least
1303 // LDK peers to force-close as we initiated closing_signed prior to the channel actually being
1304 // fully empty of pending updates/HTLCs.
1305 let chanmon_cfgs = create_chanmon_cfgs(2);
1306 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1307 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1308 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1310 let chan_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
1312 send_payment(&nodes[0], &[&nodes[1]], 1_000_000);
1313 let payment_hash_opt = if use_htlc {
1314 Some(route_payment(&nodes[1], &[&nodes[0]], 10_000).1)
1320 nodes[0].node.fail_htlc_backwards(&payment_hash_opt.unwrap());
1321 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[0],
1322 [HTLCDestination::FailedPayment { payment_hash: payment_hash_opt.unwrap() }]);
1324 *chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap() *= 10;
1325 nodes[0].node.timer_tick_occurred();
1327 let updates = get_htlc_update_msgs(&nodes[0], &nodes[1].node.get_our_node_id());
1328 check_added_monitors(&nodes[0], 1);
1330 nodes[1].node.close_channel(&chan_id, &nodes[0].node.get_our_node_id()).unwrap();
1331 let node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1332 nodes[0].node.close_channel(&chan_id, &nodes[1].node.get_our_node_id()).unwrap();
1333 let node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1335 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
1336 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_1_shutdown);
1339 nodes[1].node.handle_update_fail_htlc(&nodes[0].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
1341 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &updates.update_fee.unwrap());
1343 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
1344 check_added_monitors(&nodes[1], 1);
1345 let (bs_raa, bs_cs) = get_revoke_commit_msgs(&nodes[1], &nodes[0].node.get_our_node_id());
1347 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1348 check_added_monitors(&nodes[0], 1);
1350 // At this point the Channel on nodes[0] has no record of any HTLCs but the latest
1351 // broadcastable commitment does contain the HTLC (but only the ChannelMonitor knows this).
1352 // Thus, the channel should not yet initiate closing_signed negotiation (but previously did).
1353 assert_eq!(nodes[0].node.get_and_clear_pending_msg_events(), Vec::new());
1355 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1356 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs);
1357 check_added_monitors(&nodes[0], 1);
1358 assert_eq!(nodes[0].node.get_and_clear_pending_msg_events(), Vec::new());
1360 expect_channel_shutdown_state!(nodes[0], chan_id, ChannelShutdownState::ResolvingHTLCs);
1361 assert_eq!(nodes[0].node.get_and_clear_pending_msg_events(), Vec::new());
1362 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_id).unwrap().clone();
1363 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1365 let as_raa_closing_signed = nodes[0].node.get_and_clear_pending_msg_events();
1366 assert_eq!(as_raa_closing_signed.len(), 2);
1368 if let MessageSendEvent::SendRevokeAndACK { msg, .. } = &as_raa_closing_signed[0] {
1369 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &msg);
1370 check_added_monitors(&nodes[1], 1);
1372 expect_payment_failed!(nodes[1], payment_hash_opt.unwrap(), true);
1374 } else { panic!("Unexpected message {:?}", as_raa_closing_signed[0]); }
1376 if let MessageSendEvent::SendClosingSigned { msg, .. } = &as_raa_closing_signed[1] {
1377 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &msg);
1378 } else { panic!("Unexpected message {:?}", as_raa_closing_signed[1]); }
1380 let bs_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
1381 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &bs_closing_signed);
1382 let (_, as_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1383 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &as_2nd_closing_signed.unwrap());
1384 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1385 assert!(node_1_none.is_none());
1387 check_closed_event!(nodes[0], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
1388 check_closed_event!(nodes[1], 1, ClosureReason::LocallyInitiatedCooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
1392 fn outbound_update_no_early_closing_signed() {
1393 do_outbound_update_no_early_closing_signed(true);
1394 do_outbound_update_no_early_closing_signed(false);
1398 fn batch_funding_failure() {
1399 // Provides test coverage of batch funding failure, which previously deadlocked
1400 let chanmon_cfgs = create_chanmon_cfgs(4);
1401 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1402 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1403 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1405 let temp_chan_id_a = exchange_open_accept_chan(&nodes[0], &nodes[1], 1_000_000, 0);
1406 let temp_chan_id_b = exchange_open_accept_chan(&nodes[0], &nodes[2], 1_000_000, 0);
1408 let events = nodes[0].node.get_and_clear_pending_events();
1409 assert_eq!(events.len(), 2);
1410 // Build a transaction which only has the output for one of the two channels we're trying to
1411 // confirm. Previously this led to a deadlock in channel closure handling.
1412 let mut tx = Transaction { version: 2, lock_time: LockTime::ZERO, input: Vec::new(), output: Vec::new() };
1413 let mut chans = Vec::new();
1414 for (idx, ev) in events.iter().enumerate() {
1415 if let Event::FundingGenerationReady { temporary_channel_id, counterparty_node_id, output_script, .. } = ev {
1417 tx.output.push(TxOut { value: 1_000_000, script_pubkey: output_script.clone() });
1419 chans.push((temporary_channel_id, counterparty_node_id));
1420 } else { panic!(); }
1423 let err = "Error in transaction funding: Misuse error: No output matched the script_pubkey and value in the FundingGenerationReady event".to_string();
1424 let temp_err = "No output matched the script_pubkey and value in the FundingGenerationReady event".to_string();
1425 let post_funding_chan_id_a = ChannelId::v1_from_funding_txid(tx.txid().as_ref(), 0);
1427 ExpectedCloseEvent::from_id_reason(post_funding_chan_id_a, true, ClosureReason::ProcessingError { err: err.clone() }),
1428 ExpectedCloseEvent::from_id_reason(temp_chan_id_b, false, ClosureReason::ProcessingError { err: temp_err }),
1431 nodes[0].node.batch_funding_transaction_generated(&chans, tx).unwrap_err();
1433 let msgs = nodes[0].node.get_and_clear_pending_msg_events();
1434 assert_eq!(msgs.len(), 3);
1435 // We currently spuriously send `FundingCreated` for the first channel and then immediately
1436 // fail both channels, which isn't ideal but should be fine.
1437 assert!(msgs.iter().any(|msg| {
1438 if let MessageSendEvent::HandleError { action: msgs::ErrorAction::SendErrorMessage {
1439 msg: msgs::ErrorMessage { channel_id, .. }, ..
1441 *channel_id == temp_chan_id_b
1444 let funding_created_pos = msgs.iter().position(|msg| {
1445 if let MessageSendEvent::SendFundingCreated { msg: msgs::FundingCreated { temporary_channel_id, .. }, .. } = msg {
1446 assert_eq!(*temporary_channel_id, temp_chan_id_a);
1450 let funded_channel_close_pos = msgs.iter().position(|msg| {
1451 if let MessageSendEvent::HandleError { action: msgs::ErrorAction::SendErrorMessage {
1452 msg: msgs::ErrorMessage { channel_id, .. }, ..
1454 *channel_id == post_funding_chan_id_a
1458 // The error message uses the funded channel_id so must come after the funding_created
1459 assert!(funded_channel_close_pos > funding_created_pos);
1461 check_closed_events(&nodes[0], &close);
1462 assert_eq!(nodes[0].node.list_channels().len(), 0);