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