_ 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::ln::channelmanager::{self, PaymentSendFailure, PaymentId};
  15 use crate::routing::router::{PaymentParameters, get_route};
  16 use crate::ln::msgs;
  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;
  24
  25 use bitcoin::blockdata::script::Builder;
  26 use bitcoin::blockdata::opcodes;
  27 use bitcoin::network::constants::Network;
  28 use bitcoin::util::address::WitnessVersion;
  29
  30 use regex;
  31
  32 use core::default::Default;
  33
  34 use crate::ln::functional_test_utils::*;
  35 use crate::ln::msgs::OptionalField::Present;
  36
  37 #[test]
  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);
  45         mine_transaction(&nodes[0], &tx);
  46         mine_transaction(&nodes[1], &tx);
  47
  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(), &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(), &node_1_shutdown);
  53
  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());
  62
  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);
  67 }
  68
  69 #[test]
  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);
  77         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
  78         let logger = test_utils::TestLogger::new();
  79         let scorer = test_utils::TestScorer::new();
  80         let keys_manager = test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
  81         let random_seed_bytes = keys_manager.get_secure_random_bytes();
  82
  83         let (payment_preimage_0, payment_hash_0, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100_000);
  84
  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(), &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(), &node_1_shutdown);
  90
  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());
  93
  94         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
  95
  96         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());
  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(), TEST_FINAL_CLTV).with_features(nodes[0].node.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 {..}, {});
 102
 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);
 106
 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);
 118
 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);
 127
 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);
 138
 139         assert!(nodes[0].node.list_channels().is_empty());
 140
 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);
 148 }
 149
 150 #[test]
 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);
 158         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
 159
 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());
 169
 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(), &node_1_shutdown);
 173         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 174
 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(), &node_0_shutdown);
 179         commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
 180
 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());
 187
 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);
 190
 191         expect_payment_failed_with_update!(nodes[0], our_payment_hash, false, chan_2.0.contents.short_channel_id, true);
 192
 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());
 198                         (*msg).clone()
 199                 },
 200                 _ => panic!("Unexpected event"),
 201         };
 202
 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());
 211
 212         assert!(nodes[0].node.list_channels().is_empty());
 213
 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);
 222 }
 223
 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);
 232         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
 233
 234         let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100_000);
 235
 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());
 238         if recv_count > 0 {
 239                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 240                 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 241                 if recv_count > 1 {
 242                         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 243                 }
 244         }
 245
 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);
 248
 249         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: nodes[1].node.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: nodes[0].node.init_features(), remote_network_address: None }).unwrap();
 252         let node_1_reestablish = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
 253
 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);
 257
 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(), &node_1_2nd_shutdown);
 262                 node_0_2nd_shutdown
 263         } else {
 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(), &node_1_2nd_shutdown);
 267                 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
 268         };
 269         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_2nd_shutdown);
 270
 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());
 273
 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);
 277
 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);
 289
 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);
 298
 299         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 300         if recv_count > 0 {
 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());
 306         }
 307
 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);
 310
 311         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: nodes[0].node.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: nodes[1].node.init_features(), remote_network_address: None }).unwrap();
 314         if recv_count == 0 {
 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();
 317
 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);
 324                                 msg.clone()
 325                         },
 326                         _ => panic!(),
 327                 };
 328
 329                 let node_0_3rd_shutdown = match node_0_msgs[0] {
 330                         MessageSendEvent::SendShutdown { ref msg, .. } => {
 331                                 assert_eq!(node_0_2nd_shutdown, *msg);
 332                                 msg.clone()
 333                         },
 334                         _ => panic!(),
 335                 };
 336                 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
 337
 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);
 341
 342                 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_3rd_shutdown);
 343                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 344
 345                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_3rd_shutdown);
 346
 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);
 355         } else {
 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
 362                 // transaction.
 363                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 364
 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] {
 369                         match action {
 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);
 373                                 },
 374                                 _ => panic!("Unexpected event!"),
 375                         }
 376                 } else { panic!("Needed SendErrorMessage close"); }
 377
 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()) });
 384         }
 385
 386         assert!(nodes[0].node.list_channels().is_empty());
 387
 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);
 396 }
 397
 398 #[test]
 399 fn test_shutdown_rebroadcast() {
 400         do_test_shutdown_rebroadcast(0);
 401         do_test_shutdown_rebroadcast(1);
 402         do_test_shutdown_rebroadcast(2);
 403 }
 404
 405 #[test]
 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
 409
 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 mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 419
 420         // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
 421         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000);
 422         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[2].node.get_our_node_id()).unwrap();
 423         let node_0_orig_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
 424         let mut node_0_shutdown = node_0_orig_shutdown.clone();
 425         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
 426         // Test we enforce upfront_scriptpbukey if by providing a different one at closing that we warn
 427         // the peer and ignore the message.
 428         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 429         assert!(regex::Regex::new(r"Got shutdown request with a scriptpubkey \([A-Fa-f0-9]+\) which did not match their previous scriptpubkey.")
 430                         .unwrap().is_match(&check_warn_msg!(nodes[2], nodes[0].node.get_our_node_id(), chan.2)));
 431         // This allows nodes[2] to retry the shutdown message, which should get a response:
 432         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_orig_shutdown);
 433         get_event_msg!(nodes[2], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 434
 435         // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
 436         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000);
 437         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[2].node.get_our_node_id()).unwrap();
 438         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
 439         // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
 440         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 441         let events = nodes[2].node.get_and_clear_pending_msg_events();
 442         assert_eq!(events.len(), 1);
 443         match events[0] {
 444                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
 445                 _ => panic!("Unexpected event"),
 446         }
 447
 448         // We test that if case of peer non-signaling we don't enforce committed script at channel opening
 449         *nodes[0].override_init_features.borrow_mut() = Some(nodes[0].node.init_features().clear_upfront_shutdown_script());
 450         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000);
 451         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[1].node.get_our_node_id()).unwrap();
 452         let node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 453         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_1_shutdown);
 454         check_added_monitors!(nodes[1], 1);
 455         let events = nodes[1].node.get_and_clear_pending_msg_events();
 456         assert_eq!(events.len(), 1);
 457         match events[0] {
 458                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
 459                 _ => panic!("Unexpected event"),
 460         }
 461
 462         // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
 463         // channel smoothly, opt-out is from channel initiator here
 464         *nodes[0].override_init_features.borrow_mut() = None;
 465         let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000);
 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(), &node_0_shutdown);
 470         let events = nodes[0].node.get_and_clear_pending_msg_events();
 471         assert_eq!(events.len(), 1);
 472         match events[0] {
 473                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
 474                 _ => panic!("Unexpected event"),
 475         }
 476
 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);
 480         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[0].node.get_our_node_id()).unwrap();
 481         check_added_monitors!(nodes[1], 1);
 482         let node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 483         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
 484         let events = nodes[0].node.get_and_clear_pending_msg_events();
 485         assert_eq!(events.len(), 2);
 486         match events[0] {
 487                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
 488                 _ => panic!("Unexpected event"),
 489         }
 490         match events[1] {
 491                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
 492                 _ => panic!("Unexpected event"),
 493         }
 494 }
 495
 496 #[test]
 497 fn test_unsupported_anysegwit_upfront_shutdown_script() {
 498         let chanmon_cfgs = create_chanmon_cfgs(2);
 499         let mut node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 500         // Clear shutdown_anysegwit on initiator
 501         *node_cfgs[0].override_init_features.borrow_mut() = Some(channelmanager::provided_init_features(&test_default_channel_config()).clear_shutdown_anysegwit());
 502         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 503         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 504
 505         // Use a non-v0 segwit script supported by option_shutdown_anysegwit
 506         let anysegwit_shutdown_script = Builder::new()
 507                 .push_int(16)
 508                 .push_slice(&[0, 40])
 509                 .into_script();
 510
 511         // Check script when handling an open_channel message
 512         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
 513         let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
 514         open_channel.shutdown_scriptpubkey = Present(anysegwit_shutdown_script.clone());
 515         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel);
 516
 517         let events = nodes[1].node.get_and_clear_pending_msg_events();
 518         assert_eq!(events.len(), 1);
 519         match events[0] {
 520                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
 521                         assert_eq!(node_id, nodes[0].node.get_our_node_id());
 522                         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                 },
 524                 _ => panic!("Unexpected event"),
 525         }
 526
 527         let chanmon_cfgs = create_chanmon_cfgs(2);
 528         let mut node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 529         // Clear shutdown_anysegwit on responder
 530         *node_cfgs[1].override_init_features.borrow_mut() = Some(channelmanager::provided_init_features(&test_default_channel_config()).clear_shutdown_anysegwit());
 531         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 532         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 533
 534         // Check script when handling an accept_channel message
 535         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
 536         let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
 537         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel);
 538         let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
 539         accept_channel.shutdown_scriptpubkey = Present(anysegwit_shutdown_script.clone());
 540         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel);
 541
 542         let events = nodes[0].node.get_and_clear_pending_msg_events();
 543         assert_eq!(events.len(), 1);
 544         match events[0] {
 545                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
 546                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
 547                         assert_eq!(msg.data, "Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: Script(OP_PUSHNUM_16 OP_PUSHBYTES_2 0028)");
 548                 },
 549                 _ => panic!("Unexpected event"),
 550         }
 551         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() });
 552 }
 553
 554 #[test]
 555 fn test_invalid_upfront_shutdown_script() {
 556         let chanmon_cfgs = create_chanmon_cfgs(2);
 557         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 558         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 559         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 560
 561         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
 562
 563         // Use a segwit v0 script with an unsupported witness program
 564         let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
 565         open_channel.shutdown_scriptpubkey = Present(Builder::new().push_int(0)
 566                 .push_slice(&[0, 0])
 567                 .into_script());
 568         nodes[0].node.handle_open_channel(&nodes[1].node.get_our_node_id(), &open_channel);
 569
 570         let events = nodes[0].node.get_and_clear_pending_msg_events();
 571         assert_eq!(events.len(), 1);
 572         match events[0] {
 573                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
 574                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
 575                         assert_eq!(msg.data, "Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: Script(OP_0 OP_PUSHBYTES_2 0000)");
 576                 },
 577                 _ => panic!("Unexpected event"),
 578         }
 579 }
 580
 581 #[test]
 582 fn test_segwit_v0_shutdown_script() {
 583         let mut config = UserConfig::default();
 584         config.channel_handshake_config.announced_channel = true;
 585         config.channel_handshake_limits.force_announced_channel_preference = false;
 586         config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
 587         let user_cfgs = [None, Some(config), None];
 588         let chanmon_cfgs = create_chanmon_cfgs(3);
 589         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 590         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
 591         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 592
 593         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
 594         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[0].node.get_our_node_id()).unwrap();
 595         check_added_monitors!(nodes[1], 1);
 596
 597         // Use a segwit v0 script supported even without option_shutdown_anysegwit
 598         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 599         node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
 600                 .push_slice(&[0; 20])
 601                 .into_script();
 602         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
 603
 604         let events = nodes[0].node.get_and_clear_pending_msg_events();
 605         assert_eq!(events.len(), 2);
 606         match events[0] {
 607                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
 608                 _ => panic!("Unexpected event"),
 609         }
 610         match events[1] {
 611                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
 612                 _ => panic!("Unexpected event"),
 613         }
 614 }
 615
 616 #[test]
 617 fn test_anysegwit_shutdown_script() {
 618         let mut config = UserConfig::default();
 619         config.channel_handshake_config.announced_channel = true;
 620         config.channel_handshake_limits.force_announced_channel_preference = false;
 621         config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
 622         let user_cfgs = [None, Some(config), None];
 623         let chanmon_cfgs = create_chanmon_cfgs(3);
 624         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 625         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
 626         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 627
 628         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
 629         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[0].node.get_our_node_id()).unwrap();
 630         check_added_monitors!(nodes[1], 1);
 631
 632         // Use a non-v0 segwit script supported by option_shutdown_anysegwit
 633         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 634         node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
 635                 .push_slice(&[0, 0])
 636                 .into_script();
 637         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
 638
 639         let events = nodes[0].node.get_and_clear_pending_msg_events();
 640         assert_eq!(events.len(), 2);
 641         match events[0] {
 642                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
 643                 _ => panic!("Unexpected event"),
 644         }
 645         match events[1] {
 646                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
 647                 _ => panic!("Unexpected event"),
 648         }
 649 }
 650
 651 #[test]
 652 fn test_unsupported_anysegwit_shutdown_script() {
 653         let mut config = UserConfig::default();
 654         config.channel_handshake_config.announced_channel = true;
 655         config.channel_handshake_limits.force_announced_channel_preference = false;
 656         config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
 657         let user_cfgs = [None, Some(config), None];
 658         let chanmon_cfgs = create_chanmon_cfgs(3);
 659         let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 660         *node_cfgs[0].override_init_features.borrow_mut() = Some(channelmanager::provided_init_features(&config).clear_shutdown_anysegwit());
 661         *node_cfgs[1].override_init_features.borrow_mut() = Some(channelmanager::provided_init_features(&config).clear_shutdown_anysegwit());
 662         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
 663         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 664
 665         // Check that using an unsupported shutdown script fails and a supported one succeeds.
 666         let supported_shutdown_script = chanmon_cfgs[1].keys_manager.get_shutdown_scriptpubkey();
 667         let unsupported_shutdown_script =
 668                 ShutdownScript::new_witness_program(WitnessVersion::V16, &[0, 40]).unwrap();
 669         chanmon_cfgs[1].keys_manager
 670                 .expect(OnGetShutdownScriptpubkey { returns: unsupported_shutdown_script.clone() })
 671                 .expect(OnGetShutdownScriptpubkey { returns: supported_shutdown_script });
 672
 673         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
 674         match nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[0].node.get_our_node_id()) {
 675                 Err(APIError::IncompatibleShutdownScript { script }) => {
 676                         assert_eq!(script.into_inner(), unsupported_shutdown_script.clone().into_inner());
 677                 },
 678                 Err(e) => panic!("Unexpected error: {:?}", e),
 679                 Ok(_) => panic!("Expected error"),
 680         }
 681         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[0].node.get_our_node_id()).unwrap();
 682         check_added_monitors!(nodes[1], 1);
 683
 684         // Use a non-v0 segwit script unsupported without option_shutdown_anysegwit
 685         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 686         node_0_shutdown.scriptpubkey = unsupported_shutdown_script.into_inner();
 687         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
 688
 689         assert_eq!(&check_warn_msg!(nodes[0], nodes[1].node.get_our_node_id(), chan.2),
 690                         "Got a nonstandard scriptpubkey (60020028) from remote peer");
 691 }
 692
 693 #[test]
 694 fn test_invalid_shutdown_script() {
 695         let mut config = UserConfig::default();
 696         config.channel_handshake_config.announced_channel = true;
 697         config.channel_handshake_limits.force_announced_channel_preference = false;
 698         config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
 699         let user_cfgs = [None, Some(config), None];
 700         let chanmon_cfgs = create_chanmon_cfgs(3);
 701         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 702         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
 703         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 704
 705         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
 706         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[0].node.get_our_node_id()).unwrap();
 707         check_added_monitors!(nodes[1], 1);
 708
 709         // Use a segwit v0 script with an unsupported witness program
 710         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 711         node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
 712                 .push_slice(&[0, 0])
 713                 .into_script();
 714         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
 715
 716         assert_eq!(&check_warn_msg!(nodes[0], nodes[1].node.get_our_node_id(), chan.2),
 717                         "Got a nonstandard scriptpubkey (00020000) from remote peer");
 718 }
 719
 720 #[derive(PartialEq)]
 721 enum TimeoutStep {
 722         AfterShutdown,
 723         AfterClosingSigned,
 724         NoTimeout,
 725 }
 726
 727 fn do_test_closing_signed_reinit_timeout(timeout_step: TimeoutStep) {
 728         // The range-based closing signed negotiation allows the funder to restart the process with a
 729         // new range if the previous range did not overlap. This allows implementations to request user
 730         // intervention allowing users to enter a new fee range. We do not implement the sending side
 731         // of this, instead opting to allow users to enter an explicit "willing to pay up to X to avoid
 732         // force-closing" value and relying on that instead.
 733         //
 734         // Here we run test the fundee side of that restart mechanism, implementing the funder side of
 735         // it manually.
 736         let chanmon_cfgs = create_chanmon_cfgs(2);
 737         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 738         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 739         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 740         let chan_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
 741
 742         send_payment(&nodes[0], &[&nodes[1]], 8_000_000);
 743
 744         nodes[0].node.close_channel(&chan_id, &nodes[1].node.get_our_node_id()).unwrap();
 745         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 746         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 747         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 748         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 749
 750         {
 751                 // Now we set nodes[1] to require a relatively high feerate for closing. This should result
 752                 // in it rejecting nodes[0]'s initial closing_signed, giving nodes[0] a chance to try
 753                 // again.
 754                 let mut feerate_lock = chanmon_cfgs[1].fee_estimator.sat_per_kw.lock().unwrap();
 755                 *feerate_lock *= 10;
 756         }
 757
 758         let mut node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 759         // nodes[0] should use a "reasonable" feerate, well under the 10 sat/vByte that nodes[1] thinks
 760         // is the current prevailing feerate.
 761         assert!(node_0_closing_signed.fee_satoshis <= 500);
 762
 763         if timeout_step != TimeoutStep::AfterShutdown {
 764                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 765                 assert!(check_warn_msg!(nodes[1], nodes[0].node.get_our_node_id(), chan_id)
 766                         .starts_with("Unable to come to consensus about closing feerate"));
 767
 768                 // Now deliver a mutated closing_signed indicating a higher acceptable fee range, which
 769                 // nodes[1] should happily accept and respond to.
 770                 node_0_closing_signed.fee_range.as_mut().unwrap().max_fee_satoshis *= 10;
 771                 {
 772                         let mut node_0_per_peer_lock;
 773                         let mut node_0_peer_state_lock;
 774                         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;
 775                 }
 776                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 777                 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
 778                 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
 779                 let node_0_2nd_closing_signed = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 780                 if timeout_step == TimeoutStep::NoTimeout {
 781                         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.1.unwrap());
 782                         check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
 783                 }
 784                 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
 785         }
 786
 787         if timeout_step != TimeoutStep::NoTimeout {
 788                 assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
 789         } else {
 790                 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 791         }
 792
 793         nodes[1].node.timer_tick_occurred();
 794         nodes[1].node.timer_tick_occurred();
 795
 796         let txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
 797         assert_eq!(txn.len(), 1);
 798         assert_eq!(txn[0].output.len(), 2);
 799
 800         if timeout_step != TimeoutStep::NoTimeout {
 801                 assert!((txn[0].output[0].script_pubkey.is_v0_p2wpkh() &&
 802                          txn[0].output[1].script_pubkey.is_v0_p2wsh()) ||
 803                         (txn[0].output[1].script_pubkey.is_v0_p2wpkh() &&
 804                          txn[0].output[0].script_pubkey.is_v0_p2wsh()));
 805                 check_closed_broadcast!(nodes[1], true);
 806                 check_added_monitors!(nodes[1], 1);
 807                 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "closing_signed negotiation failed to finish within two timer ticks".to_string() });
 808         } else {
 809                 assert!(txn[0].output[0].script_pubkey.is_v0_p2wpkh());
 810                 assert!(txn[0].output[1].script_pubkey.is_v0_p2wpkh());
 811
 812                 let events = nodes[1].node.get_and_clear_pending_msg_events();
 813                 assert_eq!(events.len(), 1);
 814                 match events[0] {
 815                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
 816                                 assert_eq!(msg.contents.flags & 2, 2);
 817                         },
 818                         _ => panic!("Unexpected event"),
 819                 }
 820         }
 821 }
 822
 823 #[test]
 824 fn test_closing_signed_reinit_timeout() {
 825         do_test_closing_signed_reinit_timeout(TimeoutStep::AfterShutdown);
 826         do_test_closing_signed_reinit_timeout(TimeoutStep::AfterClosingSigned);
 827         do_test_closing_signed_reinit_timeout(TimeoutStep::NoTimeout);
 828 }
 829
 830 fn do_simple_legacy_shutdown_test(high_initiator_fee: bool) {
 831         // A simpe test of the legacy shutdown fee negotiation logic.
 832         let chanmon_cfgs = create_chanmon_cfgs(2);
 833         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 834         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 835         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 836
 837         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
 838
 839         if high_initiator_fee {
 840                 // If high_initiator_fee is set, set nodes[0]'s feerate significantly higher. This
 841                 // shouldn't impact the flow at all given nodes[1] will happily accept the higher fee.
 842                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
 843                 *feerate_lock *= 10;
 844         }
 845
 846         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[1].node.get_our_node_id()).unwrap();
 847         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 848         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 849         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 850         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 851
 852         let mut node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 853         node_0_closing_signed.fee_range = None;
 854         if high_initiator_fee {
 855                 assert!(node_0_closing_signed.fee_satoshis > 500);
 856         } else {
 857                 assert!(node_0_closing_signed.fee_satoshis < 500);
 858         }
 859
 860         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 861         let (_, mut node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 862         node_1_closing_signed.as_mut().unwrap().fee_range = None;
 863
 864         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 865         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 866         assert!(node_0_none.is_none());
 867         check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
 868         check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
 869 }
 870
 871 #[test]
 872 fn simple_legacy_shutdown_test() {
 873         do_simple_legacy_shutdown_test(false);
 874         do_simple_legacy_shutdown_test(true);
 875 }
 876
 877 #[test]
 878 fn simple_target_feerate_shutdown() {
 879         // Simple test of target in `close_channel_with_target_feerate`.
 880         let chanmon_cfgs = create_chanmon_cfgs(2);
 881         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 882         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 883         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 884
 885         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
 886         let chan_id = OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id();
 887
 888         nodes[0].node.close_channel_with_target_feerate(&chan_id, &nodes[1].node.get_our_node_id(), 253 * 10).unwrap();
 889         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 890         nodes[1].node.close_channel_with_target_feerate(&chan_id, &nodes[0].node.get_our_node_id(), 253 * 5).unwrap();
 891         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 892
 893         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 894         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 895
 896         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 897         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 898         let (_, node_1_closing_signed_opt) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 899         let node_1_closing_signed = node_1_closing_signed_opt.unwrap();
 900
 901         // nodes[1] was passed a target which was larger than the current channel feerate, which it
 902         // should ignore in favor of the channel fee, as there is no use demanding a minimum higher
 903         // than what will be paid on a force-close transaction. Note that we have to consider rounding,
 904         // so only check that we're within 10 sats.
 905         assert!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis >=
 906                 node_1_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis * 10 - 5);
 907         assert!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis <=
 908                 node_1_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis * 10 + 5);
 909
 910         // Further, because nodes[0]'s target fee is larger than the `Normal` fee estimation plus our
 911         // force-closure-avoidance buffer, min should equal max, and the nodes[1]-selected fee should
 912         // be the nodes[0] only available fee.
 913         assert_eq!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis,
 914                    node_0_closing_signed.fee_range.as_ref().unwrap().max_fee_satoshis);
 915         assert_eq!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis,
 916                    node_0_closing_signed.fee_satoshis);
 917         assert_eq!(node_0_closing_signed.fee_satoshis, node_1_closing_signed.fee_satoshis);
 918
 919         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
 920         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 921         assert!(node_0_none.is_none());
 922         check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
 923         check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
 924 }