X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=lightning%2Fsrc%2Fonion_message%2Foffers.rs;h=42c6914157e74f345ed0d2ad354834262653646a;hb=refs%2Fheads%2Fupstream%2Fmain;hp=9a1f59b84592eac465b718e8ee89c6037c24423e;hpb=8e2b70d91a0f7322042d1b0935527c90c59afe45;p=rust-lightning

diff --git a/lightning/src/onion_message/offers.rs b/lightning/src/onion_message/offers.rs
index 9a1f59b8..397f4b8a 100644
--- a/lightning/src/onion_message/offers.rs
+++ b/lightning/src/onion_message/offers.rs
@@ -9,15 +9,21 @@
 
 //! Message handling for BOLT 12 Offers.
 
-use core::convert::TryFrom;
+use core::fmt;
 use crate::io::{self, Read};
 use crate::ln::msgs::DecodeError;
 use crate::offers::invoice_error::InvoiceError;
 use crate::offers::invoice_request::InvoiceRequest;
 use crate::offers::invoice::Bolt12Invoice;
 use crate::offers::parse::Bolt12ParseError;
+#[cfg(async_payments)]
+use crate::offers::static_invoice::StaticInvoice;
+use crate::onion_message::packet::OnionMessageContents;
 use crate::util::logger::Logger;
 use crate::util::ser::{Readable, ReadableArgs, Writeable, Writer};
+use crate::onion_message::messenger::{ResponseInstruction, Responder};
+#[cfg(not(c_bindings))]
+use crate::onion_message::messenger::PendingOnionMessage;
 
 use crate::prelude::*;
 
@@ -25,6 +31,8 @@ use crate::prelude::*;
 const INVOICE_REQUEST_TLV_TYPE: u64 = 64;
 const INVOICE_TLV_TYPE: u64 = 66;
 const INVOICE_ERROR_TLV_TYPE: u64 = 68;
+#[cfg(async_payments)]
+const STATIC_INVOICE_TLV_TYPE: u64 = 70;
 
 /// A handler for an [`OnionMessage`] containing a BOLT 12 Offers message as its payload.
 ///
@@ -32,13 +40,31 @@ const INVOICE_ERROR_TLV_TYPE: u64 = 68;
 pub trait OffersMessageHandler {
 	/// Handles the given message by either responding with an [`Bolt12Invoice`], sending a payment,
 	/// or replying with an error.
-	fn handle_message(&self, message: OffersMessage) -> Option<OffersMessage>;
+	///
+	/// The returned [`OffersMessage`], if any, is enqueued to be sent by [`OnionMessenger`].
+	///
+	/// [`OnionMessenger`]: crate::onion_message::messenger::OnionMessenger
+	fn handle_message(&self, message: OffersMessage, responder: Option<Responder>) -> ResponseInstruction<OffersMessage>;
+
+	/// Releases any [`OffersMessage`]s that need to be sent.
+	///
+	/// Typically, this is used for messages initiating a payment flow rather than in response to
+	/// another message. The latter should use the return value of [`Self::handle_message`].
+	#[cfg(not(c_bindings))]
+	fn release_pending_messages(&self) -> Vec<PendingOnionMessage<OffersMessage>> { vec![] }
+
+	/// Releases any [`OffersMessage`]s that need to be sent.
+	///
+	/// Typically, this is used for messages initiating a payment flow rather than in response to
+	/// another message. The latter should use the return value of [`Self::handle_message`].
+	#[cfg(c_bindings)]
+	fn release_pending_messages(&self) -> Vec<(OffersMessage, crate::onion_message::messenger::Destination, Option<crate::blinded_path::BlindedPath>)> { vec![] }
 }
 
 /// Possible BOLT 12 Offers messages sent and received via an [`OnionMessage`].
 ///
 /// [`OnionMessage`]: crate::ln::msgs::OnionMessage
-#[derive(Debug)]
+#[derive(Clone)]
 pub enum OffersMessage {
 	/// A request for a [`Bolt12Invoice`] for a particular [`Offer`].
 	///
@@ -50,6 +76,10 @@ pub enum OffersMessage {
 	/// [`Refund`]: crate::offers::refund::Refund
 	Invoice(Bolt12Invoice),
 
+	#[cfg(async_payments)]
+	/// A [`StaticInvoice`] sent in response to an [`InvoiceRequest`].
+	StaticInvoice(StaticInvoice),
+
 	/// An error from handling an [`OffersMessage`].
 	InvoiceError(InvoiceError),
 }
@@ -58,25 +88,63 @@ impl OffersMessage {
 	/// Returns whether `tlv_type` corresponds to a TLV record for Offers.
 	pub fn is_known_type(tlv_type: u64) -> bool {
 		match tlv_type {
-			INVOICE_REQUEST_TLV_TYPE | INVOICE_TLV_TYPE | INVOICE_ERROR_TLV_TYPE => true,
+			INVOICE_REQUEST_TLV_TYPE
+			| INVOICE_TLV_TYPE
+			| INVOICE_ERROR_TLV_TYPE => true,
+			#[cfg(async_payments)]
+			STATIC_INVOICE_TLV_TYPE => true,
 			_ => false,
 		}
 	}
 
-	/// The TLV record type for the message as used in an `onionmsg_tlv` TLV stream.
-	pub fn tlv_type(&self) -> u64 {
+	fn parse(tlv_type: u64, bytes: Vec<u8>) -> Result<Self, Bolt12ParseError> {
+		match tlv_type {
+			INVOICE_REQUEST_TLV_TYPE => Ok(Self::InvoiceRequest(InvoiceRequest::try_from(bytes)?)),
+			INVOICE_TLV_TYPE => Ok(Self::Invoice(Bolt12Invoice::try_from(bytes)?)),
+			#[cfg(async_payments)]
+			STATIC_INVOICE_TLV_TYPE => Ok(Self::StaticInvoice(StaticInvoice::try_from(bytes)?)),
+			_ => Err(Bolt12ParseError::Decode(DecodeError::InvalidValue)),
+		}
+	}
+}
+
+impl fmt::Debug for OffersMessage {
+	fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+		match self {
+			OffersMessage::InvoiceRequest(message) => {
+				write!(f, "{:?}", message.as_tlv_stream())
+			}
+			OffersMessage::Invoice(message) => {
+				write!(f, "{:?}", message.as_tlv_stream())
+			}
+			#[cfg(async_payments)]
+			OffersMessage::StaticInvoice(message) => {
+				write!(f, "{:?}", message)
+			}
+			OffersMessage::InvoiceError(message) => {
+				write!(f, "{:?}", message)
+			}
+		}
+	}
+}
+
+impl OnionMessageContents for OffersMessage {
+	fn tlv_type(&self) -> u64 {
 		match self {
 			OffersMessage::InvoiceRequest(_) => INVOICE_REQUEST_TLV_TYPE,
 			OffersMessage::Invoice(_) => INVOICE_TLV_TYPE,
+			#[cfg(async_payments)]
+			OffersMessage::StaticInvoice(_) => STATIC_INVOICE_TLV_TYPE,
 			OffersMessage::InvoiceError(_) => INVOICE_ERROR_TLV_TYPE,
 		}
 	}
-
-	fn parse(tlv_type: u64, bytes: Vec<u8>) -> Result<Self, Bolt12ParseError> {
-		match tlv_type {
-			INVOICE_REQUEST_TLV_TYPE => Ok(Self::InvoiceRequest(InvoiceRequest::try_from(bytes)?)),
-			INVOICE_TLV_TYPE => Ok(Self::Invoice(Bolt12Invoice::try_from(bytes)?)),
-			_ => Err(Bolt12ParseError::Decode(DecodeError::InvalidValue)),
+	fn msg_type(&self) -> &'static str {
+		match &self {
+			OffersMessage::InvoiceRequest(_) => "Invoice Request",
+			OffersMessage::Invoice(_) => "Invoice",
+			#[cfg(async_payments)]
+			OffersMessage::StaticInvoice(_) => "Static Invoice",
+			OffersMessage::InvoiceError(_) => "Invoice Error",
 		}
 	}
 }
@@ -86,6 +154,8 @@ impl Writeable for OffersMessage {
 		match self {
 			OffersMessage::InvoiceRequest(message) => message.write(w),
 			OffersMessage::Invoice(message) => message.write(w),
+			#[cfg(async_payments)]
+			OffersMessage::StaticInvoice(message) => message.write(w),
 			OffersMessage::InvoiceError(message) => message.write(w),
 		}
 	}