1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! Tests of our shutdown and closing_signed negotiation logic.
12 use chain::keysinterface::KeysInterface;
13 use chain::transaction::OutPoint;
14 use ln::channelmanager::PaymentSendFailure;
15 use routing::router::{Payee, get_route};
16 use routing::network_graph::NetworkUpdate;
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, ClosureReason};
24 use util::errors::APIError;
25 use util::config::UserConfig;
27 use bitcoin::blockdata::script::Builder;
28 use bitcoin::blockdata::opcodes;
32 use core::default::Default;
33 use core::num::NonZeroU8;
35 use ln::functional_test_utils::*;
36 use ln::msgs::OptionalField::Present;
39 fn pre_funding_lock_shutdown_test() {
40 // Test sending a shutdown prior to funding_locked after funding generation
41 let chanmon_cfgs = create_chanmon_cfgs(2);
42 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
43 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
44 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
45 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0, InitFeatures::known(), InitFeatures::known());
46 mine_transaction(&nodes[0], &tx);
47 mine_transaction(&nodes[1], &tx);
49 nodes[0].node.close_channel(&OutPoint { txid: tx.txid(), index: 0 }.to_channel_id()).unwrap();
50 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
51 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
52 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
53 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
55 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
56 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
57 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
58 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
59 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
60 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
61 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
62 assert!(node_1_none.is_none());
64 assert!(nodes[0].node.list_channels().is_empty());
65 assert!(nodes[1].node.list_channels().is_empty());
66 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
67 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
71 fn updates_shutdown_wait() {
72 // Test sending a shutdown with outstanding updates pending
73 let chanmon_cfgs = create_chanmon_cfgs(3);
74 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
75 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
76 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
77 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
78 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
79 let logger = test_utils::TestLogger::new();
80 let scorer = test_utils::TestScorer::with_fixed_penalty(0);
82 let (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 payee_1 = Payee::from_node_id(nodes[1].node.get_our_node_id()).with_features(InvoiceFeatures::known());
96 let route_1 = get_route(&nodes[0].node.get_our_node_id(), &payee_1, nodes[0].network_graph, None, 100000, TEST_FINAL_CLTV, &logger, &scorer).unwrap();
97 let payee_2 = Payee::from_node_id(nodes[0].node.get_our_node_id()).with_features(InvoiceFeatures::known());
98 let route_2 = get_route(&nodes[1].node.get_our_node_id(), &payee_2, nodes[1].network_graph, None, 100000, TEST_FINAL_CLTV, &logger, &scorer).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(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);
123 expect_payment_sent!(nodes[0], payment_preimage);
125 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
126 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
127 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
128 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
129 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
130 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
131 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
132 assert!(node_1_none.is_none());
133 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
134 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
136 assert!(nodes[0].node.list_channels().is_empty());
138 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
139 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
140 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
141 assert!(nodes[1].node.list_channels().is_empty());
142 assert!(nodes[2].node.list_channels().is_empty());
143 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
144 check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure);
148 fn htlc_fail_async_shutdown() {
149 // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
150 let chanmon_cfgs = create_chanmon_cfgs(3);
151 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
152 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
153 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
154 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
155 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
157 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], 100000);
158 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
159 check_added_monitors!(nodes[0], 1);
160 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
161 assert_eq!(updates.update_add_htlcs.len(), 1);
162 assert!(updates.update_fulfill_htlcs.is_empty());
163 assert!(updates.update_fail_htlcs.is_empty());
164 assert!(updates.update_fail_malformed_htlcs.is_empty());
165 assert!(updates.update_fee.is_none());
167 nodes[1].node.close_channel(&chan_1.2).unwrap();
168 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
169 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
170 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
172 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
173 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
174 check_added_monitors!(nodes[1], 1);
175 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
176 commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
178 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
179 assert!(updates_2.update_add_htlcs.is_empty());
180 assert!(updates_2.update_fulfill_htlcs.is_empty());
181 assert_eq!(updates_2.update_fail_htlcs.len(), 1);
182 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
183 assert!(updates_2.update_fee.is_none());
185 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]);
186 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
188 expect_payment_failed_with_update!(nodes[0], our_payment_hash, false, chan_2.0.contents.short_channel_id, true);
190 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
191 assert_eq!(msg_events.len(), 1);
192 let node_0_closing_signed = match msg_events[0] {
193 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
194 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
197 _ => panic!("Unexpected event"),
200 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
201 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
202 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
203 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
204 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
205 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
206 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
207 assert!(node_1_none.is_none());
209 assert!(nodes[0].node.list_channels().is_empty());
211 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
212 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
213 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
214 assert!(nodes[1].node.list_channels().is_empty());
215 assert!(nodes[2].node.list_channels().is_empty());
216 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
217 check_closed_event!(nodes[1], 2, ClosureReason::CooperativeClosure);
218 check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure);
221 fn do_test_shutdown_rebroadcast(recv_count: u8) {
222 // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
223 // messages delivered prior to disconnect
224 let chanmon_cfgs = create_chanmon_cfgs(3);
225 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
226 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
227 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
228 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
229 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
231 let (payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
233 nodes[1].node.close_channel(&chan_1.2).unwrap();
234 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
236 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
237 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
239 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
243 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
244 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
246 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
247 let node_0_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
248 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
249 let node_1_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
251 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish);
252 let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
253 assert!(node_1_shutdown == node_1_2nd_shutdown);
255 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish);
256 let node_0_2nd_shutdown = if recv_count > 0 {
257 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
258 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_2nd_shutdown);
261 let node_0_chan_update = get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
262 assert_eq!(node_0_chan_update.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
263 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_2nd_shutdown);
264 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
266 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_2nd_shutdown);
268 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
269 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
271 assert!(nodes[2].node.claim_funds(payment_preimage));
272 check_added_monitors!(nodes[2], 1);
273 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
274 assert!(updates.update_add_htlcs.is_empty());
275 assert!(updates.update_fail_htlcs.is_empty());
276 assert!(updates.update_fail_malformed_htlcs.is_empty());
277 assert!(updates.update_fee.is_none());
278 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
279 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
280 expect_payment_forwarded!(nodes[1], Some(1000), false);
281 check_added_monitors!(nodes[1], 1);
282 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
283 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
285 assert!(updates_2.update_add_htlcs.is_empty());
286 assert!(updates_2.update_fail_htlcs.is_empty());
287 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
288 assert!(updates_2.update_fee.is_none());
289 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
290 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
291 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
292 expect_payment_sent!(nodes[0], payment_preimage);
294 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
296 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
297 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
298 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
299 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
300 assert!(node_0_2nd_closing_signed.is_some());
303 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
304 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
306 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
307 let node_1_2nd_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
308 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
310 // If all closing_signeds weren't delivered we can just resume where we left off...
311 let node_0_2nd_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
313 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
314 let node_0_msgs = nodes[0].node.get_and_clear_pending_msg_events();
315 assert_eq!(node_0_msgs.len(), 2);
316 let node_0_2nd_closing_signed = match node_0_msgs[1] {
317 MessageSendEvent::SendClosingSigned { ref msg, .. } => {
318 assert_eq!(node_0_closing_signed, *msg);
324 let node_0_3rd_shutdown = match node_0_msgs[0] {
325 MessageSendEvent::SendShutdown { ref msg, .. } => {
326 assert_eq!(node_0_2nd_shutdown, *msg);
331 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
333 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
334 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
335 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
337 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_3rd_shutdown);
338 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
340 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_3rd_shutdown);
342 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed);
343 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
344 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
345 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
346 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
347 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
348 assert!(node_1_none.is_none());
349 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
351 // If one node, however, received + responded with an identical closing_signed we end
352 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
353 // There isn't really anything better we can do simply, but in the future we might
354 // explore storing a set of recently-closed channels that got disconnected during
355 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
356 // give our counterparty enough time to (potentially) broadcast a cooperative closing
358 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
360 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
361 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
362 assert_eq!(msg_events.len(), 1);
363 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
365 &ErrorAction::SendErrorMessage { ref msg } => {
366 nodes[1].node.handle_error(&nodes[0].node.get_our_node_id(), &msg);
367 assert_eq!(msg.channel_id, chan_1.2);
369 _ => panic!("Unexpected event!"),
371 } else { panic!("Needed SendErrorMessage close"); }
373 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
374 // checks it, but in this case nodes[1] didn't ever get a chance to receive a
375 // closing_signed so we do it ourselves
376 check_closed_broadcast!(nodes[1], false);
377 check_added_monitors!(nodes[1], 1);
378 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyForceClosed { peer_msg: "Failed to find corresponding channel".to_string() });
381 assert!(nodes[0].node.list_channels().is_empty());
383 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
384 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
385 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
386 assert!(nodes[1].node.list_channels().is_empty());
387 assert!(nodes[2].node.list_channels().is_empty());
388 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
389 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
390 check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure);
394 fn test_shutdown_rebroadcast() {
395 do_test_shutdown_rebroadcast(0);
396 do_test_shutdown_rebroadcast(1);
397 do_test_shutdown_rebroadcast(2);
401 fn test_upfront_shutdown_script() {
402 // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
403 // enforce it at shutdown message
405 let mut config = UserConfig::default();
406 config.channel_options.announced_channel = true;
407 config.peer_channel_config_limits.force_announced_channel_preference = false;
408 config.channel_options.commit_upfront_shutdown_pubkey = false;
409 let user_cfgs = [None, Some(config), None];
410 let chanmon_cfgs = create_chanmon_cfgs(3);
411 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
412 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
413 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
415 // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
416 let flags = InitFeatures::known();
417 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
418 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
419 let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
420 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
421 // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that we disconnect peer
422 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
423 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()));
424 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() });
425 check_added_monitors!(nodes[2], 1);
427 // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
428 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
429 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
430 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
431 // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
432 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
433 let events = nodes[2].node.get_and_clear_pending_msg_events();
434 assert_eq!(events.len(), 1);
436 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
437 _ => panic!("Unexpected event"),
440 // We test that if case of peer non-signaling we don't enforce committed script at channel opening
441 let flags_no = InitFeatures::known().clear_upfront_shutdown_script();
442 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
443 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
444 let node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
445 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
446 check_added_monitors!(nodes[1], 1);
447 let events = nodes[1].node.get_and_clear_pending_msg_events();
448 assert_eq!(events.len(), 1);
450 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
451 _ => panic!("Unexpected event"),
454 // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
455 // channel smoothly, opt-out is from channel initiator here
456 let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
457 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
458 check_added_monitors!(nodes[1], 1);
459 let node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
460 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
461 let events = nodes[0].node.get_and_clear_pending_msg_events();
462 assert_eq!(events.len(), 1);
464 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
465 _ => panic!("Unexpected event"),
468 //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
469 //// channel smoothly
470 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
471 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
472 check_added_monitors!(nodes[1], 1);
473 let node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
474 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
475 let events = nodes[0].node.get_and_clear_pending_msg_events();
476 assert_eq!(events.len(), 2);
478 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
479 _ => panic!("Unexpected event"),
482 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
483 _ => panic!("Unexpected event"),
488 fn test_unsupported_anysegwit_upfront_shutdown_script() {
489 let chanmon_cfgs = create_chanmon_cfgs(2);
490 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
491 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
492 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
494 // Use a non-v0 segwit script supported by option_shutdown_anysegwit
495 let node_features = InitFeatures::known().clear_shutdown_anysegwit();
496 let anysegwit_shutdown_script = Builder::new()
498 .push_slice(&[0, 40])
501 // Check script when handling an open_channel message
502 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
503 let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
504 open_channel.shutdown_scriptpubkey = Present(anysegwit_shutdown_script.clone());
505 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), node_features.clone(), &open_channel);
507 let events = nodes[1].node.get_and_clear_pending_msg_events();
508 assert_eq!(events.len(), 1);
510 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
511 assert_eq!(node_id, nodes[0].node.get_our_node_id());
512 assert_eq!(msg.data, "Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: Script(OP_PUSHNUM_16 OP_PUSHBYTES_2 0028)");
514 _ => panic!("Unexpected event"),
517 // Check script when handling an accept_channel message
518 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
519 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
520 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
521 let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
522 accept_channel.shutdown_scriptpubkey = Present(anysegwit_shutdown_script.clone());
523 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), node_features, &accept_channel);
525 let events = nodes[0].node.get_and_clear_pending_msg_events();
526 assert_eq!(events.len(), 1);
528 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
529 assert_eq!(node_id, nodes[1].node.get_our_node_id());
530 assert_eq!(msg.data, "Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: Script(OP_PUSHNUM_16 OP_PUSHBYTES_2 0028)");
532 _ => panic!("Unexpected event"),
534 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() });
538 fn test_invalid_upfront_shutdown_script() {
539 let chanmon_cfgs = create_chanmon_cfgs(2);
540 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
541 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
542 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
544 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
546 // Use a segwit v0 script with an unsupported witness program
547 let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
548 open_channel.shutdown_scriptpubkey = Present(Builder::new().push_int(0)
551 nodes[0].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
553 let events = nodes[0].node.get_and_clear_pending_msg_events();
554 assert_eq!(events.len(), 1);
556 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
557 assert_eq!(node_id, nodes[0].node.get_our_node_id());
558 assert_eq!(msg.data, "Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: Script(OP_0 OP_PUSHBYTES_2 0000)");
560 _ => panic!("Unexpected event"),
565 fn test_segwit_v0_shutdown_script() {
566 let mut config = UserConfig::default();
567 config.channel_options.announced_channel = true;
568 config.peer_channel_config_limits.force_announced_channel_preference = false;
569 config.channel_options.commit_upfront_shutdown_pubkey = false;
570 let user_cfgs = [None, Some(config), None];
571 let chanmon_cfgs = create_chanmon_cfgs(3);
572 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
573 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
574 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
576 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
577 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
578 check_added_monitors!(nodes[1], 1);
580 // Use a segwit v0 script supported even without option_shutdown_anysegwit
581 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
582 node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
583 .push_slice(&[0; 20])
585 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
587 let events = nodes[0].node.get_and_clear_pending_msg_events();
588 assert_eq!(events.len(), 2);
590 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
591 _ => panic!("Unexpected event"),
594 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
595 _ => panic!("Unexpected event"),
600 fn test_anysegwit_shutdown_script() {
601 let mut config = UserConfig::default();
602 config.channel_options.announced_channel = true;
603 config.peer_channel_config_limits.force_announced_channel_preference = false;
604 config.channel_options.commit_upfront_shutdown_pubkey = false;
605 let user_cfgs = [None, Some(config), None];
606 let chanmon_cfgs = create_chanmon_cfgs(3);
607 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
608 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
609 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
611 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
612 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
613 check_added_monitors!(nodes[1], 1);
615 // Use a non-v0 segwit script supported by option_shutdown_anysegwit
616 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
617 node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
620 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
622 let events = nodes[0].node.get_and_clear_pending_msg_events();
623 assert_eq!(events.len(), 2);
625 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
626 _ => panic!("Unexpected event"),
629 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
630 _ => panic!("Unexpected event"),
635 fn test_unsupported_anysegwit_shutdown_script() {
636 let mut config = UserConfig::default();
637 config.channel_options.announced_channel = true;
638 config.peer_channel_config_limits.force_announced_channel_preference = false;
639 config.channel_options.commit_upfront_shutdown_pubkey = false;
640 let user_cfgs = [None, Some(config), None];
641 let chanmon_cfgs = create_chanmon_cfgs(3);
642 let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
643 node_cfgs[0].features = InitFeatures::known().clear_shutdown_anysegwit();
644 node_cfgs[1].features = InitFeatures::known().clear_shutdown_anysegwit();
645 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
646 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
648 // Check that using an unsupported shutdown script fails and a supported one succeeds.
649 let supported_shutdown_script = chanmon_cfgs[1].keys_manager.get_shutdown_scriptpubkey();
650 let unsupported_shutdown_script =
651 ShutdownScript::new_witness_program(NonZeroU8::new(16).unwrap(), &[0, 40]).unwrap();
652 chanmon_cfgs[1].keys_manager
653 .expect(OnGetShutdownScriptpubkey { returns: unsupported_shutdown_script.clone() })
654 .expect(OnGetShutdownScriptpubkey { returns: supported_shutdown_script });
656 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, node_cfgs[0].features.clone(), node_cfgs[1].features.clone());
657 match nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()) {
658 Err(APIError::IncompatibleShutdownScript { script }) => {
659 assert_eq!(script.into_inner(), unsupported_shutdown_script.clone().into_inner());
661 Err(e) => panic!("Unexpected error: {:?}", e),
662 Ok(_) => panic!("Expected error"),
664 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
665 check_added_monitors!(nodes[1], 1);
667 // Use a non-v0 segwit script unsupported without option_shutdown_anysegwit
668 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
669 node_0_shutdown.scriptpubkey = unsupported_shutdown_script.into_inner();
670 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_cfgs[1].features, &node_0_shutdown);
672 let events = nodes[0].node.get_and_clear_pending_msg_events();
673 assert_eq!(events.len(), 2);
675 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
676 assert_eq!(node_id, nodes[1].node.get_our_node_id());
677 assert_eq!(msg.data, "Got a nonstandard scriptpubkey (60020028) from remote peer".to_owned());
679 _ => panic!("Unexpected event"),
681 check_added_monitors!(nodes[0], 1);
682 check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: "Got a nonstandard scriptpubkey (60020028) from remote peer".to_string() });
686 fn test_invalid_shutdown_script() {
687 let mut config = UserConfig::default();
688 config.channel_options.announced_channel = true;
689 config.peer_channel_config_limits.force_announced_channel_preference = false;
690 config.channel_options.commit_upfront_shutdown_pubkey = false;
691 let user_cfgs = [None, Some(config), None];
692 let chanmon_cfgs = create_chanmon_cfgs(3);
693 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
694 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
695 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
697 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
698 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
699 check_added_monitors!(nodes[1], 1);
701 // Use a segwit v0 script with an unsupported witness program
702 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
703 node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
706 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
708 let events = nodes[0].node.get_and_clear_pending_msg_events();
709 assert_eq!(events.len(), 2);
711 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
712 assert_eq!(node_id, nodes[1].node.get_our_node_id());
713 assert_eq!(msg.data, "Got a nonstandard scriptpubkey (00020000) from remote peer".to_owned())
715 _ => panic!("Unexpected event"),
717 check_added_monitors!(nodes[0], 1);
718 check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: "Got a nonstandard scriptpubkey (00020000) from remote peer".to_string() });
728 fn do_test_closing_signed_reinit_timeout(timeout_step: TimeoutStep) {
729 // The range-based closing signed negotiation allows the funder to restart the process with a
730 // new range if the previous range did not overlap. This allows implementations to request user
731 // intervention allowing users to enter a new fee range. We do not implement the sending side
732 // of this, instead opting to allow users to enter an explicit "willing to pay up to X to avoid
733 // force-closing" value and relying on that instead.
735 // Here we run test the fundee side of that restart mechanism, implementing the funder side of
737 let chanmon_cfgs = create_chanmon_cfgs(2);
738 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
739 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
740 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
741 let chan_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
743 send_payment(&nodes[0], &[&nodes[1]], 8_000_000);
745 nodes[0].node.close_channel(&chan_id).unwrap();
746 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
747 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
748 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
749 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
752 // Now we set nodes[1] to require a relatively high feerate for closing. This should result
753 // in it rejecting nodes[0]'s initial closing_signed, giving nodes[0] a chance to try
755 let mut feerate_lock = chanmon_cfgs[1].fee_estimator.sat_per_kw.lock().unwrap();
759 let mut node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
760 // nodes[0] should use a "reasonable" feerate, well under the 10 sat/vByte that nodes[1] thinks
761 // is the current prevailing feerate.
762 assert!(node_0_closing_signed.fee_satoshis <= 500);
764 if timeout_step != TimeoutStep::AfterShutdown {
765 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
766 // At this point nodes[1] should send back a warning message indicating it disagrees with the
767 // given channel-closing fee. Currently we do not implement warning messages so instead we
768 // remain silent here.
769 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
771 // Now deliver a mutated closing_signed indicating a higher acceptable fee range, which
772 // nodes[1] should happily accept and respond to.
773 node_0_closing_signed.fee_range.as_mut().unwrap().max_fee_satoshis *= 10;
776 get_channel_ref!(nodes[0], lock, chan_id).closing_fee_limits.as_mut().unwrap().1 *= 10;
778 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
779 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
780 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
781 let node_0_2nd_closing_signed = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
782 if timeout_step == TimeoutStep::NoTimeout {
783 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.1.unwrap());
784 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
786 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
789 if timeout_step != TimeoutStep::NoTimeout {
790 assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
792 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
795 nodes[1].node.timer_tick_occurred();
796 nodes[1].node.timer_tick_occurred();
798 let txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
799 assert_eq!(txn.len(), 1);
800 assert_eq!(txn[0].output.len(), 2);
802 if timeout_step != TimeoutStep::NoTimeout {
803 assert!((txn[0].output[0].script_pubkey.is_v0_p2wpkh() &&
804 txn[0].output[1].script_pubkey.is_v0_p2wsh()) ||
805 (txn[0].output[1].script_pubkey.is_v0_p2wpkh() &&
806 txn[0].output[0].script_pubkey.is_v0_p2wsh()));
807 check_closed_broadcast!(nodes[1], true);
808 check_added_monitors!(nodes[1], 1);
809 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "closing_signed negotiation failed to finish within two timer ticks".to_string() });
811 assert!(txn[0].output[0].script_pubkey.is_v0_p2wpkh());
812 assert!(txn[0].output[1].script_pubkey.is_v0_p2wpkh());
814 let events = nodes[1].node.get_and_clear_pending_msg_events();
815 assert_eq!(events.len(), 1);
817 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
818 assert_eq!(msg.contents.flags & 2, 2);
820 _ => panic!("Unexpected event"),
826 fn test_closing_signed_reinit_timeout() {
827 do_test_closing_signed_reinit_timeout(TimeoutStep::AfterShutdown);
828 do_test_closing_signed_reinit_timeout(TimeoutStep::AfterClosingSigned);
829 do_test_closing_signed_reinit_timeout(TimeoutStep::NoTimeout);
832 fn do_simple_legacy_shutdown_test(high_initiator_fee: bool) {
833 // A simpe test of the legacy shutdown fee negotiation logic.
834 let chanmon_cfgs = create_chanmon_cfgs(2);
835 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
836 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
837 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
839 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
841 if high_initiator_fee {
842 // If high_initiator_fee is set, set nodes[0]'s feerate significantly higher. This
843 // shouldn't impact the flow at all given nodes[1] will happily accept the higher fee.
844 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
848 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
849 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
850 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
851 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
852 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
854 let mut node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
855 node_0_closing_signed.fee_range = None;
856 if high_initiator_fee {
857 assert!(node_0_closing_signed.fee_satoshis > 500);
859 assert!(node_0_closing_signed.fee_satoshis < 500);
862 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
863 let (_, mut node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
864 node_1_closing_signed.as_mut().unwrap().fee_range = None;
866 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
867 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
868 assert!(node_0_none.is_none());
869 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
870 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
874 fn simple_legacy_shutdown_test() {
875 do_simple_legacy_shutdown_test(false);
876 do_simple_legacy_shutdown_test(true);
880 fn simple_target_feerate_shutdown() {
881 // Simple test of target in `close_channel_with_target_feerate`.
882 let chanmon_cfgs = create_chanmon_cfgs(2);
883 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
884 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
885 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
887 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
888 let chan_id = OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id();
890 nodes[0].node.close_channel_with_target_feerate(&chan_id, 253 * 10).unwrap();
891 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
892 nodes[1].node.close_channel_with_target_feerate(&chan_id, 253 * 5).unwrap();
893 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
895 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
896 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
898 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
899 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
900 let (_, node_1_closing_signed_opt) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
901 let node_1_closing_signed = node_1_closing_signed_opt.unwrap();
903 // nodes[1] was passed a target which was larger than the current channel feerate, which it
904 // should ignore in favor of the channel fee, as there is no use demanding a minimum higher
905 // than what will be paid on a force-close transaction. Note that we have to consider rounding,
906 // so only check that we're within 10 sats.
907 assert!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis >=
908 node_1_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis * 10 - 5);
909 assert!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis <=
910 node_1_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis * 10 + 5);
912 // Further, because nodes[0]'s target fee is larger than the `Normal` fee estimation plus our
913 // force-closure-avoidance buffer, min should equal max, and the nodes[1]-selected fee should
914 // be the nodes[0] only available fee.
915 assert_eq!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis,
916 node_0_closing_signed.fee_range.as_ref().unwrap().max_fee_satoshis);
917 assert_eq!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis,
918 node_0_closing_signed.fee_satoshis);
919 assert_eq!(node_0_closing_signed.fee_satoshis, node_1_closing_signed.fee_satoshis);
921 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
922 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
923 assert!(node_0_none.is_none());
924 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
925 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);