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.
12 use crate::sign::{EntropySource, SignerProvider};
13 use crate::chain::ChannelMonitorUpdateStatus;
14 use crate::chain::transaction::OutPoint;
15 use crate::events::{MessageSendEvent, HTLCDestination, MessageSendEventsProvider, ClosureReason};
16 use crate::ln::channelmanager::{self, PaymentSendFailure, PaymentId, RecipientOnionFields, ChannelShutdownState, ChannelDetails};
17 use crate::routing::router::{PaymentParameters, get_route, RouteParameters};
19 use crate::ln::msgs::{ChannelMessageHandler, ErrorAction};
20 use crate::ln::script::ShutdownScript;
21 use crate::util::test_utils;
22 use crate::util::test_utils::OnGetShutdownScriptpubkey;
23 use crate::util::errors::APIError;
24 use crate::util::config::UserConfig;
25 use crate::util::string::UntrustedString;
27 use bitcoin::blockdata::script::Builder;
28 use bitcoin::blockdata::opcodes;
29 use bitcoin::network::constants::Network;
30 use bitcoin::address::{WitnessProgram, WitnessVersion};
34 use core::default::Default;
35 use std::convert::TryFrom;
37 use crate::ln::functional_test_utils::*;
40 fn pre_funding_lock_shutdown_test() {
41 // Test sending a shutdown prior to channel_ready after funding generation
42 let chanmon_cfgs = create_chanmon_cfgs(2);
43 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
44 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
45 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
46 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0);
47 mine_transaction(&nodes[0], &tx);
48 mine_transaction(&nodes[1], &tx);
50 nodes[0].node.close_channel(&OutPoint { txid: tx.txid(), index: 0 }.to_channel_id(), &nodes[1].node.get_our_node_id()).unwrap();
51 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
52 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
53 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
54 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
56 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
57 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
58 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
59 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
60 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
61 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
62 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
63 assert!(node_1_none.is_none());
65 assert!(nodes[0].node.list_channels().is_empty());
66 assert!(nodes[1].node.list_channels().is_empty());
67 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 8000000);
68 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 8000000);
72 fn expect_channel_shutdown_state() {
73 // Test sending a shutdown prior to channel_ready after funding generation
74 let chanmon_cfgs = create_chanmon_cfgs(2);
75 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
76 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
77 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
78 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
80 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::NotShuttingDown);
82 nodes[0].node.close_channel(&chan_1.2, &nodes[1].node.get_our_node_id()).unwrap();
84 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::ShutdownInitiated);
85 expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::NotShuttingDown);
87 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
88 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
90 // node1 goes into NegotiatingClosingFee since there are no HTLCs in flight, note that it
91 // doesnt mean that node1 has sent/recved its closing signed message
92 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::ShutdownInitiated);
93 expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::NegotiatingClosingFee);
95 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
96 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
98 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::NegotiatingClosingFee);
99 expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::NegotiatingClosingFee);
101 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
102 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
103 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
104 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
105 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
106 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
107 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
108 assert!(node_1_none.is_none());
110 assert!(nodes[0].node.list_channels().is_empty());
111 assert!(nodes[1].node.list_channels().is_empty());
112 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
113 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
117 fn expect_channel_shutdown_state_with_htlc() {
118 // Test sending a shutdown with outstanding updates pending.
119 let chanmon_cfgs = create_chanmon_cfgs(3);
120 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
121 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
122 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
123 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
124 let _chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
126 let (payment_preimage_0, payment_hash_0, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100_000);
128 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::NotShuttingDown);
129 expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::NotShuttingDown);
131 nodes[0].node.close_channel(&chan_1.2, &nodes[1].node.get_our_node_id()).unwrap();
133 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::ShutdownInitiated);
134 expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::NotShuttingDown);
136 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
137 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
139 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::ShutdownInitiated);
140 expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::ResolvingHTLCs);
142 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
143 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
145 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::ResolvingHTLCs);
146 expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::ResolvingHTLCs);
148 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
149 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
151 // Claim Funds on Node2
152 nodes[2].node.claim_funds(payment_preimage_0);
153 check_added_monitors!(nodes[2], 1);
154 expect_payment_claimed!(nodes[2], payment_hash_0, 100_000);
156 // Fulfil HTLCs on node1 and node0
157 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
158 assert!(updates.update_add_htlcs.is_empty());
159 assert!(updates.update_fail_htlcs.is_empty());
160 assert!(updates.update_fail_malformed_htlcs.is_empty());
161 assert!(updates.update_fee.is_none());
162 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
163 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
164 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), false, false);
165 check_added_monitors!(nodes[1], 1);
166 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
167 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
169 // Still in "resolvingHTLCs" on chan1 after htlc removed on chan2
170 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::ResolvingHTLCs);
171 expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::ResolvingHTLCs);
173 assert!(updates_2.update_add_htlcs.is_empty());
174 assert!(updates_2.update_fail_htlcs.is_empty());
175 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
176 assert!(updates_2.update_fee.is_none());
177 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
178 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
179 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
180 expect_payment_sent!(nodes[0], payment_preimage_0);
182 // all htlcs removed, chan1 advances to NegotiatingClosingFee
183 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::NegotiatingClosingFee);
184 expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::NegotiatingClosingFee);
186 // ClosingSignNegotion process
187 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
188 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
189 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
190 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
191 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
192 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
193 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
194 assert!(node_1_none.is_none());
195 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
196 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
198 // Shutdown basically removes the channelDetails, testing of shutdowncomplete state unnecessary
199 assert!(nodes[0].node.list_channels().is_empty());
203 fn test_lnd_bug_6039() {
204 // LND sends a nonsense error message any time it gets a shutdown if there are still HTLCs
205 // pending. We currently swallow that error to work around LND's bug #6039. This test emulates
206 // the LND nonsense and ensures we at least kinda handle it.
207 let chanmon_cfgs = create_chanmon_cfgs(2);
208 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
209 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
210 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
211 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
213 let (payment_preimage, ..) = route_payment(&nodes[0], &[&nodes[1]], 100_000);
215 nodes[0].node.close_channel(&chan.2, &nodes[1].node.get_our_node_id()).unwrap();
216 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
217 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
219 // Generate an lnd-like error message and check that we respond by simply screaming louder to
220 // see if LND will accept our protocol compliance.
221 let err_msg = msgs::ErrorMessage { channel_id: chan.2, data: "link failed to shutdown".to_string() };
222 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &err_msg);
223 let node_a_responses = nodes[0].node.get_and_clear_pending_msg_events();
224 assert_eq!(node_a_responses[0], MessageSendEvent::SendShutdown {
225 node_id: nodes[1].node.get_our_node_id(),
226 msg: node_0_shutdown,
228 if let MessageSendEvent::HandleError { action: msgs::ErrorAction::SendWarningMessage { .. }, .. }
229 = node_a_responses[1] {} else { panic!(); }
231 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
233 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
234 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
236 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
238 // Assume that LND will eventually respond to our Shutdown if we clear all the remaining HTLCs
239 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
241 // ClosingSignNegotion process
242 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
243 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
244 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
245 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
246 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
247 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
248 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
249 assert!(node_1_none.is_none());
250 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
251 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
253 // Shutdown basically removes the channelDetails, testing of shutdowncomplete state unnecessary
254 assert!(nodes[0].node.list_channels().is_empty());
258 fn shutdown_on_unfunded_channel() {
259 // Test receiving a shutdown prior to funding generation
260 let chanmon_cfgs = create_chanmon_cfgs(2);
261 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
262 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
263 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
265 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1_000_000, 100_000, 0, None, None).unwrap();
266 let open_chan = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
268 // Create a dummy P2WPKH script
269 let script = Builder::new().push_int(0)
270 .push_slice(&[0; 20])
273 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &msgs::Shutdown {
274 channel_id: open_chan.temporary_channel_id, scriptpubkey: script,
276 check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyCoopClosedUnfundedChannel, [nodes[1].node.get_our_node_id()], 1_000_000);
280 fn expect_channel_shutdown_state_with_force_closure() {
281 // Test sending a shutdown prior to channel_ready after funding generation
282 let chanmon_cfgs = create_chanmon_cfgs(2);
283 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
284 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
285 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
286 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
288 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::NotShuttingDown);
289 expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::NotShuttingDown);
291 nodes[1].node.force_close_broadcasting_latest_txn(&chan_1.2, &nodes[0].node.get_our_node_id()).unwrap();
292 check_closed_broadcast!(nodes[1], true);
293 check_added_monitors!(nodes[1], 1);
295 expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::NotShuttingDown);
296 assert!(nodes[1].node.list_channels().is_empty());
298 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
299 assert_eq!(node_txn.len(), 1);
300 check_spends!(node_txn[0], chan_1.3);
301 mine_transaction(&nodes[0], &node_txn[0]);
302 check_added_monitors!(nodes[0], 1);
304 assert!(nodes[0].node.list_channels().is_empty());
305 assert!(nodes[1].node.list_channels().is_empty());
306 check_closed_broadcast!(nodes[0], true);
307 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed, [nodes[1].node.get_our_node_id()], 100000);
308 check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed, [nodes[0].node.get_our_node_id()], 100000);
312 fn updates_shutdown_wait() {
313 // Test sending a shutdown with outstanding updates pending
314 let chanmon_cfgs = create_chanmon_cfgs(3);
315 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
316 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
317 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
318 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
319 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
320 let logger = test_utils::TestLogger::new();
321 let scorer = test_utils::TestScorer::new();
322 let keys_manager = test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
323 let random_seed_bytes = keys_manager.get_secure_random_bytes();
325 let (payment_preimage_0, payment_hash_0, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100_000);
327 nodes[0].node.close_channel(&chan_1.2, &nodes[1].node.get_our_node_id()).unwrap();
328 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
329 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
330 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
331 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
333 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
334 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
336 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
338 let payment_params_1 = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id(), TEST_FINAL_CLTV)
339 .with_bolt11_features(nodes[1].node.bolt11_invoice_features()).unwrap();
340 let route_params = RouteParameters::from_payment_params_and_value(payment_params_1, 100_000);
341 let route_1 = get_route(&nodes[0].node.get_our_node_id(), &route_params,
342 &nodes[0].network_graph.read_only(), None, &logger, &scorer, &Default::default(), &random_seed_bytes).unwrap();
343 let payment_params_2 = PaymentParameters::from_node_id(nodes[0].node.get_our_node_id(), TEST_FINAL_CLTV)
344 .with_bolt11_features(nodes[0].node.bolt11_invoice_features()).unwrap();
345 let route_params = RouteParameters::from_payment_params_and_value(payment_params_2, 100_000);
346 let route_2 = get_route(&nodes[1].node.get_our_node_id(), &route_params,
347 &nodes[1].network_graph.read_only(), None, &logger, &scorer, &Default::default(), &random_seed_bytes).unwrap();
348 unwrap_send_err!(nodes[0].node.send_payment_with_route(&route_1, payment_hash,
349 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)
350 ), true, APIError::ChannelUnavailable {..}, {});
351 unwrap_send_err!(nodes[1].node.send_payment_with_route(&route_2, payment_hash,
352 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)
353 ), true, APIError::ChannelUnavailable {..}, {});
355 nodes[2].node.claim_funds(payment_preimage_0);
356 check_added_monitors!(nodes[2], 1);
357 expect_payment_claimed!(nodes[2], payment_hash_0, 100_000);
359 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
360 assert!(updates.update_add_htlcs.is_empty());
361 assert!(updates.update_fail_htlcs.is_empty());
362 assert!(updates.update_fail_malformed_htlcs.is_empty());
363 assert!(updates.update_fee.is_none());
364 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
365 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
366 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), false, false);
367 check_added_monitors!(nodes[1], 1);
368 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
369 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
371 assert!(updates_2.update_add_htlcs.is_empty());
372 assert!(updates_2.update_fail_htlcs.is_empty());
373 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
374 assert!(updates_2.update_fee.is_none());
375 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
376 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
377 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
378 expect_payment_sent!(nodes[0], payment_preimage_0);
380 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
381 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
382 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
383 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
384 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
385 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
386 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
387 assert!(node_1_none.is_none());
388 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
389 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
391 assert!(nodes[0].node.list_channels().is_empty());
393 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
394 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
395 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
396 assert!(nodes[1].node.list_channels().is_empty());
397 assert!(nodes[2].node.list_channels().is_empty());
398 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[2].node.get_our_node_id()], 100000);
399 check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
403 fn htlc_fail_async_shutdown() {
404 // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
405 let chanmon_cfgs = create_chanmon_cfgs(3);
406 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
407 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
408 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
409 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
410 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
412 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], 100000);
413 nodes[0].node.send_payment_with_route(&route, our_payment_hash,
414 RecipientOnionFields::secret_only(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
415 check_added_monitors!(nodes[0], 1);
416 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
417 assert_eq!(updates.update_add_htlcs.len(), 1);
418 assert!(updates.update_fulfill_htlcs.is_empty());
419 assert!(updates.update_fail_htlcs.is_empty());
420 assert!(updates.update_fail_malformed_htlcs.is_empty());
421 assert!(updates.update_fee.is_none());
423 nodes[1].node.close_channel(&chan_1.2, &nodes[0].node.get_our_node_id()).unwrap();
424 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
425 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
426 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
428 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
429 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
430 check_added_monitors!(nodes[1], 1);
431 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
432 commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false, false);
434 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
435 assert!(updates_2.update_add_htlcs.is_empty());
436 assert!(updates_2.update_fulfill_htlcs.is_empty());
437 assert_eq!(updates_2.update_fail_htlcs.len(), 1);
438 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
439 assert!(updates_2.update_fee.is_none());
441 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]);
442 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
444 expect_payment_failed_with_update!(nodes[0], our_payment_hash, false, chan_2.0.contents.short_channel_id, true);
446 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
447 assert_eq!(msg_events.len(), 1);
448 let node_0_closing_signed = match msg_events[0] {
449 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
450 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
453 _ => panic!("Unexpected event"),
456 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
457 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
458 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
459 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
460 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
461 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
462 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
463 assert!(node_1_none.is_none());
465 assert!(nodes[0].node.list_channels().is_empty());
467 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
468 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
469 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
470 assert!(nodes[1].node.list_channels().is_empty());
471 assert!(nodes[2].node.list_channels().is_empty());
472 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
473 check_closed_event!(nodes[1], 2, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id(), nodes[2].node.get_our_node_id()], 100000);
474 check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
477 fn do_test_shutdown_rebroadcast(recv_count: u8) {
478 // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
479 // messages delivered prior to disconnect
480 let chanmon_cfgs = create_chanmon_cfgs(3);
481 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
482 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
483 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
484 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
485 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
487 let (payment_preimage, payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100_000);
489 nodes[1].node.close_channel(&chan_1.2, &nodes[0].node.get_our_node_id()).unwrap();
490 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
492 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
493 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
495 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
499 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
500 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
502 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
503 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
505 let node_0_reestablish = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
506 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
507 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
509 let node_1_reestablish = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
511 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish);
512 let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
513 assert!(node_1_shutdown == node_1_2nd_shutdown);
515 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish);
516 let node_0_2nd_shutdown = if recv_count > 0 {
517 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
518 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
521 let node_0_chan_update = get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
522 assert_eq!(node_0_chan_update.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
523 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
524 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
526 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_2nd_shutdown);
528 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
529 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
531 nodes[2].node.claim_funds(payment_preimage);
532 check_added_monitors!(nodes[2], 1);
533 expect_payment_claimed!(nodes[2], payment_hash, 100_000);
535 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
536 assert!(updates.update_add_htlcs.is_empty());
537 assert!(updates.update_fail_htlcs.is_empty());
538 assert!(updates.update_fail_malformed_htlcs.is_empty());
539 assert!(updates.update_fee.is_none());
540 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
541 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
542 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), false, false);
543 check_added_monitors!(nodes[1], 1);
544 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
545 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
547 assert!(updates_2.update_add_htlcs.is_empty());
548 assert!(updates_2.update_fail_htlcs.is_empty());
549 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
550 assert!(updates_2.update_fee.is_none());
551 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
552 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
553 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
554 expect_payment_sent!(nodes[0], payment_preimage);
556 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
558 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
559 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
560 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
561 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
562 assert!(node_0_2nd_closing_signed.is_some());
565 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
566 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
568 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
569 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
571 let node_1_2nd_reestablish = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
572 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
573 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
576 // If all closing_signeds weren't delivered we can just resume where we left off...
577 let node_0_2nd_reestablish = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
579 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
580 let node_0_msgs = nodes[0].node.get_and_clear_pending_msg_events();
581 assert_eq!(node_0_msgs.len(), 2);
582 let node_0_2nd_closing_signed = match node_0_msgs[1] {
583 MessageSendEvent::SendClosingSigned { ref msg, .. } => {
584 assert_eq!(node_0_closing_signed, *msg);
590 let node_0_3rd_shutdown = match node_0_msgs[0] {
591 MessageSendEvent::SendShutdown { ref msg, .. } => {
592 assert_eq!(node_0_2nd_shutdown, *msg);
597 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
599 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
600 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
601 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
603 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_3rd_shutdown);
604 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
606 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_3rd_shutdown);
608 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed);
609 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
610 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
611 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
612 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
613 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
614 assert!(node_1_none.is_none());
615 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
617 // If one node, however, received + responded with an identical closing_signed we end
618 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
619 // There isn't really anything better we can do simply, but in the future we might
620 // explore storing a set of recently-closed channels that got disconnected during
621 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
622 // give our counterparty enough time to (potentially) broadcast a cooperative closing
624 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
626 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
627 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
628 assert_eq!(msg_events.len(), 2);
629 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[1] {
631 &ErrorAction::SendErrorMessage { ref msg } => {
632 nodes[1].node.handle_error(&nodes[0].node.get_our_node_id(), &msg);
633 assert_eq!(msg.channel_id, chan_1.2);
635 _ => panic!("Unexpected event!"),
637 } else { panic!("Needed SendErrorMessage close"); }
639 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
640 // checks it, but in this case nodes[1] didn't ever get a chance to receive a
641 // closing_signed so we do it ourselves
642 check_closed_broadcast!(nodes[1], false);
643 check_added_monitors!(nodes[1], 1);
644 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())) }
645 , [nodes[0].node.get_our_node_id()], 100000);
648 assert!(nodes[0].node.list_channels().is_empty());
650 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
651 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
652 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
653 assert!(nodes[1].node.list_channels().is_empty());
654 assert!(nodes[2].node.list_channels().is_empty());
655 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
656 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[2].node.get_our_node_id()], 100000);
657 check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
661 fn test_shutdown_rebroadcast() {
662 do_test_shutdown_rebroadcast(0);
663 do_test_shutdown_rebroadcast(1);
664 do_test_shutdown_rebroadcast(2);
668 fn test_upfront_shutdown_script() {
669 // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
670 // enforce it at shutdown message
672 let mut config = UserConfig::default();
673 config.channel_handshake_config.announced_channel = true;
674 config.channel_handshake_limits.force_announced_channel_preference = false;
675 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
676 let user_cfgs = [None, Some(config), None];
677 let chanmon_cfgs = create_chanmon_cfgs(3);
678 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
679 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
680 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
682 // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
683 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000);
684 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[2].node.get_our_node_id()).unwrap();
685 let node_0_orig_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
686 let mut node_0_shutdown = node_0_orig_shutdown.clone();
687 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
688 // Test we enforce upfront_scriptpbukey if by providing a different one at closing that we warn
689 // the peer and ignore the message.
690 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
691 assert!(regex::Regex::new(r"Got shutdown request with a scriptpubkey \([A-Fa-f0-9]+\) which did not match their previous scriptpubkey.")
692 .unwrap().is_match(&check_warn_msg!(nodes[2], nodes[0].node.get_our_node_id(), chan.2)));
693 // This allows nodes[2] to retry the shutdown message, which should get a response:
694 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_orig_shutdown);
695 get_event_msg!(nodes[2], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
697 // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
698 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000);
699 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[2].node.get_our_node_id()).unwrap();
700 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
701 // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
702 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
703 let events = nodes[2].node.get_and_clear_pending_msg_events();
704 assert_eq!(events.len(), 1);
706 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
707 _ => panic!("Unexpected event"),
710 // We test that if case of peer non-signaling we don't enforce committed script at channel opening
711 *nodes[0].override_init_features.borrow_mut() = Some(nodes[0].node.init_features().clear_upfront_shutdown_script());
712 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000);
713 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[1].node.get_our_node_id()).unwrap();
714 let node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
715 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_1_shutdown);
716 check_added_monitors!(nodes[1], 1);
717 let events = nodes[1].node.get_and_clear_pending_msg_events();
718 assert_eq!(events.len(), 1);
720 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
721 _ => panic!("Unexpected event"),
724 // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
725 // channel smoothly, opt-out is from channel initiator here
726 *nodes[0].override_init_features.borrow_mut() = None;
727 let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000);
728 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[0].node.get_our_node_id()).unwrap();
729 check_added_monitors!(nodes[1], 1);
730 let node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
731 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
732 let events = nodes[0].node.get_and_clear_pending_msg_events();
733 assert_eq!(events.len(), 1);
735 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
736 _ => panic!("Unexpected event"),
739 //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
740 //// channel smoothly
741 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000);
742 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[0].node.get_our_node_id()).unwrap();
743 check_added_monitors!(nodes[1], 1);
744 let node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
745 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
746 let events = nodes[0].node.get_and_clear_pending_msg_events();
747 assert_eq!(events.len(), 2);
749 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
750 _ => panic!("Unexpected event"),
753 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
754 _ => panic!("Unexpected event"),
759 fn test_unsupported_anysegwit_upfront_shutdown_script() {
760 let chanmon_cfgs = create_chanmon_cfgs(2);
761 let mut node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
762 // Clear shutdown_anysegwit on initiator
763 *node_cfgs[0].override_init_features.borrow_mut() = Some(channelmanager::provided_init_features(&test_default_channel_config()).clear_shutdown_anysegwit());
764 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
765 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
767 // Use a non-v0 segwit script supported by option_shutdown_anysegwit
768 let anysegwit_shutdown_script = Builder::new()
770 .push_slice(&[0, 40])
773 // Check script when handling an open_channel message
774 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None, None).unwrap();
775 let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
776 open_channel.shutdown_scriptpubkey = Some(anysegwit_shutdown_script.clone());
777 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel);
779 let events = nodes[1].node.get_and_clear_pending_msg_events();
780 assert_eq!(events.len(), 1);
782 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
783 assert_eq!(node_id, nodes[0].node.get_our_node_id());
784 assert_eq!(msg.data, "Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: OP_PUSHNUM_16 OP_PUSHBYTES_2 0028");
786 _ => panic!("Unexpected event"),
789 let chanmon_cfgs = create_chanmon_cfgs(2);
790 let mut node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
791 // Clear shutdown_anysegwit on responder
792 *node_cfgs[1].override_init_features.borrow_mut() = Some(channelmanager::provided_init_features(&test_default_channel_config()).clear_shutdown_anysegwit());
793 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
794 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
796 // Check script when handling an accept_channel message
797 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None, None).unwrap();
798 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
799 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel);
800 let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
801 accept_channel.shutdown_scriptpubkey = Some(anysegwit_shutdown_script.clone());
802 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel);
804 let events = nodes[0].node.get_and_clear_pending_msg_events();
805 assert_eq!(events.len(), 1);
807 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
808 assert_eq!(node_id, nodes[1].node.get_our_node_id());
809 assert_eq!(msg.data, "Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: OP_PUSHNUM_16 OP_PUSHBYTES_2 0028");
811 _ => panic!("Unexpected event"),
813 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() }
814 , [nodes[1].node.get_our_node_id()], 100000);
818 fn test_invalid_upfront_shutdown_script() {
819 let chanmon_cfgs = create_chanmon_cfgs(2);
820 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
821 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
822 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
824 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None, None).unwrap();
826 // Use a segwit v0 script with an unsupported witness program
827 let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
828 open_channel.shutdown_scriptpubkey = Some(Builder::new().push_int(0)
831 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel);
833 let events = nodes[1].node.get_and_clear_pending_msg_events();
834 assert_eq!(events.len(), 1);
836 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
837 assert_eq!(node_id, nodes[0].node.get_our_node_id());
838 assert_eq!(msg.data, "Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: OP_0 OP_PUSHBYTES_2 0000");
840 _ => panic!("Unexpected event"),
845 fn test_segwit_v0_shutdown_script() {
846 let mut config = UserConfig::default();
847 config.channel_handshake_config.announced_channel = true;
848 config.channel_handshake_limits.force_announced_channel_preference = false;
849 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
850 let user_cfgs = [None, Some(config), None];
851 let chanmon_cfgs = create_chanmon_cfgs(3);
852 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
853 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
854 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
856 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
857 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[0].node.get_our_node_id()).unwrap();
858 check_added_monitors!(nodes[1], 1);
860 // Use a segwit v0 script supported even without option_shutdown_anysegwit
861 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
862 node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
863 .push_slice(&[0; 20])
865 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
867 let events = nodes[0].node.get_and_clear_pending_msg_events();
868 assert_eq!(events.len(), 2);
870 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
871 _ => panic!("Unexpected event"),
874 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
875 _ => panic!("Unexpected event"),
880 fn test_anysegwit_shutdown_script() {
881 let mut config = UserConfig::default();
882 config.channel_handshake_config.announced_channel = true;
883 config.channel_handshake_limits.force_announced_channel_preference = false;
884 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
885 let user_cfgs = [None, Some(config), None];
886 let chanmon_cfgs = create_chanmon_cfgs(3);
887 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
888 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
889 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
891 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
892 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[0].node.get_our_node_id()).unwrap();
893 check_added_monitors!(nodes[1], 1);
895 // Use a non-v0 segwit script supported by option_shutdown_anysegwit
896 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
897 node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
900 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
902 let events = nodes[0].node.get_and_clear_pending_msg_events();
903 assert_eq!(events.len(), 2);
905 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
906 _ => panic!("Unexpected event"),
909 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
910 _ => panic!("Unexpected event"),
915 fn test_unsupported_anysegwit_shutdown_script() {
916 let mut config = UserConfig::default();
917 config.channel_handshake_config.announced_channel = true;
918 config.channel_handshake_limits.force_announced_channel_preference = false;
919 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
920 let user_cfgs = [None, Some(config), None];
921 let chanmon_cfgs = create_chanmon_cfgs(3);
922 let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
923 *node_cfgs[0].override_init_features.borrow_mut() = Some(channelmanager::provided_init_features(&config).clear_shutdown_anysegwit());
924 *node_cfgs[1].override_init_features.borrow_mut() = Some(channelmanager::provided_init_features(&config).clear_shutdown_anysegwit());
925 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
926 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
928 // Check that using an unsupported shutdown script fails and a supported one succeeds.
929 let supported_shutdown_script = chanmon_cfgs[1].keys_manager.get_shutdown_scriptpubkey().unwrap();
930 let unsupported_witness_program = WitnessProgram::new(WitnessVersion::V16, &[0, 40]).unwrap();
931 let unsupported_shutdown_script =
932 ShutdownScript::new_witness_program(&unsupported_witness_program).unwrap();
933 chanmon_cfgs[1].keys_manager
934 .expect(OnGetShutdownScriptpubkey { returns: unsupported_shutdown_script.clone() })
935 .expect(OnGetShutdownScriptpubkey { returns: supported_shutdown_script });
937 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
938 match nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[0].node.get_our_node_id()) {
939 Err(APIError::IncompatibleShutdownScript { script }) => {
940 assert_eq!(script.into_inner(), unsupported_shutdown_script.clone().into_inner());
942 Err(e) => panic!("Unexpected error: {:?}", e),
943 Ok(_) => panic!("Expected error"),
945 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[0].node.get_our_node_id()).unwrap();
946 check_added_monitors!(nodes[1], 1);
948 // Use a non-v0 segwit script unsupported without option_shutdown_anysegwit
949 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
950 node_0_shutdown.scriptpubkey = unsupported_shutdown_script.into_inner();
951 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
953 assert_eq!(&check_warn_msg!(nodes[0], nodes[1].node.get_our_node_id(), chan.2),
954 "Got a nonstandard scriptpubkey (60020028) from remote peer");
958 fn test_invalid_shutdown_script() {
959 let mut config = UserConfig::default();
960 config.channel_handshake_config.announced_channel = true;
961 config.channel_handshake_limits.force_announced_channel_preference = false;
962 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
963 let user_cfgs = [None, Some(config), None];
964 let chanmon_cfgs = create_chanmon_cfgs(3);
965 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
966 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
967 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
969 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
970 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[0].node.get_our_node_id()).unwrap();
971 check_added_monitors!(nodes[1], 1);
973 // Use a segwit v0 script with an unsupported witness program
974 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
975 node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
978 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
980 assert_eq!(&check_warn_msg!(nodes[0], nodes[1].node.get_our_node_id(), chan.2),
981 "Got a nonstandard scriptpubkey (00020000) from remote peer");
985 fn test_user_shutdown_script() {
986 let mut config = test_default_channel_config();
987 config.channel_handshake_config.announced_channel = true;
988 config.channel_handshake_limits.force_announced_channel_preference = false;
989 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
990 let user_cfgs = [None, Some(config), None];
991 let chanmon_cfgs = create_chanmon_cfgs(3);
992 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
993 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
994 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
996 // Segwit v0 script of the form OP_0 <20-byte hash>
997 let script = Builder::new().push_int(0)
998 .push_slice(&[0; 20])
1001 let shutdown_script = ShutdownScript::try_from(script.clone()).unwrap();
1003 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
1004 nodes[1].node.close_channel_with_feerate_and_script(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[0].node.get_our_node_id(), None, Some(shutdown_script)).unwrap();
1005 check_added_monitors!(nodes[1], 1);
1007 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1009 assert_eq!(node_0_shutdown.scriptpubkey, script);
1013 fn test_already_set_user_shutdown_script() {
1014 let mut config = test_default_channel_config();
1015 config.channel_handshake_config.announced_channel = true;
1016 config.channel_handshake_limits.force_announced_channel_preference = false;
1017 let user_cfgs = [None, Some(config), None];
1018 let chanmon_cfgs = create_chanmon_cfgs(3);
1019 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1020 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
1021 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1023 // Segwit v0 script of the form OP_0 <20-byte hash>
1024 let script = Builder::new().push_int(0)
1025 .push_slice(&[0; 20])
1028 let shutdown_script = ShutdownScript::try_from(script).unwrap();
1030 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
1031 let result = nodes[1].node.close_channel_with_feerate_and_script(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[0].node.get_our_node_id(), None, Some(shutdown_script));
1033 assert_eq!(result, Err(APIError::APIMisuseError { err: "Cannot override shutdown script for a channel with one already set".to_string() }));
1036 #[derive(PartialEq)]
1043 fn do_test_closing_signed_reinit_timeout(timeout_step: TimeoutStep) {
1044 // The range-based closing signed negotiation allows the funder to restart the process with a
1045 // new range if the previous range did not overlap. This allows implementations to request user
1046 // intervention allowing users to enter a new fee range. We do not implement the sending side
1047 // of this, instead opting to allow users to enter an explicit "willing to pay up to X to avoid
1048 // force-closing" value and relying on that instead.
1050 // Here we run test the fundee side of that restart mechanism, implementing the funder side of
1052 let chanmon_cfgs = create_chanmon_cfgs(2);
1053 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1054 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1055 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1056 let chan_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
1058 send_payment(&nodes[0], &[&nodes[1]], 8_000_000);
1060 nodes[0].node.close_channel(&chan_id, &nodes[1].node.get_our_node_id()).unwrap();
1061 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1062 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
1063 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1064 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
1067 // Now we set nodes[1] to require a relatively high feerate for closing. This should result
1068 // in it rejecting nodes[0]'s initial closing_signed, giving nodes[0] a chance to try
1070 let mut feerate_lock = chanmon_cfgs[1].fee_estimator.sat_per_kw.lock().unwrap();
1071 *feerate_lock *= 10;
1074 let mut node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1075 // nodes[0] should use a "reasonable" feerate, well under the 10 sat/vByte that nodes[1] thinks
1076 // is the current prevailing feerate.
1077 assert!(node_0_closing_signed.fee_satoshis <= 500);
1079 if timeout_step != TimeoutStep::AfterShutdown {
1080 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1081 assert!(check_warn_msg!(nodes[1], nodes[0].node.get_our_node_id(), chan_id)
1082 .starts_with("Unable to come to consensus about closing feerate"));
1084 // Now deliver a mutated closing_signed indicating a higher acceptable fee range, which
1085 // nodes[1] should happily accept and respond to.
1086 node_0_closing_signed.fee_range.as_mut().unwrap().max_fee_satoshis *= 10;
1088 let mut node_0_per_peer_lock;
1089 let mut node_0_peer_state_lock;
1090 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;
1092 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1093 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
1094 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
1095 let node_0_2nd_closing_signed = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1096 if timeout_step == TimeoutStep::NoTimeout {
1097 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.1.unwrap());
1098 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
1100 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
1103 if timeout_step != TimeoutStep::NoTimeout {
1104 assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
1106 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1109 nodes[1].node.timer_tick_occurred();
1110 nodes[1].node.timer_tick_occurred();
1112 let txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1113 assert_eq!(txn.len(), 1);
1114 assert_eq!(txn[0].output.len(), 2);
1116 if timeout_step != TimeoutStep::NoTimeout {
1117 assert!((txn[0].output[0].script_pubkey.is_v0_p2wpkh() &&
1118 txn[0].output[1].script_pubkey.is_v0_p2wsh()) ||
1119 (txn[0].output[1].script_pubkey.is_v0_p2wpkh() &&
1120 txn[0].output[0].script_pubkey.is_v0_p2wsh()));
1121 check_closed_broadcast!(nodes[1], true);
1122 check_added_monitors!(nodes[1], 1);
1123 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "closing_signed negotiation failed to finish within two timer ticks".to_string() }
1124 , [nodes[0].node.get_our_node_id()], 100000);
1126 assert!(txn[0].output[0].script_pubkey.is_v0_p2wpkh());
1127 assert!(txn[0].output[1].script_pubkey.is_v0_p2wpkh());
1129 let events = nodes[1].node.get_and_clear_pending_msg_events();
1130 assert_eq!(events.len(), 1);
1132 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1133 assert_eq!(msg.contents.flags & 2, 2);
1135 _ => panic!("Unexpected event"),
1141 fn test_closing_signed_reinit_timeout() {
1142 do_test_closing_signed_reinit_timeout(TimeoutStep::AfterShutdown);
1143 do_test_closing_signed_reinit_timeout(TimeoutStep::AfterClosingSigned);
1144 do_test_closing_signed_reinit_timeout(TimeoutStep::NoTimeout);
1147 fn do_simple_legacy_shutdown_test(high_initiator_fee: bool) {
1148 // A simpe test of the legacy shutdown fee negotiation logic.
1149 let chanmon_cfgs = create_chanmon_cfgs(2);
1150 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1151 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1152 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1154 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
1156 if high_initiator_fee {
1157 // If high_initiator_fee is set, set nodes[0]'s feerate significantly higher. This
1158 // shouldn't impact the flow at all given nodes[1] will happily accept the higher fee.
1159 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
1160 *feerate_lock *= 10;
1163 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[1].node.get_our_node_id()).unwrap();
1164 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1165 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
1166 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1167 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
1169 let mut node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1170 node_0_closing_signed.fee_range = None;
1171 if high_initiator_fee {
1172 assert!(node_0_closing_signed.fee_satoshis > 500);
1174 assert!(node_0_closing_signed.fee_satoshis < 500);
1177 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1178 let (_, mut node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1179 node_1_closing_signed.as_mut().unwrap().fee_range = None;
1181 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
1182 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1183 assert!(node_0_none.is_none());
1184 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
1185 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
1189 fn simple_legacy_shutdown_test() {
1190 do_simple_legacy_shutdown_test(false);
1191 do_simple_legacy_shutdown_test(true);
1195 fn simple_target_feerate_shutdown() {
1196 // Simple test of target in `close_channel_with_target_feerate`.
1197 let chanmon_cfgs = create_chanmon_cfgs(2);
1198 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1199 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1200 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1202 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
1203 let chan_id = OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id();
1205 nodes[0].node.close_channel_with_feerate_and_script(&chan_id, &nodes[1].node.get_our_node_id(), Some(253 * 10), None).unwrap();
1206 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1207 nodes[1].node.close_channel_with_feerate_and_script(&chan_id, &nodes[0].node.get_our_node_id(), Some(253 * 5), None).unwrap();
1208 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1210 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
1211 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
1213 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1214 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1215 let (_, node_1_closing_signed_opt) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1216 let node_1_closing_signed = node_1_closing_signed_opt.unwrap();
1218 // nodes[1] was passed a target which was larger than the current channel feerate, which it
1219 // should ignore in favor of the channel fee, as there is no use demanding a minimum higher
1220 // than what will be paid on a force-close transaction. Note that we have to consider rounding,
1221 // so only check that we're within 10 sats.
1222 assert!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis >=
1223 node_1_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis * 10 - 5);
1224 assert!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis <=
1225 node_1_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis * 10 + 5);
1227 // Further, because nodes[0]'s target fee is larger than the `Normal` fee estimation plus our
1228 // force-closure-avoidance buffer, min should equal max, and the nodes[1]-selected fee should
1229 // be the nodes[0] only available fee.
1230 assert_eq!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis,
1231 node_0_closing_signed.fee_range.as_ref().unwrap().max_fee_satoshis);
1232 assert_eq!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis,
1233 node_0_closing_signed.fee_satoshis);
1234 assert_eq!(node_0_closing_signed.fee_satoshis, node_1_closing_signed.fee_satoshis);
1236 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
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::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
1240 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
1243 fn do_outbound_update_no_early_closing_signed(use_htlc: bool) {
1244 // Previously, if we have a pending inbound HTLC (or fee update) on a channel which has
1245 // initiated shutdown, we'd send our initial closing_signed immediately after receiving the
1246 // peer's last RAA to remove the HTLC/fee update, but before receiving their final
1247 // commitment_signed for a commitment without the HTLC/with the new fee. This caused at least
1248 // LDK peers to force-close as we initiated closing_signed prior to the channel actually being
1249 // fully empty of pending updates/HTLCs.
1250 let chanmon_cfgs = create_chanmon_cfgs(2);
1251 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1252 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1253 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1255 let chan_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
1257 send_payment(&nodes[0], &[&nodes[1]], 1_000_000);
1258 let payment_hash_opt = if use_htlc {
1259 Some(route_payment(&nodes[1], &[&nodes[0]], 10_000).1)
1265 nodes[0].node.fail_htlc_backwards(&payment_hash_opt.unwrap());
1266 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[0],
1267 [HTLCDestination::FailedPayment { payment_hash: payment_hash_opt.unwrap() }]);
1269 *chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap() *= 10;
1270 nodes[0].node.timer_tick_occurred();
1272 let updates = get_htlc_update_msgs(&nodes[0], &nodes[1].node.get_our_node_id());
1273 check_added_monitors(&nodes[0], 1);
1275 nodes[1].node.close_channel(&chan_id, &nodes[0].node.get_our_node_id()).unwrap();
1276 let node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1277 nodes[0].node.close_channel(&chan_id, &nodes[1].node.get_our_node_id()).unwrap();
1278 let node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1280 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
1281 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_1_shutdown);
1284 nodes[1].node.handle_update_fail_htlc(&nodes[0].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
1286 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &updates.update_fee.unwrap());
1288 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
1289 check_added_monitors(&nodes[1], 1);
1290 let (bs_raa, bs_cs) = get_revoke_commit_msgs(&nodes[1], &nodes[0].node.get_our_node_id());
1292 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1293 check_added_monitors(&nodes[0], 1);
1295 // At this point the Channel on nodes[0] has no record of any HTLCs but the latest
1296 // broadcastable commitment does contain the HTLC (but only the ChannelMonitor knows this).
1297 // Thus, the channel should not yet initiate closing_signed negotiation (but previously did).
1298 assert_eq!(nodes[0].node.get_and_clear_pending_msg_events(), Vec::new());
1300 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1301 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs);
1302 check_added_monitors(&nodes[0], 1);
1303 assert_eq!(nodes[0].node.get_and_clear_pending_msg_events(), Vec::new());
1305 expect_channel_shutdown_state!(nodes[0], chan_id, ChannelShutdownState::ResolvingHTLCs);
1306 assert_eq!(nodes[0].node.get_and_clear_pending_msg_events(), Vec::new());
1307 let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_id).unwrap().clone();
1308 nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1310 let as_raa_closing_signed = nodes[0].node.get_and_clear_pending_msg_events();
1311 assert_eq!(as_raa_closing_signed.len(), 2);
1313 if let MessageSendEvent::SendRevokeAndACK { msg, .. } = &as_raa_closing_signed[0] {
1314 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &msg);
1315 check_added_monitors(&nodes[1], 1);
1317 expect_payment_failed!(nodes[1], payment_hash_opt.unwrap(), true);
1319 } else { panic!("Unexpected message {:?}", as_raa_closing_signed[0]); }
1321 if let MessageSendEvent::SendClosingSigned { msg, .. } = &as_raa_closing_signed[1] {
1322 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &msg);
1323 } else { panic!("Unexpected message {:?}", as_raa_closing_signed[1]); }
1325 let bs_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
1326 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &bs_closing_signed);
1327 let (_, as_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1328 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &as_2nd_closing_signed.unwrap());
1329 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1330 assert!(node_1_none.is_none());
1332 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
1333 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
1337 fn outbound_update_no_early_closing_signed() {
1338 do_outbound_update_no_early_closing_signed(true);
1339 do_outbound_update_no_early_closing_signed(false);