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