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::{Payee, get_route};
17 use routing::network_graph::NetworkUpdate;
18 use ln::features::{InitFeatures, InvoiceFeatures};
20 use ln::msgs::{ChannelMessageHandler, ErrorAction};
21 use ln::script::ShutdownScript;
23 use util::test_utils::OnGetShutdownScriptpubkey;
24 use util::events::{Event, MessageSendEvent, MessageSendEventsProvider, ClosureReason};
25 use util::errors::APIError;
26 use util::config::UserConfig;
28 use bitcoin::blockdata::script::Builder;
29 use bitcoin::blockdata::opcodes;
31 use bitcoin::hashes::sha256::Hash as Sha256;
32 use bitcoin::hashes::Hash;
36 use core::default::Default;
37 use core::num::NonZeroU8;
39 use ln::functional_test_utils::*;
40 use ln::msgs::OptionalField::Present;
43 fn pre_funding_lock_shutdown_test() {
44 // Test sending a shutdown prior to funding_locked after funding generation
45 let chanmon_cfgs = create_chanmon_cfgs(2);
46 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
47 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
48 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
49 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0, InitFeatures::known(), InitFeatures::known());
50 mine_transaction(&nodes[0], &tx);
51 mine_transaction(&nodes[1], &tx);
53 nodes[0].node.close_channel(&OutPoint { txid: tx.txid(), index: 0 }.to_channel_id()).unwrap();
54 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
55 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
56 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
57 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
59 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
60 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
61 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
62 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
63 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
64 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
65 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
66 assert!(node_1_none.is_none());
68 assert!(nodes[0].node.list_channels().is_empty());
69 assert!(nodes[1].node.list_channels().is_empty());
70 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
71 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
75 fn updates_shutdown_wait() {
76 // Test sending a shutdown with outstanding updates pending
77 let chanmon_cfgs = create_chanmon_cfgs(3);
78 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
79 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
80 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
81 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
82 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
83 let logger = test_utils::TestLogger::new();
84 let scorer = test_utils::TestScorer::with_fixed_penalty(0);
86 let (payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
88 nodes[0].node.close_channel(&chan_1.2).unwrap();
89 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
90 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
91 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
92 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
94 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
95 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
97 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
99 let payee_1 = Payee::from_node_id(nodes[1].node.get_our_node_id()).with_features(InvoiceFeatures::known());
100 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();
101 let payee_2 = Payee::from_node_id(nodes[0].node.get_our_node_id()).with_features(InvoiceFeatures::known());
102 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();
103 unwrap_send_err!(nodes[0].node.send_payment(&route_1, payment_hash, &Some(payment_secret)), true, APIError::ChannelUnavailable {..}, {});
104 unwrap_send_err!(nodes[1].node.send_payment(&route_2, payment_hash, &Some(payment_secret)), true, APIError::ChannelUnavailable {..}, {});
106 assert!(nodes[2].node.claim_funds(payment_preimage));
107 check_added_monitors!(nodes[2], 1);
108 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
109 assert!(updates.update_add_htlcs.is_empty());
110 assert!(updates.update_fail_htlcs.is_empty());
111 assert!(updates.update_fail_malformed_htlcs.is_empty());
112 assert!(updates.update_fee.is_none());
113 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
114 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
115 expect_payment_forwarded!(nodes[1], Some(1000), false);
116 check_added_monitors!(nodes[1], 1);
117 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
118 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
120 assert!(updates_2.update_add_htlcs.is_empty());
121 assert!(updates_2.update_fail_htlcs.is_empty());
122 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
123 assert!(updates_2.update_fee.is_none());
124 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
125 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
126 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
127 expect_payment_sent!(nodes[0], payment_preimage);
129 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
130 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
131 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
132 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
133 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
134 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
135 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
136 assert!(node_1_none.is_none());
137 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
138 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
140 assert!(nodes[0].node.list_channels().is_empty());
142 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
143 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
144 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
145 assert!(nodes[1].node.list_channels().is_empty());
146 assert!(nodes[2].node.list_channels().is_empty());
147 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
148 check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure);
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());
161 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], 100000);
162 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
163 check_added_monitors!(nodes[0], 1);
164 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
165 assert_eq!(updates.update_add_htlcs.len(), 1);
166 assert!(updates.update_fulfill_htlcs.is_empty());
167 assert!(updates.update_fail_htlcs.is_empty());
168 assert!(updates.update_fail_malformed_htlcs.is_empty());
169 assert!(updates.update_fee.is_none());
171 nodes[1].node.close_channel(&chan_1.2).unwrap();
172 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
173 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
174 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
176 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
177 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
178 check_added_monitors!(nodes[1], 1);
179 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
180 commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
182 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
183 assert!(updates_2.update_add_htlcs.is_empty());
184 assert!(updates_2.update_fulfill_htlcs.is_empty());
185 assert_eq!(updates_2.update_fail_htlcs.len(), 1);
186 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
187 assert!(updates_2.update_fee.is_none());
189 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]);
190 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
192 expect_payment_failed_with_update!(nodes[0], our_payment_hash, false, chan_2.0.contents.short_channel_id, true);
194 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
195 assert_eq!(msg_events.len(), 1);
196 let node_0_closing_signed = match msg_events[0] {
197 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
198 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
201 _ => panic!("Unexpected event"),
204 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
205 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
206 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
207 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
208 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
209 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
210 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
211 assert!(node_1_none.is_none());
213 assert!(nodes[0].node.list_channels().is_empty());
215 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
216 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
217 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
218 assert!(nodes[1].node.list_channels().is_empty());
219 assert!(nodes[2].node.list_channels().is_empty());
220 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
221 check_closed_event!(nodes[1], 2, ClosureReason::CooperativeClosure);
222 check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure);
225 fn do_test_shutdown_rebroadcast(recv_count: u8) {
226 // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
227 // messages delivered prior to disconnect
228 let chanmon_cfgs = create_chanmon_cfgs(3);
229 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
230 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
231 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
232 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
233 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
235 let (payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
237 nodes[1].node.close_channel(&chan_1.2).unwrap();
238 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
240 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
241 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
243 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
247 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
248 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
250 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
251 let node_0_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
252 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
253 let node_1_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
255 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish);
256 let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
257 assert!(node_1_shutdown == node_1_2nd_shutdown);
259 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish);
260 let node_0_2nd_shutdown = if recv_count > 0 {
261 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
262 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_2nd_shutdown);
265 let node_0_chan_update = get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
266 assert_eq!(node_0_chan_update.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
267 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_2nd_shutdown);
268 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
270 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_2nd_shutdown);
272 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
273 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
275 assert!(nodes[2].node.claim_funds(payment_preimage));
276 check_added_monitors!(nodes[2], 1);
277 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
278 assert!(updates.update_add_htlcs.is_empty());
279 assert!(updates.update_fail_htlcs.is_empty());
280 assert!(updates.update_fail_malformed_htlcs.is_empty());
281 assert!(updates.update_fee.is_none());
282 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
283 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
284 expect_payment_forwarded!(nodes[1], Some(1000), false);
285 check_added_monitors!(nodes[1], 1);
286 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
287 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
289 assert!(updates_2.update_add_htlcs.is_empty());
290 assert!(updates_2.update_fail_htlcs.is_empty());
291 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
292 assert!(updates_2.update_fee.is_none());
293 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
294 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
295 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
296 expect_payment_sent!(nodes[0], payment_preimage);
298 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
300 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
301 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
302 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
303 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
304 assert!(node_0_2nd_closing_signed.is_some());
307 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
308 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
310 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
311 let node_1_2nd_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
312 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
314 // If all closing_signeds weren't delivered we can just resume where we left off...
315 let node_0_2nd_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
317 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
318 let node_0_msgs = nodes[0].node.get_and_clear_pending_msg_events();
319 assert_eq!(node_0_msgs.len(), 2);
320 let node_0_2nd_closing_signed = match node_0_msgs[1] {
321 MessageSendEvent::SendClosingSigned { ref msg, .. } => {
322 assert_eq!(node_0_closing_signed, *msg);
328 let node_0_3rd_shutdown = match node_0_msgs[0] {
329 MessageSendEvent::SendShutdown { ref msg, .. } => {
330 assert_eq!(node_0_2nd_shutdown, *msg);
335 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
337 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
338 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
339 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
341 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_3rd_shutdown);
342 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
344 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_3rd_shutdown);
346 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed);
347 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
348 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
349 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
350 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
351 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
352 assert!(node_1_none.is_none());
353 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
355 // If one node, however, received + responded with an identical closing_signed we end
356 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
357 // There isn't really anything better we can do simply, but in the future we might
358 // explore storing a set of recently-closed channels that got disconnected during
359 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
360 // give our counterparty enough time to (potentially) broadcast a cooperative closing
362 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
364 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
365 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
366 assert_eq!(msg_events.len(), 1);
367 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
369 &ErrorAction::SendErrorMessage { ref msg } => {
370 nodes[1].node.handle_error(&nodes[0].node.get_our_node_id(), &msg);
371 assert_eq!(msg.channel_id, chan_1.2);
373 _ => panic!("Unexpected event!"),
375 } else { panic!("Needed SendErrorMessage close"); }
377 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
378 // checks it, but in this case nodes[1] didn't ever get a chance to receive a
379 // closing_signed so we do it ourselves
380 check_closed_broadcast!(nodes[1], false);
381 check_added_monitors!(nodes[1], 1);
382 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyForceClosed { peer_msg: "Failed to find corresponding channel".to_string() });
385 assert!(nodes[0].node.list_channels().is_empty());
387 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
388 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
389 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
390 assert!(nodes[1].node.list_channels().is_empty());
391 assert!(nodes[2].node.list_channels().is_empty());
392 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
393 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
394 check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure);
398 fn test_shutdown_rebroadcast() {
399 do_test_shutdown_rebroadcast(0);
400 do_test_shutdown_rebroadcast(1);
401 do_test_shutdown_rebroadcast(2);
405 fn test_upfront_shutdown_script() {
406 // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
407 // enforce it at shutdown message
409 let mut config = UserConfig::default();
410 config.channel_options.announced_channel = true;
411 config.peer_channel_config_limits.force_announced_channel_preference = false;
412 config.channel_options.commit_upfront_shutdown_pubkey = false;
413 let user_cfgs = [None, Some(config), None];
414 let chanmon_cfgs = create_chanmon_cfgs(3);
415 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
416 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
417 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
419 // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
420 let flags = InitFeatures::known();
421 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
422 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
423 let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
424 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
425 // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that we disconnect peer
426 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
427 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()));
428 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() });
429 check_added_monitors!(nodes[2], 1);
431 // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
432 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
433 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
434 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
435 // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
436 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
437 let events = nodes[2].node.get_and_clear_pending_msg_events();
438 assert_eq!(events.len(), 1);
440 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
441 _ => panic!("Unexpected event"),
444 // We test that if case of peer non-signaling we don't enforce committed script at channel opening
445 let flags_no = InitFeatures::known().clear_upfront_shutdown_script();
446 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
447 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
448 let node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
449 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
450 check_added_monitors!(nodes[1], 1);
451 let events = nodes[1].node.get_and_clear_pending_msg_events();
452 assert_eq!(events.len(), 1);
454 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
455 _ => panic!("Unexpected event"),
458 // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
459 // channel smoothly, opt-out is from channel initiator here
460 let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
461 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
462 check_added_monitors!(nodes[1], 1);
463 let node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
464 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
465 let events = nodes[0].node.get_and_clear_pending_msg_events();
466 assert_eq!(events.len(), 1);
468 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
469 _ => panic!("Unexpected event"),
472 //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
473 //// channel smoothly
474 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
475 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
476 check_added_monitors!(nodes[1], 1);
477 let node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
478 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
479 let events = nodes[0].node.get_and_clear_pending_msg_events();
480 assert_eq!(events.len(), 2);
482 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
483 _ => panic!("Unexpected event"),
486 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
487 _ => panic!("Unexpected event"),
492 fn test_unsupported_anysegwit_upfront_shutdown_script() {
493 let chanmon_cfgs = create_chanmon_cfgs(2);
494 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
495 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
496 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
498 // Use a non-v0 segwit script supported by option_shutdown_anysegwit
499 let node_features = InitFeatures::known().clear_shutdown_anysegwit();
500 let anysegwit_shutdown_script = Builder::new()
502 .push_slice(&[0, 40])
505 // Check script when handling an open_channel message
506 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
507 let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
508 open_channel.shutdown_scriptpubkey = Present(anysegwit_shutdown_script.clone());
509 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), node_features.clone(), &open_channel);
511 let events = nodes[1].node.get_and_clear_pending_msg_events();
512 assert_eq!(events.len(), 1);
514 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
515 assert_eq!(node_id, nodes[0].node.get_our_node_id());
516 assert_eq!(msg.data, "Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: Script(OP_PUSHNUM_16 OP_PUSHBYTES_2 0028)");
518 _ => panic!("Unexpected event"),
521 // Check script when handling an accept_channel message
522 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
523 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
524 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
525 let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
526 accept_channel.shutdown_scriptpubkey = Present(anysegwit_shutdown_script.clone());
527 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), node_features, &accept_channel);
529 let events = nodes[0].node.get_and_clear_pending_msg_events();
530 assert_eq!(events.len(), 1);
532 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
533 assert_eq!(node_id, nodes[1].node.get_our_node_id());
534 assert_eq!(msg.data, "Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: Script(OP_PUSHNUM_16 OP_PUSHBYTES_2 0028)");
536 _ => panic!("Unexpected event"),
538 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() });
542 fn test_invalid_upfront_shutdown_script() {
543 let chanmon_cfgs = create_chanmon_cfgs(2);
544 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
545 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
546 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
548 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
550 // Use a segwit v0 script with an unsupported witness program
551 let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
552 open_channel.shutdown_scriptpubkey = Present(Builder::new().push_int(0)
555 nodes[0].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
557 let events = nodes[0].node.get_and_clear_pending_msg_events();
558 assert_eq!(events.len(), 1);
560 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
561 assert_eq!(node_id, nodes[0].node.get_our_node_id());
562 assert_eq!(msg.data, "Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: Script(OP_0 OP_PUSHBYTES_2 0000)");
564 _ => panic!("Unexpected event"),
569 fn test_segwit_v0_shutdown_script() {
570 let mut config = UserConfig::default();
571 config.channel_options.announced_channel = true;
572 config.peer_channel_config_limits.force_announced_channel_preference = false;
573 config.channel_options.commit_upfront_shutdown_pubkey = false;
574 let user_cfgs = [None, Some(config), None];
575 let chanmon_cfgs = create_chanmon_cfgs(3);
576 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
577 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
578 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
580 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
581 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
582 check_added_monitors!(nodes[1], 1);
584 // Use a segwit v0 script supported even without option_shutdown_anysegwit
585 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
586 node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
587 .push_slice(&[0; 20])
589 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
591 let events = nodes[0].node.get_and_clear_pending_msg_events();
592 assert_eq!(events.len(), 2);
594 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
595 _ => panic!("Unexpected event"),
598 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
599 _ => panic!("Unexpected event"),
604 fn test_anysegwit_shutdown_script() {
605 let mut config = UserConfig::default();
606 config.channel_options.announced_channel = true;
607 config.peer_channel_config_limits.force_announced_channel_preference = false;
608 config.channel_options.commit_upfront_shutdown_pubkey = false;
609 let user_cfgs = [None, Some(config), None];
610 let chanmon_cfgs = create_chanmon_cfgs(3);
611 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
612 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
613 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
615 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
616 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
617 check_added_monitors!(nodes[1], 1);
619 // Use a non-v0 segwit script supported by option_shutdown_anysegwit
620 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
621 node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
624 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
626 let events = nodes[0].node.get_and_clear_pending_msg_events();
627 assert_eq!(events.len(), 2);
629 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
630 _ => panic!("Unexpected event"),
633 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
634 _ => panic!("Unexpected event"),
639 fn test_unsupported_anysegwit_shutdown_script() {
640 let mut config = UserConfig::default();
641 config.channel_options.announced_channel = true;
642 config.peer_channel_config_limits.force_announced_channel_preference = false;
643 config.channel_options.commit_upfront_shutdown_pubkey = false;
644 let user_cfgs = [None, Some(config), None];
645 let chanmon_cfgs = create_chanmon_cfgs(3);
646 let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
647 node_cfgs[0].features = InitFeatures::known().clear_shutdown_anysegwit();
648 node_cfgs[1].features = InitFeatures::known().clear_shutdown_anysegwit();
649 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
650 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
652 // Check that using an unsupported shutdown script fails and a supported one succeeds.
653 let supported_shutdown_script = chanmon_cfgs[1].keys_manager.get_shutdown_scriptpubkey();
654 let unsupported_shutdown_script =
655 ShutdownScript::new_witness_program(NonZeroU8::new(16).unwrap(), &[0, 40]).unwrap();
656 chanmon_cfgs[1].keys_manager
657 .expect(OnGetShutdownScriptpubkey { returns: unsupported_shutdown_script.clone() })
658 .expect(OnGetShutdownScriptpubkey { returns: supported_shutdown_script });
660 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, node_cfgs[0].features.clone(), node_cfgs[1].features.clone());
661 match nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()) {
662 Err(APIError::IncompatibleShutdownScript { script }) => {
663 assert_eq!(script.into_inner(), unsupported_shutdown_script.clone().into_inner());
665 Err(e) => panic!("Unexpected error: {:?}", e),
666 Ok(_) => panic!("Expected error"),
668 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
669 check_added_monitors!(nodes[1], 1);
671 // Use a non-v0 segwit script unsupported without option_shutdown_anysegwit
672 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
673 node_0_shutdown.scriptpubkey = unsupported_shutdown_script.into_inner();
674 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_cfgs[1].features, &node_0_shutdown);
676 let events = nodes[0].node.get_and_clear_pending_msg_events();
677 assert_eq!(events.len(), 2);
679 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
680 assert_eq!(node_id, nodes[1].node.get_our_node_id());
681 assert_eq!(msg.data, "Got a nonstandard scriptpubkey (60020028) from remote peer".to_owned());
683 _ => panic!("Unexpected event"),
685 check_added_monitors!(nodes[0], 1);
686 check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: "Got a nonstandard scriptpubkey (60020028) from remote peer".to_string() });
690 fn test_invalid_shutdown_script() {
691 let mut config = UserConfig::default();
692 config.channel_options.announced_channel = true;
693 config.peer_channel_config_limits.force_announced_channel_preference = false;
694 config.channel_options.commit_upfront_shutdown_pubkey = false;
695 let user_cfgs = [None, Some(config), None];
696 let chanmon_cfgs = create_chanmon_cfgs(3);
697 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
698 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
699 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
701 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
702 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
703 check_added_monitors!(nodes[1], 1);
705 // Use a segwit v0 script with an unsupported witness program
706 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
707 node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
710 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
712 let events = nodes[0].node.get_and_clear_pending_msg_events();
713 assert_eq!(events.len(), 2);
715 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
716 assert_eq!(node_id, nodes[1].node.get_our_node_id());
717 assert_eq!(msg.data, "Got a nonstandard scriptpubkey (00020000) from remote peer".to_owned())
719 _ => panic!("Unexpected event"),
721 check_added_monitors!(nodes[0], 1);
722 check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: "Got a nonstandard scriptpubkey (00020000) from remote peer".to_string() });
732 fn do_test_closing_signed_reinit_timeout(timeout_step: TimeoutStep) {
733 // The range-based closing signed negotiation allows the funder to restart the process with a
734 // new range if the previous range did not overlap. This allows implementations to request user
735 // intervention allowing users to enter a new fee range. We do not implement the sending side
736 // of this, instead opting to allow users to enter an explicit "willing to pay up to X to avoid
737 // force-closing" value and relying on that instead.
739 // Here we run test the fundee side of that restart mechanism, implementing the funder side of
741 let chanmon_cfgs = create_chanmon_cfgs(2);
742 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
743 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
744 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
745 let chan_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
747 send_payment(&nodes[0], &[&nodes[1]], 8_000_000);
749 nodes[0].node.close_channel(&chan_id).unwrap();
750 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
751 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
752 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
753 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
756 // Now we set nodes[1] to require a relatively high feerate for closing. This should result
757 // in it rejecting nodes[0]'s initial closing_signed, giving nodes[0] a chance to try
759 let mut feerate_lock = chanmon_cfgs[1].fee_estimator.sat_per_kw.lock().unwrap();
763 let mut node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
764 // nodes[0] should use a "reasonable" feerate, well under the 10 sat/vByte that nodes[1] thinks
765 // is the current prevailing feerate.
766 assert!(node_0_closing_signed.fee_satoshis <= 500);
768 if timeout_step != TimeoutStep::AfterShutdown {
769 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
770 // At this point nodes[1] should send back a warning message indicating it disagrees with the
771 // given channel-closing fee. Currently we do not implement warning messages so instead we
772 // remain silent here.
773 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
775 // Now deliver a mutated closing_signed indicating a higher acceptable fee range, which
776 // nodes[1] should happily accept and respond to.
777 node_0_closing_signed.fee_range.as_mut().unwrap().max_fee_satoshis *= 10;
780 get_channel_ref!(nodes[0], lock, chan_id).closing_fee_limits.as_mut().unwrap().1 *= 10;
782 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
783 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
784 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
785 let node_0_2nd_closing_signed = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
786 if timeout_step == TimeoutStep::NoTimeout {
787 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.1.unwrap());
788 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
790 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
793 if timeout_step != TimeoutStep::NoTimeout {
794 assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
796 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
799 nodes[1].node.timer_tick_occurred();
800 nodes[1].node.timer_tick_occurred();
802 let txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
803 assert_eq!(txn.len(), 1);
804 assert_eq!(txn[0].output.len(), 2);
806 if timeout_step != TimeoutStep::NoTimeout {
807 assert!((txn[0].output[0].script_pubkey.is_v0_p2wpkh() &&
808 txn[0].output[1].script_pubkey.is_v0_p2wsh()) ||
809 (txn[0].output[1].script_pubkey.is_v0_p2wpkh() &&
810 txn[0].output[0].script_pubkey.is_v0_p2wsh()));
811 check_closed_broadcast!(nodes[1], true);
812 check_added_monitors!(nodes[1], 1);
813 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "closing_signed negotiation failed to finish within two timer ticks".to_string() });
815 assert!(txn[0].output[0].script_pubkey.is_v0_p2wpkh());
816 assert!(txn[0].output[1].script_pubkey.is_v0_p2wpkh());
818 let events = nodes[1].node.get_and_clear_pending_msg_events();
819 assert_eq!(events.len(), 1);
821 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
822 assert_eq!(msg.contents.flags & 2, 2);
824 _ => panic!("Unexpected event"),
830 fn test_closing_signed_reinit_timeout() {
831 do_test_closing_signed_reinit_timeout(TimeoutStep::AfterShutdown);
832 do_test_closing_signed_reinit_timeout(TimeoutStep::AfterClosingSigned);
833 do_test_closing_signed_reinit_timeout(TimeoutStep::NoTimeout);
836 fn do_simple_legacy_shutdown_test(high_initiator_fee: bool) {
837 // A simpe test of the legacy shutdown fee negotiation logic.
838 let chanmon_cfgs = create_chanmon_cfgs(2);
839 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
840 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
841 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
843 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
845 if high_initiator_fee {
846 // If high_initiator_fee is set, set nodes[0]'s feerate significantly higher. This
847 // shouldn't impact the flow at all given nodes[1] will happily accept the higher fee.
848 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
852 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
853 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
854 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
855 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
856 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
858 let mut node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
859 node_0_closing_signed.fee_range = None;
860 if high_initiator_fee {
861 assert!(node_0_closing_signed.fee_satoshis > 500);
863 assert!(node_0_closing_signed.fee_satoshis < 500);
866 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
867 let (_, mut node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
868 node_1_closing_signed.as_mut().unwrap().fee_range = None;
870 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
871 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
872 assert!(node_0_none.is_none());
873 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
874 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
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());
928 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
929 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);