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