Merge pull request #4558 from tnull/2026-04-fix-keysend-mpp-timeout

Apply MPP receive timeout to keysend payments

Author: tnull

lightning/src/ln/channelmanager.rs

@@ -8878,27 +8878,24 @@ impl<
 						debug_assert!(false);
 						return false;
 					}
-					if let OnionPayload::Invoice { .. } = payment.htlcs[0].onion_payload {
-						// Check if we've received all the parts we need for an MPP (the value of the parts adds to total_msat).
-						// In this case we're not going to handle any timeouts of the parts here.
-						// This condition determining whether the MPP is complete here must match
-						// exactly the condition used in `process_pending_htlc_forwards`.
-						let total_intended_recvd_value =
-							payment.htlcs.iter().map(|h| h.sender_intended_value).sum();
-						let total_mpp_value = payment.onion_fields.total_mpp_amount_msat;
-						if total_mpp_value <= total_intended_recvd_value {
-							return true;
-						} else if payment.htlcs.iter_mut().any(|htlc| {
-							htlc.timer_ticks += 1;
-							return htlc.timer_ticks >= MPP_TIMEOUT_TICKS;
-						}) {
-							let htlcs = payment
-								.htlcs
-								.drain(..)
-								.map(|htlc: ClaimableHTLC| (htlc.prev_hop, *payment_hash));
-							timed_out_mpp_htlcs.extend(htlcs);
-							return false;
-						}
+					// Check if we've received all the parts we need for an MPP.
+					// This condition determining whether the MPP is complete here must match
+					// exactly the condition used in `process_pending_htlc_forwards`.
+					let total_intended_recvd_value =
+						payment.htlcs.iter().map(|h| h.sender_intended_value).sum();
+					let total_mpp_value = payment.onion_fields.total_mpp_amount_msat;
+					if total_mpp_value <= total_intended_recvd_value {
+						return true;
+					} else if payment.htlcs.iter_mut().any(|htlc| {
+						htlc.timer_ticks += 1;
+						return htlc.timer_ticks >= MPP_TIMEOUT_TICKS;
+					}) {
+						let htlcs = payment
+							.htlcs
+							.drain(..)
+							.map(|htlc: ClaimableHTLC| (htlc.prev_hop, *payment_hash));
+						timed_out_mpp_htlcs.extend(htlcs);
+						return false;
 					}
 					true
 				},

lightning/src/ln/payment_tests.rs

@@ -335,7 +335,7 @@ fn mpp_retry_overpay() {
 	expect_payment_sent!(&nodes[0], payment_preimage, Some(expected_total_fee_msat));
 }
 
-fn do_mpp_receive_timeout(send_partial_mpp: bool) {
+fn do_mpp_receive_timeout(send_partial_mpp: bool, keysend: bool) {
 	let chanmon_cfgs = create_chanmon_cfgs(4);
 	let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
 	let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
@@ -351,8 +351,12 @@ fn do_mpp_receive_timeout(send_partial_mpp: bool) {
 	let (chan_3_update, _, chan_3_id, _) = create_announced_chan_between_nodes(&nodes, 1, 3);
 	let (chan_4_update, _, _, _) = create_announced_chan_between_nodes(&nodes, 2, 3);
 
-	let (mut route, hash, payment_preimage, payment_secret) =
-		get_route_and_payment_hash!(nodes[0], nodes[3], 100_000);
+	let (mut route, hash, payment_preimage, payment_secret) = if keysend {
+		let payment_params = PaymentParameters::for_keysend(node_d_id, TEST_FINAL_CLTV, true);
+		get_route_and_payment_hash!(nodes[0], nodes[3], payment_params, 100_000)
+	} else {
+		get_route_and_payment_hash!(nodes[0], nodes[3], 100_000)
+	};
 	let path = route.paths[0].clone();
 	route.paths.push(path);
 	route.paths[0].hops[0].pubkey = node_b_id;
@@ -365,7 +369,22 @@ fn do_mpp_receive_timeout(send_partial_mpp: bool) {
 
 	// Initiate the MPP payment.
 	let onion = RecipientOnionFields::secret_only(payment_secret, 200_000);
-	nodes[0].node.send_payment_with_route(route, hash, onion, PaymentId(hash.0)).unwrap();
+	if keysend {
+		let route_params = route.route_params.clone().unwrap();
+		nodes[0].router.expect_find_route(route_params.clone(), Ok(route.clone()));
+		nodes[0]
+			.node
+			.send_spontaneous_payment(
+				Some(payment_preimage),
+				onion,
+				PaymentId(hash.0),
+				route_params,
+				Retry::Attempts(0),
+			)
+			.unwrap();
+	} else {
+		nodes[0].node.send_payment_with_route(route, hash, onion, PaymentId(hash.0)).unwrap();
+	}
 	check_added_monitors(&nodes[0], 2); // one monitor per path
 	let mut events = nodes[0].node.get_and_clear_pending_msg_events();
 	assert_eq!(events.len(), 2);
@@ -414,7 +433,17 @@ fn do_mpp_receive_timeout(send_partial_mpp: bool) {
 		let node_2_msgs = remove_first_msg_event_to_node(&node_c_id, &mut events);
 		let path = &[&nodes[2], &nodes[3]];
 		let payment_secret = Some(payment_secret);
-		pass_along_path(&nodes[0], path, 200_000, hash, payment_secret, node_2_msgs, true, None);
+		let expected_preimage = if keysend { Some(payment_preimage) } else { None };
+		pass_along_path(
+			&nodes[0],
+			path,
+			200_000,
+			hash,
+			payment_secret,
+			node_2_msgs,
+			true,
+			expected_preimage,
+		);
 
 		// Even after MPP_TIMEOUT_TICKS we should not timeout the MPP if we have all the parts
 		for _ in 0..MPP_TIMEOUT_TICKS {
@@ -428,8 +457,14 @@ fn do_mpp_receive_timeout(send_partial_mpp: bool) {
 
 #[test]
 fn mpp_receive_timeout() {
-	do_mpp_receive_timeout(true);
-	do_mpp_receive_timeout(false);
+	do_mpp_receive_timeout(true, false);
+	do_mpp_receive_timeout(false, false);
+}
+
+#[test]
+fn keysend_mpp_receive_timeout() {
+	do_mpp_receive_timeout(true, true);
+	do_mpp_receive_timeout(false, true);
 }
 
 #[test]