Introduce PaymentKind to payment store

Author: tnull

bindings/ldk_node.udl

@@ -218,6 +218,14 @@ interface ClosureReason {
 	FundingBatchClosure();
 };
 
+[Enum]
+interface PaymentKind {
+	Onchain();
+	Bolt11();
+	Bolt12();
+	Spontaneous();
+};
+
 enum PaymentDirection {
 	"Inbound",
 	"Outbound",
@@ -235,6 +243,7 @@ dictionary LSPFeeLimits {
 };
 
 dictionary PaymentDetails {
+	PaymentKind? kind;
 	PaymentHash hash;
 	PaymentPreimage? preimage;
 	PaymentSecret? secret;

src/event.rs

@@ -4,7 +4,8 @@ use crate::{
 };
 
 use crate::payment::payment_store::{
-	PaymentDetails, PaymentDetailsUpdate, PaymentDirection, PaymentStatus, PaymentStore,
+	PaymentDetails, PaymentDetailsUpdate, PaymentDirection, PaymentKind, PaymentStatus,
+	PaymentStore,
 };
 
 use crate::io::{
@@ -550,6 +551,7 @@ where
 					},
 					PaymentPurpose::SpontaneousPayment(preimage) => {
 						let payment = PaymentDetails {
+							kind: Some(PaymentKind::Spontaneous),
 							preimage: Some(preimage),
 							hash: payment_hash,
 							secret: None,

src/payment/bolt11.rs

@@ -8,7 +8,7 @@ use crate::error::Error;
 use crate::liquidity::LiquiditySource;
 use crate::logger::{log_error, log_info, FilesystemLogger, Logger};
 use crate::payment::payment_store::{
-	LSPFeeLimits, PaymentDetails, PaymentDirection, PaymentStatus, PaymentStore,
+	LSPFeeLimits, PaymentDetails, PaymentDirection, PaymentKind, PaymentStatus, PaymentStore,
 };
 use crate::peer_store::{PeerInfo, PeerStore};
 use crate::types::{ChannelManager, KeysManager};
@@ -103,6 +103,7 @@ impl Bolt11Payment {
 				log_info!(self.logger, "Initiated sending {}msat to {}", amt_msat, payee_pubkey);
 
 				let payment = PaymentDetails {
+					kind: Some(PaymentKind::Bolt11),
 					preimage: None,
 					hash: payment_hash,
 					secret: payment_secret,
@@ -121,6 +122,7 @@ impl Bolt11Payment {
 					RetryableSendFailure::DuplicatePayment => Err(Error::DuplicatePayment),
 					_ => {
 						let payment = PaymentDetails {
+							kind: Some(PaymentKind::Bolt11),
 							preimage: None,
 							hash: payment_hash,
 							secret: payment_secret,
@@ -209,6 +211,7 @@ impl Bolt11Payment {
 				);
 
 				let payment = PaymentDetails {
+					kind: Some(PaymentKind::Bolt11),
 					hash: payment_hash,
 					preimage: None,
 					secret: Some(*payment_secret),
@@ -228,6 +231,7 @@ impl Bolt11Payment {
 					RetryableSendFailure::DuplicatePayment => Err(Error::DuplicatePayment),
 					_ => {
 						let payment = PaymentDetails {
+							kind: Some(PaymentKind::Bolt11),
 							hash: payment_hash,
 							preimage: None,
 							secret: Some(*payment_secret),
@@ -288,6 +292,7 @@ impl Bolt11Payment {
 
 		let payment_hash = PaymentHash(invoice.payment_hash().to_byte_array());
 		let payment = PaymentDetails {
+			kind: Some(PaymentKind::Bolt11),
 			hash: payment_hash,
 			preimage: None,
 			secret: Some(invoice.payment_secret().clone()),
@@ -414,6 +419,7 @@ impl Bolt11Payment {
 			max_proportional_opening_fee_ppm_msat: lsp_prop_opening_fee,
 		});
 		let payment = PaymentDetails {
+			kind: Some(PaymentKind::Bolt11),
 			hash: payment_hash,
 			preimage: None,
 			secret: Some(invoice.payment_secret().clone()),

src/payment/payment_store.rs

@@ -18,6 +18,10 @@ use std::sync::{Arc, Mutex};
 /// Represents a payment.
 #[derive(Clone, Debug, PartialEq, Eq)]
 pub struct PaymentDetails {
+	/// The kind of the payment.
+	///
+	/// This will be `None` for objects created with LDK Node v0.2.1 and earlier.
+	pub kind: Option<PaymentKind>,
 	/// The payment hash, i.e., the hash of the `preimage`.
 	pub hash: PaymentHash,
 	/// The pre-image used by the payment.
@@ -45,6 +49,7 @@ impl_writeable_tlv_based!(PaymentDetails, {
 	(0, hash, required),
 	(1, lsp_fee_limits, option),
 	(2, preimage, required),
+	(3, kind, option),
 	(4, secret, required),
 	(6, amount_msat, required),
 	(8, direction, required),
@@ -82,6 +87,28 @@ impl_writeable_tlv_based_enum!(PaymentStatus,
 	(4, Failed) => {};
 );
 
+/// Represents the kind of a payment.
+#[derive(Clone, Debug, PartialEq, Eq)]
+pub enum PaymentKind {
+	/// An on-chain payment.
+	Onchain,
+	/// A [BOLT 11] payment.
+	///
+	/// [BOLT 11]: https://github.com/lightning/bolts/blob/master/11-payment-encoding.md
+	// TODO: Bolt11 { invoice: Option<Bolt11Invoice> },
+	Bolt11,
+	/// A spontaneous ("keysend") payment.
+	Spontaneous,
+}
+
+impl_writeable_tlv_based_enum!(PaymentKind,
+	(0, Onchain) => {},
+	(2, Bolt11) => {
+	// TODO:	(0, invoice, option),
+	},
+	(6, Spontaneous) => {};
+);
+
 /// Limits applying to how much fee we allow an LSP to deduct from the payment amount.
 ///
 /// See [`LdkChannelConfig::accept_underpaying_htlcs`] for more information.

src/payment/spontaneous.rs

@@ -4,7 +4,7 @@ use crate::config::{Config, LDK_PAYMENT_RETRY_TIMEOUT};
 use crate::error::Error;
 use crate::logger::{log_error, log_info, FilesystemLogger, Logger};
 use crate::payment::payment_store::{
-	PaymentDetails, PaymentDirection, PaymentStatus, PaymentStore,
+	PaymentDetails, PaymentDirection, PaymentKind, PaymentStatus, PaymentStore,
 };
 use crate::types::{ChannelManager, KeysManager};
 
@@ -77,6 +77,7 @@ impl SpontaneousPayment {
 				log_info!(self.logger, "Initiated sending {}msat to {}.", amount_msat, node_id);
 
 				let payment = PaymentDetails {
+					kind: Some(PaymentKind::Spontaneous),
 					hash: payment_hash,
 					preimage: Some(payment_preimage),
 					secret: None,
@@ -96,6 +97,7 @@ impl SpontaneousPayment {
 					RetryableSendFailure::DuplicatePayment => Err(Error::DuplicatePayment),
 					_ => {
 						let payment = PaymentDetails {
+							kind: Some(PaymentKind::Spontaneous),
 							hash: payment_hash,
 							preimage: Some(payment_preimage),
 							secret: None,

src/uniffi_types.rs

@@ -1,4 +1,4 @@
-pub use crate::payment::payment_store::{LSPFeeLimits, PaymentDirection, PaymentStatus};
+pub use crate::payment::payment_store::{LSPFeeLimits, PaymentDirection, PaymentStatus, PaymentKind};
 
 pub use lightning::events::{ClosureReason, PaymentFailureReason};
 pub use lightning::ln::{ChannelId, PaymentHash, PaymentPreimage, PaymentSecret};