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 ln::features::{InitFeatures, InvoiceFeatures};
19 use ln::msgs::{ChannelMessageHandler, ErrorAction};
20 use ln::script::ShutdownScript;
22 use util::test_utils::OnGetShutdownScriptpubkey;
23 use util::events::{Event, MessageSendEvent, MessageSendEventsProvider};
24 use util::errors::APIError;
25 use util::config::UserConfig;
27 use bitcoin::blockdata::script::Builder;
28 use bitcoin::blockdata::opcodes;
30 use bitcoin::hashes::sha256::Hash as Sha256;
31 use bitcoin::hashes::Hash;
35 use core::default::Default;
36 use core::num::NonZeroU8;
38 use ln::functional_test_utils::*;
39 use ln::msgs::OptionalField::Present;
42 fn pre_funding_lock_shutdown_test() {
43 // Test sending a shutdown prior to funding_locked after funding generation
44 let chanmon_cfgs = create_chanmon_cfgs(2);
45 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
46 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
47 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
48 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0, InitFeatures::known(), InitFeatures::known());
49 mine_transaction(&nodes[0], &tx);
50 mine_transaction(&nodes[1], &tx);
52 nodes[0].node.close_channel(&OutPoint { txid: tx.txid(), index: 0 }.to_channel_id()).unwrap();
53 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
54 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
55 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
56 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
58 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
59 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
60 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
61 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
62 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
63 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
64 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
65 assert!(node_1_none.is_none());
67 assert!(nodes[0].node.list_channels().is_empty());
68 assert!(nodes[1].node.list_channels().is_empty());
72 fn updates_shutdown_wait() {
73 // Test sending a shutdown with outstanding updates pending
74 let chanmon_cfgs = create_chanmon_cfgs(3);
75 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
76 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
77 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
78 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
79 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
80 let logger = test_utils::TestLogger::new();
82 let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
84 nodes[0].node.close_channel(&chan_1.2).unwrap();
85 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
86 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
87 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
88 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
90 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
91 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
93 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
95 let net_graph_msg_handler0 = &nodes[0].net_graph_msg_handler;
96 let net_graph_msg_handler1 = &nodes[1].net_graph_msg_handler;
97 let route_1 = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler0.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
98 let route_2 = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler1.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
99 unwrap_send_err!(nodes[0].node.send_payment(&route_1, payment_hash, &Some(payment_secret)), true, APIError::ChannelUnavailable {..}, {});
100 unwrap_send_err!(nodes[1].node.send_payment(&route_2, payment_hash, &Some(payment_secret)), true, APIError::ChannelUnavailable {..}, {});
102 assert!(nodes[2].node.claim_funds(our_payment_preimage));
103 check_added_monitors!(nodes[2], 1);
104 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
105 assert!(updates.update_add_htlcs.is_empty());
106 assert!(updates.update_fail_htlcs.is_empty());
107 assert!(updates.update_fail_malformed_htlcs.is_empty());
108 assert!(updates.update_fee.is_none());
109 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
110 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
111 expect_payment_forwarded!(nodes[1], Some(1000), false);
112 check_added_monitors!(nodes[1], 1);
113 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
114 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
116 assert!(updates_2.update_add_htlcs.is_empty());
117 assert!(updates_2.update_fail_htlcs.is_empty());
118 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
119 assert!(updates_2.update_fee.is_none());
120 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
121 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
122 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
124 let events = nodes[0].node.get_and_clear_pending_events();
125 assert_eq!(events.len(), 1);
127 Event::PaymentSent { ref payment_preimage } => {
128 assert_eq!(our_payment_preimage, *payment_preimage);
130 _ => panic!("Unexpected event"),
133 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
134 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
135 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
136 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
137 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
138 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
139 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
140 assert!(node_1_none.is_none());
142 assert!(nodes[0].node.list_channels().is_empty());
144 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
145 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
146 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
147 assert!(nodes[1].node.list_channels().is_empty());
148 assert!(nodes[2].node.list_channels().is_empty());
152 fn htlc_fail_async_shutdown() {
153 // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
154 let chanmon_cfgs = create_chanmon_cfgs(3);
155 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
156 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
157 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
158 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
159 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
160 let logger = test_utils::TestLogger::new();
162 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
163 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
164 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
165 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
166 check_added_monitors!(nodes[0], 1);
167 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
168 assert_eq!(updates.update_add_htlcs.len(), 1);
169 assert!(updates.update_fulfill_htlcs.is_empty());
170 assert!(updates.update_fail_htlcs.is_empty());
171 assert!(updates.update_fail_malformed_htlcs.is_empty());
172 assert!(updates.update_fee.is_none());
174 nodes[1].node.close_channel(&chan_1.2).unwrap();
175 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
176 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
177 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
179 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
180 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
181 check_added_monitors!(nodes[1], 1);
182 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
183 commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
185 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
186 assert!(updates_2.update_add_htlcs.is_empty());
187 assert!(updates_2.update_fulfill_htlcs.is_empty());
188 assert_eq!(updates_2.update_fail_htlcs.len(), 1);
189 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
190 assert!(updates_2.update_fee.is_none());
192 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]);
193 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
195 expect_payment_failed!(nodes[0], our_payment_hash, false);
197 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
198 assert_eq!(msg_events.len(), 2);
199 match msg_events[0] {
200 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
201 assert_eq!(msg.contents.short_channel_id, chan_1.0.contents.short_channel_id);
203 _ => panic!("Unexpected event"),
205 let node_0_closing_signed = match msg_events[1] {
206 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
207 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
210 _ => panic!("Unexpected event"),
213 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
214 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
215 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
216 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
217 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
218 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
219 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
220 assert!(node_1_none.is_none());
222 assert!(nodes[0].node.list_channels().is_empty());
224 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
225 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
226 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
227 assert!(nodes[1].node.list_channels().is_empty());
228 assert!(nodes[2].node.list_channels().is_empty());
231 fn do_test_shutdown_rebroadcast(recv_count: u8) {
232 // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
233 // messages delivered prior to disconnect
234 let chanmon_cfgs = create_chanmon_cfgs(3);
235 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
236 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
237 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
238 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
239 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
241 let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
243 nodes[1].node.close_channel(&chan_1.2).unwrap();
244 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
246 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
247 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
249 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
253 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
254 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
256 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
257 let node_0_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
258 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
259 let node_1_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
261 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish);
262 let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
263 assert!(node_1_shutdown == node_1_2nd_shutdown);
265 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish);
266 let node_0_2nd_shutdown = if recv_count > 0 {
267 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
268 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_2nd_shutdown);
271 let node_0_chan_update = get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
272 assert_eq!(node_0_chan_update.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
273 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_2nd_shutdown);
274 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
276 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_2nd_shutdown);
278 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
279 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
281 assert!(nodes[2].node.claim_funds(our_payment_preimage));
282 check_added_monitors!(nodes[2], 1);
283 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
284 assert!(updates.update_add_htlcs.is_empty());
285 assert!(updates.update_fail_htlcs.is_empty());
286 assert!(updates.update_fail_malformed_htlcs.is_empty());
287 assert!(updates.update_fee.is_none());
288 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
289 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
290 expect_payment_forwarded!(nodes[1], Some(1000), false);
291 check_added_monitors!(nodes[1], 1);
292 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
293 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
295 assert!(updates_2.update_add_htlcs.is_empty());
296 assert!(updates_2.update_fail_htlcs.is_empty());
297 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
298 assert!(updates_2.update_fee.is_none());
299 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
300 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
301 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
303 let events = nodes[0].node.get_and_clear_pending_events();
304 assert_eq!(events.len(), 1);
306 Event::PaymentSent { ref payment_preimage } => {
307 assert_eq!(our_payment_preimage, *payment_preimage);
309 _ => panic!("Unexpected event"),
312 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
314 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
315 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
316 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
317 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
318 assert!(node_0_2nd_closing_signed.is_some());
321 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
322 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
324 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
325 let node_1_2nd_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
326 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
328 // If all closing_signeds weren't delivered we can just resume where we left off...
329 let node_0_2nd_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
331 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
332 let node_0_msgs = nodes[0].node.get_and_clear_pending_msg_events();
333 assert_eq!(node_0_msgs.len(), 2);
334 let node_0_2nd_closing_signed = match node_0_msgs[1] {
335 MessageSendEvent::SendClosingSigned { ref msg, .. } => {
336 assert_eq!(node_0_closing_signed, *msg);
342 let node_0_3rd_shutdown = match node_0_msgs[0] {
343 MessageSendEvent::SendShutdown { ref msg, .. } => {
344 assert_eq!(node_0_2nd_shutdown, *msg);
349 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
351 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
352 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
353 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
355 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_3rd_shutdown);
356 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
358 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_3rd_shutdown);
360 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed);
361 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
362 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
363 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
364 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
365 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
366 assert!(node_1_none.is_none());
368 // If one node, however, received + responded with an identical closing_signed we end
369 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
370 // There isn't really anything better we can do simply, but in the future we might
371 // explore storing a set of recently-closed channels that got disconnected during
372 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
373 // give our counterparty enough time to (potentially) broadcast a cooperative closing
375 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
377 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
378 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
379 assert_eq!(msg_events.len(), 1);
380 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
382 &ErrorAction::SendErrorMessage { ref msg } => {
383 nodes[1].node.handle_error(&nodes[0].node.get_our_node_id(), &msg);
384 assert_eq!(msg.channel_id, chan_1.2);
386 _ => panic!("Unexpected event!"),
388 } else { panic!("Needed SendErrorMessage close"); }
390 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
391 // checks it, but in this case nodes[1] didn't ever get a chance to receive a
392 // closing_signed so we do it ourselves
393 check_closed_broadcast!(nodes[1], false);
394 check_added_monitors!(nodes[1], 1);
397 assert!(nodes[0].node.list_channels().is_empty());
399 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
400 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
401 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
402 assert!(nodes[1].node.list_channels().is_empty());
403 assert!(nodes[2].node.list_channels().is_empty());
407 fn test_shutdown_rebroadcast() {
408 do_test_shutdown_rebroadcast(0);
409 do_test_shutdown_rebroadcast(1);
410 do_test_shutdown_rebroadcast(2);
414 fn test_upfront_shutdown_script() {
415 // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
416 // enforce it at shutdown message
418 let mut config = UserConfig::default();
419 config.channel_options.announced_channel = true;
420 config.peer_channel_config_limits.force_announced_channel_preference = false;
421 config.channel_options.commit_upfront_shutdown_pubkey = false;
422 let user_cfgs = [None, Some(config), None];
423 let chanmon_cfgs = create_chanmon_cfgs(3);
424 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
425 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
426 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
428 // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
429 let flags = InitFeatures::known();
430 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
431 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
432 let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
433 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
434 // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that we disconnect peer
435 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
436 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()));
437 check_added_monitors!(nodes[2], 1);
439 // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
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 node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
443 // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
444 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
445 let events = nodes[2].node.get_and_clear_pending_msg_events();
446 assert_eq!(events.len(), 1);
448 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
449 _ => panic!("Unexpected event"),
452 // We test that if case of peer non-signaling we don't enforce committed script at channel opening
453 let flags_no = InitFeatures::known().clear_upfront_shutdown_script();
454 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
455 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
456 let node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
457 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
458 check_added_monitors!(nodes[1], 1);
459 let events = nodes[1].node.get_and_clear_pending_msg_events();
460 assert_eq!(events.len(), 1);
462 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
463 _ => panic!("Unexpected event"),
466 // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
467 // channel smoothly, opt-out is from channel initiator here
468 let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
469 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
470 check_added_monitors!(nodes[1], 1);
471 let node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
472 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
473 let events = nodes[0].node.get_and_clear_pending_msg_events();
474 assert_eq!(events.len(), 1);
476 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
477 _ => panic!("Unexpected event"),
480 //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
481 //// channel smoothly
482 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
483 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
484 check_added_monitors!(nodes[1], 1);
485 let node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
486 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
487 let events = nodes[0].node.get_and_clear_pending_msg_events();
488 assert_eq!(events.len(), 2);
490 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
491 _ => panic!("Unexpected event"),
494 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
495 _ => panic!("Unexpected event"),
500 fn test_unsupported_anysegwit_upfront_shutdown_script() {
501 let chanmon_cfgs = create_chanmon_cfgs(2);
502 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
503 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
504 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
506 // Use a non-v0 segwit script supported by option_shutdown_anysegwit
507 let node_features = InitFeatures::known().clear_shutdown_anysegwit();
508 let anysegwit_shutdown_script = Builder::new()
510 .push_slice(&[0, 40])
513 // Check script when handling an open_channel message
514 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
515 let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
516 open_channel.shutdown_scriptpubkey = Present(anysegwit_shutdown_script.clone());
517 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), node_features.clone(), &open_channel);
519 let events = nodes[1].node.get_and_clear_pending_msg_events();
520 assert_eq!(events.len(), 1);
522 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
523 assert_eq!(node_id, nodes[0].node.get_our_node_id());
524 assert_eq!(msg.data, "Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: Script(OP_PUSHNUM_16 OP_PUSHBYTES_2 0028)");
526 _ => panic!("Unexpected event"),
529 // Check script when handling an accept_channel message
530 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
531 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
532 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
533 let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
534 accept_channel.shutdown_scriptpubkey = Present(anysegwit_shutdown_script.clone());
535 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), node_features, &accept_channel);
537 let events = nodes[0].node.get_and_clear_pending_msg_events();
538 assert_eq!(events.len(), 1);
540 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
541 assert_eq!(node_id, nodes[1].node.get_our_node_id());
542 assert_eq!(msg.data, "Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: Script(OP_PUSHNUM_16 OP_PUSHBYTES_2 0028)");
544 _ => panic!("Unexpected event"),
549 fn test_invalid_upfront_shutdown_script() {
550 let chanmon_cfgs = create_chanmon_cfgs(2);
551 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
552 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
553 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
555 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
557 // Use a segwit v0 script with an unsupported witness program
558 let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
559 open_channel.shutdown_scriptpubkey = Present(Builder::new().push_int(0)
562 nodes[0].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
564 let events = nodes[0].node.get_and_clear_pending_msg_events();
565 assert_eq!(events.len(), 1);
567 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
568 assert_eq!(node_id, nodes[0].node.get_our_node_id());
569 assert_eq!(msg.data, "Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: Script(OP_0 OP_PUSHBYTES_2 0000)");
571 _ => panic!("Unexpected event"),
576 fn test_segwit_v0_shutdown_script() {
577 let mut config = UserConfig::default();
578 config.channel_options.announced_channel = true;
579 config.peer_channel_config_limits.force_announced_channel_preference = false;
580 config.channel_options.commit_upfront_shutdown_pubkey = false;
581 let user_cfgs = [None, Some(config), None];
582 let chanmon_cfgs = create_chanmon_cfgs(3);
583 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
584 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
585 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
587 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
588 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
589 check_added_monitors!(nodes[1], 1);
591 // Use a segwit v0 script supported even without option_shutdown_anysegwit
592 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
593 node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
594 .push_slice(&[0; 20])
596 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
598 let events = nodes[0].node.get_and_clear_pending_msg_events();
599 assert_eq!(events.len(), 2);
601 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
602 _ => panic!("Unexpected event"),
605 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
606 _ => panic!("Unexpected event"),
611 fn test_anysegwit_shutdown_script() {
612 let mut config = UserConfig::default();
613 config.channel_options.announced_channel = true;
614 config.peer_channel_config_limits.force_announced_channel_preference = false;
615 config.channel_options.commit_upfront_shutdown_pubkey = false;
616 let user_cfgs = [None, Some(config), None];
617 let chanmon_cfgs = create_chanmon_cfgs(3);
618 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
619 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
620 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
622 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
623 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
624 check_added_monitors!(nodes[1], 1);
626 // Use a non-v0 segwit script supported by option_shutdown_anysegwit
627 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
628 node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
631 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
633 let events = nodes[0].node.get_and_clear_pending_msg_events();
634 assert_eq!(events.len(), 2);
636 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
637 _ => panic!("Unexpected event"),
640 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
641 _ => panic!("Unexpected event"),
646 fn test_unsupported_anysegwit_shutdown_script() {
647 let mut config = UserConfig::default();
648 config.channel_options.announced_channel = true;
649 config.peer_channel_config_limits.force_announced_channel_preference = false;
650 config.channel_options.commit_upfront_shutdown_pubkey = false;
651 let user_cfgs = [None, Some(config), None];
652 let chanmon_cfgs = create_chanmon_cfgs(3);
653 let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
654 node_cfgs[0].features = InitFeatures::known().clear_shutdown_anysegwit();
655 node_cfgs[1].features = InitFeatures::known().clear_shutdown_anysegwit();
656 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
657 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
659 // Check that using an unsupported shutdown script fails and a supported one succeeds.
660 let supported_shutdown_script = chanmon_cfgs[1].keys_manager.get_shutdown_scriptpubkey();
661 let unsupported_shutdown_script =
662 ShutdownScript::new_witness_program(NonZeroU8::new(16).unwrap(), &[0, 40]).unwrap();
663 chanmon_cfgs[1].keys_manager
664 .expect(OnGetShutdownScriptpubkey { returns: unsupported_shutdown_script.clone() })
665 .expect(OnGetShutdownScriptpubkey { returns: supported_shutdown_script });
667 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, node_cfgs[0].features.clone(), node_cfgs[1].features.clone());
668 match nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()) {
669 Err(APIError::IncompatibleShutdownScript { script }) => {
670 assert_eq!(script.into_inner(), unsupported_shutdown_script.clone().into_inner());
672 Err(e) => panic!("Unexpected error: {:?}", e),
673 Ok(_) => panic!("Expected error"),
675 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
676 check_added_monitors!(nodes[1], 1);
678 // Use a non-v0 segwit script unsupported without option_shutdown_anysegwit
679 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
680 node_0_shutdown.scriptpubkey = unsupported_shutdown_script.into_inner();
681 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_cfgs[1].features, &node_0_shutdown);
683 let events = nodes[0].node.get_and_clear_pending_msg_events();
684 assert_eq!(events.len(), 2);
686 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
687 assert_eq!(node_id, nodes[1].node.get_our_node_id());
688 assert_eq!(msg.data, "Got a nonstandard scriptpubkey (60020028) from remote peer".to_owned());
690 _ => panic!("Unexpected event"),
692 check_added_monitors!(nodes[0], 1);
696 fn test_invalid_shutdown_script() {
697 let mut config = UserConfig::default();
698 config.channel_options.announced_channel = true;
699 config.peer_channel_config_limits.force_announced_channel_preference = false;
700 config.channel_options.commit_upfront_shutdown_pubkey = false;
701 let user_cfgs = [None, Some(config), None];
702 let chanmon_cfgs = create_chanmon_cfgs(3);
703 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
704 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
705 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
707 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
708 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
709 check_added_monitors!(nodes[1], 1);
711 // Use a segwit v0 script with an unsupported witness program
712 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
713 node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
716 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
718 let events = nodes[0].node.get_and_clear_pending_msg_events();
719 assert_eq!(events.len(), 2);
721 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
722 assert_eq!(node_id, nodes[1].node.get_our_node_id());
723 assert_eq!(msg.data, "Got a nonstandard scriptpubkey (00020000) from remote peer".to_owned())
725 _ => panic!("Unexpected event"),
727 check_added_monitors!(nodes[0], 1);
737 fn do_test_closing_signed_reinit_timeout(timeout_step: TimeoutStep) {
738 // The range-based closing signed negotiation allows the funder to restart the process with a
739 // new range if the previous range did not overlap. This allows implementations to request user
740 // intervention allowing users to enter a new fee range. We do not implement the sending side
741 // of this, instead opting to allow users to enter an explicit "willing to pay up to X to avoid
742 // force-closing" value and relying on that instead.
744 // Here we run test the fundee side of that restart mechanism, implementing the funder side of
746 let chanmon_cfgs = create_chanmon_cfgs(2);
747 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
748 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
749 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
750 let chan_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
752 send_payment(&nodes[0], &[&nodes[1]], 8_000_000);
754 nodes[0].node.close_channel(&chan_id).unwrap();
755 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
756 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
757 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
758 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
761 // Now we set nodes[1] to require a relatively high feerate for closing. This should result
762 // in it rejecting nodes[0]'s initial closing_signed, giving nodes[0] a chance to try
764 let mut feerate_lock = chanmon_cfgs[1].fee_estimator.sat_per_kw.lock().unwrap();
768 let mut node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
769 // nodes[0] should use a "reasonable" feerate, well under the 10 sat/vByte that nodes[1] thinks
770 // is the current prevailing feerate.
771 assert!(node_0_closing_signed.fee_satoshis <= 500);
773 if timeout_step != TimeoutStep::AfterShutdown {
774 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
775 // At this point nodes[1] should send back a warning message indicating it disagrees with the
776 // given channel-closing fee. Currently we do not implement warning messages so instead we
777 // remain silent here.
778 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
780 // Now deliver a mutated closing_signed indicating a higher acceptable fee range, which
781 // nodes[1] should happily accept and respond to.
782 node_0_closing_signed.fee_range.as_mut().unwrap().max_fee_satoshis *= 10;
785 get_channel_ref!(nodes[0], lock, chan_id).closing_fee_limits.as_mut().unwrap().1 *= 10;
787 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
788 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
789 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
790 let node_0_2nd_closing_signed = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
791 if timeout_step == TimeoutStep::NoTimeout {
792 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.1.unwrap());
796 if timeout_step != TimeoutStep::NoTimeout {
797 assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
799 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
802 nodes[1].node.timer_tick_occurred();
803 nodes[1].node.timer_tick_occurred();
805 let txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
806 assert_eq!(txn.len(), 1);
807 assert_eq!(txn[0].output.len(), 2);
809 if timeout_step != TimeoutStep::NoTimeout {
810 assert!((txn[0].output[0].script_pubkey.is_v0_p2wpkh() &&
811 txn[0].output[1].script_pubkey.is_v0_p2wsh()) ||
812 (txn[0].output[1].script_pubkey.is_v0_p2wpkh() &&
813 txn[0].output[0].script_pubkey.is_v0_p2wsh()));
814 check_closed_broadcast!(nodes[1], true);
815 check_added_monitors!(nodes[1], 1);
817 assert!(txn[0].output[0].script_pubkey.is_v0_p2wpkh());
818 assert!(txn[0].output[1].script_pubkey.is_v0_p2wpkh());
820 let events = nodes[1].node.get_and_clear_pending_msg_events();
821 assert_eq!(events.len(), 1);
823 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
824 assert_eq!(msg.contents.flags & 2, 2);
826 _ => panic!("Unexpected event"),
832 fn test_closing_signed_reinit_timeout() {
833 do_test_closing_signed_reinit_timeout(TimeoutStep::AfterShutdown);
834 do_test_closing_signed_reinit_timeout(TimeoutStep::AfterClosingSigned);
835 do_test_closing_signed_reinit_timeout(TimeoutStep::NoTimeout);
838 fn do_simple_legacy_shutdown_test(high_initiator_fee: bool) {
839 // A simpe test of the legacy shutdown fee negotiation logic.
840 let chanmon_cfgs = create_chanmon_cfgs(2);
841 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
842 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
843 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
845 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
847 if high_initiator_fee {
848 // If high_initiator_fee is set, set nodes[0]'s feerate significantly higher. This
849 // shouldn't impact the flow at all given nodes[1] will happily accept the higher fee.
850 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
854 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
855 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
856 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
857 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
858 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
860 let mut node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
861 node_0_closing_signed.fee_range = None;
862 if high_initiator_fee {
863 assert!(node_0_closing_signed.fee_satoshis > 500);
865 assert!(node_0_closing_signed.fee_satoshis < 500);
868 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
869 let (_, mut node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
870 node_1_closing_signed.as_mut().unwrap().fee_range = None;
872 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
873 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
874 assert!(node_0_none.is_none());
878 fn simple_legacy_shutdown_test() {
879 do_simple_legacy_shutdown_test(false);
880 do_simple_legacy_shutdown_test(true);
884 fn simple_target_feerate_shutdown() {
885 // Simple test of target in `close_channel_with_target_feerate`.
886 let chanmon_cfgs = create_chanmon_cfgs(2);
887 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
888 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
889 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
891 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
892 let chan_id = OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id();
894 nodes[0].node.close_channel_with_target_feerate(&chan_id, 253 * 10).unwrap();
895 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
896 nodes[1].node.close_channel_with_target_feerate(&chan_id, 253 * 5).unwrap();
897 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
899 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
900 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
902 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
903 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
904 let (_, node_1_closing_signed_opt) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
905 let node_1_closing_signed = node_1_closing_signed_opt.unwrap();
907 // nodes[1] was passed a target which was larger than the current channel feerate, which it
908 // should ignore in favor of the channel fee, as there is no use demanding a minimum higher
909 // than what will be paid on a force-close transaction. Note that we have to consider rounding,
910 // so only check that we're within 10 sats.
911 assert!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis >=
912 node_1_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis * 10 - 5);
913 assert!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis <=
914 node_1_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis * 10 + 5);
916 // Further, because nodes[0]'s target fee is larger than the `Normal` fee estimation plus our
917 // force-closure-avoidance buffer, min should equal max, and the nodes[1]-selected fee should
918 // be the nodes[0] only available fee.
919 assert_eq!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis,
920 node_0_closing_signed.fee_range.as_ref().unwrap().max_fee_satoshis);
921 assert_eq!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis,
922 node_0_closing_signed.fee_satoshis);
923 assert_eq!(node_0_closing_signed.fee_satoshis, node_1_closing_signed.fee_satoshis);
925 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
926 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
927 assert!(node_0_none.is_none());