X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=lightning%2Fsrc%2Fonion_message%2Foffers.rs;h=6672b5dfcdd0f3e33025c4bfe0654d6cfd2b0e56;hb=670b41ae4ec1b45fad97ed813a4296410839ecaf;hp=f82afdd618a5bfa78ac02a7e0bfd6476cac4bbdd;hpb=a358ba2e68c84d19e70d1d45d3f677eaf324e09d;p=rust-lightning

diff --git a/lightning/src/onion_message/offers.rs b/lightning/src/onion_message/offers.rs
index f82afdd6..6672b5df 100644
--- a/lightning/src/onion_message/offers.rs
+++ b/lightning/src/onion_message/offers.rs
@@ -10,14 +10,18 @@
 //! 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::Invoice;
-use crate::offers::parse::ParseError;
+use crate::offers::invoice::Bolt12Invoice;
+use crate::offers::parse::Bolt12ParseError;
+use crate::onion_message::packet::OnionMessageContents;
 use crate::util::logger::Logger;
 use crate::util::ser::{Readable, ReadableArgs, Writeable, Writer};
+#[cfg(not(c_bindings))]
+use crate::onion_message::messenger::PendingOnionMessage;
 
 use crate::prelude::*;
 
@@ -30,25 +34,43 @@ const INVOICE_ERROR_TLV_TYPE: u64 = 68;
 ///
 /// [`OnionMessage`]: crate::ln::msgs::OnionMessage
 pub trait OffersMessageHandler {
-	/// Handles the given message by either responding with an [`Invoice`], sending a payment, or
-	/// replying with an error.
+	/// Handles the given message by either responding with an [`Bolt12Invoice`], sending a payment,
+	/// or replying with an error.
+	///
+	/// The returned [`OffersMessage`], if any, is enqueued to be sent by [`OnionMessenger`].
+	///
+	/// [`OnionMessenger`]: crate::onion_message::messenger::OnionMessenger
 	fn handle_message(&self, message: OffersMessage) -> Option<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 an [`Invoice`] for a particular [`Offer`].
+	/// A request for a [`Bolt12Invoice`] for a particular [`Offer`].
 	///
 	/// [`Offer`]: crate::offers::offer::Offer
 	InvoiceRequest(InvoiceRequest),
 
-	/// An [`Invoice`] sent in response to an [`InvoiceRequest`] or a [`Refund`].
+	/// A [`Bolt12Invoice`] sent in response to an [`InvoiceRequest`] or a [`Refund`].
 	///
 	/// [`Refund`]: crate::offers::refund::Refund
-	Invoice(Invoice),
+	Invoice(Bolt12Invoice),
 
 	/// An error from handling an [`OffersMessage`].
 	InvoiceError(InvoiceError),
@@ -63,20 +85,37 @@ impl OffersMessage {
 		}
 	}
 
-	/// 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)?)),
+			_ => Err(Bolt12ParseError::Decode(DecodeError::InvalidValue)),
+		}
+	}
+}
+
+impl fmt::Debug for OffersMessage {
+	fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 		match self {
-			OffersMessage::InvoiceRequest(_) => INVOICE_REQUEST_TLV_TYPE,
-			OffersMessage::Invoice(_) => INVOICE_TLV_TYPE,
-			OffersMessage::InvoiceError(_) => INVOICE_ERROR_TLV_TYPE,
+			OffersMessage::InvoiceRequest(message) => {
+				write!(f, "{:?}", message.as_tlv_stream())
+			}
+			OffersMessage::Invoice(message) => {
+				write!(f, "{:?}", message.as_tlv_stream())
+			}
+			OffersMessage::InvoiceError(message) => {
+				write!(f, "{:?}", message)
+			}
 		}
 	}
+}
 
-	fn parse(tlv_type: u64, bytes: Vec<u8>) -> Result<Self, ParseError> {
-		match tlv_type {
-			INVOICE_REQUEST_TLV_TYPE => Ok(Self::InvoiceRequest(InvoiceRequest::try_from(bytes)?)),
-			INVOICE_TLV_TYPE => Ok(Self::Invoice(Invoice::try_from(bytes)?)),
-			_ => Err(ParseError::Decode(DecodeError::InvalidValue)),
+impl OnionMessageContents for OffersMessage {
+	fn tlv_type(&self) -> u64 {
+		match self {
+			OffersMessage::InvoiceRequest(_) => INVOICE_REQUEST_TLV_TYPE,
+			OffersMessage::Invoice(_) => INVOICE_TLV_TYPE,
+			OffersMessage::InvoiceError(_) => INVOICE_ERROR_TLV_TYPE,
 		}
 	}
 }
@@ -103,12 +142,12 @@ impl<L: Logger + ?Sized> ReadableArgs<(u64, &L)> for OffersMessage {
 
 		match Self::parse(tlv_type, bytes) {
 			Ok(message) => Ok(message),
-			Err(ParseError::Decode(e)) => Err(e),
-			Err(ParseError::InvalidSemantics(e)) => {
+			Err(Bolt12ParseError::Decode(e)) => Err(e),
+			Err(Bolt12ParseError::InvalidSemantics(e)) => {
 				log_trace!(logger, "Invalid semantics for TLV type {}: {:?}", tlv_type, e);
 				Err(DecodeError::InvalidValue)
 			},
-			Err(ParseError::InvalidSignature(e)) => {
+			Err(Bolt12ParseError::InvalidSignature(e)) => {
 				log_trace!(logger, "Invalid signature for TLV type {}: {:?}", tlv_type, e);
 				Err(DecodeError::InvalidValue)
 			},