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