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