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