Add reason to Event::ChannelClosed

Author: tnull

bindings/ldk_node.udl

@@ -162,7 +162,7 @@ interface Event {
 	PaymentReceived ( PaymentHash payment_hash, u64 amount_msat);
 	ChannelPending ( ChannelId channel_id, UserChannelId user_channel_id, ChannelId former_temporary_channel_id, PublicKey counterparty_node_id, OutPoint funding_txo );
 	ChannelReady ( ChannelId channel_id, UserChannelId user_channel_id, PublicKey? counterparty_node_id );
-	ChannelClosed ( ChannelId channel_id, UserChannelId user_channel_id, PublicKey? counterparty_node_id );
+	ChannelClosed ( ChannelId channel_id, UserChannelId user_channel_id, PublicKey? counterparty_node_id, ClosureReason? reason );
 };
 
 enum PaymentFailureReason {
@@ -174,6 +174,20 @@ enum PaymentFailureReason {
 	"UnexpectedError",
 };
 
+[Enum]
+interface ClosureReason {
+	CounterpartyForceClosed ( UntrustedString peer_msg );
+	HolderForceClosed ();
+	CooperativeClosure ();
+	CommitmentTxConfirmed ();
+	FundingTimedOut ();
+	ProcessingError ( string err );
+	DisconnectedPeer ();
+	OutdatedChannelManager ();
+	CounterpartyCoopClosedUnfundedChannel ();
+	FundingBatchClosure ();
+};
+
 enum PaymentDirection {
 	"Inbound",
 	"Outbound",
@@ -309,3 +323,6 @@ typedef string UserChannelId;
 
 [Custom]
 typedef string Mnemonic;
+
+[Custom]
+typedef string UntrustedString;

src/event.rs

@@ -14,7 +14,7 @@ use crate::io::{
 use crate::logger::{log_error, log_info, Logger};
 
 use lightning::chain::chaininterface::ConfirmationTarget;
-use lightning::events::PaymentPurpose;
+use lightning::events::{ClosureReason, PaymentPurpose};
 use lightning::events::{Event as LdkEvent, PaymentFailureReason};
 use lightning::impl_writeable_tlv_based_enum;
 use lightning::ln::{ChannelId, PaymentHash};
@@ -98,6 +98,8 @@ pub enum Event {
 		///
 		/// This will be `None` for events serialized by LDK Node v0.1.0 and prior.
 		counterparty_node_id: Option<PublicKey>,
+		/// This will be `None` for events serialized by LDK Node v0.2.1 and prior.
+		reason: Option<ClosureReason>,
 	},
 }
 
@@ -129,6 +131,7 @@ impl_writeable_tlv_based_enum!(Event,
 		(0, channel_id, required),
 		(1, counterparty_node_id, option),
 		(2, user_channel_id, required),
+		(3, reason, upgradable_option),
 	};
 );
 
@@ -858,6 +861,7 @@ where
 						channel_id,
 						user_channel_id: UserChannelId(user_channel_id),
 						counterparty_node_id,
+						reason: Some(reason),
 					})
 					.unwrap_or_else(|e| {
 						log_error!(self.logger, "Failed to push to event queue: {}", e);

src/lib.rs

@@ -109,8 +109,13 @@ pub use io::utils::generate_entropy_mnemonic;
 
 #[cfg(feature = "uniffi")]
 use {
-	bip39::Mnemonic, bitcoin::OutPoint, lightning::events::PaymentFailureReason,
-	lightning::ln::ChannelId, lightning::ln::PaymentSecret, uniffi_types::*,
+	bip39::Mnemonic,
+	bitcoin::OutPoint,
+	lightning::events::{ClosureReason, PaymentFailureReason},
+	lightning::ln::ChannelId,
+	lightning::ln::PaymentSecret,
+	lightning::util::string::UntrustedString,
+	uniffi_types::*,
 };
 
 #[cfg(feature = "uniffi")]

src/uniffi_types.rs

@@ -10,6 +10,7 @@ use bitcoin::hashes::Hash;
 use bitcoin::secp256k1::PublicKey;
 use bitcoin::{Address, Txid};
 use lightning::ln::{ChannelId, PaymentHash, PaymentPreimage, PaymentSecret};
+use lightning::util::string::UntrustedString;
 use lightning_invoice::{Bolt11Invoice, SignedRawBolt11Invoice};
 
 use bip39::Mnemonic;
@@ -186,3 +187,14 @@ impl UniffiCustomTypeConverter for SocketAddress {
 		obj.to_string()
 	}
 }
+
+impl UniffiCustomTypeConverter for UntrustedString {
+	type Builtin = String;
+	fn into_custom(val: Self::Builtin) -> uniffi::Result<Self> {
+		Ok(UntrustedString(val))
+	}
+
+	fn from_custom(obj: Self) -> Self::Builtin {
+		obj.to_string()
+	}
+}