_ Git - rust-lightning/blob - lightning/src/ln/reorg_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 //! Further functional tests which test blockchain reorganizations.
  11
  12 use chain::channelmonitor::{ANTI_REORG_DELAY, ChannelMonitor};
  13 use chain::transaction::OutPoint;
  14 use chain::{Confirm, Watch};
  15 use ln::channelmanager::{ChannelManager, ChannelManagerReadArgs};
  16 use ln::features::InitFeatures;
  17 use ln::msgs::ChannelMessageHandler;
  18 use util::enforcing_trait_impls::EnforcingSigner;
  19 use util::events::{Event, MessageSendEvent, MessageSendEventsProvider, ClosureReason, HTLCDestination};
  20 use util::test_utils;
  21 use util::ser::{ReadableArgs, Writeable};
  22
  23 use bitcoin::blockdata::block::{Block, BlockHeader};
  24 use bitcoin::blockdata::script::Builder;
  25 use bitcoin::blockdata::opcodes;
  26 use bitcoin::hash_types::BlockHash;
  27 use bitcoin::secp256k1::Secp256k1;
  28
  29 use prelude::*;
  30 use core::mem;
  31 use bitcoin::hashes::Hash;
  32 use bitcoin::TxMerkleNode;
  33
  34 use ln::functional_test_utils::*;
  35
  36 fn do_test_onchain_htlc_reorg(local_commitment: bool, claim: bool) {
  37         // Our on-chain HTLC-claim learning has a few properties worth testing:
  38         //  * If an upstream HTLC is claimed with a preimage (both against our own commitment
  39         //    transaction our counterparty's), we claim it backwards immediately.
  40         //  * If an upstream HTLC is claimed with a timeout, we delay ANTI_REORG_DELAY before failing
  41         //    it backwards to ensure our counterparty can't claim with a preimage in a reorg.
  42         //
  43         // Here we test both properties in any combination based on the two bools passed in as
  44         // arguments.
  45         //
  46         // If local_commitment is set, we first broadcast a local commitment containing an offered HTLC
  47         // and an HTLC-Timeout tx, otherwise we broadcast a remote commitment containing a received
  48         // HTLC and a local HTLC-Timeout tx spending it.
  49         //
  50         // We then either allow these transactions to confirm (if !claim) or we wait until one block
  51         // before they otherwise would and reorg them out, confirming an HTLC-Success tx instead.
  52         let chanmon_cfgs = create_chanmon_cfgs(3);
  53         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
  54         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
  55         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
  56
  57         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
  58         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
  59
  60         // Make sure all nodes are at the same starting height
  61         connect_blocks(&nodes[0], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
  62         connect_blocks(&nodes[1], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
  63         connect_blocks(&nodes[2], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
  64
  65         let (our_payment_preimage, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000);
  66
  67         // Provide preimage to node 2 by claiming payment
  68         nodes[2].node.claim_funds(our_payment_preimage);
  69         expect_payment_claimed!(nodes[2], our_payment_hash, 1_000_000);
  70         check_added_monitors!(nodes[2], 1);
  71         get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
  72
  73         let mut header = BlockHeader { version: 0x2000_0000, prev_blockhash: nodes[2].best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
  74         let claim_txn = if local_commitment {
  75                 // Broadcast node 1 commitment txn to broadcast the HTLC-Timeout
  76                 let node_1_commitment_txn = get_local_commitment_txn!(nodes[1], chan_2.2);
  77                 assert_eq!(node_1_commitment_txn.len(), 2); // 1 local commitment tx, 1 Outbound HTLC-Timeout
  78                 assert_eq!(node_1_commitment_txn[0].output.len(), 2); // to-self and Offered HTLC (to-remote/to-node-3 is dust)
  79                 check_spends!(node_1_commitment_txn[0], chan_2.3);
  80                 check_spends!(node_1_commitment_txn[1], node_1_commitment_txn[0]);
  81
  82                 // Give node 2 node 1's transactions and get its response (claiming the HTLC instead).
  83                 connect_block(&nodes[2], &Block { header, txdata: node_1_commitment_txn.clone() });
  84                 check_added_monitors!(nodes[2], 1);
  85                 check_closed_broadcast!(nodes[2], true); // We should get a BroadcastChannelUpdate (and *only* a BroadcstChannelUpdate)
  86                 check_closed_event!(nodes[2], 1, ClosureReason::CommitmentTxConfirmed);
  87                 let node_2_commitment_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
  88                 assert_eq!(node_2_commitment_txn.len(), 3); // ChannelMonitor: 1 offered HTLC-Claim, ChannelManger: 1 local commitment tx, 1 Received HTLC-Claim
  89                 assert_eq!(node_2_commitment_txn[1].output.len(), 2); // to-remote and Received HTLC (to-self is dust)
  90                 check_spends!(node_2_commitment_txn[1], chan_2.3);
  91                 check_spends!(node_2_commitment_txn[2], node_2_commitment_txn[1]);
  92                 check_spends!(node_2_commitment_txn[0], node_1_commitment_txn[0]);
  93
  94                 // Make sure node 1's height is the same as the !local_commitment case
  95                 connect_blocks(&nodes[1], 1);
  96                 // Confirm node 1's commitment txn (and HTLC-Timeout) on node 1
  97                 header.prev_blockhash = nodes[1].best_block_hash();
  98                 connect_block(&nodes[1], &Block { header, txdata: node_1_commitment_txn.clone() });
  99
 100                 // ...but return node 1's commitment tx in case claim is set and we're preparing to reorg
 101                 vec![node_1_commitment_txn[0].clone(), node_2_commitment_txn[0].clone()]
 102         } else {
 103                 // Broadcast node 2 commitment txn
 104                 let mut node_2_commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
 105                 assert_eq!(node_2_commitment_txn.len(), 2); // 1 local commitment tx, 1 Received HTLC-Claim
 106                 assert_eq!(node_2_commitment_txn[0].output.len(), 2); // to-remote and Received HTLC (to-self is dust)
 107                 check_spends!(node_2_commitment_txn[0], chan_2.3);
 108                 check_spends!(node_2_commitment_txn[1], node_2_commitment_txn[0]);
 109
 110                 // Give node 1 node 2's commitment transaction and get its response (timing the HTLC out)
 111                 mine_transaction(&nodes[1], &node_2_commitment_txn[0]);
 112                 connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
 113                 let node_1_commitment_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
 114                 assert_eq!(node_1_commitment_txn.len(), 2); // ChannelMonitor: 1 offered HTLC-Timeout, ChannelManger: 1 local commitment tx
 115                 assert_eq!(node_1_commitment_txn[0].output.len(), 2); // to-local and Offered HTLC (to-remote is dust)
 116                 check_spends!(node_1_commitment_txn[0], chan_2.3);
 117                 check_spends!(node_1_commitment_txn[1], node_2_commitment_txn[0]);
 118
 119                 // Confirm node 1's HTLC-Timeout on node 1
 120                 mine_transaction(&nodes[1], &node_1_commitment_txn[1]);
 121                 // ...but return node 2's commitment tx (and claim) in case claim is set and we're preparing to reorg
 122                 vec![node_2_commitment_txn.pop().unwrap()]
 123         };
 124         check_added_monitors!(nodes[1], 1);
 125         check_closed_broadcast!(nodes[1], true); // We should get a BroadcastChannelUpdate (and *only* a BroadcstChannelUpdate)
 126         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
 127         // Connect ANTI_REORG_DELAY - 2 blocks, giving us a confirmation count of ANTI_REORG_DELAY - 1.
 128         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 2);
 129         check_added_monitors!(nodes[1], 0);
 130         assert_eq!(nodes[1].node.get_and_clear_pending_events().len(), 0);
 131
 132         if claim {
 133                 disconnect_blocks(&nodes[1], ANTI_REORG_DELAY - 2);
 134
 135                 let block = Block {
 136                         header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 },
 137                         txdata: claim_txn,
 138                 };
 139                 connect_block(&nodes[1], &block);
 140
 141                 // ChannelManager only polls chain::Watch::release_pending_monitor_events when we
 142                 // probe it for events, so we probe non-message events here (which should just be the
 143                 // PaymentForwarded event).
 144                 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), true, true);
 145         } else {
 146                 // Confirm the timeout tx and check that we fail the HTLC backwards
 147                 let block = Block {
 148                         header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 },
 149                         txdata: vec![],
 150                 };
 151                 connect_block(&nodes[1], &block);
 152                 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::NextHopChannel { node_id: Some(nodes[2].node.get_our_node_id()), channel_id: chan_2.2 }]);
 153         }
 154
 155         check_added_monitors!(nodes[1], 1);
 156         // Which should result in an immediate claim/fail of the HTLC:
 157         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 158         if claim {
 159                 assert_eq!(htlc_updates.update_fulfill_htlcs.len(), 1);
 160                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fulfill_htlcs[0]);
 161         } else {
 162                 assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
 163                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
 164         }
 165         commitment_signed_dance!(nodes[0], nodes[1], htlc_updates.commitment_signed, false, true);
 166         if claim {
 167                 expect_payment_sent!(nodes[0], our_payment_preimage);
 168         } else {
 169                 expect_payment_failed_with_update!(nodes[0], our_payment_hash, false, chan_2.0.contents.short_channel_id, true);
 170         }
 171 }
 172
 173 #[test]
 174 fn test_onchain_htlc_claim_reorg_local_commitment() {
 175         do_test_onchain_htlc_reorg(true, true);
 176 }
 177 #[test]
 178 fn test_onchain_htlc_timeout_delay_local_commitment() {
 179         do_test_onchain_htlc_reorg(true, false);
 180 }
 181 #[test]
 182 fn test_onchain_htlc_claim_reorg_remote_commitment() {
 183         do_test_onchain_htlc_reorg(false, true);
 184 }
 185 #[test]
 186 fn test_onchain_htlc_timeout_delay_remote_commitment() {
 187         do_test_onchain_htlc_reorg(false, false);
 188 }
 189
 190 #[test]
 191 fn test_counterparty_revoked_reorg() {
 192         // Test what happens when a revoked counterparty transaction is broadcast but then reorg'd out
 193         // of the main chain. Specifically, HTLCs in the latest commitment transaction which are not
 194         // included in the revoked commitment transaction should not be considered failed, and should
 195         // still be claim-from-able after the reorg.
 196         let chanmon_cfgs = create_chanmon_cfgs(2);
 197         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 198         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 199         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 200
 201         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known());
 202
 203         // Get the initial commitment transaction for broadcast, before any HTLCs are added at all.
 204         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
 205         assert_eq!(revoked_local_txn.len(), 1);
 206
 207         // Now add two HTLCs in each direction, one dust and one not.
 208         route_payment(&nodes[0], &[&nodes[1]], 5_000_000);
 209         route_payment(&nodes[0], &[&nodes[1]], 5_000);
 210         let (payment_preimage_3, payment_hash_3, ..) = route_payment(&nodes[1], &[&nodes[0]], 4_000_000);
 211         let payment_hash_4 = route_payment(&nodes[1], &[&nodes[0]], 4_000).1;
 212
 213         nodes[0].node.claim_funds(payment_preimage_3);
 214         let _ = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 215         check_added_monitors!(nodes[0], 1);
 216         expect_payment_claimed!(nodes[0], payment_hash_3, 4_000_000);
 217
 218         let mut unrevoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
 219         assert_eq!(unrevoked_local_txn.len(), 3); // commitment + 2 HTLC txn
 220         // Sort the unrevoked transactions in reverse order, ie commitment tx, then HTLC 1 then HTLC 3
 221         unrevoked_local_txn.sort_unstable_by_key(|tx| 1_000_000 - tx.output.iter().map(|outp| outp.value).sum::<u64>());
 222
 223         // Now mine A's old commitment transaction, which should close the channel, but take no action
 224         // on any of the HTLCs, at least until we get six confirmations (which we won't get).
 225         mine_transaction(&nodes[1], &revoked_local_txn[0]);
 226         check_added_monitors!(nodes[1], 1);
 227         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
 228         check_closed_broadcast!(nodes[1], true);
 229
 230         // Connect up to one block before the revoked transaction would be considered final, then do a
 231         // reorg that disconnects the full chain and goes up to the height at which the revoked
 232         // transaction would be final.
 233         let theoretical_conf_height = nodes[1].best_block_info().1 + ANTI_REORG_DELAY - 1;
 234         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 2);
 235         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 236         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
 237
 238         disconnect_all_blocks(&nodes[1]);
 239         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 240         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
 241
 242         connect_blocks(&nodes[1], theoretical_conf_height);
 243         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 244         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
 245
 246         // Now connect A's latest commitment transaction instead and resolve the HTLCs
 247         mine_transaction(&nodes[1], &unrevoked_local_txn[0]);
 248         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 249         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
 250
 251         // Connect the HTLC claim transaction for HTLC 3
 252         mine_transaction(&nodes[1], &unrevoked_local_txn[2]);
 253         expect_payment_sent!(nodes[1], payment_preimage_3);
 254         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 255
 256         // Connect blocks to confirm the unrevoked commitment transaction
 257         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 2);
 258         expect_payment_failed!(nodes[1], payment_hash_4, true);
 259 }
 260
 261 fn do_test_unconf_chan(reload_node: bool, reorg_after_reload: bool, use_funding_unconfirmed: bool, connect_style: ConnectStyle) {
 262         // After creating a chan between nodes, we disconnect all blocks previously seen to force a
 263         // channel close on nodes[0] side. We also use this to provide very basic testing of logic
 264         // around freeing background events which store monitor updates during block_[dis]connected.
 265         let chanmon_cfgs = create_chanmon_cfgs(2);
 266         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 267         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 268         let persister: test_utils::TestPersister;
 269         let new_chain_monitor: test_utils::TestChainMonitor;
 270         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
 271         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 272         *nodes[0].connect_style.borrow_mut() = connect_style;
 273
 274         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 275
 276         let channel_state = nodes[0].node.channel_state.lock().unwrap();
 277         assert_eq!(channel_state.by_id.len(), 1);
 278         assert_eq!(channel_state.short_to_chan_info.len(), 2);
 279         mem::drop(channel_state);
 280
 281         if !reorg_after_reload {
 282                 if use_funding_unconfirmed {
 283                         let relevant_txids = nodes[0].node.get_relevant_txids();
 284                         assert_eq!(&relevant_txids[..], &[chan.3.txid()]);
 285                         nodes[0].node.transaction_unconfirmed(&relevant_txids[0]);
 286                 } else if connect_style == ConnectStyle::FullBlockViaListen {
 287                         disconnect_blocks(&nodes[0], CHAN_CONFIRM_DEPTH - 1);
 288                         assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
 289                         disconnect_blocks(&nodes[0], 1);
 290                 } else {
 291                         disconnect_all_blocks(&nodes[0]);
 292                 }
 293                 handle_announce_close_broadcast_events(&nodes, 0, 1, true, "Channel closed because of an exception: Funding transaction was un-confirmed. Locked at 6 confs, now have 0 confs.");
 294                 check_added_monitors!(nodes[1], 1);
 295                 {
 296                         let channel_state = nodes[0].node.channel_state.lock().unwrap();
 297                         assert_eq!(channel_state.by_id.len(), 0);
 298                         assert_eq!(channel_state.short_to_chan_info.len(), 0);
 299                 }
 300         }
 301
 302         if reload_node {
 303                 // Since we currently have a background event pending, it's good to test that we survive a
 304                 // serialization roundtrip. Further, this tests the somewhat awkward edge-case of dropping
 305                 // the Channel object from the ChannelManager, but still having a monitor event pending for
 306                 // it when we go to deserialize, and then use the ChannelManager.
 307                 let nodes_0_serialized = nodes[0].node.encode();
 308                 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
 309                 get_monitor!(nodes[0], chan.2).write(&mut chan_0_monitor_serialized).unwrap();
 310
 311                 persister = test_utils::TestPersister::new();
 312                 let keys_manager = &chanmon_cfgs[0].keys_manager;
 313                 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), nodes[0].logger, node_cfgs[0].fee_estimator, &persister, keys_manager);
 314                 nodes[0].chain_monitor = &new_chain_monitor;
 315                 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
 316                 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
 317                         &mut chan_0_monitor_read, keys_manager).unwrap();
 318                 assert!(chan_0_monitor_read.is_empty());
 319
 320                 let mut nodes_0_read = &nodes_0_serialized[..];
 321                 nodes_0_deserialized = {
 322                         let mut channel_monitors = HashMap::new();
 323                         channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
 324                         <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster,
 325                           &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(
 326                                 &mut nodes_0_read, ChannelManagerReadArgs {
 327                                         default_config: *nodes[0].node.get_current_default_configuration(),
 328                                         keys_manager,
 329                                         fee_estimator: node_cfgs[0].fee_estimator,
 330                                         chain_monitor: nodes[0].chain_monitor,
 331                                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
 332                                         logger: nodes[0].logger,
 333                                         channel_monitors,
 334                         }).unwrap().1
 335                 };
 336                 nodes[0].node = &nodes_0_deserialized;
 337                 assert!(nodes_0_read.is_empty());
 338                 if !reorg_after_reload {
 339                         // If the channel is already closed when we reload the node, we'll broadcast a closing
 340                         // transaction via the ChannelMonitor which is missing a corresponding channel.
 341                         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 342                         nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 343                 }
 344
 345                 nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0.clone(), chan_0_monitor).unwrap();
 346                 check_added_monitors!(nodes[0], 1);
 347         }
 348
 349         if reorg_after_reload {
 350                 if use_funding_unconfirmed {
 351                         let relevant_txids = nodes[0].node.get_relevant_txids();
 352                         assert_eq!(&relevant_txids[..], &[chan.3.txid()]);
 353                         nodes[0].node.transaction_unconfirmed(&relevant_txids[0]);
 354                 } else if connect_style == ConnectStyle::FullBlockViaListen {
 355                         disconnect_blocks(&nodes[0], CHAN_CONFIRM_DEPTH - 1);
 356                         assert_eq!(nodes[0].node.list_channels().len(), 1);
 357                         disconnect_blocks(&nodes[0], 1);
 358                 } else {
 359                         disconnect_all_blocks(&nodes[0]);
 360                 }
 361                 handle_announce_close_broadcast_events(&nodes, 0, 1, true, "Channel closed because of an exception: Funding transaction was un-confirmed. Locked at 6 confs, now have 0 confs.");
 362                 check_added_monitors!(nodes[1], 1);
 363                 {
 364                         let channel_state = nodes[0].node.channel_state.lock().unwrap();
 365                         assert_eq!(channel_state.by_id.len(), 0);
 366                         assert_eq!(channel_state.short_to_chan_info.len(), 0);
 367                 }
 368         }
 369         // With expect_channel_force_closed set the TestChainMonitor will enforce that the next update
 370         // is a ChannelForcClosed on the right channel with should_broadcast set.
 371         *nodes[0].chain_monitor.expect_channel_force_closed.lock().unwrap() = Some((chan.2, true));
 372         nodes[0].node.test_process_background_events(); // Required to free the pending background monitor update
 373         check_added_monitors!(nodes[0], 1);
 374         let expected_err = "Funding transaction was un-confirmed. Locked at 6 confs, now have 0 confs.";
 375         check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyForceClosed { peer_msg: "Channel closed because of an exception: ".to_owned() + expected_err });
 376         check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: expected_err.to_owned() });
 377         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 378         nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 379
 380         // Now check that we can create a new channel
 381         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 382         send_payment(&nodes[0], &[&nodes[1]], 8000000);
 383 }
 384
 385 #[test]
 386 fn test_unconf_chan() {
 387         do_test_unconf_chan(true, true, false, ConnectStyle::BestBlockFirstSkippingBlocks);
 388         do_test_unconf_chan(false, true, false, ConnectStyle::BestBlockFirstSkippingBlocks);
 389         do_test_unconf_chan(true, false, false, ConnectStyle::BestBlockFirstSkippingBlocks);
 390         do_test_unconf_chan(false, false, false, ConnectStyle::BestBlockFirstSkippingBlocks);
 391
 392         do_test_unconf_chan(true, true, false, ConnectStyle::BestBlockFirstReorgsOnlyTip);
 393         do_test_unconf_chan(false, true, false, ConnectStyle::BestBlockFirstReorgsOnlyTip);
 394         do_test_unconf_chan(true, false, false, ConnectStyle::BestBlockFirstReorgsOnlyTip);
 395         do_test_unconf_chan(false, false, false, ConnectStyle::BestBlockFirstReorgsOnlyTip);
 396 }
 397
 398 #[test]
 399 fn test_unconf_chan_via_listen() {
 400         do_test_unconf_chan(true, true, false, ConnectStyle::FullBlockViaListen);
 401         do_test_unconf_chan(false, true, false, ConnectStyle::FullBlockViaListen);
 402         do_test_unconf_chan(true, false, false, ConnectStyle::FullBlockViaListen);
 403         do_test_unconf_chan(false, false, false, ConnectStyle::FullBlockViaListen);
 404 }
 405
 406 #[test]
 407 fn test_unconf_chan_via_funding_unconfirmed() {
 408         do_test_unconf_chan(true, true, true, ConnectStyle::BestBlockFirstSkippingBlocks);
 409         do_test_unconf_chan(false, true, true, ConnectStyle::BestBlockFirstSkippingBlocks);
 410         do_test_unconf_chan(true, false, true, ConnectStyle::BestBlockFirstSkippingBlocks);
 411         do_test_unconf_chan(false, false, true, ConnectStyle::BestBlockFirstSkippingBlocks);
 412
 413         do_test_unconf_chan(true, true, true, ConnectStyle::BestBlockFirstReorgsOnlyTip);
 414         do_test_unconf_chan(false, true, true, ConnectStyle::BestBlockFirstReorgsOnlyTip);
 415         do_test_unconf_chan(true, false, true, ConnectStyle::BestBlockFirstReorgsOnlyTip);
 416         do_test_unconf_chan(false, false, true, ConnectStyle::BestBlockFirstReorgsOnlyTip);
 417
 418         do_test_unconf_chan(true, true, true, ConnectStyle::FullBlockViaListen);
 419         do_test_unconf_chan(false, true, true, ConnectStyle::FullBlockViaListen);
 420         do_test_unconf_chan(true, false, true, ConnectStyle::FullBlockViaListen);
 421         do_test_unconf_chan(false, false, true, ConnectStyle::FullBlockViaListen);
 422 }
 423
 424 #[test]
 425 fn test_set_outpoints_partial_claiming() {
 426         // - remote party claim tx, new bump tx
 427         // - disconnect remote claiming tx, new bump
 428         // - disconnect tx, see no tx anymore
 429         let chanmon_cfgs = create_chanmon_cfgs(2);
 430         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 431         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 432         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 433
 434         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
 435         let (payment_preimage_1, payment_hash_1, _) = route_payment(&nodes[1], &[&nodes[0]], 3_000_000);
 436         let (payment_preimage_2, payment_hash_2, _) = route_payment(&nodes[1], &[&nodes[0]], 3_000_000);
 437
 438         // Remote commitment txn with 4 outputs: to_local, to_remote, 2 outgoing HTLC
 439         let remote_txn = get_local_commitment_txn!(nodes[1], chan.2);
 440         assert_eq!(remote_txn.len(), 3);
 441         assert_eq!(remote_txn[0].output.len(), 4);
 442         assert_eq!(remote_txn[0].input.len(), 1);
 443         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
 444         check_spends!(remote_txn[1], remote_txn[0]);
 445         check_spends!(remote_txn[2], remote_txn[0]);
 446
 447         // Connect blocks on node A to advance height towards TEST_FINAL_CLTV
 448         // Provide node A with both preimage
 449         nodes[0].node.claim_funds(payment_preimage_1);
 450         expect_payment_claimed!(nodes[0], payment_hash_1, 3_000_000);
 451         nodes[0].node.claim_funds(payment_preimage_2);
 452         expect_payment_claimed!(nodes[0], payment_hash_2, 3_000_000);
 453         check_added_monitors!(nodes[0], 2);
 454         nodes[0].node.get_and_clear_pending_msg_events();
 455
 456         // Connect blocks on node A commitment transaction
 457         mine_transaction(&nodes[0], &remote_txn[0]);
 458         check_closed_broadcast!(nodes[0], true);
 459         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
 460         check_added_monitors!(nodes[0], 1);
 461         // Verify node A broadcast tx claiming both HTLCs
 462         {
 463                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
 464                 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-Success*2
 465                 assert_eq!(node_txn.len(), 4);
 466                 check_spends!(node_txn[0], remote_txn[0]);
 467                 check_spends!(node_txn[1], chan.3);
 468                 check_spends!(node_txn[2], node_txn[1]);
 469                 check_spends!(node_txn[3], node_txn[1]);
 470                 assert_eq!(node_txn[0].input.len(), 2);
 471                 node_txn.clear();
 472         }
 473
 474         // Connect blocks on node B
 475         connect_blocks(&nodes[1], 135);
 476         check_closed_broadcast!(nodes[1], true);
 477         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
 478         check_added_monitors!(nodes[1], 1);
 479         // Verify node B broadcast 2 HTLC-timeout txn
 480         let partial_claim_tx = {
 481                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
 482                 assert_eq!(node_txn.len(), 3);
 483                 check_spends!(node_txn[1], node_txn[0]);
 484                 check_spends!(node_txn[2], node_txn[0]);
 485                 assert_eq!(node_txn[1].input.len(), 1);
 486                 assert_eq!(node_txn[2].input.len(), 1);
 487                 node_txn[1].clone()
 488         };
 489
 490         // Broadcast partial claim on node A, should regenerate a claiming tx with HTLC dropped
 491         mine_transaction(&nodes[0], &partial_claim_tx);
 492         {
 493                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
 494                 assert_eq!(node_txn.len(), 1);
 495                 check_spends!(node_txn[0], remote_txn[0]);
 496                 assert_eq!(node_txn[0].input.len(), 1); //dropped HTLC
 497                 node_txn.clear();
 498         }
 499         nodes[0].node.get_and_clear_pending_msg_events();
 500
 501         // Disconnect last block on node A, should regenerate a claiming tx with HTLC dropped
 502         disconnect_blocks(&nodes[0], 1);
 503         {
 504                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
 505                 assert_eq!(node_txn.len(), 1);
 506                 check_spends!(node_txn[0], remote_txn[0]);
 507                 assert_eq!(node_txn[0].input.len(), 2); //resurrected HTLC
 508                 node_txn.clear();
 509         }
 510
 511         //// Disconnect one more block and then reconnect multiple no transaction should be generated
 512         disconnect_blocks(&nodes[0], 1);
 513         connect_blocks(&nodes[0], 15);
 514         {
 515                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
 516                 assert_eq!(node_txn.len(), 0);
 517                 node_txn.clear();
 518         }
 519 }
 520
 521 fn do_test_to_remote_after_local_detection(style: ConnectStyle) {
 522         // In previous code, detection of to_remote outputs in a counterparty commitment transaction
 523         // was dependent on whether a local commitment transaction had been seen on-chain previously.
 524         // This resulted in some edge cases around not being able to generate a SpendableOutput event
 525         // after a reorg.
 526         //
 527         // Here, we test this by first confirming one set of commitment transactions, then
 528         // disconnecting them and reconnecting another. We then confirm them and check that the correct
 529         // SpendableOutput event is generated.
 530         let chanmon_cfgs = create_chanmon_cfgs(2);
 531         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 532         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 533         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 534
 535         *nodes[0].connect_style.borrow_mut() = style;
 536         *nodes[1].connect_style.borrow_mut() = style;
 537
 538         let (_, _, chan_id, funding_tx) =
 539                 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 100_000_000, InitFeatures::known(), InitFeatures::known());
 540         let funding_outpoint = OutPoint { txid: funding_tx.txid(), index: 0 };
 541         assert_eq!(funding_outpoint.to_channel_id(), chan_id);
 542
 543         let remote_txn_a = get_local_commitment_txn!(nodes[0], chan_id);
 544         let remote_txn_b = get_local_commitment_txn!(nodes[1], chan_id);
 545
 546         mine_transaction(&nodes[0], &remote_txn_a[0]);
 547         mine_transaction(&nodes[1], &remote_txn_a[0]);
 548
 549         assert!(nodes[0].node.list_channels().is_empty());
 550         check_closed_broadcast!(nodes[0], true);
 551         check_added_monitors!(nodes[0], 1);
 552         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
 553         assert!(nodes[1].node.list_channels().is_empty());
 554         check_closed_broadcast!(nodes[1], true);
 555         check_added_monitors!(nodes[1], 1);
 556         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
 557
 558         // Drop transactions broadcasted in response to the first commitment transaction (we have good
 559         // test coverage of these things already elsewhere).
 560         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0).len(), 1);
 561         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0).len(), 1);
 562
 563         assert!(nodes[0].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
 564         assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
 565
 566         disconnect_blocks(&nodes[0], 1);
 567         disconnect_blocks(&nodes[1], 1);
 568
 569         assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
 570         assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
 571         assert!(nodes[0].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
 572         assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
 573
 574         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
 575         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
 576
 577         assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
 578         assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
 579         assert!(nodes[0].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
 580         assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
 581
 582         mine_transaction(&nodes[0], &remote_txn_b[0]);
 583         mine_transaction(&nodes[1], &remote_txn_b[0]);
 584
 585         assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
 586         assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
 587         assert!(nodes[0].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
 588         assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
 589
 590         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
 591         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
 592
 593         let mut node_a_spendable = nodes[0].chain_monitor.chain_monitor.get_and_clear_pending_events();
 594         assert_eq!(node_a_spendable.len(), 1);
 595         if let Event::SpendableOutputs { outputs } = node_a_spendable.pop().unwrap() {
 596                 assert_eq!(outputs.len(), 1);
 597                 let spend_tx = nodes[0].keys_manager.backing.spend_spendable_outputs(&[&outputs[0]], Vec::new(),
 598                         Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, &Secp256k1::new()).unwrap();
 599                 check_spends!(spend_tx, remote_txn_b[0]);
 600         }
 601
 602         // nodes[1] is waiting for the to_self_delay to expire, which is many more than
 603         // ANTI_REORG_DELAY. Instead, walk it back and confirm the original remote_txn_a commitment
 604         // again and check that nodes[1] generates a similar spendable output.
 605         // Technically a reorg of ANTI_REORG_DELAY violates our assumptions, so this is undefined by
 606         // our API spec, but we currently handle this correctly and there's little reason we shouldn't
 607         // in the future.
 608         assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
 609         disconnect_blocks(&nodes[1], ANTI_REORG_DELAY);
 610         mine_transaction(&nodes[1], &remote_txn_a[0]);
 611         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
 612
 613         let mut node_b_spendable = nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events();
 614         assert_eq!(node_b_spendable.len(), 1);
 615         if let Event::SpendableOutputs { outputs } = node_b_spendable.pop().unwrap() {
 616                 assert_eq!(outputs.len(), 1);
 617                 let spend_tx = nodes[1].keys_manager.backing.spend_spendable_outputs(&[&outputs[0]], Vec::new(),
 618                         Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, &Secp256k1::new()).unwrap();
 619                 check_spends!(spend_tx, remote_txn_a[0]);
 620         }
 621 }
 622
 623 #[test]
 624 fn test_to_remote_after_local_detection() {
 625         do_test_to_remote_after_local_detection(ConnectStyle::BestBlockFirst);
 626         do_test_to_remote_after_local_detection(ConnectStyle::BestBlockFirstSkippingBlocks);
 627         do_test_to_remote_after_local_detection(ConnectStyle::BestBlockFirstReorgsOnlyTip);
 628         do_test_to_remote_after_local_detection(ConnectStyle::TransactionsFirst);
 629         do_test_to_remote_after_local_detection(ConnectStyle::TransactionsFirstSkippingBlocks);
 630         do_test_to_remote_after_local_detection(ConnectStyle::TransactionsFirstReorgsOnlyTip);
 631         do_test_to_remote_after_local_detection(ConnectStyle::FullBlockViaListen);
 632 }