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