Add PaymentReceived, ChannelClosed events

Author: tnull

src/event.rs

@@ -27,7 +27,8 @@ use std::time::Duration;
 /// The event queue will be persisted under this key.
 pub(crate) const EVENTS_PERSISTENCE_KEY: &str = "events";
 
-/// An LdkLiteEvent that should be handled by the user.
+/// An event emitted by [`LdkLite`] that should be handled by the user. This will more often than
+/// not wrap a LDK event accessible via the `inner` field.
 #[derive(Debug, Clone)]
 pub enum LdkLiteEvent {
 	/// A payment we sent was successful.
@@ -44,16 +45,28 @@ pub enum LdkLiteEvent {
 		/// The wrapped LDK event.
 		inner: ldk_events::Event,
 	},
-	//PaymentReceived {
-	//},
+	/// A payment has been received.
+	PaymentReceived {
+		/// The hash of the payment.
+		payment_hash: PaymentHash,
+		/// The value, in thousandths of a satoshi that has been received.
+		amount_msat: u64,
+		/// The wrapped LDK event.
+		inner: ldk_events::Event,
+	},
+	// TODO
 	//ChannelOpened {
 	//},
-	//ChannelClosed {
-	//},
-	//OnChainPaymentReceived {
-	//},
-	//OnChainPaymentReceived {
-	//},
+	/// A channel has been closed.
+	ChannelClosed {
+		/// The channel_id of the channel which has been closed.
+		channel_id: [u8; 32],
+		/// The wrapped LDK event.
+		inner: ldk_events::Event,
+	}, //OnChainPaymentReceived {
+	   //},
+	   //OnChainPaymentReceived {
+	   //}
 }
 
 impl Readable for LdkLiteEvent {
@@ -71,6 +84,20 @@ impl Readable for LdkLiteEvent {
 				let inner: ldk_events::Event = MaybeReadable::read(reader)?.unwrap();
 				Ok(Self::PaymentFailed { payment_hash, inner })
 			}
+			2u8 => {
+				let payment_hash: PaymentHash = Readable::read(reader)?;
+				let amount_msat: u64 = Readable::read(reader)?;
+				let inner: ldk_events::Event = MaybeReadable::read(reader)?.unwrap();
+				Ok(Self::PaymentReceived { payment_hash, amount_msat, inner })
+			}
+			//3u8 => {
+			// TODO ChannelOpened
+			//}
+			4u8 => {
+				let channel_id: [u8; 32] = Readable::read(reader)?;
+				let inner: ldk_events::Event = MaybeReadable::read(reader)?.unwrap();
+				Ok(Self::ChannelClosed { channel_id, inner })
+			}
 			_ => Err(lightning::ln::msgs::DecodeError::InvalidValue),
 		}
 	}
@@ -91,6 +118,22 @@ impl Writeable for LdkLiteEvent {
 				inner.write(writer)?;
 				Ok(())
 			}
+			Self::PaymentReceived { payment_hash, amount_msat, inner } => {
+				2u8.write(writer)?;
+				payment_hash.write(writer)?;
+				amount_msat.write(writer)?;
+				inner.write(writer)?;
+				Ok(())
+			}
+			//Self::ChannelOpened { .. } => {
+			//TODO
+			//}
+			Self::ChannelClosed { channel_id, inner } => {
+				4u8.write(writer)?;
+				channel_id.write(writer)?;
+				inner.write(writer)?;
+				Ok(())
+			}
 		}
 	}
 }
@@ -261,6 +304,13 @@ impl ldk_events::EventHandler for LdkLiteEventHandler {
 					ldk_events::PaymentPurpose::SpontaneousPayment(preimage) => Some(*preimage),
 				};
 				self.channel_manager.claim_funds(payment_preimage.unwrap());
+				self.event_queue
+					.add_event(LdkLiteEvent::PaymentReceived {
+						payment_hash: *payment_hash,
+						amount_msat: *amount_msat,
+						inner: event.clone(),
+					})
+					.unwrap();
 			}
 			ldk_events::Event::PaymentClaimed { payment_hash, purpose, amount_msat } => {
 				log_info!(
@@ -323,10 +373,12 @@ impl ldk_events::EventHandler for LdkLiteEventHandler {
 						);
 					}
 				}
-				self.event_queue.add_event(LdkLiteEvent::PaymentSuccessful {
-					payment_hash: *payment_hash,
-					inner: event.clone(),
-				}).unwrap();
+				self.event_queue
+					.add_event(LdkLiteEvent::PaymentSuccessful {
+						payment_hash: *payment_hash,
+						inner: event.clone(),
+					})
+					.unwrap();
 			}
 			ldk_events::Event::PaymentFailed { payment_hash, .. } => {
 				log_info!(
@@ -340,6 +392,12 @@ impl ldk_events::EventHandler for LdkLiteEventHandler {
 					let payment = payments.get_mut(&payment_hash).unwrap();
 					payment.status = PaymentStatus::Failed;
 				}
+				self.event_queue
+					.add_event(LdkLiteEvent::PaymentFailed {
+						payment_hash: *payment_hash,
+						inner: event.clone(),
+					})
+					.unwrap();
 			}
 
 			ldk_events::Event::PaymentPathSuccessful { .. } => {}
@@ -447,6 +505,12 @@ impl ldk_events::EventHandler for LdkLiteEventHandler {
 					hex::to_string(channel_id),
 					reason
 				);
+				self.event_queue
+					.add_event(LdkLiteEvent::ChannelClosed {
+						channel_id: *channel_id,
+						inner: event.clone(),
+					})
+					.unwrap();
 			}
 			ldk_events::Event::DiscardFunding { .. } => {}
 		}