upgrade_downgrade_tests.rs

// This file is Copyright its original authors, visible in version control
// history.
//
// This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
// or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
// You may not use this file except in accordance with one or both of these
// licenses.

//! Tests which test upgrading from previous versions of LDK or downgrading to previous versions of
//! LDK.

use lightning_0_2::commitment_signed_dance as commitment_signed_dance_0_2;
use lightning_0_2::events::Event as Event_0_2;
use lightning_0_2::get_monitor as get_monitor_0_2;
use lightning_0_2::ln::channelmanager::PaymentId as PaymentId_0_2;
use lightning_0_2::ln::channelmanager::RecipientOnionFields as RecipientOnionFields_0_2;
use lightning_0_2::ln::functional_test_utils as lightning_0_2_utils;
use lightning_0_2::ln::msgs::ChannelMessageHandler as _;
use lightning_0_2::routing::router as router_0_2;
use lightning_0_2::util::ser::Writeable as _;

use lightning_0_1::commitment_signed_dance as commitment_signed_dance_0_1;
use lightning_0_1::events::ClosureReason as ClosureReason_0_1;
use lightning_0_1::expect_pending_htlcs_forwardable_ignore as expect_pending_htlcs_forwardable_ignore_0_1;
use lightning_0_1::get_monitor as get_monitor_0_1;
use lightning_0_1::ln::channelmanager::PaymentId as PaymentId_0_1;
use lightning_0_1::ln::channelmanager::RecipientOnionFields as RecipientOnionFields_0_1;
use lightning_0_1::ln::functional_test_utils as lightning_0_1_utils;
use lightning_0_1::ln::msgs::ChannelMessageHandler as _;
use lightning_0_1::routing::router as router_0_1;
use lightning_0_1::util::ser::Writeable as _;

use lightning_0_0_125::chain::ChannelMonitorUpdateStatus as ChannelMonitorUpdateStatus_0_0_125;
use lightning_0_0_125::check_added_monitors as check_added_monitors_0_0_125;
use lightning_0_0_125::events::ClosureReason as ClosureReason_0_0_125;
use lightning_0_0_125::expect_payment_claimed as expect_payment_claimed_0_0_125;
use lightning_0_0_125::get_htlc_update_msgs as get_htlc_update_msgs_0_0_125;
use lightning_0_0_125::get_monitor as get_monitor_0_0_125;
use lightning_0_0_125::get_revoke_commit_msgs as get_revoke_commit_msgs_0_0_125;
use lightning_0_0_125::ln::channelmanager::PaymentId as PaymentId_0_0_125;
use lightning_0_0_125::ln::channelmanager::RecipientOnionFields as RecipientOnionFields_0_0_125;
use lightning_0_0_125::ln::functional_test_utils as lightning_0_0_125_utils;
use lightning_0_0_125::ln::msgs::ChannelMessageHandler as _;
use lightning_0_0_125::routing::router as router_0_0_125;
use lightning_0_0_125::util::ser::Writeable as _;

use lightning::chain::channelmonitor::{ANTI_REORG_DELAY, HTLC_FAIL_BACK_BUFFER};
use lightning::events::bump_transaction::sync::WalletSourceSync;
use lightning::events::{ClosureReason, Event, HTLCHandlingFailureType};
use lightning::ln::functional_test_utils::*;
use lightning::ln::funding::SpliceContribution;
use lightning::ln::msgs::BaseMessageHandler as _;
use lightning::ln::msgs::ChannelMessageHandler as _;
use lightning::ln::msgs::MessageSendEvent;
use lightning::ln::splicing_tests::*;
use lightning::ln::types::ChannelId;
use lightning::sign::OutputSpender;

use lightning_types::payment::{PaymentHash, PaymentPreimage, PaymentSecret};

use bitcoin::script::Builder;
use bitcoin::secp256k1::Secp256k1;
use bitcoin::{opcodes, Amount, TxOut};

use std::sync::Arc;

#[test]
fn simple_upgrade() {
	// Tests a simple case of upgrading from LDK 0.1 with a pending payment
	let (node_a_ser, node_b_ser, mon_a_ser, mon_b_ser, preimage);
	{
		let chanmon_cfgs = lightning_0_1_utils::create_chanmon_cfgs(2);
		let node_cfgs = lightning_0_1_utils::create_node_cfgs(2, &chanmon_cfgs);
		let node_chanmgrs = lightning_0_1_utils::create_node_chanmgrs(2, &node_cfgs, &[None, None]);
		let nodes = lightning_0_1_utils::create_network(2, &node_cfgs, &node_chanmgrs);

		let chan_id = lightning_0_1_utils::create_announced_chan_between_nodes(&nodes, 0, 1).2;

		let payment_preimage =
			lightning_0_1_utils::route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
		preimage = PaymentPreimage(payment_preimage.0 .0);

		node_a_ser = nodes[0].node.encode();
		node_b_ser = nodes[1].node.encode();
		mon_a_ser = get_monitor_0_1!(nodes[0], chan_id).encode();
		mon_b_ser = get_monitor_0_1!(nodes[1], chan_id).encode();
	}

	// Create a dummy node to reload over with the 0.1 state

	let mut chanmon_cfgs = create_chanmon_cfgs(2);

	// Our TestChannelSigner will fail as we're jumping ahead, so disable its state-based checks
	chanmon_cfgs[0].keys_manager.disable_all_state_policy_checks = true;
	chanmon_cfgs[1].keys_manager.disable_all_state_policy_checks = true;

	let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
	let (persister_a, persister_b, chain_mon_a, chain_mon_b);
	let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
	let (node_a, node_b);
	let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);

	let config = test_default_channel_config();
	let a_mons = &[&mon_a_ser[..]];
	reload_node!(nodes[0], config.clone(), &node_a_ser, a_mons, persister_a, chain_mon_a, node_a);
	reload_node!(nodes[1], config, &node_b_ser, &[&mon_b_ser], persister_b, chain_mon_b, node_b);

	reconnect_nodes(ReconnectArgs::new(&nodes[0], &nodes[1]));

	claim_payment(&nodes[0], &[&nodes[1]], preimage);
}

#[test]
fn test_125_dangling_post_update_actions() {
	// Tests a failure of upgrading from 0.0.125 to 0.1 when there's a dangling
	// `MonitorUpdateCompletionAction` due to the bug fixed in
	// 93b4479e472e6767af5df90fecdcdfb79074e260.
	let (node_d_ser, mon_ser);
	{
		// First, we get RAA-source monitor updates held by using async persistence (note that this
		// issue was first identified as a consequence of the bug fixed in
		// 93b4479e472e6767af5df90fecdcdfb79074e260 but in order to replicate that bug we need a
		// complicated multi-threaded race that is not deterministic, thus we "cheat" here by using
		// async persistence). We do this by simply claiming an MPP payment and not completing the
		// second channel's `ChannelMonitorUpdate`, blocking RAA `ChannelMonitorUpdate`s from the
		// first (which is ultimately a very similar bug to the one fixed in 93b4479e472e6767af5df).
		//
		// Then, we claim a second payment on the channel, which ultimately doesn't have its
		// `ChannelMonitorUpdate` completion handled due to the presence of the blocked
		// `ChannelMonitorUpdate`. The claim also generates a post-update completion action, but
		// the `ChannelMonitorUpdate` isn't queued due to the RAA-update block.
		let chanmon_cfgs = lightning_0_0_125_utils::create_chanmon_cfgs(4);
		let node_cfgs = lightning_0_0_125_utils::create_node_cfgs(4, &chanmon_cfgs);
		let node_chanmgrs =
			lightning_0_0_125_utils::create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
		let nodes = lightning_0_0_125_utils::create_network(4, &node_cfgs, &node_chanmgrs);

		let node_b_id = nodes[1].node.get_our_node_id();
		let node_d_id = nodes[3].node.get_our_node_id();

		lightning_0_0_125_utils::create_announced_chan_between_nodes_with_value(
			&nodes, 0, 1, 100_000, 0,
		);
		lightning_0_0_125_utils::create_announced_chan_between_nodes_with_value(
			&nodes, 0, 2, 100_000, 0,
		);
		let chan_id_1_3 = lightning_0_0_125_utils::create_announced_chan_between_nodes_with_value(
			&nodes, 1, 3, 100_000, 0,
		)
		.2;
		let chan_id_2_3 = lightning_0_0_125_utils::create_announced_chan_between_nodes_with_value(
			&nodes, 2, 3, 100_000, 0,
		)
		.2;

		let (preimage, hash, secret) =
			lightning_0_0_125_utils::get_payment_preimage_hash(&nodes[3], Some(15_000_000), None);

		let pay_params = router_0_0_125::PaymentParameters::from_node_id(
			node_d_id,
			lightning_0_0_125_utils::TEST_FINAL_CLTV,
		)
		.with_bolt11_features(nodes[3].node.bolt11_invoice_features())
		.unwrap();

		let route_params =
			router_0_0_125::RouteParameters::from_payment_params_and_value(pay_params, 15_000_000);
		let route = lightning_0_0_125_utils::get_route(&nodes[0], &route_params).unwrap();

		let onion = RecipientOnionFields_0_0_125::secret_only(secret);
		let id = PaymentId_0_0_125(hash.0);
		nodes[0].node.send_payment_with_route(route, hash, onion, id).unwrap();

		check_added_monitors_0_0_125!(nodes[0], 2);
		let paths = &[&[&nodes[1], &nodes[3]][..], &[&nodes[2], &nodes[3]]];
		lightning_0_0_125_utils::pass_along_route(&nodes[0], paths, 15_000_000, hash, secret);

		let preimage_2 = lightning_0_0_125_utils::route_payment(&nodes[1], &[&nodes[3]], 100_000).0;

		chanmon_cfgs[3].persister.set_update_ret(ChannelMonitorUpdateStatus_0_0_125::InProgress);
		chanmon_cfgs[3].persister.set_update_ret(ChannelMonitorUpdateStatus_0_0_125::InProgress);
		nodes[3].node.claim_funds(preimage);
		check_added_monitors_0_0_125!(nodes[3], 2);

		let (outpoint, update_id, _) = {
			let latest_monitors = nodes[3].chain_monitor.latest_monitor_update_id.lock().unwrap();
			latest_monitors.get(&chan_id_1_3).unwrap().clone()
		};
		nodes[3].chain_monitor.chain_monitor.channel_monitor_updated(outpoint, update_id).unwrap();
		expect_payment_claimed_0_0_125!(nodes[3], hash, 15_000_000);

		let ds_fulfill = get_htlc_update_msgs_0_0_125!(nodes[3], node_b_id);
		// Due to an unrelated test bug in 0.0.125, we have to leave the `ChannelMonitorUpdate` for
		// the previous node un-completed or we will panic when dropping the `Node`.
		chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus_0_0_125::InProgress);
		nodes[1].node.handle_update_fulfill_htlc(&node_d_id, &ds_fulfill.update_fulfill_htlcs[0]);
		check_added_monitors_0_0_125!(nodes[1], 1);

		nodes[1].node.handle_commitment_signed(&node_d_id, &ds_fulfill.commitment_signed);
		check_added_monitors_0_0_125!(nodes[1], 1);

		// The `ChannelMonitorUpdate` generated by the RAA from node B to node D will be blocked.
		let (bs_raa, _) = get_revoke_commit_msgs_0_0_125!(nodes[1], node_d_id);
		nodes[3].node.handle_revoke_and_ack(&node_b_id, &bs_raa);
		check_added_monitors_0_0_125!(nodes[3], 0);

		// Now that there is a blocked update in the B <-> D channel, we can claim the second
		// payment across it, which, while it will generate a `ChannelMonitorUpdate`, will not
		// complete its post-update actions.
		nodes[3].node.claim_funds(preimage_2);
		check_added_monitors_0_0_125!(nodes[3], 1);

		// Finally, we set up the failure by force-closing the channel in question, ensuring that
		// 0.1 will not create a per-peer state for node B.
		let err = "Force Closing Channel".to_owned();
		nodes[3].node.force_close_without_broadcasting_txn(&chan_id_1_3, &node_b_id, err).unwrap();
		let reason =
			ClosureReason_0_0_125::HolderForceClosed { broadcasted_latest_txn: Some(false) };
		let peers = &[node_b_id];
		lightning_0_0_125_utils::check_closed_event(&nodes[3], 1, reason, false, peers, 100_000);
		lightning_0_0_125_utils::check_closed_broadcast(&nodes[3], 1, true);
		check_added_monitors_0_0_125!(nodes[3], 1);

		node_d_ser = nodes[3].node.encode();
		mon_ser = get_monitor_0_0_125!(nodes[3], chan_id_2_3).encode();
	}

	// Create a dummy node to reload over with the 0.0.125 state

	let mut chanmon_cfgs = create_chanmon_cfgs(4);

	// Our TestChannelSigner will fail as we're jumping ahead, so disable its state-based checks
	chanmon_cfgs[0].keys_manager.disable_all_state_policy_checks = true;
	chanmon_cfgs[1].keys_manager.disable_all_state_policy_checks = true;
	chanmon_cfgs[2].keys_manager.disable_all_state_policy_checks = true;
	chanmon_cfgs[3].keys_manager.disable_all_state_policy_checks = true;

	let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
	let (persister, chain_mon);
	let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
	let node;
	let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);

	// Finally, reload the node in the latest LDK. This previously failed.
	let config = test_default_channel_config();
	reload_node!(nodes[3], config, &node_d_ser, &[&mon_ser], persister, chain_mon, node);
}

#[test]
fn test_0_1_legacy_remote_key_derivation() {
	// Test that a channel opened with a v1/legacy `remote_key` derivation will be properly spent
	// even after upgrading and opting into the new v2 derivation for new channels.
	let (node_a_ser, node_b_ser, mon_a_ser, mon_b_ser, commitment_tx, channel_id);
	let node_a_blocks;
	{
		let chanmon_cfgs = lightning_0_1_utils::create_chanmon_cfgs(2);
		let node_cfgs = lightning_0_1_utils::create_node_cfgs(2, &chanmon_cfgs);
		let node_chanmgrs = lightning_0_1_utils::create_node_chanmgrs(2, &node_cfgs, &[None, None]);
		let nodes = lightning_0_1_utils::create_network(2, &node_cfgs, &node_chanmgrs);

		let node_a_id = nodes[0].node.get_our_node_id();

		let chan_id = lightning_0_1_utils::create_announced_chan_between_nodes(&nodes, 0, 1).2;
		channel_id = chan_id.0;

		let err = "".to_owned();
		nodes[1].node.force_close_broadcasting_latest_txn(&chan_id, &node_a_id, err).unwrap();
		commitment_tx = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
		assert_eq!(commitment_tx.len(), 1);

		lightning_0_1_utils::check_added_monitors(&nodes[1], 1);
		let reason = ClosureReason_0_1::HolderForceClosed { broadcasted_latest_txn: Some(true) };
		lightning_0_1_utils::check_closed_event(&nodes[1], 1, reason, false, &[node_a_id], 100000);
		lightning_0_1_utils::check_closed_broadcast(&nodes[1], 1, true);

		node_a_ser = nodes[0].node.encode();
		node_b_ser = nodes[1].node.encode();
		mon_a_ser = get_monitor_0_1!(nodes[0], chan_id).encode();
		mon_b_ser = get_monitor_0_1!(nodes[1], chan_id).encode();

		node_a_blocks = Arc::clone(&nodes[0].blocks);
	}

	// Create a dummy node to reload over with the 0.1 state
	let chanmon_cfgs = create_chanmon_cfgs(2);
	let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
	let (persister_a, persister_b, chain_mon_a, chain_mon_b);
	let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
	let (node_a, node_b);
	let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);

	let config = test_default_channel_config();
	let a_mons = &[&mon_a_ser[..]];
	reload_node!(nodes[0], config.clone(), &node_a_ser, a_mons, persister_a, chain_mon_a, node_a);
	reload_node!(nodes[1], config, &node_b_ser, &[&mon_b_ser], persister_b, chain_mon_b, node_b);

	nodes[0].blocks = node_a_blocks;

	let node_b_id = nodes[1].node.get_our_node_id();

	mine_transaction(&nodes[0], &commitment_tx[0]);
	let reason = ClosureReason::CommitmentTxConfirmed;
	check_closed_event(&nodes[0], 1, reason, &[node_b_id], 100_000);
	check_added_monitors(&nodes[0], 1);
	check_closed_broadcast(&nodes[0], 1, false);

	connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
	let mut spendable_event = nodes[0].chain_monitor.chain_monitor.get_and_clear_pending_events();
	assert_eq!(spendable_event.len(), 1);
	if let Event::SpendableOutputs { outputs, channel_id: ev_id, counterparty_node_id: _ } =
		spendable_event.pop().unwrap()
	{
		assert_eq!(ev_id.unwrap().0, channel_id);
		assert_eq!(outputs.len(), 1);
		let spk = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script();
		let spend_tx = nodes[0]
			.keys_manager
			.backing
			.spend_spendable_outputs(&[&outputs[0]], Vec::new(), spk, 253, None, &Secp256k1::new())
			.unwrap();
		check_spends!(spend_tx, commitment_tx[0]);
	} else {
		panic!("Wrong event");
	}
}

fn do_test_0_1_htlc_forward_after_splice(fail_htlc: bool) {
	// Test what happens if an HTLC set to be forwarded in 0.1 is forwarded after the inbound
	// channel is spliced. In the initial splice code, this could have led to a dangling HTLC if
	// the HTLC is failed as the backwards-failure would use the channel's original SCID which is
	// no longer valid.
	// In some later splice code, this also failed because the `KeysManager` would have tried to
	// rotate the `to_remote` key, which we aren't able to do in the splicing protocol.
	let (node_a_ser, node_b_ser, node_c_ser, mon_a_1_ser, mon_b_1_ser, mon_b_2_ser, mon_c_1_ser);
	let (node_a_id, node_b_id, node_c_id);
	let (chan_id_bytes_a, chan_id_bytes_b);
	let (payment_secret_bytes, payment_hash_bytes, payment_preimage_bytes);
	let (node_a_blocks, node_b_blocks, node_c_blocks);

	const EXTRA_BLOCKS_BEFORE_FAIL: u32 = 145;

	{
		let chanmon_cfgs = lightning_0_1_utils::create_chanmon_cfgs(3);
		let node_cfgs = lightning_0_1_utils::create_node_cfgs(3, &chanmon_cfgs);
		let node_chanmgrs =
			lightning_0_1_utils::create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
		let nodes = lightning_0_1_utils::create_network(3, &node_cfgs, &node_chanmgrs);

		node_a_id = nodes[0].node.get_our_node_id();
		node_b_id = nodes[1].node.get_our_node_id();
		node_c_id = nodes[2].node.get_our_node_id();
		let chan_id_a = lightning_0_1_utils::create_announced_chan_between_nodes_with_value(
			&nodes, 0, 1, 10_000_000, 0,
		)
		.2;
		chan_id_bytes_a = chan_id_a.0;

		let chan_id_b = lightning_0_1_utils::create_announced_chan_between_nodes_with_value(
			&nodes, 1, 2, 50_000, 0,
		)
		.2;
		chan_id_bytes_b = chan_id_b.0;

		// Ensure all nodes are at the same initial height.
		let node_max_height = nodes.iter().map(|node| node.best_block_info().1).max().unwrap();
		for node in &nodes {
			let blocks_to_mine = node_max_height - node.best_block_info().1;
			if blocks_to_mine > 0 {
				lightning_0_1_utils::connect_blocks(node, blocks_to_mine);
			}
		}

		let (preimage, hash, secret) =
			lightning_0_1_utils::get_payment_preimage_hash(&nodes[2], Some(1_000_000), None);
		payment_preimage_bytes = preimage.0;
		payment_hash_bytes = hash.0;
		payment_secret_bytes = secret.0;

		let pay_params = router_0_1::PaymentParameters::from_node_id(
			node_c_id,
			lightning_0_1_utils::TEST_FINAL_CLTV,
		)
		.with_bolt11_features(nodes[2].node.bolt11_invoice_features())
		.unwrap();

		let route_params =
			router_0_1::RouteParameters::from_payment_params_and_value(pay_params, 1_000_000);
		let mut route = lightning_0_1_utils::get_route(&nodes[0], &route_params).unwrap();
		route.paths[0].hops[1].cltv_expiry_delta =
			EXTRA_BLOCKS_BEFORE_FAIL + HTLC_FAIL_BACK_BUFFER + 1;
		if fail_htlc {
			// Pay more than the channel's value (and probably not enough fee)
			route.paths[0].hops[1].fee_msat = 50_000_000;
		}

		let onion = RecipientOnionFields_0_1::secret_only(secret);
		let id = PaymentId_0_1(hash.0);
		nodes[0].node.send_payment_with_route(route, hash, onion, id).unwrap();

		lightning_0_1_utils::check_added_monitors(&nodes[0], 1);
		let send_event = lightning_0_1_utils::SendEvent::from_node(&nodes[0]);

		nodes[1].node.handle_update_add_htlc(node_a_id, &send_event.msgs[0]);
		commitment_signed_dance_0_1!(nodes[1], nodes[0], send_event.commitment_msg, false);
		expect_pending_htlcs_forwardable_ignore_0_1!(nodes[1]);

		// We now have an HTLC pending in node B's forwarding queue with the original channel's
		// SCID as the source.
		// We now upgrade to 0.2 and splice before forwarding that HTLC...
		node_a_ser = nodes[0].node.encode();
		node_b_ser = nodes[1].node.encode();
		node_c_ser = nodes[2].node.encode();
		mon_a_1_ser = get_monitor_0_1!(nodes[0], chan_id_a).encode();
		mon_b_1_ser = get_monitor_0_1!(nodes[1], chan_id_a).encode();
		mon_b_2_ser = get_monitor_0_1!(nodes[1], chan_id_b).encode();
		mon_c_1_ser = get_monitor_0_1!(nodes[2], chan_id_b).encode();

		node_a_blocks = Arc::clone(&nodes[0].blocks);
		node_b_blocks = Arc::clone(&nodes[1].blocks);
		node_c_blocks = Arc::clone(&nodes[2].blocks);
	}

	// Create a dummy node to reload over with the 0.1 state
	let mut chanmon_cfgs = create_chanmon_cfgs(3);

	// Our TestChannelSigner will fail as we're jumping ahead, so disable its state-based checks
	chanmon_cfgs[0].keys_manager.disable_all_state_policy_checks = true;
	chanmon_cfgs[1].keys_manager.disable_all_state_policy_checks = true;
	chanmon_cfgs[2].keys_manager.disable_all_state_policy_checks = true;

	chanmon_cfgs[0].tx_broadcaster.blocks = node_a_blocks;
	chanmon_cfgs[1].tx_broadcaster.blocks = node_b_blocks;
	chanmon_cfgs[2].tx_broadcaster.blocks = node_c_blocks;

	let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
	let (persister_a, persister_b, persister_c, chain_mon_a, chain_mon_b, chain_mon_c);
	let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
	let (node_a, node_b, node_c);
	let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);

	let config = test_default_channel_config();
	let a_mons = &[&mon_a_1_ser[..]];
	reload_node!(nodes[0], config.clone(), &node_a_ser, a_mons, persister_a, chain_mon_a, node_a);
	let b_mons = &[&mon_b_1_ser[..], &mon_b_2_ser[..]];
	reload_node!(nodes[1], config.clone(), &node_b_ser, b_mons, persister_b, chain_mon_b, node_b);
	let c_mons = &[&mon_c_1_ser[..]];
	reload_node!(nodes[2], config, &node_c_ser, c_mons, persister_c, chain_mon_c, node_c);

	reconnect_nodes(ReconnectArgs::new(&nodes[0], &nodes[1]));
	let mut reconnect_b_c_args = ReconnectArgs::new(&nodes[1], &nodes[2]);
	reconnect_b_c_args.send_channel_ready = (true, true);
	reconnect_b_c_args.send_announcement_sigs = (true, true);
	reconnect_nodes(reconnect_b_c_args);

	let contribution = SpliceContribution::splice_out(vec![TxOut {
		value: Amount::from_sat(1_000),
		script_pubkey: nodes[0].wallet_source.get_change_script().unwrap(),
	}]);
	let splice_tx = splice_channel(&nodes[0], &nodes[1], ChannelId(chan_id_bytes_a), contribution);
	for node in nodes.iter() {
		mine_transaction(node, &splice_tx);
		connect_blocks(node, ANTI_REORG_DELAY - 1);
	}

	let splice_locked = get_event_msg!(nodes[0], MessageSendEvent::SendSpliceLocked, node_b_id);
	lock_splice(&nodes[0], &nodes[1], &splice_locked, false);

	for node in nodes.iter() {
		connect_blocks(node, EXTRA_BLOCKS_BEFORE_FAIL - ANTI_REORG_DELAY);
	}

	// Now release the HTLC to be failed back to node A
	nodes[1].node.process_pending_htlc_forwards();

	let pay_secret = PaymentSecret(payment_secret_bytes);
	let pay_hash = PaymentHash(payment_hash_bytes);
	let pay_preimage = PaymentPreimage(payment_preimage_bytes);

	if fail_htlc {
		let failure = HTLCHandlingFailureType::Forward {
			node_id: Some(node_c_id),
			channel_id: ChannelId(chan_id_bytes_b),
		};
		expect_and_process_pending_htlcs_and_htlc_handling_failed(&nodes[1], &[failure]);
		check_added_monitors(&nodes[1], 1);

		let updates = get_htlc_update_msgs(&nodes[1], &node_a_id);
		nodes[0].node.handle_update_fail_htlc(node_b_id, &updates.update_fail_htlcs[0]);
		do_commitment_signed_dance(&nodes[0], &nodes[1], &updates.commitment_signed, false, false);
		let conditions = PaymentFailedConditions::new();
		expect_payment_failed_conditions(&nodes[0], pay_hash, false, conditions);
	} else {
		check_added_monitors(&nodes[1], 1);
		let forward_event = SendEvent::from_node(&nodes[1]);
		nodes[2].node.handle_update_add_htlc(node_b_id, &forward_event.msgs[0]);
		let commitment = &forward_event.commitment_msg;
		do_commitment_signed_dance(&nodes[2], &nodes[1], commitment, false, false);

		expect_and_process_pending_htlcs(&nodes[2], false);
		expect_payment_claimable!(nodes[2], pay_hash, pay_secret, 1_000_000);
		claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], pay_preimage);
	}
}

#[test]
fn test_0_1_htlc_forward_after_splice() {
	do_test_0_1_htlc_forward_after_splice(true);
	do_test_0_1_htlc_forward_after_splice(false);
}

#[derive(PartialEq, Eq)]
enum MidHtlcForwardCase {
	// Restart the upgraded node after locking an HTLC forward into the inbound edge, but before
	// decoding the onion.
	PreOnionDecode,
	// Restart the upgraded node after locking an HTLC forward into the inbound edge + decoding the
	// onion.
	PostOnionDecode,
	// Restart the upgraded node after the HTLC has been decoded and placed in the pending intercepted
	// HTLCs map.
	Intercept,
}

#[test]
fn upgrade_pre_htlc_forward_onion_decode() {
	do_upgrade_mid_htlc_forward(MidHtlcForwardCase::PreOnionDecode);
}

#[test]
fn upgrade_mid_htlc_forward() {
	do_upgrade_mid_htlc_forward(MidHtlcForwardCase::PostOnionDecode);
}

#[test]
fn upgrade_mid_htlc_intercept_forward() {
	do_upgrade_mid_htlc_forward(MidHtlcForwardCase::Intercept);
}

fn do_upgrade_mid_htlc_forward(test: MidHtlcForwardCase) {
	// In 0.3, we started reconstructing the `ChannelManager`'s HTLC forwards maps from the HTLCs
	// contained in `Channel`s, as part of removing the requirement to regularly persist the
	// `ChannelManager`. However, HTLC forwards can only be reconstructed this way if they were
	// received on 0.3 or higher. Test that HTLC forwards that were serialized on <=0.2 will still
	// succeed when read on 0.3+.
	let (node_a_ser, node_b_ser, node_c_ser, mon_a_1_ser, mon_b_1_ser, mon_b_2_ser, mon_c_1_ser);
	let (node_a_id, node_b_id, node_c_id);
	let (payment_secret_bytes, payment_hash_bytes, payment_preimage_bytes);
	let chan_id_bytes_b_c;

	{
		let chanmon_cfgs = lightning_0_2_utils::create_chanmon_cfgs(3);
		let node_cfgs = lightning_0_2_utils::create_node_cfgs(3, &chanmon_cfgs);

		let mut intercept_cfg = lightning_0_2_utils::test_default_channel_config();
		intercept_cfg.accept_intercept_htlcs = true;
		let cfgs = &[None, Some(intercept_cfg), None];
		let node_chanmgrs = lightning_0_2_utils::create_node_chanmgrs(3, &node_cfgs, cfgs);
		let nodes = lightning_0_2_utils::create_network(3, &node_cfgs, &node_chanmgrs);

		node_a_id = nodes[0].node.get_our_node_id();
		node_b_id = nodes[1].node.get_our_node_id();
		node_c_id = nodes[2].node.get_our_node_id();
		let chan_id_a = lightning_0_2_utils::create_announced_chan_between_nodes_with_value(
			&nodes, 0, 1, 10_000_000, 0,
		)
		.2;

		let chan_id_b = lightning_0_2_utils::create_announced_chan_between_nodes_with_value(
			&nodes, 1, 2, 50_000, 0,
		)
		.2;
		chan_id_bytes_b_c = chan_id_b.0;

		// Ensure all nodes are at the same initial height.
		let node_max_height = nodes.iter().map(|node| node.best_block_info().1).max().unwrap();
		for node in &nodes {
			let blocks_to_mine = node_max_height - node.best_block_info().1;
			if blocks_to_mine > 0 {
				lightning_0_2_utils::connect_blocks(node, blocks_to_mine);
			}
		}

		// Initiate an HTLC to be sent over node_a -> node_b -> node_c
		let (preimage, hash, secret) =
			lightning_0_2_utils::get_payment_preimage_hash(&nodes[2], Some(1_000_000), None);
		payment_preimage_bytes = preimage.0;
		payment_hash_bytes = hash.0;
		payment_secret_bytes = secret.0;

		let pay_params = router_0_2::PaymentParameters::from_node_id(
			node_c_id,
			lightning_0_2_utils::TEST_FINAL_CLTV,
		)
		.with_bolt11_features(nodes[2].node.bolt11_invoice_features())
		.unwrap();

		let route_params =
			router_0_2::RouteParameters::from_payment_params_and_value(pay_params, 1_000_000);
		let mut route = lightning_0_2_utils::get_route(&nodes[0], &route_params).unwrap();

		if test == MidHtlcForwardCase::Intercept {
			route.paths[0].hops[1].short_channel_id = nodes[1].node.get_intercept_scid();
		}

		let onion = RecipientOnionFields_0_2::secret_only(secret);
		let id = PaymentId_0_2(hash.0);
		nodes[0].node.send_payment_with_route(route, hash, onion, id).unwrap();

		lightning_0_2_utils::check_added_monitors(&nodes[0], 1);
		let send_event = lightning_0_2_utils::SendEvent::from_node(&nodes[0]);

		// Lock in the HTLC on the inbound edge of node_b without initiating the outbound edge.
		nodes[1].node.handle_update_add_htlc(node_a_id, &send_event.msgs[0]);
		commitment_signed_dance_0_2!(nodes[1], nodes[0], send_event.commitment_msg, false);
		if test != MidHtlcForwardCase::PreOnionDecode {
			nodes[1].node.test_process_pending_update_add_htlcs();
		}
		let events = nodes[1].node.get_and_clear_pending_events();
		if test == MidHtlcForwardCase::Intercept {
			assert_eq!(events.len(), 1);
			assert!(matches!(events[0], Event_0_2::HTLCIntercepted { .. }));
		} else {
			assert!(events.is_empty());
		}

		node_a_ser = nodes[0].node.encode();
		node_b_ser = nodes[1].node.encode();
		node_c_ser = nodes[2].node.encode();
		mon_a_1_ser = get_monitor_0_2!(nodes[0], chan_id_a).encode();
		mon_b_1_ser = get_monitor_0_2!(nodes[1], chan_id_a).encode();
		mon_b_2_ser = get_monitor_0_2!(nodes[1], chan_id_b).encode();
		mon_c_1_ser = get_monitor_0_2!(nodes[2], chan_id_b).encode();
	}

	// Create a dummy node to reload over with the 0.2 state
	let mut chanmon_cfgs = create_chanmon_cfgs(3);

	// Our TestChannelSigner will fail as we're jumping ahead, so disable its state-based checks
	chanmon_cfgs[0].keys_manager.disable_all_state_policy_checks = true;
	chanmon_cfgs[1].keys_manager.disable_all_state_policy_checks = true;
	chanmon_cfgs[2].keys_manager.disable_all_state_policy_checks = true;

	let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
	let (persister_a, persister_b, persister_c, chain_mon_a, chain_mon_b, chain_mon_c);
	let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
	let (node_a, node_b, node_c);
	let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);

	let config = test_default_channel_config();
	let a_mons = &[&mon_a_1_ser[..]];
	reload_node!(nodes[0], config.clone(), &node_a_ser, a_mons, persister_a, chain_mon_a, node_a);
	let b_mons = &[&mon_b_1_ser[..], &mon_b_2_ser[..]];
	reload_node!(nodes[1], config.clone(), &node_b_ser, b_mons, persister_b, chain_mon_b, node_b);
	let c_mons = &[&mon_c_1_ser[..]];
	reload_node!(nodes[2], config, &node_c_ser, c_mons, persister_c, chain_mon_c, node_c);

	reconnect_nodes(ReconnectArgs::new(&nodes[0], &nodes[1]));
	let mut reconnect_b_c_args = ReconnectArgs::new(&nodes[1], &nodes[2]);
	reconnect_b_c_args.send_channel_ready = (true, true);
	reconnect_b_c_args.send_announcement_sigs = (true, true);
	reconnect_nodes(reconnect_b_c_args);

	// Now release the HTLC from node_b to node_c, to be claimed back to node_a
	nodes[1].node.process_pending_htlc_forwards();

	if test == MidHtlcForwardCase::Intercept {
		let events = nodes[1].node.get_and_clear_pending_events();
		assert_eq!(events.len(), 1);
		let (intercept_id, expected_outbound_amt_msat) = match events[0] {
			Event::HTLCIntercepted { intercept_id, expected_outbound_amount_msat, .. } => {
				(intercept_id, expected_outbound_amount_msat)
			},
			_ => panic!(),
		};
		nodes[1]
			.node
			.forward_intercepted_htlc(
				intercept_id,
				&ChannelId(chan_id_bytes_b_c),
				nodes[2].node.get_our_node_id(),
				expected_outbound_amt_msat,
			)
			.unwrap();
		nodes[1].node.process_pending_htlc_forwards();
	}

	let pay_secret = PaymentSecret(payment_secret_bytes);
	let pay_hash = PaymentHash(payment_hash_bytes);
	let pay_preimage = PaymentPreimage(payment_preimage_bytes);

	check_added_monitors(&nodes[1], 1);
	let forward_event = SendEvent::from_node(&nodes[1]);
	nodes[2].node.handle_update_add_htlc(node_b_id, &forward_event.msgs[0]);
	let commitment = &forward_event.commitment_msg;
	do_commitment_signed_dance(&nodes[2], &nodes[1], commitment, false, false);

	expect_and_process_pending_htlcs(&nodes[2], false);
	expect_payment_claimable!(nodes[2], pay_hash, pay_secret, 1_000_000);
	claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], pay_preimage);
}