_ 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 crate::chain::channelmonitor::ANTI_REORG_DELAY;
  13 use crate::chain::transaction::OutPoint;
  14 use crate::chain::Confirm;
  15 use crate::ln::channelmanager::{self, ChannelManager};
  16 use crate::ln::msgs::ChannelMessageHandler;
  17 use crate::util::events::{Event, MessageSendEvent, MessageSendEventsProvider, ClosureReason, HTLCDestination};
  18 use crate::util::test_utils;
  19 use crate::util::ser::Writeable;
  20
  21 use bitcoin::blockdata::block::{Block, BlockHeader};
  22 use bitcoin::blockdata::script::Builder;
  23 use bitcoin::blockdata::opcodes;
  24 use bitcoin::secp256k1::Secp256k1;
  25
  26 use crate::prelude::*;
  27 use core::mem;
  28 use bitcoin::hashes::Hash;
  29 use bitcoin::TxMerkleNode;
  30
  31 use crate::ln::functional_test_utils::*;
  32
  33 fn do_test_onchain_htlc_reorg(local_commitment: bool, claim: bool) {
  34         // Our on-chain HTLC-claim learning has a few properties worth testing:
  35         //  * If an upstream HTLC is claimed with a preimage (both against our own commitment
  36         //    transaction our counterparty's), we claim it backwards immediately.
  37         //  * If an upstream HTLC is claimed with a timeout, we delay ANTI_REORG_DELAY before failing
  38         //    it backwards to ensure our counterparty can't claim with a preimage in a reorg.
  39         //
  40         // Here we test both properties in any combination based on the two bools passed in as
  41         // arguments.
  42         //
  43         // If local_commitment is set, we first broadcast a local commitment containing an offered HTLC
  44         // and an HTLC-Timeout tx, otherwise we broadcast a remote commitment containing a received
  45         // HTLC and a local HTLC-Timeout tx spending it.
  46         //
  47         // We then either allow these transactions to confirm (if !claim) or we wait until one block
  48         // before they otherwise would and reorg them out, confirming an HTLC-Success tx instead.
  49         let chanmon_cfgs = create_chanmon_cfgs(3);
  50         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
  51         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
  52         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
  53
  54         create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
  55         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features());
  56
  57         // Make sure all nodes are at the same starting height
  58         connect_blocks(&nodes[0], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
  59         connect_blocks(&nodes[1], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
  60         connect_blocks(&nodes[2], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
  61
  62         let (our_payment_preimage, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000);
  63
  64         // Provide preimage to node 2 by claiming payment
  65         nodes[2].node.claim_funds(our_payment_preimage);
  66         expect_payment_claimed!(nodes[2], our_payment_hash, 1_000_000);
  67         check_added_monitors!(nodes[2], 1);
  68         get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
  69
  70         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 };
  71         let claim_txn = if local_commitment {
  72                 // Broadcast node 1 commitment txn to broadcast the HTLC-Timeout
  73                 let node_1_commitment_txn = get_local_commitment_txn!(nodes[1], chan_2.2);
  74                 assert_eq!(node_1_commitment_txn.len(), 2); // 1 local commitment tx, 1 Outbound HTLC-Timeout
  75                 assert_eq!(node_1_commitment_txn[0].output.len(), 2); // to-self and Offered HTLC (to-remote/to-node-3 is dust)
  76                 check_spends!(node_1_commitment_txn[0], chan_2.3);
  77                 check_spends!(node_1_commitment_txn[1], node_1_commitment_txn[0]);
  78
  79                 // Give node 2 node 1's transactions and get its response (claiming the HTLC instead).
  80                 connect_block(&nodes[2], &Block { header, txdata: node_1_commitment_txn.clone() });
  81                 check_added_monitors!(nodes[2], 1);
  82                 check_closed_broadcast!(nodes[2], true); // We should get a BroadcastChannelUpdate (and *only* a BroadcstChannelUpdate)
  83                 check_closed_event!(nodes[2], 1, ClosureReason::CommitmentTxConfirmed);
  84                 let node_2_commitment_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
  85                 assert_eq!(node_2_commitment_txn.len(), 3); // ChannelMonitor: 1 offered HTLC-Claim, ChannelManger: 1 local commitment tx, 1 Received HTLC-Claim
  86                 assert_eq!(node_2_commitment_txn[1].output.len(), 2); // to-remote and Received HTLC (to-self is dust)
  87                 check_spends!(node_2_commitment_txn[1], chan_2.3);
  88                 check_spends!(node_2_commitment_txn[2], node_2_commitment_txn[1]);
  89                 check_spends!(node_2_commitment_txn[0], node_1_commitment_txn[0]);
  90
  91                 // Make sure node 1's height is the same as the !local_commitment case
  92                 connect_blocks(&nodes[1], 1);
  93                 // Confirm node 1's commitment txn (and HTLC-Timeout) on node 1
  94                 header.prev_blockhash = nodes[1].best_block_hash();
  95                 connect_block(&nodes[1], &Block { header, txdata: node_1_commitment_txn.clone() });
  96
  97                 // ...but return node 1's commitment tx in case claim is set and we're preparing to reorg
  98                 vec![node_1_commitment_txn[0].clone(), node_2_commitment_txn[0].clone()]
  99         } else {
 100                 // Broadcast node 2 commitment txn
 101                 let mut node_2_commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
 102                 assert_eq!(node_2_commitment_txn.len(), 2); // 1 local commitment tx, 1 Received HTLC-Claim
 103                 assert_eq!(node_2_commitment_txn[0].output.len(), 2); // to-remote and Received HTLC (to-self is dust)
 104                 check_spends!(node_2_commitment_txn[0], chan_2.3);
 105                 check_spends!(node_2_commitment_txn[1], node_2_commitment_txn[0]);
 106
 107                 // Give node 1 node 2's commitment transaction and get its response (timing the HTLC out)
 108                 mine_transaction(&nodes[1], &node_2_commitment_txn[0]);
 109                 connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
 110                 let node_1_commitment_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
 111                 assert_eq!(node_1_commitment_txn.len(), 2); // ChannelMonitor: 1 offered HTLC-Timeout, ChannelManger: 1 local commitment tx
 112                 assert_eq!(node_1_commitment_txn[0].output.len(), 2); // to-local and Offered HTLC (to-remote is dust)
 113                 check_spends!(node_1_commitment_txn[0], chan_2.3);
 114                 check_spends!(node_1_commitment_txn[1], node_2_commitment_txn[0]);
 115
 116                 // Confirm node 1's HTLC-Timeout on node 1
 117                 mine_transaction(&nodes[1], &node_1_commitment_txn[1]);
 118                 // ...but return node 2's commitment tx (and claim) in case claim is set and we're preparing to reorg
 119                 vec![node_2_commitment_txn.pop().unwrap()]
 120         };
 121         check_added_monitors!(nodes[1], 1);
 122         check_closed_broadcast!(nodes[1], true); // We should get a BroadcastChannelUpdate (and *only* a BroadcstChannelUpdate)
 123         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
 124         // Connect ANTI_REORG_DELAY - 2 blocks, giving us a confirmation count of ANTI_REORG_DELAY - 1.
 125         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 2);
 126         check_added_monitors!(nodes[1], 0);
 127         assert_eq!(nodes[1].node.get_and_clear_pending_events().len(), 0);
 128
 129         if claim {
 130                 // Disconnect Node 1's HTLC-Timeout which was connected above
 131                 disconnect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
 132
 133                 let block = Block {
 134                         header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), 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: TxMerkleNode::all_zeros(), 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, channelmanager::provided_init_features(), channelmanager::provided_init_features());
 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, false);
 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<&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_conf_height = core::cmp::max(nodes[0].best_block_info().1 + 1, nodes[1].best_block_info().1 + 1);
 273         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
 274
 275         let channel_state = nodes[0].node.channel_state.lock().unwrap();
 276         assert_eq!(channel_state.by_id.len(), 1);
 277         assert_eq!(nodes[0].node.short_to_chan_info.read().unwrap().len(), 2);
 278         mem::drop(channel_state);
 279
 280         if !reorg_after_reload {
 281                 if use_funding_unconfirmed {
 282                         let relevant_txids = nodes[0].node.get_relevant_txids();
 283                         assert_eq!(relevant_txids.len(), 1);
 284                         let block_hash_opt = relevant_txids[0].1;
 285                         let expected_hash = nodes[0].get_block_header(chan_conf_height).block_hash();
 286                         assert_eq!(block_hash_opt, Some(expected_hash));
 287                         let txid = relevant_txids[0].0;
 288                         assert_eq!(txid, chan.3.txid());
 289                         nodes[0].node.transaction_unconfirmed(&txid);
 290                 } else if connect_style == ConnectStyle::FullBlockViaListen {
 291                         disconnect_blocks(&nodes[0], CHAN_CONFIRM_DEPTH - 1);
 292                         assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
 293                         disconnect_blocks(&nodes[0], 1);
 294                 } else {
 295                         disconnect_all_blocks(&nodes[0]);
 296                 }
 297
 298                 let relevant_txids = nodes[0].node.get_relevant_txids();
 299                 assert_eq!(relevant_txids.len(), 0);
 300
 301                 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.");
 302                 check_added_monitors!(nodes[1], 1);
 303                 {
 304                         let channel_state = nodes[0].node.channel_state.lock().unwrap();
 305                         assert_eq!(channel_state.by_id.len(), 0);
 306                         assert_eq!(nodes[0].node.short_to_chan_info.read().unwrap().len(), 0);
 307                 }
 308         }
 309
 310         if reload_node {
 311                 // Since we currently have a background event pending, it's good to test that we survive a
 312                 // serialization roundtrip. Further, this tests the somewhat awkward edge-case of dropping
 313                 // the Channel object from the ChannelManager, but still having a monitor event pending for
 314                 // it when we go to deserialize, and then use the ChannelManager.
 315                 let nodes_0_serialized = nodes[0].node.encode();
 316                 let chan_0_monitor_serialized = get_monitor!(nodes[0], chan.2).encode();
 317
 318                 reload_node!(nodes[0], *nodes[0].node.get_current_default_configuration(), &nodes_0_serialized, &[&chan_0_monitor_serialized], persister, new_chain_monitor, nodes_0_deserialized);
 319                 if !reorg_after_reload {
 320                         // If the channel is already closed when we reload the node, we'll broadcast a closing
 321                         // transaction via the ChannelMonitor which is missing a corresponding channel.
 322                         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 323                         nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 324                 }
 325         }
 326
 327         if reorg_after_reload {
 328                 if use_funding_unconfirmed {
 329                         let relevant_txids = nodes[0].node.get_relevant_txids();
 330                         assert_eq!(relevant_txids.len(), 1);
 331                         let block_hash_opt = relevant_txids[0].1;
 332                         let expected_hash = nodes[0].get_block_header(chan_conf_height).block_hash();
 333                         assert_eq!(block_hash_opt, Some(expected_hash));
 334                         let txid = relevant_txids[0].0;
 335                         assert_eq!(txid, chan.3.txid());
 336                         nodes[0].node.transaction_unconfirmed(&txid);
 337                 } else if connect_style == ConnectStyle::FullBlockViaListen {
 338                         disconnect_blocks(&nodes[0], CHAN_CONFIRM_DEPTH - 1);
 339                         assert_eq!(nodes[0].node.list_channels().len(), 1);
 340                         disconnect_blocks(&nodes[0], 1);
 341                 } else {
 342                         disconnect_all_blocks(&nodes[0]);
 343                 }
 344
 345                 let relevant_txids = nodes[0].node.get_relevant_txids();
 346                 assert_eq!(relevant_txids.len(), 0);
 347
 348                 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.");
 349                 check_added_monitors!(nodes[1], 1);
 350                 {
 351                         let channel_state = nodes[0].node.channel_state.lock().unwrap();
 352                         assert_eq!(channel_state.by_id.len(), 0);
 353                         assert_eq!(nodes[0].node.short_to_chan_info.read().unwrap().len(), 0);
 354                 }
 355         }
 356         // With expect_channel_force_closed set the TestChainMonitor will enforce that the next update
 357         // is a ChannelForcClosed on the right channel with should_broadcast set.
 358         *nodes[0].chain_monitor.expect_channel_force_closed.lock().unwrap() = Some((chan.2, true));
 359         nodes[0].node.test_process_background_events(); // Required to free the pending background monitor update
 360         check_added_monitors!(nodes[0], 1);
 361         let expected_err = "Funding transaction was un-confirmed. Locked at 6 confs, now have 0 confs.";
 362         check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyForceClosed { peer_msg: "Channel closed because of an exception: ".to_owned() + expected_err });
 363         check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: expected_err.to_owned() });
 364         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 365         nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 366
 367         // Now check that we can create a new channel
 368         create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
 369         send_payment(&nodes[0], &[&nodes[1]], 8000000);
 370 }
 371
 372 #[test]
 373 fn test_unconf_chan() {
 374         do_test_unconf_chan(true, true, false, ConnectStyle::BestBlockFirstSkippingBlocks);
 375         do_test_unconf_chan(false, true, false, ConnectStyle::BestBlockFirstSkippingBlocks);
 376         do_test_unconf_chan(true, false, false, ConnectStyle::BestBlockFirstSkippingBlocks);
 377         do_test_unconf_chan(false, false, false, ConnectStyle::BestBlockFirstSkippingBlocks);
 378
 379         do_test_unconf_chan(true, true, false, ConnectStyle::BestBlockFirstReorgsOnlyTip);
 380         do_test_unconf_chan(false, true, false, ConnectStyle::BestBlockFirstReorgsOnlyTip);
 381         do_test_unconf_chan(true, false, false, ConnectStyle::BestBlockFirstReorgsOnlyTip);
 382         do_test_unconf_chan(false, false, false, ConnectStyle::BestBlockFirstReorgsOnlyTip);
 383 }
 384
 385 #[test]
 386 fn test_unconf_chan_via_listen() {
 387         do_test_unconf_chan(true, true, false, ConnectStyle::FullBlockViaListen);
 388         do_test_unconf_chan(false, true, false, ConnectStyle::FullBlockViaListen);
 389         do_test_unconf_chan(true, false, false, ConnectStyle::FullBlockViaListen);
 390         do_test_unconf_chan(false, false, false, ConnectStyle::FullBlockViaListen);
 391 }
 392
 393 #[test]
 394 fn test_unconf_chan_via_funding_unconfirmed() {
 395         do_test_unconf_chan(true, true, true, ConnectStyle::BestBlockFirstSkippingBlocks);
 396         do_test_unconf_chan(false, true, true, ConnectStyle::BestBlockFirstSkippingBlocks);
 397         do_test_unconf_chan(true, false, true, ConnectStyle::BestBlockFirstSkippingBlocks);
 398         do_test_unconf_chan(false, false, true, ConnectStyle::BestBlockFirstSkippingBlocks);
 399
 400         do_test_unconf_chan(true, true, true, ConnectStyle::BestBlockFirstReorgsOnlyTip);
 401         do_test_unconf_chan(false, true, true, ConnectStyle::BestBlockFirstReorgsOnlyTip);
 402         do_test_unconf_chan(true, false, true, ConnectStyle::BestBlockFirstReorgsOnlyTip);
 403         do_test_unconf_chan(false, false, true, ConnectStyle::BestBlockFirstReorgsOnlyTip);
 404
 405         do_test_unconf_chan(true, true, true, ConnectStyle::FullBlockViaListen);
 406         do_test_unconf_chan(false, true, true, ConnectStyle::FullBlockViaListen);
 407         do_test_unconf_chan(true, false, true, ConnectStyle::FullBlockViaListen);
 408         do_test_unconf_chan(false, false, true, ConnectStyle::FullBlockViaListen);
 409 }
 410
 411 #[test]
 412 fn test_set_outpoints_partial_claiming() {
 413         // - remote party claim tx, new bump tx
 414         // - disconnect remote claiming tx, new bump
 415         // - disconnect tx, see no tx anymore
 416         let chanmon_cfgs = create_chanmon_cfgs(2);
 417         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 418         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 419         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 420
 421         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, channelmanager::provided_init_features(), channelmanager::provided_init_features());
 422         let (payment_preimage_1, payment_hash_1, _) = route_payment(&nodes[1], &[&nodes[0]], 3_000_000);
 423         let (payment_preimage_2, payment_hash_2, _) = route_payment(&nodes[1], &[&nodes[0]], 3_000_000);
 424
 425         // Remote commitment txn with 4 outputs: to_local, to_remote, 2 outgoing HTLC
 426         let remote_txn = get_local_commitment_txn!(nodes[1], chan.2);
 427         assert_eq!(remote_txn.len(), 3);
 428         assert_eq!(remote_txn[0].output.len(), 4);
 429         assert_eq!(remote_txn[0].input.len(), 1);
 430         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
 431         check_spends!(remote_txn[1], remote_txn[0]);
 432         check_spends!(remote_txn[2], remote_txn[0]);
 433
 434         // Connect blocks on node A to advance height towards TEST_FINAL_CLTV
 435         // Provide node A with both preimage
 436         nodes[0].node.claim_funds(payment_preimage_1);
 437         expect_payment_claimed!(nodes[0], payment_hash_1, 3_000_000);
 438         nodes[0].node.claim_funds(payment_preimage_2);
 439         expect_payment_claimed!(nodes[0], payment_hash_2, 3_000_000);
 440         check_added_monitors!(nodes[0], 2);
 441         nodes[0].node.get_and_clear_pending_msg_events();
 442
 443         // Connect blocks on node A commitment transaction
 444         mine_transaction(&nodes[0], &remote_txn[0]);
 445         check_closed_broadcast!(nodes[0], true);
 446         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
 447         check_added_monitors!(nodes[0], 1);
 448         // Verify node A broadcast tx claiming both HTLCs
 449         {
 450                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
 451                 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-Success*2
 452                 assert_eq!(node_txn.len(), 4);
 453                 check_spends!(node_txn[0], remote_txn[0]);
 454                 check_spends!(node_txn[1], chan.3);
 455                 check_spends!(node_txn[2], node_txn[1]);
 456                 check_spends!(node_txn[3], node_txn[1]);
 457                 assert_eq!(node_txn[0].input.len(), 2);
 458                 node_txn.clear();
 459         }
 460
 461         // Connect blocks on node B
 462         connect_blocks(&nodes[1], 135);
 463         check_closed_broadcast!(nodes[1], true);
 464         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
 465         check_added_monitors!(nodes[1], 1);
 466         // Verify node B broadcast 2 HTLC-timeout txn
 467         let partial_claim_tx = {
 468                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
 469                 assert_eq!(node_txn.len(), 3);
 470                 check_spends!(node_txn[1], node_txn[0]);
 471                 check_spends!(node_txn[2], node_txn[0]);
 472                 assert_eq!(node_txn[1].input.len(), 1);
 473                 assert_eq!(node_txn[2].input.len(), 1);
 474                 node_txn[1].clone()
 475         };
 476
 477         // Broadcast partial claim on node A, should regenerate a claiming tx with HTLC dropped
 478         mine_transaction(&nodes[0], &partial_claim_tx);
 479         {
 480                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
 481                 assert_eq!(node_txn.len(), 1);
 482                 check_spends!(node_txn[0], remote_txn[0]);
 483                 assert_eq!(node_txn[0].input.len(), 1); //dropped HTLC
 484                 node_txn.clear();
 485         }
 486         nodes[0].node.get_and_clear_pending_msg_events();
 487
 488         // Disconnect last block on node A, should regenerate a claiming tx with HTLC dropped
 489         disconnect_blocks(&nodes[0], 1);
 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(), 2); //resurrected HTLC
 495                 node_txn.clear();
 496         }
 497
 498         //// Disconnect one more block and then reconnect multiple no transaction should be generated
 499         disconnect_blocks(&nodes[0], 1);
 500         connect_blocks(&nodes[0], 15);
 501         {
 502                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
 503                 assert_eq!(node_txn.len(), 0);
 504                 node_txn.clear();
 505         }
 506 }
 507
 508 fn do_test_to_remote_after_local_detection(style: ConnectStyle) {
 509         // In previous code, detection of to_remote outputs in a counterparty commitment transaction
 510         // was dependent on whether a local commitment transaction had been seen on-chain previously.
 511         // This resulted in some edge cases around not being able to generate a SpendableOutput event
 512         // after a reorg.
 513         //
 514         // Here, we test this by first confirming one set of commitment transactions, then
 515         // disconnecting them and reconnecting another. We then confirm them and check that the correct
 516         // SpendableOutput event is generated.
 517         let chanmon_cfgs = create_chanmon_cfgs(2);
 518         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 519         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 520         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 521
 522         *nodes[0].connect_style.borrow_mut() = style;
 523         *nodes[1].connect_style.borrow_mut() = style;
 524
 525         let (_, _, chan_id, funding_tx) =
 526                 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 100_000_000, channelmanager::provided_init_features(), channelmanager::provided_init_features());
 527         let funding_outpoint = OutPoint { txid: funding_tx.txid(), index: 0 };
 528         assert_eq!(funding_outpoint.to_channel_id(), chan_id);
 529
 530         let remote_txn_a = get_local_commitment_txn!(nodes[0], chan_id);
 531         let remote_txn_b = get_local_commitment_txn!(nodes[1], chan_id);
 532
 533         mine_transaction(&nodes[0], &remote_txn_a[0]);
 534         mine_transaction(&nodes[1], &remote_txn_a[0]);
 535
 536         assert!(nodes[0].node.list_channels().is_empty());
 537         check_closed_broadcast!(nodes[0], true);
 538         check_added_monitors!(nodes[0], 1);
 539         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
 540         assert!(nodes[1].node.list_channels().is_empty());
 541         check_closed_broadcast!(nodes[1], true);
 542         check_added_monitors!(nodes[1], 1);
 543         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
 544
 545         // Drop transactions broadcasted in response to the first commitment transaction (we have good
 546         // test coverage of these things already elsewhere).
 547         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0).len(), 1);
 548         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0).len(), 1);
 549
 550         assert!(nodes[0].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
 551         assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
 552
 553         disconnect_blocks(&nodes[0], 1);
 554         disconnect_blocks(&nodes[1], 1);
 555
 556         assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
 557         assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
 558         assert!(nodes[0].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
 559         assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
 560
 561         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
 562         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
 563
 564         assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
 565         assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
 566         assert!(nodes[0].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
 567         assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
 568
 569         mine_transaction(&nodes[0], &remote_txn_b[0]);
 570         mine_transaction(&nodes[1], &remote_txn_b[0]);
 571
 572         assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
 573         assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
 574         assert!(nodes[0].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
 575         assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
 576
 577         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
 578         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
 579
 580         let mut node_a_spendable = nodes[0].chain_monitor.chain_monitor.get_and_clear_pending_events();
 581         assert_eq!(node_a_spendable.len(), 1);
 582         if let Event::SpendableOutputs { outputs } = node_a_spendable.pop().unwrap() {
 583                 assert_eq!(outputs.len(), 1);
 584                 let spend_tx = nodes[0].keys_manager.backing.spend_spendable_outputs(&[&outputs[0]], Vec::new(),
 585                         Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, &Secp256k1::new()).unwrap();
 586                 check_spends!(spend_tx, remote_txn_b[0]);
 587         }
 588
 589         // nodes[1] is waiting for the to_self_delay to expire, which is many more than
 590         // ANTI_REORG_DELAY. Instead, walk it back and confirm the original remote_txn_a commitment
 591         // again and check that nodes[1] generates a similar spendable output.
 592         // Technically a reorg of ANTI_REORG_DELAY violates our assumptions, so this is undefined by
 593         // our API spec, but we currently handle this correctly and there's little reason we shouldn't
 594         // in the future.
 595         assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
 596         disconnect_blocks(&nodes[1], ANTI_REORG_DELAY);
 597         mine_transaction(&nodes[1], &remote_txn_a[0]);
 598         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
 599
 600         let mut node_b_spendable = nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events();
 601         assert_eq!(node_b_spendable.len(), 1);
 602         if let Event::SpendableOutputs { outputs } = node_b_spendable.pop().unwrap() {
 603                 assert_eq!(outputs.len(), 1);
 604                 let spend_tx = nodes[1].keys_manager.backing.spend_spendable_outputs(&[&outputs[0]], Vec::new(),
 605                         Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, &Secp256k1::new()).unwrap();
 606                 check_spends!(spend_tx, remote_txn_a[0]);
 607         }
 608 }
 609
 610 #[test]
 611 fn test_to_remote_after_local_detection() {
 612         do_test_to_remote_after_local_detection(ConnectStyle::BestBlockFirst);
 613         do_test_to_remote_after_local_detection(ConnectStyle::BestBlockFirstSkippingBlocks);
 614         do_test_to_remote_after_local_detection(ConnectStyle::BestBlockFirstReorgsOnlyTip);
 615         do_test_to_remote_after_local_detection(ConnectStyle::TransactionsFirst);
 616         do_test_to_remote_after_local_detection(ConnectStyle::TransactionsFirstSkippingBlocks);
 617         do_test_to_remote_after_local_detection(ConnectStyle::TransactionsFirstReorgsOnlyTip);
 618         do_test_to_remote_after_local_detection(ConnectStyle::FullBlockViaListen);
 619 }