Merge pull request #56 from G8XSU/2025-03-18-close-channel-api-fix

Consistently use UserChannelId and PaymentId as Strings.

Author: G8XSU

ldk-server-protos/src/api.rs

@@ -147,9 +147,9 @@ pub struct Bolt11SendRequest {
 #[allow(clippy::derive_partial_eq_without_eq)]
 #[derive(Clone, PartialEq, ::prost::Message)]
 pub struct Bolt11SendResponse {
-	/// An identifier used to uniquely identify a payment.
-	#[prost(bytes = "bytes", tag = "1")]
-	pub payment_id: ::prost::bytes::Bytes,
+	/// An identifier used to uniquely identify a payment in hex-encoded form.
+	#[prost(string, tag = "1")]
+	pub payment_id: ::prost::alloc::string::String,
 }
 /// Returns a BOLT12 offer for the given amount, if specified.
 ///
@@ -211,9 +211,9 @@ pub struct Bolt12SendRequest {
 #[allow(clippy::derive_partial_eq_without_eq)]
 #[derive(Clone, PartialEq, ::prost::Message)]
 pub struct Bolt12SendResponse {
-	/// An identifier used to uniquely identify a payment.
-	#[prost(bytes = "bytes", tag = "1")]
-	pub payment_id: ::prost::bytes::Bytes,
+	/// An identifier used to uniquely identify a payment in hex-encoded form.
+	#[prost(string, tag = "1")]
+	pub payment_id: ::prost::alloc::string::String,
 }
 /// Creates a new outbound channel to the given remote node.
 /// See more: <https://docs.rs/ldk-node/latest/ldk_node/struct.Node.html#method.connect_open_channel>
@@ -245,16 +245,16 @@ pub struct OpenChannelRequest {
 #[allow(clippy::derive_partial_eq_without_eq)]
 #[derive(Clone, PartialEq, ::prost::Message)]
 pub struct OpenChannelResponse {
-	/// The channel id of the created channel that user can use to refer to channel.
-	#[prost(bytes = "bytes", tag = "1")]
-	pub user_channel_id: ::prost::bytes::Bytes,
+	/// The local channel id of the created channel that user can use to refer to channel.
+	#[prost(string, tag = "1")]
+	pub user_channel_id: ::prost::alloc::string::String,
 }
 /// Update the config for a previously opened channel.
 /// See more: <https://docs.rs/ldk-node/latest/ldk_node/struct.Node.html#method.update_channel_config>
 #[allow(clippy::derive_partial_eq_without_eq)]
 #[derive(Clone, PartialEq, ::prost::Message)]
 pub struct UpdateChannelConfigRequest {
-	/// The hex-encoded local `user_channel_id` of this channel.
+	/// The local `user_channel_id` of this channel.
 	#[prost(string, tag = "1")]
 	pub user_channel_id: ::prost::alloc::string::String,
 	/// The hex-encoded public key of the counterparty node to update channel config with.
@@ -276,9 +276,9 @@ pub struct UpdateChannelConfigResponse {}
 #[allow(clippy::derive_partial_eq_without_eq)]
 #[derive(Clone, PartialEq, ::prost::Message)]
 pub struct CloseChannelRequest {
-	/// The channel id of the created channel that user can use to refer to channel.
-	#[prost(bytes = "bytes", tag = "1")]
-	pub user_channel_id: ::prost::bytes::Bytes,
+	/// The local `user_channel_id` of this channel.
+	#[prost(string, tag = "1")]
+	pub user_channel_id: ::prost::alloc::string::String,
 	/// The hex-encoded public key of the node to close a channel with.
 	#[prost(string, tag = "2")]
 	pub counterparty_node_id: ::prost::alloc::string::String,

ldk-server-protos/src/proto/api.proto

@@ -145,8 +145,8 @@ message Bolt11SendRequest {
 // When HttpStatusCode is not OK (non-200), the response `content` contains a serialized `ErrorResponse`.
 message Bolt11SendResponse {
 
-  // An identifier used to uniquely identify a payment.
-  bytes payment_id = 1;
+  // An identifier used to uniquely identify a payment in hex-encoded form.
+  string payment_id = 1;
 }
 
 // Returns a BOLT12 offer for the given amount, if specified.
@@ -205,8 +205,8 @@ message Bolt12SendRequest {
 // When HttpStatusCode is not OK (non-200), the response `content` contains a serialized `ErrorResponse`.
 message Bolt12SendResponse {
 
-  // An identifier used to uniquely identify a payment.
-  bytes payment_id = 1;
+  // An identifier used to uniquely identify a payment in hex-encoded form.
+  string payment_id = 1;
 }
 
 // Creates a new outbound channel to the given remote node.
@@ -237,15 +237,15 @@ message OpenChannelRequest {
 // When HttpStatusCode is not OK (non-200), the response `content` contains a serialized `ErrorResponse`.
 message OpenChannelResponse {
 
-  // The channel id of the created channel that user can use to refer to channel.
-  bytes user_channel_id = 1;
+  // The local channel id of the created channel that user can use to refer to channel.
+  string user_channel_id = 1;
 }
 
 // Update the config for a previously opened channel.
 // See more: https://docs.rs/ldk-node/latest/ldk_node/struct.Node.html#method.update_channel_config
 message UpdateChannelConfigRequest {
 
-  // The hex-encoded local `user_channel_id` of this channel.
+  // The local `user_channel_id` of this channel.
   string user_channel_id = 1;
 
   // The hex-encoded public key of the counterparty node to update channel config with.
@@ -266,8 +266,8 @@ message UpdateChannelConfigResponse {
 // - https://docs.rs/ldk-node/latest/ldk_node/struct.Node.html#method.force_close_channel
 message CloseChannelRequest {
 
-  // The channel id of the created channel that user can use to refer to channel.
-  bytes user_channel_id = 1;
+  // The local `user_channel_id` of this channel.
+  string user_channel_id = 1;
 
   // The hex-encoded public key of the node to close a channel with.
   string counterparty_node_id = 2;

ldk-server/src/api/bolt11_send.rs

@@ -1,6 +1,5 @@
 use crate::api::error::LdkServerError;
 use crate::service::Context;
-use bytes::Bytes;
 use ldk_node::lightning_invoice::Bolt11Invoice;
 use ldk_server_protos::api::{Bolt11SendRequest, Bolt11SendResponse};
 use std::str::FromStr;
@@ -20,6 +19,6 @@ pub(crate) fn handle_bolt11_send_request(
 		},
 	}?;
 
-	let response = Bolt11SendResponse { payment_id: Bytes::from(payment_id.0.to_vec()) };
+	let response = Bolt11SendResponse { payment_id: payment_id.to_string() };
 	Ok(response)
 }

ldk-server/src/api/bolt12_send.rs

@@ -1,6 +1,5 @@
 use crate::api::error::LdkServerError;
 use crate::service::Context;
-use bytes::Bytes;
 use ldk_node::lightning::offers::offer::Offer;
 use ldk_server_protos::api::{Bolt12SendRequest, Bolt12SendResponse};
 use std::str::FromStr;
@@ -23,6 +22,6 @@ pub(crate) fn handle_bolt12_send_request(
 		),
 	}?;
 
-	let response = Bolt12SendResponse { payment_id: Bytes::from(payment_id.0.to_vec()) };
+	let response = Bolt12SendResponse { payment_id: payment_id.to_string() };
 	Ok(response)
 }

ldk-server/src/api/close_channel.rs

@@ -11,10 +11,10 @@ pub(crate) const CLOSE_CHANNEL_PATH: &str = "CloseChannel";
 pub(crate) fn handle_close_channel_request(
 	context: Context, request: CloseChannelRequest,
 ) -> Result<CloseChannelResponse, LdkServerError> {
-	//TODO: Should this be string?
-	let mut user_channel_id_bytes = [0u8; 16];
-	user_channel_id_bytes.copy_from_slice(&request.user_channel_id);
-	let user_channel_id = UserChannelId(u128::from_be_bytes(user_channel_id_bytes));
+	let user_channel_id =
+		UserChannelId((&request.user_channel_id).parse::<u128>().map_err(|_| {
+			LdkServerError::new(InvalidRequestError, "Invalid UserChannelId.".to_string())
+		})?);
 	let counterparty_node_id = PublicKey::from_str(&request.counterparty_node_id).map_err(|e| {
 		LdkServerError::new(
 			InvalidRequestError,

ldk-server/src/api/open_channel.rs

@@ -1,6 +1,5 @@
 use crate::api::error::LdkServerError;
 use crate::service::Context;
-use bytes::Bytes;
 use ldk_node::bitcoin::secp256k1::PublicKey;
 use ldk_node::lightning::ln::msgs::SocketAddress;
 use ldk_server_protos::api::{OpenChannelRequest, OpenChannelResponse};
@@ -35,8 +34,6 @@ pub(crate) fn handle_open_channel(
 		)?
 	};
 
-	let response = OpenChannelResponse {
-		user_channel_id: Bytes::from(user_channel_id.0.to_be_bytes().to_vec()),
-	};
+	let response = OpenChannelResponse { user_channel_id: user_channel_id.0.to_string() };
 	Ok(response)
 }

ldk-server/src/api/update_channel_config.rs

@@ -13,9 +13,10 @@ pub(crate) const UPDATE_CHANNEL_CONFIG_PATH: &str = "UpdateChannelConfig";
 pub(crate) fn handle_update_channel_config_request(
 	context: Context, request: UpdateChannelConfigRequest,
 ) -> Result<UpdateChannelConfigResponse, LdkServerError> {
-	let user_channel_id: u128 = request.user_channel_id.parse().map_err(|_| {
-		LdkServerError::new(InvalidRequestError, "Failed to parse user_channel_id: invalid format.")
-	})?;
+	let user_channel_id: u128 = request
+		.user_channel_id
+		.parse::<u128>()
+		.map_err(|_| LdkServerError::new(InvalidRequestError, "Invalid UserChannelId."))?;
 
 	//FIXME: Use ldk/ldk-node's partial config update api.
 	let current_config = context