Merge pull request #4693 from valentinewallace/2026-06-sendwithroute-33b-pk

`Route::route_params`: `Option` -> required

Author: TheBlueMatt

fuzz/src/chanmon_consistency.rs

@@ -1866,7 +1866,7 @@ impl PaymentTracker {
 				}],
 				blinded_tail: None,
 			}],
-			route_params: Some(route_params.clone()),
+			route_params: route_params.clone(),
 		};
 		let onion = RecipientOnionFields::secret_only(secret, amt);
 		let res = source.send_payment_with_route(route, hash, onion, id);
@@ -1946,7 +1946,7 @@ impl PaymentTracker {
 				],
 				blinded_tail: None,
 			}],
-			route_params: Some(route_params.clone()),
+			route_params: route_params.clone(),
 		};
 		let onion = RecipientOnionFields::secret_only(secret, amt);
 		let res = source.send_payment_with_route(route, hash, onion, id);
@@ -2028,7 +2028,7 @@ impl PaymentTracker {
 			PaymentParameters::from_node_id(dest.get_our_node_id(), TEST_FINAL_CLTV),
 			amt,
 		);
-		let route = Route { paths, route_params: Some(route_params) };
+		let route = Route { paths, route_params };
 		let onion = RecipientOnionFields::secret_only(secret, amt);
 		let res = source.send_payment_with_route(route, hash, onion, id);
 		let succeeded = match res {
@@ -2132,7 +2132,7 @@ impl PaymentTracker {
 			PaymentParameters::from_node_id(dest.get_our_node_id(), TEST_FINAL_CLTV),
 			amt,
 		);
-		let route = Route { paths, route_params: Some(route_params) };
+		let route = Route { paths, route_params };
 		let onion = RecipientOnionFields::secret_only(secret, amt);
 		let res = source.send_payment_with_route(route, hash, onion, id);
 		let succeeded = match res {

lightning/src/ln/blinded_payment_tests.rs

@@ -2093,6 +2093,7 @@ fn test_trampoline_forward_payload_encoded_as_receive() {
 	let bob_carol_scid = nodes[1].node().list_channels().iter().find(|c| c.channel_id == chan_id_bob_carol).unwrap().short_channel_id.unwrap();
 
 	let amt_msat = 1000;
+	let carol_cltv_expiry_delta = 24 + 39;
 	let (payment_preimage, payment_hash, _) = get_payment_preimage_hash(&nodes[2], Some(amt_msat), None);
 
 	// We need the session priv to construct an invalid onion packet later.
@@ -2148,7 +2149,7 @@ fn test_trampoline_forward_payload_encoded_as_receive() {
 					short_channel_id: bob_carol_scid,
 					channel_features: ChannelFeatures::empty(),
 					fee_msat: 0,
-					cltv_expiry_delta: 24 + 39,
+					cltv_expiry_delta: carol_cltv_expiry_delta,
 					maybe_announced_channel: false,
 				}
 			],
@@ -2159,7 +2160,7 @@ fn test_trampoline_forward_payload_encoded_as_receive() {
 						pubkey: carol_node_id,
 						node_features: Features::empty(),
 						fee_msat: amt_msat,
-						cltv_expiry_delta: 24 + 39,
+						cltv_expiry_delta: carol_cltv_expiry_delta,
 					},
 				],
 				hops: carol_blinded_hops,
@@ -2168,7 +2169,10 @@ fn test_trampoline_forward_payload_encoded_as_receive() {
 				final_value_msat: amt_msat,
 			})
 		}],
-		route_params: None,
+		route_params: RouteParameters::from_payment_params_and_value(
+			PaymentParameters::from_node_id(carol_node_id, carol_cltv_expiry_delta),
+			amt_msat,
+		),
 	};
 
 	nodes[0].node.send_payment_with_route(route.clone(), payment_hash, RecipientOnionFields::spontaneous_empty(amt_msat), PaymentId(payment_hash.0)).unwrap();
@@ -2279,6 +2283,7 @@ fn do_test_trampoline_single_hop_receive(success: bool) {
 	let bob_carol_scid = nodes[1].node().list_channels().iter().find(|c| c.channel_id == chan_id_bob_carol).unwrap().short_channel_id.unwrap();
 
 	let amt_msat = 1000;
+	let carol_cltv_expiry_delta = 104 + 39;
 	let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash(&nodes[2], Some(amt_msat), None);
 
 	// Create a 1-hop blinded path for Carol.
@@ -2314,7 +2319,7 @@ fn do_test_trampoline_single_hop_receive(success: bool) {
 					short_channel_id: bob_carol_scid,
 					channel_features: ChannelFeatures::empty(),
 					fee_msat: 0,
-					cltv_expiry_delta: 104 + 39,
+					cltv_expiry_delta: carol_cltv_expiry_delta,
 					maybe_announced_channel: false,
 				}
 			],
@@ -2325,7 +2330,7 @@ fn do_test_trampoline_single_hop_receive(success: bool) {
 						pubkey: carol_node_id,
 						node_features: Features::empty(),
 						fee_msat: amt_msat,
-						cltv_expiry_delta: 104 + 39,
+						cltv_expiry_delta: carol_cltv_expiry_delta,
 					},
 				],
 				hops: blinded_path.blinded_hops().to_vec(),
@@ -2334,7 +2339,10 @@ fn do_test_trampoline_single_hop_receive(success: bool) {
 				final_value_msat: amt_msat,
 			})
 		}],
-		route_params: None,
+		route_params: RouteParameters::from_payment_params_and_value(
+			PaymentParameters::from_node_id(carol_node_id, carol_cltv_expiry_delta),
+			amt_msat,
+		),
 	};
 
 	nodes[0].node.send_payment_with_route(route.clone(), payment_hash, RecipientOnionFields::spontaneous_empty(amt_msat), PaymentId(payment_hash.0)).unwrap();
@@ -2618,7 +2626,13 @@ fn do_test_trampoline_relay(blinded: bool, test_case: TrampolineTestCase) {
 				original_amt_msat,
 			)),
 		}],
-		route_params: None,
+		route_params: RouteParameters::from_payment_params_and_value(
+			PaymentParameters::from_node_id(
+				carol_node_id,
+				original_trampoline_cltv + excess_final_cltv,
+			),
+			original_amt_msat,
+		),
 	};
 
 	nodes[0]
@@ -2753,6 +2767,7 @@ fn test_trampoline_forward_rejection() {
 	let bob_carol_scid = nodes[1].node().list_channels().iter().find(|c| c.channel_id == chan_id_bob_carol).unwrap().short_channel_id.unwrap();
 
 	let amt_msat = 1000;
+	let carol_cltv_expiry_delta = 24 + 24 + 39;
 	let (payment_preimage, payment_hash, _) = get_payment_preimage_hash(&nodes[2], Some(amt_msat), None);
 
 	let route = Route {
@@ -2776,7 +2791,7 @@ fn test_trampoline_forward_rejection() {
 					short_channel_id: bob_carol_scid,
 					channel_features: ChannelFeatures::empty(),
 					fee_msat: 0,
-					cltv_expiry_delta: 24 + 24 + 39,
+					cltv_expiry_delta: carol_cltv_expiry_delta,
 					maybe_announced_channel: false,
 				}
 			],
@@ -2808,7 +2823,10 @@ fn test_trampoline_forward_rejection() {
 				final_value_msat: amt_msat,
 			})
 		}],
-		route_params: None,
+		route_params: RouteParameters::from_payment_params_and_value(
+			PaymentParameters::from_node_id(carol_node_id, carol_cltv_expiry_delta),
+			amt_msat,
+		),
 	};
 
 	nodes[0].node.send_payment_with_route(route.clone(), payment_hash, RecipientOnionFields::spontaneous_empty(amt_msat), PaymentId(payment_hash.0)).unwrap();

lightning/src/ln/chanmon_update_fail_tests.rs

@@ -2315,7 +2315,7 @@ fn test_path_paused_mpp() {
 	route.paths[1].hops[0].pubkey = node_c_id;
 	route.paths[1].hops[0].short_channel_id = chan_2_ann.contents.short_channel_id;
 	route.paths[1].hops[1].short_channel_id = chan_4_id;
-	route.route_params.as_mut().unwrap().final_value_msat *= 2;
+	route.route_params.final_value_msat *= 2;
 
 	// Set it so that the first monitor update (for the path 0 -> 1 -> 3) succeeds, but the second
 	// (for the path 0 -> 2 -> 3) fails.
@@ -4315,7 +4315,7 @@ fn do_test_partial_claim_mon_update_compl_actions(reload_a: bool, reload_b: bool
 	route.paths[1].hops[0].pubkey = node_c_id;
 	route.paths[1].hops[0].short_channel_id = chan_2_scid;
 	route.paths[1].hops[1].short_channel_id = chan_4_scid;
-	route.route_params.as_mut().unwrap().final_value_msat *= 2;
+	route.route_params.final_value_msat *= 2;
 
 	let paths = &[&[&nodes[1], &nodes[3]][..], &[&nodes[2], &nodes[3]][..]];
 	send_along_route_with_secret(&nodes[0], route, paths, 200_000, payment_hash, payment_secret);

lightning/src/ln/channelmanager.rs

@@ -5631,30 +5631,32 @@ impl<
 	///
 	/// LDK will not automatically retry this payment, though it may be manually re-sent after an
 	/// [`Event::PaymentFailed`] is generated.
-	#[rustfmt::skip]
 	pub fn send_payment_with_route(
-		&self, mut route: Route, payment_hash: PaymentHash, recipient_onion: RecipientOnionFields,
-		payment_id: PaymentId
+		&self, route: Route, payment_hash: PaymentHash, recipient_onion: RecipientOnionFields,
+		payment_id: PaymentId,
 	) -> Result<(), RetryableSendFailure> {
 		let best_block_height = self.best_block.read().unwrap().height;
 		let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
-		let route_params = route.route_params.clone().unwrap_or_else(|| {
-			// Create a dummy route params since they're a required parameter but unused in this case
-			let (payee_node_id, cltv_delta) = route.paths.first()
-				.and_then(|path| path.hops.last().map(|hop| (hop.pubkey, hop.cltv_expiry_delta as u32)))
-				.unwrap_or_else(|| (PublicKey::from_slice(&[2; 33]).unwrap(), MIN_FINAL_CLTV_EXPIRY_DELTA as u32));
-			let dummy_payment_params = PaymentParameters::from_node_id(payee_node_id, cltv_delta);
-			RouteParameters::from_payment_params_and_value(dummy_payment_params, route.get_total_amount())
-		});
-		if route.route_params.is_none() { route.route_params = Some(route_params.clone()); }
+		let route_params = route.route_params.clone();
 		let router = FixedRouter::new(route);
 		let logger =
 			WithContext::for_payment(&self.logger, None, None, Some(payment_hash), payment_id);
-		self.pending_outbound_payments
-			.send_payment(payment_hash, recipient_onion, payment_id, Retry::Attempts(0),
-				route_params, &&router, self.list_usable_channels(), || self.compute_inflight_htlcs(),
-				&self.entropy_source, &self.node_signer, best_block_height,
-				&self.pending_events, |args| self.send_payment_along_path(args), &logger)
+		self.pending_outbound_payments.send_payment(
+			payment_hash,
+			recipient_onion,
+			payment_id,
+			Retry::Attempts(0),
+			route_params,
+			&&router,
+			self.list_usable_channels(),
+			|| self.compute_inflight_htlcs(),
+			&self.entropy_source,
+			&self.node_signer,
+			best_block_height,
+			&self.pending_events,
+			|args| self.send_payment_along_path(args),
+			&logger,
+		)
 	}
 
 	/// Sends a payment to the route found using the provided [`RouteParameters`], retrying failed
@@ -21095,7 +21097,7 @@ mod tests {
 		// Next, send a keysend payment with the same payment_hash and make sure it fails.
 		nodes[0].node.send_spontaneous_payment(
 			Some(payment_preimage), RecipientOnionFields::spontaneous_empty(100_000),
-			PaymentId(payment_preimage.0), route.route_params.clone().unwrap(), Retry::Attempts(0)
+			PaymentId(payment_preimage.0), route.route_params.clone(), Retry::Attempts(0)
 		).unwrap();
 		check_added_monitors(&nodes[0], 1);
 		let mut events = nodes[0].node.get_and_clear_pending_msg_events();
@@ -21251,7 +21253,7 @@ mod tests {
 		).unwrap();
 		let payment_hash = nodes[0].node.send_spontaneous_payment(
 			Some(payment_preimage), RecipientOnionFields::spontaneous_empty(100_000),
-			PaymentId(payment_preimage.0), route.route_params.clone().unwrap(), Retry::Attempts(0)
+			PaymentId(payment_preimage.0), route.route_params.clone(), Retry::Attempts(0)
 		).unwrap();
 	check_added_monitors(&nodes[0], 1);
 		let mut events = nodes[0].node.get_and_clear_pending_msg_events();
@@ -21294,7 +21296,7 @@ mod tests {
 		let payment_id_1 = PaymentId([44; 32]);
 		let payment_hash = nodes[0].node.send_spontaneous_payment(
 			Some(payment_preimage), RecipientOnionFields::spontaneous_empty(100_000), payment_id_1,
-			route.route_params.clone().unwrap(), Retry::Attempts(0)
+			route.route_params.clone(), Retry::Attempts(0)
 		).unwrap();
 		check_added_monitors(&nodes[0], 1);
 		let mut events = nodes[0].node.get_and_clear_pending_msg_events();
@@ -21412,7 +21414,7 @@ mod tests {
 		route.paths[1].hops[0].pubkey = nodes[2].node.get_our_node_id();
 		route.paths[1].hops[0].short_channel_id = chan_2_id;
 		route.paths[1].hops[1].short_channel_id = chan_4_id;
-		route.route_params.as_mut().unwrap().final_value_msat *= 2;
+		route.route_params.final_value_msat *= 2;
 
 		nodes[0].node.send_payment_with_route(route, payment_hash,
 			RecipientOnionFields::spontaneous_empty(200000), PaymentId(payment_hash.0)).unwrap();

lightning/src/ln/functional_test_utils.rs

@@ -3492,14 +3492,14 @@ pub fn send_along_route_with_secret<'a, 'b, 'c>(
 	recv_value: u64, our_payment_hash: PaymentHash, our_payment_secret: PaymentSecret,
 ) -> PaymentId {
 	let payment_id = PaymentId(origin_node.keys_manager.backing.get_secure_random_bytes());
-	origin_node.router.expect_find_route(route.route_params.clone().unwrap(), Ok(route.clone()));
+	origin_node.router.expect_find_route(route.route_params.clone(), Ok(route.clone()));
 	origin_node
 		.node
 		.send_payment(
 			our_payment_hash,
 			RecipientOnionFields::secret_only(our_payment_secret, recv_value),
 			payment_id,
-			route.route_params.unwrap(),
+			route.route_params,
 			Retry::Attempts(0),
 		)
 		.unwrap();

lightning/src/ln/functional_tests.rs

@@ -164,7 +164,7 @@ pub fn fake_network_test() {
 	let route_params = RouteParameters::from_payment_params_and_value(payment_params, 1000000);
 	let route = Route {
 		paths: vec![Path { hops, blinded_tail: None }],
-		route_params: Some(route_params.clone()),
+		route_params: route_params.clone(),
 	};
 	let path: &[_] = &[&nodes[2], &nodes[3], &nodes[1]];
 	let payment_preimage_1 = send_along_route(&nodes[1], route, path, 1000000).0;
@@ -202,8 +202,7 @@ pub fn fake_network_test() {
 		+ chan_2.1.contents.fee_proportional_millionths as u64 * hops[2].fee_msat as u64 / 1000000;
 	hops[0].fee_msat = chan_3.1.contents.fee_base_msat as u64
 		+ chan_3.1.contents.fee_proportional_millionths as u64 * hops[1].fee_msat as u64 / 1000000;
-	let route =
-		Route { paths: vec![Path { hops, blinded_tail: None }], route_params: Some(route_params) };
+	let route = Route { paths: vec![Path { hops, blinded_tail: None }], route_params };
 	let path: &[_] = &[&nodes[3], &nodes[2], &nodes[1]];
 	let payment_hash_2 = send_along_route(&nodes[1], route, path, 1000000).1;
 
@@ -7214,7 +7213,7 @@ pub fn test_simple_mpp() {
 	route.paths[1].hops[0].pubkey = node_c_id;
 	route.paths[1].hops[0].short_channel_id = chan_2_id;
 	route.paths[1].hops[1].short_channel_id = chan_4_id;
-	route.route_params.as_mut().unwrap().final_value_msat = 200_000;
+	route.route_params.final_value_msat = 200_000;
 	let paths: &[&[_]] = &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]];
 	send_along_route_with_secret(&nodes[0], route, paths, 200_000, payment_hash, payment_secret);
 	claim_payment_along_route(ClaimAlongRouteArgs::new(&nodes[0], paths, payment_preimage));

lightning/src/ln/max_payment_path_len_tests.rs

@@ -110,7 +110,7 @@ fn large_payment_metadata() {
 		custom_tlvs: Vec::new(),
 		total_mpp_amount_msat: amt_msat,
 	};
-	let route_params = route_0_1.route_params.clone().unwrap();
+	let route_params = route_0_1.route_params.clone();
 	let id = PaymentId(payment_hash.0);
 	nodes[0]
 		.node
@@ -138,14 +138,14 @@ fn large_payment_metadata() {
 	let (payment_hash_2, _, payment_secret_2, encrypted_metadata_2) =
 		get_payment_hash!(nodes[2], payment_metadata.clone());
 	let (mut route_0_2, ..) = get_route_and_payment_hash!(&nodes[0], &nodes[2], amt_msat);
-	let mut route_params_0_2 = route_0_2.route_params.clone().unwrap();
+	let mut route_params_0_2 = route_0_2.route_params.clone();
 	route_params_0_2.payment_params.max_path_length = 1;
 	nodes[0].router.expect_find_route_query(route_params_0_2);
 	max_sized_onion.payment_secret = Some(payment_secret_2);
 	max_sized_onion.payment_metadata = Some(encrypted_metadata_2);
 
 	let id = PaymentId(payment_hash_2.0);
-	let mut route_params = route_0_2.route_params.clone().unwrap();
+	let mut route_params = route_0_2.route_params.clone();
 	let err = nodes[0]
 		.node
 		.send_payment(payment_hash_2, max_sized_onion.clone(), id, route_params, Retry::Attempts(0))
@@ -184,7 +184,7 @@ fn large_payment_metadata() {
 		_ => panic!(),
 	}
 
-	let route_params = route_0_1.route_params.clone().unwrap();
+	let route_params = route_0_1.route_params.clone();
 	let err = nodes[0]
 		.node
 		.send_payment(payment_hash_2, too_large_onion, id, route_params, Retry::Attempts(0))
@@ -202,10 +202,10 @@ fn large_payment_metadata() {
 		custom_tlvs: Vec::new(),
 		total_mpp_amount_msat: amt_msat,
 	};
-	let mut route_params_0_2 = route_0_2.route_params.clone().unwrap();
+	let mut route_params_0_2 = route_0_2.route_params.clone();
 	route_params_0_2.payment_params.max_path_length = 2;
 	nodes[0].router.expect_find_route_query(route_params_0_2);
-	let route_params = route_0_2.route_params.unwrap();
+	let route_params = route_0_2.route_params;
 	nodes[0]
 		.node
 		.send_payment(payment_hash_2, onion_allowing_2_hops, id, route_params, Retry::Attempts(0))

lightning/src/ln/onion_utils.rs

@@ -3034,7 +3034,7 @@ mod tests {
 	use crate::ln::channelmanager::PaymentId;
 	use crate::ln::msgs::{self, UpdateFailHTLC};
 	use crate::ln::types::ChannelId;
-	use crate::routing::router::{Path, PaymentParameters, Route, RouteHop};
+	use crate::routing::router::{Path, PaymentParameters, Route, RouteHop, RouteParameters};
 	use crate::types::features::{ChannelFeatures, NodeFeatures};
 	use crate::types::payment::PaymentHash;
 	use crate::util::ser::{VecWriter, Writeable, Writer};
@@ -3142,7 +3142,10 @@ mod tests {
 		let secp_ctx = Secp256k1::new();
 
 		let path = build_test_path();
-		let route = Route { paths: vec![path], route_params: None };
+		let payment_params = PaymentParameters::from_node_id(path.hops.last().unwrap().pubkey, 0);
+		let route_params =
+			RouteParameters::from_payment_params_and_value(payment_params, path.final_value_msat());
+		let route = Route { paths: vec![path], route_params };
 
 		let onion_keys =
 			super::construct_onion_keys(&secp_ctx, &route.paths[0], &get_test_session_key());