Provide the full Path in payment and probe fail/success events

Author: valentinewallace

lightning/src/events/mod.rs

@@ -30,7 +30,7 @@ use crate::routing::gossip::NetworkUpdate;
 use crate::util::errors::APIError;
 use crate::util::ser::{BigSize, FixedLengthReader, Writeable, Writer, MaybeReadable, Readable, RequiredWrapper, UpgradableRequired, WithoutLength};
 use crate::util::string::UntrustedString;
-use crate::routing::router::{RouteHop, RouteParameters};
+use crate::routing::router::{BlindedTail, Path, RouteHop, RouteParameters};
 
 use bitcoin::{PackedLockTime, Transaction, OutPoint};
 #[cfg(anchors)]
@@ -447,7 +447,7 @@ pub enum Event {
 		/// The payment path that was successful.
 		///
 		/// May contain a closed channel if the HTLC sent along the path was fulfilled on chain.
-		path: Vec<RouteHop>,
+		path: Path,
 	},
 	/// Indicates an outbound HTLC we sent failed, likely due to an intermediary node being unable to
 	/// handle the HTLC.
@@ -480,7 +480,7 @@ pub enum Event {
 		/// [`NetworkGraph`]: crate::routing::gossip::NetworkGraph
 		failure: PathFailure,
 		/// The payment path that failed.
-		path: Vec<RouteHop>,
+		path: Path,
 		/// The channel responsible for the failed payment path.
 		///
 		/// Note that for route hints or for the first hop in a path this may be an SCID alias and
@@ -506,7 +506,7 @@ pub enum Event {
 		/// [`ChannelManager::send_probe`]: crate::ln::channelmanager::ChannelManager::send_probe
 		payment_hash: PaymentHash,
 		/// The payment path that was successful.
-		path: Vec<RouteHop>,
+		path: Path,
 	},
 	/// Indicates that a probe payment we sent failed at an intermediary node on the path.
 	ProbeFailed {
@@ -519,7 +519,7 @@ pub enum Event {
 		/// [`ChannelManager::send_probe`]: crate::ln::channelmanager::ChannelManager::send_probe
 		payment_hash: PaymentHash,
 		/// The payment path that failed.
-		path: Vec<RouteHop>,
+		path: Path,
 		/// The channel responsible for the failed probe.
 		///
 		/// Note that for route hints or for the first hop in a path this may be an SCID alias and
@@ -824,7 +824,8 @@ impl Writeable for Event {
 					(1, None::<NetworkUpdate>, option), // network_update in LDK versions prior to 0.0.114
 					(2, payment_failed_permanently, required),
 					(3, false, required), // all_paths_failed in LDK versions prior to 0.0.114
-					(5, *path, vec_type),
+					(4, path.blinded_tail, option),
+					(5, path.hops, vec_type),
 					(7, short_channel_id, option),
 					(9, None::<RouteParameters>, option), // retry in LDK versions prior to 0.0.115
 					(11, payment_id, option),
@@ -892,7 +893,8 @@ impl Writeable for Event {
 				write_tlv_fields!(writer, {
 					(0, payment_id, required),
 					(2, payment_hash, option),
-					(4, *path, vec_type)
+					(4, path.hops, vec_type),
+					(6, path.blinded_tail, option),
 				})
 			},
 			&Event::PaymentFailed { ref payment_id, ref payment_hash } => {
@@ -921,16 +923,18 @@ impl Writeable for Event {
 				write_tlv_fields!(writer, {
 					(0, payment_id, required),
 					(2, payment_hash, required),
-					(4, *path, vec_type)
+					(4, path.hops, vec_type),
+					(6, path.blinded_tail, option),
 				})
 			},
 			&Event::ProbeFailed { ref payment_id, ref payment_hash, ref path, ref short_channel_id } => {
 				23u8.write(writer)?;
 				write_tlv_fields!(writer, {
 					(0, payment_id, required),
 					(2, payment_hash, required),
-					(4, *path, vec_type),
+					(4, path.hops, vec_type),
 					(6, short_channel_id, option),
+					(8, path.blinded_tail, option),
 				})
 			},
 			&Event::HTLCHandlingFailed { ref prev_channel_id, ref failed_next_destination } => {
@@ -1055,6 +1059,7 @@ impl MaybeReadable for Event {
 					let mut payment_hash = PaymentHash([0; 32]);
 					let mut payment_failed_permanently = false;
 					let mut network_update = None;
+					let mut blinded_tail: Option<BlindedTail> = None;
 					let mut path: Option<Vec<RouteHop>> = Some(vec![]);
 					let mut short_channel_id = None;
 					let mut payment_id = None;
@@ -1063,6 +1068,7 @@ impl MaybeReadable for Event {
 						(0, payment_hash, required),
 						(1, network_update, upgradable_option),
 						(2, payment_failed_permanently, required),
+						(4, blinded_tail, option),
 						(5, path, vec_type),
 						(7, short_channel_id, option),
 						(11, payment_id, option),
@@ -1074,7 +1080,7 @@ impl MaybeReadable for Event {
 						payment_hash,
 						payment_failed_permanently,
 						failure,
-						path: path.unwrap(),
+						path: Path { hops: path.unwrap(), blinded_tail },
 						short_channel_id,
 						#[cfg(test)]
 						error_code,
@@ -1177,18 +1183,16 @@ impl MaybeReadable for Event {
 			},
 			13u8 => {
 				let f = || {
-					let mut payment_id = PaymentId([0; 32]);
-					let mut payment_hash = None;
-					let mut path: Option<Vec<RouteHop>> = Some(vec![]);
-					read_tlv_fields!(reader, {
+					_init_and_read_tlv_fields!(reader, {
 						(0, payment_id, required),
 						(2, payment_hash, option),
 						(4, path, vec_type),
+						(6, blinded_tail, option),
 					});
 					Ok(Some(Event::PaymentPathSuccessful {
-						payment_id,
+						payment_id: payment_id.0.unwrap(),
 						payment_hash,
-						path: path.unwrap(),
+						path: Path { hops: path.unwrap(), blinded_tail },
 					}))
 				};
 				f()
@@ -1235,38 +1239,33 @@ impl MaybeReadable for Event {
 			},
 			21u8 => {
 				let f = || {
-					let mut payment_id = PaymentId([0; 32]);
-					let mut payment_hash = PaymentHash([0; 32]);
-					let mut path: Option<Vec<RouteHop>> = Some(vec![]);
-					read_tlv_fields!(reader, {
+					_init_and_read_tlv_fields!(reader, {
 						(0, payment_id, required),
 						(2, payment_hash, required),
 						(4, path, vec_type),
+						(6, blinded_tail, option),
 					});
 					Ok(Some(Event::ProbeSuccessful {
-						payment_id,
-						payment_hash,
-						path: path.unwrap(),
+						payment_id: payment_id.0.unwrap(),
+						payment_hash: payment_hash.0.unwrap(),
+						path: Path { hops: path.unwrap(), blinded_tail },
 					}))
 				};
 				f()
 			},
 			23u8 => {
 				let f = || {
-					let mut payment_id = PaymentId([0; 32]);
-					let mut payment_hash = PaymentHash([0; 32]);
-					let mut path: Option<Vec<RouteHop>> = Some(vec![]);
-					let mut short_channel_id = None;
-					read_tlv_fields!(reader, {
+					_init_and_read_tlv_fields!(reader, {
 						(0, payment_id, required),
 						(2, payment_hash, required),
 						(4, path, vec_type),
 						(6, short_channel_id, option),
+						(8, blinded_tail, option),
 					});
 					Ok(Some(Event::ProbeFailed {
-						payment_id,
-						payment_hash,
-						path: path.unwrap(),
+						payment_id: payment_id.0.unwrap(),
+						payment_hash: payment_hash.0.unwrap(),
+						path: Path { hops: path.unwrap(), blinded_tail },
 						short_channel_id,
 					}))
 				};

lightning/src/ln/channelmanager.rs

@@ -8133,15 +8133,15 @@ mod tests {
 			Event::PaymentPathSuccessful { payment_id: ref actual_payment_id, ref payment_hash, ref path } => {
 				assert_eq!(payment_id, *actual_payment_id);
 				assert_eq!(our_payment_hash, *payment_hash.as_ref().unwrap());
-				assert_eq!(route.paths[0].hops, *path);
+				assert_eq!(route.paths[0], *path);
 			},
 			_ => panic!("Unexpected event"),
 		}
 		match events[2] {
 			Event::PaymentPathSuccessful { payment_id: ref actual_payment_id, ref payment_hash, ref path } => {
 				assert_eq!(payment_id, *actual_payment_id);
 				assert_eq!(our_payment_hash, *payment_hash.as_ref().unwrap());
-				assert_eq!(route.paths[0].hops, *path);
+				assert_eq!(route.paths[0], *path);
 			},
 			_ => panic!("Unexpected event"),
 		}

lightning/src/ln/functional_test_utils.rs

@@ -2314,7 +2314,7 @@ pub fn pass_failed_payment_back<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expe
 					assert_eq!(payment_hash, our_payment_hash);
 					assert!(payment_failed_permanently);
 					for (idx, hop) in expected_route.iter().enumerate() {
-						assert_eq!(hop.node.get_our_node_id(), path[idx].pubkey);
+						assert_eq!(hop.node.get_our_node_id(), path.hops[idx].pubkey);
 					}
 					payment_id.unwrap()
 				},

lightning/src/ln/outbound_payment.rs

@@ -787,7 +787,7 @@ impl OutboundPayments {
 					payment_hash,
 					payment_failed_permanently: false,
 					failure: events::PathFailure::InitialSend { err: e },
-					path: path.hops,
+					path,
 					short_channel_id: failed_scid,
 					#[cfg(test)]
 					error_code: None,
@@ -1042,7 +1042,7 @@ impl OutboundPayments {
 						events::Event::PaymentPathSuccessful {
 							payment_id,
 							payment_hash,
-							path: path.hops,
+							path,
 						}
 					);
 				}
@@ -1066,7 +1066,7 @@ impl OutboundPayments {
 							events::Event::PaymentPathSuccessful {
 								payment_id,
 								payment_hash: payment.get().payment_hash(),
-								path: path.hops,
+								path,
 							}
 						);
 					}
@@ -1192,13 +1192,13 @@ impl OutboundPayments {
 					events::Event::ProbeSuccessful {
 						payment_id: *payment_id,
 						payment_hash: payment_hash.clone(),
-						path: path.hops.clone(),
+						path: path.clone(),
 					}
 				} else {
 					events::Event::ProbeFailed {
 						payment_id: *payment_id,
 						payment_hash: payment_hash.clone(),
-						path: path.hops.clone(),
+						path: path.clone(),
 						short_channel_id,
 					}
 				}
@@ -1214,7 +1214,7 @@ impl OutboundPayments {
 					payment_hash: payment_hash.clone(),
 					payment_failed_permanently: !payment_retryable,
 					failure: events::PathFailure::OnPath { network_update },
-					path: path.hops.clone(),
+					path: path.clone(),
 					short_channel_id,
 					#[cfg(test)]
 					error_code: onion_error_code,