Add trampoline_hops field to Path

arik-so · arik-so · commit a85aca90cfc5 · 2024-11-21T09:11:53.000-08:00
diff --git a/fuzz/src/chanmon_consistency.rs b/fuzz/src/chanmon_consistency.rs
@@ -559,6 +559,7 @@ fn send_payment(
 					maybe_announced_channel: true,
 				}],
 				blinded_tail: None,
+				trampoline_hops: vec![],
 			}],
 			route_params: None,
 		},
@@ -639,6 +640,7 @@ fn send_hop_payment(
 					},
 				],
 				blinded_tail: None,
+				trampoline_hops: vec![],
 			}],
 			route_params: None,
 		},
diff --git a/lightning-background-processor/src/lib.rs b/lightning-background-processor/src/lib.rs
@@ -2540,7 +2540,7 @@ mod tests {
 				fee_msat: 0,
 				cltv_expiry_delta: MIN_CLTV_EXPIRY_DELTA as u32,
 				maybe_announced_channel: true,
-			}], blinded_tail: None };
+			}], trampoline_hops: vec![], blinded_tail: None };
 
 			$nodes[0].scorer.write_lock().expect(TestResult::PaymentFailure { path: path.clone(), short_channel_id: scored_scid });
 			$nodes[0].node.push_pending_event(Event::PaymentPathFailed {
diff --git a/lightning/src/events/mod.rs b/lightning/src/events/mod.rs
@@ -1911,7 +1911,7 @@ impl MaybeReadable for Event {
 						payment_hash,
 						payment_failed_permanently,
 						failure,
-						path: Path { hops: path.unwrap(), blinded_tail },
+						path: Path { hops: path.unwrap(), trampoline_hops: vec![], blinded_tail },
 						short_channel_id,
 						#[cfg(test)]
 						error_code,
@@ -2051,7 +2051,7 @@ impl MaybeReadable for Event {
 					Ok(Some(Event::PaymentPathSuccessful {
 						payment_id: payment_id.0.unwrap(),
 						payment_hash,
-						path: Path { hops: path, blinded_tail },
+						path: Path { hops: path, trampoline_hops: vec![], blinded_tail },
 					}))
 				};
 				f()
@@ -2131,7 +2131,7 @@ impl MaybeReadable for Event {
 					Ok(Some(Event::ProbeSuccessful {
 						payment_id: payment_id.0.unwrap(),
 						payment_hash: payment_hash.0.unwrap(),
-						path: Path { hops: path, blinded_tail },
+						path: Path { hops: path, trampoline_hops: vec![], blinded_tail },
 					}))
 				};
 				f()
@@ -2148,7 +2148,7 @@ impl MaybeReadable for Event {
 					Ok(Some(Event::ProbeFailed {
 						payment_id: payment_id.0.unwrap(),
 						payment_hash: payment_hash.0.unwrap(),
-						path: Path { hops: path, blinded_tail },
+						path: Path { hops: path, trampoline_hops: vec![], blinded_tail },
 						short_channel_id,
 					}))
 				};
diff --git a/lightning/src/ln/blinded_payment_tests.rs b/lightning/src/ln/blinded_payment_tests.rs
@@ -1511,6 +1511,7 @@ fn route_blinding_spec_test_vector() {
 			cltv_expiry_delta: 42,
 			maybe_announced_channel: false,
 		}],
+		trampoline_hops: vec![],
 		blinded_tail: Some(BlindedTail {
 			hops: blinded_hops,
 			blinding_point: bob_blinding_point,
diff --git a/lightning/src/ln/channel.rs b/lightning/src/ln/channel.rs
@@ -9850,7 +9850,7 @@ mod tests {
 			cltv_expiry: 200000000,
 			state: OutboundHTLCState::Committed,
 			source: HTLCSource::OutboundRoute {
-				path: Path { hops: Vec::new(), blinded_tail: None },
+				path: Path { hops: Vec::new(), trampoline_hops: vec![], blinded_tail: None },
 				session_priv: SecretKey::from_slice(&<Vec<u8>>::from_hex("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap(),
 				first_hop_htlc_msat: 548,
 				payment_id: PaymentId([42; 32]),
@@ -10226,6 +10226,7 @@ mod tests {
 					node_features: NodeFeatures::empty(), short_channel_id: 0, fee_msat: 0,
 					cltv_expiry_delta: 0, maybe_announced_channel: false,
 				}],
+				trampoline_hops: vec![],
 				blinded_tail: None
 			},
 			session_priv: test_utils::privkey(42),
diff --git a/lightning/src/ln/channelmanager.rs b/lightning/src/ln/channelmanager.rs
@@ -651,7 +651,7 @@ impl HTLCSource {
 	pub fn dummy() -> Self {
 		assert!(cfg!(not(feature = "grind_signatures")));
 		HTLCSource::OutboundRoute {
-			path: Path { hops: Vec::new(), blinded_tail: None },
+			path: Path { hops: Vec::new(), trampoline_hops: Vec::new(), blinded_tail: None },
 			session_priv: SecretKey::from_slice(&[1; 32]).unwrap(),
 			first_hop_htlc_msat: 0,
 			payment_id: PaymentId([2; 32]),
@@ -12167,7 +12167,7 @@ impl Readable for HTLCSource {
 					// instead.
 					payment_id = Some(PaymentId(*session_priv.0.unwrap().as_ref()));
 				}
-				let path = Path { hops: path_hops, blinded_tail };
+				let path = Path { hops: path_hops, trampoline_hops: vec![], blinded_tail };
 				if path.hops.len() == 0 {
 					return Err(DecodeError::InvalidValue);
 				}
diff --git a/lightning/src/ln/functional_tests.rs b/lightning/src/ln/functional_tests.rs
@@ -1093,7 +1093,7 @@ fn fake_network_test() {
 	hops[1].fee_msat = chan_4.1.contents.fee_base_msat as u64 + chan_4.1.contents.fee_proportional_millionths as u64 * hops[2].fee_msat as u64 / 1000000;
 	hops[0].fee_msat = chan_3.0.contents.fee_base_msat as u64 + chan_3.0.contents.fee_proportional_millionths as u64 * hops[1].fee_msat as u64 / 1000000;
 	let payment_preimage_1 = send_along_route(&nodes[1],
-		Route { paths: vec![Path { hops, blinded_tail: None }], route_params: None },
+		Route { paths: vec![Path { hops, trampoline_hops: vec![], blinded_tail: None }], route_params: None },
 			&vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
 
 	let mut hops = Vec::with_capacity(3);
@@ -1127,7 +1127,7 @@ fn fake_network_test() {
 	hops[1].fee_msat = chan_2.1.contents.fee_base_msat as u64 + 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 payment_hash_2 = send_along_route(&nodes[1],
-		Route { paths: vec![Path { hops, blinded_tail: None }], route_params: None },
+		Route { paths: vec![Path { hops, trampoline_hops: vec![], blinded_tail: None }], route_params: None },
 			&vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
 
 	// Claim the rebalances...
diff --git a/lightning/src/ln/onion_payment.rs b/lightning/src/ln/onion_payment.rs
@@ -539,7 +539,7 @@ mod tests {
 		// Ensure the onion will not fit all the payloads by adding a large custom TLV.
 		recipient_onion.custom_tlvs.push((13377331, vec![0; 1156]));
 
-		let path = Path { hops, blinded_tail: None, };
+		let path = Path { hops, trampoline_hops: vec![], blinded_tail: None, };
 		let onion_keys = super::onion_utils::construct_onion_keys(&secp_ctx, &path, &session_priv).unwrap();
 		let (onion_payloads, ..) = super::onion_utils::build_onion_payloads(
 			&path, total_amt_msat, &recipient_onion, cur_height + 1, &Some(keysend_preimage), None
@@ -565,6 +565,7 @@ mod tests {
 
 		let path = Path {
 			hops: hops,
+			trampoline_hops: vec![],
 			blinded_tail: None,
 		};
 
diff --git a/lightning/src/ln/onion_utils.rs b/lightning/src/ln/onion_utils.rs
@@ -1330,7 +1330,7 @@ mod tests {
 						channel_features: ChannelFeatures::empty(), node_features: NodeFeatures::empty(),
 						short_channel_id: 0, fee_msat: 0, cltv_expiry_delta: 0, maybe_announced_channel: true, // We fill in the payloads manually instead of generating them from RouteHops.
 					},
-			], blinded_tail: None }],
+			], trampoline_hops: vec![], blinded_tail: None }],
 			route_params: None,
 		};
 
diff --git a/lightning/src/ln/outbound_payment.rs b/lightning/src/ln/outbound_payment.rs
@@ -2543,7 +2543,7 @@ mod tests {
 				fee_msat: 0,
 				cltv_expiry_delta: 0,
 				maybe_announced_channel: true,
-			}], blinded_tail: None }],
+			}], trampoline_hops: vec![], blinded_tail: None }],
 			route_params: Some(route_params.clone()),
 		};
 		router.expect_find_route(route_params.clone(), Ok(route.clone()));
@@ -2899,6 +2899,7 @@ mod tests {
 								maybe_announced_channel: true,
 							}
 						],
+						trampoline_hops: vec![],
 						blinded_tail: None,
 					}
 				],
diff --git a/lightning/src/ln/payment_tests.rs b/lightning/src/ln/payment_tests.rs
@@ -2459,7 +2459,7 @@ fn auto_retry_partial_failure() {
 				fee_msat: amt_msat / 2,
 				cltv_expiry_delta: 100,
 				maybe_announced_channel: true,
-			}], blinded_tail: None },
+			}], trampoline_hops: vec![], blinded_tail: None },
 			Path { hops: vec![RouteHop {
 				pubkey: nodes[1].node.get_our_node_id(),
 				node_features: nodes[1].node.node_features(),
@@ -2468,7 +2468,7 @@ fn auto_retry_partial_failure() {
 				fee_msat: amt_msat / 2,
 				cltv_expiry_delta: 100,
 				maybe_announced_channel: true,
-			}], blinded_tail: None },
+			}], trampoline_hops: vec![], blinded_tail: None },
 		],
 		route_params: Some(route_params.clone()),
 	};
@@ -2490,7 +2490,7 @@ fn auto_retry_partial_failure() {
 				fee_msat: amt_msat / 4,
 				cltv_expiry_delta: 100,
 				maybe_announced_channel: true,
-			}], blinded_tail: None },
+			}], trampoline_hops: vec![], blinded_tail: None },
 			Path { hops: vec![RouteHop {
 				pubkey: nodes[1].node.get_our_node_id(),
 				node_features: nodes[1].node.node_features(),
@@ -2499,7 +2499,7 @@ fn auto_retry_partial_failure() {
 				fee_msat: amt_msat / 4,
 				cltv_expiry_delta: 100,
 				maybe_announced_channel: true,
-			}], blinded_tail: None },
+			}], trampoline_hops: vec![], blinded_tail: None },
 		],
 		route_params: Some(retry_1_params.clone()),
 	};
@@ -2521,7 +2521,7 @@ fn auto_retry_partial_failure() {
 				fee_msat: amt_msat / 4,
 				cltv_expiry_delta: 100,
 				maybe_announced_channel: true,
-			}], blinded_tail: None },
+			}], trampoline_hops: vec![], blinded_tail: None },
 		],
 		route_params: Some(retry_2_params.clone()),
 	};
@@ -2666,7 +2666,7 @@ fn auto_retry_zero_attempts_send_error() {
 				fee_msat: amt_msat,
 				cltv_expiry_delta: 100,
 				maybe_announced_channel: true,
-			}], blinded_tail: None },
+			}], trampoline_hops: vec![], blinded_tail: None },
 		],
 		route_params: Some(route_params.clone()),
 	};
@@ -2764,7 +2764,7 @@ fn retry_multi_path_single_failed_payment() {
 				fee_msat: 10_000,
 				cltv_expiry_delta: 100,
 				maybe_announced_channel: true,
-			}], blinded_tail: None },
+			}], trampoline_hops: vec![], blinded_tail: None },
 			Path { hops: vec![RouteHop {
 				pubkey: nodes[1].node.get_our_node_id(),
 				node_features: nodes[1].node.node_features(),
@@ -2773,7 +2773,7 @@ fn retry_multi_path_single_failed_payment() {
 				fee_msat: 100_000_001, // Our default max-HTLC-value is 10% of the channel value, which this is one more than
 				cltv_expiry_delta: 100,
 				maybe_announced_channel: true,
-			}], blinded_tail: None },
+			}], trampoline_hops: vec![], blinded_tail: None },
 		],
 		route_params: Some(route_params.clone()),
 	};
@@ -2855,7 +2855,7 @@ fn immediate_retry_on_failure() {
 				fee_msat: 100_000_001, // Our default max-HTLC-value is 10% of the channel value, which this is one more than
 				cltv_expiry_delta: 100,
 				maybe_announced_channel: true,
-			}], blinded_tail: None },
+			}], trampoline_hops: vec![], blinded_tail: None },
 		],
 		route_params: Some(route_params.clone()),
 	};
@@ -2949,7 +2949,7 @@ fn no_extra_retries_on_back_to_back_fail() {
 				fee_msat: 100_000_000,
 				cltv_expiry_delta: 100,
 				maybe_announced_channel: true,
-			}], blinded_tail: None },
+			}], trampoline_hops: vec![], blinded_tail: None },
 			Path { hops: vec![RouteHop {
 				pubkey: nodes[1].node.get_our_node_id(),
 				node_features: nodes[1].node.node_features(),
@@ -2966,7 +2966,7 @@ fn no_extra_retries_on_back_to_back_fail() {
 				fee_msat: 100_000_000,
 				cltv_expiry_delta: 100,
 				maybe_announced_channel: true,
-			}], blinded_tail: None }
+			}], trampoline_hops: vec![], blinded_tail: None }
 		],
 		route_params: Some(route_params.clone()),
 	};
@@ -3154,7 +3154,7 @@ fn test_simple_partial_retry() {
 				fee_msat: 100_000_000,
 				cltv_expiry_delta: 100,
 				maybe_announced_channel: true,
-			}], blinded_tail: None },
+			}], trampoline_hops: vec![], blinded_tail: None },
 			Path { hops: vec![RouteHop {
 				pubkey: nodes[1].node.get_our_node_id(),
 				node_features: nodes[1].node.node_features(),
@@ -3171,7 +3171,7 @@ fn test_simple_partial_retry() {
 				fee_msat: 100_000_000,
 				cltv_expiry_delta: 100,
 				maybe_announced_channel: true,
-			}], blinded_tail: None }
+			}], trampoline_hops: vec![], blinded_tail: None }
 		],
 		route_params: Some(route_params.clone()),
 	};
@@ -3325,7 +3325,7 @@ fn test_threaded_payment_retries() {
 				fee_msat: amt_msat / 1000,
 				cltv_expiry_delta: 100,
 				maybe_announced_channel: true,
-			}], blinded_tail: None },
+			}], trampoline_hops: vec![], blinded_tail: None },
 			Path { hops: vec![RouteHop {
 				pubkey: nodes[2].node.get_our_node_id(),
 				node_features: nodes[2].node.node_features(),
@@ -3342,7 +3342,7 @@ fn test_threaded_payment_retries() {
 				fee_msat: amt_msat - amt_msat / 1000,
 				cltv_expiry_delta: 100,
 				maybe_announced_channel: true,
-			}], blinded_tail: None }
+			}], trampoline_hops: vec![], blinded_tail: None }
 		],
 		route_params: Some(route_params.clone()),
 	};
diff --git a/lightning/src/routing/router.rs b/lightning/src/routing/router.rs
@@ -457,6 +457,9 @@ impl_writeable_tlv_based!(BlindedTail, {
 pub struct Path {
 	/// The list of unblinded hops in this [`Path`]. Must be at least length one.
 	pub hops: Vec<RouteHop>,
+	/// The list of unblinded Trampoline hops. If present, must be at least one.
+	/// The public key of the first Trampoline hop must match the public key of the last regular hop.
+	pub trampoline_hops: Vec<TrampolineHop>,
 	/// The blinded path at which this path terminates, if we're sending to one, and its metadata.
 	pub blinded_tail: Option<BlindedTail>,
 }
@@ -589,7 +592,7 @@ impl Readable for Route {
 			if hops.is_empty() { return Err(DecodeError::InvalidValue); }
 			min_final_cltv_expiry_delta =
 				cmp::min(min_final_cltv_expiry_delta, hops.last().unwrap().cltv_expiry_delta);
-			paths.push(Path { hops, blinded_tail: None });
+			paths.push(Path { hops, trampoline_hops: vec![], blinded_tail: None });
 		}
 		_init_and_read_len_prefixed_tlv_fields!(reader, {
 			(1, payment_params, (option: ReadableArgs, min_final_cltv_expiry_delta)),
@@ -3391,7 +3394,7 @@ where L::Target: Logger {
 			core::mem::replace(&mut hop.cltv_expiry_delta, prev_cltv_expiry_delta)
 		});
 
-		paths.push(Path { hops, blinded_tail });
+		paths.push(Path { hops, trampoline_hops: vec![], blinded_tail });
 	}
 	// Make sure we would never create a route with more paths than we allow.
 	debug_assert!(paths.len() <= payment_params.max_path_count.into());
@@ -7115,7 +7118,7 @@ mod tests {
 					channel_features: ChannelFeatures::empty(), node_features: NodeFeatures::empty(),
 					short_channel_id: 0, fee_msat: 225, cltv_expiry_delta: 0, maybe_announced_channel: true,
 				},
-			], blinded_tail: None }],
+			], trampoline_hops: vec![], blinded_tail: None }],
 			route_params: None,
 		};
 
@@ -7137,7 +7140,7 @@ mod tests {
 					channel_features: ChannelFeatures::empty(), node_features: NodeFeatures::empty(),
 					short_channel_id: 0, fee_msat: 150, cltv_expiry_delta: 0, maybe_announced_channel: true,
 				},
-			], blinded_tail: None }, Path { hops: vec![
+			], trampoline_hops: vec![], blinded_tail: None }, Path { hops: vec![
 				RouteHop {
 					pubkey: PublicKey::from_slice(&<Vec<u8>>::from_hex("02eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619").unwrap()[..]).unwrap(),
 					channel_features: ChannelFeatures::empty(), node_features: NodeFeatures::empty(),
@@ -7148,7 +7151,7 @@ mod tests {
 					channel_features: ChannelFeatures::empty(), node_features: NodeFeatures::empty(),
 					short_channel_id: 0, fee_msat: 150, cltv_expiry_delta: 0, maybe_announced_channel: true,
 				},
-			], blinded_tail: None }],
+			], trampoline_hops: vec![], blinded_tail: None }],
 			route_params: None,
 		};
 
@@ -7723,6 +7726,7 @@ mod tests {
 				cltv_expiry_delta: 0,
 				maybe_announced_channel: true,
 			}],
+			trampoline_hops: vec![],
 			blinded_tail: Some(BlindedTail {
 				hops: vec![
 					BlindedHop { blinded_node_id: ln_test_utils::pubkey(44), encrypted_payload: Vec::new() },
@@ -7741,7 +7745,7 @@ mod tests {
 				fee_msat: 100,
 				cltv_expiry_delta: 0,
 				maybe_announced_channel: true,
-			}], blinded_tail: None }],
+			}], trampoline_hops: vec![], blinded_tail: None }],
 			route_params: None,
 		};
 		let encoded_route = route.encode();
@@ -7790,6 +7794,7 @@ mod tests {
 				cltv_expiry_delta: 0,
 				maybe_announced_channel: false,
 			}],
+			trampoline_hops: vec![],
 			blinded_tail: Some(BlindedTail {
 				hops: vec![BlindedHop { blinded_node_id: ln_test_utils::pubkey(49), encrypted_payload: Vec::new() }],
 				blinding_point: ln_test_utils::pubkey(48),
@@ -7826,6 +7831,7 @@ mod tests {
 				maybe_announced_channel: false,
 			}
 			],
+			trampoline_hops: vec![],
 			blinded_tail: Some(BlindedTail {
 				hops: vec![
 					BlindedHop { blinded_node_id: ln_test_utils::pubkey(45), encrypted_payload: Vec::new() },
diff --git a/lightning/src/routing/scoring.rs b/lightning/src/routing/scoring.rs
