X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=lightning%2Fsrc%2Fonion_message%2Foffers.rs;h=faf539f868261a97768e6051b22451861db737ca;hb=b9970ff41b497bce5cba13b2bb8023368e8ea2f8;hp=e335e8aa88be24242d6fa40fa3f557661dfce704;hpb=f8c9b092fdeab598431a0d05e4ccb914c2ca0a4f;p=rust-lightning diff --git a/lightning/src/onion_message/offers.rs b/lightning/src/onion_message/offers.rs index e335e8aa..faf539f8 100644 --- 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::ParseError; +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; + + /// 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> { 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)> { 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,20 +84,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) -> Result { + 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) -> Result { - 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(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 +141,12 @@ impl 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) },