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