Use `crate::prelude::*` rather than specific imports

[rust-lightning] / lightning / src / onion_message / offers.rs

diff --git a/lightning/src/onion_message/offers.rs b/lightning/src/onion_message/offers.rs
index 9a1f59b84592eac465b718e8ee89c6037c24423e..faf539f868261a97768e6051b22451861db737ca 100644 (file)
--- a/lightning/src/onion_message/offers.rs
+++ b/lightning/src/onion_message/offers.rs
@@ -9,15 +9,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::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::*;
 
@@ -32,13 +35,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.
+       ///
+       /// 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 a [`Bolt12Invoice`] for a particular [`Offer`].
        ///
@@ -63,15 +84,6 @@ impl OffersMessage {
                }
        }
 
-       /// The TLV record type for the message as used in an `onionmsg_tlv` TLV stream.
-       pub fn tlv_type(&self) -> u64 {
-               match self {
-                       OffersMessage::InvoiceRequest(_) => INVOICE_REQUEST_TLV_TYPE,
-                       OffersMessage::Invoice(_) => 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)?)),
@@ -81,6 +93,32 @@ impl OffersMessage {
        }
 }
 
+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())
+                       }
+                       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,
+                       OffersMessage::InvoiceError(_) => INVOICE_ERROR_TLV_TYPE,
+               }
+       }
+}
+
 impl Writeable for OffersMessage {
        fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
                match self {