_ 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::Watch;
  14 use ln::channelmanager::{ChannelManager, ChannelManagerReadArgs};
  15 use ln::features::InitFeatures;
  16 use ln::msgs::{ChannelMessageHandler, ErrorAction, HTLCFailChannelUpdate};
  17 use util::config::UserConfig;
  18 use util::enforcing_trait_impls::EnforcingSigner;
  19 use util::events::{Event, EventsProvider, MessageSendEvent, MessageSendEventsProvider};
  20 use util::test_utils;
  21 use util::ser::{ReadableArgs, Writeable};
  22
  23 use bitcoin::blockdata::block::{Block, BlockHeader};
  24 use bitcoin::hash_types::BlockHash;
  25
  26 use std::collections::HashMap;
  27 use std::mem;
  28
  29 use ln::functional_test_utils::*;
  30
  31 fn do_test_onchain_htlc_reorg(local_commitment: bool, claim: bool) {
  32         // Our on-chain HTLC-claim learning has a few properties worth testing:
  33         //  * If an upstream HTLC is claimed with a preimage (both against our own commitment
  34         //    transaction our counterparty's), we claim it backwards immediately.
  35         //  * If an upstream HTLC is claimed with a timeout, we delay ANTI_REORG_DELAY before failing
  36         //    it backwards to ensure our counterparty can't claim with a preimage in a reorg.
  37         //
  38         // Here we test both properties in any combination based on the two bools passed in as
  39         // arguments.
  40         //
  41         // If local_commitment is set, we first broadcast a local commitment containing an offered HTLC
  42         // and an HTLC-Timeout tx, otherwise we broadcast a remote commitment containing a received
  43         // HTLC and a local HTLC-Timeout tx spending it.
  44         //
  45         // We then either allow these transactions to confirm (if !claim) or we wait until one block
  46         // before they otherwise would and reorg them out, confirming an HTLC-Success tx instead.
  47         let chanmon_cfgs = create_chanmon_cfgs(3);
  48         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
  49         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
  50         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
  51
  52         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
  53         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
  54
  55         // Make sure all nodes are at the same starting height
  56         connect_blocks(&nodes[0], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
  57         connect_blocks(&nodes[1], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
  58         connect_blocks(&nodes[2], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
  59
  60         let (our_payment_preimage, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
  61
  62         // Provide preimage to node 2 by claiming payment
  63         nodes[2].node.claim_funds(our_payment_preimage, &None, 1000000);
  64         check_added_monitors!(nodes[2], 1);
  65         get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
  66
  67         let mut header = BlockHeader { version: 0x2000_0000, prev_blockhash: nodes[2].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
  68         let claim_txn = if local_commitment {
  69                 // Broadcast node 1 commitment txn to broadcast the HTLC-Timeout
  70                 let node_1_commitment_txn = get_local_commitment_txn!(nodes[1], chan_2.2);
  71                 assert_eq!(node_1_commitment_txn.len(), 2); // 1 local commitment tx, 1 Outbound HTLC-Timeout
  72                 assert_eq!(node_1_commitment_txn[0].output.len(), 2); // to-self and Offered HTLC (to-remote/to-node-3 is dust)
  73                 check_spends!(node_1_commitment_txn[0], chan_2.3);
  74                 check_spends!(node_1_commitment_txn[1], node_1_commitment_txn[0]);
  75
  76                 // Give node 2 node 1's transactions and get its response (claiming the HTLC instead).
  77                 connect_block(&nodes[2], &Block { header, txdata: node_1_commitment_txn.clone() });
  78                 check_added_monitors!(nodes[2], 1);
  79                 check_closed_broadcast!(nodes[2], true); // We should get a BroadcastChannelUpdate (and *only* a BroadcstChannelUpdate)
  80                 let node_2_commitment_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
  81                 assert_eq!(node_2_commitment_txn.len(), 3); // ChannelMonitor: 1 offered HTLC-Claim, ChannelManger: 1 local commitment tx, 1 Received HTLC-Claim
  82                 assert_eq!(node_2_commitment_txn[1].output.len(), 2); // to-remote and Received HTLC (to-self is dust)
  83                 check_spends!(node_2_commitment_txn[1], chan_2.3);
  84                 check_spends!(node_2_commitment_txn[2], node_2_commitment_txn[1]);
  85                 check_spends!(node_2_commitment_txn[0], node_1_commitment_txn[0]);
  86
  87                 // Make sure node 1's height is the same as the !local_commitment case
  88                 connect_blocks(&nodes[1], 1);
  89                 // Confirm node 1's commitment txn (and HTLC-Timeout) on node 1
  90                 header.prev_blockhash = nodes[1].best_block_hash();
  91                 connect_block(&nodes[1], &Block { header, txdata: node_1_commitment_txn.clone() });
  92
  93                 // ...but return node 1's commitment tx in case claim is set and we're preparing to reorg
  94                 vec![node_1_commitment_txn[0].clone(), node_2_commitment_txn[0].clone()]
  95         } else {
  96                 // Broadcast node 2 commitment txn
  97                 let node_2_commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
  98                 assert_eq!(node_2_commitment_txn.len(), 2); // 1 local commitment tx, 1 Received HTLC-Claim
  99                 assert_eq!(node_2_commitment_txn[0].output.len(), 2); // to-remote and Received HTLC (to-self is dust)
 100                 check_spends!(node_2_commitment_txn[0], chan_2.3);
 101                 check_spends!(node_2_commitment_txn[1], node_2_commitment_txn[0]);
 102
 103                 // Give node 1 node 2's commitment transaction and get its response (timing the HTLC out)
 104                 mine_transaction(&nodes[1], &node_2_commitment_txn[0]);
 105                 let node_1_commitment_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
 106                 assert_eq!(node_1_commitment_txn.len(), 3); // ChannelMonitor: 1 offered HTLC-Timeout, ChannelManger: 1 local commitment tx, 1 Offered HTLC-Timeout
 107                 assert_eq!(node_1_commitment_txn[1].output.len(), 2); // to-local and Offered HTLC (to-remote is dust)
 108                 check_spends!(node_1_commitment_txn[1], chan_2.3);
 109                 check_spends!(node_1_commitment_txn[2], node_1_commitment_txn[1]);
 110                 check_spends!(node_1_commitment_txn[0], node_2_commitment_txn[0]);
 111
 112                 // Confirm node 2's commitment txn (and node 1's HTLC-Timeout) on node 1
 113                 header.prev_blockhash = nodes[1].best_block_hash();
 114                 connect_block(&nodes[1], &Block { header, txdata: vec![node_2_commitment_txn[0].clone(), node_1_commitment_txn[0].clone()] });
 115                 // ...but return node 2's commitment tx (and claim) in case claim is set and we're preparing to reorg
 116                 node_2_commitment_txn
 117         };
 118         check_added_monitors!(nodes[1], 1);
 119         check_closed_broadcast!(nodes[1], true); // We should get a BroadcastChannelUpdate (and *only* a BroadcstChannelUpdate)
 120         // Connect ANTI_REORG_DELAY - 2 blocks, giving us a confirmation count of ANTI_REORG_DELAY - 1.
 121         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 2);
 122         check_added_monitors!(nodes[1], 0);
 123         assert_eq!(nodes[1].node.get_and_clear_pending_events().len(), 0);
 124
 125         if claim {
 126                 disconnect_blocks(&nodes[1], ANTI_REORG_DELAY - 2);
 127
 128                 let block = Block {
 129                         header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), 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 still end up empty):
 136                 assert_eq!(nodes[1].node.get_and_clear_pending_events().len(), 0);
 137         } else {
 138                 // Confirm the timeout tx and check that we fail the HTLC backwards
 139                 let block = Block {
 140                         header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
 141                         txdata: vec![],
 142                 };
 143                 connect_block(&nodes[1], &block);
 144                 expect_pending_htlcs_forwardable!(nodes[1]);
 145         }
 146
 147         check_added_monitors!(nodes[1], 1);
 148         // Which should result in an immediate claim/fail of the HTLC:
 149         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 150         if claim {
 151                 assert_eq!(htlc_updates.update_fulfill_htlcs.len(), 1);
 152                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fulfill_htlcs[0]);
 153         } else {
 154                 assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
 155                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
 156         }
 157         commitment_signed_dance!(nodes[0], nodes[1], htlc_updates.commitment_signed, false, true);
 158         if claim {
 159                 expect_payment_sent!(nodes[0], our_payment_preimage);
 160         } else {
 161                 let events = nodes[0].node.get_and_clear_pending_msg_events();
 162                 assert_eq!(events.len(), 1);
 163                 if let MessageSendEvent::PaymentFailureNetworkUpdate { update: HTLCFailChannelUpdate::ChannelClosed { ref is_permanent, .. } } = events[0] {
 164                         assert!(is_permanent);
 165                 } else { panic!("Unexpected event!"); }
 166                 expect_payment_failed!(nodes[0], our_payment_hash, false);
 167         }
 168 }
 169
 170 #[test]
 171 fn test_onchain_htlc_claim_reorg_local_commitment() {
 172         do_test_onchain_htlc_reorg(true, true);
 173 }
 174 #[test]
 175 fn test_onchain_htlc_timeout_delay_local_commitment() {
 176         do_test_onchain_htlc_reorg(true, false);
 177 }
 178 #[test]
 179 fn test_onchain_htlc_claim_reorg_remote_commitment() {
 180         do_test_onchain_htlc_reorg(false, true);
 181 }
 182 #[test]
 183 fn test_onchain_htlc_timeout_delay_remote_commitment() {
 184         do_test_onchain_htlc_reorg(false, false);
 185 }
 186
 187 fn do_test_unconf_chan(reload_node: bool, reorg_after_reload: bool, connect_style: ConnectStyle) {
 188         // After creating a chan between nodes, we disconnect all blocks previously seen to force a
 189         // channel close on nodes[0] side. We also use this to provide very basic testing of logic
 190         // around freeing background events which store monitor updates during block_[dis]connected.
 191         let chanmon_cfgs = create_chanmon_cfgs(2);
 192         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 193         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 194         let persister: test_utils::TestPersister;
 195         let new_chain_monitor: test_utils::TestChainMonitor;
 196         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
 197         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 198         *nodes[0].connect_style.borrow_mut() = connect_style;
 199
 200         let chan_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
 201
 202         let channel_state = nodes[0].node.channel_state.lock().unwrap();
 203         assert_eq!(channel_state.by_id.len(), 1);
 204         assert_eq!(channel_state.short_to_id.len(), 1);
 205         mem::drop(channel_state);
 206
 207         if !reorg_after_reload {
 208                 disconnect_all_blocks(&nodes[0]);
 209                 check_closed_broadcast!(nodes[0], true);
 210                 {
 211                         let channel_state = nodes[0].node.channel_state.lock().unwrap();
 212                         assert_eq!(channel_state.by_id.len(), 0);
 213                         assert_eq!(channel_state.short_to_id.len(), 0);
 214                 }
 215         }
 216
 217         if reload_node {
 218                 // Since we currently have a background event pending, it's good to test that we survive a
 219                 // serialization roundtrip. Further, this tests the somewhat awkward edge-case of dropping
 220                 // the Channel object from the ChannelManager, but still having a monitor event pending for
 221                 // it when we go to deserialize, and then use the ChannelManager.
 222                 let nodes_0_serialized = nodes[0].node.encode();
 223                 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
 224                 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
 225
 226                 persister = test_utils::TestPersister::new();
 227                 let keys_manager = &chanmon_cfgs[0].keys_manager;
 228                 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);
 229                 nodes[0].chain_monitor = &new_chain_monitor;
 230                 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
 231                 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
 232                         &mut chan_0_monitor_read, keys_manager).unwrap();
 233                 assert!(chan_0_monitor_read.is_empty());
 234
 235                 let mut nodes_0_read = &nodes_0_serialized[..];
 236                 let config = UserConfig::default();
 237                 nodes_0_deserialized = {
 238                         let mut channel_monitors = HashMap::new();
 239                         channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
 240                         <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster,
 241                           &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(
 242                                 &mut nodes_0_read, ChannelManagerReadArgs {
 243                                         default_config: config,
 244                                         keys_manager,
 245                                         fee_estimator: node_cfgs[0].fee_estimator,
 246                                         chain_monitor: nodes[0].chain_monitor,
 247                                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
 248                                         logger: nodes[0].logger,
 249                                         channel_monitors,
 250                         }).unwrap().1
 251                 };
 252                 nodes[0].node = &nodes_0_deserialized;
 253                 assert!(nodes_0_read.is_empty());
 254
 255                 nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0.clone(), chan_0_monitor).unwrap();
 256                 check_added_monitors!(nodes[0], 1);
 257         }
 258
 259         if reorg_after_reload {
 260                 disconnect_all_blocks(&nodes[0]);
 261                 check_closed_broadcast!(nodes[0], true);
 262                 {
 263                         let channel_state = nodes[0].node.channel_state.lock().unwrap();
 264                         assert_eq!(channel_state.by_id.len(), 0);
 265                         assert_eq!(channel_state.short_to_id.len(), 0);
 266                 }
 267         }
 268         // With expect_channel_force_closed set the TestChainMonitor will enforce that the next update
 269         // is a ChannelForcClosed on the right channel with should_broadcast set.
 270         *nodes[0].chain_monitor.expect_channel_force_closed.lock().unwrap() = Some((chan_id, true));
 271         nodes[0].node.test_process_background_events(); // Required to free the pending background monitor update
 272         check_added_monitors!(nodes[0], 1);
 273 }
 274
 275 #[test]
 276 fn test_unconf_chan() {
 277         do_test_unconf_chan(true, true, ConnectStyle::BestBlockFirstSkippingBlocks);
 278         do_test_unconf_chan(false, true, ConnectStyle::BestBlockFirstSkippingBlocks);
 279         do_test_unconf_chan(true, false, ConnectStyle::BestBlockFirstSkippingBlocks);
 280         do_test_unconf_chan(false, false, ConnectStyle::BestBlockFirstSkippingBlocks);
 281 }
 282
 283 #[test]
 284 fn test_unconf_chan_via_listen() {
 285         do_test_unconf_chan(true, true, ConnectStyle::FullBlockViaListen);
 286         do_test_unconf_chan(false, true, ConnectStyle::FullBlockViaListen);
 287         do_test_unconf_chan(true, false, ConnectStyle::FullBlockViaListen);
 288         do_test_unconf_chan(false, false, ConnectStyle::FullBlockViaListen);
 289 }
 290
 291 #[test]
 292 fn test_set_outpoints_partial_claiming() {
 293         // - remote party claim tx, new bump tx
 294         // - disconnect remote claiming tx, new bump
 295         // - disconnect tx, see no tx anymore
 296         let chanmon_cfgs = create_chanmon_cfgs(2);
 297         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 298         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 299         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 300
 301         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
 302         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
 303         let payment_preimage_2 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
 304
 305         // Remote commitment txn with 4 outputs: to_local, to_remote, 2 outgoing HTLC
 306         let remote_txn = get_local_commitment_txn!(nodes[1], chan.2);
 307         assert_eq!(remote_txn.len(), 3);
 308         assert_eq!(remote_txn[0].output.len(), 4);
 309         assert_eq!(remote_txn[0].input.len(), 1);
 310         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
 311         check_spends!(remote_txn[1], remote_txn[0]);
 312         check_spends!(remote_txn[2], remote_txn[0]);
 313
 314         // Connect blocks on node A to advance height towards TEST_FINAL_CLTV
 315         // Provide node A with both preimage
 316         nodes[0].node.claim_funds(payment_preimage_1, &None, 3_000_000);
 317         nodes[0].node.claim_funds(payment_preimage_2, &None, 3_000_000);
 318         check_added_monitors!(nodes[0], 2);
 319         nodes[0].node.get_and_clear_pending_events();
 320         nodes[0].node.get_and_clear_pending_msg_events();
 321
 322         // Connect blocks on node A commitment transaction
 323         mine_transaction(&nodes[0], &remote_txn[0]);
 324         check_closed_broadcast!(nodes[0], true);
 325         check_added_monitors!(nodes[0], 1);
 326         // Verify node A broadcast tx claiming both HTLCs
 327         {
 328                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
 329                 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-Success*2
 330                 assert_eq!(node_txn.len(), 4);
 331                 check_spends!(node_txn[0], remote_txn[0]);
 332                 check_spends!(node_txn[1], chan.3);
 333                 check_spends!(node_txn[2], node_txn[1]);
 334                 check_spends!(node_txn[3], node_txn[1]);
 335                 assert_eq!(node_txn[0].input.len(), 2);
 336                 node_txn.clear();
 337         }
 338
 339         // Connect blocks on node B
 340         connect_blocks(&nodes[1], 135);
 341         check_closed_broadcast!(nodes[1], true);
 342         check_added_monitors!(nodes[1], 1);
 343         // Verify node B broadcast 2 HTLC-timeout txn
 344         let partial_claim_tx = {
 345                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
 346                 assert_eq!(node_txn.len(), 3);
 347                 check_spends!(node_txn[1], node_txn[0]);
 348                 check_spends!(node_txn[2], node_txn[0]);
 349                 assert_eq!(node_txn[1].input.len(), 1);
 350                 assert_eq!(node_txn[2].input.len(), 1);
 351                 node_txn[1].clone()
 352         };
 353
 354         // Broadcast partial claim on node A, should regenerate a claiming tx with HTLC dropped
 355         mine_transaction(&nodes[0], &partial_claim_tx);
 356         {
 357                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
 358                 assert_eq!(node_txn.len(), 1);
 359                 check_spends!(node_txn[0], remote_txn[0]);
 360                 assert_eq!(node_txn[0].input.len(), 1); //dropped HTLC
 361                 node_txn.clear();
 362         }
 363         nodes[0].node.get_and_clear_pending_msg_events();
 364
 365         // Disconnect last block on node A, should regenerate a claiming tx with HTLC dropped
 366         disconnect_blocks(&nodes[0], 1);
 367         {
 368                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
 369                 assert_eq!(node_txn.len(), 1);
 370                 check_spends!(node_txn[0], remote_txn[0]);
 371                 assert_eq!(node_txn[0].input.len(), 2); //resurrected HTLC
 372                 node_txn.clear();
 373         }
 374
 375         //// Disconnect one more block and then reconnect multiple no transaction should be generated
 376         disconnect_blocks(&nodes[0], 1);
 377         connect_blocks(&nodes[0], 15);
 378         {
 379                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
 380                 assert_eq!(node_txn.len(), 0);
 381                 node_txn.clear();
 382         }
 383 }