_ Git - rust-lightning/blob - lightning/src/onion_message/offers.rs

   1 // This file is Copyright its original authors, visible in version control
   2 // history.
   3 //
   4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
   5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
   7 // You may not use this file except in accordance with one or both of these
   8 // licenses.
   9
  10 //! Message handling for BOLT 12 Offers.
  11
  12 use core::convert::TryFrom;
  13 use crate::io::{self, Read};
  14 use crate::ln::msgs::DecodeError;
  15 use crate::offers::invoice_error::InvoiceError;
  16 use crate::offers::invoice_request::InvoiceRequest;
  17 use crate::offers::invoice::Bolt12Invoice;
  18 use crate::offers::parse::Bolt12ParseError;
  19 use crate::onion_message::OnionMessageContents;
  20 use crate::onion_message::messenger::PendingOnionMessage;
  21 use crate::util::logger::Logger;
  22 use crate::util::ser::{Readable, ReadableArgs, Writeable, Writer};
  23
  24 use crate::prelude::*;
  25
  26 // TLV record types for the `onionmsg_tlv` TLV stream as defined in BOLT 4.
  27 const INVOICE_REQUEST_TLV_TYPE: u64 = 64;
  28 const INVOICE_TLV_TYPE: u64 = 66;
  29 const INVOICE_ERROR_TLV_TYPE: u64 = 68;
  30
  31 /// A handler for an [`OnionMessage`] containing a BOLT 12 Offers message as its payload.
  32 ///
  33 /// [`OnionMessage`]: crate::ln::msgs::OnionMessage
  34 pub trait OffersMessageHandler {
  35         /// Handles the given message by either responding with an [`Bolt12Invoice`], sending a payment,
  36         /// or replying with an error.
  37         ///
  38         /// The returned [`OffersMessage`], if any, is enqueued to be sent by [`OnionMessenger`].
  39         ///
  40         /// [`OnionMessenger`]: crate::onion_message::OnionMessenger
  41         fn handle_message(&self, message: OffersMessage) -> Option<OffersMessage>;
  42
  43         /// Releases any [`OffersMessage`]s that need to be sent.
  44         ///
  45         /// Typically, this is used for messages initiating a payment flow rather than in response to
  46         /// another message. The latter should use the return value of [`Self::handle_message`].
  47         fn release_pending_messages(&self) -> Vec<PendingOnionMessage<OffersMessage>> { vec![] }
  48 }
  49
  50 /// Possible BOLT 12 Offers messages sent and received via an [`OnionMessage`].
  51 ///
  52 /// [`OnionMessage`]: crate::ln::msgs::OnionMessage
  53 #[derive(Clone, Debug)]
  54 pub enum OffersMessage {
  55         /// A request for a [`Bolt12Invoice`] for a particular [`Offer`].
  56         ///
  57         /// [`Offer`]: crate::offers::offer::Offer
  58         InvoiceRequest(InvoiceRequest),
  59
  60         /// A [`Bolt12Invoice`] sent in response to an [`InvoiceRequest`] or a [`Refund`].
  61         ///
  62         /// [`Refund`]: crate::offers::refund::Refund
  63         Invoice(Bolt12Invoice),
  64
  65         /// An error from handling an [`OffersMessage`].
  66         InvoiceError(InvoiceError),
  67 }
  68
  69 impl OffersMessage {
  70         /// Returns whether `tlv_type` corresponds to a TLV record for Offers.
  71         pub fn is_known_type(tlv_type: u64) -> bool {
  72                 match tlv_type {
  73                         INVOICE_REQUEST_TLV_TYPE | INVOICE_TLV_TYPE | INVOICE_ERROR_TLV_TYPE => true,
  74                         _ => false,
  75                 }
  76         }
  77
  78         fn parse(tlv_type: u64, bytes: Vec<u8>) -> Result<Self, Bolt12ParseError> {
  79                 match tlv_type {
  80                         INVOICE_REQUEST_TLV_TYPE => Ok(Self::InvoiceRequest(InvoiceRequest::try_from(bytes)?)),
  81                         INVOICE_TLV_TYPE => Ok(Self::Invoice(Bolt12Invoice::try_from(bytes)?)),
  82                         _ => Err(Bolt12ParseError::Decode(DecodeError::InvalidValue)),
  83                 }
  84         }
  85 }
  86
  87 impl OnionMessageContents for OffersMessage {
  88         fn tlv_type(&self) -> u64 {
  89                 match self {
  90                         OffersMessage::InvoiceRequest(_) => INVOICE_REQUEST_TLV_TYPE,
  91                         OffersMessage::Invoice(_) => INVOICE_TLV_TYPE,
  92                         OffersMessage::InvoiceError(_) => INVOICE_ERROR_TLV_TYPE,
  93                 }
  94         }
  95 }
  96
  97 impl Writeable for OffersMessage {
  98         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
  99                 match self {
 100                         OffersMessage::InvoiceRequest(message) => message.write(w),
 101                         OffersMessage::Invoice(message) => message.write(w),
 102                         OffersMessage::InvoiceError(message) => message.write(w),
 103                 }
 104         }
 105 }
 106
 107 impl<L: Logger + ?Sized> ReadableArgs<(u64, &L)> for OffersMessage {
 108         fn read<R: Read>(r: &mut R, read_args: (u64, &L)) -> Result<Self, DecodeError> {
 109                 let (tlv_type, logger) = read_args;
 110                 if tlv_type == INVOICE_ERROR_TLV_TYPE {
 111                         return Ok(Self::InvoiceError(InvoiceError::read(r)?));
 112                 }
 113
 114                 let mut bytes = Vec::new();
 115                 r.read_to_end(&mut bytes).unwrap();
 116
 117                 match Self::parse(tlv_type, bytes) {
 118                         Ok(message) => Ok(message),
 119                         Err(Bolt12ParseError::Decode(e)) => Err(e),
 120                         Err(Bolt12ParseError::InvalidSemantics(e)) => {
 121                                 log_trace!(logger, "Invalid semantics for TLV type {}: {:?}", tlv_type, e);
 122                                 Err(DecodeError::InvalidValue)
 123                         },
 124                         Err(Bolt12ParseError::InvalidSignature(e)) => {
 125                                 log_trace!(logger, "Invalid signature for TLV type {}: {:?}", tlv_type, e);
 126                                 Err(DecodeError::InvalidValue)
 127                         },
 128                         Err(_) => Err(DecodeError::InvalidValue),
 129                 }
 130         }
 131 }