f WIP/TODO Account for renamed lightning-liquidity types

Author: tnull

bindings/ldk_node.udl

@@ -160,8 +160,8 @@ interface Node {
 
 [Enum]
 interface Bolt11InvoiceDescription {
-  Hash(string hash);
-  Direct(string description);
+	Hash(string hash);
+	Direct(string description);
 };
 
 interface Bolt11Payment {
@@ -245,7 +245,7 @@ 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);
+	LSPS1OrderStatus check_order_status(LSPS1OrderId order_id);
 };
 
 [Error]
@@ -459,13 +459,13 @@ dictionary CustomTlvRecord {
 };
 
 dictionary LSPS1OrderStatus {
-	OrderId order_id;
-	OrderParameters order_params;
-	PaymentInfo payment_options;
-	ChannelOrderInfo? channel_state;
+	LSPS1OrderId order_id;
+	LSPS1OrderParams order_params;
+	LSPS1PaymentInfo payment_options;
+	LSPS1ChannelInfo? channel_state;
 };
 
-dictionary OrderParameters {
+dictionary LSPS1OrderParams {
 	u64 lsp_balance_sat;
 	u64 client_balance_sat;
 	u16 required_channel_confirmations;
@@ -475,22 +475,22 @@ dictionary OrderParameters {
 	boolean announce_channel;
 };
 
-dictionary PaymentInfo {
-	Bolt11PaymentInfo? bolt11;
-	OnchainPaymentInfo? onchain;
+dictionary LSPS1PaymentInfo {
+	LSPS1Bolt11PaymentInfo? bolt11;
+	LSPS1OnchainPaymentInfo? onchain;
 };
 
-dictionary Bolt11PaymentInfo {
-	PaymentState state;
-	DateTime expires_at;
+dictionary LSPS1Bolt11PaymentInfo {
+	LSPS1PaymentState state;
+	LSPSDateTime expires_at;
 	u64 fee_total_sat;
 	u64 order_total_sat;
 	Bolt11Invoice invoice;
 };
 
-dictionary OnchainPaymentInfo {
-	PaymentState state;
-	DateTime expires_at;
+dictionary LSPS1OnchainPaymentInfo {
+	LSPS1PaymentState state;
+	LSPSDateTime expires_at;
 	u64 fee_total_sat;
 	u64 order_total_sat;
 	Address address;
@@ -499,13 +499,13 @@ dictionary OnchainPaymentInfo {
 	Address? refund_onchain_address;
 };
 
-dictionary ChannelOrderInfo {
-	DateTime funded_at;
+dictionary LSPS1ChannelInfo {
+	LSPSDateTime funded_at;
 	OutPoint funding_outpoint;
-	DateTime expires_at;
+	LSPSDateTime expires_at;
 };
 
-enum PaymentState {
+enum LSPS1PaymentState {
 	"ExpectPayment",
 	"Paid",
 	"Refunded",
@@ -794,7 +794,7 @@ typedef string UntrustedString;
 typedef string NodeAlias;
 
 [Custom]
-typedef string OrderId;
+typedef string LSPS1OrderId;
 
 [Custom]
-typedef string DateTime;
+typedef string LSPSDateTime;

src/liquidity.rs

@@ -21,14 +21,16 @@ 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::events::LiquidityEvent;
+use lightning_liquidity::lsps0::ser::{LSPSDateTime, LSPSRequestId};
 use lightning_liquidity::lsps1::client::LSPS1ClientConfig as LdkLSPS1ClientConfig;
 use lightning_liquidity::lsps1::event::LSPS1ClientEvent;
-use lightning_liquidity::lsps1::msgs::{ChannelInfo, LSPS1Options, OrderId, OrderParameters};
+use lightning_liquidity::lsps1::msgs::{
+	LSPS1ChannelInfo, LSPS1Options, LSPS1OrderId, LSPS1OrderParams,
+};
 use lightning_liquidity::lsps2::client::LSPS2ClientConfig as LdkLSPS2ClientConfig;
 use lightning_liquidity::lsps2::event::{LSPS2ClientEvent, LSPS2ServiceEvent};
-use lightning_liquidity::lsps2::msgs::{OpeningFeeParams, RawOpeningFeeParams};
+use lightning_liquidity::lsps2::msgs::{LSPS2OpeningFeeParams, LSPS2RawOpeningFeeParams};
 use lightning_liquidity::lsps2::service::LSPS2ServiceConfig as LdkLSPS2ServiceConfig;
 use lightning_liquidity::lsps2::utils::compute_opening_fee;
 use lightning_liquidity::{LiquidityClientConfig, LiquidityServiceConfig};
@@ -40,12 +42,13 @@ use bitcoin::secp256k1::{PublicKey, Secp256k1};
 
 use tokio::sync::oneshot;
 
-use chrono::{DateTime, Utc};
+use chrono::Utc;
 
 use rand::Rng;
 
 use std::collections::HashMap;
 use std::ops::Deref;
+use std::str::FromStr;
 use std::sync::{Arc, Mutex, RwLock};
 use std::time::Duration;
 
@@ -61,10 +64,10 @@ struct LSPS1Client {
 	token: Option<String>,
 	ldk_client_config: LdkLSPS1ClientConfig,
 	pending_opening_params_requests:
-		Mutex<HashMap<RequestId, oneshot::Sender<LSPS1OpeningParamsResponse>>>,
-	pending_create_order_requests: Mutex<HashMap<RequestId, oneshot::Sender<LSPS1OrderStatus>>>,
+		Mutex<HashMap<LSPSRequestId, oneshot::Sender<LSPS1OpeningParamsResponse>>>,
+	pending_create_order_requests: Mutex<HashMap<LSPSRequestId, oneshot::Sender<LSPS1OrderStatus>>>,
 	pending_check_order_status_requests:
-		Mutex<HashMap<RequestId, oneshot::Sender<LSPS1OrderStatus>>>,
+		Mutex<HashMap<LSPSRequestId, oneshot::Sender<LSPS1OrderStatus>>>,
 }
 
 #[derive(Debug, Clone)]
@@ -79,8 +82,8 @@ struct LSPS2Client {
 	lsp_address: SocketAddress,
 	token: Option<String>,
 	ldk_client_config: LdkLSPS2ClientConfig,
-	pending_fee_requests: Mutex<HashMap<RequestId, oneshot::Sender<LSPS2FeeResponse>>>,
-	pending_buy_requests: Mutex<HashMap<RequestId, oneshot::Sender<LSPS2BuyResponse>>>,
+	pending_fee_requests: Mutex<HashMap<LSPSRequestId, oneshot::Sender<LSPS2FeeResponse>>>,
+	pending_buy_requests: Mutex<HashMap<LSPSRequestId, oneshot::Sender<LSPS2BuyResponse>>>,
 }
 
 #[derive(Debug, Clone)]
@@ -293,7 +296,7 @@ where
 
 	pub(crate) async fn handle_next_event(&self) {
 		match self.liquidity_manager.next_event_async().await {
-			Event::LSPS1Client(LSPS1ClientEvent::SupportedOptionsReady {
+			LiquidityEvent::LSPS1Client(LSPS1ClientEvent::SupportedOptionsReady {
 				request_id,
 				counterparty_node_id,
 				supported_options,
@@ -346,7 +349,7 @@ where
 					);
 				}
 			},
-			Event::LSPS1Client(LSPS1ClientEvent::OrderCreated {
+			LiquidityEvent::LSPS1Client(LSPS1ClientEvent::OrderCreated {
 				request_id,
 				counterparty_node_id,
 				order_id,
@@ -404,7 +407,7 @@ where
 					log_error!(self.logger, "Received unexpected LSPS1Client::OrderCreated event!");
 				}
 			},
-			Event::LSPS1Client(LSPS1ClientEvent::OrderStatus {
+			LiquidityEvent::LSPS1Client(LSPS1ClientEvent::OrderStatus {
 				request_id,
 				counterparty_node_id,
 				order_id,
@@ -462,7 +465,7 @@ where
 					log_error!(self.logger, "Received unexpected LSPS1Client::OrderStatus event!");
 				}
 			},
-			Event::LSPS2Service(LSPS2ServiceEvent::GetInfo {
+			LiquidityEvent::LSPS2Service(LSPS2ServiceEvent::GetInfo {
 				request_id,
 				counterparty_node_id,
 				token,
@@ -501,10 +504,11 @@ where
 						}
 					}
 
-					let mut valid_until: DateTime<Utc> = Utc::now();
-					valid_until += LSPS2_GETINFO_REQUEST_EXPIRY;
+					let expiry_time = Utc::now() + LSPS2_GETINFO_REQUEST_EXPIRY;
+					let valid_until = LSPSDateTime::from_str(&expiry_time.to_string())
+						.expect("TODO: switch to use constructor when merged");
 
-					let opening_fee_params = RawOpeningFeeParams {
+					let opening_fee_params = LSPS2RawOpeningFeeParams {
 						min_fee_msat: service_config.min_channel_opening_fee_msat,
 						proportional: service_config.channel_opening_fee_ppm,
 						valid_until,
@@ -532,7 +536,7 @@ where
 					return;
 				}
 			},
-			Event::LSPS2Service(LSPS2ServiceEvent::BuyRequest {
+			LiquidityEvent::LSPS2Service(LSPS2ServiceEvent::BuyRequest {
 				request_id,
 				counterparty_node_id,
 				opening_fee_params: _,
@@ -599,7 +603,7 @@ where
 					return;
 				}
 			},
-			Event::LSPS2Service(LSPS2ServiceEvent::OpenChannel {
+			LiquidityEvent::LSPS2Service(LSPS2ServiceEvent::OpenChannel {
 				their_network_key,
 				amt_to_forward_msat,
 				opening_fee_msat: _,
@@ -713,7 +717,7 @@ where
 					},
 				}
 			},
-			Event::LSPS2Client(LSPS2ClientEvent::OpeningParametersReady {
+			LiquidityEvent::LSPS2Client(LSPS2ClientEvent::OpeningParametersReady {
 				request_id,
 				counterparty_node_id,
 				opening_fee_params_menu,
@@ -763,7 +767,7 @@ where
 					);
 				}
 			},
-			Event::LSPS2Client(LSPS2ClientEvent::InvoiceParametersReady {
+			LiquidityEvent::LSPS2Client(LSPS2ClientEvent::InvoiceParametersReady {
 				request_id,
 				counterparty_node_id,
 				intercept_scid,
@@ -903,7 +907,7 @@ where
 			return Err(Error::LiquidityRequestFailed);
 		}
 
-		let order_params = OrderParameters {
+		let order_params = LSPS1OrderParams {
 			lsp_balance_sat,
 			client_balance_sat,
 			required_channel_confirmations: lsp_limits.min_required_channel_confirmations,
@@ -952,7 +956,7 @@ where
 	}
 
 	pub(crate) async fn lsps1_check_order_status(
-		&self, order_id: OrderId,
+		&self, order_id: LSPS1OrderId,
 	) -> Result<LSPS1OrderStatus, Error> {
 		let lsps1_client = self.lsps1_client.as_ref().ok_or(Error::LiquiditySourceUnavailable)?;
 		let client_handler = self.liquidity_manager.lsps1_client_handler().ok_or_else(|| {
@@ -1120,7 +1124,7 @@ where
 	}
 
 	async fn lsps2_send_buy_request(
-		&self, amount_msat: Option<u64>, opening_fee_params: OpeningFeeParams,
+		&self, amount_msat: Option<u64>, opening_fee_params: LSPS2OpeningFeeParams,
 	) -> Result<LSPS2BuyResponse, Error> {
 		let lsps2_client = self.lsps2_client.as_ref().ok_or(Error::LiquiditySourceUnavailable)?;
 
@@ -1291,32 +1295,32 @@ pub(crate) struct LSPS1OpeningParamsResponse {
 #[derive(Debug, Clone)]
 pub struct LSPS1OrderStatus {
 	/// The id of the channel order.
-	pub order_id: OrderId,
+	pub order_id: LSPS1OrderId,
 	/// The parameters of channel order.
-	pub order_params: OrderParameters,
+	pub order_params: LSPS1OrderParams,
 	/// Contains details about how to pay for the order.
-	pub payment_options: PaymentInfo,
+	pub payment_options: LSPS1PaymentInfo,
 	/// Contains information about the channel state.
-	pub channel_state: Option<ChannelInfo>,
+	pub channel_state: Option<LSPS1ChannelInfo>,
 }
 
 #[cfg(not(feature = "uniffi"))]
-type PaymentInfo = lightning_liquidity::lsps1::msgs::PaymentInfo;
+type LSPS1PaymentInfo = lightning_liquidity::lsps1::msgs::LSPS1PaymentInfo;
 
 /// Details regarding how to pay for an order.
 #[cfg(feature = "uniffi")]
 #[derive(Clone, Debug, PartialEq, Eq)]
-pub struct PaymentInfo {
+pub struct LSPS1PaymentInfo {
 	/// A Lightning payment using BOLT 11.
-	pub bolt11: Option<crate::uniffi_types::Bolt11PaymentInfo>,
+	pub bolt11: Option<crate::uniffi_types::LSPS1Bolt11PaymentInfo>,
 	/// An onchain payment.
-	pub onchain: Option<OnchainPaymentInfo>,
+	pub onchain: Option<LSPS1OnchainPaymentInfo>,
 }
 
 #[cfg(feature = "uniffi")]
-impl From<lightning_liquidity::lsps1::msgs::PaymentInfo> for PaymentInfo {
-	fn from(value: lightning_liquidity::lsps1::msgs::PaymentInfo) -> Self {
-		PaymentInfo {
+impl From<lightning_liquidity::lsps1::msgs::LSPS1PaymentInfo> for LSPS1PaymentInfo {
+	fn from(value: lightning_liquidity::lsps1::msgs::LSPS1PaymentInfo) -> Self {
+		LSPS1PaymentInfo {
 			bolt11: value.bolt11.map(|b| b.into()),
 			onchain: value.onchain.map(|o| o.into()),
 		}
@@ -1326,11 +1330,11 @@ impl From<lightning_liquidity::lsps1::msgs::PaymentInfo> for PaymentInfo {
 /// An onchain payment.
 #[cfg(feature = "uniffi")]
 #[derive(Clone, Debug, PartialEq, Eq)]
-pub struct OnchainPaymentInfo {
+pub struct LSPS1OnchainPaymentInfo {
 	/// Indicates the current state of the payment.
-	pub state: lightning_liquidity::lsps1::msgs::PaymentState,
+	pub state: lightning_liquidity::lsps1::msgs::LSPS1PaymentState,
 	/// The datetime when the payment option expires.
-	pub expires_at: chrono::DateTime<chrono::Utc>,
+	pub expires_at: LSPSDateTime,
 	/// 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.
@@ -1349,8 +1353,8 @@ pub struct OnchainPaymentInfo {
 }
 
 #[cfg(feature = "uniffi")]
-impl From<lightning_liquidity::lsps1::msgs::OnchainPaymentInfo> for OnchainPaymentInfo {
-	fn from(value: lightning_liquidity::lsps1::msgs::OnchainPaymentInfo) -> Self {
+impl From<lightning_liquidity::lsps1::msgs::LSPS1OnchainPaymentInfo> for LSPS1OnchainPaymentInfo {
+	fn from(value: lightning_liquidity::lsps1::msgs::LSPS1OnchainPaymentInfo) -> Self {
 		Self {
 			state: value.state,
 			expires_at: value.expires_at,
@@ -1366,7 +1370,7 @@ impl From<lightning_liquidity::lsps1::msgs::OnchainPaymentInfo> for OnchainPayme
 
 #[derive(Debug, Clone)]
 pub(crate) struct LSPS2FeeResponse {
-	opening_fee_params_menu: Vec<OpeningFeeParams>,
+	opening_fee_params_menu: Vec<LSPS2OpeningFeeParams>,
 }
 
 #[derive(Debug, Clone)]
@@ -1456,7 +1460,7 @@ impl LSPS1Liquidity {
 	}
 
 	/// Connects to the configured LSP and checks for the status of a previously-placed order.
-	pub fn check_order_status(&self, order_id: OrderId) -> Result<LSPS1OrderStatus, Error> {
+	pub fn check_order_status(&self, order_id: LSPS1OrderId) -> Result<LSPS1OrderStatus, Error> {
 		let liquidity_source =
 			self.liquidity_source.as_ref().ok_or(Error::LiquiditySourceUnavailable)?;