Implement serialization for event queue types

Author: tnull

lightning-liquidity/src/events/mod.rs

@@ -25,6 +25,12 @@ use crate::lsps1;
 use crate::lsps2;
 use crate::lsps5;
 
+use lightning::io;
+use lightning::ln::msgs::DecodeError;
+use lightning::util::ser::{
+	BigSize, FixedLengthReader, MaybeReadable, Readable, Writeable, Writer,
+};
+
 /// An event which you should probably take some action in response to.
 #[derive(Debug, Clone, PartialEq, Eq)]
 pub enum LiquidityEvent {
@@ -87,3 +93,53 @@ impl From<lsps5::event::LSPS5ServiceEvent> for LiquidityEvent {
 		Self::LSPS5Service(event)
 	}
 }
+
+impl Writeable for LiquidityEvent {
+	fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
+		match self {
+			Self::LSPS0Client(_) => {},
+			Self::LSPS1Client(_) => {},
+			#[cfg(lsps1_service)]
+			Self::LSPS1Service(_) => {},
+			Self::LSPS2Client(_) => {},
+			Self::LSPS2Service(event) => {
+				0u8.write(writer)?;
+				event.write(writer)?;
+			},
+			Self::LSPS5Client(_) => {},
+			Self::LSPS5Service(event) => {
+				2u8.write(writer)?;
+				event.write(writer)?;
+			},
+		}
+		Ok(())
+	}
+}
+
+impl MaybeReadable for LiquidityEvent {
+	fn read<R: io::Read>(reader: &mut R) -> Result<Option<Self>, DecodeError> {
+		match Readable::read(reader)? {
+			0u8 => {
+				let event = Readable::read(reader)?;
+				Ok(Some(LiquidityEvent::LSPS2Service(event)))
+			},
+			2u8 => {
+				let event = Readable::read(reader)?;
+				Ok(Some(LiquidityEvent::LSPS5Service(event)))
+			},
+			x if x % 2 == 1 => {
+				// If the event is of unknown type, assume it was written with `write_tlv_fields`,
+				// which prefixes the whole thing with a length BigSize. Because the event is
+				// odd-type unknown, we should treat it as `Ok(None)` even if it has some TLV
+				// fields that are even. Thus, we avoid using `read_tlv_fields` and simply read
+				// exactly the number of bytes specified, ignoring them entirely.
+				let tlv_len: BigSize = Readable::read(reader)?;
+				FixedLengthReader::new(reader, tlv_len.0)
+					.eat_remaining()
+					.map_err(|_| DecodeError::ShortRead)?;
+				Ok(None)
+			},
+			_ => Err(DecodeError::InvalidValue),
+		}
+	}
+}

lightning-liquidity/src/lsps2/event.rs

@@ -16,6 +16,8 @@ use alloc::vec::Vec;
 
 use bitcoin::secp256k1::PublicKey;
 
+use lightning::impl_writeable_tlv_based_enum;
+
 /// An event which an LSPS2 client should take some action in response to.
 #[derive(Clone, Debug, PartialEq, Eq)]
 pub enum LSPS2ClientEvent {
@@ -161,3 +163,24 @@ pub enum LSPS2ServiceEvent {
 		intercept_scid: u64,
 	},
 }
+
+impl_writeable_tlv_based_enum!(LSPS2ServiceEvent,
+	(0, GetInfo) => {
+		(0, request_id, required),
+		(2, counterparty_node_id, required),
+		(4, token, option),
+	},
+	(2, BuyRequest) => {
+		(0, request_id, required),
+		(2, counterparty_node_id, required),
+		(4, opening_fee_params, required),
+		(6, payment_size_msat, option),
+	},
+	(4, OpenChannel) => {
+		(0, their_network_key, required),
+		(2, amt_to_forward_msat, required),
+		(4, opening_fee_msat, required),
+		(6, user_channel_id, required),
+		(8, intercept_scid, required),
+	}
+);

lightning-liquidity/src/lsps5/event.rs

@@ -13,6 +13,8 @@ use crate::lsps0::ser::LSPSRequestId;
 use alloc::string::String;
 use alloc::vec::Vec;
 use bitcoin::secp256k1::PublicKey;
+
+use lightning::impl_writeable_tlv_based_enum;
 use lightning::util::hash_tables::HashMap;
 
 use super::msgs::LSPS5AppName;
@@ -70,6 +72,16 @@ pub enum LSPS5ServiceEvent {
 	},
 }
 
+impl_writeable_tlv_based_enum!(LSPS5ServiceEvent,
+	(0, SendWebhookNotification) => {
+		(0, counterparty_node_id, required),
+		(2, app_name, required),
+		(4, url, required),
+		(6, notification, required),
+		(8, headers, required),
+	}
+);
+
 /// An event which an LSPS5 client should take some action in response to.
 #[derive(Debug, Clone, PartialEq, Eq)]
 pub enum LSPS5ClientEvent {

lightning-liquidity/src/lsps5/msgs.rs

@@ -18,6 +18,7 @@ use super::url_utils::LSPSUrl;
 
 use lightning::ln::msgs::DecodeError;
 use lightning::util::ser::{Readable, Writeable};
+use lightning::{impl_writeable_tlv_based, impl_writeable_tlv_based_enum};
 use lightning_types::string::UntrustedString;
 
 use serde::de::{self, Deserializer, MapAccess, Visitor};
@@ -522,6 +523,16 @@ pub enum WebhookNotificationMethod {
 	LSPS5OnionMessageIncoming,
 }
 
+impl_writeable_tlv_based_enum!(WebhookNotificationMethod,
+	(0, LSPS5WebhookRegistered) => {},
+	(2, LSPS5PaymentIncoming) => {},
+	(4, LSPS5ExpirySoon) => {
+		(0, timeout, required),
+	},
+	(6, LSPS5LiquidityManagementRequest) => {},
+	(8, LSPS5OnionMessageIncoming) => {},
+);
+
 /// Webhook notification payload.
 #[derive(Debug, Clone, PartialEq, Eq)]
 pub struct WebhookNotification {
@@ -672,6 +683,10 @@ impl<'de> Deserialize<'de> for WebhookNotification {
 	}
 }
 
+impl_writeable_tlv_based!(WebhookNotification, {
+	(0, method, required),
+});
+
 /// An LSPS5 protocol request.
 #[derive(Clone, Debug, PartialEq, Eq)]
 pub enum LSPS5Request {