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::router::get_route;
17 use routing::network_graph::NetworkUpdate;
18 use routing::scorer::Scorer;
19 use ln::features::{InitFeatures, InvoiceFeatures};
21 use ln::msgs::{ChannelMessageHandler, ErrorAction};
22 use ln::script::ShutdownScript;
24 use util::test_utils::OnGetShutdownScriptpubkey;
25 use util::events::{Event, MessageSendEvent, MessageSendEventsProvider, ClosureReason};
26 use util::errors::APIError;
27 use util::config::UserConfig;
29 use bitcoin::blockdata::script::Builder;
30 use bitcoin::blockdata::opcodes;
32 use bitcoin::hashes::sha256::Hash as Sha256;
33 use bitcoin::hashes::Hash;
37 use core::default::Default;
38 use core::num::NonZeroU8;
40 use ln::functional_test_utils::*;
41 use ln::msgs::OptionalField::Present;
44 fn pre_funding_lock_shutdown_test() {
45 // Test sending a shutdown prior to funding_locked after funding generation
46 let chanmon_cfgs = create_chanmon_cfgs(2);
47 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
48 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
49 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
50 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0, InitFeatures::known(), InitFeatures::known());
51 mine_transaction(&nodes[0], &tx);
52 mine_transaction(&nodes[1], &tx);
54 nodes[0].node.close_channel(&OutPoint { txid: tx.txid(), index: 0 }.to_channel_id()).unwrap();
55 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
56 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
57 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
58 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
60 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
61 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
62 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
63 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
64 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
65 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
66 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
67 assert!(node_1_none.is_none());
69 assert!(nodes[0].node.list_channels().is_empty());
70 assert!(nodes[1].node.list_channels().is_empty());
71 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
72 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
76 fn updates_shutdown_wait() {
77 // Test sending a shutdown with outstanding updates pending
78 let chanmon_cfgs = create_chanmon_cfgs(3);
79 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
80 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
81 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
82 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
83 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
84 let logger = test_utils::TestLogger::new();
85 let scorer = Scorer::new(0);
87 let (our_payment_preimage, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
89 nodes[0].node.close_channel(&chan_1.2).unwrap();
90 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
91 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
92 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
93 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
95 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
96 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
98 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
100 let net_graph_msg_handler0 = &nodes[0].net_graph_msg_handler;
101 let net_graph_msg_handler1 = &nodes[1].net_graph_msg_handler;
102 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, &scorer).unwrap();
103 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, &scorer).unwrap();
104 unwrap_send_err!(nodes[0].node.send_payment(&route_1, payment_hash, &Some(payment_secret)), true, APIError::ChannelUnavailable {..}, {});
105 unwrap_send_err!(nodes[1].node.send_payment(&route_2, payment_hash, &Some(payment_secret)), true, APIError::ChannelUnavailable {..}, {});
107 assert!(nodes[2].node.claim_funds(our_payment_preimage));
108 check_added_monitors!(nodes[2], 1);
109 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
110 assert!(updates.update_add_htlcs.is_empty());
111 assert!(updates.update_fail_htlcs.is_empty());
112 assert!(updates.update_fail_malformed_htlcs.is_empty());
113 assert!(updates.update_fee.is_none());
114 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
115 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
116 expect_payment_forwarded!(nodes[1], Some(1000), false);
117 check_added_monitors!(nodes[1], 1);
118 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
119 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
121 assert!(updates_2.update_add_htlcs.is_empty());
122 assert!(updates_2.update_fail_htlcs.is_empty());
123 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
124 assert!(updates_2.update_fee.is_none());
125 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
126 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
127 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
129 let events = nodes[0].node.get_and_clear_pending_events();
130 assert_eq!(events.len(), 1);
132 Event::PaymentSent { ref payment_preimage, ref payment_hash } => {
133 assert_eq!(our_payment_preimage, *payment_preimage);
134 assert_eq!(our_payment_hash, *payment_hash);
136 _ => panic!("Unexpected event"),
139 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
140 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
141 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
142 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
143 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
144 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
145 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
146 assert!(node_1_none.is_none());
147 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
148 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
150 assert!(nodes[0].node.list_channels().is_empty());
152 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
153 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
154 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
155 assert!(nodes[1].node.list_channels().is_empty());
156 assert!(nodes[2].node.list_channels().is_empty());
157 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
158 check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure);
162 fn htlc_fail_async_shutdown() {
163 // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
164 let chanmon_cfgs = create_chanmon_cfgs(3);
165 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
166 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
167 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
168 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
169 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
171 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], 100000);
172 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
173 check_added_monitors!(nodes[0], 1);
174 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
175 assert_eq!(updates.update_add_htlcs.len(), 1);
176 assert!(updates.update_fulfill_htlcs.is_empty());
177 assert!(updates.update_fail_htlcs.is_empty());
178 assert!(updates.update_fail_malformed_htlcs.is_empty());
179 assert!(updates.update_fee.is_none());
181 nodes[1].node.close_channel(&chan_1.2).unwrap();
182 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
183 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
184 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
186 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
187 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
188 check_added_monitors!(nodes[1], 1);
189 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
190 commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
192 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
193 assert!(updates_2.update_add_htlcs.is_empty());
194 assert!(updates_2.update_fulfill_htlcs.is_empty());
195 assert_eq!(updates_2.update_fail_htlcs.len(), 1);
196 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
197 assert!(updates_2.update_fee.is_none());
199 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]);
200 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
202 expect_payment_failed_with_update!(nodes[0], our_payment_hash, false, chan_2.0.contents.short_channel_id, true);
204 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
205 assert_eq!(msg_events.len(), 1);
206 let node_0_closing_signed = match msg_events[0] {
207 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
208 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
211 _ => panic!("Unexpected event"),
214 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
215 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
216 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
217 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
218 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
219 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
220 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
221 assert!(node_1_none.is_none());
223 assert!(nodes[0].node.list_channels().is_empty());
225 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
226 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
227 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
228 assert!(nodes[1].node.list_channels().is_empty());
229 assert!(nodes[2].node.list_channels().is_empty());
230 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
231 check_closed_event!(nodes[1], 2, ClosureReason::CooperativeClosure);
232 check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure);
235 fn do_test_shutdown_rebroadcast(recv_count: u8) {
236 // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
237 // messages delivered prior to disconnect
238 let chanmon_cfgs = create_chanmon_cfgs(3);
239 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
240 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
241 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
242 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
243 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
245 let (our_payment_preimage, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
247 nodes[1].node.close_channel(&chan_1.2).unwrap();
248 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
250 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
251 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
253 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
257 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
258 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
260 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
261 let node_0_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
262 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
263 let node_1_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
265 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish);
266 let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
267 assert!(node_1_shutdown == node_1_2nd_shutdown);
269 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish);
270 let node_0_2nd_shutdown = if recv_count > 0 {
271 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
272 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_2nd_shutdown);
275 let node_0_chan_update = get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
276 assert_eq!(node_0_chan_update.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
277 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_2nd_shutdown);
278 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
280 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_2nd_shutdown);
282 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
283 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
285 assert!(nodes[2].node.claim_funds(our_payment_preimage));
286 check_added_monitors!(nodes[2], 1);
287 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
288 assert!(updates.update_add_htlcs.is_empty());
289 assert!(updates.update_fail_htlcs.is_empty());
290 assert!(updates.update_fail_malformed_htlcs.is_empty());
291 assert!(updates.update_fee.is_none());
292 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
293 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
294 expect_payment_forwarded!(nodes[1], Some(1000), false);
295 check_added_monitors!(nodes[1], 1);
296 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
297 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
299 assert!(updates_2.update_add_htlcs.is_empty());
300 assert!(updates_2.update_fail_htlcs.is_empty());
301 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
302 assert!(updates_2.update_fee.is_none());
303 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
304 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
305 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
307 let events = nodes[0].node.get_and_clear_pending_events();
308 assert_eq!(events.len(), 1);
310 Event::PaymentSent { ref payment_preimage, ref payment_hash } => {
311 assert_eq!(our_payment_preimage, *payment_preimage);
312 assert_eq!(our_payment_hash, *payment_hash);
314 _ => panic!("Unexpected event"),
317 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
319 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
320 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
321 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
322 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
323 assert!(node_0_2nd_closing_signed.is_some());
326 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
327 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
329 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
330 let node_1_2nd_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
331 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
333 // If all closing_signeds weren't delivered we can just resume where we left off...
334 let node_0_2nd_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
336 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
337 let node_0_msgs = nodes[0].node.get_and_clear_pending_msg_events();
338 assert_eq!(node_0_msgs.len(), 2);
339 let node_0_2nd_closing_signed = match node_0_msgs[1] {
340 MessageSendEvent::SendClosingSigned { ref msg, .. } => {
341 assert_eq!(node_0_closing_signed, *msg);
347 let node_0_3rd_shutdown = match node_0_msgs[0] {
348 MessageSendEvent::SendShutdown { ref msg, .. } => {
349 assert_eq!(node_0_2nd_shutdown, *msg);
354 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
356 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
357 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
358 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
360 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_3rd_shutdown);
361 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
363 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_3rd_shutdown);
365 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed);
366 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
367 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
368 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
369 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
370 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
371 assert!(node_1_none.is_none());
372 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
374 // If one node, however, received + responded with an identical closing_signed we end
375 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
376 // There isn't really anything better we can do simply, but in the future we might
377 // explore storing a set of recently-closed channels that got disconnected during
378 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
379 // give our counterparty enough time to (potentially) broadcast a cooperative closing
381 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
383 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
384 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
385 assert_eq!(msg_events.len(), 1);
386 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
388 &ErrorAction::SendErrorMessage { ref msg } => {
389 nodes[1].node.handle_error(&nodes[0].node.get_our_node_id(), &msg);
390 assert_eq!(msg.channel_id, chan_1.2);
392 _ => panic!("Unexpected event!"),
394 } else { panic!("Needed SendErrorMessage close"); }
396 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
397 // checks it, but in this case nodes[1] didn't ever get a chance to receive a
398 // closing_signed so we do it ourselves
399 check_closed_broadcast!(nodes[1], false);
400 check_added_monitors!(nodes[1], 1);
401 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyForceClosed { peer_msg: "Failed to find corresponding channel".to_string() });
404 assert!(nodes[0].node.list_channels().is_empty());
406 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
407 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
408 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
409 assert!(nodes[1].node.list_channels().is_empty());
410 assert!(nodes[2].node.list_channels().is_empty());
411 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
412 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
413 check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure);
417 fn test_shutdown_rebroadcast() {
418 do_test_shutdown_rebroadcast(0);
419 do_test_shutdown_rebroadcast(1);
420 do_test_shutdown_rebroadcast(2);
424 fn test_upfront_shutdown_script() {
425 // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
426 // enforce it at shutdown message
428 let mut config = UserConfig::default();
429 config.channel_options.announced_channel = true;
430 config.peer_channel_config_limits.force_announced_channel_preference = false;
431 config.channel_options.commit_upfront_shutdown_pubkey = false;
432 let user_cfgs = [None, Some(config), None];
433 let chanmon_cfgs = create_chanmon_cfgs(3);
434 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
435 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
436 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
438 // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
439 let flags = InitFeatures::known();
440 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
441 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
442 let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
443 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
444 // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that we disconnect peer
445 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
446 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()));
447 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() });
448 check_added_monitors!(nodes[2], 1);
450 // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
451 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
452 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
453 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
454 // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
455 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
456 let events = nodes[2].node.get_and_clear_pending_msg_events();
457 assert_eq!(events.len(), 1);
459 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
460 _ => panic!("Unexpected event"),
463 // We test that if case of peer non-signaling we don't enforce committed script at channel opening
464 let flags_no = InitFeatures::known().clear_upfront_shutdown_script();
465 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
466 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
467 let node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
468 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
469 check_added_monitors!(nodes[1], 1);
470 let events = nodes[1].node.get_and_clear_pending_msg_events();
471 assert_eq!(events.len(), 1);
473 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
474 _ => panic!("Unexpected event"),
477 // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
478 // channel smoothly, opt-out is from channel initiator here
479 let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
480 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
481 check_added_monitors!(nodes[1], 1);
482 let node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
483 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
484 let events = nodes[0].node.get_and_clear_pending_msg_events();
485 assert_eq!(events.len(), 1);
487 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
488 _ => panic!("Unexpected event"),
491 //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
492 //// channel smoothly
493 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
494 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
495 check_added_monitors!(nodes[1], 1);
496 let node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
497 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
498 let events = nodes[0].node.get_and_clear_pending_msg_events();
499 assert_eq!(events.len(), 2);
501 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
502 _ => panic!("Unexpected event"),
505 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
506 _ => panic!("Unexpected event"),
511 fn test_unsupported_anysegwit_upfront_shutdown_script() {
512 let chanmon_cfgs = create_chanmon_cfgs(2);
513 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
514 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
515 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
517 // Use a non-v0 segwit script supported by option_shutdown_anysegwit
518 let node_features = InitFeatures::known().clear_shutdown_anysegwit();
519 let anysegwit_shutdown_script = Builder::new()
521 .push_slice(&[0, 40])
524 // Check script when handling an open_channel message
525 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
526 let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
527 open_channel.shutdown_scriptpubkey = Present(anysegwit_shutdown_script.clone());
528 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), node_features.clone(), &open_channel);
530 let events = nodes[1].node.get_and_clear_pending_msg_events();
531 assert_eq!(events.len(), 1);
533 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
534 assert_eq!(node_id, nodes[0].node.get_our_node_id());
535 assert_eq!(msg.data, "Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: Script(OP_PUSHNUM_16 OP_PUSHBYTES_2 0028)");
537 _ => panic!("Unexpected event"),
540 // Check script when handling an accept_channel message
541 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
542 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
543 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
544 let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
545 accept_channel.shutdown_scriptpubkey = Present(anysegwit_shutdown_script.clone());
546 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), node_features, &accept_channel);
548 let events = nodes[0].node.get_and_clear_pending_msg_events();
549 assert_eq!(events.len(), 1);
551 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
552 assert_eq!(node_id, nodes[1].node.get_our_node_id());
553 assert_eq!(msg.data, "Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: Script(OP_PUSHNUM_16 OP_PUSHBYTES_2 0028)");
555 _ => panic!("Unexpected event"),
557 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() });
561 fn test_invalid_upfront_shutdown_script() {
562 let chanmon_cfgs = create_chanmon_cfgs(2);
563 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
564 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
565 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
567 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
569 // Use a segwit v0 script with an unsupported witness program
570 let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
571 open_channel.shutdown_scriptpubkey = Present(Builder::new().push_int(0)
574 nodes[0].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
576 let events = nodes[0].node.get_and_clear_pending_msg_events();
577 assert_eq!(events.len(), 1);
579 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
580 assert_eq!(node_id, nodes[0].node.get_our_node_id());
581 assert_eq!(msg.data, "Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: Script(OP_0 OP_PUSHBYTES_2 0000)");
583 _ => panic!("Unexpected event"),
588 fn test_segwit_v0_shutdown_script() {
589 let mut config = UserConfig::default();
590 config.channel_options.announced_channel = true;
591 config.peer_channel_config_limits.force_announced_channel_preference = false;
592 config.channel_options.commit_upfront_shutdown_pubkey = false;
593 let user_cfgs = [None, Some(config), None];
594 let chanmon_cfgs = create_chanmon_cfgs(3);
595 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
596 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
597 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
599 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
600 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
601 check_added_monitors!(nodes[1], 1);
603 // Use a segwit v0 script supported even without option_shutdown_anysegwit
604 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
605 node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
606 .push_slice(&[0; 20])
608 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
610 let events = nodes[0].node.get_and_clear_pending_msg_events();
611 assert_eq!(events.len(), 2);
613 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
614 _ => panic!("Unexpected event"),
617 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
618 _ => panic!("Unexpected event"),
623 fn test_anysegwit_shutdown_script() {
624 let mut config = UserConfig::default();
625 config.channel_options.announced_channel = true;
626 config.peer_channel_config_limits.force_announced_channel_preference = false;
627 config.channel_options.commit_upfront_shutdown_pubkey = false;
628 let user_cfgs = [None, Some(config), None];
629 let chanmon_cfgs = create_chanmon_cfgs(3);
630 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
631 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
632 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
634 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
635 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
636 check_added_monitors!(nodes[1], 1);
638 // Use a non-v0 segwit script supported by option_shutdown_anysegwit
639 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
640 node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
643 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
645 let events = nodes[0].node.get_and_clear_pending_msg_events();
646 assert_eq!(events.len(), 2);
648 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
649 _ => panic!("Unexpected event"),
652 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
653 _ => panic!("Unexpected event"),
658 fn test_unsupported_anysegwit_shutdown_script() {
659 let mut config = UserConfig::default();
660 config.channel_options.announced_channel = true;
661 config.peer_channel_config_limits.force_announced_channel_preference = false;
662 config.channel_options.commit_upfront_shutdown_pubkey = false;
663 let user_cfgs = [None, Some(config), None];
664 let chanmon_cfgs = create_chanmon_cfgs(3);
665 let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
666 node_cfgs[0].features = InitFeatures::known().clear_shutdown_anysegwit();
667 node_cfgs[1].features = InitFeatures::known().clear_shutdown_anysegwit();
668 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
669 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
671 // Check that using an unsupported shutdown script fails and a supported one succeeds.
672 let supported_shutdown_script = chanmon_cfgs[1].keys_manager.get_shutdown_scriptpubkey();
673 let unsupported_shutdown_script =
674 ShutdownScript::new_witness_program(NonZeroU8::new(16).unwrap(), &[0, 40]).unwrap();
675 chanmon_cfgs[1].keys_manager
676 .expect(OnGetShutdownScriptpubkey { returns: unsupported_shutdown_script.clone() })
677 .expect(OnGetShutdownScriptpubkey { returns: supported_shutdown_script });
679 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, node_cfgs[0].features.clone(), node_cfgs[1].features.clone());
680 match nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()) {
681 Err(APIError::IncompatibleShutdownScript { script }) => {
682 assert_eq!(script.into_inner(), unsupported_shutdown_script.clone().into_inner());
684 Err(e) => panic!("Unexpected error: {:?}", e),
685 Ok(_) => panic!("Expected error"),
687 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
688 check_added_monitors!(nodes[1], 1);
690 // Use a non-v0 segwit script unsupported without option_shutdown_anysegwit
691 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
692 node_0_shutdown.scriptpubkey = unsupported_shutdown_script.into_inner();
693 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_cfgs[1].features, &node_0_shutdown);
695 let events = nodes[0].node.get_and_clear_pending_msg_events();
696 assert_eq!(events.len(), 2);
698 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
699 assert_eq!(node_id, nodes[1].node.get_our_node_id());
700 assert_eq!(msg.data, "Got a nonstandard scriptpubkey (60020028) from remote peer".to_owned());
702 _ => panic!("Unexpected event"),
704 check_added_monitors!(nodes[0], 1);
705 check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: "Got a nonstandard scriptpubkey (60020028) from remote peer".to_string() });
709 fn test_invalid_shutdown_script() {
710 let mut config = UserConfig::default();
711 config.channel_options.announced_channel = true;
712 config.peer_channel_config_limits.force_announced_channel_preference = false;
713 config.channel_options.commit_upfront_shutdown_pubkey = false;
714 let user_cfgs = [None, Some(config), None];
715 let chanmon_cfgs = create_chanmon_cfgs(3);
716 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
717 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
718 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
720 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
721 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
722 check_added_monitors!(nodes[1], 1);
724 // Use a segwit v0 script with an unsupported witness program
725 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
726 node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
729 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
731 let events = nodes[0].node.get_and_clear_pending_msg_events();
732 assert_eq!(events.len(), 2);
734 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
735 assert_eq!(node_id, nodes[1].node.get_our_node_id());
736 assert_eq!(msg.data, "Got a nonstandard scriptpubkey (00020000) from remote peer".to_owned())
738 _ => panic!("Unexpected event"),
740 check_added_monitors!(nodes[0], 1);
741 check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: "Got a nonstandard scriptpubkey (00020000) from remote peer".to_string() });
751 fn do_test_closing_signed_reinit_timeout(timeout_step: TimeoutStep) {
752 // The range-based closing signed negotiation allows the funder to restart the process with a
753 // new range if the previous range did not overlap. This allows implementations to request user
754 // intervention allowing users to enter a new fee range. We do not implement the sending side
755 // of this, instead opting to allow users to enter an explicit "willing to pay up to X to avoid
756 // force-closing" value and relying on that instead.
758 // Here we run test the fundee side of that restart mechanism, implementing the funder side of
760 let chanmon_cfgs = create_chanmon_cfgs(2);
761 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
762 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
763 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
764 let chan_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
766 send_payment(&nodes[0], &[&nodes[1]], 8_000_000);
768 nodes[0].node.close_channel(&chan_id).unwrap();
769 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
770 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
771 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
772 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
775 // Now we set nodes[1] to require a relatively high feerate for closing. This should result
776 // in it rejecting nodes[0]'s initial closing_signed, giving nodes[0] a chance to try
778 let mut feerate_lock = chanmon_cfgs[1].fee_estimator.sat_per_kw.lock().unwrap();
782 let mut node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
783 // nodes[0] should use a "reasonable" feerate, well under the 10 sat/vByte that nodes[1] thinks
784 // is the current prevailing feerate.
785 assert!(node_0_closing_signed.fee_satoshis <= 500);
787 if timeout_step != TimeoutStep::AfterShutdown {
788 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
789 // At this point nodes[1] should send back a warning message indicating it disagrees with the
790 // given channel-closing fee. Currently we do not implement warning messages so instead we
791 // remain silent here.
792 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
794 // Now deliver a mutated closing_signed indicating a higher acceptable fee range, which
795 // nodes[1] should happily accept and respond to.
796 node_0_closing_signed.fee_range.as_mut().unwrap().max_fee_satoshis *= 10;
799 get_channel_ref!(nodes[0], lock, chan_id).closing_fee_limits.as_mut().unwrap().1 *= 10;
801 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
802 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
803 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
804 let node_0_2nd_closing_signed = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
805 if timeout_step == TimeoutStep::NoTimeout {
806 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.1.unwrap());
807 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
809 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
812 if timeout_step != TimeoutStep::NoTimeout {
813 assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
815 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
818 nodes[1].node.timer_tick_occurred();
819 nodes[1].node.timer_tick_occurred();
821 let txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
822 assert_eq!(txn.len(), 1);
823 assert_eq!(txn[0].output.len(), 2);
825 if timeout_step != TimeoutStep::NoTimeout {
826 assert!((txn[0].output[0].script_pubkey.is_v0_p2wpkh() &&
827 txn[0].output[1].script_pubkey.is_v0_p2wsh()) ||
828 (txn[0].output[1].script_pubkey.is_v0_p2wpkh() &&
829 txn[0].output[0].script_pubkey.is_v0_p2wsh()));
830 check_closed_broadcast!(nodes[1], true);
831 check_added_monitors!(nodes[1], 1);
832 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "closing_signed negotiation failed to finish within two timer ticks".to_string() });
834 assert!(txn[0].output[0].script_pubkey.is_v0_p2wpkh());
835 assert!(txn[0].output[1].script_pubkey.is_v0_p2wpkh());
837 let events = nodes[1].node.get_and_clear_pending_msg_events();
838 assert_eq!(events.len(), 1);
840 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
841 assert_eq!(msg.contents.flags & 2, 2);
843 _ => panic!("Unexpected event"),
849 fn test_closing_signed_reinit_timeout() {
850 do_test_closing_signed_reinit_timeout(TimeoutStep::AfterShutdown);
851 do_test_closing_signed_reinit_timeout(TimeoutStep::AfterClosingSigned);
852 do_test_closing_signed_reinit_timeout(TimeoutStep::NoTimeout);
855 fn do_simple_legacy_shutdown_test(high_initiator_fee: bool) {
856 // A simpe test of the legacy shutdown fee negotiation logic.
857 let chanmon_cfgs = create_chanmon_cfgs(2);
858 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
859 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
860 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
862 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
864 if high_initiator_fee {
865 // If high_initiator_fee is set, set nodes[0]'s feerate significantly higher. This
866 // shouldn't impact the flow at all given nodes[1] will happily accept the higher fee.
867 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
871 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
872 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
873 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
874 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
875 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
877 let mut node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
878 node_0_closing_signed.fee_range = None;
879 if high_initiator_fee {
880 assert!(node_0_closing_signed.fee_satoshis > 500);
882 assert!(node_0_closing_signed.fee_satoshis < 500);
885 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
886 let (_, mut node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
887 node_1_closing_signed.as_mut().unwrap().fee_range = None;
889 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
890 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
891 assert!(node_0_none.is_none());
892 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
893 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
897 fn simple_legacy_shutdown_test() {
898 do_simple_legacy_shutdown_test(false);
899 do_simple_legacy_shutdown_test(true);
903 fn simple_target_feerate_shutdown() {
904 // Simple test of target in `close_channel_with_target_feerate`.
905 let chanmon_cfgs = create_chanmon_cfgs(2);
906 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
907 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
908 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
910 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
911 let chan_id = OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id();
913 nodes[0].node.close_channel_with_target_feerate(&chan_id, 253 * 10).unwrap();
914 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
915 nodes[1].node.close_channel_with_target_feerate(&chan_id, 253 * 5).unwrap();
916 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
918 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
919 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
921 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
922 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
923 let (_, node_1_closing_signed_opt) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
924 let node_1_closing_signed = node_1_closing_signed_opt.unwrap();
926 // nodes[1] was passed a target which was larger than the current channel feerate, which it
927 // should ignore in favor of the channel fee, as there is no use demanding a minimum higher
928 // than what will be paid on a force-close transaction. Note that we have to consider rounding,
929 // so only check that we're within 10 sats.
930 assert!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis >=
931 node_1_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis * 10 - 5);
932 assert!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis <=
933 node_1_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis * 10 + 5);
935 // Further, because nodes[0]'s target fee is larger than the `Normal` fee estimation plus our
936 // force-closure-avoidance buffer, min should equal max, and the nodes[1]-selected fee should
937 // be the nodes[0] only available fee.
938 assert_eq!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis,
939 node_0_closing_signed.fee_range.as_ref().unwrap().max_fee_satoshis);
940 assert_eq!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis,
941 node_0_closing_signed.fee_satoshis);
942 assert_eq!(node_0_closing_signed.fee_satoshis, node_1_closing_signed.fee_satoshis);
944 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
945 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
946 assert!(node_0_none.is_none());
947 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
948 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);