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 crate::chain::keysinterface::{EntropySource, SignerProvider};
13 use crate::chain::transaction::OutPoint;
14 use crate::events::{Event, MessageSendEvent, MessageSendEventsProvider, ClosureReason};
15 use crate::ln::channelmanager::{self, PaymentSendFailure, PaymentId};
16 use crate::routing::router::{PaymentParameters, get_route};
18 use crate::ln::msgs::{ChannelMessageHandler, ErrorAction};
19 use crate::ln::script::ShutdownScript;
20 use crate::util::test_utils;
21 use crate::util::test_utils::OnGetShutdownScriptpubkey;
22 use crate::util::errors::APIError;
23 use crate::util::config::UserConfig;
24 use crate::util::string::UntrustedString;
26 use bitcoin::blockdata::script::Builder;
27 use bitcoin::blockdata::opcodes;
28 use bitcoin::network::constants::Network;
29 use bitcoin::util::address::WitnessVersion;
33 use core::default::Default;
35 use crate::ln::functional_test_utils::*;
36 use crate::ln::msgs::OptionalField::Present;
39 fn pre_funding_lock_shutdown_test() {
40 // Test sending a shutdown prior to channel_ready after funding generation
41 let chanmon_cfgs = create_chanmon_cfgs(2);
42 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
43 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
44 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
45 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0);
46 mine_transaction(&nodes[0], &tx);
47 mine_transaction(&nodes[1], &tx);
49 nodes[0].node.close_channel(&OutPoint { txid: tx.txid(), index: 0 }.to_channel_id(), &nodes[1].node.get_our_node_id()).unwrap();
50 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
51 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
52 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
53 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
55 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
56 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
57 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
58 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
59 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
60 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
61 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
62 assert!(node_1_none.is_none());
64 assert!(nodes[0].node.list_channels().is_empty());
65 assert!(nodes[1].node.list_channels().is_empty());
66 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
67 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
71 fn updates_shutdown_wait() {
72 // Test sending a shutdown with outstanding updates pending
73 let chanmon_cfgs = create_chanmon_cfgs(3);
74 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
75 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
76 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
77 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
78 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
79 let logger = test_utils::TestLogger::new();
80 let scorer = test_utils::TestScorer::new();
81 let keys_manager = test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
82 let random_seed_bytes = keys_manager.get_secure_random_bytes();
84 let (payment_preimage_0, payment_hash_0, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100_000);
86 nodes[0].node.close_channel(&chan_1.2, &nodes[1].node.get_our_node_id()).unwrap();
87 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
88 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
89 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
90 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
92 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
93 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
95 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
97 let payment_params_1 = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id(), TEST_FINAL_CLTV).with_features(nodes[1].node.invoice_features());
98 let route_1 = get_route(&nodes[0].node.get_our_node_id(), &payment_params_1, &nodes[0].network_graph.read_only(), None, 100000, TEST_FINAL_CLTV, &logger, &scorer, &random_seed_bytes).unwrap();
99 let payment_params_2 = PaymentParameters::from_node_id(nodes[0].node.get_our_node_id(), TEST_FINAL_CLTV).with_features(nodes[0].node.invoice_features());
100 let route_2 = get_route(&nodes[1].node.get_our_node_id(), &payment_params_2, &nodes[1].network_graph.read_only(), None, 100000, TEST_FINAL_CLTV, &logger, &scorer, &random_seed_bytes).unwrap();
101 unwrap_send_err!(nodes[0].node.send_payment(&route_1, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)), true, APIError::ChannelUnavailable {..}, {});
102 unwrap_send_err!(nodes[1].node.send_payment(&route_2, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)), true, APIError::ChannelUnavailable {..}, {});
104 nodes[2].node.claim_funds(payment_preimage_0);
105 check_added_monitors!(nodes[2], 1);
106 expect_payment_claimed!(nodes[2], payment_hash_0, 100_000);
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], nodes[0], nodes[2], Some(1000), false, 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_0);
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);
159 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
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), PaymentId(our_payment_hash.0)).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, &nodes[0].node.get_our_node_id()).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(), &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(), &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);
233 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
235 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100_000);
237 nodes[1].node.close_channel(&chan_1.2, &nodes[0].node.get_our_node_id()).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(), &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(), &node_0_shutdown);
247 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
248 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
250 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: nodes[1].node.init_features(), remote_network_address: None }, true).unwrap();
251 let node_0_reestablish = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
252 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: nodes[0].node.init_features(), remote_network_address: None }, false).unwrap();
253 let node_1_reestablish = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
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(), &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(), &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(), &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 nodes[2].node.claim_funds(payment_preimage);
276 check_added_monitors!(nodes[2], 1);
277 expect_payment_claimed!(nodes[2], payment_hash, 100_000);
279 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
280 assert!(updates.update_add_htlcs.is_empty());
281 assert!(updates.update_fail_htlcs.is_empty());
282 assert!(updates.update_fail_malformed_htlcs.is_empty());
283 assert!(updates.update_fee.is_none());
284 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
285 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
286 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), false, false);
287 check_added_monitors!(nodes[1], 1);
288 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
289 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
291 assert!(updates_2.update_add_htlcs.is_empty());
292 assert!(updates_2.update_fail_htlcs.is_empty());
293 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
294 assert!(updates_2.update_fee.is_none());
295 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
296 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
297 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
298 expect_payment_sent!(nodes[0], payment_preimage);
300 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
302 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
303 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
304 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
305 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
306 assert!(node_0_2nd_closing_signed.is_some());
309 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
310 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
312 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: nodes[0].node.init_features(), remote_network_address: None }, true).unwrap();
313 let node_1_2nd_reestablish = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
314 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: nodes[1].node.init_features(), remote_network_address: None }, false).unwrap();
316 // If all closing_signeds weren't delivered we can just resume where we left off...
317 let node_0_2nd_reestablish = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
319 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
320 let node_0_msgs = nodes[0].node.get_and_clear_pending_msg_events();
321 assert_eq!(node_0_msgs.len(), 2);
322 let node_0_2nd_closing_signed = match node_0_msgs[1] {
323 MessageSendEvent::SendClosingSigned { ref msg, .. } => {
324 assert_eq!(node_0_closing_signed, *msg);
330 let node_0_3rd_shutdown = match node_0_msgs[0] {
331 MessageSendEvent::SendShutdown { ref msg, .. } => {
332 assert_eq!(node_0_2nd_shutdown, *msg);
337 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
339 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
340 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
341 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
343 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_3rd_shutdown);
344 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
346 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_3rd_shutdown);
348 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed);
349 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
350 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
351 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
352 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
353 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
354 assert!(node_1_none.is_none());
355 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
357 // If one node, however, received + responded with an identical closing_signed we end
358 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
359 // There isn't really anything better we can do simply, but in the future we might
360 // explore storing a set of recently-closed channels that got disconnected during
361 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
362 // give our counterparty enough time to (potentially) broadcast a cooperative closing
364 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
366 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
367 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
368 assert_eq!(msg_events.len(), 1);
369 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
371 &ErrorAction::SendErrorMessage { ref msg } => {
372 nodes[1].node.handle_error(&nodes[0].node.get_our_node_id(), &msg);
373 assert_eq!(msg.channel_id, chan_1.2);
375 _ => panic!("Unexpected event!"),
377 } else { panic!("Needed SendErrorMessage close"); }
379 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
380 // checks it, but in this case nodes[1] didn't ever get a chance to receive a
381 // closing_signed so we do it ourselves
382 check_closed_broadcast!(nodes[1], false);
383 check_added_monitors!(nodes[1], 1);
384 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyForceClosed { peer_msg: UntrustedString(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}", &nodes[1].node.get_our_node_id())) });
387 assert!(nodes[0].node.list_channels().is_empty());
389 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
390 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
391 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
392 assert!(nodes[1].node.list_channels().is_empty());
393 assert!(nodes[2].node.list_channels().is_empty());
394 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
395 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
396 check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure);
400 fn test_shutdown_rebroadcast() {
401 do_test_shutdown_rebroadcast(0);
402 do_test_shutdown_rebroadcast(1);
403 do_test_shutdown_rebroadcast(2);
407 fn test_upfront_shutdown_script() {
408 // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
409 // enforce it at shutdown message
411 let mut config = UserConfig::default();
412 config.channel_handshake_config.announced_channel = true;
413 config.channel_handshake_limits.force_announced_channel_preference = false;
414 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
415 let user_cfgs = [None, Some(config), None];
416 let chanmon_cfgs = create_chanmon_cfgs(3);
417 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
418 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
419 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
421 // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
422 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000);
423 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[2].node.get_our_node_id()).unwrap();
424 let node_0_orig_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
425 let mut node_0_shutdown = node_0_orig_shutdown.clone();
426 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
427 // Test we enforce upfront_scriptpbukey if by providing a different one at closing that we warn
428 // the peer and ignore the message.
429 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
430 assert!(regex::Regex::new(r"Got shutdown request with a scriptpubkey \([A-Fa-f0-9]+\) which did not match their previous scriptpubkey.")
431 .unwrap().is_match(&check_warn_msg!(nodes[2], nodes[0].node.get_our_node_id(), chan.2)));
432 // This allows nodes[2] to retry the shutdown message, which should get a response:
433 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_orig_shutdown);
434 get_event_msg!(nodes[2], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
436 // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
437 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000);
438 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[2].node.get_our_node_id()).unwrap();
439 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
440 // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
441 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
442 let events = nodes[2].node.get_and_clear_pending_msg_events();
443 assert_eq!(events.len(), 1);
445 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
446 _ => panic!("Unexpected event"),
449 // We test that if case of peer non-signaling we don't enforce committed script at channel opening
450 *nodes[0].override_init_features.borrow_mut() = Some(nodes[0].node.init_features().clear_upfront_shutdown_script());
451 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000);
452 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[1].node.get_our_node_id()).unwrap();
453 let node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
454 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_1_shutdown);
455 check_added_monitors!(nodes[1], 1);
456 let events = nodes[1].node.get_and_clear_pending_msg_events();
457 assert_eq!(events.len(), 1);
459 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
460 _ => panic!("Unexpected event"),
463 // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
464 // channel smoothly, opt-out is from channel initiator here
465 *nodes[0].override_init_features.borrow_mut() = None;
466 let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000);
467 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[0].node.get_our_node_id()).unwrap();
468 check_added_monitors!(nodes[1], 1);
469 let node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
470 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
471 let events = nodes[0].node.get_and_clear_pending_msg_events();
472 assert_eq!(events.len(), 1);
474 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
475 _ => panic!("Unexpected event"),
478 //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
479 //// channel smoothly
480 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000);
481 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[0].node.get_our_node_id()).unwrap();
482 check_added_monitors!(nodes[1], 1);
483 let node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
484 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
485 let events = nodes[0].node.get_and_clear_pending_msg_events();
486 assert_eq!(events.len(), 2);
488 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
489 _ => panic!("Unexpected event"),
492 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
493 _ => panic!("Unexpected event"),
498 fn test_unsupported_anysegwit_upfront_shutdown_script() {
499 let chanmon_cfgs = create_chanmon_cfgs(2);
500 let mut node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
501 // Clear shutdown_anysegwit on initiator
502 *node_cfgs[0].override_init_features.borrow_mut() = Some(channelmanager::provided_init_features(&test_default_channel_config()).clear_shutdown_anysegwit());
503 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
504 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
506 // Use a non-v0 segwit script supported by option_shutdown_anysegwit
507 let anysegwit_shutdown_script = Builder::new()
509 .push_slice(&[0, 40])
512 // Check script when handling an open_channel message
513 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
514 let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
515 open_channel.shutdown_scriptpubkey = Present(anysegwit_shutdown_script.clone());
516 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel);
518 let events = nodes[1].node.get_and_clear_pending_msg_events();
519 assert_eq!(events.len(), 1);
521 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
522 assert_eq!(node_id, nodes[0].node.get_our_node_id());
523 assert_eq!(msg.data, "Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: Script(OP_PUSHNUM_16 OP_PUSHBYTES_2 0028)");
525 _ => panic!("Unexpected event"),
528 let chanmon_cfgs = create_chanmon_cfgs(2);
529 let mut node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
530 // Clear shutdown_anysegwit on responder
531 *node_cfgs[1].override_init_features.borrow_mut() = Some(channelmanager::provided_init_features(&test_default_channel_config()).clear_shutdown_anysegwit());
532 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
533 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
535 // Check script when handling an accept_channel message
536 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
537 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
538 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel);
539 let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
540 accept_channel.shutdown_scriptpubkey = Present(anysegwit_shutdown_script.clone());
541 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel);
543 let events = nodes[0].node.get_and_clear_pending_msg_events();
544 assert_eq!(events.len(), 1);
546 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
547 assert_eq!(node_id, nodes[1].node.get_our_node_id());
548 assert_eq!(msg.data, "Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: Script(OP_PUSHNUM_16 OP_PUSHBYTES_2 0028)");
550 _ => panic!("Unexpected event"),
552 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() });
556 fn test_invalid_upfront_shutdown_script() {
557 let chanmon_cfgs = create_chanmon_cfgs(2);
558 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
559 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
560 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
562 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
564 // Use a segwit v0 script with an unsupported witness program
565 let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
566 open_channel.shutdown_scriptpubkey = Present(Builder::new().push_int(0)
569 nodes[0].node.handle_open_channel(&nodes[1].node.get_our_node_id(), &open_channel);
571 let events = nodes[0].node.get_and_clear_pending_msg_events();
572 assert_eq!(events.len(), 1);
574 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
575 assert_eq!(node_id, nodes[1].node.get_our_node_id());
576 assert_eq!(msg.data, "Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: Script(OP_0 OP_PUSHBYTES_2 0000)");
578 _ => panic!("Unexpected event"),
583 fn test_segwit_v0_shutdown_script() {
584 let mut config = UserConfig::default();
585 config.channel_handshake_config.announced_channel = true;
586 config.channel_handshake_limits.force_announced_channel_preference = false;
587 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
588 let user_cfgs = [None, Some(config), None];
589 let chanmon_cfgs = create_chanmon_cfgs(3);
590 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
591 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
592 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
594 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
595 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[0].node.get_our_node_id()).unwrap();
596 check_added_monitors!(nodes[1], 1);
598 // Use a segwit v0 script supported even without option_shutdown_anysegwit
599 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
600 node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
601 .push_slice(&[0; 20])
603 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
605 let events = nodes[0].node.get_and_clear_pending_msg_events();
606 assert_eq!(events.len(), 2);
608 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
609 _ => panic!("Unexpected event"),
612 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
613 _ => panic!("Unexpected event"),
618 fn test_anysegwit_shutdown_script() {
619 let mut config = UserConfig::default();
620 config.channel_handshake_config.announced_channel = true;
621 config.channel_handshake_limits.force_announced_channel_preference = false;
622 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
623 let user_cfgs = [None, Some(config), None];
624 let chanmon_cfgs = create_chanmon_cfgs(3);
625 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
626 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
627 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
629 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
630 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[0].node.get_our_node_id()).unwrap();
631 check_added_monitors!(nodes[1], 1);
633 // Use a non-v0 segwit script supported by option_shutdown_anysegwit
634 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
635 node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
638 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
640 let events = nodes[0].node.get_and_clear_pending_msg_events();
641 assert_eq!(events.len(), 2);
643 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
644 _ => panic!("Unexpected event"),
647 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
648 _ => panic!("Unexpected event"),
653 fn test_unsupported_anysegwit_shutdown_script() {
654 let mut config = UserConfig::default();
655 config.channel_handshake_config.announced_channel = true;
656 config.channel_handshake_limits.force_announced_channel_preference = false;
657 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
658 let user_cfgs = [None, Some(config), None];
659 let chanmon_cfgs = create_chanmon_cfgs(3);
660 let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
661 *node_cfgs[0].override_init_features.borrow_mut() = Some(channelmanager::provided_init_features(&config).clear_shutdown_anysegwit());
662 *node_cfgs[1].override_init_features.borrow_mut() = Some(channelmanager::provided_init_features(&config).clear_shutdown_anysegwit());
663 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
664 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
666 // Check that using an unsupported shutdown script fails and a supported one succeeds.
667 let supported_shutdown_script = chanmon_cfgs[1].keys_manager.get_shutdown_scriptpubkey();
668 let unsupported_shutdown_script =
669 ShutdownScript::new_witness_program(WitnessVersion::V16, &[0, 40]).unwrap();
670 chanmon_cfgs[1].keys_manager
671 .expect(OnGetShutdownScriptpubkey { returns: unsupported_shutdown_script.clone() })
672 .expect(OnGetShutdownScriptpubkey { returns: supported_shutdown_script });
674 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
675 match nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[0].node.get_our_node_id()) {
676 Err(APIError::IncompatibleShutdownScript { script }) => {
677 assert_eq!(script.into_inner(), unsupported_shutdown_script.clone().into_inner());
679 Err(e) => panic!("Unexpected error: {:?}", e),
680 Ok(_) => panic!("Expected error"),
682 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[0].node.get_our_node_id()).unwrap();
683 check_added_monitors!(nodes[1], 1);
685 // Use a non-v0 segwit script unsupported without option_shutdown_anysegwit
686 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
687 node_0_shutdown.scriptpubkey = unsupported_shutdown_script.into_inner();
688 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
690 assert_eq!(&check_warn_msg!(nodes[0], nodes[1].node.get_our_node_id(), chan.2),
691 "Got a nonstandard scriptpubkey (60020028) from remote peer");
695 fn test_invalid_shutdown_script() {
696 let mut config = UserConfig::default();
697 config.channel_handshake_config.announced_channel = true;
698 config.channel_handshake_limits.force_announced_channel_preference = false;
699 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
700 let user_cfgs = [None, Some(config), None];
701 let chanmon_cfgs = create_chanmon_cfgs(3);
702 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
703 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
704 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
706 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
707 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[0].node.get_our_node_id()).unwrap();
708 check_added_monitors!(nodes[1], 1);
710 // Use a segwit v0 script with an unsupported witness program
711 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
712 node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
715 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
717 assert_eq!(&check_warn_msg!(nodes[0], nodes[1].node.get_our_node_id(), chan.2),
718 "Got a nonstandard scriptpubkey (00020000) from remote peer");
728 fn do_test_closing_signed_reinit_timeout(timeout_step: TimeoutStep) {
729 // The range-based closing signed negotiation allows the funder to restart the process with a
730 // new range if the previous range did not overlap. This allows implementations to request user
731 // intervention allowing users to enter a new fee range. We do not implement the sending side
732 // of this, instead opting to allow users to enter an explicit "willing to pay up to X to avoid
733 // force-closing" value and relying on that instead.
735 // Here we run test the fundee side of that restart mechanism, implementing the funder side of
737 let chanmon_cfgs = create_chanmon_cfgs(2);
738 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
739 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
740 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
741 let chan_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
743 send_payment(&nodes[0], &[&nodes[1]], 8_000_000);
745 nodes[0].node.close_channel(&chan_id, &nodes[1].node.get_our_node_id()).unwrap();
746 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
747 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
748 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
749 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
752 // Now we set nodes[1] to require a relatively high feerate for closing. This should result
753 // in it rejecting nodes[0]'s initial closing_signed, giving nodes[0] a chance to try
755 let mut feerate_lock = chanmon_cfgs[1].fee_estimator.sat_per_kw.lock().unwrap();
759 let mut node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
760 // nodes[0] should use a "reasonable" feerate, well under the 10 sat/vByte that nodes[1] thinks
761 // is the current prevailing feerate.
762 assert!(node_0_closing_signed.fee_satoshis <= 500);
764 if timeout_step != TimeoutStep::AfterShutdown {
765 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
766 assert!(check_warn_msg!(nodes[1], nodes[0].node.get_our_node_id(), chan_id)
767 .starts_with("Unable to come to consensus about closing feerate"));
769 // Now deliver a mutated closing_signed indicating a higher acceptable fee range, which
770 // nodes[1] should happily accept and respond to.
771 node_0_closing_signed.fee_range.as_mut().unwrap().max_fee_satoshis *= 10;
773 let mut node_0_per_peer_lock;
774 let mut node_0_peer_state_lock;
775 get_channel_ref!(nodes[0], nodes[1], node_0_per_peer_lock, node_0_peer_state_lock, chan_id).closing_fee_limits.as_mut().unwrap().1 *= 10;
777 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
778 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
779 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
780 let node_0_2nd_closing_signed = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
781 if timeout_step == TimeoutStep::NoTimeout {
782 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.1.unwrap());
783 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
785 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
788 if timeout_step != TimeoutStep::NoTimeout {
789 assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
791 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
794 nodes[1].node.timer_tick_occurred();
795 nodes[1].node.timer_tick_occurred();
797 let txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
798 assert_eq!(txn.len(), 1);
799 assert_eq!(txn[0].output.len(), 2);
801 if timeout_step != TimeoutStep::NoTimeout {
802 assert!((txn[0].output[0].script_pubkey.is_v0_p2wpkh() &&
803 txn[0].output[1].script_pubkey.is_v0_p2wsh()) ||
804 (txn[0].output[1].script_pubkey.is_v0_p2wpkh() &&
805 txn[0].output[0].script_pubkey.is_v0_p2wsh()));
806 check_closed_broadcast!(nodes[1], true);
807 check_added_monitors!(nodes[1], 1);
808 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "closing_signed negotiation failed to finish within two timer ticks".to_string() });
810 assert!(txn[0].output[0].script_pubkey.is_v0_p2wpkh());
811 assert!(txn[0].output[1].script_pubkey.is_v0_p2wpkh());
813 let events = nodes[1].node.get_and_clear_pending_msg_events();
814 assert_eq!(events.len(), 1);
816 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
817 assert_eq!(msg.contents.flags & 2, 2);
819 _ => panic!("Unexpected event"),
825 fn test_closing_signed_reinit_timeout() {
826 do_test_closing_signed_reinit_timeout(TimeoutStep::AfterShutdown);
827 do_test_closing_signed_reinit_timeout(TimeoutStep::AfterClosingSigned);
828 do_test_closing_signed_reinit_timeout(TimeoutStep::NoTimeout);
831 fn do_simple_legacy_shutdown_test(high_initiator_fee: bool) {
832 // A simpe test of the legacy shutdown fee negotiation logic.
833 let chanmon_cfgs = create_chanmon_cfgs(2);
834 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
835 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
836 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
838 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
840 if high_initiator_fee {
841 // If high_initiator_fee is set, set nodes[0]'s feerate significantly higher. This
842 // shouldn't impact the flow at all given nodes[1] will happily accept the higher fee.
843 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
847 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[1].node.get_our_node_id()).unwrap();
848 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
849 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
850 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
851 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
853 let mut node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
854 node_0_closing_signed.fee_range = None;
855 if high_initiator_fee {
856 assert!(node_0_closing_signed.fee_satoshis > 500);
858 assert!(node_0_closing_signed.fee_satoshis < 500);
861 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
862 let (_, mut node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
863 node_1_closing_signed.as_mut().unwrap().fee_range = None;
865 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
866 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
867 assert!(node_0_none.is_none());
868 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
869 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
873 fn simple_legacy_shutdown_test() {
874 do_simple_legacy_shutdown_test(false);
875 do_simple_legacy_shutdown_test(true);
879 fn simple_target_feerate_shutdown() {
880 // Simple test of target in `close_channel_with_target_feerate`.
881 let chanmon_cfgs = create_chanmon_cfgs(2);
882 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
883 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
884 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
886 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
887 let chan_id = OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id();
889 nodes[0].node.close_channel_with_target_feerate(&chan_id, &nodes[1].node.get_our_node_id(), 253 * 10).unwrap();
890 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
891 nodes[1].node.close_channel_with_target_feerate(&chan_id, &nodes[0].node.get_our_node_id(), 253 * 5).unwrap();
892 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
894 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
895 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
897 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
898 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
899 let (_, node_1_closing_signed_opt) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
900 let node_1_closing_signed = node_1_closing_signed_opt.unwrap();
902 // nodes[1] was passed a target which was larger than the current channel feerate, which it
903 // should ignore in favor of the channel fee, as there is no use demanding a minimum higher
904 // than what will be paid on a force-close transaction. Note that we have to consider rounding,
905 // so only check that we're within 10 sats.
906 assert!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis >=
907 node_1_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis * 10 - 5);
908 assert!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis <=
909 node_1_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis * 10 + 5);
911 // Further, because nodes[0]'s target fee is larger than the `Normal` fee estimation plus our
912 // force-closure-avoidance buffer, min should equal max, and the nodes[1]-selected fee should
913 // be the nodes[0] only available fee.
914 assert_eq!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis,
915 node_0_closing_signed.fee_range.as_ref().unwrap().max_fee_satoshis);
916 assert_eq!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis,
917 node_0_closing_signed.fee_satoshis);
918 assert_eq!(node_0_closing_signed.fee_satoshis, node_1_closing_signed.fee_satoshis);
920 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
921 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
922 assert!(node_0_none.is_none());
923 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
924 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);