_ Git - rust-lightning/blob - lightning/src/ln/shutdown_tests.rs

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