From: Matt Corallo <git@bluematt.me>
Date: Sun, 18 Sep 2022 13:34:39 +0000 (+0000)
Subject: Swap `Vec<&RouteHop>` parameters for slices
X-Git-Tag: v0.0.112~33^2~1
X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=commitdiff_plain;h=4910c7cffee4ce35de44c0bef361c2d822daacde;p=rust-lightning

Swap `Vec<&RouteHop>` parameters for slices

In c353c3ed7c40e689a3b9fb6730c6dabbd3c92cc5, new scorer-updating
methods were added to the `Router` object, however they were
passed as a `Vec` of references. We use the list-of-references
pattern to make bindings simpler (by not requiring allocations per
entry), however there's no reason prefer to passing a `Vec` over
a slice, given the `Vec` doesn't hold ownership of the objects
anyway.
---

diff --git a/lightning-invoice/src/payment.rs b/lightning-invoice/src/payment.rs
index 21d7def4a..226e8fe42 100644
--- a/lightning-invoice/src/payment.rs
+++ b/lightning-invoice/src/payment.rs
@@ -77,10 +77,10 @@
 //! #         first_hops: Option<&[&ChannelDetails]>, _inflight_htlcs: InFlightHtlcs
 //! #     ) -> Result<Route, LightningError> { unimplemented!() }
 //! #
-//! #     fn notify_payment_path_failed(&self, path: Vec<&RouteHop>, short_channel_id: u64) {  unimplemented!() }
-//! #     fn notify_payment_path_successful(&self, path: Vec<&RouteHop>) {  unimplemented!() }
-//! #     fn notify_payment_probe_successful(&self, path: Vec<&RouteHop>) {  unimplemented!() }
-//! #     fn notify_payment_probe_failed(&self, path: Vec<&RouteHop>, short_channel_id: u64) { unimplemented!() }
+//! #     fn notify_payment_path_failed(&self, path: &[&RouteHop], short_channel_id: u64) {  unimplemented!() }
+//! #     fn notify_payment_path_successful(&self, path: &[&RouteHop]) {  unimplemented!() }
+//! #     fn notify_payment_probe_successful(&self, path: &[&RouteHop]) {  unimplemented!() }
+//! #     fn notify_payment_probe_failed(&self, path: &[&RouteHop], short_channel_id: u64) { unimplemented!() }
 //! # }
 //! #
 //! # struct FakeScorer {}
@@ -273,13 +273,13 @@ pub trait Router {
 		first_hops: Option<&[&ChannelDetails]>, inflight_htlcs: InFlightHtlcs
 	) -> Result<Route, LightningError>;
 	/// Lets the router know that payment through a specific path has failed.
-	fn notify_payment_path_failed(&self, path: Vec<&RouteHop>, short_channel_id: u64);
+	fn notify_payment_path_failed(&self, path: &[&RouteHop], short_channel_id: u64);
 	/// Lets the router know that payment through a specific path was successful.
-	fn notify_payment_path_successful(&self, path: Vec<&RouteHop>);
+	fn notify_payment_path_successful(&self, path: &[&RouteHop]);
 	/// Lets the router know that a payment probe was successful.
-	fn notify_payment_probe_successful(&self, path: Vec<&RouteHop>);
+	fn notify_payment_probe_successful(&self, path: &[&RouteHop]);
 	/// Lets the router know that a payment probe failed.
-	fn notify_payment_probe_failed(&self, path: Vec<&RouteHop>, short_channel_id: u64);
+	fn notify_payment_probe_failed(&self, path: &[&RouteHop], short_channel_id: u64);
 }
 
 /// Strategies available to retry payment path failures for an [`Invoice`].
@@ -680,7 +680,7 @@ where
 			} => {
 				if let Some(short_channel_id) = short_channel_id {
 					let path = path.iter().collect::<Vec<_>>();
-					self.router.notify_payment_path_failed(path, *short_channel_id)
+					self.router.notify_payment_path_failed(&path, *short_channel_id)
 				}
 
 				if payment_id.is_none() {
@@ -703,7 +703,7 @@ where
 			},
 			Event::PaymentPathSuccessful { path, .. } => {
 				let path = path.iter().collect::<Vec<_>>();
-				self.router.notify_payment_path_successful(path);
+				self.router.notify_payment_path_successful(&path);
 			},
 			Event::PaymentSent { payment_hash, .. } => {
 				let mut payment_cache = self.payment_cache.lock().unwrap();
@@ -715,13 +715,13 @@ where
 			Event::ProbeSuccessful { payment_hash, path, .. } => {
 				log_trace!(self.logger, "Probe payment {} of {}msat was successful", log_bytes!(payment_hash.0), path.last().unwrap().fee_msat);
 				let path = path.iter().collect::<Vec<_>>();
-				self.router.notify_payment_probe_successful(path);
+				self.router.notify_payment_probe_successful(&path);
 			},
 			Event::ProbeFailed { payment_hash, path, short_channel_id, .. } => {
 				if let Some(short_channel_id) = short_channel_id {
 					log_trace!(self.logger, "Probe payment {} of {}msat failed at channel {}", log_bytes!(payment_hash.0), path.last().unwrap().fee_msat, *short_channel_id);
 					let path = path.iter().collect::<Vec<_>>();
-					self.router.notify_payment_probe_failed(path, *short_channel_id);
+					self.router.notify_payment_probe_failed(&path, *short_channel_id);
 				}
 			},
 			_ => {},
@@ -1844,20 +1844,20 @@ mod tests {
 			})
 		}
 
-		fn notify_payment_path_failed(&self, path: Vec<&RouteHop>, short_channel_id: u64) {
-			self.scorer.lock().payment_path_failed(&path, short_channel_id);
+		fn notify_payment_path_failed(&self, path: &[&RouteHop], short_channel_id: u64) {
+			self.scorer.lock().payment_path_failed(path, short_channel_id);
 		}
 
-		fn notify_payment_path_successful(&self, path: Vec<&RouteHop>) {
-			self.scorer.lock().payment_path_successful(&path);
+		fn notify_payment_path_successful(&self, path: &[&RouteHop]) {
+			self.scorer.lock().payment_path_successful(path);
 		}
 
-		fn notify_payment_probe_successful(&self, path: Vec<&RouteHop>) {
-			self.scorer.lock().probe_successful(&path);
+		fn notify_payment_probe_successful(&self, path: &[&RouteHop]) {
+			self.scorer.lock().probe_successful(path);
 		}
 
-		fn notify_payment_probe_failed(&self, path: Vec<&RouteHop>, short_channel_id: u64) {
-			self.scorer.lock().probe_failed(&path, short_channel_id);
+		fn notify_payment_probe_failed(&self, path: &[&RouteHop], short_channel_id: u64) {
+			self.scorer.lock().probe_failed(path, short_channel_id);
 		}
 	}
 
@@ -1871,13 +1871,13 @@ mod tests {
 			Err(LightningError { err: String::new(), action: ErrorAction::IgnoreError })
 		}
 
-		fn notify_payment_path_failed(&self, _path: Vec<&RouteHop>, _short_channel_id: u64) {}
+		fn notify_payment_path_failed(&self, _path: &[&RouteHop], _short_channel_id: u64) {}
 
-		fn notify_payment_path_successful(&self, _path: Vec<&RouteHop>) {}
+		fn notify_payment_path_successful(&self, _path: &[&RouteHop]) {}
 
-		fn notify_payment_probe_successful(&self, _path: Vec<&RouteHop>) {}
+		fn notify_payment_probe_successful(&self, _path: &[&RouteHop]) {}
 
-		fn notify_payment_probe_failed(&self, _path: Vec<&RouteHop>, _short_channel_id: u64) {}
+		fn notify_payment_probe_failed(&self, _path: &[&RouteHop], _short_channel_id: u64) {}
 	}
 
 	struct TestScorer {
@@ -2133,13 +2133,13 @@ mod tests {
 			self.0.borrow_mut().pop_front().unwrap()
 		}
 
-		fn notify_payment_path_failed(&self, _path: Vec<&RouteHop>, _short_channel_id: u64) {}
+		fn notify_payment_path_failed(&self, _path: &[&RouteHop], _short_channel_id: u64) {}
 
-		fn notify_payment_path_successful(&self, _path: Vec<&RouteHop>) {}
+		fn notify_payment_path_successful(&self, _path: &[&RouteHop]) {}
 
-		fn notify_payment_probe_successful(&self, _path: Vec<&RouteHop>) {}
+		fn notify_payment_probe_successful(&self, _path: &[&RouteHop]) {}
 
-		fn notify_payment_probe_failed(&self, _path: Vec<&RouteHop>, _short_channel_id: u64) {}
+		fn notify_payment_probe_failed(&self, _path: &[&RouteHop], _short_channel_id: u64) {}
 	}
 	impl ManualRouter {
 		fn expect_find_route(&self, result: Result<Route, LightningError>) {
diff --git a/lightning-invoice/src/utils.rs b/lightning-invoice/src/utils.rs
index d26be35fb..5faecbfab 100644
--- a/lightning-invoice/src/utils.rs
+++ b/lightning-invoice/src/utils.rs
@@ -483,20 +483,20 @@ impl<G: Deref<Target = NetworkGraph<L>>, L: Deref, S: Deref> Router for DefaultR
 		)
 	}
 
-	fn notify_payment_path_failed(&self, path: Vec<&RouteHop>, short_channel_id: u64) {
-		self.scorer.lock().payment_path_failed(&path, short_channel_id);
+	fn notify_payment_path_failed(&self, path: &[&RouteHop], short_channel_id: u64) {
+		self.scorer.lock().payment_path_failed(path, short_channel_id);
 	}
 
-	fn notify_payment_path_successful(&self, path: Vec<&RouteHop>) {
-		self.scorer.lock().payment_path_successful(&path);
+	fn notify_payment_path_successful(&self, path: &[&RouteHop]) {
+		self.scorer.lock().payment_path_successful(path);
 	}
 
-	fn notify_payment_probe_successful(&self, path: Vec<&RouteHop>) {
-		self.scorer.lock().probe_successful(&path);
+	fn notify_payment_probe_successful(&self, path: &[&RouteHop]) {
+		self.scorer.lock().probe_successful(path);
 	}
 
-	fn notify_payment_probe_failed(&self, path: Vec<&RouteHop>, short_channel_id: u64) {
-		self.scorer.lock().probe_failed(&path, short_channel_id);
+	fn notify_payment_probe_failed(&self, path: &[&RouteHop], short_channel_id: u64) {
+		self.scorer.lock().probe_failed(path, short_channel_id);
 	}
 }