Allow configuring LSPS2 service via builders

We add the capability to configure LSPS2 service mode in `Builder` and
`LiquiditySourceBuilder`.

Author: tnull

bindings/ldk_node.udl

@@ -25,6 +25,18 @@ dictionary EsploraSyncConfig {
 	u64 fee_rate_cache_update_interval_secs;
 };
 
+dictionary LSPS2ServiceConfig {
+	string? require_token;
+	boolean advertise_service;
+	u32 channel_opening_fee_ppm;
+	u32 channel_over_provisioning_ppm;
+	u64 min_channel_opening_fee_msat;
+	u32 min_channel_lifetime;
+	u32 max_client_to_self_delay;
+	u64 min_payment_size_msat;
+	u64 max_payment_size_msat;
+};
+
 enum LogLevel {
 	"Gossip",
 	"Trace",

src/builder.rs

@@ -18,7 +18,9 @@ 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::{LSPS1ClientConfig, LSPS2ClientConfig, LiquiditySourceBuilder};
+use crate::liquidity::{
+	LSPS1ClientConfig, LSPS2ClientConfig, LSPS2ServiceConfig, LiquiditySourceBuilder,
+};
 use crate::logger::{log_error, log_info, LdkLogger, LogLevel, LogWriter, Logger};
 use crate::message_handler::NodeCustomMessageHandler;
 use crate::payment::store::PaymentStore;
@@ -77,6 +79,7 @@ use vss_client::headers::{FixedHeaders, LnurlAuthToJwtProvider, VssHeaderProvide
 
 const VSS_HARDENED_CHILD_INDEX: u32 = 877;
 const VSS_LNURL_AUTH_HARDENED_CHILD_INDEX: u32 = 138;
+const LSPS_HARDENED_CHILD_INDEX: u32 = 577;
 
 #[derive(Debug, Clone)]
 enum ChainDataSourceConfig {
@@ -103,6 +106,8 @@ struct LiquiditySourceConfig {
 	lsps1_client: Option<LSPS1ClientConfig>,
 	// Act as an LSPS2 client connecting to the given service.
 	lsps2_client: Option<LSPS2ClientConfig>,
+	// Act as an LSPS2 service.
+	lsps2_service: Option<LSPS2ServiceConfig>,
 }
 
 #[derive(Clone)]
@@ -340,6 +345,21 @@ impl NodeBuilder {
 		self
 	}
 
+	/// Configures the [`Node`] instance to provide an [LSPS2] service, issuing just-in-time
+	/// channels to clients.
+	///
+	/// **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,
+	) -> &mut Self {
+		let liquidity_source_config =
+			self.liquidity_source_config.get_or_insert(LiquiditySourceConfig::default());
+		liquidity_source_config.lsps2_service = Some(service_config);
+		self
+	}
+
 	/// Sets the used storage directory path.
 	pub fn set_storage_dir_path(&mut self, storage_dir_path: String) -> &mut Self {
 		self.config.storage_dir_path = storage_dir_path;
@@ -692,6 +712,16 @@ impl ArcedNodeBuilder {
 		self.inner.write().unwrap().set_liquidity_source_lsps2(node_id, address, token);
 	}
 
+	/// Configures the [`Node`] instance to provide an [LSPS2] service, issuing just-in-time
+	/// channels to clients.
+	///
+	/// **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().unwrap().set_liquidity_provider_lsps2(service_config);
+	}
+
 	/// Sets the used storage directory path.
 	pub fn set_storage_dir_path(&self, storage_dir_path: String) {
 		self.inner.write().unwrap().set_storage_dir_path(storage_dir_path);
@@ -1167,39 +1197,52 @@ fn build_with_store_internal(
 		},
 	};
 
-	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_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) =
+		if let Some(lsc) = liquidity_source_config.as_ref() {
+			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.lsps2_client.as_ref().map(|config| {
-			liquidity_source_builder.lsps2_client(
-				config.node_id,
-				config.address.clone(),
-				config.token.clone(),
-			)
-		});
+			lsc.lsps1_client.as_ref().map(|config| {
+				liquidity_source_builder.lsps1_client(
+					config.node_id,
+					config.address.clone(),
+					config.token.clone(),
+				)
+			});
 
-		Arc::new(liquidity_source_builder.build())
-	});
+			lsc.lsps2_client.as_ref().map(|config| {
+				liquidity_source_builder.lsps2_client(
+					config.node_id,
+					config.address.clone(),
+					config.token.clone(),
+				)
+			});
 
-	let custom_message_handler = if let Some(liquidity_source) = liquidity_source.as_ref() {
-		Arc::new(NodeCustomMessageHandler::new_liquidity(Arc::clone(&liquidity_source)))
-	} else {
-		Arc::new(NodeCustomMessageHandler::new_ignoring())
-	};
+			let promise_secret = {
+				let lsps_xpriv = derive_xprv(
+					Arc::clone(&config),
+					&seed_bytes,
+					LSPS_HARDENED_CHILD_INDEX,
+					Arc::clone(&logger),
+				)?;
+				lsps_xpriv.private_key.secret_bytes()
+			};
+			lsc.lsps2_service.as_ref().map(|config| {
+				liquidity_source_builder.lsps2_service(promise_secret, config.clone())
+			});
+
+			let liquidity_source = Arc::new(liquidity_source_builder.build());
+			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 msg_handler = match gossip_source.as_gossip_sync() {
 		GossipSync::P2P(p2p_gossip_sync) => MessageHandler {

src/liquidity.rs

@@ -25,8 +25,9 @@ use lightning_liquidity::lsps1::msgs::{ChannelInfo, LSPS1Options, OrderId, Order
 use lightning_liquidity::lsps2::client::LSPS2ClientConfig as LdkLSPS2ClientConfig;
 use lightning_liquidity::lsps2::event::LSPS2ClientEvent;
 use lightning_liquidity::lsps2::msgs::OpeningFeeParams;
+use lightning_liquidity::lsps2::service::LSPS2ServiceConfig as LdkLSPS2ServiceConfig;
 use lightning_liquidity::lsps2::utils::compute_opening_fee;
-use lightning_liquidity::LiquidityClientConfig;
+use lightning_liquidity::{LiquidityClientConfig, LiquidityServiceConfig};
 
 use bitcoin::hashes::{sha256, Hash};
 use bitcoin::secp256k1::{PublicKey, Secp256k1};
@@ -75,12 +76,56 @@ pub(crate) struct LSPS2ClientConfig {
 	pub token: Option<String>,
 }
 
+struct LSPS2Service {
+	service_config: LSPS2ServiceConfig,
+	ldk_service_config: LdkLSPS2ServiceConfig,
+}
+
+/// Represents the configuration of the LSPS2 service.
+///
+/// See [bLIP-52 / LSPS2] for more information.
+///
+/// [bLIP-52 / LSPS2]: https://github.com/lightning/blips/blob/master/blip-0052.md
+#[derive(Debug, Clone)]
+pub struct LSPS2ServiceConfig {
+	/// A token we may require to be sent by the clients.
+	///
+	/// If set, only requests matching this token will be accepted.
+	pub require_token: Option<String>,
+	/// Indicates whether the LSPS service will be announced via the gossip network.
+	pub advertise_service: bool,
+	/// The fee we withhold for the channel open from the initial payment.
+	///
+	/// This fee is proportional to the client-requested amount, in parts-per-million.
+	pub channel_opening_fee_ppm: u32,
+	/// The proportional overprovisioning for the channel.
+	///
+	/// This determines, in parts-per-million, how much value we'll provision on top of the amount
+	/// we need to forward the payment to the client.
+	///
+	/// For example, setting this to `100_000` will result in a channel being opened that is 10%
+	/// larger than then the to-be-forwarded amount (i.e., client-requested amount minus the
+	/// channel opening fee fee).
+	pub channel_over_provisioning_ppm: u32,
+	/// The minimum fee required for opening a channel.
+	pub min_channel_opening_fee_msat: u64,
+	/// The minimum number of blocks after confirmation we promise to keep the channel open.
+	pub min_channel_lifetime: u32,
+	/// The maximum number of blocks that the client is allowed to set its `to_self_delay` parameter.
+	pub max_client_to_self_delay: u32,
+	/// The minimum payment size that we will accept when opening a channel.
+	pub min_payment_size_msat: u64,
+	/// The maximum payment size that we will accept when opening a channel.
+	pub max_payment_size_msat: u64,
+}
+
 pub(crate) struct LiquiditySourceBuilder<L: Deref>
 where
 	L::Target: LdkLogger,
 {
 	lsps1_client: Option<LSPS1Client>,
 	lsps2_client: Option<LSPS2Client>,
+	lsps2_service: Option<LSPS2Service>,
 	channel_manager: Arc<ChannelManager>,
 	keys_manager: Arc<KeysManager>,
 	chain_source: Arc<ChainSource>,
@@ -98,9 +143,11 @@ where
 	) -> Self {
 		let lsps1_client = None;
 		let lsps2_client = None;
+		let lsps2_service = None;
 		Self {
 			lsps1_client,
 			lsps2_client,
+			lsps2_service,
 			channel_manager,
 			keys_manager,
 			chain_source,
@@ -146,7 +193,21 @@ where
 		self
 	}
 
+	pub(crate) fn lsps2_service(
+		&mut self, promise_secret: [u8; 32], service_config: LSPS2ServiceConfig,
+	) -> &mut Self {
+		let ldk_service_config = LdkLSPS2ServiceConfig { promise_secret };
+		self.lsps2_service = Some(LSPS2Service { service_config, ldk_service_config });
+		self
+	}
+
 	pub(crate) fn build(self) -> LiquiditySource<L> {
+		let liquidity_service_config = self.lsps2_service.as_ref().map(|s| {
+			let lsps2_service_config = Some(s.ldk_service_config.clone());
+			let advertise_service = s.service_config.advertise_service;
+			LiquidityServiceConfig { lsps2_service_config, advertise_service }
+		});
+
 		let lsps1_client_config = self.lsps1_client.as_ref().map(|s| s.ldk_client_config.clone());
 		let lsps2_client_config = self.lsps2_client.as_ref().map(|s| s.ldk_client_config.clone());
 		let liquidity_client_config =
@@ -157,13 +218,14 @@ where
 			Arc::clone(&self.channel_manager),
 			Some(Arc::clone(&self.chain_source)),
 			None,
-			None,
+			liquidity_service_config,
 			liquidity_client_config,
 		));
 
 		LiquiditySource {
 			lsps1_client: self.lsps1_client,
 			lsps2_client: self.lsps2_client,
+			lsps2_service: self.lsps2_service,
 			channel_manager: self.channel_manager,
 			keys_manager: self.keys_manager,
 			liquidity_manager,
@@ -179,6 +241,7 @@ where
 {
 	lsps1_client: Option<LSPS1Client>,
 	lsps2_client: Option<LSPS2Client>,
+	lsps2_service: Option<LSPS2Service>,
 	channel_manager: Arc<ChannelManager>,
 	keys_manager: Arc<KeysManager>,
 	liquidity_manager: Arc<LiquidityManager>,

src/uniffi_types.rs

@@ -14,7 +14,7 @@ pub use crate::config::{
 	default_config, AnchorChannelsConfig, EsploraSyncConfig, MaxDustHTLCExposure,
 };
 pub use crate::graph::{ChannelInfo, ChannelUpdateInfo, NodeAnnouncementInfo, NodeInfo};
-pub use crate::liquidity::{LSPS1OrderStatus, OnchainPaymentInfo, PaymentInfo};
+pub use crate::liquidity::{LSPS1OrderStatus, LSPS2ServiceConfig, OnchainPaymentInfo, PaymentInfo};
 pub use crate::logger::{LogLevel, LogRecord, LogWriter};
 pub use crate::payment::store::{
 	ConfirmationStatus, LSPFeeLimits, PaymentDirection, PaymentKind, PaymentStatus,