Consider anchor outputs value on inbound HTLCs
[rust-lightning] / lightning / src / ln / reorg_tests.rs
index bab1b097e37c248edf70edf351a164055f9f933b..b745453a3c6799e012ddf3368be4136ef4831653 100644 (file)
@@ -9,11 +9,11 @@
 
 //! Further functional tests which test blockchain reorganizations.
 
+use crate::chain::chaininterface::LowerBoundedFeeEstimator;
 use crate::chain::channelmonitor::{ANTI_REORG_DELAY, LATENCY_GRACE_PERIOD_BLOCKS};
 use crate::chain::transaction::OutPoint;
 use crate::chain::Confirm;
-use crate::events::{Event, MessageSendEventsProvider, ClosureReason, HTLCDestination};
-use crate::ln::channelmanager::ChannelManager;
+use crate::events::{Event, MessageSendEventsProvider, ClosureReason, HTLCDestination, MessageSendEvent};
 use crate::ln::msgs::{ChannelMessageHandler, Init};
 use crate::util::test_utils;
 use crate::util::ser::Writeable;
@@ -56,7 +56,7 @@ fn do_test_onchain_htlc_reorg(local_commitment: bool, claim: bool) {
        connect_blocks(&nodes[1], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
        connect_blocks(&nodes[2], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
 
-       let (our_payment_preimage, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000);
+       let (our_payment_preimage, our_payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000);
 
        // Provide preimage to node 2 by claiming payment
        nodes[2].node.claim_funds(our_payment_preimage);
@@ -424,8 +424,8 @@ fn test_set_outpoints_partial_claiming() {
        let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 
        let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000);
-       let (payment_preimage_1, payment_hash_1, _) = route_payment(&nodes[1], &[&nodes[0]], 3_000_000);
-       let (payment_preimage_2, payment_hash_2, _) = route_payment(&nodes[1], &[&nodes[0]], 3_000_000);
+       let (payment_preimage_1, payment_hash_1, ..) = route_payment(&nodes[1], &[&nodes[0]], 3_000_000);
+       let (payment_preimage_2, payment_hash_2, ..) = route_payment(&nodes[1], &[&nodes[0]], 3_000_000);
 
        // Remote commitment txn with 4 outputs: to_local, to_remote, 2 outgoing HTLC
        let remote_txn = get_local_commitment_txn!(nodes[1], chan.2);
@@ -463,7 +463,7 @@ fn test_set_outpoints_partial_claiming() {
        // Connect blocks on node B
        connect_blocks(&nodes[1], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
        check_closed_broadcast!(nodes[1], true);
-       check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed, [nodes[0].node.get_our_node_id()], 1000000);
+       check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed, [nodes[0].node.get_our_node_id()], 1000000);
        check_added_monitors!(nodes[1], 1);
        // Verify node B broadcast 2 HTLC-timeout txn
        let partial_claim_tx = {
@@ -578,8 +578,9 @@ fn do_test_to_remote_after_local_detection(style: ConnectStyle) {
 
        let mut node_a_spendable = nodes[0].chain_monitor.chain_monitor.get_and_clear_pending_events();
        assert_eq!(node_a_spendable.len(), 1);
-       if let Event::SpendableOutputs { outputs } = node_a_spendable.pop().unwrap() {
+       if let Event::SpendableOutputs { outputs, channel_id } = node_a_spendable.pop().unwrap() {
                assert_eq!(outputs.len(), 1);
+               assert_eq!(channel_id, Some(chan_id));
                let spend_tx = nodes[0].keys_manager.backing.spend_spendable_outputs(&[&outputs[0]], Vec::new(),
                        Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, None, &Secp256k1::new()).unwrap();
                check_spends!(spend_tx, remote_txn_b[0]);
@@ -598,8 +599,9 @@ fn do_test_to_remote_after_local_detection(style: ConnectStyle) {
 
        let mut node_b_spendable = nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events();
        assert_eq!(node_b_spendable.len(), 1);
-       if let Event::SpendableOutputs { outputs } = node_b_spendable.pop().unwrap() {
+       if let Event::SpendableOutputs { outputs, channel_id } = node_b_spendable.pop().unwrap() {
                assert_eq!(outputs.len(), 1);
+               assert_eq!(channel_id, Some(chan_id));
                let spend_tx = nodes[1].keys_manager.backing.spend_spendable_outputs(&[&outputs[0]], Vec::new(),
                        Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, None, &Secp256k1::new()).unwrap();
                check_spends!(spend_tx, remote_txn_a[0]);
@@ -616,3 +618,139 @@ fn test_to_remote_after_local_detection() {
        do_test_to_remote_after_local_detection(ConnectStyle::TransactionsFirstReorgsOnlyTip);
        do_test_to_remote_after_local_detection(ConnectStyle::FullBlockViaListen);
 }
+
+#[test]
+fn test_htlc_preimage_claim_holder_commitment_after_counterparty_commitment_reorg() {
+       // We detect a counterparty commitment confirm onchain, followed by a reorg and a confirmation
+       // of a holder commitment. Then, if we learn of the preimage for an HTLC in both commitments,
+       // test that we only claim the currently confirmed commitment.
+       let chanmon_cfgs = create_chanmon_cfgs(2);
+       let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
+       let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
+       let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
+
+       let (_, _, chan_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 1);
+
+       // Route an HTLC which we will claim onchain with the preimage.
+       let (payment_preimage, payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
+
+       // Force close with the latest counterparty commitment, confirm it, and reorg it with the latest
+       // holder commitment.
+       nodes[0].node.force_close_broadcasting_latest_txn(&chan_id, &nodes[1].node.get_our_node_id()).unwrap();
+       check_closed_broadcast(&nodes[0], 1, true);
+       check_added_monitors(&nodes[0], 1);
+       check_closed_event(&nodes[0], 1, ClosureReason::HolderForceClosed, false, &[nodes[1].node.get_our_node_id()], 100000);
+
+       nodes[1].node.force_close_broadcasting_latest_txn(&chan_id, &nodes[0].node.get_our_node_id()).unwrap();
+       check_closed_broadcast(&nodes[1], 1, true);
+       check_added_monitors(&nodes[1], 1);
+       check_closed_event(&nodes[1], 1, ClosureReason::HolderForceClosed, false, &[nodes[0].node.get_our_node_id()], 100000);
+
+       let mut txn = nodes[0].tx_broadcaster.txn_broadcast();
+       assert_eq!(txn.len(), 1);
+       let commitment_tx_a = txn.pop().unwrap();
+       check_spends!(commitment_tx_a, funding_tx);
+
+       let mut txn = nodes[1].tx_broadcaster.txn_broadcast();
+       assert_eq!(txn.len(), 1);
+       let commitment_tx_b = txn.pop().unwrap();
+       check_spends!(commitment_tx_b, funding_tx);
+
+       mine_transaction(&nodes[0], &commitment_tx_a);
+       mine_transaction(&nodes[1], &commitment_tx_a);
+
+       disconnect_blocks(&nodes[0], 1);
+       disconnect_blocks(&nodes[1], 1);
+
+       mine_transaction(&nodes[0], &commitment_tx_b);
+       mine_transaction(&nodes[1], &commitment_tx_b);
+
+       // Provide the preimage now, such that we only claim from the holder commitment (since it's
+       // currently confirmed) and not the counterparty's.
+       get_monitor!(nodes[1], chan_id).provide_payment_preimage(
+               &payment_hash, &payment_preimage, &nodes[1].tx_broadcaster,
+               &LowerBoundedFeeEstimator(nodes[1].fee_estimator), &nodes[1].logger
+       );
+
+       let mut txn = nodes[1].tx_broadcaster.txn_broadcast();
+       assert_eq!(txn.len(), 1);
+       let htlc_success_tx = txn.pop().unwrap();
+       check_spends!(htlc_success_tx, commitment_tx_b);
+}
+
+#[test]
+fn test_htlc_preimage_claim_prev_counterparty_commitment_after_current_counterparty_commitment_reorg() {
+       // We detect a counterparty commitment confirm onchain, followed by a reorg and a
+       // confirmation of the previous (still unrevoked) counterparty commitment. Then, if we learn
+       // of the preimage for an HTLC in both commitments, test that we only claim the currently
+       // confirmed commitment.
+       let chanmon_cfgs = create_chanmon_cfgs(2);
+       let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
+       let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
+       let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
+
+       let (_, _, chan_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 1);
+
+       // Route an HTLC which we will claim onchain with the preimage.
+       let (payment_preimage, payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
+
+       // Obtain the current commitment, which will become the previous after a fee update.
+       let prev_commitment_a = &get_local_commitment_txn!(nodes[0], chan_id)[0];
+
+       *nodes[0].fee_estimator.sat_per_kw.lock().unwrap() *= 4;
+       nodes[0].node.timer_tick_occurred();
+       check_added_monitors(&nodes[0], 1);
+       let mut msg_events = nodes[0].node.get_and_clear_pending_msg_events();
+       assert_eq!(msg_events.len(), 1);
+       let (update_fee, commit_sig) = if let MessageSendEvent::UpdateHTLCs { node_id, mut updates } = msg_events.pop().unwrap() {
+               assert_eq!(node_id, nodes[1].node.get_our_node_id());
+               (updates.update_fee.take().unwrap(), updates.commitment_signed)
+       } else {
+               panic!("Unexpected message send event");
+       };
+
+       // Handle the fee update on the other side, but don't send the last RAA such that the previous
+       // commitment is still valid (unrevoked).
+       nodes[1].node().handle_update_fee(&nodes[0].node.get_our_node_id(), &update_fee);
+       let _last_revoke_and_ack = commitment_signed_dance!(nodes[1], nodes[0], commit_sig, false, true, false, true);
+
+       // Force close with the latest commitment, confirm it, and reorg it with the previous commitment.
+       nodes[0].node.force_close_broadcasting_latest_txn(&chan_id, &nodes[1].node.get_our_node_id()).unwrap();
+       check_closed_broadcast(&nodes[0], 1, true);
+       check_added_monitors(&nodes[0], 1);
+       check_closed_event(&nodes[0], 1, ClosureReason::HolderForceClosed, false, &[nodes[1].node.get_our_node_id()], 100000);
+
+       let mut txn = nodes[0].tx_broadcaster.txn_broadcast();
+       assert_eq!(txn.len(), 1);
+       let current_commitment_a = txn.pop().unwrap();
+       assert_ne!(current_commitment_a.txid(), prev_commitment_a.txid());
+       check_spends!(current_commitment_a, funding_tx);
+
+       mine_transaction(&nodes[0], &current_commitment_a);
+       mine_transaction(&nodes[1], &current_commitment_a);
+
+       check_closed_broadcast(&nodes[1], 1, true);
+       check_added_monitors(&nodes[1], 1);
+       check_closed_event(&nodes[1], 1, ClosureReason::CommitmentTxConfirmed, false, &[nodes[0].node.get_our_node_id()], 100000);
+
+       disconnect_blocks(&nodes[0], 1);
+       disconnect_blocks(&nodes[1], 1);
+
+       mine_transaction(&nodes[0], &prev_commitment_a);
+       mine_transaction(&nodes[1], &prev_commitment_a);
+
+       // Provide the preimage now, such that we only claim from the previous commitment (since it's
+       // currently confirmed) and not the latest.
+       get_monitor!(nodes[1], chan_id).provide_payment_preimage(
+               &payment_hash, &payment_preimage, &nodes[1].tx_broadcaster,
+               &LowerBoundedFeeEstimator(nodes[1].fee_estimator), &nodes[1].logger
+       );
+
+       let mut txn = nodes[1].tx_broadcaster.txn_broadcast();
+       assert_eq!(txn.len(), 1);
+       let htlc_preimage_tx = txn.pop().unwrap();
+       check_spends!(htlc_preimage_tx, prev_commitment_a);
+       // Make sure it was indeed a preimage claim and not a revocation claim since the previous
+       // commitment (still unrevoked) is the currently confirmed closing transaction.
+       assert_eq!(htlc_preimage_tx.input[0].witness.second_to_last().unwrap(), &payment_preimage.0[..]);
+}