Merge pull request #2660 from benthecarman/flexible-fee-rate

[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..254db7b81bdf12d89c3a1b739e4da7e06faa5d18 100644 (file)
--- a/lightning/src/onion_message/offers.rs
+++ b/lightning/src/onion_message/offers.rs
@@ -16,6 +16,8 @@ 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::OnionMessageContents;
+use crate::onion_message::messenger::PendingOnionMessage;
 use crate::util::logger::Logger;
 use crate::util::ser::{Readable, ReadableArgs, Writeable, Writer};
 
@@ -32,13 +34,23 @@ 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::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`].
+       fn release_pending_messages(&self) -> Vec<PendingOnionMessage<OffersMessage>> { vec![] }
 }
 
 /// Possible BOLT 12 Offers messages sent and received via an [`OnionMessage`].
 ///
 /// [`OnionMessage`]: crate::ln::msgs::OnionMessage
-#[derive(Debug)]
+#[derive(Clone, Debug)]
 pub enum OffersMessage {
        /// A request for a [`Bolt12Invoice`] for a particular [`Offer`].
        ///
@@ -63,15 +75,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 +84,16 @@ impl OffersMessage {
        }
 }
 
+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 {