Expose txid and confirmation_status for onchain payments.

Onchain payments now provide additional information such as
transaction_id and confirmation_status.

Author: G8XSU

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

@@ -35,7 +35,35 @@ message PaymentKind {
 }
 
 // Represents an on-chain payment.
-message Onchain {}
+message Onchain {
+  // The transaction identifier of this payment.
+  string txid = 1;
+
+  // The confirmation status of this payment.
+  ConfirmationStatus status = 2;
+}
+
+message ConfirmationStatus {
+  oneof status {
+    Confirmed confirmed     = 1;
+    Unconfirmed unconfirmed = 2;
+  }
+}
+
+// The on-chain transaction is confirmed in the best chain.
+message Confirmed {
+  // The hex representation of hash of the block in which the transaction was confirmed.
+  string  block_hash = 1;
+
+  // The height under which the block was confirmed.
+  uint32 height = 2;
+
+  // The timestamp, in seconds since start of the UNIX epoch, when this entry was last updated.
+  uint64 timestamp = 3;
+}
+
+// The on-chain transaction is unconfirmed.
+message Unconfirmed {}
 
 // Represents a BOLT 11 payment.
 message Bolt11 {

ldk-server-protos/src/types.rs

@@ -50,7 +50,49 @@ pub mod payment_kind {
 /// Represents an on-chain payment.
 #[allow(clippy::derive_partial_eq_without_eq)]
 #[derive(Clone, PartialEq, ::prost::Message)]
-pub struct Onchain {}
+pub struct Onchain {
+	/// The transaction identifier of this payment.
+	#[prost(string, tag = "1")]
+	pub txid: ::prost::alloc::string::String,
+	/// The confirmation status of this payment.
+	#[prost(message, optional, tag = "2")]
+	pub status: ::core::option::Option<ConfirmationStatus>,
+}
+#[allow(clippy::derive_partial_eq_without_eq)]
+#[derive(Clone, PartialEq, ::prost::Message)]
+pub struct ConfirmationStatus {
+	#[prost(oneof = "confirmation_status::Status", tags = "1, 2")]
+	pub status: ::core::option::Option<confirmation_status::Status>,
+}
+/// Nested message and enum types in `ConfirmationStatus`.
+pub mod confirmation_status {
+	#[allow(clippy::derive_partial_eq_without_eq)]
+	#[derive(Clone, PartialEq, ::prost::Oneof)]
+	pub enum Status {
+		#[prost(message, tag = "1")]
+		Confirmed(super::Confirmed),
+		#[prost(message, tag = "2")]
+		Unconfirmed(super::Unconfirmed),
+	}
+}
+/// The on-chain transaction is confirmed in the best chain.
+#[allow(clippy::derive_partial_eq_without_eq)]
+#[derive(Clone, PartialEq, ::prost::Message)]
+pub struct Confirmed {
+	/// The hex representation of hash of the block in which the transaction was confirmed.
+	#[prost(string, tag = "1")]
+	pub block_hash: ::prost::alloc::string::String,
+	/// The height under which the block was confirmed.
+	#[prost(uint32, tag = "2")]
+	pub height: u32,
+	/// The timestamp, in seconds since start of the UNIX epoch, when this entry was last updated.
+	#[prost(uint64, tag = "3")]
+	pub timestamp: u64,
+}
+/// The on-chain transaction is unconfirmed.
+#[allow(clippy::derive_partial_eq_without_eq)]
+#[derive(Clone, PartialEq, ::prost::Message)]
+pub struct Unconfirmed {}
 /// Represents a BOLT 11 payment.
 #[allow(clippy::derive_partial_eq_without_eq)]
 #[derive(Clone, PartialEq, ::prost::Message)]

ldk-server/src/util/proto_adapter.rs

@@ -5,8 +5,11 @@ use ldk_node::bitcoin::secp256k1::PublicKey;
 use ldk_node::config::{ChannelConfig, MaxDustHTLCExposure};
 use ldk_node::lightning::ln::types::ChannelId;
 use ldk_node::lightning_invoice::{Bolt11InvoiceDescription, Description, Sha256};
-use ldk_node::payment::{PaymentDetails, PaymentDirection, PaymentKind, PaymentStatus};
+use ldk_node::payment::{
+	ConfirmationStatus, PaymentDetails, PaymentDirection, PaymentKind, PaymentStatus,
+};
 use ldk_node::{ChannelDetails, LightningBalance, NodeError, PendingSweepBalance, UserChannelId};
+use ldk_server_protos::types::confirmation_status::Status::{Confirmed, Unconfirmed};
 use ldk_server_protos::types::lightning_balance::BalanceType::{
 	ClaimableAwaitingConfirmations, ClaimableOnChannelClose, ContentiousClaimable,
 	CounterpartyRevokedOutputClaimable, MaybePreimageClaimableHtlc, MaybeTimeoutClaimableHtlc,
@@ -110,8 +113,11 @@ pub(crate) fn payment_kind_to_proto(
 	payment_kind: PaymentKind,
 ) -> ldk_server_protos::types::PaymentKind {
 	match payment_kind {
-		PaymentKind::Onchain => ldk_server_protos::types::PaymentKind {
-			kind: Some(Onchain(ldk_server_protos::types::Onchain {})),
+		PaymentKind::Onchain { txid, status } => ldk_server_protos::types::PaymentKind {
+			kind: Some(Onchain(ldk_server_protos::types::Onchain {
+				txid: txid.to_string(),
+				status: Some(confirmation_status_to_proto(status)),
+			})),
 		},
 		PaymentKind::Bolt11 { hash, preimage, secret } => ldk_server_protos::types::PaymentKind {
 			kind: Some(Bolt11(ldk_server_protos::types::Bolt11 {
@@ -166,6 +172,25 @@ pub(crate) fn payment_kind_to_proto(
 	}
 }
 
+pub(crate) fn confirmation_status_to_proto(
+	confirmation_status: ConfirmationStatus,
+) -> ldk_server_protos::types::ConfirmationStatus {
+	match confirmation_status {
+		ConfirmationStatus::Confirmed { block_hash, height, timestamp } => {
+			ldk_server_protos::types::ConfirmationStatus {
+				status: Some(Confirmed(ldk_server_protos::types::Confirmed {
+					block_hash: block_hash.to_string(),
+					height,
+					timestamp,
+				})),
+			}
+		},
+		ConfirmationStatus::Unconfirmed => ldk_server_protos::types::ConfirmationStatus {
+			status: Some(Unconfirmed(ldk_server_protos::types::Unconfirmed {})),
+		},
+	}
+}
+
 pub(crate) fn lightning_balance_to_proto(
 	lightning_balance: LightningBalance,
 ) -> ldk_server_protos::types::LightningBalance {