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::{PaymentPreimage, PaymentHash};
15 use ln::channelmanager::PaymentSendFailure;
16 use routing::network_graph::NetworkUpdate;
17 use routing::router::get_route;
18 use ln::features::{InitFeatures, InvoiceFeatures};
20 use ln::msgs::{ChannelMessageHandler, ErrorAction};
21 use ln::script::ShutdownScript;
23 use util::test_utils::OnGetShutdownScriptpubkey;
24 use util::events::{Event, MessageSendEvent, MessageSendEventsProvider, ClosureReason};
25 use util::errors::APIError;
26 use util::config::UserConfig;
28 use bitcoin::blockdata::script::Builder;
29 use bitcoin::blockdata::opcodes;
31 use bitcoin::hashes::sha256::Hash as Sha256;
32 use bitcoin::hashes::Hash;
36 use core::default::Default;
37 use core::num::NonZeroU8;
39 use ln::functional_test_utils::*;
40 use ln::msgs::OptionalField::Present;
43 fn pre_funding_lock_shutdown_test() {
44 // Test sending a shutdown prior to funding_locked after funding generation
45 let chanmon_cfgs = create_chanmon_cfgs(2);
46 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
47 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
48 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
49 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0, InitFeatures::known(), InitFeatures::known());
50 mine_transaction(&nodes[0], &tx);
51 mine_transaction(&nodes[1], &tx);
53 nodes[0].node.close_channel(&OutPoint { txid: tx.txid(), index: 0 }.to_channel_id()).unwrap();
54 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
55 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
56 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
57 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
59 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
60 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
61 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
62 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
63 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
64 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
65 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
66 assert!(node_1_none.is_none());
68 assert!(nodes[0].node.list_channels().is_empty());
69 assert!(nodes[1].node.list_channels().is_empty());
70 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
71 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
75 fn updates_shutdown_wait() {
76 // Test sending a shutdown with outstanding updates pending
77 let chanmon_cfgs = create_chanmon_cfgs(3);
78 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
79 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
80 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
81 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
82 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
83 let logger = test_utils::TestLogger::new();
85 let (our_payment_preimage, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
87 nodes[0].node.close_channel(&chan_1.2).unwrap();
88 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
89 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
90 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
91 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
93 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
94 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
96 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
98 let net_graph_msg_handler0 = &nodes[0].net_graph_msg_handler;
99 let net_graph_msg_handler1 = &nodes[1].net_graph_msg_handler;
100 let route_1 = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler0.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
101 let route_2 = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler1.network_graph, &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
102 unwrap_send_err!(nodes[0].node.send_payment(&route_1, payment_hash, &Some(payment_secret)), true, APIError::ChannelUnavailable {..}, {});
103 unwrap_send_err!(nodes[1].node.send_payment(&route_2, payment_hash, &Some(payment_secret)), true, APIError::ChannelUnavailable {..}, {});
105 assert!(nodes[2].node.claim_funds(our_payment_preimage));
106 check_added_monitors!(nodes[2], 1);
107 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
108 assert!(updates.update_add_htlcs.is_empty());
109 assert!(updates.update_fail_htlcs.is_empty());
110 assert!(updates.update_fail_malformed_htlcs.is_empty());
111 assert!(updates.update_fee.is_none());
112 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
113 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
114 expect_payment_forwarded!(nodes[1], Some(1000), false);
115 check_added_monitors!(nodes[1], 1);
116 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
117 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
119 assert!(updates_2.update_add_htlcs.is_empty());
120 assert!(updates_2.update_fail_htlcs.is_empty());
121 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
122 assert!(updates_2.update_fee.is_none());
123 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
124 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
125 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
127 let events = nodes[0].node.get_and_clear_pending_events();
128 assert_eq!(events.len(), 1);
130 Event::PaymentSent { ref payment_preimage, ref payment_hash } => {
131 assert_eq!(our_payment_preimage, *payment_preimage);
132 assert_eq!(our_payment_hash, *payment_hash);
134 _ => panic!("Unexpected event"),
137 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
138 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
139 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
140 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
141 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
142 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
143 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
144 assert!(node_1_none.is_none());
145 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
146 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
148 assert!(nodes[0].node.list_channels().is_empty());
150 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
151 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
152 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
153 assert!(nodes[1].node.list_channels().is_empty());
154 assert!(nodes[2].node.list_channels().is_empty());
155 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
156 check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure);
160 fn htlc_fail_async_shutdown() {
161 // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
162 let chanmon_cfgs = create_chanmon_cfgs(3);
163 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
164 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
165 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
166 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
167 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
168 let logger = test_utils::TestLogger::new();
170 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
171 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
172 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
173 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
174 check_added_monitors!(nodes[0], 1);
175 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
176 assert_eq!(updates.update_add_htlcs.len(), 1);
177 assert!(updates.update_fulfill_htlcs.is_empty());
178 assert!(updates.update_fail_htlcs.is_empty());
179 assert!(updates.update_fail_malformed_htlcs.is_empty());
180 assert!(updates.update_fee.is_none());
182 nodes[1].node.close_channel(&chan_1.2).unwrap();
183 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
184 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
185 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
187 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
188 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
189 check_added_monitors!(nodes[1], 1);
190 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
191 commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
193 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
194 assert!(updates_2.update_add_htlcs.is_empty());
195 assert!(updates_2.update_fulfill_htlcs.is_empty());
196 assert_eq!(updates_2.update_fail_htlcs.len(), 1);
197 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
198 assert!(updates_2.update_fee.is_none());
200 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]);
201 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
203 expect_payment_failed_with_update!(nodes[0], our_payment_hash, false, chan_2.0.contents.short_channel_id, true);
205 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
206 assert_eq!(msg_events.len(), 1);
207 let node_0_closing_signed = match msg_events[0] {
208 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
209 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
212 _ => panic!("Unexpected event"),
215 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
216 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
217 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
218 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
219 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
220 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
221 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
222 assert!(node_1_none.is_none());
224 assert!(nodes[0].node.list_channels().is_empty());
226 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
227 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
228 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
229 assert!(nodes[1].node.list_channels().is_empty());
230 assert!(nodes[2].node.list_channels().is_empty());
231 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
232 check_closed_event!(nodes[1], 2, ClosureReason::CooperativeClosure);
233 check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure);
236 fn do_test_shutdown_rebroadcast(recv_count: u8) {
237 // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
238 // messages delivered prior to disconnect
239 let chanmon_cfgs = create_chanmon_cfgs(3);
240 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
241 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
242 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
243 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
244 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
246 let (our_payment_preimage, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
248 nodes[1].node.close_channel(&chan_1.2).unwrap();
249 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
251 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
252 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
254 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
258 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
259 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
261 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
262 let node_0_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
263 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
264 let node_1_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
266 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish);
267 let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
268 assert!(node_1_shutdown == node_1_2nd_shutdown);
270 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish);
271 let node_0_2nd_shutdown = if recv_count > 0 {
272 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
273 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_2nd_shutdown);
276 let node_0_chan_update = get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
277 assert_eq!(node_0_chan_update.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
278 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_2nd_shutdown);
279 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
281 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_2nd_shutdown);
283 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
284 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
286 assert!(nodes[2].node.claim_funds(our_payment_preimage));
287 check_added_monitors!(nodes[2], 1);
288 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
289 assert!(updates.update_add_htlcs.is_empty());
290 assert!(updates.update_fail_htlcs.is_empty());
291 assert!(updates.update_fail_malformed_htlcs.is_empty());
292 assert!(updates.update_fee.is_none());
293 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
294 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
295 expect_payment_forwarded!(nodes[1], Some(1000), false);
296 check_added_monitors!(nodes[1], 1);
297 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
298 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
300 assert!(updates_2.update_add_htlcs.is_empty());
301 assert!(updates_2.update_fail_htlcs.is_empty());
302 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
303 assert!(updates_2.update_fee.is_none());
304 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
305 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
306 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
308 let events = nodes[0].node.get_and_clear_pending_events();
309 assert_eq!(events.len(), 1);
311 Event::PaymentSent { ref payment_preimage, ref payment_hash } => {
312 assert_eq!(our_payment_preimage, *payment_preimage);
313 assert_eq!(our_payment_hash, *payment_hash);
315 _ => panic!("Unexpected event"),
318 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
320 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
321 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
322 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
323 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
324 assert!(node_0_2nd_closing_signed.is_some());
327 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
328 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
330 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
331 let node_1_2nd_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
332 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
334 // If all closing_signeds weren't delivered we can just resume where we left off...
335 let node_0_2nd_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
337 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
338 let node_0_msgs = nodes[0].node.get_and_clear_pending_msg_events();
339 assert_eq!(node_0_msgs.len(), 2);
340 let node_0_2nd_closing_signed = match node_0_msgs[1] {
341 MessageSendEvent::SendClosingSigned { ref msg, .. } => {
342 assert_eq!(node_0_closing_signed, *msg);
348 let node_0_3rd_shutdown = match node_0_msgs[0] {
349 MessageSendEvent::SendShutdown { ref msg, .. } => {
350 assert_eq!(node_0_2nd_shutdown, *msg);
355 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
357 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
358 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
359 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
361 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_3rd_shutdown);
362 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
364 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_3rd_shutdown);
366 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed);
367 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
368 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
369 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
370 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
371 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
372 assert!(node_1_none.is_none());
373 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
375 // If one node, however, received + responded with an identical closing_signed we end
376 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
377 // There isn't really anything better we can do simply, but in the future we might
378 // explore storing a set of recently-closed channels that got disconnected during
379 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
380 // give our counterparty enough time to (potentially) broadcast a cooperative closing
382 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
384 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
385 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
386 assert_eq!(msg_events.len(), 1);
387 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
389 &ErrorAction::SendErrorMessage { ref msg } => {
390 nodes[1].node.handle_error(&nodes[0].node.get_our_node_id(), &msg);
391 assert_eq!(msg.channel_id, chan_1.2);
393 _ => panic!("Unexpected event!"),
395 } else { panic!("Needed SendErrorMessage close"); }
397 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
398 // checks it, but in this case nodes[1] didn't ever get a chance to receive a
399 // closing_signed so we do it ourselves
400 check_closed_broadcast!(nodes[1], false);
401 check_added_monitors!(nodes[1], 1);
402 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyForceClosed { peer_msg: "Failed to find corresponding channel".to_string() });
405 assert!(nodes[0].node.list_channels().is_empty());
407 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
408 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
409 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
410 assert!(nodes[1].node.list_channels().is_empty());
411 assert!(nodes[2].node.list_channels().is_empty());
412 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
413 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
414 check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure);
418 fn test_shutdown_rebroadcast() {
419 do_test_shutdown_rebroadcast(0);
420 do_test_shutdown_rebroadcast(1);
421 do_test_shutdown_rebroadcast(2);
425 fn test_upfront_shutdown_script() {
426 // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
427 // enforce it at shutdown message
429 let mut config = UserConfig::default();
430 config.channel_options.announced_channel = true;
431 config.peer_channel_config_limits.force_announced_channel_preference = false;
432 config.channel_options.commit_upfront_shutdown_pubkey = false;
433 let user_cfgs = [None, Some(config), None];
434 let chanmon_cfgs = create_chanmon_cfgs(3);
435 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
436 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
437 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
439 // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
440 let flags = InitFeatures::known();
441 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
442 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
443 let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
444 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
445 // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that we disconnect peer
446 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
447 assert!(regex::Regex::new(r"Got shutdown request with a scriptpubkey \([A-Fa-f0-9]+\) which did not match their previous scriptpubkey.").unwrap().is_match(check_closed_broadcast!(nodes[2], true).unwrap().data.as_str()));
448 check_closed_event!(nodes[2], 1, ClosureReason::ProcessingError { err: "Got shutdown request with a scriptpubkey (a91441c98a140039816273e50db317422c11c2bfcc8887) which did not match their previous scriptpubkey.".to_string() });
449 check_added_monitors!(nodes[2], 1);
451 // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
452 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
453 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
454 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
455 // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
456 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
457 let events = nodes[2].node.get_and_clear_pending_msg_events();
458 assert_eq!(events.len(), 1);
460 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
461 _ => panic!("Unexpected event"),
464 // We test that if case of peer non-signaling we don't enforce committed script at channel opening
465 let flags_no = InitFeatures::known().clear_upfront_shutdown_script();
466 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
467 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
468 let node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
469 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
470 check_added_monitors!(nodes[1], 1);
471 let events = nodes[1].node.get_and_clear_pending_msg_events();
472 assert_eq!(events.len(), 1);
474 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
475 _ => panic!("Unexpected event"),
478 // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
479 // channel smoothly, opt-out is from channel initiator here
480 let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
481 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
482 check_added_monitors!(nodes[1], 1);
483 let node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
484 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
485 let events = nodes[0].node.get_and_clear_pending_msg_events();
486 assert_eq!(events.len(), 1);
488 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
489 _ => panic!("Unexpected event"),
492 //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
493 //// channel smoothly
494 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
495 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
496 check_added_monitors!(nodes[1], 1);
497 let node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
498 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
499 let events = nodes[0].node.get_and_clear_pending_msg_events();
500 assert_eq!(events.len(), 2);
502 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
503 _ => panic!("Unexpected event"),
506 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
507 _ => panic!("Unexpected event"),
512 fn test_unsupported_anysegwit_upfront_shutdown_script() {
513 let chanmon_cfgs = create_chanmon_cfgs(2);
514 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
515 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
516 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
518 // Use a non-v0 segwit script supported by option_shutdown_anysegwit
519 let node_features = InitFeatures::known().clear_shutdown_anysegwit();
520 let anysegwit_shutdown_script = Builder::new()
522 .push_slice(&[0, 40])
525 // Check script when handling an open_channel message
526 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
527 let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
528 open_channel.shutdown_scriptpubkey = Present(anysegwit_shutdown_script.clone());
529 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), node_features.clone(), &open_channel);
531 let events = nodes[1].node.get_and_clear_pending_msg_events();
532 assert_eq!(events.len(), 1);
534 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
535 assert_eq!(node_id, nodes[0].node.get_our_node_id());
536 assert_eq!(msg.data, "Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: Script(OP_PUSHNUM_16 OP_PUSHBYTES_2 0028)");
538 _ => panic!("Unexpected event"),
541 // Check script when handling an accept_channel message
542 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
543 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
544 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
545 let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
546 accept_channel.shutdown_scriptpubkey = Present(anysegwit_shutdown_script.clone());
547 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), node_features, &accept_channel);
549 let events = nodes[0].node.get_and_clear_pending_msg_events();
550 assert_eq!(events.len(), 1);
552 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
553 assert_eq!(node_id, nodes[1].node.get_our_node_id());
554 assert_eq!(msg.data, "Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: Script(OP_PUSHNUM_16 OP_PUSHBYTES_2 0028)");
556 _ => panic!("Unexpected event"),
558 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() });
562 fn test_invalid_upfront_shutdown_script() {
563 let chanmon_cfgs = create_chanmon_cfgs(2);
564 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
565 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
566 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
568 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
570 // Use a segwit v0 script with an unsupported witness program
571 let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
572 open_channel.shutdown_scriptpubkey = Present(Builder::new().push_int(0)
575 nodes[0].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
577 let events = nodes[0].node.get_and_clear_pending_msg_events();
578 assert_eq!(events.len(), 1);
580 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
581 assert_eq!(node_id, nodes[0].node.get_our_node_id());
582 assert_eq!(msg.data, "Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: Script(OP_0 OP_PUSHBYTES_2 0000)");
584 _ => panic!("Unexpected event"),
589 fn test_segwit_v0_shutdown_script() {
590 let mut config = UserConfig::default();
591 config.channel_options.announced_channel = true;
592 config.peer_channel_config_limits.force_announced_channel_preference = false;
593 config.channel_options.commit_upfront_shutdown_pubkey = false;
594 let user_cfgs = [None, Some(config), None];
595 let chanmon_cfgs = create_chanmon_cfgs(3);
596 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
597 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
598 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
600 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
601 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
602 check_added_monitors!(nodes[1], 1);
604 // Use a segwit v0 script supported even without option_shutdown_anysegwit
605 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
606 node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
607 .push_slice(&[0; 20])
609 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
611 let events = nodes[0].node.get_and_clear_pending_msg_events();
612 assert_eq!(events.len(), 2);
614 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
615 _ => panic!("Unexpected event"),
618 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
619 _ => panic!("Unexpected event"),
624 fn test_anysegwit_shutdown_script() {
625 let mut config = UserConfig::default();
626 config.channel_options.announced_channel = true;
627 config.peer_channel_config_limits.force_announced_channel_preference = false;
628 config.channel_options.commit_upfront_shutdown_pubkey = false;
629 let user_cfgs = [None, Some(config), None];
630 let chanmon_cfgs = create_chanmon_cfgs(3);
631 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
632 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
633 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
635 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
636 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
637 check_added_monitors!(nodes[1], 1);
639 // Use a non-v0 segwit script supported by option_shutdown_anysegwit
640 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
641 node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
644 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
646 let events = nodes[0].node.get_and_clear_pending_msg_events();
647 assert_eq!(events.len(), 2);
649 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
650 _ => panic!("Unexpected event"),
653 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
654 _ => panic!("Unexpected event"),
659 fn test_unsupported_anysegwit_shutdown_script() {
660 let mut config = UserConfig::default();
661 config.channel_options.announced_channel = true;
662 config.peer_channel_config_limits.force_announced_channel_preference = false;
663 config.channel_options.commit_upfront_shutdown_pubkey = false;
664 let user_cfgs = [None, Some(config), None];
665 let chanmon_cfgs = create_chanmon_cfgs(3);
666 let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
667 node_cfgs[0].features = InitFeatures::known().clear_shutdown_anysegwit();
668 node_cfgs[1].features = InitFeatures::known().clear_shutdown_anysegwit();
669 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
670 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
672 // Check that using an unsupported shutdown script fails and a supported one succeeds.
673 let supported_shutdown_script = chanmon_cfgs[1].keys_manager.get_shutdown_scriptpubkey();
674 let unsupported_shutdown_script =
675 ShutdownScript::new_witness_program(NonZeroU8::new(16).unwrap(), &[0, 40]).unwrap();
676 chanmon_cfgs[1].keys_manager
677 .expect(OnGetShutdownScriptpubkey { returns: unsupported_shutdown_script.clone() })
678 .expect(OnGetShutdownScriptpubkey { returns: supported_shutdown_script });
680 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, node_cfgs[0].features.clone(), node_cfgs[1].features.clone());
681 match nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()) {
682 Err(APIError::IncompatibleShutdownScript { script }) => {
683 assert_eq!(script.into_inner(), unsupported_shutdown_script.clone().into_inner());
685 Err(e) => panic!("Unexpected error: {:?}", e),
686 Ok(_) => panic!("Expected error"),
688 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
689 check_added_monitors!(nodes[1], 1);
691 // Use a non-v0 segwit script unsupported without option_shutdown_anysegwit
692 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
693 node_0_shutdown.scriptpubkey = unsupported_shutdown_script.into_inner();
694 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_cfgs[1].features, &node_0_shutdown);
696 let events = nodes[0].node.get_and_clear_pending_msg_events();
697 assert_eq!(events.len(), 2);
699 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
700 assert_eq!(node_id, nodes[1].node.get_our_node_id());
701 assert_eq!(msg.data, "Got a nonstandard scriptpubkey (60020028) from remote peer".to_owned());
703 _ => panic!("Unexpected event"),
705 check_added_monitors!(nodes[0], 1);
706 check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: "Got a nonstandard scriptpubkey (60020028) from remote peer".to_string() });
710 fn test_invalid_shutdown_script() {
711 let mut config = UserConfig::default();
712 config.channel_options.announced_channel = true;
713 config.peer_channel_config_limits.force_announced_channel_preference = false;
714 config.channel_options.commit_upfront_shutdown_pubkey = false;
715 let user_cfgs = [None, Some(config), None];
716 let chanmon_cfgs = create_chanmon_cfgs(3);
717 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
718 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
719 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
721 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
722 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
723 check_added_monitors!(nodes[1], 1);
725 // Use a segwit v0 script with an unsupported witness program
726 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
727 node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
730 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
732 let events = nodes[0].node.get_and_clear_pending_msg_events();
733 assert_eq!(events.len(), 2);
735 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
736 assert_eq!(node_id, nodes[1].node.get_our_node_id());
737 assert_eq!(msg.data, "Got a nonstandard scriptpubkey (00020000) from remote peer".to_owned())
739 _ => panic!("Unexpected event"),
741 check_added_monitors!(nodes[0], 1);
742 check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: "Got a nonstandard scriptpubkey (00020000) from remote peer".to_string() });
752 fn do_test_closing_signed_reinit_timeout(timeout_step: TimeoutStep) {
753 // The range-based closing signed negotiation allows the funder to restart the process with a
754 // new range if the previous range did not overlap. This allows implementations to request user
755 // intervention allowing users to enter a new fee range. We do not implement the sending side
756 // of this, instead opting to allow users to enter an explicit "willing to pay up to X to avoid
757 // force-closing" value and relying on that instead.
759 // Here we run test the fundee side of that restart mechanism, implementing the funder side of
761 let chanmon_cfgs = create_chanmon_cfgs(2);
762 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
763 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
764 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
765 let chan_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
767 send_payment(&nodes[0], &[&nodes[1]], 8_000_000);
769 nodes[0].node.close_channel(&chan_id).unwrap();
770 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
771 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
772 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
773 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
776 // Now we set nodes[1] to require a relatively high feerate for closing. This should result
777 // in it rejecting nodes[0]'s initial closing_signed, giving nodes[0] a chance to try
779 let mut feerate_lock = chanmon_cfgs[1].fee_estimator.sat_per_kw.lock().unwrap();
783 let mut node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
784 // nodes[0] should use a "reasonable" feerate, well under the 10 sat/vByte that nodes[1] thinks
785 // is the current prevailing feerate.
786 assert!(node_0_closing_signed.fee_satoshis <= 500);
788 if timeout_step != TimeoutStep::AfterShutdown {
789 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
790 // At this point nodes[1] should send back a warning message indicating it disagrees with the
791 // given channel-closing fee. Currently we do not implement warning messages so instead we
792 // remain silent here.
793 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
795 // Now deliver a mutated closing_signed indicating a higher acceptable fee range, which
796 // nodes[1] should happily accept and respond to.
797 node_0_closing_signed.fee_range.as_mut().unwrap().max_fee_satoshis *= 10;
800 get_channel_ref!(nodes[0], lock, chan_id).closing_fee_limits.as_mut().unwrap().1 *= 10;
802 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
803 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
804 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
805 let node_0_2nd_closing_signed = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
806 if timeout_step == TimeoutStep::NoTimeout {
807 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.1.unwrap());
808 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
810 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
813 if timeout_step != TimeoutStep::NoTimeout {
814 assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
816 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
819 nodes[1].node.timer_tick_occurred();
820 nodes[1].node.timer_tick_occurred();
822 let txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
823 assert_eq!(txn.len(), 1);
824 assert_eq!(txn[0].output.len(), 2);
826 if timeout_step != TimeoutStep::NoTimeout {
827 assert!((txn[0].output[0].script_pubkey.is_v0_p2wpkh() &&
828 txn[0].output[1].script_pubkey.is_v0_p2wsh()) ||
829 (txn[0].output[1].script_pubkey.is_v0_p2wpkh() &&
830 txn[0].output[0].script_pubkey.is_v0_p2wsh()));
831 check_closed_broadcast!(nodes[1], true);
832 check_added_monitors!(nodes[1], 1);
833 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "closing_signed negotiation failed to finish within two timer ticks".to_string() });
835 assert!(txn[0].output[0].script_pubkey.is_v0_p2wpkh());
836 assert!(txn[0].output[1].script_pubkey.is_v0_p2wpkh());
838 let events = nodes[1].node.get_and_clear_pending_msg_events();
839 assert_eq!(events.len(), 1);
841 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
842 assert_eq!(msg.contents.flags & 2, 2);
844 _ => panic!("Unexpected event"),
850 fn test_closing_signed_reinit_timeout() {
851 do_test_closing_signed_reinit_timeout(TimeoutStep::AfterShutdown);
852 do_test_closing_signed_reinit_timeout(TimeoutStep::AfterClosingSigned);
853 do_test_closing_signed_reinit_timeout(TimeoutStep::NoTimeout);
856 fn do_simple_legacy_shutdown_test(high_initiator_fee: bool) {
857 // A simpe test of the legacy shutdown fee negotiation logic.
858 let chanmon_cfgs = create_chanmon_cfgs(2);
859 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
860 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
861 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
863 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
865 if high_initiator_fee {
866 // If high_initiator_fee is set, set nodes[0]'s feerate significantly higher. This
867 // shouldn't impact the flow at all given nodes[1] will happily accept the higher fee.
868 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
872 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
873 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
874 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
875 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
876 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
878 let mut node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
879 node_0_closing_signed.fee_range = None;
880 if high_initiator_fee {
881 assert!(node_0_closing_signed.fee_satoshis > 500);
883 assert!(node_0_closing_signed.fee_satoshis < 500);
886 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
887 let (_, mut node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
888 node_1_closing_signed.as_mut().unwrap().fee_range = None;
890 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
891 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
892 assert!(node_0_none.is_none());
893 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
894 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
898 fn simple_legacy_shutdown_test() {
899 do_simple_legacy_shutdown_test(false);
900 do_simple_legacy_shutdown_test(true);
904 fn simple_target_feerate_shutdown() {
905 // Simple test of target in `close_channel_with_target_feerate`.
906 let chanmon_cfgs = create_chanmon_cfgs(2);
907 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
908 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
909 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
911 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
912 let chan_id = OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id();
914 nodes[0].node.close_channel_with_target_feerate(&chan_id, 253 * 10).unwrap();
915 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
916 nodes[1].node.close_channel_with_target_feerate(&chan_id, 253 * 5).unwrap();
917 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
919 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
920 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
922 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
923 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
924 let (_, node_1_closing_signed_opt) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
925 let node_1_closing_signed = node_1_closing_signed_opt.unwrap();
927 // nodes[1] was passed a target which was larger than the current channel feerate, which it
928 // should ignore in favor of the channel fee, as there is no use demanding a minimum higher
929 // than what will be paid on a force-close transaction. Note that we have to consider rounding,
930 // so only check that we're within 10 sats.
931 assert!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis >=
932 node_1_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis * 10 - 5);
933 assert!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis <=
934 node_1_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis * 10 + 5);
936 // Further, because nodes[0]'s target fee is larger than the `Normal` fee estimation plus our
937 // force-closure-avoidance buffer, min should equal max, and the nodes[1]-selected fee should
938 // be the nodes[0] only available fee.
939 assert_eq!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis,
940 node_0_closing_signed.fee_range.as_ref().unwrap().max_fee_satoshis);
941 assert_eq!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis,
942 node_0_closing_signed.fee_satoshis);
943 assert_eq!(node_0_closing_signed.fee_satoshis, node_1_closing_signed.fee_satoshis);
945 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
946 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
947 assert!(node_0_none.is_none());
948 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
949 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);