Refactor liquidity source to support multiple LSP nodes

Replace per-protocol single-LSP configuration `LSPS1Client` and `LSPS2Client`
with a unified `Vec<LspNode>` model where users configure LSP nodes via
`add_liquidity_source()` at build time or runtime and per-LSP protocol
support is discovered via the LSPS0 `list_protocols`.

- Introduce a per-LSP `trust_peer_0conf` flag to `LspConfig`/`LspNode`
  structs that controls whether 0-conf channels from that LSP are accepted
- Add LSPS0 protocol discovery `discover_lsp_protocols` with event
  handling for `ListProtocolsResponse`
- Update events to also use each LSP's `trust_peer_0conf` flag
  when deciding whether to allow 0-conf channels
- Replace `set_liquidity_source_lsps1` and `set_liquidity_source_lsps2`
  builder methods with a single `add_liquidity_source()` that takes a
  `trust_peer_0conf` flag
- Rename `set_liquidity_provider_lsps2` to `enable_liquidity_provider`
- LSPS2 JIT channels now query all LSPS2-capable LSPs and automatically
  select the cheapest fee offer across all of them
- Spawn background discovery task on `Node::start()` and expose a watch
  channel so dependent flows can wait for discovery to complete
- Add a new `Liquidity` handler `Node::liquidity()` exposing `add_liquidity_source()`
  API for adding LSPs at runtime, and `lsps1()` for the existing LSPS1 surface

Author: Camillarhi

bindings/ldk_node.udl

@@ -43,8 +43,7 @@ interface Builder {
 	void set_gossip_source_p2p();
 	void set_gossip_source_rgs(string rgs_server_url);
 	void set_pathfinding_scores_source(string url);
-	void set_liquidity_source_lsps1(PublicKey node_id, SocketAddress address, string? token);
-	void set_liquidity_source_lsps2(PublicKey node_id, SocketAddress address, string? token);
+	void add_liquidity_source(PublicKey node_id, SocketAddress address, string? token, boolean trust_peer_0conf);
 	void set_storage_dir_path(string storage_dir_path);
 	void set_filesystem_logger(string? log_file_path, LogLevel? max_log_level);
 	void set_log_facade_logger();
@@ -97,7 +96,7 @@ interface Node {
 	SpontaneousPayment spontaneous_payment();
 	OnchainPayment onchain_payment();
 	UnifiedPayment unified_payment();
-	LSPS1Liquidity lsps1_liquidity();
+	Liquidity liquidity();
 	[Throws=NodeError]
 	void lnurl_auth(string lnurl);
 	[Throws=NodeError]
@@ -165,7 +164,7 @@ interface FeeRate {
 
 typedef interface UnifiedPayment;
 
-typedef interface LSPS1Liquidity;
+typedef interface Liquidity;
 
 [Error]
 enum NodeError {
@@ -279,6 +278,7 @@ dictionary LSPS1OrderStatus {
 	LSPS1OrderParams order_params;
 	LSPS1PaymentInfo payment_options;
 	LSPS1ChannelInfo? channel_state;
+	PublicKey counterparty_node_id;
 };
 
 [Remote]

src/builder.rs

@@ -69,9 +69,7 @@ use crate::io::{
 	PENDING_PAYMENT_INFO_PERSISTENCE_PRIMARY_NAMESPACE,
 	PENDING_PAYMENT_INFO_PERSISTENCE_SECONDARY_NAMESPACE,
 };
-use crate::liquidity::{
-	LSPS1ClientConfig, LSPS2ClientConfig, LSPS2ServiceConfig, LiquiditySourceBuilder,
-};
+use crate::liquidity::{LSPS2ServiceConfig, LiquiditySourceBuilder, LspConfig};
 use crate::lnurl_auth::LnurlAuth;
 use crate::logger::{log_error, LdkLogger, LogLevel, LogWriter, Logger};
 use crate::message_handler::NodeCustomMessageHandler;
@@ -124,10 +122,8 @@ struct PathfindingScoresSyncConfig {
 
 #[derive(Debug, Clone, Default)]
 struct LiquiditySourceConfig {
-	// Act as an LSPS1 client connecting to the given service.
-	lsps1_client: Option<LSPS1ClientConfig>,
-	// Act as an LSPS2 client connecting to the given service.
-	lsps2_client: Option<LSPS2ClientConfig>,
+	// Acts for both LSPS1 and LSPS2 clients connecting to the given service.
+	lsp_nodes: Vec<LspConfig>,
 	// Act as an LSPS2 service.
 	lsps2_service: Option<LSPS2ServiceConfig>,
 }
@@ -444,45 +440,25 @@ impl NodeBuilder {
 		self
 	}
 
-	/// 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`].
+	/// Configures the [`Node`] instance to source inbound liquidity from the given LSP, without specifying
+	/// the exact protocol used (e.g., LSPS1 or LSPS2).
 	///
 	/// 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(
+	/// This method is useful when the user wants to connect to an LSP but does not want to be concerned with
+	///  the specific protocol used for liquidity provision. The node will automatically detect and use the
+	/// appropriate protocol supported by the LSP.
+	pub fn add_liquidity_source(
 		&mut self, node_id: PublicKey, address: SocketAddress, token: Option<String>,
+		trust_peer_0conf: bool,
 	) -> &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());
-		let lsps1_client_config = LSPS1ClientConfig { node_id, address, token };
-		liquidity_source_config.lsps1_client = Some(lsps1_client_config);
-		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 {
-		// 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());
-		let lsps2_client_config = LSPS2ClientConfig { node_id, address, token };
-		liquidity_source_config.lsps2_client = Some(lsps2_client_config);
+		liquidity_source_config.lsp_nodes.push(LspConfig {
+			node_id,
+			address,
+			token,
+			trust_peer_0conf,
+		});
 		self
 	}
 
@@ -492,12 +468,12 @@ impl NodeBuilder {
 	/// **Caution**: LSP service support is in **alpha** and is considered an experimental feature.
 	///
 	/// [LSPS2]: https://github.com/BitcoinAndLightningLayerSpecs/lsp/blob/main/LSPS2/README.md
-	pub fn set_liquidity_provider_lsps2(
-		&mut self, service_config: LSPS2ServiceConfig,
+	pub fn enable_liquidity_provider(
+		&mut self, lsps2_service_config: LSPS2ServiceConfig,
 	) -> &mut Self {
 		let liquidity_source_config =
 			self.liquidity_source_config.get_or_insert(LiquiditySourceConfig::default());
-		liquidity_source_config.lsps2_service = Some(service_config);
+		liquidity_source_config.lsps2_service = Some(lsps2_service_config);
 		self
 	}
 
@@ -965,32 +941,24 @@ impl ArcedNodeBuilder {
 		self.inner.write().expect("lock").set_pathfinding_scores_source(url);
 	}
 
-	/// 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().expect("lock").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.
+	/// Configures the [`Node`] instance to source inbound liquidity from the given LSP.
 	///
 	/// 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(
+	/// This method is useful when the user wants to connect to an LSP but does not want to be concerned with
+	///  the specific protocol used for liquidity provision. The node will automatically detect and use the
+	/// appropriate protocol supported by the LSP.
+	pub fn add_liquidity_source(
 		&self, node_id: PublicKey, address: SocketAddress, token: Option<String>,
+		trust_peer_0conf: bool,
 	) {
-		self.inner.write().expect("lock").set_liquidity_source_lsps2(node_id, address, token);
+		self.inner.write().expect("lock").add_liquidity_source(
+			node_id,
+			address,
+			token,
+			trust_peer_0conf,
+		);
 	}
 
 	/// Configures the [`Node`] instance to provide an [LSPS2] service, issuing just-in-time
@@ -999,8 +967,8 @@ impl ArcedNodeBuilder {
 	/// **Caution**: LSP service support is in **alpha** and is considered an experimental feature.
 	///
 	/// [LSPS2]: https://github.com/BitcoinAndLightningLayerSpecs/lsp/blob/main/LSPS2/README.md
-	pub fn set_liquidity_provider_lsps2(&self, service_config: LSPS2ServiceConfig) {
-		self.inner.write().expect("lock").set_liquidity_provider_lsps2(service_config);
+	pub fn enable_liquidity_provider(&self, lsps2_service_config: LSPS2ServiceConfig) {
+		self.inner.write().expect("lock").enable_liquidity_provider(lsps2_service_config);
 	}
 
 	/// Sets the used storage directory path.
@@ -1857,33 +1825,19 @@ fn build_with_store_internal(
 		},
 	};
 
-	let (liquidity_source, custom_message_handler) =
-		if let Some(lsc) = liquidity_source_config.as_ref() {
-			let mut liquidity_source_builder = LiquiditySourceBuilder::new(
-				Arc::clone(&wallet),
-				Arc::clone(&channel_manager),
-				Arc::clone(&keys_manager),
-				Arc::clone(&tx_broadcaster),
-				Arc::clone(&kv_store),
-				Arc::clone(&config),
-				Arc::clone(&logger),
-			);
-
-			lsc.lsps1_client.as_ref().map(|config| {
-				liquidity_source_builder.lsps1_client(
-					config.node_id,
-					config.address.clone(),
-					config.token.clone(),
-				)
-			});
+	let (liquidity_source, custom_message_handler) = {
+		let mut liquidity_source_builder = LiquiditySourceBuilder::new(
+			Arc::clone(&wallet),
+			Arc::clone(&channel_manager),
+			Arc::clone(&keys_manager),
+			Arc::clone(&tx_broadcaster),
+			Arc::clone(&kv_store),
+			Arc::clone(&config),
+			Arc::clone(&logger),
+		);
 
-			lsc.lsps2_client.as_ref().map(|config| {
-				liquidity_source_builder.lsps2_client(
-					config.node_id,
-					config.address.clone(),
-					config.token.clone(),
-				)
-			});
+		if let Some(lsc) = liquidity_source_config.as_ref() {
+			liquidity_source_builder.set_lsp_nodes(lsc.lsp_nodes.clone());
 
 			let promise_secret = {
 				let lsps_xpriv = derive_xprv(
@@ -1897,15 +1851,15 @@ fn build_with_store_internal(
 			lsc.lsps2_service.as_ref().map(|config| {
 				liquidity_source_builder.lsps2_service(promise_secret, config.clone())
 			});
+		}
 
-			let liquidity_source = runtime
-				.block_on(async move { liquidity_source_builder.build().await.map(Arc::new) })?;
-			let custom_message_handler =
-				Arc::new(NodeCustomMessageHandler::new_liquidity(Arc::clone(&liquidity_source)));
-			(Some(liquidity_source), custom_message_handler)
-		} else {
-			(None, Arc::new(NodeCustomMessageHandler::new_ignoring()))
-		};
+		let liquidity_source = runtime
+			.block_on(async move { liquidity_source_builder.build().await.map(Arc::new) })?;
+		let custom_message_handler =
+			Arc::new(NodeCustomMessageHandler::new_liquidity(Arc::clone(&liquidity_source)));
+
+		(liquidity_source, custom_message_handler)
+	};
 
 	let msg_handler = match gossip_source.as_gossip_sync() {
 		GossipSync::P2P(p2p_gossip_sync) => MessageHandler {
@@ -1949,7 +1903,7 @@ fn build_with_store_internal(
 		*guard = Some(Arc::downgrade(&peer_manager));
 	}
 
-	liquidity_source.as_ref().map(|l| l.set_peer_manager(Arc::downgrade(&peer_manager)));
+	liquidity_source.lsps2_service().set_peer_manager(Arc::downgrade(&peer_manager));
 
 	let connection_manager = Arc::new(ConnectionManager::new(
 		Arc::clone(&peer_manager),