X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=lightning%2Fsrc%2Futil%2Fevents.rs;h=2282ea55ab36211576b4726645af7579179001f8;hb=29e34c8a10cf813116c9251188a86978cc97e259;hp=caba7753f3fbb9bbf9b5364f6ab2488f8e6a6503;hpb=a600eee87c96ee8865402e86bb1865011bf2d2de;p=rust-lightning

diff --git a/lightning/src/util/events.rs b/lightning/src/util/events.rs
index caba7753..2282ea55 100644
--- a/lightning/src/util/events.rs
+++ b/lightning/src/util/events.rs
@@ -382,6 +382,38 @@ pub enum Event {
 #[cfg(test)]
 		error_data: Option<Vec<u8>>,
 	},
+	/// Indicates that a probe payment we sent returned successful, i.e., only failed at the destination.
+	ProbeSuccessful {
+		/// The id returned by [`ChannelManager::send_probe`].
+		///
+		/// [`ChannelManager::send_probe`]: crate::ln::channelmanager::ChannelManager::send_probe
+		payment_id: PaymentId,
+		/// The hash generated by [`ChannelManager::send_probe`].
+		///
+		/// [`ChannelManager::send_probe`]: crate::ln::channelmanager::ChannelManager::send_probe
+		payment_hash: PaymentHash,
+		/// The payment path that was successful.
+		path: Vec<RouteHop>,
+	},
+	/// Indicates that a probe payment we sent failed at an intermediary node on the path.
+	ProbeFailed {
+		/// The id returned by [`ChannelManager::send_probe`].
+		///
+		/// [`ChannelManager::send_probe`]: crate::ln::channelmanager::ChannelManager::send_probe
+		payment_id: PaymentId,
+		/// The hash generated by [`ChannelManager::send_probe`].
+		///
+		/// [`ChannelManager::send_probe`]: crate::ln::channelmanager::ChannelManager::send_probe
+		payment_hash: PaymentHash,
+		/// The payment path that failed.
+		path: Vec<RouteHop>,
+		/// 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
+		/// may not refer to a channel in the public network graph. These aliases may also collide
+		/// with channels in the public network graph.
+		short_channel_id: Option<u64>,
+	},
 	/// Used to indicate that [`ChannelManager::process_pending_htlc_forwards`] should be called at
 	/// a time in the future.
 	///
@@ -635,6 +667,23 @@ impl Writeable for Event {
 					(4, amount_msat, required),
 				});
 			},
+			&Event::ProbeSuccessful { ref payment_id, ref payment_hash, ref path } => {
+				21u8.write(writer)?;
+				write_tlv_fields!(writer, {
+					(0, payment_id, required),
+					(2, payment_hash, required),
+					(4, path, vec_type)
+				})
+			},
+			&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),
+					(6, short_channel_id, option),
+				})
+			},
 			// Note that, going forward, all new events must only write data inside of
 			// `write_tlv_fields`. Versions 0.0.101+ will ignore odd-numbered events that write
 			// data via `write_tlv_fields`.
@@ -854,6 +903,45 @@ impl MaybeReadable for Event {
 				};
 				f()
 			},
+			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, {
+						(0, payment_id, required),
+						(2, payment_hash, required),
+						(4, path, vec_type),
+					});
+					Ok(Some(Event::ProbeSuccessful {
+						payment_id,
+						payment_hash,
+						path: path.unwrap(),
+					}))
+				};
+				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, {
+						(0, payment_id, required),
+						(2, payment_hash, required),
+						(4, path, vec_type),
+						(6, short_channel_id, option),
+					});
+					Ok(Some(Event::ProbeFailed{
+						payment_id,
+						payment_hash,
+						path: path.unwrap(),
+						short_channel_id,
+					}))
+				};
+				f()
+			},
 			// Versions prior to 0.0.100 did not ignore odd types, instead returning InvalidValue.
 			// Version 0.0.100 failed to properly ignore odd types, possibly resulting in corrupt
 			// reads.