_ Git - rust-lightning/blob - lightning/src/ln/reorg_tests.rs

   1 //! Further functional tests which test blockchain reorganizations.
   2
   3 use ln::channelmonitor::ANTI_REORG_DELAY;
   4 use ln::features::InitFeatures;
   5 use ln::msgs::{ChannelMessageHandler, ErrorAction, HTLCFailChannelUpdate};
   6 use util::events::{Event, EventsProvider, MessageSendEvent, MessageSendEventsProvider};
   7
   8 use bitcoin::util::hash::BitcoinHash;
   9 use bitcoin::blockdata::block::{Block, BlockHeader};
  10
  11 use std::default::Default;
  12
  13 use ln::functional_test_utils::*;
  14
  15 fn do_test_onchain_htlc_reorg(local_commitment: bool, claim: bool) {
  16         // Our on-chain HTLC-claim learning has a few properties worth testing:
  17         //  * If an upstream HTLC is claimed with a preimage (both against our own commitment
  18         //    transaction our counterparty's), we claim it backwards immediately.
  19         //  * If an upstream HTLC is claimed with a timeout, we delay ANTI_REORG_DELAY before failing
  20         //    it backwards to ensure our counterparty can't claim with a preimage in a reorg.
  21         //
  22         // Here we test both properties in any combination based on the two bools passed in as
  23         // arguments.
  24         //
  25         // If local_commitment is set, we first broadcast a local commitment containing an offered HTLC
  26         // and an HTLC-Timeout tx, otherwise we broadcast a remote commitment containing a received
  27         // HTLC and a local HTLC-Timeout tx spending it.
  28         //
  29         // We then either allow these transactions to confirm (if !claim) or we wait until one block
  30         // before they otherwise would and reorg them out, confirming an HTLC-Success tx instead.
  31         let chanmon_cfgs = create_chanmon_cfgs(3);
  32         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
  33         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
  34         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
  35
  36         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
  37         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
  38
  39         let (our_payment_preimage, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
  40
  41         // Provide preimage to node 2 by claiming payment
  42         nodes[2].node.claim_funds(our_payment_preimage, &None, 1000000);
  43         check_added_monitors!(nodes[2], 1);
  44         get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
  45
  46         let mut headers = Vec::new();
  47         let mut header = BlockHeader { version: 0x2000_0000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
  48         let claim_txn = if local_commitment {
  49                 // Broadcast node 1 commitment txn to broadcast the HTLC-Timeout
  50                 let node_1_commitment_txn = get_local_commitment_txn!(nodes[1], chan_2.2);
  51                 assert_eq!(node_1_commitment_txn.len(), 2); // 1 local commitment tx, 1 Outbound HTLC-Timeout
  52                 assert_eq!(node_1_commitment_txn[0].output.len(), 3); // to-self, anchor, and Offered HTLC (to-remote/to-node-3 is dust)
  53                 check_spends!(node_1_commitment_txn[0], chan_2.3);
  54                 check_spends!(node_1_commitment_txn[1], node_1_commitment_txn[0]);
  55
  56                 // Give node 2 node 1's transactions and get its response (claiming the HTLC instead).
  57                 nodes[2].block_notifier.block_connected(&Block { header, txdata: node_1_commitment_txn.clone() }, CHAN_CONFIRM_DEPTH + 1);
  58                 check_added_monitors!(nodes[2], 1);
  59                 check_closed_broadcast!(nodes[2], false); // We should get a BroadcastChannelUpdate (and *only* a BroadcstChannelUpdate)
  60                 let node_2_commitment_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
  61                 assert_eq!(node_2_commitment_txn.len(), 3); // ChannelMonitor: 1 offered HTLC-Claim, ChannelManger: 1 local commitment tx, 1 Received HTLC-Claim
  62                 assert_eq!(node_2_commitment_txn[1].output.len(), 3); // to-remote, anchor, and Received HTLC (to-self is dust)
  63                 check_spends!(node_2_commitment_txn[1], chan_2.3);
  64                 check_spends!(node_2_commitment_txn[2], node_2_commitment_txn[1]);
  65                 check_spends!(node_2_commitment_txn[0], node_1_commitment_txn[0]);
  66
  67                 // Confirm node 1's commitment txn (and HTLC-Timeout) on node 1
  68                 nodes[1].block_notifier.block_connected(&Block { header, txdata: node_1_commitment_txn.clone() }, CHAN_CONFIRM_DEPTH + 1);
  69
  70                 // ...but return node 1's commitment tx in case claim is set and we're preparing to reorg
  71                 vec![node_1_commitment_txn[0].clone(), node_2_commitment_txn[0].clone()]
  72         } else {
  73                 // Broadcast node 2 commitment txn
  74                 let node_2_commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
  75                 assert_eq!(node_2_commitment_txn.len(), 2); // 1 local commitment tx, 1 Received HTLC-Claim
  76                 assert_eq!(node_2_commitment_txn[0].output.len(), 3); // to-remote, anchor, and Received HTLC (to-self is dust)
  77                 check_spends!(node_2_commitment_txn[0], chan_2.3);
  78                 check_spends!(node_2_commitment_txn[1], node_2_commitment_txn[0]);
  79
  80                 // Give node 1 node 2's commitment transaction and get its response (timing the HTLC out)
  81                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_2_commitment_txn[0].clone()] }, CHAN_CONFIRM_DEPTH + 1);
  82                 let node_1_commitment_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
  83                 assert_eq!(node_1_commitment_txn.len(), 3); // ChannelMonitor: 1 offered HTLC-Timeout, ChannelManger: 1 local commitment tx, 1 Offered HTLC-Timeout
  84                 assert_eq!(node_1_commitment_txn[1].output.len(), 3); // to-local, anchor, and Offered HTLC (to-remote is dust)
  85                 check_spends!(node_1_commitment_txn[1], chan_2.3);
  86                 check_spends!(node_1_commitment_txn[2], node_1_commitment_txn[1]);
  87                 check_spends!(node_1_commitment_txn[0], node_2_commitment_txn[0]);
  88
  89                 // Confirm node 2's commitment txn (and node 1's HTLC-Timeout) on node 1
  90                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_2_commitment_txn[0].clone(), node_1_commitment_txn[0].clone()] }, CHAN_CONFIRM_DEPTH + 1);
  91                 // ...but return node 2's commitment tx (and claim) in case claim is set and we're preparing to reorg
  92                 node_2_commitment_txn
  93         };
  94         check_added_monitors!(nodes[1], 1);
  95         check_closed_broadcast!(nodes[1], false); // We should get a BroadcastChannelUpdate (and *only* a BroadcstChannelUpdate)
  96         headers.push(header.clone());
  97         // At CHAN_CONFIRM_DEPTH + 1 we have a confirmation count of 1, so CHAN_CONFIRM_DEPTH +
  98         // ANTI_REORG_DELAY - 1 will give us a confirmation count of ANTI_REORG_DELAY - 1.
  99         for i in CHAN_CONFIRM_DEPTH + 2..CHAN_CONFIRM_DEPTH + ANTI_REORG_DELAY - 1 {
 100                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
 101                 nodes[1].block_notifier.block_connected_checked(&header, i, &vec![], &[0; 0]);
 102                 headers.push(header.clone());
 103         }
 104         check_added_monitors!(nodes[1], 0);
 105         assert_eq!(nodes[1].node.get_and_clear_pending_events().len(), 0);
 106
 107         if claim {
 108                 // Now reorg back to CHAN_CONFIRM_DEPTH and confirm node 2's broadcasted transactions:
 109                 for (height, header) in (CHAN_CONFIRM_DEPTH + 1..CHAN_CONFIRM_DEPTH + ANTI_REORG_DELAY - 1).zip(headers.iter()).rev() {
 110                         nodes[1].block_notifier.block_disconnected(&header, height);
 111                 }
 112
 113                 header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
 114                 nodes[1].block_notifier.block_connected(&Block { header, txdata: claim_txn }, CHAN_CONFIRM_DEPTH + 1);
 115
 116                 // ChannelManager only polls ManyChannelMonitor::get_and_clear_pending_htlcs_updated when we
 117                 // probe it for events, so we probe non-message events here (which should still end up empty):
 118                 assert_eq!(nodes[1].node.get_and_clear_pending_events().len(), 0);
 119         } else {
 120                 // Confirm the timeout tx and check that we fail the HTLC backwards
 121                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
 122                 nodes[1].block_notifier.block_connected_checked(&header, CHAN_CONFIRM_DEPTH + ANTI_REORG_DELAY, &vec![], &[0; 0]);
 123                 expect_pending_htlcs_forwardable!(nodes[1]);
 124         }
 125
 126         check_added_monitors!(nodes[1], 1);
 127         // Which should result in an immediate claim/fail of the HTLC:
 128         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 129         if claim {
 130                 assert_eq!(htlc_updates.update_fulfill_htlcs.len(), 1);
 131                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fulfill_htlcs[0]);
 132         } else {
 133                 assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
 134                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
 135         }
 136         commitment_signed_dance!(nodes[0], nodes[1], htlc_updates.commitment_signed, false, true);
 137         if claim {
 138                 expect_payment_sent!(nodes[0], our_payment_preimage);
 139         } else {
 140                 let events = nodes[0].node.get_and_clear_pending_msg_events();
 141                 assert_eq!(events.len(), 1);
 142                 if let MessageSendEvent::PaymentFailureNetworkUpdate { update: HTLCFailChannelUpdate::ChannelClosed { ref is_permanent, .. } } = events[0] {
 143                         assert!(is_permanent);
 144                 } else { panic!("Unexpected event!"); }
 145                 expect_payment_failed!(nodes[0], our_payment_hash, false);
 146         }
 147 }
 148
 149 #[test]
 150 fn test_onchain_htlc_claim_reorg_local_commitment() {
 151         do_test_onchain_htlc_reorg(true, true);
 152 }
 153 #[test]
 154 fn test_onchain_htlc_timeout_delay_local_commitment() {
 155         do_test_onchain_htlc_reorg(true, false);
 156 }
 157 #[test]
 158 fn test_onchain_htlc_claim_reorg_remote_commitment() {
 159         do_test_onchain_htlc_reorg(false, true);
 160 }
 161 #[test]
 162 fn test_onchain_htlc_timeout_delay_remote_commitment() {
 163         do_test_onchain_htlc_reorg(false, false);
 164 }