Merge pull request #1004 from TheBlueMatt/2021-07-forward-event
[rust-lightning] / lightning / src / ln / reorg_tests.rs
index c9573a67c13244cc73e1298ca43a9e1d66537e33..bbdb5bfac6bae9270e30bb99434c818020a3d475 100644 (file)
 //! Further functional tests which test blockchain reorganizations.
 
 use chain::channelmonitor::{ANTI_REORG_DELAY, ChannelMonitor};
-use chain::Watch;
+use chain::transaction::OutPoint;
+use chain::{Confirm, Watch};
 use ln::channelmanager::{ChannelManager, ChannelManagerReadArgs};
 use ln::features::InitFeatures;
 use ln::msgs::{ChannelMessageHandler, ErrorAction, HTLCFailChannelUpdate};
-use util::config::UserConfig;
 use util::enforcing_trait_impls::EnforcingSigner;
-use util::events::{Event, EventsProvider, MessageSendEvent, MessageSendEventsProvider};
+use util::events::{Event, MessageSendEvent, MessageSendEventsProvider};
 use util::test_utils;
 use util::ser::{ReadableArgs, Writeable};
 
 use bitcoin::blockdata::block::{Block, BlockHeader};
+use bitcoin::blockdata::script::Builder;
+use bitcoin::blockdata::opcodes;
 use bitcoin::hash_types::BlockHash;
+use bitcoin::secp256k1::Secp256k1;
 
-use std::collections::HashMap;
-use std::mem;
+use prelude::*;
+use core::mem;
 
 use ln::functional_test_utils::*;
 
@@ -57,10 +60,10 @@ 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]], 1000000);
+       let (our_payment_preimage, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
 
        // Provide preimage to node 2 by claiming payment
-       nodes[2].node.claim_funds(our_payment_preimage, &None, 1000000);
+       nodes[2].node.claim_funds(our_payment_preimage);
        check_added_monitors!(nodes[2], 1);
        get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
 
@@ -102,16 +105,17 @@ fn do_test_onchain_htlc_reorg(local_commitment: bool, claim: bool) {
 
                // Give node 1 node 2's commitment transaction and get its response (timing the HTLC out)
                mine_transaction(&nodes[1], &node_2_commitment_txn[0]);
-               let node_1_commitment_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
-               assert_eq!(node_1_commitment_txn.len(), 3); // ChannelMonitor: 1 offered HTLC-Timeout, ChannelManger: 1 local commitment tx, 1 Offered HTLC-Timeout
-               assert_eq!(node_1_commitment_txn[1].output.len(), 2); // to-local and Offered HTLC (to-remote is dust)
-               check_spends!(node_1_commitment_txn[1], chan_2.3);
-               check_spends!(node_1_commitment_txn[2], node_1_commitment_txn[1]);
-               check_spends!(node_1_commitment_txn[0], node_2_commitment_txn[0]);
+               connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
+               let node_1_commitment_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
+               assert_eq!(node_1_commitment_txn.len(), 2); // ChannelMonitor: 1 offered HTLC-Timeout, ChannelManger: 1 local commitment tx
+               assert_eq!(node_1_commitment_txn[0].output.len(), 2); // to-local and Offered HTLC (to-remote is dust)
+               check_spends!(node_1_commitment_txn[0], chan_2.3);
+               check_spends!(node_1_commitment_txn[1], node_2_commitment_txn[0]);
 
                // Confirm node 2's commitment txn (and node 1's HTLC-Timeout) on node 1
                header.prev_blockhash = nodes[1].best_block_hash();
-               connect_block(&nodes[1], &Block { header, txdata: vec![node_2_commitment_txn[0].clone(), node_1_commitment_txn[0].clone()] });
+               let block = Block { header, txdata: vec![node_2_commitment_txn[0].clone(), node_1_commitment_txn[1].clone()] };
+               connect_block(&nodes[1], &block);
                // ...but return node 2's commitment tx (and claim) in case claim is set and we're preparing to reorg
                node_2_commitment_txn
        };
@@ -132,8 +136,9 @@ fn do_test_onchain_htlc_reorg(local_commitment: bool, claim: bool) {
                connect_block(&nodes[1], &block);
 
                // ChannelManager only polls chain::Watch::release_pending_monitor_events when we
-               // probe it for events, so we probe non-message events here (which should still end up empty):
-               assert_eq!(nodes[1].node.get_and_clear_pending_events().len(), 0);
+               // probe it for events, so we probe non-message events here (which should just be the
+               // PaymentForwarded event).
+               expect_payment_forwarded!(nodes[1], Some(1000), true);
        } else {
                // Confirm the timeout tx and check that we fail the HTLC backwards
                let block = Block {
@@ -184,7 +189,7 @@ fn test_onchain_htlc_timeout_delay_remote_commitment() {
        do_test_onchain_htlc_reorg(false, false);
 }
 
-fn do_test_unconf_chan(reload_node: bool, reorg_after_reload: bool, connect_style: ConnectStyle) {
+fn do_test_unconf_chan(reload_node: bool, reorg_after_reload: bool, use_funding_unconfirmed: bool, connect_style: ConnectStyle) {
        // After creating a chan between nodes, we disconnect all blocks previously seen to force a
        // channel close on nodes[0] side. We also use this to provide very basic testing of logic
        // around freeing background events which store monitor updates during block_[dis]connected.
@@ -197,7 +202,7 @@ fn do_test_unconf_chan(reload_node: bool, reorg_after_reload: bool, connect_styl
        let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
        *nodes[0].connect_style.borrow_mut() = connect_style;
 
-       let chan_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
+       let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 
        let channel_state = nodes[0].node.channel_state.lock().unwrap();
        assert_eq!(channel_state.by_id.len(), 1);
@@ -205,8 +210,19 @@ fn do_test_unconf_chan(reload_node: bool, reorg_after_reload: bool, connect_styl
        mem::drop(channel_state);
 
        if !reorg_after_reload {
-               disconnect_all_blocks(&nodes[0]);
-               check_closed_broadcast!(nodes[0], true);
+               if use_funding_unconfirmed {
+                       let relevant_txids = nodes[0].node.get_relevant_txids();
+                       assert_eq!(&relevant_txids[..], &[chan.3.txid()]);
+                       nodes[0].node.transaction_unconfirmed(&relevant_txids[0]);
+               } else {
+                       disconnect_all_blocks(&nodes[0]);
+               }
+               if connect_style == ConnectStyle::FullBlockViaListen && !use_funding_unconfirmed {
+                       handle_announce_close_broadcast_events(&nodes, 0, 1, true, "Funding transaction was un-confirmed. Locked at 6 confs, now have 2 confs.");
+               } else {
+                       handle_announce_close_broadcast_events(&nodes, 0, 1, true, "Funding transaction was un-confirmed. Locked at 6 confs, now have 0 confs.");
+               }
+               check_added_monitors!(nodes[1], 1);
                {
                        let channel_state = nodes[0].node.channel_state.lock().unwrap();
                        assert_eq!(channel_state.by_id.len(), 0);
@@ -233,14 +249,13 @@ fn do_test_unconf_chan(reload_node: bool, reorg_after_reload: bool, connect_styl
                assert!(chan_0_monitor_read.is_empty());
 
                let mut nodes_0_read = &nodes_0_serialized[..];
-               let config = UserConfig::default();
                nodes_0_deserialized = {
                        let mut channel_monitors = HashMap::new();
                        channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
                        <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster,
                          &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(
                                &mut nodes_0_read, ChannelManagerReadArgs {
-                                       default_config: config,
+                                       default_config: *nodes[0].node.get_current_default_configuration(),
                                        keys_manager,
                                        fee_estimator: node_cfgs[0].fee_estimator,
                                        chain_monitor: nodes[0].chain_monitor,
@@ -251,14 +266,31 @@ fn do_test_unconf_chan(reload_node: bool, reorg_after_reload: bool, connect_styl
                };
                nodes[0].node = &nodes_0_deserialized;
                assert!(nodes_0_read.is_empty());
+               if !reorg_after_reload {
+                       // If the channel is already closed when we reload the node, we'll broadcast a closing
+                       // transaction via the ChannelMonitor which is missing a corresponding channel.
+                       assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
+                       nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
+               }
 
                nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0.clone(), chan_0_monitor).unwrap();
                check_added_monitors!(nodes[0], 1);
        }
 
        if reorg_after_reload {
-               disconnect_all_blocks(&nodes[0]);
-               check_closed_broadcast!(nodes[0], true);
+               if use_funding_unconfirmed {
+                       let relevant_txids = nodes[0].node.get_relevant_txids();
+                       assert_eq!(&relevant_txids[..], &[chan.3.txid()]);
+                       nodes[0].node.transaction_unconfirmed(&relevant_txids[0]);
+               } else {
+                       disconnect_all_blocks(&nodes[0]);
+               }
+               if connect_style == ConnectStyle::FullBlockViaListen && !use_funding_unconfirmed {
+                       handle_announce_close_broadcast_events(&nodes, 0, 1, true, "Funding transaction was un-confirmed. Locked at 6 confs, now have 2 confs.");
+               } else {
+                       handle_announce_close_broadcast_events(&nodes, 0, 1, true, "Funding transaction was un-confirmed. Locked at 6 confs, now have 0 confs.");
+               }
+               check_added_monitors!(nodes[1], 1);
                {
                        let channel_state = nodes[0].node.channel_state.lock().unwrap();
                        assert_eq!(channel_state.by_id.len(), 0);
@@ -267,25 +299,44 @@ fn do_test_unconf_chan(reload_node: bool, reorg_after_reload: bool, connect_styl
        }
        // With expect_channel_force_closed set the TestChainMonitor will enforce that the next update
        // is a ChannelForcClosed on the right channel with should_broadcast set.
-       *nodes[0].chain_monitor.expect_channel_force_closed.lock().unwrap() = Some((chan_id, true));
+       *nodes[0].chain_monitor.expect_channel_force_closed.lock().unwrap() = Some((chan.2, true));
        nodes[0].node.test_process_background_events(); // Required to free the pending background monitor update
        check_added_monitors!(nodes[0], 1);
+       assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
+       nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
+
+       // Now check that we can create a new channel
+       create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
+       send_payment(&nodes[0], &[&nodes[1]], 8000000);
 }
 
 #[test]
 fn test_unconf_chan() {
-       do_test_unconf_chan(true, true, ConnectStyle::BestBlockFirstSkippingBlocks);
-       do_test_unconf_chan(false, true, ConnectStyle::BestBlockFirstSkippingBlocks);
-       do_test_unconf_chan(true, false, ConnectStyle::BestBlockFirstSkippingBlocks);
-       do_test_unconf_chan(false, false, ConnectStyle::BestBlockFirstSkippingBlocks);
+       do_test_unconf_chan(true, true, false, ConnectStyle::BestBlockFirstSkippingBlocks);
+       do_test_unconf_chan(false, true, false, ConnectStyle::BestBlockFirstSkippingBlocks);
+       do_test_unconf_chan(true, false, false, ConnectStyle::BestBlockFirstSkippingBlocks);
+       do_test_unconf_chan(false, false, false, ConnectStyle::BestBlockFirstSkippingBlocks);
 }
 
 #[test]
 fn test_unconf_chan_via_listen() {
-       do_test_unconf_chan(true, true, ConnectStyle::FullBlockViaListen);
-       do_test_unconf_chan(false, true, ConnectStyle::FullBlockViaListen);
-       do_test_unconf_chan(true, false, ConnectStyle::FullBlockViaListen);
-       do_test_unconf_chan(false, false, ConnectStyle::FullBlockViaListen);
+       do_test_unconf_chan(true, true, false, ConnectStyle::FullBlockViaListen);
+       do_test_unconf_chan(false, true, false, ConnectStyle::FullBlockViaListen);
+       do_test_unconf_chan(true, false, false, ConnectStyle::FullBlockViaListen);
+       do_test_unconf_chan(false, false, false, ConnectStyle::FullBlockViaListen);
+}
+
+#[test]
+fn test_unconf_chan_via_funding_unconfirmed() {
+       do_test_unconf_chan(true, true, true, ConnectStyle::BestBlockFirstSkippingBlocks);
+       do_test_unconf_chan(false, true, true, ConnectStyle::BestBlockFirstSkippingBlocks);
+       do_test_unconf_chan(true, false, true, ConnectStyle::BestBlockFirstSkippingBlocks);
+       do_test_unconf_chan(false, false, true, ConnectStyle::BestBlockFirstSkippingBlocks);
+
+       do_test_unconf_chan(true, true, true, ConnectStyle::FullBlockViaListen);
+       do_test_unconf_chan(false, true, true, ConnectStyle::FullBlockViaListen);
+       do_test_unconf_chan(true, false, true, ConnectStyle::FullBlockViaListen);
+       do_test_unconf_chan(false, false, true, ConnectStyle::FullBlockViaListen);
 }
 
 #[test]
@@ -313,8 +364,8 @@ fn test_set_outpoints_partial_claiming() {
 
        // Connect blocks on node A to advance height towards TEST_FINAL_CLTV
        // Provide node A with both preimage
-       nodes[0].node.claim_funds(payment_preimage_1, &None, 3_000_000);
-       nodes[0].node.claim_funds(payment_preimage_2, &None, 3_000_000);
+       nodes[0].node.claim_funds(payment_preimage_1);
+       nodes[0].node.claim_funds(payment_preimage_2);
        check_added_monitors!(nodes[0], 2);
        nodes[0].node.get_and_clear_pending_events();
        nodes[0].node.get_and_clear_pending_msg_events();
@@ -381,3 +432,112 @@ fn test_set_outpoints_partial_claiming() {
                node_txn.clear();
        }
 }
+
+fn do_test_to_remote_after_local_detection(style: ConnectStyle) {
+       // In previous code, detection of to_remote outputs in a counterparty commitment transaction
+       // was dependent on whether a local commitment transaction had been seen on-chain previously.
+       // This resulted in some edge cases around not being able to generate a SpendableOutput event
+       // after a reorg.
+       //
+       // Here, we test this by first confirming one set of commitment transactions, then
+       // disconnecting them and reconnecting another. We then confirm them and check that the correct
+       // SpendableOutput event is generated.
+       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]);
+       let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
+
+       *nodes[0].connect_style.borrow_mut() = style;
+       *nodes[1].connect_style.borrow_mut() = style;
+
+       let (_, _, chan_id, funding_tx) =
+               create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 100_000_000, InitFeatures::known(), InitFeatures::known());
+       let funding_outpoint = OutPoint { txid: funding_tx.txid(), index: 0 };
+       assert_eq!(funding_outpoint.to_channel_id(), chan_id);
+
+       let remote_txn_a = get_local_commitment_txn!(nodes[0], chan_id);
+       let remote_txn_b = get_local_commitment_txn!(nodes[1], chan_id);
+
+       mine_transaction(&nodes[0], &remote_txn_a[0]);
+       mine_transaction(&nodes[1], &remote_txn_a[0]);
+
+       assert!(nodes[0].node.list_channels().is_empty());
+       check_closed_broadcast!(nodes[0], true);
+       check_added_monitors!(nodes[0], 1);
+       assert!(nodes[1].node.list_channels().is_empty());
+       check_closed_broadcast!(nodes[1], true);
+       check_added_monitors!(nodes[1], 1);
+
+       // Drop transactions broadcasted in response to the first commitment transaction (we have good
+       // test coverage of these things already elsewhere).
+       assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0).len(), 1);
+       assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0).len(), 1);
+
+       assert!(nodes[0].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
+       assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
+
+       disconnect_blocks(&nodes[0], 1);
+       disconnect_blocks(&nodes[1], 1);
+
+       assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
+       assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
+       assert!(nodes[0].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
+       assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
+
+       connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
+       connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
+
+       assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
+       assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
+       assert!(nodes[0].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
+       assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
+
+       mine_transaction(&nodes[0], &remote_txn_b[0]);
+       mine_transaction(&nodes[1], &remote_txn_b[0]);
+
+       assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
+       assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
+       assert!(nodes[0].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
+       assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
+
+       connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
+       connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
+
+       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() {
+               assert_eq!(outputs.len(), 1);
+               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, &Secp256k1::new()).unwrap();
+               check_spends!(spend_tx, remote_txn_b[0]);
+       }
+
+       // nodes[1] is waiting for the to_self_delay to expire, which is many more than
+       // ANTI_REORG_DELAY. Instead, walk it back and confirm the original remote_txn_a commitment
+       // again and check that nodes[1] generates a similar spendable output.
+       // Technically a reorg of ANTI_REORG_DELAY violates our assumptions, so this is undefined by
+       // our API spec, but we currently handle this correctly and there's little reason we shouldn't
+       // in the future.
+       assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
+       disconnect_blocks(&nodes[1], ANTI_REORG_DELAY);
+       mine_transaction(&nodes[1], &remote_txn_a[0]);
+       connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
+
+       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() {
+               assert_eq!(outputs.len(), 1);
+               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, &Secp256k1::new()).unwrap();
+               check_spends!(spend_tx, remote_txn_a[0]);
+       }
+}
+
+#[test]
+fn test_to_remote_after_local_detection() {
+       do_test_to_remote_after_local_detection(ConnectStyle::BestBlockFirst);
+       do_test_to_remote_after_local_detection(ConnectStyle::BestBlockFirstSkippingBlocks);
+       do_test_to_remote_after_local_detection(ConnectStyle::TransactionsFirst);
+       do_test_to_remote_after_local_detection(ConnectStyle::TransactionsFirstSkippingBlocks);
+       do_test_to_remote_after_local_detection(ConnectStyle::FullBlockViaListen);
+}