1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! Tests of our shutdown and closing_signed negotiation logic.
12 use chain::keysinterface::KeysInterface;
13 use chain::transaction::OutPoint;
14 use ln::channelmanager::PaymentSendFailure;
15 use routing::router::{PaymentParameters, get_route};
16 use ln::features::{InitFeatures, InvoiceFeatures};
18 use ln::msgs::{ChannelMessageHandler, ErrorAction};
19 use ln::script::ShutdownScript;
21 use util::test_utils::OnGetShutdownScriptpubkey;
22 use util::events::{Event, MessageSendEvent, MessageSendEventsProvider, ClosureReason};
23 use util::errors::APIError;
24 use util::config::UserConfig;
26 use bitcoin::blockdata::script::Builder;
27 use bitcoin::blockdata::opcodes;
31 use core::default::Default;
32 use core::num::NonZeroU8;
34 use ln::functional_test_utils::*;
35 use ln::msgs::OptionalField::Present;
38 fn pre_funding_lock_shutdown_test() {
39 // Test sending a shutdown prior to funding_locked after funding generation
40 let chanmon_cfgs = create_chanmon_cfgs(2);
41 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
42 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
43 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
44 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0, InitFeatures::known(), InitFeatures::known());
45 mine_transaction(&nodes[0], &tx);
46 mine_transaction(&nodes[1], &tx);
48 nodes[0].node.close_channel(&OutPoint { txid: tx.txid(), index: 0 }.to_channel_id()).unwrap();
49 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
50 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
51 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
52 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
54 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
55 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
56 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
57 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
58 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
59 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
60 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
61 assert!(node_1_none.is_none());
63 assert!(nodes[0].node.list_channels().is_empty());
64 assert!(nodes[1].node.list_channels().is_empty());
65 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
66 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
70 fn updates_shutdown_wait() {
71 // Test sending a shutdown with outstanding updates pending
72 let chanmon_cfgs = create_chanmon_cfgs(3);
73 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
74 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
75 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
76 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
77 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
78 let logger = test_utils::TestLogger::new();
79 let scorer = test_utils::TestScorer::with_fixed_penalty(0);
81 let (payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
83 nodes[0].node.close_channel(&chan_1.2).unwrap();
84 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
85 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
86 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
87 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
89 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
90 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
92 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
94 let payment_params_1 = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id()).with_features(InvoiceFeatures::known());
95 let route_1 = get_route(&nodes[0].node.get_our_node_id(), &payment_params_1, nodes[0].network_graph, None, 100000, TEST_FINAL_CLTV, &logger, &scorer).unwrap();
96 let payment_params_2 = PaymentParameters::from_node_id(nodes[0].node.get_our_node_id()).with_features(InvoiceFeatures::known());
97 let route_2 = get_route(&nodes[1].node.get_our_node_id(), &payment_params_2, nodes[1].network_graph, None, 100000, TEST_FINAL_CLTV, &logger, &scorer).unwrap();
98 unwrap_send_err!(nodes[0].node.send_payment(&route_1, payment_hash, &Some(payment_secret)), true, APIError::ChannelUnavailable {..}, {});
99 unwrap_send_err!(nodes[1].node.send_payment(&route_2, payment_hash, &Some(payment_secret)), true, APIError::ChannelUnavailable {..}, {});
101 assert!(nodes[2].node.claim_funds(payment_preimage));
102 check_added_monitors!(nodes[2], 1);
103 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
104 assert!(updates.update_add_htlcs.is_empty());
105 assert!(updates.update_fail_htlcs.is_empty());
106 assert!(updates.update_fail_malformed_htlcs.is_empty());
107 assert!(updates.update_fee.is_none());
108 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
109 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
110 expect_payment_forwarded!(nodes[1], Some(1000), false);
111 check_added_monitors!(nodes[1], 1);
112 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
113 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
115 assert!(updates_2.update_add_htlcs.is_empty());
116 assert!(updates_2.update_fail_htlcs.is_empty());
117 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
118 assert!(updates_2.update_fee.is_none());
119 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
120 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
121 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
122 expect_payment_sent!(nodes[0], payment_preimage);
124 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
125 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
126 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
127 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
128 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
129 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
130 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
131 assert!(node_1_none.is_none());
132 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
133 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
135 assert!(nodes[0].node.list_channels().is_empty());
137 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
138 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
139 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
140 assert!(nodes[1].node.list_channels().is_empty());
141 assert!(nodes[2].node.list_channels().is_empty());
142 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
143 check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure);
147 fn htlc_fail_async_shutdown() {
148 // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
149 let chanmon_cfgs = create_chanmon_cfgs(3);
150 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
151 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
152 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
153 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
154 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
156 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], 100000);
157 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
158 check_added_monitors!(nodes[0], 1);
159 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
160 assert_eq!(updates.update_add_htlcs.len(), 1);
161 assert!(updates.update_fulfill_htlcs.is_empty());
162 assert!(updates.update_fail_htlcs.is_empty());
163 assert!(updates.update_fail_malformed_htlcs.is_empty());
164 assert!(updates.update_fee.is_none());
166 nodes[1].node.close_channel(&chan_1.2).unwrap();
167 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
168 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
169 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
171 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
172 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
173 check_added_monitors!(nodes[1], 1);
174 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
175 commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
177 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
178 assert!(updates_2.update_add_htlcs.is_empty());
179 assert!(updates_2.update_fulfill_htlcs.is_empty());
180 assert_eq!(updates_2.update_fail_htlcs.len(), 1);
181 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
182 assert!(updates_2.update_fee.is_none());
184 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]);
185 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
187 expect_payment_failed_with_update!(nodes[0], our_payment_hash, false, chan_2.0.contents.short_channel_id, true);
189 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
190 assert_eq!(msg_events.len(), 1);
191 let node_0_closing_signed = match msg_events[0] {
192 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
193 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
196 _ => panic!("Unexpected event"),
199 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
200 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
201 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
202 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
203 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
204 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
205 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
206 assert!(node_1_none.is_none());
208 assert!(nodes[0].node.list_channels().is_empty());
210 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
211 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
212 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
213 assert!(nodes[1].node.list_channels().is_empty());
214 assert!(nodes[2].node.list_channels().is_empty());
215 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
216 check_closed_event!(nodes[1], 2, ClosureReason::CooperativeClosure);
217 check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure);
220 fn do_test_shutdown_rebroadcast(recv_count: u8) {
221 // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
222 // messages delivered prior to disconnect
223 let chanmon_cfgs = create_chanmon_cfgs(3);
224 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
225 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
226 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
227 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
228 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
230 let (payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
232 nodes[1].node.close_channel(&chan_1.2).unwrap();
233 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
235 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
236 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
238 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
242 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
243 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
245 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
246 let node_0_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
247 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
248 let node_1_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
250 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish);
251 let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
252 assert!(node_1_shutdown == node_1_2nd_shutdown);
254 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish);
255 let node_0_2nd_shutdown = if recv_count > 0 {
256 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
257 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_2nd_shutdown);
260 let node_0_chan_update = get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
261 assert_eq!(node_0_chan_update.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
262 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_2nd_shutdown);
263 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
265 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_2nd_shutdown);
267 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
268 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
270 assert!(nodes[2].node.claim_funds(payment_preimage));
271 check_added_monitors!(nodes[2], 1);
272 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
273 assert!(updates.update_add_htlcs.is_empty());
274 assert!(updates.update_fail_htlcs.is_empty());
275 assert!(updates.update_fail_malformed_htlcs.is_empty());
276 assert!(updates.update_fee.is_none());
277 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
278 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
279 expect_payment_forwarded!(nodes[1], Some(1000), false);
280 check_added_monitors!(nodes[1], 1);
281 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
282 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
284 assert!(updates_2.update_add_htlcs.is_empty());
285 assert!(updates_2.update_fail_htlcs.is_empty());
286 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
287 assert!(updates_2.update_fee.is_none());
288 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
289 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
290 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
291 expect_payment_sent!(nodes[0], payment_preimage);
293 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
295 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
296 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
297 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
298 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
299 assert!(node_0_2nd_closing_signed.is_some());
302 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
303 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
305 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
306 let node_1_2nd_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
307 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
309 // If all closing_signeds weren't delivered we can just resume where we left off...
310 let node_0_2nd_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
312 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
313 let node_0_msgs = nodes[0].node.get_and_clear_pending_msg_events();
314 assert_eq!(node_0_msgs.len(), 2);
315 let node_0_2nd_closing_signed = match node_0_msgs[1] {
316 MessageSendEvent::SendClosingSigned { ref msg, .. } => {
317 assert_eq!(node_0_closing_signed, *msg);
323 let node_0_3rd_shutdown = match node_0_msgs[0] {
324 MessageSendEvent::SendShutdown { ref msg, .. } => {
325 assert_eq!(node_0_2nd_shutdown, *msg);
330 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
332 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
333 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
334 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
336 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_3rd_shutdown);
337 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
339 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_3rd_shutdown);
341 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed);
342 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
343 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
344 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
345 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
346 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
347 assert!(node_1_none.is_none());
348 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
350 // If one node, however, received + responded with an identical closing_signed we end
351 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
352 // There isn't really anything better we can do simply, but in the future we might
353 // explore storing a set of recently-closed channels that got disconnected during
354 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
355 // give our counterparty enough time to (potentially) broadcast a cooperative closing
357 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
359 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
360 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
361 assert_eq!(msg_events.len(), 1);
362 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
364 &ErrorAction::SendErrorMessage { ref msg } => {
365 nodes[1].node.handle_error(&nodes[0].node.get_our_node_id(), &msg);
366 assert_eq!(msg.channel_id, chan_1.2);
368 _ => panic!("Unexpected event!"),
370 } else { panic!("Needed SendErrorMessage close"); }
372 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
373 // checks it, but in this case nodes[1] didn't ever get a chance to receive a
374 // closing_signed so we do it ourselves
375 check_closed_broadcast!(nodes[1], false);
376 check_added_monitors!(nodes[1], 1);
377 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyForceClosed { peer_msg: "Failed to find corresponding channel".to_string() });
380 assert!(nodes[0].node.list_channels().is_empty());
382 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
383 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
384 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
385 assert!(nodes[1].node.list_channels().is_empty());
386 assert!(nodes[2].node.list_channels().is_empty());
387 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
388 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
389 check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure);
393 fn test_shutdown_rebroadcast() {
394 do_test_shutdown_rebroadcast(0);
395 do_test_shutdown_rebroadcast(1);
396 do_test_shutdown_rebroadcast(2);
400 fn test_upfront_shutdown_script() {
401 // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
402 // enforce it at shutdown message
404 let mut config = UserConfig::default();
405 config.channel_options.announced_channel = true;
406 config.peer_channel_config_limits.force_announced_channel_preference = false;
407 config.channel_options.commit_upfront_shutdown_pubkey = false;
408 let user_cfgs = [None, Some(config), None];
409 let chanmon_cfgs = create_chanmon_cfgs(3);
410 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
411 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
412 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
414 // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
415 let flags = InitFeatures::known();
416 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
417 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
418 let node_0_orig_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
419 let mut node_0_shutdown = node_0_orig_shutdown.clone();
420 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
421 // Test we enforce upfront_scriptpbukey if by providing a different one at closing that we warn
422 // the peer and ignore the message.
423 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
424 assert!(regex::Regex::new(r"Got shutdown request with a scriptpubkey \([A-Fa-f0-9]+\) which did not match their previous scriptpubkey.")
425 .unwrap().is_match(&check_warn_msg!(nodes[2], nodes[0].node.get_our_node_id(), chan.2)));
426 // This allows nodes[2] to retry the shutdown message, which should get a response:
427 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_orig_shutdown);
428 get_event_msg!(nodes[2], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
430 // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
431 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
432 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
433 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
434 // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
435 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
436 let events = nodes[2].node.get_and_clear_pending_msg_events();
437 assert_eq!(events.len(), 1);
439 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
440 _ => panic!("Unexpected event"),
443 // We test that if case of peer non-signaling we don't enforce committed script at channel opening
444 let flags_no = InitFeatures::known().clear_upfront_shutdown_script();
445 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
446 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
447 let node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
448 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
449 check_added_monitors!(nodes[1], 1);
450 let events = nodes[1].node.get_and_clear_pending_msg_events();
451 assert_eq!(events.len(), 1);
453 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
454 _ => panic!("Unexpected event"),
457 // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
458 // channel smoothly, opt-out is from channel initiator here
459 let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
460 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
461 check_added_monitors!(nodes[1], 1);
462 let node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
463 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
464 let events = nodes[0].node.get_and_clear_pending_msg_events();
465 assert_eq!(events.len(), 1);
467 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
468 _ => panic!("Unexpected event"),
471 //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
472 //// channel smoothly
473 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
474 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
475 check_added_monitors!(nodes[1], 1);
476 let node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
477 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
478 let events = nodes[0].node.get_and_clear_pending_msg_events();
479 assert_eq!(events.len(), 2);
481 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
482 _ => panic!("Unexpected event"),
485 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
486 _ => panic!("Unexpected event"),
491 fn test_unsupported_anysegwit_upfront_shutdown_script() {
492 let chanmon_cfgs = create_chanmon_cfgs(2);
493 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
494 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
495 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
497 // Use a non-v0 segwit script supported by option_shutdown_anysegwit
498 let node_features = InitFeatures::known().clear_shutdown_anysegwit();
499 let anysegwit_shutdown_script = Builder::new()
501 .push_slice(&[0, 40])
504 // Check script when handling an open_channel message
505 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
506 let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
507 open_channel.shutdown_scriptpubkey = Present(anysegwit_shutdown_script.clone());
508 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), node_features.clone(), &open_channel);
510 let events = nodes[1].node.get_and_clear_pending_msg_events();
511 assert_eq!(events.len(), 1);
513 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
514 assert_eq!(node_id, nodes[0].node.get_our_node_id());
515 assert_eq!(msg.data, "Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: Script(OP_PUSHNUM_16 OP_PUSHBYTES_2 0028)");
517 _ => panic!("Unexpected event"),
520 // Check script when handling an accept_channel message
521 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
522 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
523 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
524 let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
525 accept_channel.shutdown_scriptpubkey = Present(anysegwit_shutdown_script.clone());
526 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), node_features, &accept_channel);
528 let events = nodes[0].node.get_and_clear_pending_msg_events();
529 assert_eq!(events.len(), 1);
531 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
532 assert_eq!(node_id, nodes[1].node.get_our_node_id());
533 assert_eq!(msg.data, "Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: Script(OP_PUSHNUM_16 OP_PUSHBYTES_2 0028)");
535 _ => panic!("Unexpected event"),
537 check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: "Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: Script(OP_PUSHNUM_16 OP_PUSHBYTES_2 0028)".to_string() });
541 fn test_invalid_upfront_shutdown_script() {
542 let chanmon_cfgs = create_chanmon_cfgs(2);
543 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
544 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
545 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
547 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
549 // Use a segwit v0 script with an unsupported witness program
550 let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
551 open_channel.shutdown_scriptpubkey = Present(Builder::new().push_int(0)
554 nodes[0].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
556 let events = nodes[0].node.get_and_clear_pending_msg_events();
557 assert_eq!(events.len(), 1);
559 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
560 assert_eq!(node_id, nodes[0].node.get_our_node_id());
561 assert_eq!(msg.data, "Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: Script(OP_0 OP_PUSHBYTES_2 0000)");
563 _ => panic!("Unexpected event"),
568 fn test_segwit_v0_shutdown_script() {
569 let mut config = UserConfig::default();
570 config.channel_options.announced_channel = true;
571 config.peer_channel_config_limits.force_announced_channel_preference = false;
572 config.channel_options.commit_upfront_shutdown_pubkey = false;
573 let user_cfgs = [None, Some(config), None];
574 let chanmon_cfgs = create_chanmon_cfgs(3);
575 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
576 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
577 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
579 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
580 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
581 check_added_monitors!(nodes[1], 1);
583 // Use a segwit v0 script supported even without option_shutdown_anysegwit
584 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
585 node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
586 .push_slice(&[0; 20])
588 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
590 let events = nodes[0].node.get_and_clear_pending_msg_events();
591 assert_eq!(events.len(), 2);
593 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
594 _ => panic!("Unexpected event"),
597 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
598 _ => panic!("Unexpected event"),
603 fn test_anysegwit_shutdown_script() {
604 let mut config = UserConfig::default();
605 config.channel_options.announced_channel = true;
606 config.peer_channel_config_limits.force_announced_channel_preference = false;
607 config.channel_options.commit_upfront_shutdown_pubkey = false;
608 let user_cfgs = [None, Some(config), None];
609 let chanmon_cfgs = create_chanmon_cfgs(3);
610 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
611 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
612 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
614 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
615 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
616 check_added_monitors!(nodes[1], 1);
618 // Use a non-v0 segwit script supported by option_shutdown_anysegwit
619 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
620 node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
623 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
625 let events = nodes[0].node.get_and_clear_pending_msg_events();
626 assert_eq!(events.len(), 2);
628 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
629 _ => panic!("Unexpected event"),
632 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
633 _ => panic!("Unexpected event"),
638 fn test_unsupported_anysegwit_shutdown_script() {
639 let mut config = UserConfig::default();
640 config.channel_options.announced_channel = true;
641 config.peer_channel_config_limits.force_announced_channel_preference = false;
642 config.channel_options.commit_upfront_shutdown_pubkey = false;
643 let user_cfgs = [None, Some(config), None];
644 let chanmon_cfgs = create_chanmon_cfgs(3);
645 let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
646 node_cfgs[0].features = InitFeatures::known().clear_shutdown_anysegwit();
647 node_cfgs[1].features = InitFeatures::known().clear_shutdown_anysegwit();
648 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
649 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
651 // Check that using an unsupported shutdown script fails and a supported one succeeds.
652 let supported_shutdown_script = chanmon_cfgs[1].keys_manager.get_shutdown_scriptpubkey();
653 let unsupported_shutdown_script =
654 ShutdownScript::new_witness_program(NonZeroU8::new(16).unwrap(), &[0, 40]).unwrap();
655 chanmon_cfgs[1].keys_manager
656 .expect(OnGetShutdownScriptpubkey { returns: unsupported_shutdown_script.clone() })
657 .expect(OnGetShutdownScriptpubkey { returns: supported_shutdown_script });
659 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, node_cfgs[0].features.clone(), node_cfgs[1].features.clone());
660 match nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()) {
661 Err(APIError::IncompatibleShutdownScript { script }) => {
662 assert_eq!(script.into_inner(), unsupported_shutdown_script.clone().into_inner());
664 Err(e) => panic!("Unexpected error: {:?}", e),
665 Ok(_) => panic!("Expected error"),
667 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
668 check_added_monitors!(nodes[1], 1);
670 // Use a non-v0 segwit script unsupported without option_shutdown_anysegwit
671 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
672 node_0_shutdown.scriptpubkey = unsupported_shutdown_script.into_inner();
673 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_cfgs[1].features, &node_0_shutdown);
675 assert_eq!(&check_warn_msg!(nodes[0], nodes[1].node.get_our_node_id(), chan.2),
676 "Got a nonstandard scriptpubkey (60020028) from remote peer");
680 fn test_invalid_shutdown_script() {
681 let mut config = UserConfig::default();
682 config.channel_options.announced_channel = true;
683 config.peer_channel_config_limits.force_announced_channel_preference = false;
684 config.channel_options.commit_upfront_shutdown_pubkey = false;
685 let user_cfgs = [None, Some(config), None];
686 let chanmon_cfgs = create_chanmon_cfgs(3);
687 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
688 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
689 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
691 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
692 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
693 check_added_monitors!(nodes[1], 1);
695 // Use a segwit v0 script with an unsupported witness program
696 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
697 node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
700 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
702 assert_eq!(&check_warn_msg!(nodes[0], nodes[1].node.get_our_node_id(), chan.2),
703 "Got a nonstandard scriptpubkey (00020000) from remote peer");
713 fn do_test_closing_signed_reinit_timeout(timeout_step: TimeoutStep) {
714 // The range-based closing signed negotiation allows the funder to restart the process with a
715 // new range if the previous range did not overlap. This allows implementations to request user
716 // intervention allowing users to enter a new fee range. We do not implement the sending side
717 // of this, instead opting to allow users to enter an explicit "willing to pay up to X to avoid
718 // force-closing" value and relying on that instead.
720 // Here we run test the fundee side of that restart mechanism, implementing the funder side of
722 let chanmon_cfgs = create_chanmon_cfgs(2);
723 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
724 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
725 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
726 let chan_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
728 send_payment(&nodes[0], &[&nodes[1]], 8_000_000);
730 nodes[0].node.close_channel(&chan_id).unwrap();
731 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
732 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
733 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
734 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
737 // Now we set nodes[1] to require a relatively high feerate for closing. This should result
738 // in it rejecting nodes[0]'s initial closing_signed, giving nodes[0] a chance to try
740 let mut feerate_lock = chanmon_cfgs[1].fee_estimator.sat_per_kw.lock().unwrap();
744 let mut node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
745 // nodes[0] should use a "reasonable" feerate, well under the 10 sat/vByte that nodes[1] thinks
746 // is the current prevailing feerate.
747 assert!(node_0_closing_signed.fee_satoshis <= 500);
749 if timeout_step != TimeoutStep::AfterShutdown {
750 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
751 assert!(check_warn_msg!(nodes[1], nodes[0].node.get_our_node_id(), chan_id)
752 .starts_with("Unable to come to consensus about closing feerate"));
754 // Now deliver a mutated closing_signed indicating a higher acceptable fee range, which
755 // nodes[1] should happily accept and respond to.
756 node_0_closing_signed.fee_range.as_mut().unwrap().max_fee_satoshis *= 10;
759 get_channel_ref!(nodes[0], lock, chan_id).closing_fee_limits.as_mut().unwrap().1 *= 10;
761 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
762 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
763 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
764 let node_0_2nd_closing_signed = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
765 if timeout_step == TimeoutStep::NoTimeout {
766 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.1.unwrap());
767 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
769 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
772 if timeout_step != TimeoutStep::NoTimeout {
773 assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
775 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
778 nodes[1].node.timer_tick_occurred();
779 nodes[1].node.timer_tick_occurred();
781 let txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
782 assert_eq!(txn.len(), 1);
783 assert_eq!(txn[0].output.len(), 2);
785 if timeout_step != TimeoutStep::NoTimeout {
786 assert!((txn[0].output[0].script_pubkey.is_v0_p2wpkh() &&
787 txn[0].output[1].script_pubkey.is_v0_p2wsh()) ||
788 (txn[0].output[1].script_pubkey.is_v0_p2wpkh() &&
789 txn[0].output[0].script_pubkey.is_v0_p2wsh()));
790 check_closed_broadcast!(nodes[1], true);
791 check_added_monitors!(nodes[1], 1);
792 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "closing_signed negotiation failed to finish within two timer ticks".to_string() });
794 assert!(txn[0].output[0].script_pubkey.is_v0_p2wpkh());
795 assert!(txn[0].output[1].script_pubkey.is_v0_p2wpkh());
797 let events = nodes[1].node.get_and_clear_pending_msg_events();
798 assert_eq!(events.len(), 1);
800 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
801 assert_eq!(msg.contents.flags & 2, 2);
803 _ => panic!("Unexpected event"),
809 fn test_closing_signed_reinit_timeout() {
810 do_test_closing_signed_reinit_timeout(TimeoutStep::AfterShutdown);
811 do_test_closing_signed_reinit_timeout(TimeoutStep::AfterClosingSigned);
812 do_test_closing_signed_reinit_timeout(TimeoutStep::NoTimeout);
815 fn do_simple_legacy_shutdown_test(high_initiator_fee: bool) {
816 // A simpe test of the legacy shutdown fee negotiation logic.
817 let chanmon_cfgs = create_chanmon_cfgs(2);
818 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
819 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
820 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
822 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
824 if high_initiator_fee {
825 // If high_initiator_fee is set, set nodes[0]'s feerate significantly higher. This
826 // shouldn't impact the flow at all given nodes[1] will happily accept the higher fee.
827 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
831 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
832 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
833 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
834 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
835 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
837 let mut node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
838 node_0_closing_signed.fee_range = None;
839 if high_initiator_fee {
840 assert!(node_0_closing_signed.fee_satoshis > 500);
842 assert!(node_0_closing_signed.fee_satoshis < 500);
845 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
846 let (_, mut node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
847 node_1_closing_signed.as_mut().unwrap().fee_range = None;
849 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
850 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
851 assert!(node_0_none.is_none());
852 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
853 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
857 fn simple_legacy_shutdown_test() {
858 do_simple_legacy_shutdown_test(false);
859 do_simple_legacy_shutdown_test(true);
863 fn simple_target_feerate_shutdown() {
864 // Simple test of target in `close_channel_with_target_feerate`.
865 let chanmon_cfgs = create_chanmon_cfgs(2);
866 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
867 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
868 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
870 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
871 let chan_id = OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id();
873 nodes[0].node.close_channel_with_target_feerate(&chan_id, 253 * 10).unwrap();
874 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
875 nodes[1].node.close_channel_with_target_feerate(&chan_id, 253 * 5).unwrap();
876 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
878 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
879 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
881 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
882 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
883 let (_, node_1_closing_signed_opt) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
884 let node_1_closing_signed = node_1_closing_signed_opt.unwrap();
886 // nodes[1] was passed a target which was larger than the current channel feerate, which it
887 // should ignore in favor of the channel fee, as there is no use demanding a minimum higher
888 // than what will be paid on a force-close transaction. Note that we have to consider rounding,
889 // so only check that we're within 10 sats.
890 assert!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis >=
891 node_1_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis * 10 - 5);
892 assert!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis <=
893 node_1_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis * 10 + 5);
895 // Further, because nodes[0]'s target fee is larger than the `Normal` fee estimation plus our
896 // force-closure-avoidance buffer, min should equal max, and the nodes[1]-selected fee should
897 // be the nodes[0] only available fee.
898 assert_eq!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis,
899 node_0_closing_signed.fee_range.as_ref().unwrap().max_fee_satoshis);
900 assert_eq!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis,
901 node_0_closing_signed.fee_satoshis);
902 assert_eq!(node_0_closing_signed.fee_satoshis, node_1_closing_signed.fee_satoshis);
904 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
905 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
906 assert!(node_0_none.is_none());
907 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
908 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);