f - Remove NetworkGraph from Router interface

Author: jkczyz

lightning-invoice/src/payment.rs

@@ -12,8 +12,7 @@
 //! Defines an [`InvoicePayer`] utility for paying invoices, parameterized by [`Payer`] and
 //! [`Router`] traits. Implementations of [`Payer`] provide the payer's node id, channels, and means
 //! to send a payment over a [`Route`]. Implementations of [`Router`] find a [`Route`] between payer
-//! and payee using information provided by the payer and from the payee's [`Invoice`] along with a
-//! [`NetworkGraph`].
+//! and payee using information provided by the payer and from the payee's [`Invoice`].
 //!
 //! [`InvoicePayer`] caches each [`Invoice`] by its `payment_hash` so that [`PaymentRetryHandler`]
 //! can retry the payment if it fails. It accomplishes this by implementing [`EventHandler`] which
@@ -26,10 +25,10 @@
 //!
 //! # Note
 //!
-//! The [`Route`] is compute before each payment attempt. Any updates to the [`NetworkGraph`] or
-//! changes to channels scores should be applied prior to retries. This typically means any
-//! [`EventHandler`] decorators responsible for this should decorate [`PaymentRetryHandler`] so that
-//! such changes take effect before retrying.
+//! The [`Route`] is compute before each payment attempt. Any updates affecting path finding such as
+//! updates to the network graph or changes to channels scores should be applied prior to retries.
+//! This typically means any [`EventHandler`] decorators responsible for this should decorate
+//! [`PaymentRetryHandler`] so that such changes take effect before retrying.
 
 use crate::Invoice;
 
@@ -41,7 +40,6 @@ use lightning::ln::{PaymentHash, PaymentSecret};
 use lightning::ln::channelmanager::{ChannelDetails, PaymentSendFailure};
 use lightning::ln::features::InvoiceFeatures;
 use lightning::ln::msgs::LightningError;
-use lightning::routing::network_graph::NetworkGraph;
 use lightning::routing::router::{Route, RouteHint};
 use lightning::util::events::{Event, EventHandler};
 use lightning::util::logger::Logger;
@@ -56,11 +54,9 @@ use std::sync::Mutex;
 const MAX_PAYMENT_ATTEMPTS: usize = 3;
 
 /// A utility for paying [`Invoice]`s.
-pub struct InvoicePayer<P: Deref, R, G>
-where P::Target: Payer, R: Router, G: Deref<Target = NetworkGraph> {
+pub struct InvoicePayer<P: Deref, R> where P::Target: Payer, R: Router {
 	payer: P,
 	router: R,
-	network_graph: G,
 	invoice_cache: Mutex<HashMap<PaymentHash, Invoice>>,
 }
 
@@ -80,12 +76,11 @@ pub trait Payer {
 
 /// A trait defining behavior for routing an [`Invoice`] payment.
 pub trait Router {
-	/// Finds a [`Route`] between `payer` and `payee` using the provided first and last hops and
-	/// [`NetworkGraph`] for a payment with the given values.
+	/// Finds a [`Route`] between `payer` and `payee` using the provided first and last hops for a
+	/// payment with the given values.
 	fn find_route(
 		&self,
 		payer: &PublicKey,
-		network: &NetworkGraph,
 		payee: &PublicKey,
 		payee_features: Option<InvoiceFeatures>,
 		first_hops: Option<&[&ChannelDetails]>,
@@ -107,12 +102,11 @@ pub enum PaymentError {
 }
 
 /// An [`EventHandler`] decorator for retrying failed payments.
-pub struct PaymentRetryHandler<I, P: Deref, R, G, L: Deref, E>
+pub struct PaymentRetryHandler<I, P: Deref, R, L: Deref, E>
 where
-	I: Deref<Target = InvoicePayer<P, R, G>>,
+	I: Deref<Target = InvoicePayer<P, R>>,
 	P::Target: Payer,
 	R: Router,
-	G: Deref<Target = NetworkGraph>,
 	L::Target: Logger,
 	E: EventHandler,
 {
@@ -122,14 +116,12 @@ where
 	event_handler: E,
 }
 
-impl<P: Deref, R, G> InvoicePayer<P, R, G>
-where P::Target: Payer, R: Router, G: Deref<Target = NetworkGraph> {
+impl<P: Deref, R> InvoicePayer<P, R> where P::Target: Payer, R: Router {
 	/// Creates an invoice payer.
-	pub fn new(payer: P, router: R, network_graph: G) -> Self {
+	pub fn new(payer: P, router: R) -> Self {
 		Self {
 			payer,
 			router,
-			network_graph,
 			invoice_cache: Mutex::new(HashMap::new()),
 		}
 	}
@@ -167,7 +159,6 @@ where P::Target: Payer, R: Router, G: Deref<Target = NetworkGraph> {
 		let final_cltv = invoice.min_final_cltv_expiry() as u32;
 		let route = self.router.find_route(
 			&payer,
-			&*self.network_graph,
 			&payee,
 			payee_features,
 			Some(&first_hops.iter().collect::<Vec<_>>()),
@@ -191,12 +182,11 @@ where P::Target: Payer, R: Router, G: Deref<Target = NetworkGraph> {
 	}
 }
 
-impl<I, P: Deref, R, G, L: Deref, E> PaymentRetryHandler<I, P, R, G, L, E>
+impl<I, P: Deref, R, L: Deref, E> PaymentRetryHandler<I, P, R, L, E>
 where
-	I: Deref<Target = InvoicePayer<P, R, G>>,
+	I: Deref<Target = InvoicePayer<P, R>>,
 	P::Target: Payer,
 	R: Router,
-	G: Deref<Target = NetworkGraph>,
 	L::Target: Logger,
 	E: EventHandler,
 {
@@ -211,12 +201,11 @@ where
 	}
 }
 
-impl<I, P: Deref, R, G, L: Deref, E> EventHandler for PaymentRetryHandler<I, P, R, G, L, E>
+impl<I, P: Deref, R, L: Deref, E> EventHandler for PaymentRetryHandler<I, P, R, L, E>
 where
-	I: Deref<Target = InvoicePayer<P, R, G>>,
+	I: Deref<Target = InvoicePayer<P, R>>,
 	P::Target: Payer,
 	R: Router,
-	G: Deref<Target = NetworkGraph>,
 	L::Target: Logger,
 	E: EventHandler,
 {
@@ -270,12 +259,9 @@ mod tests {
 
 	use super::*;
 	use crate::{InvoiceBuilder, Currency};
-	use bitcoin::network::constants::Network;
-	use bitcoin::blockdata::constants::genesis_block;
 	use bitcoin::secp256k1::{SecretKey, PublicKey, Secp256k1};
 	use lightning::ln::PaymentPreimage;
 	use lightning::ln::msgs::{ErrorAction, LightningError};
-	use lightning::routing::network_graph::NetworkGraph;
 	use lightning::util::test_utils::TestLogger;
 	use lightning::util::events::Event;
 	use lightning::util::errors::APIError;
@@ -300,8 +286,7 @@ mod tests {
 	fn pays_invoice_on_first_attempt() {
 		let payer = TestPayer::new();
 		let router = NullRouter {};
-		let network_graph = NetworkGraph::new(genesis_block(Network::Testnet).header.block_hash());
-		let invoice_payer = InvoicePayer::new(&payer, router, &network_graph);
+		let invoice_payer = InvoicePayer::new(&payer, router);
 
 		let logger = TestLogger::new();
 		let event_handled = core::cell::RefCell::new(false);
@@ -322,8 +307,7 @@ mod tests {
 	fn pays_invoice_on_retry() {
 		let payer = TestPayer::new();
 		let router = NullRouter {};
-		let network_graph = NetworkGraph::new(genesis_block(Network::Testnet).header.block_hash());
-		let invoice_payer = InvoicePayer::new(&payer, router, &network_graph);
+		let invoice_payer = InvoicePayer::new(&payer, router);
 
 		let logger = TestLogger::new();
 		let event_handled = core::cell::RefCell::new(false);
@@ -349,8 +333,7 @@ mod tests {
 	fn fails_paying_invoice_after_max_retries() {
 		let payer = TestPayer::new();
 		let router = NullRouter {};
-		let network_graph = NetworkGraph::new(genesis_block(Network::Testnet).header.block_hash());
-		let invoice_payer = InvoicePayer::new(&payer, router, &network_graph);
+		let invoice_payer = InvoicePayer::new(&payer, router);
 
 		let logger = TestLogger::new();
 		let event_handled = core::cell::RefCell::new(false);
@@ -380,8 +363,7 @@ mod tests {
 	fn fails_paying_invoice_after_retry_error() {
 		let payer = TestPayer::new().fails_on_attempt(2);
 		let router = NullRouter {};
-		let network_graph = NetworkGraph::new(genesis_block(Network::Testnet).header.block_hash());
-		let invoice_payer = InvoicePayer::new(&payer, router, &network_graph);
+		let invoice_payer = InvoicePayer::new(&payer, router);
 
 		let logger = TestLogger::new();
 		let event_handled = core::cell::RefCell::new(false);
@@ -403,8 +385,7 @@ mod tests {
 	fn fails_paying_invoice_after_rejected_by_payee() {
 		let payer = TestPayer::new();
 		let router = NullRouter {};
-		let network_graph = NetworkGraph::new(genesis_block(Network::Testnet).header.block_hash());
-		let invoice_payer = InvoicePayer::new(&payer, router, &network_graph);
+		let invoice_payer = InvoicePayer::new(&payer, router);
 
 		let logger = TestLogger::new();
 		let event_handled = core::cell::RefCell::new(false);
@@ -426,8 +407,7 @@ mod tests {
 	fn fails_repaying_invoice_with_pending_payment() {
 		let payer = TestPayer::new();
 		let router = NullRouter {};
-		let network_graph = NetworkGraph::new(genesis_block(Network::Testnet).header.block_hash());
-		let invoice_payer = InvoicePayer::new(&payer, router, &network_graph);
+		let invoice_payer = InvoicePayer::new(&payer, router);
 
 		let logger = TestLogger::new();
 		let event_handled = core::cell::RefCell::new(false);
@@ -460,8 +440,7 @@ mod tests {
 	fn fails_paying_invoice_with_routing_errors() {
 		let payer = TestPayer::new();
 		let router = FailingRouter {};
-		let network_graph = NetworkGraph::new(genesis_block(Network::Testnet).header.block_hash());
-		let invoice_payer = InvoicePayer::new(&payer, router, &network_graph);
+		let invoice_payer = InvoicePayer::new(&payer, router);
 
 		let payment_preimage = PaymentPreimage([1; 32]);
 		let invoice = invoice(payment_preimage);
@@ -476,8 +455,7 @@ mod tests {
 	fn fails_paying_invoice_with_sending_errors() {
 		let payer = TestPayer::new().fails_on_attempt(1);
 		let router = NullRouter {};
-		let network_graph = NetworkGraph::new(genesis_block(Network::Testnet).header.block_hash());
-		let invoice_payer = InvoicePayer::new(&payer, router, &network_graph);
+		let invoice_payer = InvoicePayer::new(&payer, router);
 
 		let payment_preimage = PaymentPreimage([1; 32]);
 		let invoice = invoice(payment_preimage);
@@ -494,7 +472,6 @@ mod tests {
 		fn find_route(
 			&self,
 			_payer: &PublicKey,
-			_network: &NetworkGraph,
 			_payee: &PublicKey,
 			_payee_features: Option<InvoiceFeatures>,
 			_first_hops: Option<&[&ChannelDetails]>,
@@ -512,7 +489,6 @@ mod tests {
 		fn find_route(
 			&self,
 			_payer: &PublicKey,
-			_network: &NetworkGraph,
 			_payee: &PublicKey,
 			_payee_features: Option<InvoiceFeatures>,
 			_first_hops: Option<&[&ChannelDetails]>,