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 98276d1bfb74d1fb617a3b8c71892a0280d2593b..254db7b81bdf12d89c3a1b739e4da7e06faa5d18 100644 (file)
--- a/lightning/src/onion_message/offers.rs
+++ b/lightning/src/onion_message/offers.rs
@@ -14,8 +14,10 @@ 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::OnionMessageContents;
+use crate::onion_message::messenger::PendingOnionMessage;
 use crate::util::logger::Logger;
 use crate::util::ser::{Readable, ReadableArgs, Writeable, Writer};
 
@@ -30,25 +32,35 @@ 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.
-       fn handle_message(&self, message: OffersMessage);
+       /// 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 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,22 +75,23 @@ 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 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,
                }
        }
-
-       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 Writeable for OffersMessage {
@@ -103,12 +116,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)
                        },