Allow to set LSPS1 liquidity source

We add support for LSPS1 liquidity sources. To this end we slightly
refactor our logic to first create a `LiquiditySourceBuilder` that then
can be used to `build()` the `LiquiditySource` with the configured
services.

Author: tnull

src/builder.rs

@@ -18,7 +18,7 @@ use crate::gossip::GossipSource;
 use crate::io::sqlite_store::SqliteStore;
 use crate::io::utils::{read_node_metrics, write_node_metrics};
 use crate::io::vss_store::VssStore;
-use crate::liquidity::LiquiditySource;
+use crate::liquidity::LiquiditySourceBuilder;
 use crate::logger::{log_error, log_info, LdkLogger, LogLevel, LogWriter, Logger};
 use crate::message_handler::NodeCustomMessageHandler;
 use crate::payment::store::PaymentStore;
@@ -54,9 +54,6 @@ use lightning::util::sweep::OutputSweeper;
 
 use lightning_persister::fs_store::FilesystemStore;
 
-use lightning_liquidity::lsps2::client::LSPS2ClientConfig;
-use lightning_liquidity::{LiquidityClientConfig, LiquidityManager};
-
 use bdk_wallet::template::Bip84;
 use bdk_wallet::KeychainKind;
 use bdk_wallet::Wallet as BdkWallet;
@@ -99,13 +96,15 @@ enum GossipSourceConfig {
 
 #[derive(Debug, Clone)]
 struct LiquiditySourceConfig {
+	// LSPS1 service's (node_id, address, token)
+	lsps1_service: Option<(PublicKey, SocketAddress, Option<String>)>,
 	// LSPS2 service's (node_id, address, token)
 	lsps2_service: Option<(PublicKey, SocketAddress, Option<String>)>,
 }
 
 impl Default for LiquiditySourceConfig {
 	fn default() -> Self {
-		Self { lsps2_service: None }
+		Self { lsps1_service: None, lsps2_service: None }
 	}
 }
 
@@ -322,13 +321,34 @@ impl NodeBuilder {
 		self
 	}
 
-	/// Configures the [`Node`] instance to source its inbound liquidity from the given
-	/// [LSPS2](https://github.com/BitcoinAndLightningLayerSpecs/lsp/blob/main/LSPS2/README.md)
-	/// service.
+	/// Configures the [`Node`] instance to source inbound liquidity from the given
+	/// [bLIP-51 / LSPS1] service.
 	///
 	/// Will mark the LSP as trusted for 0-confirmation channels, see [`Config::trusted_peers_0conf`].
 	///
 	/// The given `token` will be used by the LSP to authenticate the user.
+	///
+	/// [bLIP-51 / LSPS1]: https://github.com/lightning/blips/blob/master/blip-0051.md
+	pub fn set_liquidity_source_lsps1(
+		&mut self, node_id: PublicKey, address: SocketAddress, token: Option<String>,
+	) -> &mut Self {
+		// Mark the LSP as trusted for 0conf
+		self.config.trusted_peers_0conf.push(node_id.clone());
+
+		let liquidity_source_config =
+			self.liquidity_source_config.get_or_insert(LiquiditySourceConfig::default());
+		liquidity_source_config.lsps1_service = Some((node_id, address, token));
+		self
+	}
+
+	/// Configures the [`Node`] instance to source just-in-time inbound liquidity from the given
+	/// [bLIP-52 / LSPS2] service.
+	///
+	/// Will mark the LSP as trusted for 0-confirmation channels, see [`Config::trusted_peers_0conf`].
+	///
+	/// The given `token` will be used by the LSP to authenticate the user.
+	///
+	/// [bLIP-52 / LSPS2]: https://github.com/lightning/blips/blob/master/blip-0052.md
 	pub fn set_liquidity_source_lsps2(
 		&mut self, node_id: PublicKey, address: SocketAddress, token: Option<String>,
 	) -> &mut Self {
@@ -654,13 +674,28 @@ impl ArcedNodeBuilder {
 		self.inner.write().unwrap().set_gossip_source_rgs(rgs_server_url);
 	}
 
-	/// Configures the [`Node`] instance to source its inbound liquidity from the given
-	/// [LSPS2](https://github.com/BitcoinAndLightningLayerSpecs/lsp/blob/main/LSPS2/README.md)
-	/// service.
+	/// Configures the [`Node`] instance to source inbound liquidity from the given
+	/// [bLIP-51 / LSPS1] service.
 	///
 	/// Will mark the LSP as trusted for 0-confirmation channels, see [`Config::trusted_peers_0conf`].
 	///
 	/// The given `token` will be used by the LSP to authenticate the user.
+	///
+	/// [bLIP-51 / LSPS1]: https://github.com/lightning/blips/blob/master/blip-0051.md
+	pub fn set_liquidity_source_lsps1(
+		&self, node_id: PublicKey, address: SocketAddress, token: Option<String>,
+	) {
+		self.inner.write().unwrap().set_liquidity_source_lsps1(node_id, address, token);
+	}
+
+	/// Configures the [`Node`] instance to source just-in-time inbound liquidity from the given
+	/// [bLIP-52 / LSPS2] service.
+	///
+	/// Will mark the LSP as trusted for 0-confirmation channels, see [`Config::trusted_peers_0conf`].
+	///
+	/// The given `token` will be used by the LSP to authenticate the user.
+	///
+	/// [bLIP-52 / LSPS2]: https://github.com/lightning/blips/blob/master/blip-0052.md
 	pub fn set_liquidity_source_lsps2(
 		&self, node_id: PublicKey, address: SocketAddress, token: Option<String>,
 	) {
@@ -1129,30 +1164,24 @@ fn build_with_store_internal(
 		},
 	};
 
-	let liquidity_source = liquidity_source_config.as_ref().and_then(|lsc| {
+	let liquidity_source = liquidity_source_config.as_ref().map(|lsc| {
+		let mut liquidity_source_builder = LiquiditySourceBuilder::new(
+			Arc::clone(&channel_manager),
+			Arc::clone(&keys_manager),
+			Arc::clone(&chain_source),
+			Arc::clone(&config),
+			Arc::clone(&logger),
+		);
+
+		lsc.lsps1_service.as_ref().map(|(node_id, address, token)| {
+			liquidity_source_builder.lsps1_service(*node_id, address.clone(), token.clone())
+		});
+
 		lsc.lsps2_service.as_ref().map(|(node_id, address, token)| {
-			let lsps2_client_config = Some(LSPS2ClientConfig {});
-			let liquidity_client_config =
-				Some(LiquidityClientConfig { lsps1_client_config: None, lsps2_client_config });
-			let liquidity_manager = Arc::new(LiquidityManager::new(
-				Arc::clone(&keys_manager),
-				Arc::clone(&channel_manager),
-				Some(Arc::clone(&chain_source)),
-				None,
-				None,
-				liquidity_client_config,
-			));
-			Arc::new(LiquiditySource::new_lsps2(
-				*node_id,
-				address.clone(),
-				token.clone(),
-				Arc::clone(&channel_manager),
-				Arc::clone(&keys_manager),
-				liquidity_manager,
-				Arc::clone(&config),
-				Arc::clone(&logger),
-			))
-		})
+			liquidity_source_builder.lsps2_service(*node_id, address.clone(), token.clone())
+		});
+
+		Arc::new(liquidity_source_builder.build())
 	});
 
 	let custom_message_handler = if let Some(liquidity_source) = liquidity_source.as_ref() {

src/liquidity.rs

@@ -5,6 +5,7 @@
 // http://opensource.org/licenses/MIT>, at your option. You may not use this file except in
 // accordance with one or both of these licenses.
 
+use crate::chain::ChainSource;
 use crate::logger::{log_debug, log_error, log_info, LdkLogger};
 use crate::types::{ChannelManager, KeysManager, LiquidityManager, PeerManager};
 use crate::{Config, Error};
@@ -15,9 +16,12 @@ use lightning::routing::router::{RouteHint, RouteHintHop};
 use lightning_invoice::{Bolt11Invoice, Bolt11InvoiceDescription, InvoiceBuilder, RoutingFees};
 use lightning_liquidity::events::Event;
 use lightning_liquidity::lsps0::ser::RequestId;
+use lightning_liquidity::lsps1::client::LSPS1ClientConfig;
+use lightning_liquidity::lsps2::client::LSPS2ClientConfig;
 use lightning_liquidity::lsps2::event::LSPS2ClientEvent;
 use lightning_liquidity::lsps2::msgs::OpeningFeeParams;
 use lightning_liquidity::lsps2::utils::compute_opening_fee;
+use lightning_liquidity::LiquidityClientConfig;
 
 use bitcoin::hashes::{sha256, Hash};
 use bitcoin::secp256k1::{PublicKey, Secp256k1};
@@ -31,47 +35,126 @@ use std::time::Duration;
 
 const LIQUIDITY_REQUEST_TIMEOUT_SECS: u64 = 5;
 
+struct LSPS1Service {
+	node_id: PublicKey,
+	address: SocketAddress,
+	token: Option<String>,
+	client_config: LSPS1ClientConfig,
+}
+
 struct LSPS2Service {
 	node_id: PublicKey,
 	address: SocketAddress,
 	token: Option<String>,
+	client_config: LSPS2ClientConfig,
 	pending_fee_requests: Mutex<HashMap<RequestId, oneshot::Sender<LSPS2FeeResponse>>>,
 	pending_buy_requests: Mutex<HashMap<RequestId, oneshot::Sender<LSPS2BuyResponse>>>,
 }
 
-pub(crate) struct LiquiditySource<L: Deref>
+pub(crate) struct LiquiditySourceBuilder<L: Deref>
 where
 	L::Target: LdkLogger,
 {
+	lsps1_service: Option<LSPS1Service>,
 	lsps2_service: Option<LSPS2Service>,
 	channel_manager: Arc<ChannelManager>,
 	keys_manager: Arc<KeysManager>,
-	liquidity_manager: Arc<LiquidityManager>,
+	chain_source: Arc<ChainSource>,
 	config: Arc<Config>,
 	logger: L,
 }
 
-impl<L: Deref> LiquiditySource<L>
+impl<L: Deref> LiquiditySourceBuilder<L>
 where
 	L::Target: LdkLogger,
 {
-	pub(crate) fn new_lsps2(
-		node_id: PublicKey, address: SocketAddress, token: Option<String>,
+	pub(crate) fn new(
 		channel_manager: Arc<ChannelManager>, keys_manager: Arc<KeysManager>,
-		liquidity_manager: Arc<LiquidityManager>, config: Arc<Config>, logger: L,
+		chain_source: Arc<ChainSource>, config: Arc<Config>, logger: L,
 	) -> Self {
+		let lsps1_service = None;
+		let lsps2_service = None;
+		Self {
+			lsps1_service,
+			lsps2_service,
+			channel_manager,
+			keys_manager,
+			chain_source,
+			config,
+			logger,
+		}
+	}
+
+	pub(crate) fn lsps1_service(
+		&mut self, node_id: PublicKey, address: SocketAddress, token: Option<String>,
+	) -> &mut Self {
+		// TODO: allow to set max_channel_fees_msat
+		let client_config = LSPS1ClientConfig { max_channel_fees_msat: None };
+		self.lsps1_service = Some(LSPS1Service { node_id, address, token, client_config });
+		self
+	}
+
+	pub(crate) fn lsps2_service(
+		&mut self, node_id: PublicKey, address: SocketAddress, token: Option<String>,
+	) -> &mut Self {
+		let client_config = LSPS2ClientConfig {};
 		let pending_fee_requests = Mutex::new(HashMap::new());
 		let pending_buy_requests = Mutex::new(HashMap::new());
-		let lsps2_service = Some(LSPS2Service {
+		self.lsps2_service = Some(LSPS2Service {
 			node_id,
 			address,
 			token,
+			client_config,
 			pending_fee_requests,
 			pending_buy_requests,
 		});
-		Self { lsps2_service, channel_manager, keys_manager, liquidity_manager, config, logger }
+		self
 	}
 
+	pub(crate) fn build(self) -> LiquiditySource<L> {
+		let lsps1_client_config = self.lsps1_service.as_ref().map(|s| s.client_config.clone());
+		let lsps2_client_config = self.lsps2_service.as_ref().map(|s| s.client_config.clone());
+		let liquidity_client_config =
+			Some(LiquidityClientConfig { lsps1_client_config, lsps2_client_config });
+
+		let liquidity_manager = Arc::new(LiquidityManager::new(
+			Arc::clone(&self.keys_manager),
+			Arc::clone(&self.channel_manager),
+			Some(Arc::clone(&self.chain_source)),
+			None,
+			None,
+			liquidity_client_config,
+		));
+
+		LiquiditySource {
+			lsps1_service: self.lsps1_service,
+			lsps2_service: self.lsps2_service,
+			channel_manager: self.channel_manager,
+			keys_manager: self.keys_manager,
+			liquidity_manager,
+			config: self.config,
+			logger: self.logger,
+		}
+	}
+}
+
+pub(crate) struct LiquiditySource<L: Deref>
+where
+	L::Target: LdkLogger,
+{
+	lsps1_service: Option<LSPS1Service>,
+	lsps2_service: Option<LSPS2Service>,
+	channel_manager: Arc<ChannelManager>,
+	keys_manager: Arc<KeysManager>,
+	liquidity_manager: Arc<LiquidityManager>,
+	config: Arc<Config>,
+	logger: L,
+}
+
+impl<L: Deref> LiquiditySource<L>
+where
+	L::Target: LdkLogger,
+{
 	pub(crate) fn set_peer_manager(&self, peer_manager: Arc<PeerManager>) {
 		let process_msgs_callback = move || peer_manager.process_events();
 		self.liquidity_manager.set_process_msgs_callback(process_msgs_callback);
@@ -81,7 +164,11 @@ where
 		self.liquidity_manager.as_ref()
 	}
 
-	pub(crate) fn get_liquidity_source_details(&self) -> Option<(PublicKey, SocketAddress)> {
+	pub(crate) fn get_lsps1_service_details(&self) -> Option<(PublicKey, SocketAddress)> {
+		self.lsps1_service.as_ref().map(|s| (s.node_id, s.address.clone()))
+	}
+
+	pub(crate) fn get_lsps2_service_details(&self) -> Option<(PublicKey, SocketAddress)> {
 		self.lsps2_service.as_ref().map(|s| (s.node_id, s.address.clone()))
 	}
 

src/payment/bolt11.rs

@@ -597,7 +597,7 @@ impl Bolt11Payment {
 			self.liquidity_source.as_ref().ok_or(Error::LiquiditySourceUnavailable)?;
 
 		let (node_id, address) = liquidity_source
-			.get_liquidity_source_details()
+			.get_lsps2_service_details()
 			.ok_or(Error::LiquiditySourceUnavailable)?;
 
 		let rt_lock = self.runtime.read().unwrap();