WIP: Implement Display for Offer

Author: jkczyz

lightning/src/offers/mod.rs

@@ -31,7 +31,7 @@ use prelude::*;
 use std::time::SystemTime;
 
 ///
-#[derive(Debug)]
+#[derive(Clone, Debug)]
 pub struct Offer {
 	chains: Option<Vec<BlockHash>>,
 	amount: Option<Amount>,
@@ -113,11 +113,51 @@ impl Offer {
 	pub fn signature(&self) -> Option<&Signature> {
 		self.signature.as_ref()
 	}
+
+	fn to_tlv_stream(&self) -> OfferTlvStream {
+		let (currency, amount) = match self.amount.clone() {
+			None => (None, None),
+			Some(Amount::Bitcoin { amount_msats }) => (
+				None, Some(HighZeroBytesDroppedVarInt(amount_msats))
+			),
+			Some(Amount::Currency { iso4217_code, amount }) => (
+				Some(WithoutLength(iso4217_code)), Some(HighZeroBytesDroppedVarInt(amount))
+			),
+		};
+
+		let (paths, node_id) = match self.destination.clone() {
+			Destination::NodeId(node_id) => (None, Some(node_id)),
+			Destination::Paths(paths) => (Some(WithoutLength(paths)), None),
+		};
+
+		let (send_invoice, refund_for) = match self.send_invoice.clone() {
+			None => (None, None),
+			Some(SendInvoice { refund_for }) => (Some(()), refund_for),
+		};
+
+		OfferTlvStream {
+			chains: self.chains.clone().map(|chains| WithoutLength(chains)),
+			currency,
+			amount,
+			description: Some(WithoutLength(self.description.clone())),
+			features: self.features.clone(),
+			absolute_expiry: self.absolute_expiry.map(|d| HighZeroBytesDroppedVarInt(d.as_secs())),
+			paths,
+			issuer: self.issuer.clone().map(|issuer| WithoutLength(issuer)),
+			quantity_min: self.quantity_min.map(|quantity| HighZeroBytesDroppedVarInt(quantity)),
+			quantity_max: self.quantity_max.map(|quantity| HighZeroBytesDroppedVarInt(quantity)),
+			recurrence: self.recurrence.clone(),
+			node_id,
+			send_invoice,
+			refund_for,
+			signature: self.signature,
+		}
+	}
 }
 
 /// The amount required for an item in an [`Offer`] denominated in either bitcoin or another
 /// currency.
-#[derive(Debug)]
+#[derive(Clone, Debug)]
 pub enum Amount {
 	/// An amount of bitcoin.
 	Bitcoin {
@@ -136,7 +176,7 @@ pub enum Amount {
 const ISO4217_CODE_LEN: usize = 3;
 
 ///
-#[derive(Debug)]
+#[derive(Clone, Debug)]
 pub enum Destination {
 	///
 	NodeId(XOnlyPublicKey),
@@ -145,7 +185,7 @@ pub enum Destination {
 }
 
 ///
-#[derive(Debug)]
+#[derive(Clone, Debug)]
 pub struct SendInvoice {
 	refund_for: Option<PaymentHash>,
 }
@@ -189,7 +229,7 @@ impl_writeable_tlv_stream!(OfferTlvStream, {
 	(240, signature, option),
 });
 
-#[derive(Debug)]
+#[derive(Clone, Debug)]
 ///
 pub struct BlindedPath {
 	blinding: PublicKey,
@@ -198,7 +238,7 @@ pub struct BlindedPath {
 
 impl_writeable!(BlindedPath, { blinding, path });
 
-#[derive(Debug)]
+#[derive(Clone, Debug)]
 struct OnionMessagePath {
 	node_id: PublicKey,
 	encrypted_recipient_data: Vec<u8>,
@@ -207,7 +247,7 @@ struct OnionMessagePath {
 impl_writeable!(OnionMessagePath, { node_id, encrypted_recipient_data });
 
 // TODO: Remove once BOLT 12 test vectors are updated.
-#[derive(Debug)]
+#[derive(Clone, Debug)]
 struct Recurrence {
 	time_unit: u8,
 	period: HighZeroBytesDroppedVarInt<u32>,
@@ -398,6 +438,12 @@ impl FromStr for OfferTlvStream {
 	}
 }
 
+impl core::fmt::Display for Offer {
+	fn fmt(&self, f: &mut core::fmt::Formatter) -> Result<(), core::fmt::Error> {
+		self.to_tlv_stream().fmt(f)
+	}
+}
+
 impl core::fmt::Display for OfferTlvStream {
 	fn fmt(&self, f: &mut core::fmt::Formatter) -> Result<(), core::fmt::Error> {
 		use util::ser::Writeable;
@@ -421,9 +467,9 @@ mod tests {
 	#[test]
 	fn encodes_offer_as_bech32_without_checksum() {
 		let encoded_offer = "lno1qcp4256ypqpq86q2pucnq42ngssx2an9wfujqerp0y2pqun4wd68jtn00fkxzcnn9ehhyec6qgqsz83qfwdpl28qqmc78ymlvhmxcsywdk5wrjnj36jryg488qwlrnzyjczlqsp9nyu4phcg6dqhlhzgxagfu7zh3d9re0sqp9ts2yfugvnnm9gxkcnnnkdpa084a6t520h5zhkxsdnghvpukvd43lastpwuh73k29qsy";
-		let offer = dbg!(encoded_offer.parse::<OfferTlvStream>().unwrap());
+		let offer = dbg!(encoded_offer.parse::<Offer>().unwrap());
 		let reencoded_offer = offer.to_string();
-		dbg!(reencoded_offer.parse::<OfferTlvStream>().unwrap());
+		dbg!(reencoded_offer.parse::<Offer>().unwrap());
 		assert_eq!(reencoded_offer, encoded_offer);
 	}
 

lightning/src/util/ser.rs

@@ -393,7 +393,7 @@ impl Readable for BigSize {
 /// variable-length integer which is simply truncated by skipping high zero bytes. This type
 /// encapsulates such integers implementing Readable/Writeable for them.
 #[cfg_attr(test, derive(PartialEq))]
-#[derive(Debug)]
+#[derive(Clone, Debug)]
 pub(crate) struct HighZeroBytesDroppedVarInt<T>(pub T);
 
 macro_rules! impl_writeable_primitive {