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::sign::{EntropySource, SignerProvider};
13 use crate::chain::transaction::OutPoint;
14 use crate::events::{Event, MessageSendEvent, MessageSendEventsProvider, ClosureReason};
15 use crate::ln::channelmanager::{self, PaymentSendFailure, PaymentId, RecipientOnionFields};
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;
34 use std::convert::TryFrom;
36 use crate::ln::functional_test_utils::*;
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_bolt11_features(nodes[1].node.invoice_features()).unwrap();
98 let route_1 = get_route(&nodes[0].node.get_our_node_id(), &payment_params_1, &nodes[0].network_graph.read_only(), None, 100000, &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_bolt11_features(nodes[0].node.invoice_features()).unwrap();
100 let route_2 = get_route(&nodes[1].node.get_our_node_id(), &payment_params_2, &nodes[1].network_graph.read_only(), None, 100000, &logger, &scorer, &(), &random_seed_bytes).unwrap();
101 unwrap_send_err!(nodes[0].node.send_payment_with_route(&route_1, payment_hash,
102 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)
103 ), true, APIError::ChannelUnavailable {..}, {});
104 unwrap_send_err!(nodes[1].node.send_payment_with_route(&route_2, payment_hash,
105 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)
106 ), true, APIError::ChannelUnavailable {..}, {});
108 nodes[2].node.claim_funds(payment_preimage_0);
109 check_added_monitors!(nodes[2], 1);
110 expect_payment_claimed!(nodes[2], payment_hash_0, 100_000);
112 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
113 assert!(updates.update_add_htlcs.is_empty());
114 assert!(updates.update_fail_htlcs.is_empty());
115 assert!(updates.update_fail_malformed_htlcs.is_empty());
116 assert!(updates.update_fee.is_none());
117 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
118 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
119 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), false, false);
120 check_added_monitors!(nodes[1], 1);
121 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
122 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
124 assert!(updates_2.update_add_htlcs.is_empty());
125 assert!(updates_2.update_fail_htlcs.is_empty());
126 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
127 assert!(updates_2.update_fee.is_none());
128 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
129 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
130 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
131 expect_payment_sent!(nodes[0], payment_preimage_0);
133 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
134 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
135 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
136 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
137 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
138 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
139 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
140 assert!(node_1_none.is_none());
141 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
142 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
144 assert!(nodes[0].node.list_channels().is_empty());
146 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
147 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
148 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
149 assert!(nodes[1].node.list_channels().is_empty());
150 assert!(nodes[2].node.list_channels().is_empty());
151 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
152 check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure);
156 fn htlc_fail_async_shutdown() {
157 // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
158 let chanmon_cfgs = create_chanmon_cfgs(3);
159 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
160 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
161 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
162 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
163 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
165 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], 100000);
166 nodes[0].node.send_payment_with_route(&route, our_payment_hash,
167 RecipientOnionFields::secret_only(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
168 check_added_monitors!(nodes[0], 1);
169 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
170 assert_eq!(updates.update_add_htlcs.len(), 1);
171 assert!(updates.update_fulfill_htlcs.is_empty());
172 assert!(updates.update_fail_htlcs.is_empty());
173 assert!(updates.update_fail_malformed_htlcs.is_empty());
174 assert!(updates.update_fee.is_none());
176 nodes[1].node.close_channel(&chan_1.2, &nodes[0].node.get_our_node_id()).unwrap();
177 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
178 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
179 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
181 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
182 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
183 check_added_monitors!(nodes[1], 1);
184 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
185 commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
187 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
188 assert!(updates_2.update_add_htlcs.is_empty());
189 assert!(updates_2.update_fulfill_htlcs.is_empty());
190 assert_eq!(updates_2.update_fail_htlcs.len(), 1);
191 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
192 assert!(updates_2.update_fee.is_none());
194 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]);
195 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
197 expect_payment_failed_with_update!(nodes[0], our_payment_hash, false, chan_2.0.contents.short_channel_id, true);
199 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
200 assert_eq!(msg_events.len(), 1);
201 let node_0_closing_signed = match msg_events[0] {
202 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
203 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
206 _ => panic!("Unexpected event"),
209 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
210 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
211 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
212 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
213 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
214 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
215 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
216 assert!(node_1_none.is_none());
218 assert!(nodes[0].node.list_channels().is_empty());
220 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
221 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
222 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
223 assert!(nodes[1].node.list_channels().is_empty());
224 assert!(nodes[2].node.list_channels().is_empty());
225 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
226 check_closed_event!(nodes[1], 2, ClosureReason::CooperativeClosure);
227 check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure);
230 fn do_test_shutdown_rebroadcast(recv_count: u8) {
231 // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
232 // messages delivered prior to disconnect
233 let chanmon_cfgs = create_chanmon_cfgs(3);
234 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
235 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
236 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
237 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
238 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
240 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100_000);
242 nodes[1].node.close_channel(&chan_1.2, &nodes[0].node.get_our_node_id()).unwrap();
243 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
245 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
246 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
248 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
252 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
253 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
255 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
256 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
258 let node_0_reestablish = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
259 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
260 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
262 let node_1_reestablish = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
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(), &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(), &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(), &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 nodes[2].node.claim_funds(payment_preimage);
285 check_added_monitors!(nodes[2], 1);
286 expect_payment_claimed!(nodes[2], payment_hash, 100_000);
288 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
289 assert!(updates.update_add_htlcs.is_empty());
290 assert!(updates.update_fail_htlcs.is_empty());
291 assert!(updates.update_fail_malformed_htlcs.is_empty());
292 assert!(updates.update_fee.is_none());
293 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
294 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
295 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), false, false);
296 check_added_monitors!(nodes[1], 1);
297 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
298 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
300 assert!(updates_2.update_add_htlcs.is_empty());
301 assert!(updates_2.update_fail_htlcs.is_empty());
302 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
303 assert!(updates_2.update_fee.is_none());
304 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
305 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
306 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
307 expect_payment_sent!(nodes[0], payment_preimage);
309 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
311 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
312 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
313 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
314 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
315 assert!(node_0_2nd_closing_signed.is_some());
318 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
319 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
321 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
322 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
324 let node_1_2nd_reestablish = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
325 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
326 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
329 // If all closing_signeds weren't delivered we can just resume where we left off...
330 let node_0_2nd_reestablish = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
332 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
333 let node_0_msgs = nodes[0].node.get_and_clear_pending_msg_events();
334 assert_eq!(node_0_msgs.len(), 2);
335 let node_0_2nd_closing_signed = match node_0_msgs[1] {
336 MessageSendEvent::SendClosingSigned { ref msg, .. } => {
337 assert_eq!(node_0_closing_signed, *msg);
343 let node_0_3rd_shutdown = match node_0_msgs[0] {
344 MessageSendEvent::SendShutdown { ref msg, .. } => {
345 assert_eq!(node_0_2nd_shutdown, *msg);
350 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
352 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
353 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
354 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
356 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_3rd_shutdown);
357 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
359 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_3rd_shutdown);
361 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed);
362 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
363 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
364 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
365 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
366 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
367 assert!(node_1_none.is_none());
368 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
370 // If one node, however, received + responded with an identical closing_signed we end
371 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
372 // There isn't really anything better we can do simply, but in the future we might
373 // explore storing a set of recently-closed channels that got disconnected during
374 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
375 // give our counterparty enough time to (potentially) broadcast a cooperative closing
377 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
379 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
380 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
381 assert_eq!(msg_events.len(), 1);
382 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
384 &ErrorAction::SendErrorMessage { ref msg } => {
385 nodes[1].node.handle_error(&nodes[0].node.get_our_node_id(), &msg);
386 assert_eq!(msg.channel_id, chan_1.2);
388 _ => panic!("Unexpected event!"),
390 } else { panic!("Needed SendErrorMessage close"); }
392 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
393 // checks it, but in this case nodes[1] didn't ever get a chance to receive a
394 // closing_signed so we do it ourselves
395 check_closed_broadcast!(nodes[1], false);
396 check_added_monitors!(nodes[1], 1);
397 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())) });
400 assert!(nodes[0].node.list_channels().is_empty());
402 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
403 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
404 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
405 assert!(nodes[1].node.list_channels().is_empty());
406 assert!(nodes[2].node.list_channels().is_empty());
407 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
408 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
409 check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure);
413 fn test_shutdown_rebroadcast() {
414 do_test_shutdown_rebroadcast(0);
415 do_test_shutdown_rebroadcast(1);
416 do_test_shutdown_rebroadcast(2);
420 fn test_upfront_shutdown_script() {
421 // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
422 // enforce it at shutdown message
424 let mut config = UserConfig::default();
425 config.channel_handshake_config.announced_channel = true;
426 config.channel_handshake_limits.force_announced_channel_preference = false;
427 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
428 let user_cfgs = [None, Some(config), None];
429 let chanmon_cfgs = create_chanmon_cfgs(3);
430 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
431 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
432 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
434 // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
435 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000);
436 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[2].node.get_our_node_id()).unwrap();
437 let node_0_orig_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
438 let mut node_0_shutdown = node_0_orig_shutdown.clone();
439 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
440 // Test we enforce upfront_scriptpbukey if by providing a different one at closing that we warn
441 // the peer and ignore the message.
442 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
443 assert!(regex::Regex::new(r"Got shutdown request with a scriptpubkey \([A-Fa-f0-9]+\) which did not match their previous scriptpubkey.")
444 .unwrap().is_match(&check_warn_msg!(nodes[2], nodes[0].node.get_our_node_id(), chan.2)));
445 // This allows nodes[2] to retry the shutdown message, which should get a response:
446 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_orig_shutdown);
447 get_event_msg!(nodes[2], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
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);
451 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[2].node.get_our_node_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(), &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 *nodes[0].override_init_features.borrow_mut() = Some(nodes[0].node.init_features().clear_upfront_shutdown_script());
464 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000);
465 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[1].node.get_our_node_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(), &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 *nodes[0].override_init_features.borrow_mut() = None;
479 let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000);
480 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[0].node.get_our_node_id()).unwrap();
481 check_added_monitors!(nodes[1], 1);
482 let node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
483 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
484 let events = nodes[0].node.get_and_clear_pending_msg_events();
485 assert_eq!(events.len(), 1);
487 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
488 _ => panic!("Unexpected event"),
491 //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
492 //// channel smoothly
493 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000);
494 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[0].node.get_our_node_id()).unwrap();
495 check_added_monitors!(nodes[1], 1);
496 let node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
497 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
498 let events = nodes[0].node.get_and_clear_pending_msg_events();
499 assert_eq!(events.len(), 2);
501 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
502 _ => panic!("Unexpected event"),
505 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
506 _ => panic!("Unexpected event"),
511 fn test_unsupported_anysegwit_upfront_shutdown_script() {
512 let chanmon_cfgs = create_chanmon_cfgs(2);
513 let mut node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
514 // Clear shutdown_anysegwit on initiator
515 *node_cfgs[0].override_init_features.borrow_mut() = Some(channelmanager::provided_init_features(&test_default_channel_config()).clear_shutdown_anysegwit());
516 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
517 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
519 // Use a non-v0 segwit script supported by option_shutdown_anysegwit
520 let anysegwit_shutdown_script = Builder::new()
522 .push_slice(&[0, 40])
525 // Check script when handling an open_channel message
526 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
527 let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
528 open_channel.shutdown_scriptpubkey = Some(anysegwit_shutdown_script.clone());
529 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel);
531 let events = nodes[1].node.get_and_clear_pending_msg_events();
532 assert_eq!(events.len(), 1);
534 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
535 assert_eq!(node_id, nodes[0].node.get_our_node_id());
536 assert_eq!(msg.data, "Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: Script(OP_PUSHNUM_16 OP_PUSHBYTES_2 0028)");
538 _ => panic!("Unexpected event"),
541 let chanmon_cfgs = create_chanmon_cfgs(2);
542 let mut node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
543 // Clear shutdown_anysegwit on responder
544 *node_cfgs[1].override_init_features.borrow_mut() = Some(channelmanager::provided_init_features(&test_default_channel_config()).clear_shutdown_anysegwit());
545 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
546 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
548 // Check script when handling an accept_channel message
549 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
550 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
551 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel);
552 let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
553 accept_channel.shutdown_scriptpubkey = Some(anysegwit_shutdown_script.clone());
554 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel);
556 let events = nodes[0].node.get_and_clear_pending_msg_events();
557 assert_eq!(events.len(), 1);
559 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
560 assert_eq!(node_id, nodes[1].node.get_our_node_id());
561 assert_eq!(msg.data, "Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: Script(OP_PUSHNUM_16 OP_PUSHBYTES_2 0028)");
563 _ => panic!("Unexpected event"),
565 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() });
569 fn test_invalid_upfront_shutdown_script() {
570 let chanmon_cfgs = create_chanmon_cfgs(2);
571 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
572 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
573 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
575 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
577 // Use a segwit v0 script with an unsupported witness program
578 let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
579 open_channel.shutdown_scriptpubkey = Some(Builder::new().push_int(0)
582 nodes[0].node.handle_open_channel(&nodes[1].node.get_our_node_id(), &open_channel);
584 let events = nodes[0].node.get_and_clear_pending_msg_events();
585 assert_eq!(events.len(), 1);
587 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
588 assert_eq!(node_id, nodes[1].node.get_our_node_id());
589 assert_eq!(msg.data, "Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: Script(OP_0 OP_PUSHBYTES_2 0000)");
591 _ => panic!("Unexpected event"),
596 fn test_segwit_v0_shutdown_script() {
597 let mut config = UserConfig::default();
598 config.channel_handshake_config.announced_channel = true;
599 config.channel_handshake_limits.force_announced_channel_preference = false;
600 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
601 let user_cfgs = [None, Some(config), None];
602 let chanmon_cfgs = create_chanmon_cfgs(3);
603 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
604 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
605 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
607 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
608 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[0].node.get_our_node_id()).unwrap();
609 check_added_monitors!(nodes[1], 1);
611 // Use a segwit v0 script supported even without option_shutdown_anysegwit
612 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
613 node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
614 .push_slice(&[0; 20])
616 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
618 let events = nodes[0].node.get_and_clear_pending_msg_events();
619 assert_eq!(events.len(), 2);
621 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
622 _ => panic!("Unexpected event"),
625 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
626 _ => panic!("Unexpected event"),
631 fn test_anysegwit_shutdown_script() {
632 let mut config = UserConfig::default();
633 config.channel_handshake_config.announced_channel = true;
634 config.channel_handshake_limits.force_announced_channel_preference = false;
635 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
636 let user_cfgs = [None, Some(config), None];
637 let chanmon_cfgs = create_chanmon_cfgs(3);
638 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
639 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
640 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
642 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
643 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[0].node.get_our_node_id()).unwrap();
644 check_added_monitors!(nodes[1], 1);
646 // Use a non-v0 segwit script supported by option_shutdown_anysegwit
647 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
648 node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
651 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
653 let events = nodes[0].node.get_and_clear_pending_msg_events();
654 assert_eq!(events.len(), 2);
656 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
657 _ => panic!("Unexpected event"),
660 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
661 _ => panic!("Unexpected event"),
666 fn test_unsupported_anysegwit_shutdown_script() {
667 let mut config = UserConfig::default();
668 config.channel_handshake_config.announced_channel = true;
669 config.channel_handshake_limits.force_announced_channel_preference = false;
670 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
671 let user_cfgs = [None, Some(config), None];
672 let chanmon_cfgs = create_chanmon_cfgs(3);
673 let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
674 *node_cfgs[0].override_init_features.borrow_mut() = Some(channelmanager::provided_init_features(&config).clear_shutdown_anysegwit());
675 *node_cfgs[1].override_init_features.borrow_mut() = Some(channelmanager::provided_init_features(&config).clear_shutdown_anysegwit());
676 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
677 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
679 // Check that using an unsupported shutdown script fails and a supported one succeeds.
680 let supported_shutdown_script = chanmon_cfgs[1].keys_manager.get_shutdown_scriptpubkey().unwrap();
681 let unsupported_shutdown_script =
682 ShutdownScript::new_witness_program(WitnessVersion::V16, &[0, 40]).unwrap();
683 chanmon_cfgs[1].keys_manager
684 .expect(OnGetShutdownScriptpubkey { returns: unsupported_shutdown_script.clone() })
685 .expect(OnGetShutdownScriptpubkey { returns: supported_shutdown_script });
687 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
688 match nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[0].node.get_our_node_id()) {
689 Err(APIError::IncompatibleShutdownScript { script }) => {
690 assert_eq!(script.into_inner(), unsupported_shutdown_script.clone().into_inner());
692 Err(e) => panic!("Unexpected error: {:?}", e),
693 Ok(_) => panic!("Expected error"),
695 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[0].node.get_our_node_id()).unwrap();
696 check_added_monitors!(nodes[1], 1);
698 // Use a non-v0 segwit script unsupported without option_shutdown_anysegwit
699 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
700 node_0_shutdown.scriptpubkey = unsupported_shutdown_script.into_inner();
701 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
703 assert_eq!(&check_warn_msg!(nodes[0], nodes[1].node.get_our_node_id(), chan.2),
704 "Got a nonstandard scriptpubkey (60020028) from remote peer");
708 fn test_invalid_shutdown_script() {
709 let mut config = UserConfig::default();
710 config.channel_handshake_config.announced_channel = true;
711 config.channel_handshake_limits.force_announced_channel_preference = false;
712 config.channel_handshake_config.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);
720 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[0].node.get_our_node_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(), &node_0_shutdown);
730 assert_eq!(&check_warn_msg!(nodes[0], nodes[1].node.get_our_node_id(), chan.2),
731 "Got a nonstandard scriptpubkey (00020000) from remote peer");
735 fn test_user_shutdown_script() {
736 let mut config = test_default_channel_config();
737 config.channel_handshake_config.announced_channel = true;
738 config.channel_handshake_limits.force_announced_channel_preference = false;
739 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
740 let user_cfgs = [None, Some(config), None];
741 let chanmon_cfgs = create_chanmon_cfgs(3);
742 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
743 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
744 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
746 // Segwit v0 script of the form OP_0 <20-byte hash>
747 let script = Builder::new().push_int(0)
748 .push_slice(&[0; 20])
751 let shutdown_script = ShutdownScript::try_from(script.clone()).unwrap();
753 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
754 nodes[1].node.close_channel_with_feerate_and_script(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[0].node.get_our_node_id(), None, Some(shutdown_script)).unwrap();
755 check_added_monitors!(nodes[1], 1);
757 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
759 assert_eq!(node_0_shutdown.scriptpubkey, script);
763 fn test_already_set_user_shutdown_script() {
764 let mut config = test_default_channel_config();
765 config.channel_handshake_config.announced_channel = true;
766 config.channel_handshake_limits.force_announced_channel_preference = false;
767 let user_cfgs = [None, Some(config), None];
768 let chanmon_cfgs = create_chanmon_cfgs(3);
769 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
770 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
771 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
773 // Segwit v0 script of the form OP_0 <20-byte hash>
774 let script = Builder::new().push_int(0)
775 .push_slice(&[0; 20])
778 let shutdown_script = ShutdownScript::try_from(script).unwrap();
780 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
781 let result = nodes[1].node.close_channel_with_feerate_and_script(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[0].node.get_our_node_id(), None, Some(shutdown_script));
783 assert_eq!(result, Err(APIError::APIMisuseError { err: "Cannot override shutdown script for a channel with one already set".to_string() }));
793 fn do_test_closing_signed_reinit_timeout(timeout_step: TimeoutStep) {
794 // The range-based closing signed negotiation allows the funder to restart the process with a
795 // new range if the previous range did not overlap. This allows implementations to request user
796 // intervention allowing users to enter a new fee range. We do not implement the sending side
797 // of this, instead opting to allow users to enter an explicit "willing to pay up to X to avoid
798 // force-closing" value and relying on that instead.
800 // Here we run test the fundee side of that restart mechanism, implementing the funder side of
802 let chanmon_cfgs = create_chanmon_cfgs(2);
803 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
804 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
805 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
806 let chan_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
808 send_payment(&nodes[0], &[&nodes[1]], 8_000_000);
810 nodes[0].node.close_channel(&chan_id, &nodes[1].node.get_our_node_id()).unwrap();
811 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
812 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
813 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
814 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
817 // Now we set nodes[1] to require a relatively high feerate for closing. This should result
818 // in it rejecting nodes[0]'s initial closing_signed, giving nodes[0] a chance to try
820 let mut feerate_lock = chanmon_cfgs[1].fee_estimator.sat_per_kw.lock().unwrap();
824 let mut node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
825 // nodes[0] should use a "reasonable" feerate, well under the 10 sat/vByte that nodes[1] thinks
826 // is the current prevailing feerate.
827 assert!(node_0_closing_signed.fee_satoshis <= 500);
829 if timeout_step != TimeoutStep::AfterShutdown {
830 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
831 assert!(check_warn_msg!(nodes[1], nodes[0].node.get_our_node_id(), chan_id)
832 .starts_with("Unable to come to consensus about closing feerate"));
834 // Now deliver a mutated closing_signed indicating a higher acceptable fee range, which
835 // nodes[1] should happily accept and respond to.
836 node_0_closing_signed.fee_range.as_mut().unwrap().max_fee_satoshis *= 10;
838 let mut node_0_per_peer_lock;
839 let mut node_0_peer_state_lock;
840 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;
842 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
843 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
844 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
845 let node_0_2nd_closing_signed = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
846 if timeout_step == TimeoutStep::NoTimeout {
847 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.1.unwrap());
848 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
850 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
853 if timeout_step != TimeoutStep::NoTimeout {
854 assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
856 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
859 nodes[1].node.timer_tick_occurred();
860 nodes[1].node.timer_tick_occurred();
862 let txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
863 assert_eq!(txn.len(), 1);
864 assert_eq!(txn[0].output.len(), 2);
866 if timeout_step != TimeoutStep::NoTimeout {
867 assert!((txn[0].output[0].script_pubkey.is_v0_p2wpkh() &&
868 txn[0].output[1].script_pubkey.is_v0_p2wsh()) ||
869 (txn[0].output[1].script_pubkey.is_v0_p2wpkh() &&
870 txn[0].output[0].script_pubkey.is_v0_p2wsh()));
871 check_closed_broadcast!(nodes[1], true);
872 check_added_monitors!(nodes[1], 1);
873 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "closing_signed negotiation failed to finish within two timer ticks".to_string() });
875 assert!(txn[0].output[0].script_pubkey.is_v0_p2wpkh());
876 assert!(txn[0].output[1].script_pubkey.is_v0_p2wpkh());
878 let events = nodes[1].node.get_and_clear_pending_msg_events();
879 assert_eq!(events.len(), 1);
881 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
882 assert_eq!(msg.contents.flags & 2, 2);
884 _ => panic!("Unexpected event"),
890 fn test_closing_signed_reinit_timeout() {
891 do_test_closing_signed_reinit_timeout(TimeoutStep::AfterShutdown);
892 do_test_closing_signed_reinit_timeout(TimeoutStep::AfterClosingSigned);
893 do_test_closing_signed_reinit_timeout(TimeoutStep::NoTimeout);
896 fn do_simple_legacy_shutdown_test(high_initiator_fee: bool) {
897 // A simpe test of the legacy shutdown fee negotiation logic.
898 let chanmon_cfgs = create_chanmon_cfgs(2);
899 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
900 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
901 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
903 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
905 if high_initiator_fee {
906 // If high_initiator_fee is set, set nodes[0]'s feerate significantly higher. This
907 // shouldn't impact the flow at all given nodes[1] will happily accept the higher fee.
908 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
912 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[1].node.get_our_node_id()).unwrap();
913 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
914 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
915 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
916 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
918 let mut node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
919 node_0_closing_signed.fee_range = None;
920 if high_initiator_fee {
921 assert!(node_0_closing_signed.fee_satoshis > 500);
923 assert!(node_0_closing_signed.fee_satoshis < 500);
926 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
927 let (_, mut node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
928 node_1_closing_signed.as_mut().unwrap().fee_range = None;
930 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
931 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
932 assert!(node_0_none.is_none());
933 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
934 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
938 fn simple_legacy_shutdown_test() {
939 do_simple_legacy_shutdown_test(false);
940 do_simple_legacy_shutdown_test(true);
944 fn simple_target_feerate_shutdown() {
945 // Simple test of target in `close_channel_with_target_feerate`.
946 let chanmon_cfgs = create_chanmon_cfgs(2);
947 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
948 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
949 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
951 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
952 let chan_id = OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id();
954 nodes[0].node.close_channel_with_feerate_and_script(&chan_id, &nodes[1].node.get_our_node_id(), Some(253 * 10), None).unwrap();
955 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
956 nodes[1].node.close_channel_with_feerate_and_script(&chan_id, &nodes[0].node.get_our_node_id(), Some(253 * 5), None).unwrap();
957 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
959 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
960 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
962 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
963 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
964 let (_, node_1_closing_signed_opt) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
965 let node_1_closing_signed = node_1_closing_signed_opt.unwrap();
967 // nodes[1] was passed a target which was larger than the current channel feerate, which it
968 // should ignore in favor of the channel fee, as there is no use demanding a minimum higher
969 // than what will be paid on a force-close transaction. Note that we have to consider rounding,
970 // so only check that we're within 10 sats.
971 assert!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis >=
972 node_1_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis * 10 - 5);
973 assert!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis <=
974 node_1_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis * 10 + 5);
976 // Further, because nodes[0]'s target fee is larger than the `Normal` fee estimation plus our
977 // force-closure-avoidance buffer, min should equal max, and the nodes[1]-selected fee should
978 // be the nodes[0] only available fee.
979 assert_eq!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis,
980 node_0_closing_signed.fee_range.as_ref().unwrap().max_fee_satoshis);
981 assert_eq!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis,
982 node_0_closing_signed.fee_satoshis);
983 assert_eq!(node_0_closing_signed.fee_satoshis, node_1_closing_signed.fee_satoshis);
985 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
986 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
987 assert!(node_0_none.is_none());
988 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
989 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);