Merge pull request #3084 from jkczyz/2024-05-onion-fields
[rust-lightning] / lightning / src / ln / functional_tests.rs
index cba5f2bab8799c9e984ab1e3704dbf97c254325c..6d5b2b4f1d63b7fd2ee8bd88dc032e591f21f747 100644 (file)
@@ -19,7 +19,7 @@ use crate::chain::channelmonitor::{CLOSED_CHANNEL_UPDATE_ID, CLTV_CLAIM_BUFFER,
 use crate::chain::transaction::OutPoint;
 use crate::sign::{ecdsa::EcdsaChannelSigner, EntropySource, OutputSpender, SignerProvider};
 use crate::events::{Event, MessageSendEvent, MessageSendEventsProvider, PathFailure, PaymentPurpose, ClosureReason, HTLCDestination, PaymentFailureReason};
-use crate::ln::{ChannelId, PaymentPreimage, PaymentSecret, PaymentHash};
+use crate::ln::types::{ChannelId, PaymentPreimage, PaymentSecret, PaymentHash};
 use crate::ln::channel::{commitment_tx_base_weight, COMMITMENT_TX_WEIGHT_PER_HTLC, CONCURRENT_INBOUND_HTLC_FEE_BUFFER, FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE, MIN_AFFORDABLE_HTLC_COUNT, get_holder_selected_channel_reserve_satoshis, OutboundV1Channel, InboundV1Channel, COINBASE_MATURITY, ChannelPhase};
 use crate::ln::channelmanager::{self, PaymentId, RAACommitmentOrder, PaymentSendFailure, RecipientOnionFields, BREAKDOWN_TIMEOUT, ENABLE_GOSSIP_TICKS, DISABLE_GOSSIP_TICKS, MIN_CLTV_EXPIRY_DELTA};
 use crate::ln::channel::{DISCONNECT_PEER_AWAITING_RESPONSE_TICKS, ChannelError};
@@ -61,6 +61,38 @@ use crate::ln::chan_utils::CommitmentTransaction;
 
 use super::channel::UNFUNDED_CHANNEL_AGE_LIMIT_TICKS;
 
+#[test]
+fn test_channel_resumption_fail_post_funding() {
+       // If we fail to exchange funding with a peer prior to it disconnecting we'll resume the
+       // channel open on reconnect, however if we do exchange funding we do not currently support
+       // replaying it and here test that the channel closes.
+       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 nodes = create_network(2, &node_cfgs, &node_chanmgrs);
+
+       nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1_000_000, 0, 42, None, None).unwrap();
+       let open_chan = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
+       nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_chan);
+       let accept_chan = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
+       nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_chan);
+
+       let (temp_chan_id, tx, funding_output) =
+               create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 1_000_000, 42);
+       let new_chan_id = ChannelId::v1_from_funding_outpoint(funding_output);
+       nodes[0].node.funding_transaction_generated(&temp_chan_id, &nodes[1].node.get_our_node_id(), tx).unwrap();
+
+       nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
+       check_closed_events(&nodes[0], &[ExpectedCloseEvent::from_id_reason(new_chan_id, true, ClosureReason::DisconnectedPeer)]);
+
+       // After ddf75afd16 we'd panic on reconnection if we exchanged funding info, so test that
+       // explicitly here.
+       nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
+               features: nodes[1].node.init_features(), networks: None, remote_network_address: None
+       }, true).unwrap();
+       assert_eq!(nodes[0].node.get_and_clear_pending_msg_events(), Vec::new());
+}
+
 #[test]
 fn test_insane_channel_opens() {
        // Stand up a network of 2 nodes
@@ -1401,8 +1433,9 @@ fn test_fee_spike_violation_fails_htlc() {
        let cur_height = nodes[1].node.best_block.read().unwrap().height + 1;
 
        let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
+       let recipient_onion_fields = RecipientOnionFields::secret_only(payment_secret);
        let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0],
-               3460001, RecipientOnionFields::secret_only(payment_secret), cur_height, &None).unwrap();
+               3460001, &recipient_onion_fields, cur_height, &None).unwrap();
        let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash).unwrap();
        let msg = msgs::UpdateAddHTLC {
                channel_id: chan.2,
@@ -1598,8 +1631,9 @@ fn test_chan_reserve_violation_inbound_htlc_outbound_channel() {
        let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
        let cur_height = nodes[1].node.best_block.read().unwrap().height + 1;
        let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
+       let recipient_onion_fields = RecipientOnionFields::secret_only(payment_secret);
        let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0],
-               700_000, RecipientOnionFields::secret_only(payment_secret), cur_height, &None).unwrap();
+               700_000, &recipient_onion_fields, cur_height, &None).unwrap();
        let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash).unwrap();
        let msg = msgs::UpdateAddHTLC {
                channel_id: chan.2,
@@ -1777,8 +1811,9 @@ fn test_chan_reserve_violation_inbound_htlc_inbound_chan() {
        let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
        let cur_height = nodes[0].node.best_block.read().unwrap().height + 1;
        let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route_2.paths[0], &session_priv).unwrap();
+       let recipient_onion_fields = RecipientOnionFields::spontaneous_empty();
        let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(
-               &route_2.paths[0], recv_value_2, RecipientOnionFields::spontaneous_empty(), cur_height, &None).unwrap();
+               &route_2.paths[0], recv_value_2, &recipient_onion_fields, cur_height, &None).unwrap();
        let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash_1).unwrap();
        let msg = msgs::UpdateAddHTLC {
                channel_id: chan.2,
@@ -3501,8 +3536,9 @@ fn fail_backward_pending_htlc_upon_channel_failure() {
                let secp_ctx = Secp256k1::new();
                let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
                let current_height = nodes[1].node.best_block.read().unwrap().height + 1;
+               let recipient_onion_fields = RecipientOnionFields::secret_only(payment_secret);
                let (onion_payloads, _amount_msat, cltv_expiry) = onion_utils::build_onion_payloads(
-                       &route.paths[0], 50_000, RecipientOnionFields::secret_only(payment_secret), current_height, &None).unwrap();
+                       &route.paths[0], 50_000, &recipient_onion_fields, current_height, &None).unwrap();
                let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
                let onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash).unwrap();
 
@@ -3734,10 +3770,10 @@ fn test_peer_disconnected_before_funding_broadcasted() {
                nodes[0].node.timer_tick_occurred();
        }
 
-       // Ensure that the channel is closed with `ClosureReason::HolderForceClosed`
-       // when the peers are disconnected and do not reconnect before the funding
-       // transaction is broadcasted.
-       check_closed_event!(&nodes[0], 2, ClosureReason::HolderForceClosed, true
+       // Ensure that the channel is closed with `ClosureReason::DisconnectedPeer` and a
+       // `DiscardFunding` event when the peers are disconnected and do not reconnect before the
+       // funding transaction is broadcasted.
+       check_closed_event!(&nodes[0], 2, ClosureReason::DisconnectedPeer, true
                , [nodes[1].node.get_our_node_id()], 1000000);
        check_closed_event!(&nodes[1], 1, ClosureReason::DisconnectedPeer, false
                , [nodes[0].node.get_our_node_id()], 1000000);
@@ -3776,7 +3812,10 @@ fn test_simple_peer_disconnect() {
        nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
        nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
 
-       claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], true, payment_preimage_3);
+       claim_payment_along_route(
+               ClaimAlongRouteArgs::new(&nodes[0], &[&[&nodes[1], &nodes[2]]], payment_preimage_3)
+                       .skip_last(true)
+       );
        fail_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], true, payment_hash_5);
 
        let mut reconnect_args = ReconnectArgs::new(&nodes[0], &nodes[1]);
@@ -6487,8 +6526,9 @@ fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
        let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
        let cur_height = nodes[0].node.best_block.read().unwrap().height + 1;
        let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route.paths[0], &session_priv).unwrap();
+       let recipient_onion_fields = RecipientOnionFields::secret_only(our_payment_secret);
        let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(
-               &route.paths[0], send_amt, RecipientOnionFields::secret_only(our_payment_secret), cur_height, &None).unwrap();
+               &route.paths[0], send_amt, &recipient_onion_fields, cur_height, &None).unwrap();
        let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash).unwrap();
 
        let mut msg = msgs::UpdateAddHTLC {
@@ -8222,8 +8262,9 @@ fn test_onion_value_mpp_set_calculation() {
                        let height = nodes[0].best_block_info().1;
                        let session_priv = SecretKey::from_slice(&session_priv).unwrap();
                        let mut onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
+                       let recipient_onion_fields = RecipientOnionFields::secret_only(our_payment_secret);
                        let (mut onion_payloads, _, _) = onion_utils::build_onion_payloads(&route.paths[0], 100_000,
-                               RecipientOnionFields::secret_only(our_payment_secret), height + 1, &None).unwrap();
+                               &recipient_onion_fields, height + 1, &None).unwrap();
                        // Edit amt_to_forward to simulate the sender having set
                        // the final amount and the routing node taking less fee
                        if let msgs::OutboundOnionPayload::Receive {
@@ -8258,7 +8299,9 @@ fn test_onion_value_mpp_set_calculation() {
        let ev = remove_first_msg_event_to_node(&expected_paths[1][0].node.get_our_node_id(), &mut events);
        pass_along_path(&nodes[0], expected_paths[1], 101_000, our_payment_hash.clone(), Some(our_payment_secret), ev, true, None);
 
-       claim_payment_along_route(&nodes[0], expected_paths, false, our_payment_preimage);
+       claim_payment_along_route(
+               ClaimAlongRouteArgs::new(&nodes[0], expected_paths, our_payment_preimage)
+       );
 }
 
 fn do_test_overshoot_mpp(msat_amounts: &[u64], total_msat: u64) {
@@ -8324,7 +8367,9 @@ fn do_test_overshoot_mpp(msat_amounts: &[u64], total_msat: u64) {
                pass_along_path(&nodes[src_idx], expected_path, amount_received, our_payment_hash.clone(), Some(our_payment_secret), ev, became_claimable_now, None);
        }
 
-       claim_payment_along_route(&nodes[src_idx], &expected_paths, false, our_payment_preimage);
+       claim_payment_along_route(
+               ClaimAlongRouteArgs::new(&nodes[src_idx], &expected_paths, our_payment_preimage)
+       );
 }
 
 #[test]
@@ -8356,7 +8401,9 @@ fn test_simple_mpp() {
        route.paths[1].hops[0].short_channel_id = chan_2_id;
        route.paths[1].hops[1].short_channel_id = chan_4_id;
        send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, payment_secret);
-       claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
+       claim_payment_along_route(
+               ClaimAlongRouteArgs::new(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], payment_preimage)
+       );
 }
 
 #[test]
@@ -9800,7 +9847,9 @@ fn test_inconsistent_mpp_params() {
        assert_eq!(events.len(), 1);
        pass_along_path(&nodes[0], &[&nodes[2], &nodes[3]], 15_000_000, our_payment_hash, Some(our_payment_secret), events.pop().unwrap(), true, None);
 
-       do_claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, our_payment_preimage);
+       do_claim_payment_along_route(
+               ClaimAlongRouteArgs::new(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], our_payment_preimage)
+       );
        expect_payment_sent(&nodes[0], our_payment_preimage, Some(None), true, true);
 }
 
@@ -10115,6 +10164,94 @@ fn test_max_dust_htlc_exposure() {
        do_test_max_dust_htlc_exposure_by_threshold_type(true, true);
 }
 
+#[test]
+fn test_nondust_htlc_fees_are_dust() {
+       // Test that the transaction fees paid in nondust HTLCs count towards our dust limit
+       let chanmon_cfgs = create_chanmon_cfgs(3);
+       let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
+
+       let mut config = test_default_channel_config();
+       // Set the dust limit to the default value
+       config.channel_config.max_dust_htlc_exposure =
+               MaxDustHTLCExposure::FeeRateMultiplier(10_000);
+       // Make sure the HTLC limits don't get in the way
+       config.channel_handshake_limits.min_max_accepted_htlcs = 400;
+       config.channel_handshake_config.our_max_accepted_htlcs = 400;
+       config.channel_handshake_config.our_htlc_minimum_msat = 1;
+
+       let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config), Some(config), Some(config)]);
+       let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
+
+       // Create a channel from 1 -> 0 but immediately push all of the funds towards 0
+       let chan_id_1 = create_announced_chan_between_nodes(&nodes, 1, 0).2;
+       while nodes[1].node.list_channels()[0].next_outbound_htlc_limit_msat > 0 {
+               send_payment(&nodes[1], &[&nodes[0]], nodes[1].node.list_channels()[0].next_outbound_htlc_limit_msat);
+       }
+
+       // First get the channel one HTLC_VALUE HTLC away from the dust limit by sending dust HTLCs
+       // repeatedly until we run out of space.
+       const HTLC_VALUE: u64 = 1_000_000; // Doesn't matter, tune until the test passes
+       let payment_preimage = route_payment(&nodes[0], &[&nodes[1]], HTLC_VALUE).0;
+
+       while nodes[0].node.list_channels()[0].next_outbound_htlc_minimum_msat == 0 {
+               route_payment(&nodes[0], &[&nodes[1]], HTLC_VALUE);
+       }
+       assert_ne!(nodes[0].node.list_channels()[0].next_outbound_htlc_limit_msat, 0,
+               "We don't want to run out of ability to send because of some non-dust limit");
+       assert!(nodes[0].node.list_channels()[0].pending_outbound_htlcs.len() < 10,
+               "We should be able to fill our dust limit without too many HTLCs");
+
+       let dust_limit = nodes[0].node.list_channels()[0].next_outbound_htlc_minimum_msat;
+       claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
+       assert_ne!(nodes[0].node.list_channels()[0].next_outbound_htlc_minimum_msat, 0,
+               "Make sure we are able to send once we clear one HTLC");
+
+       // At this point we have somewhere between dust_limit and dust_limit * 2 left in our dust
+       // exposure limit, and we want to max that out using non-dust HTLCs.
+       let commitment_tx_per_htlc_cost =
+               htlc_success_tx_weight(&ChannelTypeFeatures::empty()) * 253;
+       let max_htlcs_remaining = dust_limit * 2 / commitment_tx_per_htlc_cost;
+       assert!(max_htlcs_remaining < 30,
+               "We should be able to fill our dust limit without too many HTLCs");
+       for i in 0..max_htlcs_remaining + 1 {
+               assert_ne!(i, max_htlcs_remaining);
+               if nodes[0].node.list_channels()[0].next_outbound_htlc_limit_msat < dust_limit {
+                       // We found our limit, and it was less than max_htlcs_remaining!
+                       // At this point we can only send dust HTLCs as any non-dust HTLCs will overuse our
+                       // remaining dust exposure.
+                       break;
+               }
+               route_payment(&nodes[0], &[&nodes[1]], dust_limit * 2);
+       }
+
+       // At this point non-dust HTLCs are no longer accepted from node 0 -> 1, we also check that
+       // such HTLCs can't be routed over the same channel either.
+       create_announced_chan_between_nodes(&nodes, 2, 0);
+       let (route, payment_hash, _, payment_secret) =
+               get_route_and_payment_hash!(nodes[2], nodes[1], dust_limit * 2);
+       let onion = RecipientOnionFields::secret_only(payment_secret);
+       nodes[2].node.send_payment_with_route(&route, payment_hash, onion, PaymentId([0; 32])).unwrap();
+       check_added_monitors(&nodes[2], 1);
+       let send = SendEvent::from_node(&nodes[2]);
+
+       nodes[0].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &send.msgs[0]);
+       commitment_signed_dance!(nodes[0], nodes[2], send.commitment_msg, false, true);
+
+       expect_pending_htlcs_forwardable!(nodes[0]);
+       check_added_monitors(&nodes[0], 1);
+       let node_id_1 = nodes[1].node.get_our_node_id();
+       expect_htlc_handling_failed_destinations!(
+               nodes[0].node.get_and_clear_pending_events(),
+               &[HTLCDestination::NextHopChannel { node_id: Some(node_id_1), channel_id: chan_id_1 }]
+       );
+
+       let fail = get_htlc_update_msgs(&nodes[0], &nodes[2].node.get_our_node_id());
+       nodes[2].node.handle_update_fail_htlc(&nodes[0].node.get_our_node_id(), &fail.update_fail_htlcs[0]);
+       commitment_signed_dance!(nodes[2], nodes[0], fail.commitment_signed, false);
+       expect_payment_failed_conditions(&nodes[2], payment_hash, false, PaymentFailedConditions::new());
+}
+
+
 #[test]
 fn test_non_final_funding_tx() {
        let chanmon_cfgs = create_chanmon_cfgs(2);
@@ -10150,14 +10287,9 @@ fn test_non_final_funding_tx() {
                },
                _ => panic!()
        }
-       let events = nodes[0].node.get_and_clear_pending_events();
-       assert_eq!(events.len(), 1);
-       match events[0] {
-               Event::ChannelClosed { channel_id, .. } => {
-                       assert_eq!(channel_id, temp_channel_id);
-               },
-               _ => panic!("Unexpected event"),
-       }
+       let err = "Error in transaction funding: Misuse error: Funding transaction absolute timelock is non-final".to_owned();
+       check_closed_events(&nodes[0], &[ExpectedCloseEvent::from_id_reason(temp_channel_id, false, ClosureReason::ProcessingError { err })]);
+       assert_eq!(get_err_msg(&nodes[0], &nodes[1].node.get_our_node_id()).data, "Failed to fund channel");
 }
 
 #[test]