_ 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::ChannelManager;
  16 use crate::ln::msgs::{ChannelMessageHandler, Init};
  17 use crate::util::events::{Event, MessageSendEventsProvider, ClosureReason, HTLCDestination};
  18 use crate::util::test_utils;
  19 use crate::util::ser::Writeable;
  20 use crate::util::string::UntrustedString;
  21
  22 use bitcoin::blockdata::block::{Block, BlockHeader};
  23 use bitcoin::blockdata::script::Builder;
  24 use bitcoin::blockdata::opcodes;
  25 use bitcoin::secp256k1::Secp256k1;
  26
  27 use crate::prelude::*;
  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);
  55         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
  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(), 1); // ChannelMonitor: 1 offered HTLC-Claim
  86                 check_spends!(node_2_commitment_txn[0], node_1_commitment_txn[0]);
  87
  88                 // Make sure node 1's height is the same as the !local_commitment case
  89                 connect_blocks(&nodes[1], 1);
  90                 // Confirm node 1's commitment txn (and HTLC-Timeout) on node 1
  91                 header.prev_blockhash = nodes[1].best_block_hash();
  92                 connect_block(&nodes[1], &Block { header, txdata: node_1_commitment_txn.clone() });
  93
  94                 // ...but return node 1's commitment tx in case claim is set and we're preparing to reorg
  95                 vec![node_1_commitment_txn[0].clone(), node_2_commitment_txn[0].clone()]
  96         } else {
  97                 // Broadcast node 2 commitment txn
  98                 let mut node_2_commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
  99                 assert_eq!(node_2_commitment_txn.len(), 2); // 1 local commitment tx, 1 Received HTLC-Claim
 100                 assert_eq!(node_2_commitment_txn[0].output.len(), 2); // to-remote and Received HTLC (to-self is dust)
 101                 check_spends!(node_2_commitment_txn[0], chan_2.3);
 102                 check_spends!(node_2_commitment_txn[1], node_2_commitment_txn[0]);
 103
 104                 // Give node 1 node 2's commitment transaction and get its response (timing the HTLC out)
 105                 mine_transaction(&nodes[1], &node_2_commitment_txn[0]);
 106                 connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
 107                 let node_1_commitment_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
 108                 assert_eq!(node_1_commitment_txn.len(), 1); // ChannelMonitor: 1 offered HTLC-Timeout
 109                 check_spends!(node_1_commitment_txn[0], node_2_commitment_txn[0]);
 110
 111                 // Confirm node 1's HTLC-Timeout on node 1
 112                 mine_transaction(&nodes[1], &node_1_commitment_txn[0]);
 113                 // ...but return node 2's commitment tx (and claim) in case claim is set and we're preparing to reorg
 114                 vec![node_2_commitment_txn.pop().unwrap()]
 115         };
 116         check_added_monitors!(nodes[1], 1);
 117         check_closed_broadcast!(nodes[1], true); // We should get a BroadcastChannelUpdate (and *only* a BroadcstChannelUpdate)
 118         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
 119         // Connect ANTI_REORG_DELAY - 2 blocks, giving us a confirmation count of ANTI_REORG_DELAY - 1.
 120         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 2);
 121         check_added_monitors!(nodes[1], 0);
 122         assert_eq!(nodes[1].node.get_and_clear_pending_events().len(), 0);
 123
 124         if claim {
 125                 // Disconnect Node 1's HTLC-Timeout which was connected above
 126                 disconnect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
 127
 128                 let block = Block {
 129                         header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 },
 130                         txdata: claim_txn,
 131                 };
 132                 connect_block(&nodes[1], &block);
 133
 134                 // ChannelManager only polls chain::Watch::release_pending_monitor_events when we
 135                 // probe it for events, so we probe non-message events here (which should just be the
 136                 // PaymentForwarded event).
 137                 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), true, true);
 138         } else {
 139                 // Confirm the timeout tx and check that we fail the HTLC backwards
 140                 let block = Block {
 141                         header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 },
 142                         txdata: vec![],
 143                 };
 144                 connect_block(&nodes[1], &block);
 145                 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 }]);
 146         }
 147
 148         check_added_monitors!(nodes[1], 1);
 149         // Which should result in an immediate claim/fail of the HTLC:
 150         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 151         if claim {
 152                 assert_eq!(htlc_updates.update_fulfill_htlcs.len(), 1);
 153                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fulfill_htlcs[0]);
 154         } else {
 155                 assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
 156                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
 157         }
 158         commitment_signed_dance!(nodes[0], nodes[1], htlc_updates.commitment_signed, false, true);
 159         if claim {
 160                 expect_payment_sent!(nodes[0], our_payment_preimage);
 161         } else {
 162                 expect_payment_failed_with_update!(nodes[0], our_payment_hash, false, chan_2.0.contents.short_channel_id, true);
 163         }
 164 }
 165
 166 #[test]
 167 fn test_onchain_htlc_claim_reorg_local_commitment() {
 168         do_test_onchain_htlc_reorg(true, true);
 169 }
 170 #[test]
 171 fn test_onchain_htlc_timeout_delay_local_commitment() {
 172         do_test_onchain_htlc_reorg(true, false);
 173 }
 174 #[test]
 175 fn test_onchain_htlc_claim_reorg_remote_commitment() {
 176         do_test_onchain_htlc_reorg(false, true);
 177 }
 178 #[test]
 179 fn test_onchain_htlc_timeout_delay_remote_commitment() {
 180         do_test_onchain_htlc_reorg(false, false);
 181 }
 182
 183 #[test]
 184 fn test_counterparty_revoked_reorg() {
 185         // Test what happens when a revoked counterparty transaction is broadcast but then reorg'd out
 186         // of the main chain. Specifically, HTLCs in the latest commitment transaction which are not
 187         // included in the revoked commitment transaction should not be considered failed, and should
 188         // still be claim-from-able after the reorg.
 189         let chanmon_cfgs = create_chanmon_cfgs(2);
 190         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 191         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 192         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 193
 194         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000);
 195
 196         // Get the initial commitment transaction for broadcast, before any HTLCs are added at all.
 197         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
 198         assert_eq!(revoked_local_txn.len(), 1);
 199
 200         // Now add two HTLCs in each direction, one dust and one not.
 201         route_payment(&nodes[0], &[&nodes[1]], 5_000_000);
 202         route_payment(&nodes[0], &[&nodes[1]], 5_000);
 203         let (payment_preimage_3, payment_hash_3, ..) = route_payment(&nodes[1], &[&nodes[0]], 4_000_000);
 204         let payment_hash_4 = route_payment(&nodes[1], &[&nodes[0]], 4_000).1;
 205
 206         nodes[0].node.claim_funds(payment_preimage_3);
 207         let _ = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 208         check_added_monitors!(nodes[0], 1);
 209         expect_payment_claimed!(nodes[0], payment_hash_3, 4_000_000);
 210
 211         let mut unrevoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
 212         assert_eq!(unrevoked_local_txn.len(), 3); // commitment + 2 HTLC txn
 213         // Sort the unrevoked transactions in reverse order, ie commitment tx, then HTLC 1 then HTLC 3
 214         unrevoked_local_txn.sort_unstable_by_key(|tx| 1_000_000 - tx.output.iter().map(|outp| outp.value).sum::<u64>());
 215
 216         // Now mine A's old commitment transaction, which should close the channel, but take no action
 217         // on any of the HTLCs, at least until we get six confirmations (which we won't get).
 218         mine_transaction(&nodes[1], &revoked_local_txn[0]);
 219         check_added_monitors!(nodes[1], 1);
 220         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
 221         check_closed_broadcast!(nodes[1], true);
 222
 223         // Connect up to one block before the revoked transaction would be considered final, then do a
 224         // reorg that disconnects the full chain and goes up to the height at which the revoked
 225         // transaction would be final.
 226         let theoretical_conf_height = nodes[1].best_block_info().1 + ANTI_REORG_DELAY - 1;
 227         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 2);
 228         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 229         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
 230
 231         disconnect_all_blocks(&nodes[1]);
 232         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 233         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
 234
 235         connect_blocks(&nodes[1], theoretical_conf_height);
 236         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 237         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
 238
 239         // Now connect A's latest commitment transaction instead and resolve the HTLCs
 240         mine_transaction(&nodes[1], &unrevoked_local_txn[0]);
 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         // Connect the HTLC claim transaction for HTLC 3
 245         mine_transaction(&nodes[1], &unrevoked_local_txn[2]);
 246         expect_payment_sent!(nodes[1], payment_preimage_3);
 247         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 248
 249         // Connect blocks to confirm the unrevoked commitment transaction
 250         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 2);
 251         expect_payment_failed!(nodes[1], payment_hash_4, false);
 252 }
 253
 254 fn do_test_unconf_chan(reload_node: bool, reorg_after_reload: bool, use_funding_unconfirmed: bool, connect_style: ConnectStyle) {
 255         // After creating a chan between nodes, we disconnect all blocks previously seen to force a
 256         // channel close on nodes[0] side. We also use this to provide very basic testing of logic
 257         // around freeing background events which store monitor updates during block_[dis]connected.
 258         let chanmon_cfgs = create_chanmon_cfgs(2);
 259         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 260         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 261         let persister: test_utils::TestPersister;
 262         let new_chain_monitor: test_utils::TestChainMonitor;
 263         let nodes_0_deserialized: ChannelManager<&test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestKeysInterface, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestRouter, &test_utils::TestLogger>;
 264         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 265         *nodes[0].connect_style.borrow_mut() = connect_style;
 266
 267         let chan_conf_height = core::cmp::max(nodes[0].best_block_info().1 + 1, nodes[1].best_block_info().1 + 1);
 268         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
 269
 270         {
 271                 let per_peer_state = nodes[0].node.per_peer_state.read().unwrap();
 272                 let peer_state = per_peer_state.get(&nodes[1].node.get_our_node_id()).unwrap().lock().unwrap();
 273                 assert_eq!(peer_state.channel_by_id.len(), 1);
 274                 assert_eq!(nodes[0].node.short_to_chan_info.read().unwrap().len(), 2);
 275         }
 276
 277         assert_eq!(nodes[0].node.list_channels()[0].confirmations, Some(10));
 278         assert_eq!(nodes[1].node.list_channels()[0].confirmations, Some(10));
 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                         assert_eq!(nodes[0].node.list_usable_channels().len(), 0);
 291                 } else if connect_style == ConnectStyle::FullBlockViaListen {
 292                         disconnect_blocks(&nodes[0], CHAN_CONFIRM_DEPTH - 1);
 293                         assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
 294                         assert_eq!(nodes[0].node.list_channels()[0].confirmations, Some(1));
 295                         disconnect_blocks(&nodes[0], 1);
 296                         assert_eq!(nodes[0].node.list_usable_channels().len(), 0);
 297                 } else {
 298                         disconnect_all_blocks(&nodes[0]);
 299                         assert_eq!(nodes[0].node.list_usable_channels().len(), 0);
 300                 }
 301
 302                 let relevant_txids = nodes[0].node.get_relevant_txids();
 303                 assert_eq!(relevant_txids.len(), 0);
 304
 305                 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.");
 306                 check_added_monitors!(nodes[1], 1);
 307                 {
 308                         let per_peer_state = nodes[0].node.per_peer_state.read().unwrap();
 309                         let peer_state = per_peer_state.get(&nodes[1].node.get_our_node_id()).unwrap().lock().unwrap();
 310                         assert_eq!(peer_state.channel_by_id.len(), 0);
 311                         assert_eq!(nodes[0].node.short_to_chan_info.read().unwrap().len(), 0);
 312                 }
 313         }
 314
 315         if reload_node {
 316                 // Since we currently have a background event pending, it's good to test that we survive a
 317                 // serialization roundtrip. Further, this tests the somewhat awkward edge-case of dropping
 318                 // the Channel object from the ChannelManager, but still having a monitor event pending for
 319                 // it when we go to deserialize, and then use the ChannelManager.
 320                 let nodes_0_serialized = nodes[0].node.encode();
 321                 let chan_0_monitor_serialized = get_monitor!(nodes[0], chan.2).encode();
 322
 323                 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);
 324                 if !reorg_after_reload {
 325                         // If the channel is already closed when we reload the node, we'll broadcast a closing
 326                         // transaction via the ChannelMonitor which is missing a corresponding channel.
 327                         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 328                         nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 329                 }
 330         }
 331
 332         if reorg_after_reload {
 333                 if use_funding_unconfirmed {
 334                         let relevant_txids = nodes[0].node.get_relevant_txids();
 335                         assert_eq!(relevant_txids.len(), 1);
 336                         let block_hash_opt = relevant_txids[0].1;
 337                         let expected_hash = nodes[0].get_block_header(chan_conf_height).block_hash();
 338                         assert_eq!(block_hash_opt, Some(expected_hash));
 339                         let txid = relevant_txids[0].0;
 340                         assert_eq!(txid, chan.3.txid());
 341                         nodes[0].node.transaction_unconfirmed(&txid);
 342                         assert_eq!(nodes[0].node.list_channels().len(), 0);
 343                 } else if connect_style == ConnectStyle::FullBlockViaListen {
 344                         disconnect_blocks(&nodes[0], CHAN_CONFIRM_DEPTH - 1);
 345                         assert_eq!(nodes[0].node.list_channels().len(), 1);
 346                         assert_eq!(nodes[0].node.list_channels()[0].confirmations, Some(1));
 347                         disconnect_blocks(&nodes[0], 1);
 348                         assert_eq!(nodes[0].node.list_usable_channels().len(), 0);
 349                 } else {
 350                         disconnect_all_blocks(&nodes[0]);
 351                         assert_eq!(nodes[0].node.list_usable_channels().len(), 0);
 352                 }
 353
 354                 let relevant_txids = nodes[0].node.get_relevant_txids();
 355                 assert_eq!(relevant_txids.len(), 0);
 356
 357                 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.");
 358                 check_added_monitors!(nodes[1], 1);
 359                 {
 360                         let per_peer_state = nodes[0].node.per_peer_state.read().unwrap();
 361                         let peer_state = per_peer_state.get(&nodes[1].node.get_our_node_id()).unwrap().lock().unwrap();
 362                         assert_eq!(peer_state.channel_by_id.len(), 0);
 363                         assert_eq!(nodes[0].node.short_to_chan_info.read().unwrap().len(), 0);
 364                 }
 365         }
 366         // With expect_channel_force_closed set the TestChainMonitor will enforce that the next update
 367         // is a ChannelForcClosed on the right channel with should_broadcast set.
 368         *nodes[0].chain_monitor.expect_channel_force_closed.lock().unwrap() = Some((chan.2, true));
 369         nodes[0].node.test_process_background_events(); // Required to free the pending background monitor update
 370         check_added_monitors!(nodes[0], 1);
 371         let expected_err = "Funding transaction was un-confirmed. Locked at 6 confs, now have 0 confs.";
 372         check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyForceClosed { peer_msg: UntrustedString(format!("Channel closed because of an exception: {}", expected_err)) });
 373         check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: expected_err.to_owned() });
 374         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 375         nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 376
 377         // Now check that we can create a new channel
 378         if reload_node && nodes[0].node.per_peer_state.read().unwrap().len() == 0 {
 379                 // If we dropped the channel before reloading the node, nodes[1] was also dropped from
 380                 // nodes[0] storage, and hence not connected again on startup. We therefore need to
 381                 // reconnect to the node before attempting to create a new channel.
 382                 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &Init { features: nodes[1].node.init_features(), remote_network_address: None }, true).unwrap();
 383         }
 384         create_announced_chan_between_nodes(&nodes, 0, 1);
 385         send_payment(&nodes[0], &[&nodes[1]], 8000000);
 386 }
 387
 388 #[test]
 389 fn test_unconf_chan() {
 390         do_test_unconf_chan(true, true, false, ConnectStyle::BestBlockFirstSkippingBlocks);
 391         do_test_unconf_chan(false, true, false, ConnectStyle::BestBlockFirstSkippingBlocks);
 392         do_test_unconf_chan(true, false, false, ConnectStyle::BestBlockFirstSkippingBlocks);
 393         do_test_unconf_chan(false, false, false, ConnectStyle::BestBlockFirstSkippingBlocks);
 394
 395         do_test_unconf_chan(true, true, false, ConnectStyle::BestBlockFirstReorgsOnlyTip);
 396         do_test_unconf_chan(false, true, false, ConnectStyle::BestBlockFirstReorgsOnlyTip);
 397         do_test_unconf_chan(true, false, false, ConnectStyle::BestBlockFirstReorgsOnlyTip);
 398         do_test_unconf_chan(false, false, false, ConnectStyle::BestBlockFirstReorgsOnlyTip);
 399 }
 400
 401 #[test]
 402 fn test_unconf_chan_via_listen() {
 403         do_test_unconf_chan(true, true, false, ConnectStyle::FullBlockViaListen);
 404         do_test_unconf_chan(false, true, false, ConnectStyle::FullBlockViaListen);
 405         do_test_unconf_chan(true, false, false, ConnectStyle::FullBlockViaListen);
 406         do_test_unconf_chan(false, false, false, ConnectStyle::FullBlockViaListen);
 407 }
 408
 409 #[test]
 410 fn test_unconf_chan_via_funding_unconfirmed() {
 411         do_test_unconf_chan(true, true, true, ConnectStyle::BestBlockFirstSkippingBlocks);
 412         do_test_unconf_chan(false, true, true, ConnectStyle::BestBlockFirstSkippingBlocks);
 413         do_test_unconf_chan(true, false, true, ConnectStyle::BestBlockFirstSkippingBlocks);
 414         do_test_unconf_chan(false, false, true, ConnectStyle::BestBlockFirstSkippingBlocks);
 415
 416         do_test_unconf_chan(true, true, true, ConnectStyle::BestBlockFirstReorgsOnlyTip);
 417         do_test_unconf_chan(false, true, true, ConnectStyle::BestBlockFirstReorgsOnlyTip);
 418         do_test_unconf_chan(true, false, true, ConnectStyle::BestBlockFirstReorgsOnlyTip);
 419         do_test_unconf_chan(false, false, true, ConnectStyle::BestBlockFirstReorgsOnlyTip);
 420
 421         do_test_unconf_chan(true, true, true, ConnectStyle::FullBlockViaListen);
 422         do_test_unconf_chan(false, true, true, ConnectStyle::FullBlockViaListen);
 423         do_test_unconf_chan(true, false, true, ConnectStyle::FullBlockViaListen);
 424         do_test_unconf_chan(false, false, true, ConnectStyle::FullBlockViaListen);
 425 }
 426
 427 #[test]
 428 fn test_set_outpoints_partial_claiming() {
 429         // - remote party claim tx, new bump tx
 430         // - disconnect remote claiming tx, new bump
 431         // - disconnect tx, see no tx anymore
 432         let chanmon_cfgs = create_chanmon_cfgs(2);
 433         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 434         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 435         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 436
 437         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000);
 438         let (payment_preimage_1, payment_hash_1, _) = route_payment(&nodes[1], &[&nodes[0]], 3_000_000);
 439         let (payment_preimage_2, payment_hash_2, _) = route_payment(&nodes[1], &[&nodes[0]], 3_000_000);
 440
 441         // Remote commitment txn with 4 outputs: to_local, to_remote, 2 outgoing HTLC
 442         let remote_txn = get_local_commitment_txn!(nodes[1], chan.2);
 443         assert_eq!(remote_txn.len(), 3);
 444         assert_eq!(remote_txn[0].output.len(), 4);
 445         assert_eq!(remote_txn[0].input.len(), 1);
 446         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
 447         check_spends!(remote_txn[1], remote_txn[0]);
 448         check_spends!(remote_txn[2], remote_txn[0]);
 449
 450         // Connect blocks on node A to advance height towards TEST_FINAL_CLTV
 451         // Provide node A with both preimage
 452         nodes[0].node.claim_funds(payment_preimage_1);
 453         expect_payment_claimed!(nodes[0], payment_hash_1, 3_000_000);
 454         nodes[0].node.claim_funds(payment_preimage_2);
 455         expect_payment_claimed!(nodes[0], payment_hash_2, 3_000_000);
 456         check_added_monitors!(nodes[0], 2);
 457         nodes[0].node.get_and_clear_pending_msg_events();
 458
 459         // Connect blocks on node A commitment transaction
 460         mine_transaction(&nodes[0], &remote_txn[0]);
 461         check_closed_broadcast!(nodes[0], true);
 462         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
 463         check_added_monitors!(nodes[0], 1);
 464         // Verify node A broadcast tx claiming both HTLCs
 465         {
 466                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
 467                 // ChannelMonitor: claim tx
 468                 assert_eq!(node_txn.len(), 1);
 469                 check_spends!(node_txn[0], remote_txn[0]);
 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);
 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         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         disconnect_blocks(&nodes[0], 1);
 562         disconnect_blocks(&nodes[1], 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         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
 570         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
 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         mine_transaction(&nodes[0], &remote_txn_b[0]);
 578         mine_transaction(&nodes[1], &remote_txn_b[0]);
 579
 580         assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
 581         assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
 582         assert!(nodes[0].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
 583         assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
 584
 585         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
 586         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
 587
 588         let mut node_a_spendable = nodes[0].chain_monitor.chain_monitor.get_and_clear_pending_events();
 589         assert_eq!(node_a_spendable.len(), 1);
 590         if let Event::SpendableOutputs { outputs } = node_a_spendable.pop().unwrap() {
 591                 assert_eq!(outputs.len(), 1);
 592                 let spend_tx = nodes[0].keys_manager.backing.spend_spendable_outputs(&[&outputs[0]], Vec::new(),
 593                         Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, &Secp256k1::new()).unwrap();
 594                 check_spends!(spend_tx, remote_txn_b[0]);
 595         }
 596
 597         // nodes[1] is waiting for the to_self_delay to expire, which is many more than
 598         // ANTI_REORG_DELAY. Instead, walk it back and confirm the original remote_txn_a commitment
 599         // again and check that nodes[1] generates a similar spendable output.
 600         // Technically a reorg of ANTI_REORG_DELAY violates our assumptions, so this is undefined by
 601         // our API spec, but we currently handle this correctly and there's little reason we shouldn't
 602         // in the future.
 603         assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
 604         disconnect_blocks(&nodes[1], ANTI_REORG_DELAY);
 605         mine_transaction(&nodes[1], &remote_txn_a[0]);
 606         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
 607
 608         let mut node_b_spendable = nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events();
 609         assert_eq!(node_b_spendable.len(), 1);
 610         if let Event::SpendableOutputs { outputs } = node_b_spendable.pop().unwrap() {
 611                 assert_eq!(outputs.len(), 1);
 612                 let spend_tx = nodes[1].keys_manager.backing.spend_spendable_outputs(&[&outputs[0]], Vec::new(),
 613                         Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, &Secp256k1::new()).unwrap();
 614                 check_spends!(spend_tx, remote_txn_a[0]);
 615         }
 616 }
 617
 618 #[test]
 619 fn test_to_remote_after_local_detection() {
 620         do_test_to_remote_after_local_detection(ConnectStyle::BestBlockFirst);
 621         do_test_to_remote_after_local_detection(ConnectStyle::BestBlockFirstSkippingBlocks);
 622         do_test_to_remote_after_local_detection(ConnectStyle::BestBlockFirstReorgsOnlyTip);
 623         do_test_to_remote_after_local_detection(ConnectStyle::TransactionsFirst);
 624         do_test_to_remote_after_local_detection(ConnectStyle::TransactionsFirstSkippingBlocks);
 625         do_test_to_remote_after_local_detection(ConnectStyle::TransactionsFirstReorgsOnlyTip);
 626         do_test_to_remote_after_local_detection(ConnectStyle::FullBlockViaListen);
 627 }