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