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