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