_ 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 crate::sign::{EntropySource, SignerProvider};
  13 use crate::chain::ChannelMonitorUpdateStatus;
  14 use crate::chain::transaction::OutPoint;
  15 use crate::events::{MessageSendEvent, HTLCDestination, MessageSendEventsProvider, ClosureReason};
  16 use crate::ln::channelmanager::{self, PaymentSendFailure, PaymentId, RecipientOnionFields, ChannelShutdownState, ChannelDetails};
  17 use crate::routing::router::{PaymentParameters, get_route, RouteParameters};
  18 use crate::ln::msgs;
  19 use crate::ln::msgs::{ChannelMessageHandler, ErrorAction};
  20 use crate::ln::script::ShutdownScript;
  21 use crate::util::test_utils;
  22 use crate::util::test_utils::OnGetShutdownScriptpubkey;
  23 use crate::util::errors::APIError;
  24 use crate::util::config::UserConfig;
  25 use crate::util::string::UntrustedString;
  26
  27 use bitcoin::blockdata::script::Builder;
  28 use bitcoin::blockdata::opcodes;
  29 use bitcoin::network::constants::Network;
  30 use bitcoin::util::address::WitnessVersion;
  31
  32 use regex;
  33
  34 use core::default::Default;
  35 use std::convert::TryFrom;
  36
  37 use crate::ln::functional_test_utils::*;
  38
  39 #[test]
  40 fn pre_funding_lock_shutdown_test() {
  41         // Test sending a shutdown prior to channel_ready after funding generation
  42         let chanmon_cfgs = create_chanmon_cfgs(2);
  43         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
  44         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
  45         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
  46         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0);
  47         mine_transaction(&nodes[0], &tx);
  48         mine_transaction(&nodes[1], &tx);
  49
  50         nodes[0].node.close_channel(&OutPoint { txid: tx.txid(), index: 0 }.to_channel_id(), &nodes[1].node.get_our_node_id()).unwrap();
  51         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
  52         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
  53         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
  54         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
  55
  56         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
  57         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
  58         let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
  59         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
  60         let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
  61         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
  62         let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
  63         assert!(node_1_none.is_none());
  64
  65         assert!(nodes[0].node.list_channels().is_empty());
  66         assert!(nodes[1].node.list_channels().is_empty());
  67         check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 8000000);
  68         check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 8000000);
  69 }
  70
  71 #[test]
  72 fn expect_channel_shutdown_state() {
  73         // Test sending a shutdown prior to channel_ready after funding generation
  74         let chanmon_cfgs = create_chanmon_cfgs(2);
  75         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
  76         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
  77         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
  78         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
  79
  80         expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::NotShuttingDown);
  81
  82         nodes[0].node.close_channel(&chan_1.2, &nodes[1].node.get_our_node_id()).unwrap();
  83
  84         expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::ShutdownInitiated);
  85         expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::NotShuttingDown);
  86
  87         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
  88         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
  89
  90         // node1 goes into NegotiatingClosingFee since there are no HTLCs in flight, note that it
  91         // doesnt mean that node1 has sent/recved its closing signed message
  92         expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::ShutdownInitiated);
  93         expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::NegotiatingClosingFee);
  94
  95         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
  96         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
  97
  98         expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::NegotiatingClosingFee);
  99         expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::NegotiatingClosingFee);
 100
 101         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 102         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 103         let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
 104         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
 105         let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 106         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
 107         let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 108         assert!(node_1_none.is_none());
 109
 110         assert!(nodes[0].node.list_channels().is_empty());
 111         assert!(nodes[1].node.list_channels().is_empty());
 112         check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
 113         check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
 114 }
 115
 116 #[test]
 117 fn expect_channel_shutdown_state_with_htlc() {
 118         // Test sending a shutdown with outstanding updates pending.
 119         let chanmon_cfgs = create_chanmon_cfgs(3);
 120         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 121         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 122         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 123         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
 124         let _chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
 125
 126         let (payment_preimage_0, payment_hash_0, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100_000);
 127
 128         expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::NotShuttingDown);
 129         expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::NotShuttingDown);
 130
 131         nodes[0].node.close_channel(&chan_1.2, &nodes[1].node.get_our_node_id()).unwrap();
 132
 133         expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::ShutdownInitiated);
 134         expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::NotShuttingDown);
 135
 136         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 137         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 138
 139         expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::ShutdownInitiated);
 140         expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::ResolvingHTLCs);
 141
 142         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 143         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 144
 145         expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::ResolvingHTLCs);
 146         expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::ResolvingHTLCs);
 147
 148         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 149         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 150
 151         // Claim Funds on Node2
 152         nodes[2].node.claim_funds(payment_preimage_0);
 153         check_added_monitors!(nodes[2], 1);
 154         expect_payment_claimed!(nodes[2], payment_hash_0, 100_000);
 155
 156         // Fulfil HTLCs on node1 and node0
 157         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
 158         assert!(updates.update_add_htlcs.is_empty());
 159         assert!(updates.update_fail_htlcs.is_empty());
 160         assert!(updates.update_fail_malformed_htlcs.is_empty());
 161         assert!(updates.update_fee.is_none());
 162         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
 163         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
 164         expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), false, false);
 165         check_added_monitors!(nodes[1], 1);
 166         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 167         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
 168
 169         // Still in "resolvingHTLCs" on chan1 after htlc removed on chan2
 170         expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::ResolvingHTLCs);
 171         expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::ResolvingHTLCs);
 172
 173         assert!(updates_2.update_add_htlcs.is_empty());
 174         assert!(updates_2.update_fail_htlcs.is_empty());
 175         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 176         assert!(updates_2.update_fee.is_none());
 177         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
 178         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
 179         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 180         expect_payment_sent!(nodes[0], payment_preimage_0);
 181
 182         // all htlcs removed, chan1 advances to NegotiatingClosingFee
 183         expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::NegotiatingClosingFee);
 184         expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::NegotiatingClosingFee);
 185
 186         // ClosingSignNegotion process
 187         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 188         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 189         let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
 190         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
 191         let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 192         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
 193         let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 194         assert!(node_1_none.is_none());
 195         check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
 196         check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
 197
 198         // Shutdown basically removes the channelDetails, testing of shutdowncomplete state unnecessary
 199         assert!(nodes[0].node.list_channels().is_empty());
 200 }
 201
 202 #[test]
 203 fn test_lnd_bug_6039() {
 204         // LND sends a nonsense error message any time it gets a shutdown if there are still HTLCs
 205         // pending. We currently swallow that error to work around LND's bug #6039. This test emulates
 206         // the LND nonsense and ensures we at least kinda handle it.
 207         let chanmon_cfgs = create_chanmon_cfgs(2);
 208         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 209         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 210         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 211         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
 212
 213         let (payment_preimage, ..) = route_payment(&nodes[0], &[&nodes[1]], 100_000);
 214
 215         nodes[0].node.close_channel(&chan.2, &nodes[1].node.get_our_node_id()).unwrap();
 216         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 217         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 218
 219         // Generate an lnd-like error message and check that we respond by simply screaming louder to
 220         // see if LND will accept our protocol compliance.
 221         let err_msg = msgs::ErrorMessage { channel_id: chan.2, data: "link failed to shutdown".to_string() };
 222         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &err_msg);
 223         let node_a_responses = nodes[0].node.get_and_clear_pending_msg_events();
 224         assert_eq!(node_a_responses[0], MessageSendEvent::SendShutdown {
 225                         node_id: nodes[1].node.get_our_node_id(),
 226                         msg: node_0_shutdown,
 227                 });
 228         if let MessageSendEvent::HandleError { action: msgs::ErrorAction::SendWarningMessage { .. }, .. }
 229                 = node_a_responses[1] {} else { panic!(); }
 230
 231         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 232
 233         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 234         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 235
 236         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
 237
 238         // Assume that LND will eventually respond to our Shutdown if we clear all the remaining HTLCs
 239         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 240
 241         // ClosingSignNegotion process
 242         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 243         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 244         let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
 245         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
 246         let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 247         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
 248         let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 249         assert!(node_1_none.is_none());
 250         check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
 251         check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
 252
 253         // Shutdown basically removes the channelDetails, testing of shutdowncomplete state unnecessary
 254         assert!(nodes[0].node.list_channels().is_empty());
 255 }
 256
 257 #[test]
 258 fn shutdown_on_unfunded_channel() {
 259         // Test receiving a shutdown prior to funding generation
 260         let chanmon_cfgs = create_chanmon_cfgs(2);
 261         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 262         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 263         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 264
 265         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1_000_000, 100_000, 0, None).unwrap();
 266         let open_chan = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
 267
 268         // Create a dummy P2WPKH script
 269         let script = Builder::new().push_int(0)
 270                 .push_slice(&[0; 20])
 271                 .into_script();
 272
 273         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &msgs::Shutdown {
 274                 channel_id: open_chan.temporary_channel_id, scriptpubkey: script,
 275         });
 276         check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyCoopClosedUnfundedChannel, [nodes[1].node.get_our_node_id()], 1_000_000);
 277 }
 278
 279 #[test]
 280 fn expect_channel_shutdown_state_with_force_closure() {
 281         // Test sending a shutdown prior to channel_ready after funding generation
 282         let chanmon_cfgs = create_chanmon_cfgs(2);
 283         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 284         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 285         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 286         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
 287
 288         expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::NotShuttingDown);
 289         expect_channel_shutdown_state!(nodes[1], chan_1.2, ChannelShutdownState::NotShuttingDown);
 290
 291         nodes[1].node.force_close_broadcasting_latest_txn(&chan_1.2, &nodes[0].node.get_our_node_id()).unwrap();
 292         check_closed_broadcast!(nodes[1], true);
 293         check_added_monitors!(nodes[1], 1);
 294
 295         expect_channel_shutdown_state!(nodes[0], chan_1.2, ChannelShutdownState::NotShuttingDown);
 296         assert!(nodes[1].node.list_channels().is_empty());
 297
 298         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
 299         assert_eq!(node_txn.len(), 1);
 300         check_spends!(node_txn[0], chan_1.3);
 301         mine_transaction(&nodes[0], &node_txn[0]);
 302         check_added_monitors!(nodes[0], 1);
 303
 304         assert!(nodes[0].node.list_channels().is_empty());
 305         assert!(nodes[1].node.list_channels().is_empty());
 306         check_closed_broadcast!(nodes[0], true);
 307         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed, [nodes[1].node.get_our_node_id()], 100000);
 308         check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed, [nodes[0].node.get_our_node_id()], 100000);
 309 }
 310
 311 #[test]
 312 fn updates_shutdown_wait() {
 313         // Test sending a shutdown with outstanding updates pending
 314         let chanmon_cfgs = create_chanmon_cfgs(3);
 315         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 316         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 317         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 318         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
 319         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
 320         let logger = test_utils::TestLogger::new();
 321         let scorer = test_utils::TestScorer::new();
 322         let keys_manager = test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
 323         let random_seed_bytes = keys_manager.get_secure_random_bytes();
 324
 325         let (payment_preimage_0, payment_hash_0, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100_000);
 326
 327         nodes[0].node.close_channel(&chan_1.2, &nodes[1].node.get_our_node_id()).unwrap();
 328         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 329         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 330         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 331         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 332
 333         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 334         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 335
 336         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
 337
 338         let payment_params_1 = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id(), TEST_FINAL_CLTV)
 339                 .with_bolt11_features(nodes[1].node.bolt11_invoice_features()).unwrap();
 340         let route_params = RouteParameters::from_payment_params_and_value(payment_params_1, 100_000);
 341         let route_1 = get_route(&nodes[0].node.get_our_node_id(), &route_params,
 342                 &nodes[0].network_graph.read_only(), None, &logger, &scorer, &Default::default(), &random_seed_bytes).unwrap();
 343         let payment_params_2 = PaymentParameters::from_node_id(nodes[0].node.get_our_node_id(), TEST_FINAL_CLTV)
 344                 .with_bolt11_features(nodes[0].node.bolt11_invoice_features()).unwrap();
 345         let route_params = RouteParameters::from_payment_params_and_value(payment_params_2, 100_000);
 346         let route_2 = get_route(&nodes[1].node.get_our_node_id(), &route_params,
 347                 &nodes[1].network_graph.read_only(), None, &logger, &scorer, &Default::default(), &random_seed_bytes).unwrap();
 348         unwrap_send_err!(nodes[0].node.send_payment_with_route(&route_1, payment_hash,
 349                         RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)
 350                 ), true, APIError::ChannelUnavailable {..}, {});
 351         unwrap_send_err!(nodes[1].node.send_payment_with_route(&route_2, payment_hash,
 352                         RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)
 353                 ), true, APIError::ChannelUnavailable {..}, {});
 354
 355         nodes[2].node.claim_funds(payment_preimage_0);
 356         check_added_monitors!(nodes[2], 1);
 357         expect_payment_claimed!(nodes[2], payment_hash_0, 100_000);
 358
 359         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
 360         assert!(updates.update_add_htlcs.is_empty());
 361         assert!(updates.update_fail_htlcs.is_empty());
 362         assert!(updates.update_fail_malformed_htlcs.is_empty());
 363         assert!(updates.update_fee.is_none());
 364         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
 365         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
 366         expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), false, false);
 367         check_added_monitors!(nodes[1], 1);
 368         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 369         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
 370
 371         assert!(updates_2.update_add_htlcs.is_empty());
 372         assert!(updates_2.update_fail_htlcs.is_empty());
 373         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 374         assert!(updates_2.update_fee.is_none());
 375         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
 376         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
 377         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 378         expect_payment_sent!(nodes[0], payment_preimage_0);
 379
 380         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 381         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 382         let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
 383         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
 384         let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 385         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
 386         let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 387         assert!(node_1_none.is_none());
 388         check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
 389         check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
 390
 391         assert!(nodes[0].node.list_channels().is_empty());
 392
 393         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 394         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 395         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
 396         assert!(nodes[1].node.list_channels().is_empty());
 397         assert!(nodes[2].node.list_channels().is_empty());
 398         check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[2].node.get_our_node_id()], 100000);
 399         check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
 400 }
 401
 402 #[test]
 403 fn htlc_fail_async_shutdown() {
 404         // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
 405         let chanmon_cfgs = create_chanmon_cfgs(3);
 406         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 407         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 408         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 409         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
 410         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
 411
 412         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], 100000);
 413         nodes[0].node.send_payment_with_route(&route, our_payment_hash,
 414                 RecipientOnionFields::secret_only(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
 415         check_added_monitors!(nodes[0], 1);
 416         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 417         assert_eq!(updates.update_add_htlcs.len(), 1);
 418         assert!(updates.update_fulfill_htlcs.is_empty());
 419         assert!(updates.update_fail_htlcs.is_empty());
 420         assert!(updates.update_fail_malformed_htlcs.is_empty());
 421         assert!(updates.update_fee.is_none());
 422
 423         nodes[1].node.close_channel(&chan_1.2, &nodes[0].node.get_our_node_id()).unwrap();
 424         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 425         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 426         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 427
 428         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
 429         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
 430         check_added_monitors!(nodes[1], 1);
 431         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 432         commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false, false);
 433
 434         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 435         assert!(updates_2.update_add_htlcs.is_empty());
 436         assert!(updates_2.update_fulfill_htlcs.is_empty());
 437         assert_eq!(updates_2.update_fail_htlcs.len(), 1);
 438         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 439         assert!(updates_2.update_fee.is_none());
 440
 441         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]);
 442         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 443
 444         expect_payment_failed_with_update!(nodes[0], our_payment_hash, false, chan_2.0.contents.short_channel_id, true);
 445
 446         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
 447         assert_eq!(msg_events.len(), 1);
 448         let node_0_closing_signed = match msg_events[0] {
 449                 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
 450                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
 451                         (*msg).clone()
 452                 },
 453                 _ => panic!("Unexpected event"),
 454         };
 455
 456         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 457         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 458         let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
 459         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
 460         let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 461         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
 462         let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 463         assert!(node_1_none.is_none());
 464
 465         assert!(nodes[0].node.list_channels().is_empty());
 466
 467         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 468         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 469         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
 470         assert!(nodes[1].node.list_channels().is_empty());
 471         assert!(nodes[2].node.list_channels().is_empty());
 472         check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
 473         check_closed_event!(nodes[1], 2, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id(), nodes[2].node.get_our_node_id()], 100000);
 474         check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
 475 }
 476
 477 fn do_test_shutdown_rebroadcast(recv_count: u8) {
 478         // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
 479         // messages delivered prior to disconnect
 480         let chanmon_cfgs = create_chanmon_cfgs(3);
 481         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 482         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 483         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 484         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
 485         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
 486
 487         let (payment_preimage, payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100_000);
 488
 489         nodes[1].node.close_channel(&chan_1.2, &nodes[0].node.get_our_node_id()).unwrap();
 490         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 491         if recv_count > 0 {
 492                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 493                 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 494                 if recv_count > 1 {
 495                         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 496                 }
 497         }
 498
 499         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
 500         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
 501
 502         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
 503                 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
 504         }, true).unwrap();
 505         let node_0_reestablish = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
 506         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
 507                 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
 508         }, false).unwrap();
 509         let node_1_reestablish = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
 510
 511         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish);
 512         let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 513         assert!(node_1_shutdown == node_1_2nd_shutdown);
 514
 515         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish);
 516         let node_0_2nd_shutdown = if recv_count > 0 {
 517                 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 518                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
 519                 node_0_2nd_shutdown
 520         } else {
 521                 let node_0_chan_update = get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
 522                 assert_eq!(node_0_chan_update.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
 523                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
 524                 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
 525         };
 526         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_2nd_shutdown);
 527
 528         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 529         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 530
 531         nodes[2].node.claim_funds(payment_preimage);
 532         check_added_monitors!(nodes[2], 1);
 533         expect_payment_claimed!(nodes[2], payment_hash, 100_000);
 534
 535         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
 536         assert!(updates.update_add_htlcs.is_empty());
 537         assert!(updates.update_fail_htlcs.is_empty());
 538         assert!(updates.update_fail_malformed_htlcs.is_empty());
 539         assert!(updates.update_fee.is_none());
 540         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
 541         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
 542         expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), false, false);
 543         check_added_monitors!(nodes[1], 1);
 544         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 545         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
 546
 547         assert!(updates_2.update_add_htlcs.is_empty());
 548         assert!(updates_2.update_fail_htlcs.is_empty());
 549         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 550         assert!(updates_2.update_fee.is_none());
 551         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
 552         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
 553         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 554         expect_payment_sent!(nodes[0], payment_preimage);
 555
 556         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 557         if recv_count > 0 {
 558                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 559                 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
 560                 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
 561                 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 562                 assert!(node_0_2nd_closing_signed.is_some());
 563         }
 564
 565         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
 566         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
 567
 568         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
 569                 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
 570         }, true).unwrap();
 571         let node_1_2nd_reestablish = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
 572         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
 573                 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
 574         }, false).unwrap();
 575         if recv_count == 0 {
 576                 // If all closing_signeds weren't delivered we can just resume where we left off...
 577                 let node_0_2nd_reestablish = get_chan_reestablish_msgs!(nodes[0], nodes[1]).pop().unwrap();
 578
 579                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
 580                 let node_0_msgs = nodes[0].node.get_and_clear_pending_msg_events();
 581                 assert_eq!(node_0_msgs.len(), 2);
 582                 let node_0_2nd_closing_signed = match node_0_msgs[1] {
 583                         MessageSendEvent::SendClosingSigned { ref msg, .. } => {
 584                                 assert_eq!(node_0_closing_signed, *msg);
 585                                 msg.clone()
 586                         },
 587                         _ => panic!(),
 588                 };
 589
 590                 let node_0_3rd_shutdown = match node_0_msgs[0] {
 591                         MessageSendEvent::SendShutdown { ref msg, .. } => {
 592                                 assert_eq!(node_0_2nd_shutdown, *msg);
 593                                 msg.clone()
 594                         },
 595                         _ => panic!(),
 596                 };
 597                 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
 598
 599                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
 600                 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 601                 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
 602
 603                 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_3rd_shutdown);
 604                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 605
 606                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_3rd_shutdown);
 607
 608                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed);
 609                 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
 610                 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
 611                 let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 612                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
 613                 let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 614                 assert!(node_1_none.is_none());
 615                 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
 616         } else {
 617                 // If one node, however, received + responded with an identical closing_signed we end
 618                 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
 619                 // There isn't really anything better we can do simply, but in the future we might
 620                 // explore storing a set of recently-closed channels that got disconnected during
 621                 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
 622                 // give our counterparty enough time to (potentially) broadcast a cooperative closing
 623                 // transaction.
 624                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 625
 626                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
 627                 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
 628                 assert_eq!(msg_events.len(), 2);
 629                 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[1] {
 630                         match action {
 631                                 &ErrorAction::SendErrorMessage { ref msg } => {
 632                                         nodes[1].node.handle_error(&nodes[0].node.get_our_node_id(), &msg);
 633                                         assert_eq!(msg.channel_id, chan_1.2);
 634                                 },
 635                                 _ => panic!("Unexpected event!"),
 636                         }
 637                 } else { panic!("Needed SendErrorMessage close"); }
 638
 639                 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
 640                 // checks it, but in this case nodes[1] didn't ever get a chance to receive a
 641                 // closing_signed so we do it ourselves
 642                 check_closed_broadcast!(nodes[1], false);
 643                 check_added_monitors!(nodes[1], 1);
 644                 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyForceClosed { peer_msg: UntrustedString(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}", &nodes[1].node.get_our_node_id())) }
 645                         , [nodes[0].node.get_our_node_id()], 100000);
 646         }
 647
 648         assert!(nodes[0].node.list_channels().is_empty());
 649
 650         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 651         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 652         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
 653         assert!(nodes[1].node.list_channels().is_empty());
 654         assert!(nodes[2].node.list_channels().is_empty());
 655         check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
 656         check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[2].node.get_our_node_id()], 100000);
 657         check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
 658 }
 659
 660 #[test]
 661 fn test_shutdown_rebroadcast() {
 662         do_test_shutdown_rebroadcast(0);
 663         do_test_shutdown_rebroadcast(1);
 664         do_test_shutdown_rebroadcast(2);
 665 }
 666
 667 #[test]
 668 fn test_upfront_shutdown_script() {
 669         // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
 670         // enforce it at shutdown message
 671
 672         let mut config = UserConfig::default();
 673         config.channel_handshake_config.announced_channel = true;
 674         config.channel_handshake_limits.force_announced_channel_preference = false;
 675         config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
 676         let user_cfgs = [None, Some(config), None];
 677         let chanmon_cfgs = create_chanmon_cfgs(3);
 678         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 679         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
 680         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 681
 682         // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
 683         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000);
 684         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[2].node.get_our_node_id()).unwrap();
 685         let node_0_orig_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
 686         let mut node_0_shutdown = node_0_orig_shutdown.clone();
 687         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
 688         // Test we enforce upfront_scriptpbukey if by providing a different one at closing that we warn
 689         // the peer and ignore the message.
 690         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 691         assert!(regex::Regex::new(r"Got shutdown request with a scriptpubkey \([A-Fa-f0-9]+\) which did not match their previous scriptpubkey.")
 692                         .unwrap().is_match(&check_warn_msg!(nodes[2], nodes[0].node.get_our_node_id(), chan.2)));
 693         // This allows nodes[2] to retry the shutdown message, which should get a response:
 694         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_orig_shutdown);
 695         get_event_msg!(nodes[2], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 696
 697         // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
 698         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000);
 699         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[2].node.get_our_node_id()).unwrap();
 700         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
 701         // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
 702         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 703         let events = nodes[2].node.get_and_clear_pending_msg_events();
 704         assert_eq!(events.len(), 1);
 705         match events[0] {
 706                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
 707                 _ => panic!("Unexpected event"),
 708         }
 709
 710         // We test that if case of peer non-signaling we don't enforce committed script at channel opening
 711         *nodes[0].override_init_features.borrow_mut() = Some(nodes[0].node.init_features().clear_upfront_shutdown_script());
 712         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000);
 713         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[1].node.get_our_node_id()).unwrap();
 714         let node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 715         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_1_shutdown);
 716         check_added_monitors!(nodes[1], 1);
 717         let events = nodes[1].node.get_and_clear_pending_msg_events();
 718         assert_eq!(events.len(), 1);
 719         match events[0] {
 720                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
 721                 _ => panic!("Unexpected event"),
 722         }
 723
 724         // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
 725         // channel smoothly, opt-out is from channel initiator here
 726         *nodes[0].override_init_features.borrow_mut() = None;
 727         let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000);
 728         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[0].node.get_our_node_id()).unwrap();
 729         check_added_monitors!(nodes[1], 1);
 730         let node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 731         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
 732         let events = nodes[0].node.get_and_clear_pending_msg_events();
 733         assert_eq!(events.len(), 1);
 734         match events[0] {
 735                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
 736                 _ => panic!("Unexpected event"),
 737         }
 738
 739         //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
 740         //// channel smoothly
 741         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000);
 742         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[0].node.get_our_node_id()).unwrap();
 743         check_added_monitors!(nodes[1], 1);
 744         let node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 745         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
 746         let events = nodes[0].node.get_and_clear_pending_msg_events();
 747         assert_eq!(events.len(), 2);
 748         match events[0] {
 749                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
 750                 _ => panic!("Unexpected event"),
 751         }
 752         match events[1] {
 753                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
 754                 _ => panic!("Unexpected event"),
 755         }
 756 }
 757
 758 #[test]
 759 fn test_unsupported_anysegwit_upfront_shutdown_script() {
 760         let chanmon_cfgs = create_chanmon_cfgs(2);
 761         let mut node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 762         // Clear shutdown_anysegwit on initiator
 763         *node_cfgs[0].override_init_features.borrow_mut() = Some(channelmanager::provided_init_features(&test_default_channel_config()).clear_shutdown_anysegwit());
 764         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 765         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 766
 767         // Use a non-v0 segwit script supported by option_shutdown_anysegwit
 768         let anysegwit_shutdown_script = Builder::new()
 769                 .push_int(16)
 770                 .push_slice(&[0, 40])
 771                 .into_script();
 772
 773         // Check script when handling an open_channel message
 774         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
 775         let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
 776         open_channel.shutdown_scriptpubkey = Some(anysegwit_shutdown_script.clone());
 777         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel);
 778
 779         let events = nodes[1].node.get_and_clear_pending_msg_events();
 780         assert_eq!(events.len(), 1);
 781         match events[0] {
 782                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
 783                         assert_eq!(node_id, nodes[0].node.get_our_node_id());
 784                         assert_eq!(msg.data, "Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: Script(OP_PUSHNUM_16 OP_PUSHBYTES_2 0028)");
 785                 },
 786                 _ => panic!("Unexpected event"),
 787         }
 788
 789         let chanmon_cfgs = create_chanmon_cfgs(2);
 790         let mut node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 791         // Clear shutdown_anysegwit on responder
 792         *node_cfgs[1].override_init_features.borrow_mut() = Some(channelmanager::provided_init_features(&test_default_channel_config()).clear_shutdown_anysegwit());
 793         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 794         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 795
 796         // Check script when handling an accept_channel message
 797         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
 798         let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
 799         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel);
 800         let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
 801         accept_channel.shutdown_scriptpubkey = Some(anysegwit_shutdown_script.clone());
 802         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel);
 803
 804         let events = nodes[0].node.get_and_clear_pending_msg_events();
 805         assert_eq!(events.len(), 1);
 806         match events[0] {
 807                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
 808                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
 809                         assert_eq!(msg.data, "Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: Script(OP_PUSHNUM_16 OP_PUSHBYTES_2 0028)");
 810                 },
 811                 _ => panic!("Unexpected event"),
 812         }
 813         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() }
 814                 , [nodes[1].node.get_our_node_id()], 100000);
 815 }
 816
 817 #[test]
 818 fn test_invalid_upfront_shutdown_script() {
 819         let chanmon_cfgs = create_chanmon_cfgs(2);
 820         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 821         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 822         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 823
 824         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
 825
 826         // Use a segwit v0 script with an unsupported witness program
 827         let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
 828         open_channel.shutdown_scriptpubkey = Some(Builder::new().push_int(0)
 829                 .push_slice(&[0, 0])
 830                 .into_script());
 831         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel);
 832
 833         let events = nodes[1].node.get_and_clear_pending_msg_events();
 834         assert_eq!(events.len(), 1);
 835         match events[0] {
 836                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
 837                         assert_eq!(node_id, nodes[0].node.get_our_node_id());
 838                         assert_eq!(msg.data, "Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: Script(OP_0 OP_PUSHBYTES_2 0000)");
 839                 },
 840                 _ => panic!("Unexpected event"),
 841         }
 842 }
 843
 844 #[test]
 845 fn test_segwit_v0_shutdown_script() {
 846         let mut config = UserConfig::default();
 847         config.channel_handshake_config.announced_channel = true;
 848         config.channel_handshake_limits.force_announced_channel_preference = false;
 849         config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
 850         let user_cfgs = [None, Some(config), None];
 851         let chanmon_cfgs = create_chanmon_cfgs(3);
 852         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 853         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
 854         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 855
 856         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
 857         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[0].node.get_our_node_id()).unwrap();
 858         check_added_monitors!(nodes[1], 1);
 859
 860         // Use a segwit v0 script supported even without option_shutdown_anysegwit
 861         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 862         node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
 863                 .push_slice(&[0; 20])
 864                 .into_script();
 865         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
 866
 867         let events = nodes[0].node.get_and_clear_pending_msg_events();
 868         assert_eq!(events.len(), 2);
 869         match events[0] {
 870                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
 871                 _ => panic!("Unexpected event"),
 872         }
 873         match events[1] {
 874                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
 875                 _ => panic!("Unexpected event"),
 876         }
 877 }
 878
 879 #[test]
 880 fn test_anysegwit_shutdown_script() {
 881         let mut config = UserConfig::default();
 882         config.channel_handshake_config.announced_channel = true;
 883         config.channel_handshake_limits.force_announced_channel_preference = false;
 884         config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
 885         let user_cfgs = [None, Some(config), None];
 886         let chanmon_cfgs = create_chanmon_cfgs(3);
 887         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 888         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
 889         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 890
 891         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
 892         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[0].node.get_our_node_id()).unwrap();
 893         check_added_monitors!(nodes[1], 1);
 894
 895         // Use a non-v0 segwit script supported by option_shutdown_anysegwit
 896         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 897         node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
 898                 .push_slice(&[0, 0])
 899                 .into_script();
 900         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
 901
 902         let events = nodes[0].node.get_and_clear_pending_msg_events();
 903         assert_eq!(events.len(), 2);
 904         match events[0] {
 905                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
 906                 _ => panic!("Unexpected event"),
 907         }
 908         match events[1] {
 909                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
 910                 _ => panic!("Unexpected event"),
 911         }
 912 }
 913
 914 #[test]
 915 fn test_unsupported_anysegwit_shutdown_script() {
 916         let mut config = UserConfig::default();
 917         config.channel_handshake_config.announced_channel = true;
 918         config.channel_handshake_limits.force_announced_channel_preference = false;
 919         config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
 920         let user_cfgs = [None, Some(config), None];
 921         let chanmon_cfgs = create_chanmon_cfgs(3);
 922         let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 923         *node_cfgs[0].override_init_features.borrow_mut() = Some(channelmanager::provided_init_features(&config).clear_shutdown_anysegwit());
 924         *node_cfgs[1].override_init_features.borrow_mut() = Some(channelmanager::provided_init_features(&config).clear_shutdown_anysegwit());
 925         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
 926         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 927
 928         // Check that using an unsupported shutdown script fails and a supported one succeeds.
 929         let supported_shutdown_script = chanmon_cfgs[1].keys_manager.get_shutdown_scriptpubkey().unwrap();
 930         let unsupported_shutdown_script =
 931                 ShutdownScript::new_witness_program(WitnessVersion::V16, &[0, 40]).unwrap();
 932         chanmon_cfgs[1].keys_manager
 933                 .expect(OnGetShutdownScriptpubkey { returns: unsupported_shutdown_script.clone() })
 934                 .expect(OnGetShutdownScriptpubkey { returns: supported_shutdown_script });
 935
 936         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
 937         match nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[0].node.get_our_node_id()) {
 938                 Err(APIError::IncompatibleShutdownScript { script }) => {
 939                         assert_eq!(script.into_inner(), unsupported_shutdown_script.clone().into_inner());
 940                 },
 941                 Err(e) => panic!("Unexpected error: {:?}", e),
 942                 Ok(_) => panic!("Expected error"),
 943         }
 944         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[0].node.get_our_node_id()).unwrap();
 945         check_added_monitors!(nodes[1], 1);
 946
 947         // Use a non-v0 segwit script unsupported without option_shutdown_anysegwit
 948         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 949         node_0_shutdown.scriptpubkey = unsupported_shutdown_script.into_inner();
 950         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
 951
 952         assert_eq!(&check_warn_msg!(nodes[0], nodes[1].node.get_our_node_id(), chan.2),
 953                         "Got a nonstandard scriptpubkey (60020028) from remote peer");
 954 }
 955
 956 #[test]
 957 fn test_invalid_shutdown_script() {
 958         let mut config = UserConfig::default();
 959         config.channel_handshake_config.announced_channel = true;
 960         config.channel_handshake_limits.force_announced_channel_preference = false;
 961         config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
 962         let user_cfgs = [None, Some(config), None];
 963         let chanmon_cfgs = create_chanmon_cfgs(3);
 964         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 965         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
 966         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 967
 968         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
 969         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[0].node.get_our_node_id()).unwrap();
 970         check_added_monitors!(nodes[1], 1);
 971
 972         // Use a segwit v0 script with an unsupported witness program
 973         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 974         node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
 975                 .push_slice(&[0, 0])
 976                 .into_script();
 977         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
 978
 979         assert_eq!(&check_warn_msg!(nodes[0], nodes[1].node.get_our_node_id(), chan.2),
 980                         "Got a nonstandard scriptpubkey (00020000) from remote peer");
 981 }
 982
 983 #[test]
 984 fn test_user_shutdown_script() {
 985         let mut config = test_default_channel_config();
 986         config.channel_handshake_config.announced_channel = true;
 987         config.channel_handshake_limits.force_announced_channel_preference = false;
 988         config.channel_handshake_config.commit_upfront_shutdown_pubkey = false;
 989         let user_cfgs = [None, Some(config), None];
 990         let chanmon_cfgs = create_chanmon_cfgs(3);
 991         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 992         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
 993         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 994
 995         // Segwit v0 script of the form OP_0 <20-byte hash>
 996         let script = Builder::new().push_int(0)
 997                 .push_slice(&[0; 20])
 998                 .into_script();
 999
1000         let shutdown_script = ShutdownScript::try_from(script.clone()).unwrap();
1001
1002         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
1003         nodes[1].node.close_channel_with_feerate_and_script(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[0].node.get_our_node_id(), None, Some(shutdown_script)).unwrap();
1004         check_added_monitors!(nodes[1], 1);
1005
1006         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1007
1008         assert_eq!(node_0_shutdown.scriptpubkey, script);
1009 }
1010
1011 #[test]
1012 fn test_already_set_user_shutdown_script() {
1013         let mut config = test_default_channel_config();
1014         config.channel_handshake_config.announced_channel = true;
1015         config.channel_handshake_limits.force_announced_channel_preference = false;
1016         let user_cfgs = [None, Some(config), None];
1017         let chanmon_cfgs = create_chanmon_cfgs(3);
1018         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1019         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
1020         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1021
1022         // Segwit v0 script of the form OP_0 <20-byte hash>
1023         let script = Builder::new().push_int(0)
1024                 .push_slice(&[0; 20])
1025                 .into_script();
1026
1027         let shutdown_script = ShutdownScript::try_from(script).unwrap();
1028
1029         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
1030         let result = nodes[1].node.close_channel_with_feerate_and_script(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[0].node.get_our_node_id(), None, Some(shutdown_script));
1031
1032         assert_eq!(result, Err(APIError::APIMisuseError { err: "Cannot override shutdown script for a channel with one already set".to_string() }));
1033 }
1034
1035 #[derive(PartialEq)]
1036 enum TimeoutStep {
1037         AfterShutdown,
1038         AfterClosingSigned,
1039         NoTimeout,
1040 }
1041
1042 fn do_test_closing_signed_reinit_timeout(timeout_step: TimeoutStep) {
1043         // The range-based closing signed negotiation allows the funder to restart the process with a
1044         // new range if the previous range did not overlap. This allows implementations to request user
1045         // intervention allowing users to enter a new fee range. We do not implement the sending side
1046         // of this, instead opting to allow users to enter an explicit "willing to pay up to X to avoid
1047         // force-closing" value and relying on that instead.
1048         //
1049         // Here we run test the fundee side of that restart mechanism, implementing the funder side of
1050         // it manually.
1051         let chanmon_cfgs = create_chanmon_cfgs(2);
1052         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1053         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1054         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1055         let chan_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
1056
1057         send_payment(&nodes[0], &[&nodes[1]], 8_000_000);
1058
1059         nodes[0].node.close_channel(&chan_id, &nodes[1].node.get_our_node_id()).unwrap();
1060         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1061         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
1062         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1063         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
1064
1065         {
1066                 // Now we set nodes[1] to require a relatively high feerate for closing. This should result
1067                 // in it rejecting nodes[0]'s initial closing_signed, giving nodes[0] a chance to try
1068                 // again.
1069                 let mut feerate_lock = chanmon_cfgs[1].fee_estimator.sat_per_kw.lock().unwrap();
1070                 *feerate_lock *= 10;
1071         }
1072
1073         let mut node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1074         // nodes[0] should use a "reasonable" feerate, well under the 10 sat/vByte that nodes[1] thinks
1075         // is the current prevailing feerate.
1076         assert!(node_0_closing_signed.fee_satoshis <= 500);
1077
1078         if timeout_step != TimeoutStep::AfterShutdown {
1079                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1080                 assert!(check_warn_msg!(nodes[1], nodes[0].node.get_our_node_id(), chan_id)
1081                         .starts_with("Unable to come to consensus about closing feerate"));
1082
1083                 // Now deliver a mutated closing_signed indicating a higher acceptable fee range, which
1084                 // nodes[1] should happily accept and respond to.
1085                 node_0_closing_signed.fee_range.as_mut().unwrap().max_fee_satoshis *= 10;
1086                 {
1087                         let mut node_0_per_peer_lock;
1088                         let mut node_0_peer_state_lock;
1089                         get_channel_ref!(nodes[0], nodes[1], node_0_per_peer_lock, node_0_peer_state_lock, chan_id).context_mut().closing_fee_limits.as_mut().unwrap().1 *= 10;
1090                 }
1091                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1092                 let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
1093                 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
1094                 let node_0_2nd_closing_signed = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1095                 if timeout_step == TimeoutStep::NoTimeout {
1096                         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.1.unwrap());
1097                         check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
1098                 }
1099                 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
1100         }
1101
1102         if timeout_step != TimeoutStep::NoTimeout {
1103                 assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
1104         } else {
1105                 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1106         }
1107
1108         nodes[1].node.timer_tick_occurred();
1109         nodes[1].node.timer_tick_occurred();
1110
1111         let txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1112         assert_eq!(txn.len(), 1);
1113         assert_eq!(txn[0].output.len(), 2);
1114
1115         if timeout_step != TimeoutStep::NoTimeout {
1116                 assert!((txn[0].output[0].script_pubkey.is_v0_p2wpkh() &&
1117                          txn[0].output[1].script_pubkey.is_v0_p2wsh()) ||
1118                         (txn[0].output[1].script_pubkey.is_v0_p2wpkh() &&
1119                          txn[0].output[0].script_pubkey.is_v0_p2wsh()));
1120                 check_closed_broadcast!(nodes[1], true);
1121                 check_added_monitors!(nodes[1], 1);
1122                 check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "closing_signed negotiation failed to finish within two timer ticks".to_string() }
1123                         , [nodes[0].node.get_our_node_id()], 100000);
1124         } else {
1125                 assert!(txn[0].output[0].script_pubkey.is_v0_p2wpkh());
1126                 assert!(txn[0].output[1].script_pubkey.is_v0_p2wpkh());
1127
1128                 let events = nodes[1].node.get_and_clear_pending_msg_events();
1129                 assert_eq!(events.len(), 1);
1130                 match events[0] {
1131                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1132                                 assert_eq!(msg.contents.flags & 2, 2);
1133                         },
1134                         _ => panic!("Unexpected event"),
1135                 }
1136         }
1137 }
1138
1139 #[test]
1140 fn test_closing_signed_reinit_timeout() {
1141         do_test_closing_signed_reinit_timeout(TimeoutStep::AfterShutdown);
1142         do_test_closing_signed_reinit_timeout(TimeoutStep::AfterClosingSigned);
1143         do_test_closing_signed_reinit_timeout(TimeoutStep::NoTimeout);
1144 }
1145
1146 fn do_simple_legacy_shutdown_test(high_initiator_fee: bool) {
1147         // A simpe test of the legacy shutdown fee negotiation logic.
1148         let chanmon_cfgs = create_chanmon_cfgs(2);
1149         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1150         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1151         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1152
1153         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
1154
1155         if high_initiator_fee {
1156                 // If high_initiator_fee is set, set nodes[0]'s feerate significantly higher. This
1157                 // shouldn't impact the flow at all given nodes[1] will happily accept the higher fee.
1158                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
1159                 *feerate_lock *= 10;
1160         }
1161
1162         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id(), &nodes[1].node.get_our_node_id()).unwrap();
1163         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1164         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
1165         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1166         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
1167
1168         let mut node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1169         node_0_closing_signed.fee_range = None;
1170         if high_initiator_fee {
1171                 assert!(node_0_closing_signed.fee_satoshis > 500);
1172         } else {
1173                 assert!(node_0_closing_signed.fee_satoshis < 500);
1174         }
1175
1176         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1177         let (_, mut node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1178         node_1_closing_signed.as_mut().unwrap().fee_range = None;
1179
1180         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
1181         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1182         assert!(node_0_none.is_none());
1183         check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
1184         check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
1185 }
1186
1187 #[test]
1188 fn simple_legacy_shutdown_test() {
1189         do_simple_legacy_shutdown_test(false);
1190         do_simple_legacy_shutdown_test(true);
1191 }
1192
1193 #[test]
1194 fn simple_target_feerate_shutdown() {
1195         // Simple test of target in `close_channel_with_target_feerate`.
1196         let chanmon_cfgs = create_chanmon_cfgs(2);
1197         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1198         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1199         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1200
1201         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
1202         let chan_id = OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id();
1203
1204         nodes[0].node.close_channel_with_feerate_and_script(&chan_id, &nodes[1].node.get_our_node_id(), Some(253 * 10), None).unwrap();
1205         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1206         nodes[1].node.close_channel_with_feerate_and_script(&chan_id, &nodes[0].node.get_our_node_id(), Some(253 * 5), None).unwrap();
1207         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1208
1209         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
1210         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
1211
1212         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1213         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1214         let (_, node_1_closing_signed_opt) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1215         let node_1_closing_signed = node_1_closing_signed_opt.unwrap();
1216
1217         // nodes[1] was passed a target which was larger than the current channel feerate, which it
1218         // should ignore in favor of the channel fee, as there is no use demanding a minimum higher
1219         // than what will be paid on a force-close transaction. Note that we have to consider rounding,
1220         // so only check that we're within 10 sats.
1221         assert!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis >=
1222                 node_1_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis * 10 - 5);
1223         assert!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis <=
1224                 node_1_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis * 10 + 5);
1225
1226         // Further, because nodes[0]'s target fee is larger than the `Normal` fee estimation plus our
1227         // force-closure-avoidance buffer, min should equal max, and the nodes[1]-selected fee should
1228         // be the nodes[0] only available fee.
1229         assert_eq!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis,
1230                    node_0_closing_signed.fee_range.as_ref().unwrap().max_fee_satoshis);
1231         assert_eq!(node_0_closing_signed.fee_range.as_ref().unwrap().min_fee_satoshis,
1232                    node_0_closing_signed.fee_satoshis);
1233         assert_eq!(node_0_closing_signed.fee_satoshis, node_1_closing_signed.fee_satoshis);
1234
1235         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
1236         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1237         assert!(node_0_none.is_none());
1238         check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
1239         check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
1240 }
1241
1242 fn do_outbound_update_no_early_closing_signed(use_htlc: bool) {
1243         // Previously, if we have a pending inbound HTLC (or fee update) on a channel which has
1244         // initiated shutdown, we'd send our initial closing_signed immediately after receiving the
1245         // peer's last RAA to remove the HTLC/fee update, but before receiving their final
1246         // commitment_signed for a commitment without the HTLC/with the new fee. This caused at least
1247         // LDK peers to force-close as we initiated closing_signed prior to the channel actually being
1248         // fully empty of pending updates/HTLCs.
1249         let chanmon_cfgs = create_chanmon_cfgs(2);
1250         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1251         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1252         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1253
1254         let chan_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
1255
1256         send_payment(&nodes[0], &[&nodes[1]], 1_000_000);
1257         let payment_hash_opt = if use_htlc {
1258                 Some(route_payment(&nodes[1], &[&nodes[0]], 10_000).1)
1259         } else {
1260                 None
1261         };
1262
1263         if use_htlc {
1264                 nodes[0].node.fail_htlc_backwards(&payment_hash_opt.unwrap());
1265                 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[0],
1266                         [HTLCDestination::FailedPayment { payment_hash: payment_hash_opt.unwrap() }]);
1267         } else {
1268                 *chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap() *= 10;
1269                 nodes[0].node.timer_tick_occurred();
1270         }
1271         let updates = get_htlc_update_msgs(&nodes[0], &nodes[1].node.get_our_node_id());
1272         check_added_monitors(&nodes[0], 1);
1273
1274         nodes[1].node.close_channel(&chan_id, &nodes[0].node.get_our_node_id()).unwrap();
1275         let node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1276         nodes[0].node.close_channel(&chan_id, &nodes[1].node.get_our_node_id()).unwrap();
1277         let node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1278
1279         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
1280         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_1_shutdown);
1281
1282         if use_htlc {
1283                 nodes[1].node.handle_update_fail_htlc(&nodes[0].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
1284         } else {
1285                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &updates.update_fee.unwrap());
1286         }
1287         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
1288         check_added_monitors(&nodes[1], 1);
1289         let (bs_raa, bs_cs) = get_revoke_commit_msgs(&nodes[1], &nodes[0].node.get_our_node_id());
1290
1291         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1292         check_added_monitors(&nodes[0], 1);
1293
1294         // At this point the Channel on nodes[0] has no record of any HTLCs but the latest
1295         // broadcastable commitment does contain the HTLC (but only the ChannelMonitor knows this).
1296         // Thus, the channel should not yet initiate closing_signed negotiation (but previously did).
1297         assert_eq!(nodes[0].node.get_and_clear_pending_msg_events(), Vec::new());
1298
1299         chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1300         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs);
1301         check_added_monitors(&nodes[0], 1);
1302         assert_eq!(nodes[0].node.get_and_clear_pending_msg_events(), Vec::new());
1303
1304         expect_channel_shutdown_state!(nodes[0], chan_id, ChannelShutdownState::ResolvingHTLCs);
1305         assert_eq!(nodes[0].node.get_and_clear_pending_msg_events(), Vec::new());
1306         let (outpoint, latest_update, _) = nodes[0].chain_monitor.latest_monitor_update_id.lock().unwrap().get(&chan_id).unwrap().clone();
1307         nodes[0].chain_monitor.chain_monitor.force_channel_monitor_updated(outpoint, latest_update);
1308
1309         let as_raa_closing_signed = nodes[0].node.get_and_clear_pending_msg_events();
1310         assert_eq!(as_raa_closing_signed.len(), 2);
1311
1312         if let MessageSendEvent::SendRevokeAndACK { msg, .. } = &as_raa_closing_signed[0] {
1313                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &msg);
1314                 check_added_monitors(&nodes[1], 1);
1315                 if use_htlc {
1316                         expect_payment_failed!(nodes[1], payment_hash_opt.unwrap(), true);
1317                 }
1318         } else { panic!("Unexpected message {:?}", as_raa_closing_signed[0]); }
1319
1320         if let MessageSendEvent::SendClosingSigned { msg, .. } = &as_raa_closing_signed[1] {
1321                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &msg);
1322         } else { panic!("Unexpected message {:?}", as_raa_closing_signed[1]); }
1323
1324         let bs_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
1325         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &bs_closing_signed);
1326         let (_, as_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1327         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &as_2nd_closing_signed.unwrap());
1328         let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1329         assert!(node_1_none.is_none());
1330
1331         check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 100000);
1332         check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 100000);
1333 }
1334
1335 #[test]
1336 fn outbound_update_no_early_closing_signed() {
1337         do_outbound_update_no_early_closing_signed(true);
1338         do_outbound_update_no_early_closing_signed(false);
1339 }