Add Uniffi bindings for LSPS1 API

Author: tnull

bindings/ldk_node.udl

@@ -58,6 +58,7 @@ interface Builder {
 	void set_chain_source_bitcoind_rpc(string rpc_host, u16 rpc_port, string rpc_user, string rpc_password);
 	void set_gossip_source_p2p();
 	void set_gossip_source_rgs(string rgs_server_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 set_storage_dir_path(string storage_dir_path);
 	void set_filesystem_logger(string? log_file_path, LogLevel? log_level);
@@ -100,6 +101,7 @@ interface Node {
 	SpontaneousPayment spontaneous_payment();
 	OnchainPayment onchain_payment();
 	UnifiedQrPayment unified_qr_payment();
+	LSPS1Liquidity lsps1_liquidity();
 	[Throws=NodeError]
 	void connect(PublicKey node_id, SocketAddress address, boolean persist);
 	[Throws=NodeError]
@@ -211,6 +213,13 @@ interface UnifiedQrPayment {
 	QrPaymentResult send([ByRef]string uri_str);
 };
 
+interface LSPS1Liquidity {
+	[Throws=NodeError]
+	LSPS1OrderStatus request_channel(u64 lsp_balance_sat, u64 client_balance_sat, u32 channel_expiry_blocks, boolean announce_channel);
+	[Throws=NodeError]
+	LSPS1OrderStatus check_order_status(OrderId order_id);
+};
+
 [Error]
 enum NodeError {
 	"AlreadyRunning",
@@ -258,6 +267,8 @@ enum NodeError {
 	"InvalidUri",
 	"InvalidQuantity",
 	"InvalidNodeAlias",
+	"InvalidDateTime",
+	"InvalidFeeRate",
 	"DuplicatePayment",
 	"UnsupportedCurrency",
 	"InsufficientFunds",
@@ -416,6 +427,59 @@ dictionary CustomTlvRecord {
 	sequence<u8> value;
 };
 
+dictionary LSPS1OrderStatus {
+	OrderId order_id;
+	OrderParameters order_params;
+	PaymentInfo payment_options;
+	ChannelOrderInfo? channel_state;
+};
+
+dictionary OrderParameters {
+	u64 lsp_balance_sat;
+	u64 client_balance_sat;
+	u16 required_channel_confirmations;
+	u16 funding_confirms_within_blocks;
+	u32 channel_expiry_blocks;
+	string? token;
+	boolean announce_channel;
+};
+
+dictionary PaymentInfo {
+	Bolt11PaymentInfo? bolt11;
+	OnchainPaymentInfo? onchain;
+};
+
+dictionary Bolt11PaymentInfo {
+	PaymentState state;
+	DateTime expires_at;
+	u64 fee_total_sat;
+	u64 order_total_sat;
+	Bolt11Invoice invoice;
+};
+
+dictionary OnchainPaymentInfo {
+	PaymentState state;
+	DateTime expires_at;
+	u64 fee_total_sat;
+	u64 order_total_sat;
+	Address address;
+	u16? min_onchain_payment_confirmations;
+	FeeRate min_fee_for_0conf;
+	Address? refund_onchain_address;
+};
+
+dictionary ChannelOrderInfo {
+	DateTime funded_at;
+	OutPoint funding_outpoint;
+	DateTime expires_at;
+};
+
+enum PaymentState {
+	"ExpectPayment",
+	"Paid",
+	"Refunded",
+};
+
 [Enum]
 interface MaxTotalRoutingFeeLimit {
 	None ();
@@ -662,3 +726,9 @@ typedef string UntrustedString;
 
 [Custom]
 typedef string NodeAlias;
+
+[Custom]
+typedef string OrderId;
+
+[Custom]
+typedef string DateTime;

src/error.rs

@@ -106,6 +106,10 @@ pub enum Error {
 	InvalidQuantity,
 	/// The given node alias is invalid.
 	InvalidNodeAlias,
+	/// The given date time is invalid.
+	InvalidDateTime,
+	/// The given fee rate is invalid.
+	InvalidFeeRate,
 	/// A payment with the given hash has already been initiated.
 	DuplicatePayment,
 	/// The provided offer was denonminated in an unsupported currency.
@@ -172,6 +176,8 @@ impl fmt::Display for Error {
 			Self::InvalidUri => write!(f, "The given URI is invalid."),
 			Self::InvalidQuantity => write!(f, "The given quantity is invalid."),
 			Self::InvalidNodeAlias => write!(f, "The given node alias is invalid."),
+			Self::InvalidDateTime => write!(f, "The given date time is invalid."),
+			Self::InvalidFeeRate => write!(f, "The given fee rate is invalid."),
 			Self::DuplicatePayment => {
 				write!(f, "A payment with the given hash has already been initiated.")
 			},

src/liquidity.rs

@@ -21,9 +21,7 @@ use lightning_liquidity::events::Event;
 use lightning_liquidity::lsps0::ser::RequestId;
 use lightning_liquidity::lsps1::client::LSPS1ClientConfig;
 use lightning_liquidity::lsps1::event::LSPS1ClientEvent;
-use lightning_liquidity::lsps1::msgs::{
-	ChannelInfo, LSPS1Options, OrderId, OrderParameters, PaymentInfo,
-};
+use lightning_liquidity::lsps1::msgs::{ChannelInfo, LSPS1Options, OrderId, OrderParameters};
 use lightning_liquidity::lsps2::client::LSPS2ClientConfig;
 use lightning_liquidity::lsps2::event::LSPS2ClientEvent;
 use lightning_liquidity::lsps2::msgs::OpeningFeeParams;
@@ -280,7 +278,7 @@ where
 						let response = LSPS1OrderStatus {
 							order_id,
 							order_params: order,
-							payment_options: payment,
+							payment_options: payment.into(),
 							channel_state: channel,
 						};
 
@@ -338,7 +336,7 @@ where
 						let response = LSPS1OrderStatus {
 							order_id,
 							order_params: order,
-							payment_options: payment,
+							payment_options: payment.into(),
 							channel_state: channel,
 						};
 
@@ -889,6 +887,67 @@ pub struct LSPS1OrderStatus {
 	pub channel_state: Option<ChannelInfo>,
 }
 
+#[cfg(not(feature = "uniffi"))]
+type PaymentInfo = lightning_liquidity::lsps1::msgs::PaymentInfo;
+
+/// Details regarding how to pay for an order.
+#[cfg(feature = "uniffi")]
+#[derive(Clone, Debug, PartialEq, Eq)]
+pub struct PaymentInfo {
+	/// A Lightning payment using BOLT 11.
+	pub bolt11: Option<lightning_liquidity::lsps1::msgs::Bolt11PaymentInfo>,
+	/// An onchain payment.
+	pub onchain: Option<OnchainPaymentInfo>,
+}
+
+#[cfg(feature = "uniffi")]
+impl From<lightning_liquidity::lsps1::msgs::PaymentInfo> for PaymentInfo {
+	fn from(value: lightning_liquidity::lsps1::msgs::PaymentInfo) -> Self {
+		PaymentInfo { bolt11: value.bolt11, onchain: value.onchain.map(|o| o.into()) }
+	}
+}
+
+/// An onchain payment.
+#[cfg(feature = "uniffi")]
+#[derive(Clone, Debug, PartialEq, Eq)]
+pub struct OnchainPaymentInfo {
+	/// Indicates the current state of the payment.
+	pub state: lightning_liquidity::lsps1::msgs::PaymentState,
+	/// The datetime when the payment option expires.
+	pub expires_at: chrono::DateTime<chrono::Utc>,
+	/// The total fee the LSP will charge to open this channel in satoshi.
+	pub fee_total_sat: u64,
+	/// The amount the client needs to pay to have the requested channel openend.
+	pub order_total_sat: u64,
+	/// An on-chain address the client can send [`Self::order_total_sat`] to to have the channel
+	/// opened.
+	pub address: bitcoin::Address,
+	/// The minimum number of block confirmations that are required for the on-chain payment to be
+	/// considered confirmed.
+	pub min_onchain_payment_confirmations: Option<u16>,
+	/// The minimum fee rate for the on-chain payment in case the client wants the payment to be
+	/// confirmed without a confirmation.
+	pub min_fee_for_0conf: Arc<bitcoin::FeeRate>,
+	/// The address where the LSP will send the funds if the order fails.
+	pub refund_onchain_address: Option<bitcoin::Address>,
+}
+
+#[cfg(feature = "uniffi")]
+impl From<lightning_liquidity::lsps1::msgs::OnchainPaymentInfo> for OnchainPaymentInfo {
+	fn from(value: lightning_liquidity::lsps1::msgs::OnchainPaymentInfo) -> Self {
+		Self {
+			state: value.state,
+			expires_at: value.expires_at,
+			fee_total_sat: value.fee_total_sat,
+			order_total_sat: value.order_total_sat,
+			address: value.address,
+			min_onchain_payment_confirmations: value.min_onchain_payment_confirmations,
+			min_fee_for_0conf: Arc::new(value.min_fee_for_0conf),
+			refund_onchain_address: value.refund_onchain_address,
+		}
+	}
+}
+
 #[derive(Debug, Clone)]
 pub(crate) struct LSPS2FeeResponse {
 	opening_fee_params_menu: Vec<OpeningFeeParams>,

src/uniffi_types.rs

@@ -14,6 +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::logger::{LogLevel, LogRecord, LogWriter};
 pub use crate::payment::store::{
 	ConfirmationStatus, LSPFeeLimits, PaymentDirection, PaymentKind, PaymentStatus,
@@ -33,12 +34,19 @@ pub use lightning_types::payment::{PaymentHash, PaymentPreimage, PaymentSecret};
 
 pub use lightning_invoice::{Bolt11Invoice, Description};
 
+pub use lightning_liquidity::lsps1::msgs::ChannelInfo as ChannelOrderInfo;
+pub use lightning_liquidity::lsps1::msgs::{
+	Bolt11PaymentInfo, OrderId, OrderParameters, PaymentState,
+};
+
 pub use bitcoin::{Address, BlockHash, FeeRate, Network, OutPoint, Txid};
 
 pub use bip39::Mnemonic;
 
 pub use vss_client::headers::{VssHeaderProvider, VssHeaderProviderError};
 
+pub type DateTime = chrono::DateTime<chrono::Utc>;
+
 use crate::UniffiCustomTypeConverter;
 
 use crate::builder::sanitize_alias;
@@ -396,6 +404,30 @@ impl From<lightning_invoice::Bolt11InvoiceDescription> for Bolt11InvoiceDescript
 	}
 }
 
+impl UniffiCustomTypeConverter for OrderId {
+	type Builtin = String;
+
+	fn into_custom(val: Self::Builtin) -> uniffi::Result<Self> {
+		Ok(Self(val))
+	}
+
+	fn from_custom(obj: Self) -> Self::Builtin {
+		obj.0
+	}
+}
+
+impl UniffiCustomTypeConverter for DateTime {
+	type Builtin = String;
+
+	fn into_custom(val: Self::Builtin) -> uniffi::Result<Self> {
+		Ok(DateTime::from_str(&val).map_err(|_| Error::InvalidDateTime)?)
+	}
+
+	fn from_custom(obj: Self) -> Self::Builtin {
+		obj.to_rfc3339()
+	}
+}
+
 #[cfg(test)]
 mod tests {
 	use super::*;