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 (our_payment_preimage, our_payment_hash, _) = 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::new(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::new(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(our_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);
128 let events = nodes[0].node.get_and_clear_pending_events();
129 assert_eq!(events.len(), 1);
131 Event::PaymentSent { ref payment_preimage, ref payment_hash, .. } => {
132 assert_eq!(our_payment_preimage, *payment_preimage);
133 assert_eq!(our_payment_hash, *payment_hash);
135 _ => panic!("Unexpected event"),
138 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
139 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
140 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
141 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
142 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
143 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
144 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
145 assert!(node_1_none.is_none());
146 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
147 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
149 assert!(nodes[0].node.list_channels().is_empty());
151 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
152 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
153 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
154 assert!(nodes[1].node.list_channels().is_empty());
155 assert!(nodes[2].node.list_channels().is_empty());
156 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
157 check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure);
161 fn htlc_fail_async_shutdown() {
162 // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
163 let chanmon_cfgs = create_chanmon_cfgs(3);
164 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
165 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
166 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
167 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
168 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
170 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], 100000);
171 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
172 check_added_monitors!(nodes[0], 1);
173 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
174 assert_eq!(updates.update_add_htlcs.len(), 1);
175 assert!(updates.update_fulfill_htlcs.is_empty());
176 assert!(updates.update_fail_htlcs.is_empty());
177 assert!(updates.update_fail_malformed_htlcs.is_empty());
178 assert!(updates.update_fee.is_none());
180 nodes[1].node.close_channel(&chan_1.2).unwrap();
181 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
182 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
183 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
185 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
186 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
187 check_added_monitors!(nodes[1], 1);
188 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
189 commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
191 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
192 assert!(updates_2.update_add_htlcs.is_empty());
193 assert!(updates_2.update_fulfill_htlcs.is_empty());
194 assert_eq!(updates_2.update_fail_htlcs.len(), 1);
195 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
196 assert!(updates_2.update_fee.is_none());
198 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]);
199 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
201 expect_payment_failed_with_update!(nodes[0], our_payment_hash, false, chan_2.0.contents.short_channel_id, true);
203 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
204 assert_eq!(msg_events.len(), 1);
205 let node_0_closing_signed = match msg_events[0] {
206 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
207 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
210 _ => panic!("Unexpected event"),
213 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
214 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
215 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
216 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
217 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
218 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
219 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
220 assert!(node_1_none.is_none());
222 assert!(nodes[0].node.list_channels().is_empty());
224 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
225 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
226 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
227 assert!(nodes[1].node.list_channels().is_empty());
228 assert!(nodes[2].node.list_channels().is_empty());
229 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
230 check_closed_event!(nodes[1], 2, ClosureReason::CooperativeClosure);
231 check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure);
234 fn do_test_shutdown_rebroadcast(recv_count: u8) {
235 // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
236 // messages delivered prior to disconnect
237 let chanmon_cfgs = create_chanmon_cfgs(3);
238 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
239 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
240 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
241 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
242 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
244 let (our_payment_preimage, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
246 nodes[1].node.close_channel(&chan_1.2).unwrap();
247 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
249 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
250 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
252 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
256 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
257 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
259 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
260 let node_0_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
261 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
262 let node_1_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
264 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish);
265 let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
266 assert!(node_1_shutdown == node_1_2nd_shutdown);
268 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish);
269 let node_0_2nd_shutdown = if recv_count > 0 {
270 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
271 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_2nd_shutdown);
274 let node_0_chan_update = get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
275 assert_eq!(node_0_chan_update.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
276 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_2nd_shutdown);
277 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
279 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_2nd_shutdown);
281 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
282 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
284 assert!(nodes[2].node.claim_funds(our_payment_preimage));
285 check_added_monitors!(nodes[2], 1);
286 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
287 assert!(updates.update_add_htlcs.is_empty());
288 assert!(updates.update_fail_htlcs.is_empty());
289 assert!(updates.update_fail_malformed_htlcs.is_empty());
290 assert!(updates.update_fee.is_none());
291 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
292 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
293 expect_payment_forwarded!(nodes[1], Some(1000), false);
294 check_added_monitors!(nodes[1], 1);
295 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
296 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
298 assert!(updates_2.update_add_htlcs.is_empty());
299 assert!(updates_2.update_fail_htlcs.is_empty());
300 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
301 assert!(updates_2.update_fee.is_none());
302 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
303 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
304 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
306 let events = nodes[0].node.get_and_clear_pending_events();
307 assert_eq!(events.len(), 1);
309 Event::PaymentSent { ref payment_preimage, ref payment_hash, .. } => {
310 assert_eq!(our_payment_preimage, *payment_preimage);
311 assert_eq!(our_payment_hash, *payment_hash);
313 _ => panic!("Unexpected event"),
316 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
318 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
319 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
320 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
321 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
322 assert!(node_0_2nd_closing_signed.is_some());
325 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
326 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
328 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
329 let node_1_2nd_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
330 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
332 // If all closing_signeds weren't delivered we can just resume where we left off...
333 let node_0_2nd_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
335 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
336 let node_0_msgs = nodes[0].node.get_and_clear_pending_msg_events();
337 assert_eq!(node_0_msgs.len(), 2);
338 let node_0_2nd_closing_signed = match node_0_msgs[1] {
339 MessageSendEvent::SendClosingSigned { ref msg, .. } => {
340 assert_eq!(node_0_closing_signed, *msg);
346 let node_0_3rd_shutdown = match node_0_msgs[0] {
347 MessageSendEvent::SendShutdown { ref msg, .. } => {
348 assert_eq!(node_0_2nd_shutdown, *msg);
353 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
355 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
356 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
357 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
359 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_3rd_shutdown);
360 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
362 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_3rd_shutdown);
364 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed);
365 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
366 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
367 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
368 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
369 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
370 assert!(node_1_none.is_none());
371 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
373 // If one node, however, received + responded with an identical closing_signed we end
374 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
375 // There isn't really anything better we can do simply, but in the future we might
376 // explore storing a set of recently-closed channels that got disconnected during
377 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
378 // give our counterparty enough time to (potentially) broadcast a cooperative closing
380 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
382 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
383 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
384 assert_eq!(msg_events.len(), 1);
385 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
387 &ErrorAction::SendErrorMessage { ref msg } => {
388 nodes[1].node.handle_error(&nodes[0].node.get_our_node_id(), &msg);
389 assert_eq!(msg.channel_id, chan_1.2);
391 _ => panic!("Unexpected event!"),
393 } else { panic!("Needed SendErrorMessage close"); }
395 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
396 // checks it, but in this case nodes[1] didn't ever get a chance to receive a
397 // closing_signed so we do it ourselves
398 check_closed_broadcast!(nodes[1], false);
399 check_added_monitors!(nodes[1], 1);
400 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyForceClosed { peer_msg: "Failed to find corresponding channel".to_string() });
403 assert!(nodes[0].node.list_channels().is_empty());
405 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
406 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
407 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
408 assert!(nodes[1].node.list_channels().is_empty());
409 assert!(nodes[2].node.list_channels().is_empty());
410 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
411 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
412 check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure);
416 fn test_shutdown_rebroadcast() {
417 do_test_shutdown_rebroadcast(0);
418 do_test_shutdown_rebroadcast(1);
419 do_test_shutdown_rebroadcast(2);
423 fn test_upfront_shutdown_script() {
424 // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
425 // enforce it at shutdown message
427 let mut config = UserConfig::default();
428 config.channel_options.announced_channel = true;
429 config.peer_channel_config_limits.force_announced_channel_preference = false;
430 config.channel_options.commit_upfront_shutdown_pubkey = false;
431 let user_cfgs = [None, Some(config), None];
432 let chanmon_cfgs = create_chanmon_cfgs(3);
433 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
434 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
435 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
437 // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
438 let flags = InitFeatures::known();
439 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
440 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
441 let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
442 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
443 // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that we disconnect peer
444 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
445 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()));
446 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() });
447 check_added_monitors!(nodes[2], 1);
449 // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
450 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
451 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
452 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
453 // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
454 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
455 let events = nodes[2].node.get_and_clear_pending_msg_events();
456 assert_eq!(events.len(), 1);
458 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
459 _ => panic!("Unexpected event"),
462 // We test that if case of peer non-signaling we don't enforce committed script at channel opening
463 let flags_no = InitFeatures::known().clear_upfront_shutdown_script();
464 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
465 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
466 let node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
467 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
468 check_added_monitors!(nodes[1], 1);
469 let events = nodes[1].node.get_and_clear_pending_msg_events();
470 assert_eq!(events.len(), 1);
472 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
473 _ => panic!("Unexpected event"),
476 // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
477 // channel smoothly, opt-out is from channel initiator here
478 let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
479 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
480 check_added_monitors!(nodes[1], 1);
481 let node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
482 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
483 let events = nodes[0].node.get_and_clear_pending_msg_events();
484 assert_eq!(events.len(), 1);
486 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
487 _ => panic!("Unexpected event"),
490 //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
491 //// channel smoothly
492 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
493 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
494 check_added_monitors!(nodes[1], 1);
495 let node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
496 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
497 let events = nodes[0].node.get_and_clear_pending_msg_events();
498 assert_eq!(events.len(), 2);
500 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
501 _ => panic!("Unexpected event"),
504 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
505 _ => panic!("Unexpected event"),
510 fn test_unsupported_anysegwit_upfront_shutdown_script() {
511 let chanmon_cfgs = create_chanmon_cfgs(2);
512 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
513 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
514 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
516 // Use a non-v0 segwit script supported by option_shutdown_anysegwit
517 let node_features = InitFeatures::known().clear_shutdown_anysegwit();
518 let anysegwit_shutdown_script = Builder::new()
520 .push_slice(&[0, 40])
523 // Check script when handling an open_channel message
524 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
525 let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
526 open_channel.shutdown_scriptpubkey = Present(anysegwit_shutdown_script.clone());
527 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), node_features.clone(), &open_channel);
529 let events = nodes[1].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[0].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"),
539 // Check script when handling an accept_channel message
540 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
541 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
542 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
543 let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
544 accept_channel.shutdown_scriptpubkey = Present(anysegwit_shutdown_script.clone());
545 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), node_features, &accept_channel);
547 let events = nodes[0].node.get_and_clear_pending_msg_events();
548 assert_eq!(events.len(), 1);
550 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
551 assert_eq!(node_id, nodes[1].node.get_our_node_id());
552 assert_eq!(msg.data, "Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: Script(OP_PUSHNUM_16 OP_PUSHBYTES_2 0028)");
554 _ => panic!("Unexpected event"),
556 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() });
560 fn test_invalid_upfront_shutdown_script() {
561 let chanmon_cfgs = create_chanmon_cfgs(2);
562 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
563 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
564 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
566 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
568 // Use a segwit v0 script with an unsupported witness program
569 let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
570 open_channel.shutdown_scriptpubkey = Present(Builder::new().push_int(0)
573 nodes[0].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
575 let events = nodes[0].node.get_and_clear_pending_msg_events();
576 assert_eq!(events.len(), 1);
578 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
579 assert_eq!(node_id, nodes[0].node.get_our_node_id());
580 assert_eq!(msg.data, "Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: Script(OP_0 OP_PUSHBYTES_2 0000)");
582 _ => panic!("Unexpected event"),
587 fn test_segwit_v0_shutdown_script() {
588 let mut config = UserConfig::default();
589 config.channel_options.announced_channel = true;
590 config.peer_channel_config_limits.force_announced_channel_preference = false;
591 config.channel_options.commit_upfront_shutdown_pubkey = false;
592 let user_cfgs = [None, Some(config), None];
593 let chanmon_cfgs = create_chanmon_cfgs(3);
594 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
595 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
596 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
598 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
599 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
600 check_added_monitors!(nodes[1], 1);
602 // Use a segwit v0 script supported even without option_shutdown_anysegwit
603 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
604 node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
605 .push_slice(&[0; 20])
607 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
609 let events = nodes[0].node.get_and_clear_pending_msg_events();
610 assert_eq!(events.len(), 2);
612 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
613 _ => panic!("Unexpected event"),
616 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
617 _ => panic!("Unexpected event"),
622 fn test_anysegwit_shutdown_script() {
623 let mut config = UserConfig::default();
624 config.channel_options.announced_channel = true;
625 config.peer_channel_config_limits.force_announced_channel_preference = false;
626 config.channel_options.commit_upfront_shutdown_pubkey = false;
627 let user_cfgs = [None, Some(config), None];
628 let chanmon_cfgs = create_chanmon_cfgs(3);
629 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
630 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
631 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
633 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
634 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
635 check_added_monitors!(nodes[1], 1);
637 // Use a non-v0 segwit script supported by option_shutdown_anysegwit
638 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
639 node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
642 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
644 let events = nodes[0].node.get_and_clear_pending_msg_events();
645 assert_eq!(events.len(), 2);
647 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
648 _ => panic!("Unexpected event"),
651 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
652 _ => panic!("Unexpected event"),
657 fn test_unsupported_anysegwit_shutdown_script() {
658 let mut config = UserConfig::default();
659 config.channel_options.announced_channel = true;
660 config.peer_channel_config_limits.force_announced_channel_preference = false;
661 config.channel_options.commit_upfront_shutdown_pubkey = false;
662 let user_cfgs = [None, Some(config), None];
663 let chanmon_cfgs = create_chanmon_cfgs(3);
664 let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
665 node_cfgs[0].features = InitFeatures::known().clear_shutdown_anysegwit();
666 node_cfgs[1].features = InitFeatures::known().clear_shutdown_anysegwit();
667 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
668 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
670 // Check that using an unsupported shutdown script fails and a supported one succeeds.
671 let supported_shutdown_script = chanmon_cfgs[1].keys_manager.get_shutdown_scriptpubkey();
672 let unsupported_shutdown_script =
673 ShutdownScript::new_witness_program(NonZeroU8::new(16).unwrap(), &[0, 40]).unwrap();
674 chanmon_cfgs[1].keys_manager
675 .expect(OnGetShutdownScriptpubkey { returns: unsupported_shutdown_script.clone() })
676 .expect(OnGetShutdownScriptpubkey { returns: supported_shutdown_script });
678 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, node_cfgs[0].features.clone(), node_cfgs[1].features.clone());
679 match nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()) {
680 Err(APIError::IncompatibleShutdownScript { script }) => {
681 assert_eq!(script.into_inner(), unsupported_shutdown_script.clone().into_inner());
683 Err(e) => panic!("Unexpected error: {:?}", e),
684 Ok(_) => panic!("Expected error"),
686 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
687 check_added_monitors!(nodes[1], 1);
689 // Use a non-v0 segwit script unsupported without option_shutdown_anysegwit
690 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
691 node_0_shutdown.scriptpubkey = unsupported_shutdown_script.into_inner();
692 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_cfgs[1].features, &node_0_shutdown);
694 let events = nodes[0].node.get_and_clear_pending_msg_events();
695 assert_eq!(events.len(), 2);
697 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
698 assert_eq!(node_id, nodes[1].node.get_our_node_id());
699 assert_eq!(msg.data, "Got a nonstandard scriptpubkey (60020028) from remote peer".to_owned());
701 _ => panic!("Unexpected event"),
703 check_added_monitors!(nodes[0], 1);
704 check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: "Got a nonstandard scriptpubkey (60020028) from remote peer".to_string() });
708 fn test_invalid_shutdown_script() {
709 let mut config = UserConfig::default();
710 config.channel_options.announced_channel = true;
711 config.peer_channel_config_limits.force_announced_channel_preference = false;
712 config.channel_options.commit_upfront_shutdown_pubkey = false;
713 let user_cfgs = [None, Some(config), None];
714 let chanmon_cfgs = create_chanmon_cfgs(3);
715 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
716 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
717 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
719 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
720 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
721 check_added_monitors!(nodes[1], 1);
723 // Use a segwit v0 script with an unsupported witness program
724 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
725 node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
728 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
730 let events = nodes[0].node.get_and_clear_pending_msg_events();
731 assert_eq!(events.len(), 2);
733 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
734 assert_eq!(node_id, nodes[1].node.get_our_node_id());
735 assert_eq!(msg.data, "Got a nonstandard scriptpubkey (00020000) from remote peer".to_owned())
737 _ => panic!("Unexpected event"),
739 check_added_monitors!(nodes[0], 1);
740 check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: "Got a nonstandard scriptpubkey (00020000) from remote peer".to_string() });
750 fn do_test_closing_signed_reinit_timeout(timeout_step: TimeoutStep) {
751 // The range-based closing signed negotiation allows the funder to restart the process with a
752 // new range if the previous range did not overlap. This allows implementations to request user
753 // intervention allowing users to enter a new fee range. We do not implement the sending side
754 // of this, instead opting to allow users to enter an explicit "willing to pay up to X to avoid
755 // force-closing" value and relying on that instead.
757 // Here we run test the fundee side of that restart mechanism, implementing the funder side of
759 let chanmon_cfgs = create_chanmon_cfgs(2);
760 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
761 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
762 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
763 let chan_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
765 send_payment(&nodes[0], &[&nodes[1]], 8_000_000);
767 nodes[0].node.close_channel(&chan_id).unwrap();
768 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
769 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
770 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
771 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
774 // Now we set nodes[1] to require a relatively high feerate for closing. This should result
775 // in it rejecting nodes[0]'s initial closing_signed, giving nodes[0] a chance to try
777 let mut feerate_lock = chanmon_cfgs[1].fee_estimator.sat_per_kw.lock().unwrap();
781 let mut node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
782 // nodes[0] should use a "reasonable" feerate, well under the 10 sat/vByte that nodes[1] thinks
783 // is the current prevailing feerate.
784 assert!(node_0_closing_signed.fee_satoshis <= 500);
786 if timeout_step != TimeoutStep::AfterShutdown {
787 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
788 // At this point nodes[1] should send back a warning message indicating it disagrees with the
789 // given channel-closing fee. Currently we do not implement warning messages so instead we
790 // remain silent here.
791 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
793 // Now deliver a mutated closing_signed indicating a higher acceptable fee range, which
794 // nodes[1] should happily accept and respond to.
795 node_0_closing_signed.fee_range.as_mut().unwrap().max_fee_satoshis *= 10;
798 get_channel_ref!(nodes[0], lock, chan_id).closing_fee_limits.as_mut().unwrap().1 *= 10;
800 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
801 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
802 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
803 let node_0_2nd_closing_signed = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
804 if timeout_step == TimeoutStep::NoTimeout {
805 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.1.unwrap());
806 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
808 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
811 if timeout_step != TimeoutStep::NoTimeout {
812 assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
814 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
817 nodes[1].node.timer_tick_occurred();
818 nodes[1].node.timer_tick_occurred();
820 let txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
821 assert_eq!(txn.len(), 1);
822 assert_eq!(txn[0].output.len(), 2);
824 if timeout_step != TimeoutStep::NoTimeout {
825 assert!((txn[0].output[0].script_pubkey.is_v0_p2wpkh() &&
826 txn[0].output[1].script_pubkey.is_v0_p2wsh()) ||
827 (txn[0].output[1].script_pubkey.is_v0_p2wpkh() &&
828 txn[0].output[0].script_pubkey.is_v0_p2wsh()));
829 check_closed_broadcast!(nodes[1], true);
830 check_added_monitors!(nodes[1], 1);
831 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "closing_signed negotiation failed to finish within two timer ticks".to_string() });
833 assert!(txn[0].output[0].script_pubkey.is_v0_p2wpkh());
834 assert!(txn[0].output[1].script_pubkey.is_v0_p2wpkh());
836 let events = nodes[1].node.get_and_clear_pending_msg_events();
837 assert_eq!(events.len(), 1);
839 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
840 assert_eq!(msg.contents.flags & 2, 2);
842 _ => panic!("Unexpected event"),
848 fn test_closing_signed_reinit_timeout() {
849 do_test_closing_signed_reinit_timeout(TimeoutStep::AfterShutdown);
850 do_test_closing_signed_reinit_timeout(TimeoutStep::AfterClosingSigned);
851 do_test_closing_signed_reinit_timeout(TimeoutStep::NoTimeout);
854 fn do_simple_legacy_shutdown_test(high_initiator_fee: bool) {
855 // A simpe test of the legacy shutdown fee negotiation logic.
856 let chanmon_cfgs = create_chanmon_cfgs(2);
857 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
858 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
859 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
861 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
863 if high_initiator_fee {
864 // If high_initiator_fee is set, set nodes[0]'s feerate significantly higher. This
865 // shouldn't impact the flow at all given nodes[1] will happily accept the higher fee.
866 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
870 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
871 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
872 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
873 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
874 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
876 let mut node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
877 node_0_closing_signed.fee_range = None;
878 if high_initiator_fee {
879 assert!(node_0_closing_signed.fee_satoshis > 500);
881 assert!(node_0_closing_signed.fee_satoshis < 500);
884 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
885 let (_, mut node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
886 node_1_closing_signed.as_mut().unwrap().fee_range = None;
888 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
889 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
890 assert!(node_0_none.is_none());
891 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
892 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
896 fn simple_legacy_shutdown_test() {
897 do_simple_legacy_shutdown_test(false);
898 do_simple_legacy_shutdown_test(true);
902 fn simple_target_feerate_shutdown() {
903 // Simple test of target in `close_channel_with_target_feerate`.
904 let chanmon_cfgs = create_chanmon_cfgs(2);
905 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
906 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
907 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
909 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
910 let chan_id = OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id();
912 nodes[0].node.close_channel_with_target_feerate(&chan_id, 253 * 10).unwrap();
913 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
914 nodes[1].node.close_channel_with_target_feerate(&chan_id, 253 * 5).unwrap();
915 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
917 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
918 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
920 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
921 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
922 let (_, node_1_closing_signed_opt) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
923 let node_1_closing_signed = node_1_closing_signed_opt.unwrap();
925 // nodes[1] was passed a target which was larger than the current channel feerate, which it
926 // should ignore in favor of the channel fee, as there is no use demanding a minimum higher
927 // than what will be paid on a force-close transaction. Note that we have to consider rounding,
928 // so only check that we're within 10 sats.
929 assert!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis >=
930 node_1_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis * 10 - 5);
931 assert!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis <=
932 node_1_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis * 10 + 5);
934 // Further, because nodes[0]'s target fee is larger than the `Normal` fee estimation plus our
935 // force-closure-avoidance buffer, min should equal max, and the nodes[1]-selected fee should
936 // be the nodes[0] only available fee.
937 assert_eq!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis,
938 node_0_closing_signed.fee_range.as_ref().unwrap().max_fee_satoshis);
939 assert_eq!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis,
940 node_0_closing_signed.fee_satoshis);
941 assert_eq!(node_0_closing_signed.fee_satoshis, node_1_closing_signed.fee_satoshis);
943 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
944 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
945 assert!(node_0_none.is_none());
946 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
947 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);