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, KeysInterface, SignerProvider};
13 use crate::chain::transaction::OutPoint;
14 use crate::ln::channelmanager::{self, PaymentSendFailure, PaymentId};
15 use crate::routing::router::{PaymentParameters, get_route};
17 use crate::ln::msgs::{ChannelMessageHandler, ErrorAction};
18 use crate::ln::script::ShutdownScript;
19 use crate::util::test_utils;
20 use crate::util::test_utils::OnGetShutdownScriptpubkey;
21 use crate::util::events::{Event, MessageSendEvent, MessageSendEventsProvider, ClosureReason};
22 use crate::util::errors::APIError;
23 use crate::util::config::UserConfig;
25 use bitcoin::blockdata::script::Builder;
26 use bitcoin::blockdata::opcodes;
27 use bitcoin::network::constants::Network;
28 use bitcoin::util::address::WitnessVersion;
32 use core::default::Default;
34 use crate::ln::functional_test_utils::*;
35 use crate::ln::msgs::OptionalField::Present;
38 fn pre_funding_lock_shutdown_test() {
39 // Test sending a shutdown prior to channel_ready after funding generation
40 let chanmon_cfgs = create_chanmon_cfgs(2);
41 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
42 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
43 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
44 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0, channelmanager::provided_init_features(), channelmanager::provided_init_features());
45 mine_transaction(&nodes[0], &tx);
46 mine_transaction(&nodes[1], &tx);
48 nodes[0].node.close_channel(&OutPoint { txid: tx.txid(), index: 0 }.to_channel_id(), &nodes[1].node.get_our_node_id()).unwrap();
49 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
50 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &channelmanager::provided_init_features(), &node_0_shutdown);
51 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
52 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &channelmanager::provided_init_features(), &node_1_shutdown);
54 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
55 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
56 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
57 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
58 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
59 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
60 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
61 assert!(node_1_none.is_none());
63 assert!(nodes[0].node.list_channels().is_empty());
64 assert!(nodes[1].node.list_channels().is_empty());
65 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
66 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
70 fn updates_shutdown_wait() {
71 // Test sending a shutdown with outstanding updates pending
72 let chanmon_cfgs = create_chanmon_cfgs(3);
73 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
74 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
75 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
76 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
77 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features());
78 let logger = test_utils::TestLogger::new();
79 let scorer = test_utils::TestScorer::with_penalty(0);
80 let keys_manager = test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
81 let random_seed_bytes = keys_manager.get_secure_random_bytes();
83 let (payment_preimage_0, payment_hash_0, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100_000);
85 nodes[0].node.close_channel(&chan_1.2, &nodes[1].node.get_our_node_id()).unwrap();
86 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
87 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &channelmanager::provided_init_features(), &node_0_shutdown);
88 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
89 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &channelmanager::provided_init_features(), &node_1_shutdown);
91 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
92 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
94 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
96 let payment_params_1 = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id()).with_features(channelmanager::provided_invoice_features());
97 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();
98 let payment_params_2 = PaymentParameters::from_node_id(nodes[0].node.get_our_node_id()).with_features(channelmanager::provided_invoice_features());
99 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();
100 unwrap_send_err!(nodes[0].node.send_payment(&route_1, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)), true, APIError::ChannelUnavailable {..}, {});
101 unwrap_send_err!(nodes[1].node.send_payment(&route_2, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)), true, APIError::ChannelUnavailable {..}, {});
103 nodes[2].node.claim_funds(payment_preimage_0);
104 check_added_monitors!(nodes[2], 1);
105 expect_payment_claimed!(nodes[2], payment_hash_0, 100_000);
107 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
108 assert!(updates.update_add_htlcs.is_empty());
109 assert!(updates.update_fail_htlcs.is_empty());
110 assert!(updates.update_fail_malformed_htlcs.is_empty());
111 assert!(updates.update_fee.is_none());
112 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
113 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
114 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), false, false);
115 check_added_monitors!(nodes[1], 1);
116 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
117 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
119 assert!(updates_2.update_add_htlcs.is_empty());
120 assert!(updates_2.update_fail_htlcs.is_empty());
121 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
122 assert!(updates_2.update_fee.is_none());
123 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
124 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
125 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
126 expect_payment_sent!(nodes[0], payment_preimage_0);
128 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
129 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
130 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
131 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
132 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
133 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
134 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
135 assert!(node_1_none.is_none());
136 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
137 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
139 assert!(nodes[0].node.list_channels().is_empty());
141 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
142 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
143 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
144 assert!(nodes[1].node.list_channels().is_empty());
145 assert!(nodes[2].node.list_channels().is_empty());
146 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
147 check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure);
151 fn htlc_fail_async_shutdown() {
152 // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
153 let chanmon_cfgs = create_chanmon_cfgs(3);
154 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
155 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
156 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
157 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
158 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features());
160 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], 100000);
161 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
162 check_added_monitors!(nodes[0], 1);
163 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
164 assert_eq!(updates.update_add_htlcs.len(), 1);
165 assert!(updates.update_fulfill_htlcs.is_empty());
166 assert!(updates.update_fail_htlcs.is_empty());
167 assert!(updates.update_fail_malformed_htlcs.is_empty());
168 assert!(updates.update_fee.is_none());
170 nodes[1].node.close_channel(&chan_1.2, &nodes[0].node.get_our_node_id()).unwrap();
171 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
172 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &channelmanager::provided_init_features(), &node_1_shutdown);
173 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
175 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
176 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
177 check_added_monitors!(nodes[1], 1);
178 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &channelmanager::provided_init_features(), &node_0_shutdown);
179 commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
181 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
182 assert!(updates_2.update_add_htlcs.is_empty());
183 assert!(updates_2.update_fulfill_htlcs.is_empty());
184 assert_eq!(updates_2.update_fail_htlcs.len(), 1);
185 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
186 assert!(updates_2.update_fee.is_none());
188 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]);
189 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
191 expect_payment_failed_with_update!(nodes[0], our_payment_hash, false, chan_2.0.contents.short_channel_id, true);
193 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
194 assert_eq!(msg_events.len(), 1);
195 let node_0_closing_signed = match msg_events[0] {
196 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
197 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
200 _ => panic!("Unexpected event"),
203 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
204 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
205 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
206 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
207 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
208 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
209 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
210 assert!(node_1_none.is_none());
212 assert!(nodes[0].node.list_channels().is_empty());
214 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
215 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
216 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
217 assert!(nodes[1].node.list_channels().is_empty());
218 assert!(nodes[2].node.list_channels().is_empty());
219 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
220 check_closed_event!(nodes[1], 2, ClosureReason::CooperativeClosure);
221 check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure);
224 fn do_test_shutdown_rebroadcast(recv_count: u8) {
225 // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
226 // messages delivered prior to disconnect
227 let chanmon_cfgs = create_chanmon_cfgs(3);
228 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
229 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
230 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
231 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
232 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features());
234 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100_000);
236 nodes[1].node.close_channel(&chan_1.2, &nodes[0].node.get_our_node_id()).unwrap();
237 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
239 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &channelmanager::provided_init_features(), &node_1_shutdown);
240 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
242 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &channelmanager::provided_init_features(), &node_0_shutdown);
246 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
247 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
249 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
250 let node_0_reestablish = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
251 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
252 let node_1_reestablish = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
254 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish);
255 let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
256 assert!(node_1_shutdown == node_1_2nd_shutdown);
258 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish);
259 let node_0_2nd_shutdown = if recv_count > 0 {
260 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
261 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &channelmanager::provided_init_features(), &node_1_2nd_shutdown);
264 let node_0_chan_update = get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
265 assert_eq!(node_0_chan_update.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
266 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &channelmanager::provided_init_features(), &node_1_2nd_shutdown);
267 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
269 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &channelmanager::provided_init_features(), &node_0_2nd_shutdown);
271 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
272 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
274 nodes[2].node.claim_funds(payment_preimage);
275 check_added_monitors!(nodes[2], 1);
276 expect_payment_claimed!(nodes[2], payment_hash, 100_000);
278 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
279 assert!(updates.update_add_htlcs.is_empty());
280 assert!(updates.update_fail_htlcs.is_empty());
281 assert!(updates.update_fail_malformed_htlcs.is_empty());
282 assert!(updates.update_fee.is_none());
283 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
284 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
285 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), false, false);
286 check_added_monitors!(nodes[1], 1);
287 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
288 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
290 assert!(updates_2.update_add_htlcs.is_empty());
291 assert!(updates_2.update_fail_htlcs.is_empty());
292 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
293 assert!(updates_2.update_fee.is_none());
294 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
295 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
296 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
297 expect_payment_sent!(nodes[0], payment_preimage);
299 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
301 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
302 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
303 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
304 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
305 assert!(node_0_2nd_closing_signed.is_some());
308 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
309 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
311 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
312 let node_1_2nd_reestablish = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
313 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
315 // If all closing_signeds weren't delivered we can just resume where we left off...
316 let node_0_2nd_reestablish = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
318 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
319 let node_0_msgs = nodes[0].node.get_and_clear_pending_msg_events();
320 assert_eq!(node_0_msgs.len(), 2);
321 let node_0_2nd_closing_signed = match node_0_msgs[1] {
322 MessageSendEvent::SendClosingSigned { ref msg, .. } => {
323 assert_eq!(node_0_closing_signed, *msg);
329 let node_0_3rd_shutdown = match node_0_msgs[0] {
330 MessageSendEvent::SendShutdown { ref msg, .. } => {
331 assert_eq!(node_0_2nd_shutdown, *msg);
336 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
338 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
339 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
340 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
342 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &channelmanager::provided_init_features(), &node_0_3rd_shutdown);
343 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
345 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &channelmanager::provided_init_features(), &node_1_3rd_shutdown);
347 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed);
348 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
349 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
350 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
351 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
352 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
353 assert!(node_1_none.is_none());
354 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
356 // If one node, however, received + responded with an identical closing_signed we end
357 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
358 // There isn't really anything better we can do simply, but in the future we might
359 // explore storing a set of recently-closed channels that got disconnected during
360 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
361 // give our counterparty enough time to (potentially) broadcast a cooperative closing
363 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
365 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
366 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
367 assert_eq!(msg_events.len(), 1);
368 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
370 &ErrorAction::SendErrorMessage { ref msg } => {
371 nodes[1].node.handle_error(&nodes[0].node.get_our_node_id(), &msg);
372 assert_eq!(msg.channel_id, chan_1.2);
374 _ => panic!("Unexpected event!"),
376 } else { panic!("Needed SendErrorMessage close"); }
378 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
379 // checks it, but in this case nodes[1] didn't ever get a chance to receive a
380 // closing_signed so we do it ourselves
381 check_closed_broadcast!(nodes[1], false);
382 check_added_monitors!(nodes[1], 1);
383 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyForceClosed { peer_msg: 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()) });
386 assert!(nodes[0].node.list_channels().is_empty());
388 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
389 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
390 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
391 assert!(nodes[1].node.list_channels().is_empty());
392 assert!(nodes[2].node.list_channels().is_empty());
393 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
394 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
395 check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure);
399 fn test_shutdown_rebroadcast() {
400 do_test_shutdown_rebroadcast(0);
401 do_test_shutdown_rebroadcast(1);
402 do_test_shutdown_rebroadcast(2);
406 fn test_upfront_shutdown_script() {
407 // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
408 // enforce it at shutdown message
410 let mut config = UserConfig::default();
411 config.channel_handshake_config.announced_channel = true;
412 config.channel_handshake_limits.force_announced_channel_preference = false;
413 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
414 let user_cfgs = [None, Some(config), None];
415 let chanmon_cfgs = create_chanmon_cfgs(3);
416 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
417 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
418 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
420 // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
421 let flags = channelmanager::provided_init_features();
422 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
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(), &channelmanager::provided_init_features(), &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(), &channelmanager::provided_init_features(), &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, flags.clone(), flags.clone());
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(), &channelmanager::provided_init_features(), &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 let flags_no = channelmanager::provided_init_features().clear_upfront_shutdown_script();
451 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
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(), &channelmanager::provided_init_features(), &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 let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
466 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[0].node.get_our_node_id()).unwrap();
467 check_added_monitors!(nodes[1], 1);
468 let node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
469 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &channelmanager::provided_init_features(), &node_0_shutdown);
470 let events = nodes[0].node.get_and_clear_pending_msg_events();
471 assert_eq!(events.len(), 1);
473 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
474 _ => panic!("Unexpected event"),
477 //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
478 //// channel smoothly
479 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
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(), &channelmanager::provided_init_features(), &node_0_shutdown);
484 let events = nodes[0].node.get_and_clear_pending_msg_events();
485 assert_eq!(events.len(), 2);
487 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
488 _ => panic!("Unexpected event"),
491 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
492 _ => panic!("Unexpected event"),
497 fn test_unsupported_anysegwit_upfront_shutdown_script() {
498 let chanmon_cfgs = create_chanmon_cfgs(2);
499 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
500 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
501 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
503 // Use a non-v0 segwit script supported by option_shutdown_anysegwit
504 let node_features = channelmanager::provided_init_features().clear_shutdown_anysegwit();
505 let anysegwit_shutdown_script = Builder::new()
507 .push_slice(&[0, 40])
510 // Check script when handling an open_channel message
511 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
512 let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
513 open_channel.shutdown_scriptpubkey = Present(anysegwit_shutdown_script.clone());
514 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), node_features.clone(), &open_channel);
516 let events = nodes[1].node.get_and_clear_pending_msg_events();
517 assert_eq!(events.len(), 1);
519 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
520 assert_eq!(node_id, nodes[0].node.get_our_node_id());
521 assert_eq!(msg.data, "Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: Script(OP_PUSHNUM_16 OP_PUSHBYTES_2 0028)");
523 _ => panic!("Unexpected event"),
526 // Check script when handling an accept_channel message
527 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
528 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
529 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), channelmanager::provided_init_features(), &open_channel);
530 let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
531 accept_channel.shutdown_scriptpubkey = Present(anysegwit_shutdown_script.clone());
532 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), node_features, &accept_channel);
534 let events = nodes[0].node.get_and_clear_pending_msg_events();
535 assert_eq!(events.len(), 1);
537 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
538 assert_eq!(node_id, nodes[1].node.get_our_node_id());
539 assert_eq!(msg.data, "Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: Script(OP_PUSHNUM_16 OP_PUSHBYTES_2 0028)");
541 _ => panic!("Unexpected event"),
543 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() });
547 fn test_invalid_upfront_shutdown_script() {
548 let chanmon_cfgs = create_chanmon_cfgs(2);
549 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
550 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
551 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
553 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
555 // Use a segwit v0 script with an unsupported witness program
556 let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
557 open_channel.shutdown_scriptpubkey = Present(Builder::new().push_int(0)
560 nodes[0].node.handle_open_channel(&nodes[0].node.get_our_node_id(), channelmanager::provided_init_features(), &open_channel);
562 let events = nodes[0].node.get_and_clear_pending_msg_events();
563 assert_eq!(events.len(), 1);
565 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
566 assert_eq!(node_id, nodes[0].node.get_our_node_id());
567 assert_eq!(msg.data, "Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: Script(OP_0 OP_PUSHBYTES_2 0000)");
569 _ => panic!("Unexpected event"),
574 fn test_segwit_v0_shutdown_script() {
575 let mut config = UserConfig::default();
576 config.channel_handshake_config.announced_channel = true;
577 config.channel_handshake_limits.force_announced_channel_preference = false;
578 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
579 let user_cfgs = [None, Some(config), None];
580 let chanmon_cfgs = create_chanmon_cfgs(3);
581 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
582 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
583 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
585 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
586 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[0].node.get_our_node_id()).unwrap();
587 check_added_monitors!(nodes[1], 1);
589 // Use a segwit v0 script supported even without option_shutdown_anysegwit
590 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
591 node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
592 .push_slice(&[0; 20])
594 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &channelmanager::provided_init_features(), &node_0_shutdown);
596 let events = nodes[0].node.get_and_clear_pending_msg_events();
597 assert_eq!(events.len(), 2);
599 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
600 _ => panic!("Unexpected event"),
603 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
604 _ => panic!("Unexpected event"),
609 fn test_anysegwit_shutdown_script() {
610 let mut config = UserConfig::default();
611 config.channel_handshake_config.announced_channel = true;
612 config.channel_handshake_limits.force_announced_channel_preference = false;
613 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
614 let user_cfgs = [None, Some(config), None];
615 let chanmon_cfgs = create_chanmon_cfgs(3);
616 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
617 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
618 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
620 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
621 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[0].node.get_our_node_id()).unwrap();
622 check_added_monitors!(nodes[1], 1);
624 // Use a non-v0 segwit script supported by option_shutdown_anysegwit
625 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
626 node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
629 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &channelmanager::provided_init_features(), &node_0_shutdown);
631 let events = nodes[0].node.get_and_clear_pending_msg_events();
632 assert_eq!(events.len(), 2);
634 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
635 _ => panic!("Unexpected event"),
638 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
639 _ => panic!("Unexpected event"),
644 fn test_unsupported_anysegwit_shutdown_script() {
645 let mut config = UserConfig::default();
646 config.channel_handshake_config.announced_channel = true;
647 config.channel_handshake_limits.force_announced_channel_preference = false;
648 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
649 let user_cfgs = [None, Some(config), None];
650 let chanmon_cfgs = create_chanmon_cfgs(3);
651 let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
652 node_cfgs[0].features = channelmanager::provided_init_features().clear_shutdown_anysegwit();
653 node_cfgs[1].features = channelmanager::provided_init_features().clear_shutdown_anysegwit();
654 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
655 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
657 // Check that using an unsupported shutdown script fails and a supported one succeeds.
658 let supported_shutdown_script = chanmon_cfgs[1].keys_manager.get_shutdown_scriptpubkey();
659 let unsupported_shutdown_script =
660 ShutdownScript::new_witness_program(WitnessVersion::V16, &[0, 40]).unwrap();
661 chanmon_cfgs[1].keys_manager
662 .expect(OnGetShutdownScriptpubkey { returns: unsupported_shutdown_script.clone() })
663 .expect(OnGetShutdownScriptpubkey { returns: supported_shutdown_script });
665 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, node_cfgs[0].features.clone(), node_cfgs[1].features.clone());
666 match nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[0].node.get_our_node_id()) {
667 Err(APIError::IncompatibleShutdownScript { script }) => {
668 assert_eq!(script.into_inner(), unsupported_shutdown_script.clone().into_inner());
670 Err(e) => panic!("Unexpected error: {:?}", e),
671 Ok(_) => panic!("Expected error"),
673 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[0].node.get_our_node_id()).unwrap();
674 check_added_monitors!(nodes[1], 1);
676 // Use a non-v0 segwit script unsupported without option_shutdown_anysegwit
677 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
678 node_0_shutdown.scriptpubkey = unsupported_shutdown_script.into_inner();
679 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_cfgs[1].features, &node_0_shutdown);
681 assert_eq!(&check_warn_msg!(nodes[0], nodes[1].node.get_our_node_id(), chan.2),
682 "Got a nonstandard scriptpubkey (60020028) from remote peer");
686 fn test_invalid_shutdown_script() {
687 let mut config = UserConfig::default();
688 config.channel_handshake_config.announced_channel = true;
689 config.channel_handshake_limits.force_announced_channel_preference = false;
690 config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
691 let user_cfgs = [None, Some(config), None];
692 let chanmon_cfgs = create_chanmon_cfgs(3);
693 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
694 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
695 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
697 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
698 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[0].node.get_our_node_id()).unwrap();
699 check_added_monitors!(nodes[1], 1);
701 // Use a segwit v0 script with an unsupported witness program
702 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
703 node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
706 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &channelmanager::provided_init_features(), &node_0_shutdown);
708 assert_eq!(&check_warn_msg!(nodes[0], nodes[1].node.get_our_node_id(), chan.2),
709 "Got a nonstandard scriptpubkey (00020000) from remote peer");
719 fn do_test_closing_signed_reinit_timeout(timeout_step: TimeoutStep) {
720 // The range-based closing signed negotiation allows the funder to restart the process with a
721 // new range if the previous range did not overlap. This allows implementations to request user
722 // intervention allowing users to enter a new fee range. We do not implement the sending side
723 // of this, instead opting to allow users to enter an explicit "willing to pay up to X to avoid
724 // force-closing" value and relying on that instead.
726 // Here we run test the fundee side of that restart mechanism, implementing the funder side of
728 let chanmon_cfgs = create_chanmon_cfgs(2);
729 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
730 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
731 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
732 let chan_id = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
734 send_payment(&nodes[0], &[&nodes[1]], 8_000_000);
736 nodes[0].node.close_channel(&chan_id, &nodes[1].node.get_our_node_id()).unwrap();
737 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
738 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &channelmanager::provided_init_features(), &node_0_shutdown);
739 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
740 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &channelmanager::provided_init_features(), &node_1_shutdown);
743 // Now we set nodes[1] to require a relatively high feerate for closing. This should result
744 // in it rejecting nodes[0]'s initial closing_signed, giving nodes[0] a chance to try
746 let mut feerate_lock = chanmon_cfgs[1].fee_estimator.sat_per_kw.lock().unwrap();
750 let mut node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
751 // nodes[0] should use a "reasonable" feerate, well under the 10 sat/vByte that nodes[1] thinks
752 // is the current prevailing feerate.
753 assert!(node_0_closing_signed.fee_satoshis <= 500);
755 if timeout_step != TimeoutStep::AfterShutdown {
756 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
757 assert!(check_warn_msg!(nodes[1], nodes[0].node.get_our_node_id(), chan_id)
758 .starts_with("Unable to come to consensus about closing feerate"));
760 // Now deliver a mutated closing_signed indicating a higher acceptable fee range, which
761 // nodes[1] should happily accept and respond to.
762 node_0_closing_signed.fee_range.as_mut().unwrap().max_fee_satoshis *= 10;
764 let mut node_0_per_peer_lock;
765 let mut node_0_peer_state_lock;
766 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;
768 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
769 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
770 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
771 let node_0_2nd_closing_signed = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
772 if timeout_step == TimeoutStep::NoTimeout {
773 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.1.unwrap());
774 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
776 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
779 if timeout_step != TimeoutStep::NoTimeout {
780 assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
782 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
785 nodes[1].node.timer_tick_occurred();
786 nodes[1].node.timer_tick_occurred();
788 let txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
789 assert_eq!(txn.len(), 1);
790 assert_eq!(txn[0].output.len(), 2);
792 if timeout_step != TimeoutStep::NoTimeout {
793 assert!((txn[0].output[0].script_pubkey.is_v0_p2wpkh() &&
794 txn[0].output[1].script_pubkey.is_v0_p2wsh()) ||
795 (txn[0].output[1].script_pubkey.is_v0_p2wpkh() &&
796 txn[0].output[0].script_pubkey.is_v0_p2wsh()));
797 check_closed_broadcast!(nodes[1], true);
798 check_added_monitors!(nodes[1], 1);
799 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "closing_signed negotiation failed to finish within two timer ticks".to_string() });
801 assert!(txn[0].output[0].script_pubkey.is_v0_p2wpkh());
802 assert!(txn[0].output[1].script_pubkey.is_v0_p2wpkh());
804 let events = nodes[1].node.get_and_clear_pending_msg_events();
805 assert_eq!(events.len(), 1);
807 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
808 assert_eq!(msg.contents.flags & 2, 2);
810 _ => panic!("Unexpected event"),
816 fn test_closing_signed_reinit_timeout() {
817 do_test_closing_signed_reinit_timeout(TimeoutStep::AfterShutdown);
818 do_test_closing_signed_reinit_timeout(TimeoutStep::AfterClosingSigned);
819 do_test_closing_signed_reinit_timeout(TimeoutStep::NoTimeout);
822 fn do_simple_legacy_shutdown_test(high_initiator_fee: bool) {
823 // A simpe test of the legacy shutdown fee negotiation logic.
824 let chanmon_cfgs = create_chanmon_cfgs(2);
825 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
826 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
827 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
829 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
831 if high_initiator_fee {
832 // If high_initiator_fee is set, set nodes[0]'s feerate significantly higher. This
833 // shouldn't impact the flow at all given nodes[1] will happily accept the higher fee.
834 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
838 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[1].node.get_our_node_id()).unwrap();
839 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
840 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &channelmanager::provided_init_features(), &node_0_shutdown);
841 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
842 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &channelmanager::provided_init_features(), &node_1_shutdown);
844 let mut node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
845 node_0_closing_signed.fee_range = None;
846 if high_initiator_fee {
847 assert!(node_0_closing_signed.fee_satoshis > 500);
849 assert!(node_0_closing_signed.fee_satoshis < 500);
852 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
853 let (_, mut node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
854 node_1_closing_signed.as_mut().unwrap().fee_range = None;
856 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
857 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
858 assert!(node_0_none.is_none());
859 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
860 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
864 fn simple_legacy_shutdown_test() {
865 do_simple_legacy_shutdown_test(false);
866 do_simple_legacy_shutdown_test(true);
870 fn simple_target_feerate_shutdown() {
871 // Simple test of target in `close_channel_with_target_feerate`.
872 let chanmon_cfgs = create_chanmon_cfgs(2);
873 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
874 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
875 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
877 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
878 let chan_id = OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id();
880 nodes[0].node.close_channel_with_target_feerate(&chan_id, &nodes[1].node.get_our_node_id(), 253 * 10).unwrap();
881 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
882 nodes[1].node.close_channel_with_target_feerate(&chan_id, &nodes[0].node.get_our_node_id(), 253 * 5).unwrap();
883 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
885 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &channelmanager::provided_init_features(), &node_0_shutdown);
886 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &channelmanager::provided_init_features(), &node_1_shutdown);
888 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
889 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
890 let (_, node_1_closing_signed_opt) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
891 let node_1_closing_signed = node_1_closing_signed_opt.unwrap();
893 // nodes[1] was passed a target which was larger than the current channel feerate, which it
894 // should ignore in favor of the channel fee, as there is no use demanding a minimum higher
895 // than what will be paid on a force-close transaction. Note that we have to consider rounding,
896 // so only check that we're within 10 sats.
897 assert!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis >=
898 node_1_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis * 10 - 5);
899 assert!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis <=
900 node_1_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis * 10 + 5);
902 // Further, because nodes[0]'s target fee is larger than the `Normal` fee estimation plus our
903 // force-closure-avoidance buffer, min should equal max, and the nodes[1]-selected fee should
904 // be the nodes[0] only available fee.
905 assert_eq!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis,
906 node_0_closing_signed.fee_range.as_ref().unwrap().max_fee_satoshis);
907 assert_eq!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis,
908 node_0_closing_signed.fee_satoshis);
909 assert_eq!(node_0_closing_signed.fee_satoshis, node_1_closing_signed.fee_satoshis);
911 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
912 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
913 assert!(node_0_none.is_none());
914 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
915 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);