_ Git - rust-lightning/blob - lightning/src/ln/shutdown_tests.rs

   1 // This file is Copyright its original authors, visible in version control
   2 // history.
   3 //
   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
   8 // licenses.
   9
  10 //! Tests of our shutdown and closing_signed negotiation logic.
  11
  12 use crate::chain::keysinterface::{EntropySource, SignerProvider};
  13 use crate::chain::transaction::OutPoint;
  14 use crate::events::{Event, MessageSendEvent, MessageSendEventsProvider, ClosureReason};
  15 use crate::ln::channelmanager::{self, PaymentSendFailure, PaymentId, RecipientOnionFields};
  16 use crate::routing::router::{PaymentParameters, get_route};
  17 use crate::ln::msgs;
  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;
  25
  26 use bitcoin::blockdata::script::Builder;
  27 use bitcoin::blockdata::opcodes;
  28 use bitcoin::network::constants::Network;
  29 use bitcoin::util::address::WitnessVersion;
  30
  31 use regex;
  32
  33 use core::default::Default;
  34 use std::convert::TryFrom;
  35
  36 use crate::ln::functional_test_utils::*;
  37 use crate::ln::msgs::OptionalField::Present;
  38
  39 #[test]
  40 fn pre_funding_lock_shutdown_test() {
  41         // Test sending a shutdown prior to channel_ready after funding generation
  42         let chanmon_cfgs = create_chanmon_cfgs(2);
  43         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
  44         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
  45         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
  46         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0);
  47         mine_transaction(&nodes[0], &tx);
  48         mine_transaction(&nodes[1], &tx);
  49
  50         nodes[0].node.close_channel(&OutPoint { txid: tx.txid(), index: 0 }.to_channel_id(), &nodes[1].node.get_our_node_id()).unwrap();
  51         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
  52         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
  53         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
  54         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
  55
  56         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
  57         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
  58         let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
  59         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
  60         let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
  61         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
  62         let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
  63         assert!(node_1_none.is_none());
  64
  65         assert!(nodes[0].node.list_channels().is_empty());
  66         assert!(nodes[1].node.list_channels().is_empty());
  67         check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
  68         check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
  69 }
  70
  71 #[test]
  72 fn updates_shutdown_wait() {
  73         // Test sending a shutdown with outstanding updates pending
  74         let chanmon_cfgs = create_chanmon_cfgs(3);
  75         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
  76         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
  77         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
  78         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
  79         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
  80         let logger = test_utils::TestLogger::new();
  81         let scorer = test_utils::TestScorer::new();
  82         let keys_manager = test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
  83         let random_seed_bytes = keys_manager.get_secure_random_bytes();
  84
  85         let (payment_preimage_0, payment_hash_0, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100_000);
  86
  87         nodes[0].node.close_channel(&chan_1.2, &nodes[1].node.get_our_node_id()).unwrap();
  88         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
  89         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
  90         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
  91         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
  92
  93         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
  94         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
  95
  96         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
  97
  98         let payment_params_1 = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id(), TEST_FINAL_CLTV).with_features(nodes[1].node.invoice_features());
  99         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();
 100         let payment_params_2 = PaymentParameters::from_node_id(nodes[0].node.get_our_node_id(), TEST_FINAL_CLTV).with_features(nodes[0].node.invoice_features());
 101         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();
 102         unwrap_send_err!(nodes[0].node.send_payment_with_route(&route_1, payment_hash,
 103                         RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)
 104                 ), true, APIError::ChannelUnavailable {..}, {});
 105         unwrap_send_err!(nodes[1].node.send_payment_with_route(&route_2, payment_hash,
 106                         RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)
 107                 ), true, APIError::ChannelUnavailable {..}, {});
 108
 109         nodes[2].node.claim_funds(payment_preimage_0);
 110         check_added_monitors!(nodes[2], 1);
 111         expect_payment_claimed!(nodes[2], payment_hash_0, 100_000);
 112
 113         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
 114         assert!(updates.update_add_htlcs.is_empty());
 115         assert!(updates.update_fail_htlcs.is_empty());
 116         assert!(updates.update_fail_malformed_htlcs.is_empty());
 117         assert!(updates.update_fee.is_none());
 118         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
 119         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
 120         expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), false, false);
 121         check_added_monitors!(nodes[1], 1);
 122         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 123         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
 124
 125         assert!(updates_2.update_add_htlcs.is_empty());
 126         assert!(updates_2.update_fail_htlcs.is_empty());
 127         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 128         assert!(updates_2.update_fee.is_none());
 129         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
 130         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
 131         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 132         expect_payment_sent!(nodes[0], payment_preimage_0);
 133
 134         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 135         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 136         let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
 137         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
 138         let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 139         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
 140         let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 141         assert!(node_1_none.is_none());
 142         check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
 143         check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
 144
 145         assert!(nodes[0].node.list_channels().is_empty());
 146
 147         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 148         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 149         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
 150         assert!(nodes[1].node.list_channels().is_empty());
 151         assert!(nodes[2].node.list_channels().is_empty());
 152         check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
 153         check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure);
 154 }
 155
 156 #[test]
 157 fn htlc_fail_async_shutdown() {
 158         // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
 159         let chanmon_cfgs = create_chanmon_cfgs(3);
 160         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 161         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 162         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 163         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
 164         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
 165
 166         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], 100000);
 167         nodes[0].node.send_payment_with_route(&route, our_payment_hash,
 168                 RecipientOnionFields::secret_only(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
 169         check_added_monitors!(nodes[0], 1);
 170         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 171         assert_eq!(updates.update_add_htlcs.len(), 1);
 172         assert!(updates.update_fulfill_htlcs.is_empty());
 173         assert!(updates.update_fail_htlcs.is_empty());
 174         assert!(updates.update_fail_malformed_htlcs.is_empty());
 175         assert!(updates.update_fee.is_none());
 176
 177         nodes[1].node.close_channel(&chan_1.2, &nodes[0].node.get_our_node_id()).unwrap();
 178         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 179         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 180         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 181
 182         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
 183         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
 184         check_added_monitors!(nodes[1], 1);
 185         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 186         commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
 187
 188         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 189         assert!(updates_2.update_add_htlcs.is_empty());
 190         assert!(updates_2.update_fulfill_htlcs.is_empty());
 191         assert_eq!(updates_2.update_fail_htlcs.len(), 1);
 192         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 193         assert!(updates_2.update_fee.is_none());
 194
 195         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]);
 196         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 197
 198         expect_payment_failed_with_update!(nodes[0], our_payment_hash, false, chan_2.0.contents.short_channel_id, true);
 199
 200         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
 201         assert_eq!(msg_events.len(), 1);
 202         let node_0_closing_signed = match msg_events[0] {
 203                 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
 204                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
 205                         (*msg).clone()
 206                 },
 207                 _ => panic!("Unexpected event"),
 208         };
 209
 210         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 211         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 212         let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
 213         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
 214         let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 215         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
 216         let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 217         assert!(node_1_none.is_none());
 218
 219         assert!(nodes[0].node.list_channels().is_empty());
 220
 221         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 222         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 223         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
 224         assert!(nodes[1].node.list_channels().is_empty());
 225         assert!(nodes[2].node.list_channels().is_empty());
 226         check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
 227         check_closed_event!(nodes[1], 2, ClosureReason::CooperativeClosure);
 228         check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure);
 229 }
 230
 231 fn do_test_shutdown_rebroadcast(recv_count: u8) {
 232         // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
 233         // messages delivered prior to disconnect
 234         let chanmon_cfgs = create_chanmon_cfgs(3);
 235         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 236         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 237         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 238         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
 239         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
 240
 241         let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100_000);
 242
 243         nodes[1].node.close_channel(&chan_1.2, &nodes[0].node.get_our_node_id()).unwrap();
 244         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 245         if recv_count > 0 {
 246                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 247                 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 248                 if recv_count > 1 {
 249                         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 250                 }
 251         }
 252
 253         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
 254         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
 255
 256         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: nodes[1].node.init_features(), remote_network_address: None }, true).unwrap();
 257         let node_0_reestablish = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
 258         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: nodes[0].node.init_features(), remote_network_address: None }, false).unwrap();
 259         let node_1_reestablish = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
 260
 261         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish);
 262         let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 263         assert!(node_1_shutdown == node_1_2nd_shutdown);
 264
 265         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish);
 266         let node_0_2nd_shutdown = if recv_count > 0 {
 267                 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 268                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
 269                 node_0_2nd_shutdown
 270         } else {
 271                 let node_0_chan_update = get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
 272                 assert_eq!(node_0_chan_update.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
 273                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
 274                 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
 275         };
 276         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_2nd_shutdown);
 277
 278         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 279         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 280
 281         nodes[2].node.claim_funds(payment_preimage);
 282         check_added_monitors!(nodes[2], 1);
 283         expect_payment_claimed!(nodes[2], payment_hash, 100_000);
 284
 285         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
 286         assert!(updates.update_add_htlcs.is_empty());
 287         assert!(updates.update_fail_htlcs.is_empty());
 288         assert!(updates.update_fail_malformed_htlcs.is_empty());
 289         assert!(updates.update_fee.is_none());
 290         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
 291         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
 292         expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), false, false);
 293         check_added_monitors!(nodes[1], 1);
 294         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 295         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
 296
 297         assert!(updates_2.update_add_htlcs.is_empty());
 298         assert!(updates_2.update_fail_htlcs.is_empty());
 299         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 300         assert!(updates_2.update_fee.is_none());
 301         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
 302         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
 303         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 304         expect_payment_sent!(nodes[0], payment_preimage);
 305
 306         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 307         if recv_count > 0 {
 308                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 309                 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
 310                 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
 311                 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 312                 assert!(node_0_2nd_closing_signed.is_some());
 313         }
 314
 315         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
 316         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
 317
 318         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: nodes[0].node.init_features(), remote_network_address: None }, true).unwrap();
 319         let node_1_2nd_reestablish = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
 320         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: nodes[1].node.init_features(), remote_network_address: None }, false).unwrap();
 321         if recv_count == 0 {
 322                 // If all closing_signeds weren't delivered we can just resume where we left off...
 323                 let node_0_2nd_reestablish = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
 324
 325                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
 326                 let node_0_msgs = nodes[0].node.get_and_clear_pending_msg_events();
 327                 assert_eq!(node_0_msgs.len(), 2);
 328                 let node_0_2nd_closing_signed = match node_0_msgs[1] {
 329                         MessageSendEvent::SendClosingSigned { ref msg, .. } => {
 330                                 assert_eq!(node_0_closing_signed, *msg);
 331                                 msg.clone()
 332                         },
 333                         _ => panic!(),
 334                 };
 335
 336                 let node_0_3rd_shutdown = match node_0_msgs[0] {
 337                         MessageSendEvent::SendShutdown { ref msg, .. } => {
 338                                 assert_eq!(node_0_2nd_shutdown, *msg);
 339                                 msg.clone()
 340                         },
 341                         _ => panic!(),
 342                 };
 343                 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
 344
 345                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
 346                 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 347                 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
 348
 349                 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_3rd_shutdown);
 350                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 351
 352                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_3rd_shutdown);
 353
 354                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed);
 355                 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
 356                 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
 357                 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 358                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
 359                 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 360                 assert!(node_1_none.is_none());
 361                 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
 362         } else {
 363                 // If one node, however, received + responded with an identical closing_signed we end
 364                 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
 365                 // There isn't really anything better we can do simply, but in the future we might
 366                 // explore storing a set of recently-closed channels that got disconnected during
 367                 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
 368                 // give our counterparty enough time to (potentially) broadcast a cooperative closing
 369                 // transaction.
 370                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 371
 372                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
 373                 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
 374                 assert_eq!(msg_events.len(), 1);
 375                 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
 376                         match action {
 377                                 &ErrorAction::SendErrorMessage { ref msg } => {
 378                                         nodes[1].node.handle_error(&nodes[0].node.get_our_node_id(), &msg);
 379                                         assert_eq!(msg.channel_id, chan_1.2);
 380                                 },
 381                                 _ => panic!("Unexpected event!"),
 382                         }
 383                 } else { panic!("Needed SendErrorMessage close"); }
 384
 385                 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
 386                 // checks it, but in this case nodes[1] didn't ever get a chance to receive a
 387                 // closing_signed so we do it ourselves
 388                 check_closed_broadcast!(nodes[1], false);
 389                 check_added_monitors!(nodes[1], 1);
 390                 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())) });
 391         }
 392
 393         assert!(nodes[0].node.list_channels().is_empty());
 394
 395         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 396         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 397         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
 398         assert!(nodes[1].node.list_channels().is_empty());
 399         assert!(nodes[2].node.list_channels().is_empty());
 400         check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
 401         check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
 402         check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure);
 403 }
 404
 405 #[test]
 406 fn test_shutdown_rebroadcast() {
 407         do_test_shutdown_rebroadcast(0);
 408         do_test_shutdown_rebroadcast(1);
 409         do_test_shutdown_rebroadcast(2);
 410 }
 411
 412 #[test]
 413 fn test_upfront_shutdown_script() {
 414         // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
 415         // enforce it at shutdown message
 416
 417         let mut config = UserConfig::default();
 418         config.channel_handshake_config.announced_channel = true;
 419         config.channel_handshake_limits.force_announced_channel_preference = false;
 420         config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
 421         let user_cfgs = [None, Some(config), None];
 422         let chanmon_cfgs = create_chanmon_cfgs(3);
 423         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 424         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
 425         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 426
 427         // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
 428         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000);
 429         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[2].node.get_our_node_id()).unwrap();
 430         let node_0_orig_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
 431         let mut node_0_shutdown = node_0_orig_shutdown.clone();
 432         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
 433         // Test we enforce upfront_scriptpbukey if by providing a different one at closing that we warn
 434         // the peer and ignore the message.
 435         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 436         assert!(regex::Regex::new(r"Got shutdown request with a scriptpubkey \([A-Fa-f0-9]+\) which did not match their previous scriptpubkey.")
 437                         .unwrap().is_match(&check_warn_msg!(nodes[2], nodes[0].node.get_our_node_id(), chan.2)));
 438         // This allows nodes[2] to retry the shutdown message, which should get a response:
 439         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_orig_shutdown);
 440         get_event_msg!(nodes[2], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 441
 442         // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
 443         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000);
 444         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[2].node.get_our_node_id()).unwrap();
 445         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
 446         // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
 447         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 448         let events = nodes[2].node.get_and_clear_pending_msg_events();
 449         assert_eq!(events.len(), 1);
 450         match events[0] {
 451                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
 452                 _ => panic!("Unexpected event"),
 453         }
 454
 455         // We test that if case of peer non-signaling we don't enforce committed script at channel opening
 456         *nodes[0].override_init_features.borrow_mut() = Some(nodes[0].node.init_features().clear_upfront_shutdown_script());
 457         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000);
 458         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[1].node.get_our_node_id()).unwrap();
 459         let node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 460         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_1_shutdown);
 461         check_added_monitors!(nodes[1], 1);
 462         let events = nodes[1].node.get_and_clear_pending_msg_events();
 463         assert_eq!(events.len(), 1);
 464         match events[0] {
 465                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
 466                 _ => panic!("Unexpected event"),
 467         }
 468
 469         // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
 470         // channel smoothly, opt-out is from channel initiator here
 471         *nodes[0].override_init_features.borrow_mut() = None;
 472         let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000);
 473         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[0].node.get_our_node_id()).unwrap();
 474         check_added_monitors!(nodes[1], 1);
 475         let node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 476         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
 477         let events = nodes[0].node.get_and_clear_pending_msg_events();
 478         assert_eq!(events.len(), 1);
 479         match events[0] {
 480                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
 481                 _ => panic!("Unexpected event"),
 482         }
 483
 484         //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
 485         //// channel smoothly
 486         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000);
 487         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[0].node.get_our_node_id()).unwrap();
 488         check_added_monitors!(nodes[1], 1);
 489         let node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 490         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
 491         let events = nodes[0].node.get_and_clear_pending_msg_events();
 492         assert_eq!(events.len(), 2);
 493         match events[0] {
 494                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
 495                 _ => panic!("Unexpected event"),
 496         }
 497         match events[1] {
 498                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
 499                 _ => panic!("Unexpected event"),
 500         }
 501 }
 502
 503 #[test]
 504 fn test_unsupported_anysegwit_upfront_shutdown_script() {
 505         let chanmon_cfgs = create_chanmon_cfgs(2);
 506         let mut node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 507         // Clear shutdown_anysegwit on initiator
 508         *node_cfgs[0].override_init_features.borrow_mut() = Some(channelmanager::provided_init_features(&test_default_channel_config()).clear_shutdown_anysegwit());
 509         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 510         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 511
 512         // Use a non-v0 segwit script supported by option_shutdown_anysegwit
 513         let anysegwit_shutdown_script = Builder::new()
 514                 .push_int(16)
 515                 .push_slice(&[0, 40])
 516                 .into_script();
 517
 518         // Check script when handling an open_channel message
 519         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
 520         let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
 521         open_channel.shutdown_scriptpubkey = Present(anysegwit_shutdown_script.clone());
 522         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel);
 523
 524         let events = nodes[1].node.get_and_clear_pending_msg_events();
 525         assert_eq!(events.len(), 1);
 526         match events[0] {
 527                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
 528                         assert_eq!(node_id, nodes[0].node.get_our_node_id());
 529                         assert_eq!(msg.data, "Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: Script(OP_PUSHNUM_16 OP_PUSHBYTES_2 0028)");
 530                 },
 531                 _ => panic!("Unexpected event"),
 532         }
 533
 534         let chanmon_cfgs = create_chanmon_cfgs(2);
 535         let mut node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 536         // Clear shutdown_anysegwit on responder
 537         *node_cfgs[1].override_init_features.borrow_mut() = Some(channelmanager::provided_init_features(&test_default_channel_config()).clear_shutdown_anysegwit());
 538         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 539         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 540
 541         // Check script when handling an accept_channel message
 542         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
 543         let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
 544         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel);
 545         let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
 546         accept_channel.shutdown_scriptpubkey = Present(anysegwit_shutdown_script.clone());
 547         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel);
 548
 549         let events = nodes[0].node.get_and_clear_pending_msg_events();
 550         assert_eq!(events.len(), 1);
 551         match events[0] {
 552                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
 553                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
 554                         assert_eq!(msg.data, "Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: Script(OP_PUSHNUM_16 OP_PUSHBYTES_2 0028)");
 555                 },
 556                 _ => panic!("Unexpected event"),
 557         }
 558         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() });
 559 }
 560
 561 #[test]
 562 fn test_invalid_upfront_shutdown_script() {
 563         let chanmon_cfgs = create_chanmon_cfgs(2);
 564         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 565         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 566         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 567
 568         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
 569
 570         // Use a segwit v0 script with an unsupported witness program
 571         let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
 572         open_channel.shutdown_scriptpubkey = Present(Builder::new().push_int(0)
 573                 .push_slice(&[0, 0])
 574                 .into_script());
 575         nodes[0].node.handle_open_channel(&nodes[1].node.get_our_node_id(), &open_channel);
 576
 577         let events = nodes[0].node.get_and_clear_pending_msg_events();
 578         assert_eq!(events.len(), 1);
 579         match events[0] {
 580                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
 581                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
 582                         assert_eq!(msg.data, "Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: Script(OP_0 OP_PUSHBYTES_2 0000)");
 583                 },
 584                 _ => panic!("Unexpected event"),
 585         }
 586 }
 587
 588 #[test]
 589 fn test_segwit_v0_shutdown_script() {
 590         let mut config = UserConfig::default();
 591         config.channel_handshake_config.announced_channel = true;
 592         config.channel_handshake_limits.force_announced_channel_preference = false;
 593         config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
 594         let user_cfgs = [None, Some(config), None];
 595         let chanmon_cfgs = create_chanmon_cfgs(3);
 596         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 597         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
 598         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 599
 600         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
 601         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[0].node.get_our_node_id()).unwrap();
 602         check_added_monitors!(nodes[1], 1);
 603
 604         // Use a segwit v0 script supported even without option_shutdown_anysegwit
 605         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 606         node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
 607                 .push_slice(&[0; 20])
 608                 .into_script();
 609         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
 610
 611         let events = nodes[0].node.get_and_clear_pending_msg_events();
 612         assert_eq!(events.len(), 2);
 613         match events[0] {
 614                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
 615                 _ => panic!("Unexpected event"),
 616         }
 617         match events[1] {
 618                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
 619                 _ => panic!("Unexpected event"),
 620         }
 621 }
 622
 623 #[test]
 624 fn test_anysegwit_shutdown_script() {
 625         let mut config = UserConfig::default();
 626         config.channel_handshake_config.announced_channel = true;
 627         config.channel_handshake_limits.force_announced_channel_preference = false;
 628         config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
 629         let user_cfgs = [None, Some(config), None];
 630         let chanmon_cfgs = create_chanmon_cfgs(3);
 631         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 632         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
 633         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 634
 635         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
 636         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[0].node.get_our_node_id()).unwrap();
 637         check_added_monitors!(nodes[1], 1);
 638
 639         // Use a non-v0 segwit script supported by option_shutdown_anysegwit
 640         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 641         node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
 642                 .push_slice(&[0, 0])
 643                 .into_script();
 644         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
 645
 646         let events = nodes[0].node.get_and_clear_pending_msg_events();
 647         assert_eq!(events.len(), 2);
 648         match events[0] {
 649                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
 650                 _ => panic!("Unexpected event"),
 651         }
 652         match events[1] {
 653                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
 654                 _ => panic!("Unexpected event"),
 655         }
 656 }
 657
 658 #[test]
 659 fn test_unsupported_anysegwit_shutdown_script() {
 660         let mut config = UserConfig::default();
 661         config.channel_handshake_config.announced_channel = true;
 662         config.channel_handshake_limits.force_announced_channel_preference = false;
 663         config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
 664         let user_cfgs = [None, Some(config), None];
 665         let chanmon_cfgs = create_chanmon_cfgs(3);
 666         let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 667         *node_cfgs[0].override_init_features.borrow_mut() = Some(channelmanager::provided_init_features(&config).clear_shutdown_anysegwit());
 668         *node_cfgs[1].override_init_features.borrow_mut() = Some(channelmanager::provided_init_features(&config).clear_shutdown_anysegwit());
 669         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
 670         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 671
 672         // Check that using an unsupported shutdown script fails and a supported one succeeds.
 673         let supported_shutdown_script = chanmon_cfgs[1].keys_manager.get_shutdown_scriptpubkey().unwrap();
 674         let unsupported_shutdown_script =
 675                 ShutdownScript::new_witness_program(WitnessVersion::V16, &[0, 40]).unwrap();
 676         chanmon_cfgs[1].keys_manager
 677                 .expect(OnGetShutdownScriptpubkey { returns: unsupported_shutdown_script.clone() })
 678                 .expect(OnGetShutdownScriptpubkey { returns: supported_shutdown_script });
 679
 680         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
 681         match nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[0].node.get_our_node_id()) {
 682                 Err(APIError::IncompatibleShutdownScript { script }) => {
 683                         assert_eq!(script.into_inner(), unsupported_shutdown_script.clone().into_inner());
 684                 },
 685                 Err(e) => panic!("Unexpected error: {:?}", e),
 686                 Ok(_) => panic!("Expected error"),
 687         }
 688         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[0].node.get_our_node_id()).unwrap();
 689         check_added_monitors!(nodes[1], 1);
 690
 691         // Use a non-v0 segwit script unsupported without option_shutdown_anysegwit
 692         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 693         node_0_shutdown.scriptpubkey = unsupported_shutdown_script.into_inner();
 694         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
 695
 696         assert_eq!(&check_warn_msg!(nodes[0], nodes[1].node.get_our_node_id(), chan.2),
 697                         "Got a nonstandard scriptpubkey (60020028) from remote peer");
 698 }
 699
 700 #[test]
 701 fn test_invalid_shutdown_script() {
 702         let mut config = UserConfig::default();
 703         config.channel_handshake_config.announced_channel = true;
 704         config.channel_handshake_limits.force_announced_channel_preference = false;
 705         config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
 706         let user_cfgs = [None, Some(config), None];
 707         let chanmon_cfgs = create_chanmon_cfgs(3);
 708         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 709         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
 710         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 711
 712         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
 713         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[0].node.get_our_node_id()).unwrap();
 714         check_added_monitors!(nodes[1], 1);
 715
 716         // Use a segwit v0 script with an unsupported witness program
 717         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 718         node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
 719                 .push_slice(&[0, 0])
 720                 .into_script();
 721         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
 722
 723         assert_eq!(&check_warn_msg!(nodes[0], nodes[1].node.get_our_node_id(), chan.2),
 724                         "Got a nonstandard scriptpubkey (00020000) from remote peer");
 725 }
 726
 727 #[test]
 728 fn test_user_shutdown_script() {
 729         let mut config = test_default_channel_config();
 730         config.channel_handshake_config.announced_channel = true;
 731         config.channel_handshake_limits.force_announced_channel_preference = false;
 732         config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
 733         let user_cfgs = [None, Some(config), None];
 734         let chanmon_cfgs = create_chanmon_cfgs(3);
 735         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 736         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
 737         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 738
 739         // Segwit v0 script of the form OP_0 <20-byte hash>
 740         let script = Builder::new().push_int(0)
 741                 .push_slice(&[0; 20])
 742                 .into_script();
 743
 744         let shutdown_script = ShutdownScript::try_from(script.clone()).unwrap();
 745
 746         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
 747         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();
 748         check_added_monitors!(nodes[1], 1);
 749
 750         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 751
 752         assert_eq!(node_0_shutdown.scriptpubkey, script);
 753 }
 754
 755 #[test]
 756 fn test_already_set_user_shutdown_script() {
 757         let mut config = test_default_channel_config();
 758         config.channel_handshake_config.announced_channel = true;
 759         config.channel_handshake_limits.force_announced_channel_preference = false;
 760         let user_cfgs = [None, Some(config), None];
 761         let chanmon_cfgs = create_chanmon_cfgs(3);
 762         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 763         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
 764         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 765
 766         // Segwit v0 script of the form OP_0 <20-byte hash>
 767         let script = Builder::new().push_int(0)
 768                 .push_slice(&[0; 20])
 769                 .into_script();
 770
 771         let shutdown_script = ShutdownScript::try_from(script).unwrap();
 772
 773         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
 774         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));
 775
 776         assert_eq!(result, Err(APIError::APIMisuseError { err: "Cannot override shutdown script for a channel with one already set".to_string() }));
 777 }
 778
 779 #[derive(PartialEq)]
 780 enum TimeoutStep {
 781         AfterShutdown,
 782         AfterClosingSigned,
 783         NoTimeout,
 784 }
 785
 786 fn do_test_closing_signed_reinit_timeout(timeout_step: TimeoutStep) {
 787         // The range-based closing signed negotiation allows the funder to restart the process with a
 788         // new range if the previous range did not overlap. This allows implementations to request user
 789         // intervention allowing users to enter a new fee range. We do not implement the sending side
 790         // of this, instead opting to allow users to enter an explicit "willing to pay up to X to avoid
 791         // force-closing" value and relying on that instead.
 792         //
 793         // Here we run test the fundee side of that restart mechanism, implementing the funder side of
 794         // it manually.
 795         let chanmon_cfgs = create_chanmon_cfgs(2);
 796         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 797         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 798         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 799         let chan_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
 800
 801         send_payment(&nodes[0], &[&nodes[1]], 8_000_000);
 802
 803         nodes[0].node.close_channel(&chan_id, &nodes[1].node.get_our_node_id()).unwrap();
 804         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 805         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 806         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 807         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 808
 809         {
 810                 // Now we set nodes[1] to require a relatively high feerate for closing. This should result
 811                 // in it rejecting nodes[0]'s initial closing_signed, giving nodes[0] a chance to try
 812                 // again.
 813                 let mut feerate_lock = chanmon_cfgs[1].fee_estimator.sat_per_kw.lock().unwrap();
 814                 *feerate_lock *= 10;
 815         }
 816
 817         let mut node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 818         // nodes[0] should use a "reasonable" feerate, well under the 10 sat/vByte that nodes[1] thinks
 819         // is the current prevailing feerate.
 820         assert!(node_0_closing_signed.fee_satoshis <= 500);
 821
 822         if timeout_step != TimeoutStep::AfterShutdown {
 823                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 824                 assert!(check_warn_msg!(nodes[1], nodes[0].node.get_our_node_id(), chan_id)
 825                         .starts_with("Unable to come to consensus about closing feerate"));
 826
 827                 // Now deliver a mutated closing_signed indicating a higher acceptable fee range, which
 828                 // nodes[1] should happily accept and respond to.
 829                 node_0_closing_signed.fee_range.as_mut().unwrap().max_fee_satoshis *= 10;
 830                 {
 831                         let mut node_0_per_peer_lock;
 832                         let mut node_0_peer_state_lock;
 833                         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;
 834                 }
 835                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 836                 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
 837                 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
 838                 let node_0_2nd_closing_signed = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 839                 if timeout_step == TimeoutStep::NoTimeout {
 840                         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.1.unwrap());
 841                         check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
 842                 }
 843                 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
 844         }
 845
 846         if timeout_step != TimeoutStep::NoTimeout {
 847                 assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
 848         } else {
 849                 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 850         }
 851
 852         nodes[1].node.timer_tick_occurred();
 853         nodes[1].node.timer_tick_occurred();
 854
 855         let txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
 856         assert_eq!(txn.len(), 1);
 857         assert_eq!(txn[0].output.len(), 2);
 858
 859         if timeout_step != TimeoutStep::NoTimeout {
 860                 assert!((txn[0].output[0].script_pubkey.is_v0_p2wpkh() &&
 861                          txn[0].output[1].script_pubkey.is_v0_p2wsh()) ||
 862                         (txn[0].output[1].script_pubkey.is_v0_p2wpkh() &&
 863                          txn[0].output[0].script_pubkey.is_v0_p2wsh()));
 864                 check_closed_broadcast!(nodes[1], true);
 865                 check_added_monitors!(nodes[1], 1);
 866                 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "closing_signed negotiation failed to finish within two timer ticks".to_string() });
 867         } else {
 868                 assert!(txn[0].output[0].script_pubkey.is_v0_p2wpkh());
 869                 assert!(txn[0].output[1].script_pubkey.is_v0_p2wpkh());
 870
 871                 let events = nodes[1].node.get_and_clear_pending_msg_events();
 872                 assert_eq!(events.len(), 1);
 873                 match events[0] {
 874                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
 875                                 assert_eq!(msg.contents.flags & 2, 2);
 876                         },
 877                         _ => panic!("Unexpected event"),
 878                 }
 879         }
 880 }
 881
 882 #[test]
 883 fn test_closing_signed_reinit_timeout() {
 884         do_test_closing_signed_reinit_timeout(TimeoutStep::AfterShutdown);
 885         do_test_closing_signed_reinit_timeout(TimeoutStep::AfterClosingSigned);
 886         do_test_closing_signed_reinit_timeout(TimeoutStep::NoTimeout);
 887 }
 888
 889 fn do_simple_legacy_shutdown_test(high_initiator_fee: bool) {
 890         // A simpe test of the legacy shutdown fee negotiation logic.
 891         let chanmon_cfgs = create_chanmon_cfgs(2);
 892         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 893         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 894         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 895
 896         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
 897
 898         if high_initiator_fee {
 899                 // If high_initiator_fee is set, set nodes[0]'s feerate significantly higher. This
 900                 // shouldn't impact the flow at all given nodes[1] will happily accept the higher fee.
 901                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
 902                 *feerate_lock *= 10;
 903         }
 904
 905         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[1].node.get_our_node_id()).unwrap();
 906         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 907         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 908         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 909         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 910
 911         let mut node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 912         node_0_closing_signed.fee_range = None;
 913         if high_initiator_fee {
 914                 assert!(node_0_closing_signed.fee_satoshis > 500);
 915         } else {
 916                 assert!(node_0_closing_signed.fee_satoshis < 500);
 917         }
 918
 919         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 920         let (_, mut node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 921         node_1_closing_signed.as_mut().unwrap().fee_range = None;
 922
 923         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 924         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 925         assert!(node_0_none.is_none());
 926         check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
 927         check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
 928 }
 929
 930 #[test]
 931 fn simple_legacy_shutdown_test() {
 932         do_simple_legacy_shutdown_test(false);
 933         do_simple_legacy_shutdown_test(true);
 934 }
 935
 936 #[test]
 937 fn simple_target_feerate_shutdown() {
 938         // Simple test of target in `close_channel_with_target_feerate`.
 939         let chanmon_cfgs = create_chanmon_cfgs(2);
 940         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 941         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 942         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 943
 944         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
 945         let chan_id = OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id();
 946
 947         nodes[0].node.close_channel_with_feerate_and_script(&chan_id, &nodes[1].node.get_our_node_id(), Some(253 * 10), None).unwrap();
 948         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 949         nodes[1].node.close_channel_with_feerate_and_script(&chan_id, &nodes[0].node.get_our_node_id(), Some(253 * 5), None).unwrap();
 950         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 951
 952         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 953         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 954
 955         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 956         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 957         let (_, node_1_closing_signed_opt) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 958         let node_1_closing_signed = node_1_closing_signed_opt.unwrap();
 959
 960         // nodes[1] was passed a target which was larger than the current channel feerate, which it
 961         // should ignore in favor of the channel fee, as there is no use demanding a minimum higher
 962         // than what will be paid on a force-close transaction. Note that we have to consider rounding,
 963         // so only check that we're within 10 sats.
 964         assert!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis >=
 965                 node_1_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis * 10 - 5);
 966         assert!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis <=
 967                 node_1_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis * 10 + 5);
 968
 969         // Further, because nodes[0]'s target fee is larger than the `Normal` fee estimation plus our
 970         // force-closure-avoidance buffer, min should equal max, and the nodes[1]-selected fee should
 971         // be the nodes[0] only available fee.
 972         assert_eq!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis,
 973                    node_0_closing_signed.fee_range.as_ref().unwrap().max_fee_satoshis);
 974         assert_eq!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis,
 975                    node_0_closing_signed.fee_satoshis);
 976         assert_eq!(node_0_closing_signed.fee_satoshis, node_1_closing_signed.fee_satoshis);
 977
 978         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
 979         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 980         assert!(node_0_none.is_none());
 981         check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
 982         check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
 983 }