_ 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;
  13 use ln::features::InitFeatures;
  14 use ln::msgs::{ChannelMessageHandler, ErrorAction, HTLCFailChannelUpdate};
  15 use util::events::{Event, EventsProvider, MessageSendEvent, MessageSendEventsProvider};
  16
  17 use bitcoin::blockdata::block::{Block, BlockHeader};
  18
  19 use std::default::Default;
  20 use std::mem;
  21
  22 use ln::functional_test_utils::*;
  23
  24 fn do_test_onchain_htlc_reorg(local_commitment: bool, claim: bool) {
  25         // Our on-chain HTLC-claim learning has a few properties worth testing:
  26         //  * If an upstream HTLC is claimed with a preimage (both against our own commitment
  27         //    transaction our counterparty's), we claim it backwards immediately.
  28         //  * If an upstream HTLC is claimed with a timeout, we delay ANTI_REORG_DELAY before failing
  29         //    it backwards to ensure our counterparty can't claim with a preimage in a reorg.
  30         //
  31         // Here we test both properties in any combination based on the two bools passed in as
  32         // arguments.
  33         //
  34         // If local_commitment is set, we first broadcast a local commitment containing an offered HTLC
  35         // and an HTLC-Timeout tx, otherwise we broadcast a remote commitment containing a received
  36         // HTLC and a local HTLC-Timeout tx spending it.
  37         //
  38         // We then either allow these transactions to confirm (if !claim) or we wait until one block
  39         // before they otherwise would and reorg them out, confirming an HTLC-Success tx instead.
  40         let chanmon_cfgs = create_chanmon_cfgs(3);
  41         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
  42         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
  43         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
  44
  45         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
  46         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
  47
  48         let (our_payment_preimage, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
  49
  50         // Provide preimage to node 2 by claiming payment
  51         nodes[2].node.claim_funds(our_payment_preimage, &None, 1000000);
  52         check_added_monitors!(nodes[2], 1);
  53         get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
  54
  55         let header = BlockHeader { version: 0x2000_0000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
  56         let claim_txn = if local_commitment {
  57                 // Broadcast node 1 commitment txn to broadcast the HTLC-Timeout
  58                 let node_1_commitment_txn = get_local_commitment_txn!(nodes[1], chan_2.2);
  59                 assert_eq!(node_1_commitment_txn.len(), 2); // 1 local commitment tx, 1 Outbound HTLC-Timeout
  60                 assert_eq!(node_1_commitment_txn[0].output.len(), 2); // to-self and Offered HTLC (to-remote/to-node-3 is dust)
  61                 check_spends!(node_1_commitment_txn[0], chan_2.3);
  62                 check_spends!(node_1_commitment_txn[1], node_1_commitment_txn[0]);
  63
  64                 // Give node 2 node 1's transactions and get its response (claiming the HTLC instead).
  65                 connect_block(&nodes[2], &Block { header, txdata: node_1_commitment_txn.clone() }, CHAN_CONFIRM_DEPTH + 1);
  66                 check_added_monitors!(nodes[2], 1);
  67                 check_closed_broadcast!(nodes[2], false); // We should get a BroadcastChannelUpdate (and *only* a BroadcstChannelUpdate)
  68                 let node_2_commitment_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
  69                 assert_eq!(node_2_commitment_txn.len(), 3); // ChannelMonitor: 1 offered HTLC-Claim, ChannelManger: 1 local commitment tx, 1 Received HTLC-Claim
  70                 assert_eq!(node_2_commitment_txn[1].output.len(), 2); // to-remote and Received HTLC (to-self is dust)
  71                 check_spends!(node_2_commitment_txn[1], chan_2.3);
  72                 check_spends!(node_2_commitment_txn[2], node_2_commitment_txn[1]);
  73                 check_spends!(node_2_commitment_txn[0], node_1_commitment_txn[0]);
  74
  75                 // Confirm node 1's commitment txn (and HTLC-Timeout) on node 1
  76                 connect_block(&nodes[1], &Block { header, txdata: node_1_commitment_txn.clone() }, CHAN_CONFIRM_DEPTH + 1);
  77
  78                 // ...but return node 1's commitment tx in case claim is set and we're preparing to reorg
  79                 vec![node_1_commitment_txn[0].clone(), node_2_commitment_txn[0].clone()]
  80         } else {
  81                 // Broadcast node 2 commitment txn
  82                 let node_2_commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
  83                 assert_eq!(node_2_commitment_txn.len(), 2); // 1 local commitment tx, 1 Received HTLC-Claim
  84                 assert_eq!(node_2_commitment_txn[0].output.len(), 2); // to-remote and Received HTLC (to-self is dust)
  85                 check_spends!(node_2_commitment_txn[0], chan_2.3);
  86                 check_spends!(node_2_commitment_txn[1], node_2_commitment_txn[0]);
  87
  88                 // Give node 1 node 2's commitment transaction and get its response (timing the HTLC out)
  89                 connect_block(&nodes[1], &Block { header, txdata: vec![node_2_commitment_txn[0].clone()] }, CHAN_CONFIRM_DEPTH + 1);
  90                 let node_1_commitment_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
  91                 assert_eq!(node_1_commitment_txn.len(), 3); // ChannelMonitor: 1 offered HTLC-Timeout, ChannelManger: 1 local commitment tx, 1 Offered HTLC-Timeout
  92                 assert_eq!(node_1_commitment_txn[1].output.len(), 2); // to-local and Offered HTLC (to-remote is dust)
  93                 check_spends!(node_1_commitment_txn[1], chan_2.3);
  94                 check_spends!(node_1_commitment_txn[2], node_1_commitment_txn[1]);
  95                 check_spends!(node_1_commitment_txn[0], node_2_commitment_txn[0]);
  96
  97                 // Confirm node 2's commitment txn (and node 1's HTLC-Timeout) on node 1
  98                 connect_block(&nodes[1], &Block { header, txdata: vec![node_2_commitment_txn[0].clone(), node_1_commitment_txn[0].clone()] }, CHAN_CONFIRM_DEPTH + 1);
  99                 // ...but return node 2's commitment tx (and claim) in case claim is set and we're preparing to reorg
 100                 node_2_commitment_txn
 101         };
 102         check_added_monitors!(nodes[1], 1);
 103         check_closed_broadcast!(nodes[1], false); // We should get a BroadcastChannelUpdate (and *only* a BroadcstChannelUpdate)
 104         let mut block = Block { header, txdata: vec![] };
 105         let mut blocks = Vec::new();
 106         blocks.push(block.clone());
 107         // At CHAN_CONFIRM_DEPTH + 1 we have a confirmation count of 1, so CHAN_CONFIRM_DEPTH +
 108         // ANTI_REORG_DELAY - 1 will give us a confirmation count of ANTI_REORG_DELAY - 1.
 109         for i in CHAN_CONFIRM_DEPTH + 2..CHAN_CONFIRM_DEPTH + ANTI_REORG_DELAY - 1 {
 110                 block = Block {
 111                         header: BlockHeader { version: 0x20000000, prev_blockhash: block.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
 112                         txdata: vec![],
 113                 };
 114                 connect_block(&nodes[1], &block, i);
 115                 blocks.push(block.clone());
 116         }
 117         check_added_monitors!(nodes[1], 0);
 118         assert_eq!(nodes[1].node.get_and_clear_pending_events().len(), 0);
 119
 120         if claim {
 121                 // Now reorg back to CHAN_CONFIRM_DEPTH and confirm node 2's broadcasted transactions:
 122                 for (height, block) in (CHAN_CONFIRM_DEPTH + 1..CHAN_CONFIRM_DEPTH + ANTI_REORG_DELAY - 1).zip(blocks.iter()).rev() {
 123                         disconnect_block(&nodes[1], &block.header, height);
 124                 }
 125
 126                 block = Block {
 127                         header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
 128                         txdata: claim_txn,
 129                 };
 130                 connect_block(&nodes[1], &block, CHAN_CONFIRM_DEPTH + 1);
 131
 132                 // ChannelManager only polls chain::Watch::release_pending_monitor_events when we
 133                 // probe it for events, so we probe non-message events here (which should still end up empty):
 134                 assert_eq!(nodes[1].node.get_and_clear_pending_events().len(), 0);
 135         } else {
 136                 // Confirm the timeout tx and check that we fail the HTLC backwards
 137                 block = Block {
 138                         header: BlockHeader { version: 0x20000000, prev_blockhash: block.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
 139                         txdata: vec![],
 140                 };
 141                 connect_block(&nodes[1], &block, CHAN_CONFIRM_DEPTH + ANTI_REORG_DELAY);
 142                 expect_pending_htlcs_forwardable!(nodes[1]);
 143         }
 144
 145         check_added_monitors!(nodes[1], 1);
 146         // Which should result in an immediate claim/fail of the HTLC:
 147         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 148         if claim {
 149                 assert_eq!(htlc_updates.update_fulfill_htlcs.len(), 1);
 150                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fulfill_htlcs[0]);
 151         } else {
 152                 assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
 153                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
 154         }
 155         commitment_signed_dance!(nodes[0], nodes[1], htlc_updates.commitment_signed, false, true);
 156         if claim {
 157                 expect_payment_sent!(nodes[0], our_payment_preimage);
 158         } else {
 159                 let events = nodes[0].node.get_and_clear_pending_msg_events();
 160                 assert_eq!(events.len(), 1);
 161                 if let MessageSendEvent::PaymentFailureNetworkUpdate { update: HTLCFailChannelUpdate::ChannelClosed { ref is_permanent, .. } } = events[0] {
 162                         assert!(is_permanent);
 163                 } else { panic!("Unexpected event!"); }
 164                 expect_payment_failed!(nodes[0], our_payment_hash, false);
 165         }
 166 }
 167
 168 #[test]
 169 fn test_onchain_htlc_claim_reorg_local_commitment() {
 170         do_test_onchain_htlc_reorg(true, true);
 171 }
 172 #[test]
 173 fn test_onchain_htlc_timeout_delay_local_commitment() {
 174         do_test_onchain_htlc_reorg(true, false);
 175 }
 176 #[test]
 177 fn test_onchain_htlc_claim_reorg_remote_commitment() {
 178         do_test_onchain_htlc_reorg(false, true);
 179 }
 180 #[test]
 181 fn test_onchain_htlc_timeout_delay_remote_commitment() {
 182         do_test_onchain_htlc_reorg(false, false);
 183 }
 184
 185 #[test]
 186 fn test_unconf_chan() {
 187         // After creating a chan between nodes, we disconnect all blocks previously seen to force a channel close on nodes[0] side
 188         let chanmon_cfgs = create_chanmon_cfgs(2);
 189         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 190         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 191         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 192         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 193
 194         let channel_state = nodes[0].node.channel_state.lock().unwrap();
 195         assert_eq!(channel_state.by_id.len(), 1);
 196         assert_eq!(channel_state.short_to_id.len(), 1);
 197         mem::drop(channel_state);
 198
 199         let mut headers = Vec::new();
 200         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
 201         headers.push(header.clone());
 202         for _i in 2..100 {
 203                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
 204                 headers.push(header.clone());
 205         }
 206         while !headers.is_empty() {
 207                 nodes[0].node.block_disconnected(&headers.pop().unwrap());
 208         }
 209         check_closed_broadcast!(nodes[0], false);
 210         check_added_monitors!(nodes[0], 1);
 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 #[test]
 217 fn test_set_outpoints_partial_claiming() {
 218         // - remote party claim tx, new bump tx
 219         // - disconnect remote claiming tx, new bump
 220         // - disconnect tx, see no tx anymore
 221         let chanmon_cfgs = create_chanmon_cfgs(2);
 222         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 223         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 224         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 225
 226         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
 227         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
 228         let payment_preimage_2 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
 229
 230         // Remote commitment txn with 4 outputs: to_local, to_remote, 2 outgoing HTLC
 231         let remote_txn = get_local_commitment_txn!(nodes[1], chan.2);
 232         assert_eq!(remote_txn.len(), 3);
 233         assert_eq!(remote_txn[0].output.len(), 4);
 234         assert_eq!(remote_txn[0].input.len(), 1);
 235         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
 236         check_spends!(remote_txn[1], remote_txn[0]);
 237         check_spends!(remote_txn[2], remote_txn[0]);
 238
 239         // Connect blocks on node A to advance height towards TEST_FINAL_CLTV
 240         let prev_header_100 = connect_blocks(&nodes[1], 100, 0, false, Default::default());
 241         // Provide node A with both preimage
 242         nodes[0].node.claim_funds(payment_preimage_1, &None, 3_000_000);
 243         nodes[0].node.claim_funds(payment_preimage_2, &None, 3_000_000);
 244         check_added_monitors!(nodes[0], 2);
 245         nodes[0].node.get_and_clear_pending_events();
 246         nodes[0].node.get_and_clear_pending_msg_events();
 247
 248         // Connect blocks on node A commitment transaction
 249         let header = BlockHeader { version: 0x20000000, prev_blockhash: prev_header_100, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
 250         connect_block(&nodes[0], &Block { header, txdata: vec![remote_txn[0].clone()] }, 101);
 251         check_closed_broadcast!(nodes[0], false);
 252         check_added_monitors!(nodes[0], 1);
 253         // Verify node A broadcast tx claiming both HTLCs
 254         {
 255                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
 256                 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-Success*2
 257                 assert_eq!(node_txn.len(), 4);
 258                 check_spends!(node_txn[0], remote_txn[0]);
 259                 check_spends!(node_txn[1], chan.3);
 260                 check_spends!(node_txn[2], node_txn[1]);
 261                 check_spends!(node_txn[3], node_txn[1]);
 262                 assert_eq!(node_txn[0].input.len(), 2);
 263                 node_txn.clear();
 264         }
 265
 266         // Connect blocks on node B
 267         connect_blocks(&nodes[1], 135, 0, false, Default::default());
 268         check_closed_broadcast!(nodes[1], false);
 269         check_added_monitors!(nodes[1], 1);
 270         // Verify node B broadcast 2 HTLC-timeout txn
 271         let partial_claim_tx = {
 272                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
 273                 assert_eq!(node_txn.len(), 3);
 274                 check_spends!(node_txn[1], node_txn[0]);
 275                 check_spends!(node_txn[2], node_txn[0]);
 276                 assert_eq!(node_txn[1].input.len(), 1);
 277                 assert_eq!(node_txn[2].input.len(), 1);
 278                 node_txn[1].clone()
 279         };
 280
 281         // Broadcast partial claim on node A, should regenerate a claiming tx with HTLC dropped
 282         let header = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
 283         connect_block(&nodes[0], &Block { header, txdata: vec![partial_claim_tx.clone()] }, 102);
 284         {
 285                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
 286                 assert_eq!(node_txn.len(), 1);
 287                 check_spends!(node_txn[0], remote_txn[0]);
 288                 assert_eq!(node_txn[0].input.len(), 1); //dropped HTLC
 289                 node_txn.clear();
 290         }
 291         nodes[0].node.get_and_clear_pending_msg_events();
 292
 293         // Disconnect last block on node A, should regenerate a claiming tx with HTLC dropped
 294         disconnect_block(&nodes[0], &header, 102);
 295         {
 296                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
 297                 assert_eq!(node_txn.len(), 1);
 298                 check_spends!(node_txn[0], remote_txn[0]);
 299                 assert_eq!(node_txn[0].input.len(), 2); //resurrected HTLC
 300                 node_txn.clear();
 301         }
 302
 303         //// Disconnect one more block and then reconnect multiple no transaction should be generated
 304         disconnect_block(&nodes[0], &header, 101);
 305         connect_blocks(&nodes[1], 15, 101, false, prev_header_100);
 306         {
 307                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
 308                 assert_eq!(node_txn.len(), 0);
 309                 node_txn.clear();
 310         }
 311 }