Merge pull request #20 from G8XSU/error-model-2

Simpler Error Model for ldk-server

Author: G8XSU

cli/src/main.rs

@@ -1,7 +1,7 @@
 use clap::{Parser, Subcommand};
 use client::client::LdkNodeServerClient;
 use client::error::LdkNodeServerError;
-use client::protos::{
+use client::protos::api::{
 	Bolt11ReceiveRequest, Bolt11SendRequest, Bolt12ReceiveRequest, Bolt12SendRequest,
 	OnchainReceiveRequest, OnchainSendRequest, OpenChannelRequest,
 };

client/src/client.rs

@@ -1,7 +1,7 @@
 use prost::Message;
 
 use crate::error::LdkNodeServerError;
-use protos::{
+use protos::api::{
 	Bolt11ReceiveRequest, Bolt11ReceiveResponse, Bolt11SendRequest, Bolt11SendResponse,
 	Bolt12ReceiveRequest, Bolt12ReceiveResponse, Bolt12SendRequest, Bolt12SendResponse,
 	CloseChannelRequest, CloseChannelResponse, ListChannelsRequest, ListChannelsResponse,

protos/build.rs

@@ -14,9 +14,16 @@ fn main() {
 fn generate_protos() {
 	prost_build::Config::new()
 		.bytes(&["."])
-		.compile_protos(&["src/proto/ldk_node_server.proto"], &["src/"])
+		.compile_protos(
+			&["src/proto/api.proto", "src/proto/types.proto", "src/proto/error.proto"],
+			&["src/proto/"],
+		)
 		.expect("protobuf compilation failed");
 	println!("OUT_DIR: {}", &env::var("OUT_DIR").unwrap());
-	let from_path = Path::new(&env::var("OUT_DIR").unwrap()).join("ldk_node_server.rs");
-	fs::copy(from_path, "src/lib.rs").unwrap();
+	let from_path = Path::new(&env::var("OUT_DIR").unwrap()).join("api.rs");
+	fs::copy(from_path, "src/api.rs").unwrap();
+	let from_path = Path::new(&env::var("OUT_DIR").unwrap()).join("types.rs");
+	fs::copy(from_path, "src/types.rs").unwrap();
+	let from_path = Path::new(&env::var("OUT_DIR").unwrap()).join("error.rs");
+	fs::copy(from_path, "src/error.rs").unwrap();
 }

protos/src/api.rs

@@ -0,0 +1,313 @@
+/// Retrieve the latest node info like `node_id`, `current_best_block` etc.
+/// See more:
+/// - <https://docs.rs/ldk-node/latest/ldk_node/struct.Node.html#method.node_id>
+/// - <https://docs.rs/ldk-node/latest/ldk_node/struct.Node.html#method.status>
+#[allow(clippy::derive_partial_eq_without_eq)]
+#[derive(Clone, PartialEq, ::prost::Message)]
+pub struct GetNodeInfoRequest {}
+#[allow(clippy::derive_partial_eq_without_eq)]
+#[derive(Clone, PartialEq, ::prost::Message)]
+pub struct GetNodeInfoResponse {
+	/// The hex-encoded `node-id` or public key for our own lightning node.
+	#[prost(string, tag = "1")]
+	pub node_id: ::prost::alloc::string::String,
+	/// The best block to which our Lightning wallet is currently synced.
+	///
+	/// Should be always set, will never be `None`.
+	#[prost(message, optional, tag = "3")]
+	pub current_best_block: ::core::option::Option<super::types::BestBlock>,
+	/// The timestamp, in seconds since start of the UNIX epoch, when we last successfully synced our Lightning wallet to
+	/// the chain tip.
+	///
+	/// Will be `None` if the wallet hasn't been synced yet.
+	#[prost(uint64, optional, tag = "4")]
+	pub latest_lightning_wallet_sync_timestamp: ::core::option::Option<u64>,
+	/// The timestamp, in seconds since start of the UNIX epoch, when we last successfully synced our on-chain
+	/// wallet to the chain tip.
+	///
+	/// Will be `None` if the wallet hasn’t been synced since the node was initialized.
+	#[prost(uint64, optional, tag = "5")]
+	pub latest_onchain_wallet_sync_timestamp: ::core::option::Option<u64>,
+	/// The timestamp, in seconds since start of the UNIX epoch, when we last successfully update our fee rate cache.
+	///
+	/// Will be `None` if the cache hasn’t been updated since the node was initialized.
+	#[prost(uint64, optional, tag = "6")]
+	pub latest_fee_rate_cache_update_timestamp: ::core::option::Option<u64>,
+	/// The timestamp, in seconds since start of the UNIX epoch, when the last rapid gossip sync (RGS) snapshot we
+	/// successfully applied was generated.
+	///
+	/// Will be `None` if RGS isn’t configured or the snapshot hasn’t been updated since the node was initialized.
+	#[prost(uint64, optional, tag = "7")]
+	pub latest_rgs_snapshot_timestamp: ::core::option::Option<u64>,
+	/// The timestamp, in seconds since start of the UNIX epoch, when we last broadcasted a node announcement.
+	///
+	/// Will be `None` if we have no public channels or we haven’t broadcasted since the node was initialized.
+	#[prost(uint64, optional, tag = "8")]
+	pub latest_node_announcement_broadcast_timestamp: ::core::option::Option<u64>,
+}
+/// Retrieve a new on-chain funding address.
+/// See more: <https://docs.rs/ldk-node/latest/ldk_node/payment/struct.OnchainPayment.html#method.new_address>
+#[allow(clippy::derive_partial_eq_without_eq)]
+#[derive(Clone, PartialEq, ::prost::Message)]
+pub struct OnchainReceiveRequest {}
+#[allow(clippy::derive_partial_eq_without_eq)]
+#[derive(Clone, PartialEq, ::prost::Message)]
+pub struct OnchainReceiveResponse {
+	/// A Bitcoin on-chain address.
+	#[prost(string, tag = "1")]
+	pub address: ::prost::alloc::string::String,
+}
+/// Send an on-chain payment to the given address.
+#[allow(clippy::derive_partial_eq_without_eq)]
+#[derive(Clone, PartialEq, ::prost::Message)]
+pub struct OnchainSendRequest {
+	/// The address to send coins to.
+	#[prost(string, tag = "1")]
+	pub address: ::prost::alloc::string::String,
+	/// The amount in satoshis to send.
+	/// While sending the specified amount, we will respect any on-chain reserve we need to keep,
+	/// i.e., won't allow to cut into `total_anchor_channels_reserve_sats`.
+	/// See more: <https://docs.rs/ldk-node/latest/ldk_node/payment/struct.OnchainPayment.html#method.send_to_address>
+	#[prost(uint64, optional, tag = "2")]
+	pub amount_sats: ::core::option::Option<u64>,
+	/// If set, the amount_sats field should be unset.
+	/// It indicates that node will send full balance to the specified address.
+	///
+	/// Please note that when send_all is used this operation will **not** retain any on-chain reserves,
+	/// which might be potentially dangerous if you have open Anchor channels for which you can't trust
+	/// the counterparty to spend the Anchor output after channel closure.
+	/// See more: <https://docs.rs/ldk-node/latest/ldk_node/payment/struct.OnchainPayment.html#method.send_all_to_address>
+	#[prost(bool, optional, tag = "3")]
+	pub send_all: ::core::option::Option<bool>,
+}
+#[allow(clippy::derive_partial_eq_without_eq)]
+#[derive(Clone, PartialEq, ::prost::Message)]
+pub struct OnchainSendResponse {
+	/// The transaction ID of the broadcasted transaction.
+	#[prost(string, tag = "1")]
+	pub txid: ::prost::alloc::string::String,
+}
+/// Return a BOLT11 payable invoice that can be used to request and receive a payment
+/// for the given amount, if specified.
+/// The inbound payment will be automatically claimed upon arrival.
+/// See more:
+/// - <https://docs.rs/ldk-node/latest/ldk_node/payment/struct.Bolt11Payment.html#method.receive>
+/// - <https://docs.rs/ldk-node/latest/ldk_node/payment/struct.Bolt11Payment.html#method.receive_variable_amount>
+#[allow(clippy::derive_partial_eq_without_eq)]
+#[derive(Clone, PartialEq, ::prost::Message)]
+pub struct Bolt11ReceiveRequest {
+	/// The amount in millisatoshi to send. If unset, a "zero-amount" or variable-amount invoice is returned.
+	#[prost(uint64, optional, tag = "1")]
+	pub amount_msat: ::core::option::Option<u64>,
+	/// An optional description to attach along with the invoice.
+	/// Will be set in the description field of the encoded payment request.
+	#[prost(string, tag = "2")]
+	pub description: ::prost::alloc::string::String,
+	/// Invoice expiry time in seconds.
+	#[prost(uint32, tag = "3")]
+	pub expiry_secs: u32,
+}
+#[allow(clippy::derive_partial_eq_without_eq)]
+#[derive(Clone, PartialEq, ::prost::Message)]
+pub struct Bolt11ReceiveResponse {
+	/// An invoice for a payment within the Lightning Network.
+	/// With the details of the invoice, the sender has all the data necessary to send a payment
+	/// to the recipient.
+	#[prost(string, tag = "1")]
+	pub invoice: ::prost::alloc::string::String,
+}
+/// Send a payment for a BOLT11 invoice.
+/// See more: <https://docs.rs/ldk-node/latest/ldk_node/payment/struct.Bolt11Payment.html#method.send>
+#[allow(clippy::derive_partial_eq_without_eq)]
+#[derive(Clone, PartialEq, ::prost::Message)]
+pub struct Bolt11SendRequest {
+	/// An invoice for a payment within the Lightning Network.
+	#[prost(string, tag = "1")]
+	pub invoice: ::prost::alloc::string::String,
+	/// Set this field when paying a so-called "zero-amount" invoice, i.e., an invoice that leaves the
+	/// amount paid to be determined by the user.
+	/// This operation will fail if the amount specified is less than the value required by the given invoice.
+	#[prost(uint64, optional, tag = "2")]
+	pub amount_msat: ::core::option::Option<u64>,
+}
+#[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,
+}
+/// Returns a BOLT12 offer for the given amount, if specified.
+///
+/// See more:
+/// - <https://docs.rs/ldk-node/latest/ldk_node/payment/struct.Bolt12Payment.html#method.receive>
+/// - <https://docs.rs/ldk-node/latest/ldk_node/payment/struct.Bolt12Payment.html#method.receive_variable_amount>
+#[allow(clippy::derive_partial_eq_without_eq)]
+#[derive(Clone, PartialEq, ::prost::Message)]
+pub struct Bolt12ReceiveRequest {
+	/// An optional description to attach along with the offer.
+	/// Will be set in the description field of the encoded offer.
+	#[prost(string, tag = "1")]
+	pub description: ::prost::alloc::string::String,
+	/// The amount in millisatoshi to send. If unset, a "zero-amount" or variable-amount offer is returned.
+	#[prost(uint64, optional, tag = "2")]
+	pub amount_msat: ::core::option::Option<u64>,
+	/// Offer expiry time in seconds.
+	#[prost(uint32, optional, tag = "3")]
+	pub expiry_secs: ::core::option::Option<u32>,
+	/// If set, it represents the number of items requested, can only be set for fixed-amount offers.
+	#[prost(uint64, optional, tag = "4")]
+	pub quantity: ::core::option::Option<u64>,
+}
+#[allow(clippy::derive_partial_eq_without_eq)]
+#[derive(Clone, PartialEq, ::prost::Message)]
+pub struct Bolt12ReceiveResponse {
+	/// An offer for a payment within the Lightning Network.
+	/// With the details of the offer, the sender has all the data necessary to send a payment
+	/// to the recipient.
+	#[prost(string, tag = "1")]
+	pub offer: ::prost::alloc::string::String,
+}
+/// Send a payment for a BOLT12 offer.
+/// See more:
+/// - <https://docs.rs/ldk-node/latest/ldk_node/payment/struct.Bolt12Payment.html#method.send>
+/// - <https://docs.rs/ldk-node/latest/ldk_node/payment/struct.Bolt12Payment.html#method.send_using_amount>
+#[allow(clippy::derive_partial_eq_without_eq)]
+#[derive(Clone, PartialEq, ::prost::Message)]
+pub struct Bolt12SendRequest {
+	/// An offer for a payment within the Lightning Network.
+	#[prost(string, tag = "1")]
+	pub offer: ::prost::alloc::string::String,
+	/// Set this field when paying a so-called "zero-amount" offer, i.e., an offer that leaves the
+	/// amount paid to be determined by the user.
+	/// This operation will fail if the amount specified is less than the value required by the given offer.
+	#[prost(uint64, optional, tag = "2")]
+	pub amount_msat: ::core::option::Option<u64>,
+	/// If set, it represents the number of items requested.
+	#[prost(uint64, optional, tag = "3")]
+	pub quantity: ::core::option::Option<u64>,
+	/// If set, it will be seen by the recipient and reflected back in the invoice.
+	#[prost(string, optional, tag = "4")]
+	pub payer_note: ::core::option::Option<::prost::alloc::string::String>,
+}
+#[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,
+}
+/// 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>
+#[allow(clippy::derive_partial_eq_without_eq)]
+#[derive(Clone, PartialEq, ::prost::Message)]
+pub struct OpenChannelRequest {
+	/// The hex-encoded public key of the node to open a channel with.
+	#[prost(string, tag = "1")]
+	pub node_pubkey: ::prost::alloc::string::String,
+	/// An address which can be used to connect to a remote peer.
+	/// It can be of type IPv4:port, IPv6:port, OnionV3:port or hostname:port
+	#[prost(string, tag = "2")]
+	pub address: ::prost::alloc::string::String,
+	/// The amount of satoshis the caller is willing to commit to the channel.
+	#[prost(uint64, tag = "3")]
+	pub channel_amount_sats: u64,
+	/// The amount of satoshis to push to the remote side as part of the initial commitment state.
+	#[prost(uint64, optional, tag = "4")]
+	pub push_to_counterparty_msat: ::core::option::Option<u64>,
+	/// The channel configuration to be used for opening this channel. If unset, default ChannelConfig is used.
+	#[prost(message, optional, tag = "5")]
+	pub channel_config: ::core::option::Option<super::types::ChannelConfig>,
+	/// Whether the channel should be public.
+	#[prost(bool, tag = "6")]
+	pub announce_channel: bool,
+}
+#[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,
+}
+/// 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.
+	#[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.
+	#[prost(string, tag = "2")]
+	pub counterparty_node_id: ::prost::alloc::string::String,
+	/// The updated channel configuration settings for a channel.
+	#[prost(message, optional, tag = "3")]
+	pub channel_config: ::core::option::Option<super::types::ChannelConfig>,
+}
+#[allow(clippy::derive_partial_eq_without_eq)]
+#[derive(Clone, PartialEq, ::prost::Message)]
+pub struct UpdateChannelConfigResponse {}
+/// Closes the channel specified by given request.
+/// See more:
+/// - <https://docs.rs/ldk-node/latest/ldk_node/struct.Node.html#method.close_channel>
+/// - <https://docs.rs/ldk-node/latest/ldk_node/struct.Node.html#method.force_close_channel>
+#[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 hex-encoded public key of the node to close a channel with.
+	#[prost(string, tag = "2")]
+	pub counterparty_node_id: ::prost::alloc::string::String,
+	/// Whether to force close the specified channel.
+	#[prost(bool, optional, tag = "3")]
+	pub force_close: ::core::option::Option<bool>,
+	/// The reason for force-closing, can only be set while force closing a channel.
+	#[prost(string, optional, tag = "4")]
+	pub force_close_reason: ::core::option::Option<::prost::alloc::string::String>,
+}
+#[allow(clippy::derive_partial_eq_without_eq)]
+#[derive(Clone, PartialEq, ::prost::Message)]
+pub struct CloseChannelResponse {}
+/// Returns a list of known channels.
+/// See more: <https://docs.rs/ldk-node/latest/ldk_node/struct.Node.html#method.list_channels>
+#[allow(clippy::derive_partial_eq_without_eq)]
+#[derive(Clone, PartialEq, ::prost::Message)]
+pub struct ListChannelsRequest {}
+#[allow(clippy::derive_partial_eq_without_eq)]
+#[derive(Clone, PartialEq, ::prost::Message)]
+pub struct ListChannelsResponse {
+	/// List of channels.
+	#[prost(message, repeated, tag = "1")]
+	pub channels: ::prost::alloc::vec::Vec<super::types::Channel>,
+}
+/// Returns payment details for a given payment_id.
+/// See more: <https://docs.rs/ldk-node/latest/ldk_node/struct.Node.html#method.payment>
+#[allow(clippy::derive_partial_eq_without_eq)]
+#[derive(Clone, PartialEq, ::prost::Message)]
+pub struct GetPaymentDetailsRequest {
+	/// An identifier used to uniquely identify a payment in hex-encoded form.
+	#[prost(string, tag = "1")]
+	pub payment_id: ::prost::alloc::string::String,
+}
+#[allow(clippy::derive_partial_eq_without_eq)]
+#[derive(Clone, PartialEq, ::prost::Message)]
+pub struct GetPaymentDetailsResponse {
+	/// Represents a payment.
+	/// Will be `None` if payment doesn't exist.
+	#[prost(message, optional, tag = "1")]
+	pub payment: ::core::option::Option<super::types::Payment>,
+}
+/// Retrieves list of all payments.
+/// See more: <https://docs.rs/ldk-node/latest/ldk_node/struct.Node.html#method.list_payments>
+#[allow(clippy::derive_partial_eq_without_eq)]
+#[derive(Clone, PartialEq, ::prost::Message)]
+pub struct ListPaymentsRequest {}
+#[allow(clippy::derive_partial_eq_without_eq)]
+#[derive(Clone, PartialEq, ::prost::Message)]
+pub struct ListPaymentsResponse {
+	/// List of payments.
+	#[prost(message, repeated, tag = "1")]
+	pub payments: ::prost::alloc::vec::Vec<super::types::Payment>,
+}