_ Git - rust-lightning/blob - lightning/src/offers/offer.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 //! Data structures and encoding for `offer` messages.
  11 //!
  12 //! An [`Offer`] represents an "offer to be paid." It is typically constructed by a merchant and
  13 //! published as a QR code to be scanned by a customer. The customer uses the offer to request an
  14 //! invoice from the merchant to be paid.
  15 //!
  16 //! # Example
  17 //!
  18 //! ```
  19 //! extern crate bitcoin;
  20 //! extern crate core;
  21 //! extern crate lightning;
  22 //!
  23 //! use core::convert::TryFrom;
  24 //! use core::num::NonZeroU64;
  25 //! use core::time::Duration;
  26 //!
  27 //! use bitcoin::secp256k1::{Keypair, PublicKey, Secp256k1, SecretKey};
  28 //! use lightning::offers::offer::{Offer, OfferBuilder, Quantity};
  29 //! use lightning::offers::parse::Bolt12ParseError;
  30 //! use lightning::util::ser::{Readable, Writeable};
  31 //!
  32 //! # use lightning::blinded_path::BlindedPath;
  33 //! # #[cfg(feature = "std")]
  34 //! # use std::time::SystemTime;
  35 //! #
  36 //! # fn create_blinded_path() -> BlindedPath { unimplemented!() }
  37 //! # fn create_another_blinded_path() -> BlindedPath { unimplemented!() }
  38 //! #
  39 //! # #[cfg(feature = "std")]
  40 //! # fn build() -> Result<(), Bolt12ParseError> {
  41 //! let secp_ctx = Secp256k1::new();
  42 //! let keys = Keypair::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
  43 //! let pubkey = PublicKey::from(keys);
  44 //!
  45 //! let expiration = SystemTime::now() + Duration::from_secs(24 * 60 * 60);
  46 //! let offer = OfferBuilder::new(pubkey)
  47 //!     .description("coffee, large".to_string())
  48 //!     .amount_msats(20_000)
  49 //!     .supported_quantity(Quantity::Unbounded)
  50 //!     .absolute_expiry(expiration.duration_since(SystemTime::UNIX_EPOCH).unwrap())
  51 //!     .issuer("Foo Bar".to_string())
  52 //!     .path(create_blinded_path())
  53 //!     .path(create_another_blinded_path())
  54 //!     .build()?;
  55 //!
  56 //! // Encode as a bech32 string for use in a QR code.
  57 //! let encoded_offer = offer.to_string();
  58 //!
  59 //! // Parse from a bech32 string after scanning from a QR code.
  60 //! let offer = encoded_offer.parse::<Offer>()?;
  61 //!
  62 //! // Encode offer as raw bytes.
  63 //! let mut bytes = Vec::new();
  64 //! offer.write(&mut bytes).unwrap();
  65 //!
  66 //! // Decode raw bytes into an offer.
  67 //! let offer = Offer::try_from(bytes)?;
  68 //! # Ok(())
  69 //! # }
  70 //! ```
  71 //!
  72 //! # Note
  73 //!
  74 //! If constructing an [`Offer`] for use with a [`ChannelManager`], use
  75 //! [`ChannelManager::create_offer_builder`] instead of [`OfferBuilder::new`].
  76 //!
  77 //! [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
  78 //! [`ChannelManager::create_offer_builder`]: crate::ln::channelmanager::ChannelManager::create_offer_builder
  79
  80 use bitcoin::blockdata::constants::ChainHash;
  81 use bitcoin::network::Network;
  82 use bitcoin::secp256k1::{Keypair, PublicKey, Secp256k1, self};
  83 use core::hash::{Hash, Hasher};
  84 use core::num::NonZeroU64;
  85 use core::ops::Deref;
  86 use core::str::FromStr;
  87 use core::time::Duration;
  88 use crate::sign::EntropySource;
  89 use crate::io;
  90 use crate::blinded_path::BlindedPath;
  91 use crate::ln::channelmanager::PaymentId;
  92 use crate::ln::features::OfferFeatures;
  93 use crate::ln::inbound_payment::{ExpandedKey, IV_LEN, Nonce};
  94 use crate::ln::msgs::{DecodeError, MAX_VALUE_MSAT};
  95 use crate::offers::merkle::{TaggedHash, TlvStream};
  96 use crate::offers::parse::{Bech32Encode, Bolt12ParseError, Bolt12SemanticError, ParsedMessage};
  97 use crate::offers::signer::{Metadata, MetadataMaterial, self};
  98 use crate::util::ser::{HighZeroBytesDroppedBigSize, Readable, WithoutLength, Writeable, Writer};
  99 use crate::util::string::PrintableString;
 100
 101 #[cfg(not(c_bindings))]
 102 use {
 103         crate::offers::invoice_request::{DerivedPayerId, ExplicitPayerId, InvoiceRequestBuilder},
 104 };
 105 #[cfg(c_bindings)]
 106 use {
 107         crate::offers::invoice_request::{InvoiceRequestWithDerivedPayerIdBuilder, InvoiceRequestWithExplicitPayerIdBuilder},
 108 };
 109
 110 #[allow(unused_imports)]
 111 use crate::prelude::*;
 112
 113 #[cfg(feature = "std")]
 114 use std::time::SystemTime;
 115
 116 pub(super) const IV_BYTES: &[u8; IV_LEN] = b"LDK Offer ~~~~~~";
 117
 118 /// An identifier for an [`Offer`] built using [`DerivedMetadata`].
 119 #[derive(Clone, Copy, Debug, Eq, PartialEq)]
 120 pub struct OfferId(pub [u8; 32]);
 121
 122 impl OfferId {
 123         const ID_TAG: &'static str = "LDK Offer ID";
 124
 125         fn from_valid_offer_tlv_stream(bytes: &[u8]) -> Self {
 126                 let tagged_hash = TaggedHash::from_valid_tlv_stream_bytes(Self::ID_TAG, bytes);
 127                 Self(tagged_hash.to_bytes())
 128         }
 129
 130         fn from_valid_invreq_tlv_stream(bytes: &[u8]) -> Self {
 131                 let tlv_stream = TlvStream::new(bytes).range(OFFER_TYPES);
 132                 let tagged_hash = TaggedHash::from_tlv_stream(Self::ID_TAG, tlv_stream);
 133                 Self(tagged_hash.to_bytes())
 134         }
 135 }
 136
 137 impl Writeable for OfferId {
 138         fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
 139                 self.0.write(w)
 140         }
 141 }
 142
 143 impl Readable for OfferId {
 144         fn read<R: io::Read>(r: &mut R) -> Result<Self, DecodeError> {
 145                 Ok(OfferId(Readable::read(r)?))
 146         }
 147 }
 148
 149 /// Builds an [`Offer`] for the "offer to be paid" flow.
 150 ///
 151 /// See [module-level documentation] for usage.
 152 ///
 153 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
 154 ///
 155 /// [module-level documentation]: self
 156 pub struct OfferBuilder<'a, M: MetadataStrategy, T: secp256k1::Signing> {
 157         offer: OfferContents,
 158         metadata_strategy: core::marker::PhantomData<M>,
 159         secp_ctx: Option<&'a Secp256k1<T>>,
 160 }
 161
 162 /// Builds an [`Offer`] for the "offer to be paid" flow.
 163 ///
 164 /// See [module-level documentation] for usage.
 165 ///
 166 /// [module-level documentation]: self
 167 #[cfg(c_bindings)]
 168 #[derive(Clone)]
 169 pub struct OfferWithExplicitMetadataBuilder<'a> {
 170         offer: OfferContents,
 171         metadata_strategy: core::marker::PhantomData<ExplicitMetadata>,
 172         secp_ctx: Option<&'a Secp256k1<secp256k1::All>>,
 173 }
 174
 175 /// Builds an [`Offer`] for the "offer to be paid" flow.
 176 ///
 177 /// See [module-level documentation] for usage.
 178 ///
 179 /// [module-level documentation]: self
 180 #[cfg(c_bindings)]
 181 #[derive(Clone)]
 182 pub struct OfferWithDerivedMetadataBuilder<'a> {
 183         offer: OfferContents,
 184         metadata_strategy: core::marker::PhantomData<DerivedMetadata>,
 185         secp_ctx: Option<&'a Secp256k1<secp256k1::All>>,
 186 }
 187
 188 /// Indicates how [`Offer::metadata`] may be set.
 189 ///
 190 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
 191 pub trait MetadataStrategy {}
 192
 193 /// [`Offer::metadata`] may be explicitly set or left empty.
 194 ///
 195 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
 196 pub struct ExplicitMetadata {}
 197
 198 /// [`Offer::metadata`] will be derived.
 199 ///
 200 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
 201 pub struct DerivedMetadata {}
 202
 203 impl MetadataStrategy for ExplicitMetadata {}
 204
 205 impl MetadataStrategy for DerivedMetadata {}
 206
 207 macro_rules! offer_explicit_metadata_builder_methods { (
 208         $self: ident, $self_type: ty, $return_type: ty, $return_value: expr
 209 ) => {
 210         /// Creates a new builder for an offer using the [`Offer::signing_pubkey`] for signing invoices.
 211         /// The associated secret key must be remembered while the offer is valid.
 212         ///
 213         /// Use a different pubkey per offer to avoid correlating offers.
 214         ///
 215         /// # Note
 216         ///
 217         /// If constructing an [`Offer`] for use with a [`ChannelManager`], use
 218         /// [`ChannelManager::create_offer_builder`] instead of [`OfferBuilder::new`].
 219         ///
 220         /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
 221         /// [`ChannelManager::create_offer_builder`]: crate::ln::channelmanager::ChannelManager::create_offer_builder
 222         pub fn new(signing_pubkey: PublicKey) -> Self {
 223                 Self {
 224                         offer: OfferContents {
 225                                 chains: None, metadata: None, amount: None, description: None,
 226                                 features: OfferFeatures::empty(), absolute_expiry: None, issuer: None, paths: None,
 227                                 supported_quantity: Quantity::One, signing_pubkey: Some(signing_pubkey),
 228                         },
 229                         metadata_strategy: core::marker::PhantomData,
 230                         secp_ctx: None,
 231                 }
 232         }
 233
 234         /// Sets the [`Offer::metadata`] to the given bytes.
 235         ///
 236         /// Successive calls to this method will override the previous setting.
 237         pub fn metadata(mut $self: $self_type, metadata: Vec<u8>) -> Result<$return_type, Bolt12SemanticError> {
 238                 $self.offer.metadata = Some(Metadata::Bytes(metadata));
 239                 Ok($return_value)
 240         }
 241 } }
 242
 243 macro_rules! offer_derived_metadata_builder_methods { ($secp_context: ty) => {
 244         /// Similar to [`OfferBuilder::new`] except, if [`OfferBuilder::path`] is called, the signing
 245         /// pubkey is derived from the given [`ExpandedKey`] and [`EntropySource`]. This provides
 246         /// recipient privacy by using a different signing pubkey for each offer. Otherwise, the
 247         /// provided `node_id` is used for the signing pubkey.
 248         ///
 249         /// Also, sets the metadata when [`OfferBuilder::build`] is called such that it can be used by
 250         /// [`InvoiceRequest::verify`] to determine if the request was produced for the offer given an
 251         /// [`ExpandedKey`].
 252         ///
 253         /// [`InvoiceRequest::verify`]: crate::offers::invoice_request::InvoiceRequest::verify
 254         /// [`ExpandedKey`]: crate::ln::inbound_payment::ExpandedKey
 255         pub fn deriving_signing_pubkey<ES: Deref>(
 256                 node_id: PublicKey, expanded_key: &ExpandedKey, entropy_source: ES,
 257                 secp_ctx: &'a Secp256k1<$secp_context>
 258         ) -> Self where ES::Target: EntropySource {
 259                 let nonce = Nonce::from_entropy_source(entropy_source);
 260                 let derivation_material = MetadataMaterial::new(nonce, expanded_key, IV_BYTES, None);
 261                 let metadata = Metadata::DerivedSigningPubkey(derivation_material);
 262                 Self {
 263                         offer: OfferContents {
 264                                 chains: None, metadata: Some(metadata), amount: None, description: None,
 265                                 features: OfferFeatures::empty(), absolute_expiry: None, issuer: None, paths: None,
 266                                 supported_quantity: Quantity::One, signing_pubkey: Some(node_id),
 267                         },
 268                         metadata_strategy: core::marker::PhantomData,
 269                         secp_ctx: Some(secp_ctx),
 270                 }
 271         }
 272 } }
 273
 274 macro_rules! offer_builder_methods { (
 275         $self: ident, $self_type: ty, $return_type: ty, $return_value: expr $(, $self_mut: tt)?
 276 ) => {
 277         /// Adds the chain hash of the given [`Network`] to [`Offer::chains`]. If not called,
 278         /// the chain hash of [`Network::Bitcoin`] is assumed to be the only one supported.
 279         ///
 280         /// See [`Offer::chains`] on how this relates to the payment currency.
 281         ///
 282         /// Successive calls to this method will add another chain hash.
 283         pub fn chain($self: $self_type, network: Network) -> $return_type {
 284                 $self.chain_hash(ChainHash::using_genesis_block(network))
 285         }
 286
 287         /// Adds the [`ChainHash`] to [`Offer::chains`]. If not called, the chain hash of
 288         /// [`Network::Bitcoin`] is assumed to be the only one supported.
 289         ///
 290         /// See [`Offer::chains`] on how this relates to the payment currency.
 291         ///
 292         /// Successive calls to this method will add another chain hash.
 293         pub(crate) fn chain_hash($($self_mut)* $self: $self_type, chain: ChainHash) -> $return_type {
 294                 let chains = $self.offer.chains.get_or_insert_with(Vec::new);
 295                 if !chains.contains(&chain) {
 296                         chains.push(chain);
 297                 }
 298
 299                 $return_value
 300         }
 301
 302         /// Sets the [`Offer::amount`] as an [`Amount::Bitcoin`].
 303         ///
 304         /// Successive calls to this method will override the previous setting.
 305         pub fn amount_msats($self: $self_type, amount_msats: u64) -> $return_type {
 306                 $self.amount(Amount::Bitcoin { amount_msats })
 307         }
 308
 309         /// Sets the [`Offer::amount`].
 310         ///
 311         /// Successive calls to this method will override the previous setting.
 312         pub(super) fn amount($($self_mut)* $self: $self_type, amount: Amount) -> $return_type {
 313                 $self.offer.amount = Some(amount);
 314                 $return_value
 315         }
 316
 317         /// Sets the [`Offer::absolute_expiry`] as seconds since the Unix epoch. Any expiry that has
 318         /// already passed is valid and can be checked for using [`Offer::is_expired`].
 319         ///
 320         /// Successive calls to this method will override the previous setting.
 321         pub fn absolute_expiry($($self_mut)* $self: $self_type, absolute_expiry: Duration) -> $return_type {
 322                 $self.offer.absolute_expiry = Some(absolute_expiry);
 323                 $return_value
 324         }
 325
 326         /// Sets the [`Offer::description`].
 327         ///
 328         /// Successive calls to this method will override the previous setting.
 329         pub fn description($($self_mut)* $self: $self_type, description: String) -> $return_type {
 330                 $self.offer.description = Some(description);
 331                 $return_value
 332         }
 333
 334         /// Sets the [`Offer::issuer`].
 335         ///
 336         /// Successive calls to this method will override the previous setting.
 337         pub fn issuer($($self_mut)* $self: $self_type, issuer: String) -> $return_type {
 338                 $self.offer.issuer = Some(issuer);
 339                 $return_value
 340         }
 341
 342         /// Adds a blinded path to [`Offer::paths`]. Must include at least one path if only connected by
 343         /// private channels or if [`Offer::signing_pubkey`] is not a public node id.
 344         ///
 345         /// Successive calls to this method will add another blinded path. Caller is responsible for not
 346         /// adding duplicate paths.
 347         pub fn path($($self_mut)* $self: $self_type, path: BlindedPath) -> $return_type {
 348                 $self.offer.paths.get_or_insert_with(Vec::new).push(path);
 349                 $return_value
 350         }
 351
 352         /// Sets the quantity of items for [`Offer::supported_quantity`]. If not called, defaults to
 353         /// [`Quantity::One`].
 354         ///
 355         /// Successive calls to this method will override the previous setting.
 356         pub fn supported_quantity($($self_mut)* $self: $self_type, quantity: Quantity) -> $return_type {
 357                 $self.offer.supported_quantity = quantity;
 358                 $return_value
 359         }
 360
 361         /// Builds an [`Offer`] from the builder's settings.
 362         pub fn build($($self_mut)* $self: $self_type) -> Result<Offer, Bolt12SemanticError> {
 363                 match $self.offer.amount {
 364                         Some(Amount::Bitcoin { amount_msats }) => {
 365                                 if amount_msats > MAX_VALUE_MSAT {
 366                                         return Err(Bolt12SemanticError::InvalidAmount);
 367                                 }
 368                         },
 369                         Some(Amount::Currency { .. }) => return Err(Bolt12SemanticError::UnsupportedCurrency),
 370                         None => {},
 371                 }
 372
 373                 if $self.offer.amount.is_some() && $self.offer.description.is_none() {
 374                         $self.offer.description = Some(String::new());
 375                 }
 376
 377                 if let Some(chains) = &$self.offer.chains {
 378                         if chains.len() == 1 && chains[0] == $self.offer.implied_chain() {
 379                                 $self.offer.chains = None;
 380                         }
 381                 }
 382
 383                 Ok($self.build_without_checks())
 384         }
 385
 386         fn build_without_checks($($self_mut)* $self: $self_type) -> Offer {
 387                 // Create the metadata for stateless verification of an InvoiceRequest.
 388                 if let Some(mut metadata) = $self.offer.metadata.take() {
 389                         if metadata.has_derivation_material() {
 390                                 if $self.offer.paths.is_none() {
 391                                         metadata = metadata.without_keys();
 392                                 }
 393
 394                                 let mut tlv_stream = $self.offer.as_tlv_stream();
 395                                 debug_assert_eq!(tlv_stream.metadata, None);
 396                                 tlv_stream.metadata = None;
 397                                 if metadata.derives_recipient_keys() {
 398                                         tlv_stream.node_id = None;
 399                                 }
 400
 401                                 let (derived_metadata, keys) = metadata.derive_from(tlv_stream, $self.secp_ctx);
 402                                 metadata = derived_metadata;
 403                                 if let Some(keys) = keys {
 404                                         $self.offer.signing_pubkey = Some(keys.public_key());
 405                                 }
 406                         }
 407
 408                         $self.offer.metadata = Some(metadata);
 409                 }
 410
 411                 let mut bytes = Vec::new();
 412                 $self.offer.write(&mut bytes).unwrap();
 413
 414                 let id = OfferId::from_valid_offer_tlv_stream(&bytes);
 415
 416                 Offer {
 417                         bytes,
 418                         #[cfg(not(c_bindings))]
 419                         contents: $self.offer,
 420                         #[cfg(c_bindings)]
 421                         contents: $self.offer.clone(),
 422                         id,
 423                 }
 424         }
 425 } }
 426
 427 #[cfg(test)]
 428 macro_rules! offer_builder_test_methods { (
 429         $self: ident, $self_type: ty, $return_type: ty, $return_value: expr $(, $self_mut: tt)?
 430 ) => {
 431         #[cfg_attr(c_bindings, allow(dead_code))]
 432         fn features_unchecked($($self_mut)* $self: $self_type, features: OfferFeatures) -> $return_type {
 433                 $self.offer.features = features;
 434                 $return_value
 435         }
 436
 437         #[cfg_attr(c_bindings, allow(dead_code))]
 438         pub(crate) fn clear_chains($($self_mut)* $self: $self_type) -> $return_type {
 439                 $self.offer.chains = None;
 440                 $return_value
 441         }
 442
 443         #[cfg_attr(c_bindings, allow(dead_code))]
 444         pub(crate) fn clear_paths($($self_mut)* $self: $self_type) -> $return_type {
 445                 $self.offer.paths = None;
 446                 $return_value
 447         }
 448
 449         #[cfg_attr(c_bindings, allow(dead_code))]
 450         pub(crate) fn clear_signing_pubkey($($self_mut)* $self: $self_type) -> $return_type {
 451                 $self.offer.signing_pubkey = None;
 452                 $return_value
 453         }
 454
 455         #[cfg_attr(c_bindings, allow(dead_code))]
 456         pub(super) fn build_unchecked($self: $self_type) -> Offer {
 457                 $self.build_without_checks()
 458         }
 459 } }
 460
 461 impl<'a, M: MetadataStrategy, T: secp256k1::Signing> OfferBuilder<'a, M, T> {
 462         offer_builder_methods!(self, Self, Self, self, mut);
 463
 464         #[cfg(test)]
 465         offer_builder_test_methods!(self, Self, Self, self, mut);
 466 }
 467
 468 impl<'a> OfferBuilder<'a, ExplicitMetadata, secp256k1::SignOnly> {
 469         offer_explicit_metadata_builder_methods!(self, Self, Self, self);
 470 }
 471
 472 impl<'a, T: secp256k1::Signing> OfferBuilder<'a, DerivedMetadata, T> {
 473         offer_derived_metadata_builder_methods!(T);
 474 }
 475
 476 #[cfg(all(c_bindings, not(test)))]
 477 impl<'a> OfferWithExplicitMetadataBuilder<'a> {
 478         offer_explicit_metadata_builder_methods!(self, &mut Self, (), ());
 479         offer_builder_methods!(self, &mut Self, (), ());
 480 }
 481
 482 #[cfg(all(c_bindings, test))]
 483 impl<'a> OfferWithExplicitMetadataBuilder<'a> {
 484         offer_explicit_metadata_builder_methods!(self, &mut Self, &mut Self, self);
 485         offer_builder_methods!(self, &mut Self, &mut Self, self);
 486         offer_builder_test_methods!(self, &mut Self, &mut Self, self);
 487 }
 488
 489 #[cfg(all(c_bindings, not(test)))]
 490 impl<'a> OfferWithDerivedMetadataBuilder<'a> {
 491         offer_derived_metadata_builder_methods!(secp256k1::All);
 492         offer_builder_methods!(self, &mut Self, (), ());
 493 }
 494
 495 #[cfg(all(c_bindings, test))]
 496 impl<'a> OfferWithDerivedMetadataBuilder<'a> {
 497         offer_derived_metadata_builder_methods!(secp256k1::All);
 498         offer_builder_methods!(self, &mut Self, &mut Self, self);
 499         offer_builder_test_methods!(self, &mut Self, &mut Self, self);
 500 }
 501
 502 #[cfg(c_bindings)]
 503 impl<'a> From<OfferBuilder<'a, DerivedMetadata, secp256k1::All>>
 504 for OfferWithDerivedMetadataBuilder<'a> {
 505         fn from(builder: OfferBuilder<'a, DerivedMetadata, secp256k1::All>) -> Self {
 506                 let OfferBuilder { offer, metadata_strategy, secp_ctx } = builder;
 507
 508                 Self { offer, metadata_strategy, secp_ctx }
 509         }
 510 }
 511
 512 #[cfg(c_bindings)]
 513 impl<'a> From<OfferWithDerivedMetadataBuilder<'a>>
 514 for OfferBuilder<'a, DerivedMetadata, secp256k1::All> {
 515         fn from(builder: OfferWithDerivedMetadataBuilder<'a>) -> Self {
 516                 let OfferWithDerivedMetadataBuilder { offer, metadata_strategy, secp_ctx } = builder;
 517
 518                 Self { offer, metadata_strategy, secp_ctx }
 519         }
 520 }
 521
 522 /// An `Offer` is a potentially long-lived proposal for payment of a good or service.
 523 ///
 524 /// An offer is a precursor to an [`InvoiceRequest`]. A merchant publishes an offer from which a
 525 /// customer may request an [`Bolt12Invoice`] for a specific quantity and using an amount sufficient
 526 /// to cover that quantity (i.e., at least `quantity * amount`). See [`Offer::amount`].
 527 ///
 528 /// Offers may be denominated in currency other than bitcoin but are ultimately paid using the
 529 /// latter.
 530 ///
 531 /// Through the use of [`BlindedPath`]s, offers provide recipient privacy.
 532 ///
 533 /// [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
 534 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
 535 #[derive(Clone, Debug)]
 536 pub struct Offer {
 537         // The serialized offer. Needed when creating an `InvoiceRequest` if the offer contains unknown
 538         // fields.
 539         pub(super) bytes: Vec<u8>,
 540         pub(super) contents: OfferContents,
 541         id: OfferId,
 542 }
 543
 544 /// The contents of an [`Offer`], which may be shared with an [`InvoiceRequest`] or a
 545 /// [`Bolt12Invoice`].
 546 ///
 547 /// [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
 548 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
 549 #[derive(Clone, Debug)]
 550 #[cfg_attr(test, derive(PartialEq))]
 551 pub(super) struct OfferContents {
 552         chains: Option<Vec<ChainHash>>,
 553         metadata: Option<Metadata>,
 554         amount: Option<Amount>,
 555         description: Option<String>,
 556         features: OfferFeatures,
 557         absolute_expiry: Option<Duration>,
 558         issuer: Option<String>,
 559         paths: Option<Vec<BlindedPath>>,
 560         supported_quantity: Quantity,
 561         signing_pubkey: Option<PublicKey>,
 562 }
 563
 564 macro_rules! offer_accessors { ($self: ident, $contents: expr) => {
 565         // TODO: Return a slice once ChainHash has constants.
 566         // - https://github.com/rust-bitcoin/rust-bitcoin/pull/1283
 567         // - https://github.com/rust-bitcoin/rust-bitcoin/pull/1286
 568         /// The chains that may be used when paying a requested invoice (e.g., bitcoin mainnet).
 569         /// Payments must be denominated in units of the minimal lightning-payable unit (e.g., msats)
 570         /// for the selected chain.
 571         pub fn chains(&$self) -> Vec<bitcoin::blockdata::constants::ChainHash> {
 572                 $contents.chains()
 573         }
 574
 575         // TODO: Link to corresponding method in `InvoiceRequest`.
 576         /// Opaque bytes set by the originator. Useful for authentication and validating fields since it
 577         /// is reflected in `invoice_request` messages along with all the other fields from the `offer`.
 578         pub fn metadata(&$self) -> Option<&Vec<u8>> {
 579                 $contents.metadata()
 580         }
 581
 582         /// The minimum amount required for a successful payment of a single item.
 583         pub fn amount(&$self) -> Option<$crate::offers::offer::Amount> {
 584                 $contents.amount()
 585         }
 586
 587         /// A complete description of the purpose of the payment. Intended to be displayed to the user
 588         /// but with the caveat that it has not been verified in any way.
 589         pub fn description(&$self) -> Option<$crate::util::string::PrintableString> {
 590                 $contents.description()
 591         }
 592
 593         /// Features pertaining to the offer.
 594         pub fn offer_features(&$self) -> &$crate::ln::features::OfferFeatures {
 595                 &$contents.features()
 596         }
 597
 598         /// Duration since the Unix epoch when an invoice should no longer be requested.
 599         ///
 600         /// If `None`, the offer does not expire.
 601         pub fn absolute_expiry(&$self) -> Option<core::time::Duration> {
 602                 $contents.absolute_expiry()
 603         }
 604
 605         /// The issuer of the offer, possibly beginning with `user@domain` or `domain`. Intended to be
 606         /// displayed to the user but with the caveat that it has not been verified in any way.
 607         pub fn issuer(&$self) -> Option<$crate::util::string::PrintableString> {
 608                 $contents.issuer()
 609         }
 610
 611         /// Paths to the recipient originating from publicly reachable nodes. Blinded paths provide
 612         /// recipient privacy by obfuscating its node id.
 613         pub fn paths(&$self) -> &[$crate::blinded_path::BlindedPath] {
 614                 $contents.paths()
 615         }
 616
 617         /// The quantity of items supported.
 618         pub fn supported_quantity(&$self) -> $crate::offers::offer::Quantity {
 619                 $contents.supported_quantity()
 620         }
 621
 622         /// The public key used by the recipient to sign invoices.
 623         pub fn signing_pubkey(&$self) -> Option<bitcoin::secp256k1::PublicKey> {
 624                 $contents.signing_pubkey()
 625         }
 626 } }
 627
 628 impl Offer {
 629         offer_accessors!(self, self.contents);
 630
 631         /// Returns the id of the offer.
 632         pub fn id(&self) -> OfferId {
 633                 self.id
 634         }
 635
 636         pub(super) fn implied_chain(&self) -> ChainHash {
 637                 self.contents.implied_chain()
 638         }
 639
 640         /// Returns whether the given chain is supported by the offer.
 641         pub fn supports_chain(&self, chain: ChainHash) -> bool {
 642                 self.contents.supports_chain(chain)
 643         }
 644
 645         /// Whether the offer has expired.
 646         #[cfg(feature = "std")]
 647         pub fn is_expired(&self) -> bool {
 648                 self.contents.is_expired()
 649         }
 650
 651         /// Whether the offer has expired given the duration since the Unix epoch.
 652         pub fn is_expired_no_std(&self, duration_since_epoch: Duration) -> bool {
 653                 self.contents.is_expired_no_std(duration_since_epoch)
 654         }
 655
 656         /// Returns whether the given quantity is valid for the offer.
 657         pub fn is_valid_quantity(&self, quantity: u64) -> bool {
 658                 self.contents.is_valid_quantity(quantity)
 659         }
 660
 661         /// Returns whether a quantity is expected in an [`InvoiceRequest`] for the offer.
 662         ///
 663         /// [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
 664         pub fn expects_quantity(&self) -> bool {
 665                 self.contents.expects_quantity()
 666         }
 667
 668         pub(super) fn verify<T: secp256k1::Signing>(
 669                 &self, key: &ExpandedKey, secp_ctx: &Secp256k1<T>
 670         ) -> Result<(OfferId, Option<Keypair>), ()> {
 671                 self.contents.verify(&self.bytes, key, secp_ctx)
 672         }
 673 }
 674
 675 macro_rules! request_invoice_derived_payer_id { ($self: ident, $builder: ty) => {
 676         /// Similar to [`Offer::request_invoice`] except it:
 677         /// - derives the [`InvoiceRequest::payer_id`] such that a different key can be used for each
 678         ///   request,
 679         /// - sets [`InvoiceRequest::payer_metadata`] when [`InvoiceRequestBuilder::build`] is called
 680         ///   such that it can be used by [`Bolt12Invoice::verify`] to determine if the invoice was
 681         ///   requested using a base [`ExpandedKey`] from which the payer id was derived, and
 682         /// - includes the [`PaymentId`] encrypted in [`InvoiceRequest::payer_metadata`] so that it can
 683         ///   be used when sending the payment for the requested invoice.
 684         ///
 685         /// Useful to protect the sender's privacy.
 686         ///
 687         /// [`InvoiceRequest::payer_id`]: crate::offers::invoice_request::InvoiceRequest::payer_id
 688         /// [`InvoiceRequest::payer_metadata`]: crate::offers::invoice_request::InvoiceRequest::payer_metadata
 689         /// [`Bolt12Invoice::verify`]: crate::offers::invoice::Bolt12Invoice::verify
 690         /// [`ExpandedKey`]: crate::ln::inbound_payment::ExpandedKey
 691         pub fn request_invoice_deriving_payer_id<
 692                 'a, 'b, ES: Deref,
 693                 #[cfg(not(c_bindings))]
 694                 T: secp256k1::Signing
 695         >(
 696                 &'a $self, expanded_key: &ExpandedKey, entropy_source: ES,
 697                 #[cfg(not(c_bindings))]
 698                 secp_ctx: &'b Secp256k1<T>,
 699                 #[cfg(c_bindings)]
 700                 secp_ctx: &'b Secp256k1<secp256k1::All>,
 701                 payment_id: PaymentId
 702         ) -> Result<$builder, Bolt12SemanticError>
 703         where
 704                 ES::Target: EntropySource,
 705         {
 706                 if $self.offer_features().requires_unknown_bits() {
 707                         return Err(Bolt12SemanticError::UnknownRequiredFeatures);
 708                 }
 709
 710                 Ok(<$builder>::deriving_payer_id($self, expanded_key, entropy_source, secp_ctx, payment_id))
 711         }
 712 } }
 713
 714 macro_rules! request_invoice_explicit_payer_id { ($self: ident, $builder: ty) => {
 715         /// Similar to [`Offer::request_invoice_deriving_payer_id`] except uses `payer_id` for the
 716         /// [`InvoiceRequest::payer_id`] instead of deriving a different key for each request.
 717         ///
 718         /// Useful for recurring payments using the same `payer_id` with different invoices.
 719         ///
 720         /// [`InvoiceRequest::payer_id`]: crate::offers::invoice_request::InvoiceRequest::payer_id
 721         pub fn request_invoice_deriving_metadata<ES: Deref>(
 722                 &$self, payer_id: PublicKey, expanded_key: &ExpandedKey, entropy_source: ES,
 723                 payment_id: PaymentId
 724         ) -> Result<$builder, Bolt12SemanticError>
 725         where
 726                 ES::Target: EntropySource,
 727         {
 728                 if $self.offer_features().requires_unknown_bits() {
 729                         return Err(Bolt12SemanticError::UnknownRequiredFeatures);
 730                 }
 731
 732                 Ok(<$builder>::deriving_metadata($self, payer_id, expanded_key, entropy_source, payment_id))
 733         }
 734
 735         /// Creates an [`InvoiceRequestBuilder`] for the offer with the given `metadata` and `payer_id`,
 736         /// which will be reflected in the `Bolt12Invoice` response.
 737         ///
 738         /// The `metadata` is useful for including information about the derivation of `payer_id` such
 739         /// that invoice response handling can be stateless. Also serves as payer-provided entropy while
 740         /// hashing in the signature calculation.
 741         ///
 742         /// This should not leak any information such as by using a simple BIP-32 derivation path.
 743         /// Otherwise, payments may be correlated.
 744         ///
 745         /// Errors if the offer contains unknown required features.
 746         ///
 747         /// [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
 748         pub fn request_invoice(
 749                 &$self, metadata: Vec<u8>, payer_id: PublicKey
 750         ) -> Result<$builder, Bolt12SemanticError> {
 751                 if $self.offer_features().requires_unknown_bits() {
 752                         return Err(Bolt12SemanticError::UnknownRequiredFeatures);
 753                 }
 754
 755                 Ok(<$builder>::new($self, metadata, payer_id))
 756         }
 757 } }
 758
 759 #[cfg(not(c_bindings))]
 760 impl Offer {
 761         request_invoice_derived_payer_id!(self, InvoiceRequestBuilder<'a, 'b, DerivedPayerId, T>);
 762         request_invoice_explicit_payer_id!(self, InvoiceRequestBuilder<ExplicitPayerId, secp256k1::SignOnly>);
 763 }
 764
 765 #[cfg(c_bindings)]
 766 impl Offer {
 767         request_invoice_derived_payer_id!(self, InvoiceRequestWithDerivedPayerIdBuilder<'a, 'b>);
 768         request_invoice_explicit_payer_id!(self, InvoiceRequestWithExplicitPayerIdBuilder);
 769 }
 770
 771 #[cfg(test)]
 772 impl Offer {
 773         pub(super) fn as_tlv_stream(&self) -> OfferTlvStreamRef {
 774                 self.contents.as_tlv_stream()
 775         }
 776 }
 777
 778 impl AsRef<[u8]> for Offer {
 779         fn as_ref(&self) -> &[u8] {
 780                 &self.bytes
 781         }
 782 }
 783
 784 impl PartialEq for Offer {
 785         fn eq(&self, other: &Self) -> bool {
 786                 self.bytes.eq(&other.bytes)
 787         }
 788 }
 789
 790 impl Eq for Offer {}
 791
 792 impl Hash for Offer {
 793         fn hash<H: Hasher>(&self, state: &mut H) {
 794                 self.bytes.hash(state);
 795         }
 796 }
 797
 798 impl OfferContents {
 799         pub fn chains(&self) -> Vec<ChainHash> {
 800                 self.chains.as_ref().cloned().unwrap_or_else(|| vec![self.implied_chain()])
 801         }
 802
 803         pub fn implied_chain(&self) -> ChainHash {
 804                 ChainHash::using_genesis_block(Network::Bitcoin)
 805         }
 806
 807         pub fn supports_chain(&self, chain: ChainHash) -> bool {
 808                 self.chains().contains(&chain)
 809         }
 810
 811         pub fn metadata(&self) -> Option<&Vec<u8>> {
 812                 self.metadata.as_ref().and_then(|metadata| metadata.as_bytes())
 813         }
 814
 815         pub fn amount(&self) -> Option<Amount> {
 816                 self.amount
 817         }
 818
 819         pub fn description(&self) -> Option<PrintableString> {
 820                 self.description.as_ref().map(|description| PrintableString(description))
 821         }
 822
 823         pub fn features(&self) -> &OfferFeatures {
 824                 &self.features
 825         }
 826
 827         pub fn absolute_expiry(&self) -> Option<Duration> {
 828                 self.absolute_expiry
 829         }
 830
 831         #[cfg(feature = "std")]
 832         pub(super) fn is_expired(&self) -> bool {
 833                 SystemTime::UNIX_EPOCH
 834                         .elapsed()
 835                         .map(|duration_since_epoch| self.is_expired_no_std(duration_since_epoch))
 836                         .unwrap_or(false)
 837         }
 838
 839         pub(super) fn is_expired_no_std(&self, duration_since_epoch: Duration) -> bool {
 840                 self.absolute_expiry
 841                         .map(|absolute_expiry| duration_since_epoch > absolute_expiry)
 842                         .unwrap_or(false)
 843         }
 844
 845         pub fn issuer(&self) -> Option<PrintableString> {
 846                 self.issuer.as_ref().map(|issuer| PrintableString(issuer.as_str()))
 847         }
 848
 849         pub fn paths(&self) -> &[BlindedPath] {
 850                 self.paths.as_ref().map(|paths| paths.as_slice()).unwrap_or(&[])
 851         }
 852
 853         pub(super) fn check_amount_msats_for_quantity(
 854                 &self, amount_msats: Option<u64>, quantity: Option<u64>
 855         ) -> Result<(), Bolt12SemanticError> {
 856                 let offer_amount_msats = match self.amount {
 857                         None => 0,
 858                         Some(Amount::Bitcoin { amount_msats }) => amount_msats,
 859                         Some(Amount::Currency { .. }) => return Err(Bolt12SemanticError::UnsupportedCurrency),
 860                 };
 861
 862                 if !self.expects_quantity() || quantity.is_some() {
 863                         let expected_amount_msats = offer_amount_msats.checked_mul(quantity.unwrap_or(1))
 864                                 .ok_or(Bolt12SemanticError::InvalidAmount)?;
 865                         let amount_msats = amount_msats.unwrap_or(expected_amount_msats);
 866
 867                         if amount_msats < expected_amount_msats {
 868                                 return Err(Bolt12SemanticError::InsufficientAmount);
 869                         }
 870
 871                         if amount_msats > MAX_VALUE_MSAT {
 872                                 return Err(Bolt12SemanticError::InvalidAmount);
 873                         }
 874                 }
 875
 876                 Ok(())
 877         }
 878
 879         pub fn supported_quantity(&self) -> Quantity {
 880                 self.supported_quantity
 881         }
 882
 883         pub(super) fn check_quantity(&self, quantity: Option<u64>) -> Result<(), Bolt12SemanticError> {
 884                 let expects_quantity = self.expects_quantity();
 885                 match quantity {
 886                         None if expects_quantity => Err(Bolt12SemanticError::MissingQuantity),
 887                         Some(_) if !expects_quantity => Err(Bolt12SemanticError::UnexpectedQuantity),
 888                         Some(quantity) if !self.is_valid_quantity(quantity) => {
 889                                 Err(Bolt12SemanticError::InvalidQuantity)
 890                         },
 891                         _ => Ok(()),
 892                 }
 893         }
 894
 895         fn is_valid_quantity(&self, quantity: u64) -> bool {
 896                 match self.supported_quantity {
 897                         Quantity::Bounded(n) => quantity <= n.get(),
 898                         Quantity::Unbounded => quantity > 0,
 899                         Quantity::One => quantity == 1,
 900                 }
 901         }
 902
 903         fn expects_quantity(&self) -> bool {
 904                 match self.supported_quantity {
 905                         Quantity::Bounded(_) => true,
 906                         Quantity::Unbounded => true,
 907                         Quantity::One => false,
 908                 }
 909         }
 910
 911         pub(super) fn signing_pubkey(&self) -> Option<PublicKey> {
 912                 self.signing_pubkey
 913         }
 914
 915         /// Verifies that the offer metadata was produced from the offer in the TLV stream.
 916         pub(super) fn verify<T: secp256k1::Signing>(
 917                 &self, bytes: &[u8], key: &ExpandedKey, secp_ctx: &Secp256k1<T>
 918         ) -> Result<(OfferId, Option<Keypair>), ()> {
 919                 match self.metadata() {
 920                         Some(metadata) => {
 921                                 let tlv_stream = TlvStream::new(bytes).range(OFFER_TYPES).filter(|record| {
 922                                         match record.r#type {
 923                                                 OFFER_METADATA_TYPE => false,
 924                                                 OFFER_NODE_ID_TYPE => {
 925                                                         !self.metadata.as_ref().unwrap().derives_recipient_keys()
 926                                                 },
 927                                                 _ => true,
 928                                         }
 929                                 });
 930                                 let signing_pubkey = match self.signing_pubkey() {
 931                                         Some(signing_pubkey) => signing_pubkey,
 932                                         None => return Err(()),
 933                                 };
 934                                 let keys = signer::verify_recipient_metadata(
 935                                         metadata, key, IV_BYTES, signing_pubkey, tlv_stream, secp_ctx
 936                                 )?;
 937
 938                                 let offer_id = OfferId::from_valid_invreq_tlv_stream(bytes);
 939
 940                                 Ok((offer_id, keys))
 941                         },
 942                         None => Err(()),
 943                 }
 944         }
 945
 946         pub(super) fn as_tlv_stream(&self) -> OfferTlvStreamRef {
 947                 let (currency, amount) = match &self.amount {
 948                         None => (None, None),
 949                         Some(Amount::Bitcoin { amount_msats }) => (None, Some(*amount_msats)),
 950                         Some(Amount::Currency { iso4217_code, amount }) => (
 951                                 Some(iso4217_code), Some(*amount)
 952                         ),
 953                 };
 954
 955                 let features = {
 956                         if self.features == OfferFeatures::empty() { None } else { Some(&self.features) }
 957                 };
 958
 959                 OfferTlvStreamRef {
 960                         chains: self.chains.as_ref(),
 961                         metadata: self.metadata(),
 962                         currency,
 963                         amount,
 964                         description: self.description.as_ref(),
 965                         features,
 966                         absolute_expiry: self.absolute_expiry.map(|duration| duration.as_secs()),
 967                         paths: self.paths.as_ref(),
 968                         issuer: self.issuer.as_ref(),
 969                         quantity_max: self.supported_quantity.to_tlv_record(),
 970                         node_id: self.signing_pubkey.as_ref(),
 971                 }
 972         }
 973 }
 974
 975 impl Readable for Offer {
 976         fn read<R: io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
 977                 let bytes: WithoutLength<Vec<u8>> = Readable::read(reader)?;
 978                 Self::try_from(bytes.0).map_err(|_| DecodeError::InvalidValue)
 979         }
 980 }
 981
 982 impl Writeable for Offer {
 983         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
 984                 WithoutLength(&self.bytes).write(writer)
 985         }
 986 }
 987
 988 impl Writeable for OfferContents {
 989         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
 990                 self.as_tlv_stream().write(writer)
 991         }
 992 }
 993
 994 /// The minimum amount required for an item in an [`Offer`], denominated in either bitcoin or
 995 /// another currency.
 996 #[derive(Clone, Copy, Debug, PartialEq)]
 997 pub enum Amount {
 998         /// An amount of bitcoin.
 999         Bitcoin {
1000                 /// The amount in millisatoshi.
1001                 amount_msats: u64,
1002         },
1003         /// An amount of currency specified using ISO 4712.
1004         Currency {
1005                 /// The currency that the amount is denominated in.
1006                 iso4217_code: CurrencyCode,
1007                 /// The amount in the currency unit adjusted by the ISO 4712 exponent (e.g., USD cents).
1008                 amount: u64,
1009         },
1010 }
1011
1012 /// An ISO 4712 three-letter currency code (e.g., USD).
1013 pub type CurrencyCode = [u8; 3];
1014
1015 /// Quantity of items supported by an [`Offer`].
1016 #[derive(Clone, Copy, Debug, PartialEq)]
1017 pub enum Quantity {
1018         /// Up to a specific number of items (inclusive). Use when more than one item can be requested
1019         /// but is limited (e.g., because of per customer or inventory limits).
1020         ///
1021         /// May be used with `NonZeroU64::new(1)` but prefer to use [`Quantity::One`] if only one item
1022         /// is supported.
1023         Bounded(NonZeroU64),
1024         /// One or more items. Use when more than one item can be requested without any limit.
1025         Unbounded,
1026         /// Only one item. Use when only a single item can be requested.
1027         One,
1028 }
1029
1030 impl Quantity {
1031         fn to_tlv_record(&self) -> Option<u64> {
1032                 match self {
1033                         Quantity::Bounded(n) => Some(n.get()),
1034                         Quantity::Unbounded => Some(0),
1035                         Quantity::One => None,
1036                 }
1037         }
1038 }
1039
1040 /// Valid type range for offer TLV records.
1041 pub(super) const OFFER_TYPES: core::ops::Range<u64> = 1..80;
1042
1043 /// TLV record type for [`Offer::metadata`].
1044 const OFFER_METADATA_TYPE: u64 = 4;
1045
1046 /// TLV record type for [`Offer::signing_pubkey`].
1047 const OFFER_NODE_ID_TYPE: u64 = 22;
1048
1049 tlv_stream!(OfferTlvStream, OfferTlvStreamRef, OFFER_TYPES, {
1050         (2, chains: (Vec<ChainHash>, WithoutLength)),
1051         (OFFER_METADATA_TYPE, metadata: (Vec<u8>, WithoutLength)),
1052         (6, currency: CurrencyCode),
1053         (8, amount: (u64, HighZeroBytesDroppedBigSize)),
1054         (10, description: (String, WithoutLength)),
1055         (12, features: (OfferFeatures, WithoutLength)),
1056         (14, absolute_expiry: (u64, HighZeroBytesDroppedBigSize)),
1057         (16, paths: (Vec<BlindedPath>, WithoutLength)),
1058         (18, issuer: (String, WithoutLength)),
1059         (20, quantity_max: (u64, HighZeroBytesDroppedBigSize)),
1060         (OFFER_NODE_ID_TYPE, node_id: PublicKey),
1061 });
1062
1063 impl Bech32Encode for Offer {
1064         const BECH32_HRP: &'static str = "lno";
1065 }
1066
1067 impl FromStr for Offer {
1068         type Err = Bolt12ParseError;
1069
1070         fn from_str(s: &str) -> Result<Self, <Self as FromStr>::Err> {
1071                 Self::from_bech32_str(s)
1072         }
1073 }
1074
1075 impl TryFrom<Vec<u8>> for Offer {
1076         type Error = Bolt12ParseError;
1077
1078         fn try_from(bytes: Vec<u8>) -> Result<Self, Self::Error> {
1079                 let offer = ParsedMessage::<OfferTlvStream>::try_from(bytes)?;
1080                 let ParsedMessage { bytes, tlv_stream } = offer;
1081                 let contents = OfferContents::try_from(tlv_stream)?;
1082                 let id = OfferId::from_valid_offer_tlv_stream(&bytes);
1083
1084                 Ok(Offer { bytes, contents, id })
1085         }
1086 }
1087
1088 impl TryFrom<OfferTlvStream> for OfferContents {
1089         type Error = Bolt12SemanticError;
1090
1091         fn try_from(tlv_stream: OfferTlvStream) -> Result<Self, Self::Error> {
1092                 let OfferTlvStream {
1093                         chains, metadata, currency, amount, description, features, absolute_expiry, paths,
1094                         issuer, quantity_max, node_id,
1095                 } = tlv_stream;
1096
1097                 let metadata = metadata.map(|metadata| Metadata::Bytes(metadata));
1098
1099                 let amount = match (currency, amount) {
1100                         (None, None) => None,
1101                         (None, Some(amount_msats)) if amount_msats > MAX_VALUE_MSAT => {
1102                                 return Err(Bolt12SemanticError::InvalidAmount);
1103                         },
1104                         (None, Some(amount_msats)) => Some(Amount::Bitcoin { amount_msats }),
1105                         (Some(_), None) => return Err(Bolt12SemanticError::MissingAmount),
1106                         (Some(iso4217_code), Some(amount)) => Some(Amount::Currency { iso4217_code, amount }),
1107                 };
1108
1109                 if amount.is_some() && description.is_none() {
1110                         return Err(Bolt12SemanticError::MissingDescription);
1111                 }
1112
1113                 let features = features.unwrap_or_else(OfferFeatures::empty);
1114
1115                 let absolute_expiry = absolute_expiry
1116                         .map(|seconds_from_epoch| Duration::from_secs(seconds_from_epoch));
1117
1118                 let supported_quantity = match quantity_max {
1119                         None => Quantity::One,
1120                         Some(0) => Quantity::Unbounded,
1121                         Some(n) => Quantity::Bounded(NonZeroU64::new(n).unwrap()),
1122                 };
1123
1124                 let (signing_pubkey, paths) = match (node_id, paths) {
1125                         (None, None) => return Err(Bolt12SemanticError::MissingSigningPubkey),
1126                         (_, Some(paths)) if paths.is_empty() => return Err(Bolt12SemanticError::MissingPaths),
1127                         (node_id, paths) => (node_id, paths),
1128                 };
1129
1130                 Ok(OfferContents {
1131                         chains, metadata, amount, description, features, absolute_expiry, issuer, paths,
1132                         supported_quantity, signing_pubkey,
1133                 })
1134         }
1135 }
1136
1137 impl core::fmt::Display for Offer {
1138         fn fmt(&self, f: &mut core::fmt::Formatter) -> Result<(), core::fmt::Error> {
1139                 self.fmt_bech32_str(f)
1140         }
1141 }
1142
1143 #[cfg(test)]
1144 mod tests {
1145         use super::{Amount, Offer, OfferTlvStreamRef, Quantity};
1146         #[cfg(not(c_bindings))]
1147         use {
1148                 super::OfferBuilder,
1149         };
1150         #[cfg(c_bindings)]
1151         use {
1152                 super::OfferWithExplicitMetadataBuilder as OfferBuilder,
1153         };
1154
1155         use bitcoin::blockdata::constants::ChainHash;
1156         use bitcoin::network::Network;
1157         use bitcoin::secp256k1::Secp256k1;
1158         use core::num::NonZeroU64;
1159         use core::time::Duration;
1160         use crate::blinded_path::{BlindedHop, BlindedPath, IntroductionNode};
1161         use crate::sign::KeyMaterial;
1162         use crate::ln::features::OfferFeatures;
1163         use crate::ln::inbound_payment::ExpandedKey;
1164         use crate::ln::msgs::{DecodeError, MAX_VALUE_MSAT};
1165         use crate::offers::parse::{Bolt12ParseError, Bolt12SemanticError};
1166         use crate::offers::test_utils::*;
1167         use crate::util::ser::{BigSize, Writeable};
1168         use crate::util::string::PrintableString;
1169
1170         #[test]
1171         fn builds_offer_with_defaults() {
1172                 let offer = OfferBuilder::new(pubkey(42)).build().unwrap();
1173
1174                 let mut buffer = Vec::new();
1175                 offer.write(&mut buffer).unwrap();
1176
1177                 assert_eq!(offer.bytes, buffer.as_slice());
1178                 assert_eq!(offer.chains(), vec![ChainHash::using_genesis_block(Network::Bitcoin)]);
1179                 assert!(offer.supports_chain(ChainHash::using_genesis_block(Network::Bitcoin)));
1180                 assert_eq!(offer.metadata(), None);
1181                 assert_eq!(offer.amount(), None);
1182                 assert_eq!(offer.description(), None);
1183                 assert_eq!(offer.offer_features(), &OfferFeatures::empty());
1184                 assert_eq!(offer.absolute_expiry(), None);
1185                 #[cfg(feature = "std")]
1186                 assert!(!offer.is_expired());
1187                 assert_eq!(offer.paths(), &[]);
1188                 assert_eq!(offer.issuer(), None);
1189                 assert_eq!(offer.supported_quantity(), Quantity::One);
1190                 assert!(!offer.expects_quantity());
1191                 assert_eq!(offer.signing_pubkey(), Some(pubkey(42)));
1192
1193                 assert_eq!(
1194                         offer.as_tlv_stream(),
1195                         OfferTlvStreamRef {
1196                                 chains: None,
1197                                 metadata: None,
1198                                 currency: None,
1199                                 amount: None,
1200                                 description: None,
1201                                 features: None,
1202                                 absolute_expiry: None,
1203                                 paths: None,
1204                                 issuer: None,
1205                                 quantity_max: None,
1206                                 node_id: Some(&pubkey(42)),
1207                         },
1208                 );
1209
1210                 if let Err(e) = Offer::try_from(buffer) {
1211                         panic!("error parsing offer: {:?}", e);
1212                 }
1213         }
1214
1215         #[test]
1216         fn builds_offer_with_chains() {
1217                 let mainnet = ChainHash::using_genesis_block(Network::Bitcoin);
1218                 let testnet = ChainHash::using_genesis_block(Network::Testnet);
1219
1220                 let offer = OfferBuilder::new(pubkey(42))
1221                         .chain(Network::Bitcoin)
1222                         .build()
1223                         .unwrap();
1224                 assert!(offer.supports_chain(mainnet));
1225                 assert_eq!(offer.chains(), vec![mainnet]);
1226                 assert_eq!(offer.as_tlv_stream().chains, None);
1227
1228                 let offer = OfferBuilder::new(pubkey(42))
1229                         .chain(Network::Testnet)
1230                         .build()
1231                         .unwrap();
1232                 assert!(offer.supports_chain(testnet));
1233                 assert_eq!(offer.chains(), vec![testnet]);
1234                 assert_eq!(offer.as_tlv_stream().chains, Some(&vec![testnet]));
1235
1236                 let offer = OfferBuilder::new(pubkey(42))
1237                         .chain(Network::Testnet)
1238                         .chain(Network::Testnet)
1239                         .build()
1240                         .unwrap();
1241                 assert!(offer.supports_chain(testnet));
1242                 assert_eq!(offer.chains(), vec![testnet]);
1243                 assert_eq!(offer.as_tlv_stream().chains, Some(&vec![testnet]));
1244
1245                 let offer = OfferBuilder::new(pubkey(42))
1246                         .chain(Network::Bitcoin)
1247                         .chain(Network::Testnet)
1248                         .build()
1249                         .unwrap();
1250                 assert!(offer.supports_chain(mainnet));
1251                 assert!(offer.supports_chain(testnet));
1252                 assert_eq!(offer.chains(), vec![mainnet, testnet]);
1253                 assert_eq!(offer.as_tlv_stream().chains, Some(&vec![mainnet, testnet]));
1254         }
1255
1256         #[test]
1257         fn builds_offer_with_metadata() {
1258                 let offer = OfferBuilder::new(pubkey(42))
1259                         .metadata(vec![42; 32]).unwrap()
1260                         .build()
1261                         .unwrap();
1262                 assert_eq!(offer.metadata(), Some(&vec![42; 32]));
1263                 assert_eq!(offer.as_tlv_stream().metadata, Some(&vec![42; 32]));
1264
1265                 let offer = OfferBuilder::new(pubkey(42))
1266                         .metadata(vec![42; 32]).unwrap()
1267                         .metadata(vec![43; 32]).unwrap()
1268                         .build()
1269                         .unwrap();
1270                 assert_eq!(offer.metadata(), Some(&vec![43; 32]));
1271                 assert_eq!(offer.as_tlv_stream().metadata, Some(&vec![43; 32]));
1272         }
1273
1274         #[test]
1275         fn builds_offer_with_metadata_derived() {
1276                 let node_id = recipient_pubkey();
1277                 let expanded_key = ExpandedKey::new(&KeyMaterial([42; 32]));
1278                 let entropy = FixedEntropy {};
1279                 let secp_ctx = Secp256k1::new();
1280
1281                 #[cfg(c_bindings)]
1282                 use super::OfferWithDerivedMetadataBuilder as OfferBuilder;
1283                 let offer = OfferBuilder
1284                         ::deriving_signing_pubkey(node_id, &expanded_key, &entropy, &secp_ctx)
1285                         .amount_msats(1000)
1286                         .build().unwrap();
1287                 assert_eq!(offer.signing_pubkey(), Some(node_id));
1288
1289                 let invoice_request = offer.request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1290                         .build().unwrap()
1291                         .sign(payer_sign).unwrap();
1292                 match invoice_request.verify(&expanded_key, &secp_ctx) {
1293                         Ok(invoice_request) => assert_eq!(invoice_request.offer_id, offer.id()),
1294                         Err(_) => panic!("unexpected error"),
1295                 }
1296
1297                 // Fails verification with altered offer field
1298                 let mut tlv_stream = offer.as_tlv_stream();
1299                 tlv_stream.amount = Some(100);
1300
1301                 let mut encoded_offer = Vec::new();
1302                 tlv_stream.write(&mut encoded_offer).unwrap();
1303
1304                 let invoice_request = Offer::try_from(encoded_offer).unwrap()
1305                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1306                         .build().unwrap()
1307                         .sign(payer_sign).unwrap();
1308                 assert!(invoice_request.verify(&expanded_key, &secp_ctx).is_err());
1309
1310                 // Fails verification with altered metadata
1311                 let mut tlv_stream = offer.as_tlv_stream();
1312                 let metadata = tlv_stream.metadata.unwrap().iter().copied().rev().collect();
1313                 tlv_stream.metadata = Some(&metadata);
1314
1315                 let mut encoded_offer = Vec::new();
1316                 tlv_stream.write(&mut encoded_offer).unwrap();
1317
1318                 let invoice_request = Offer::try_from(encoded_offer).unwrap()
1319                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1320                         .build().unwrap()
1321                         .sign(payer_sign).unwrap();
1322                 assert!(invoice_request.verify(&expanded_key, &secp_ctx).is_err());
1323         }
1324
1325         #[test]
1326         fn builds_offer_with_derived_signing_pubkey() {
1327                 let node_id = recipient_pubkey();
1328                 let expanded_key = ExpandedKey::new(&KeyMaterial([42; 32]));
1329                 let entropy = FixedEntropy {};
1330                 let secp_ctx = Secp256k1::new();
1331
1332                 let blinded_path = BlindedPath {
1333                         introduction_node: IntroductionNode::NodeId(pubkey(40)),
1334                         blinding_point: pubkey(41),
1335                         blinded_hops: vec![
1336                                 BlindedHop { blinded_node_id: pubkey(42), encrypted_payload: vec![0; 43] },
1337                                 BlindedHop { blinded_node_id: node_id, encrypted_payload: vec![0; 44] },
1338                         ],
1339                 };
1340
1341                 #[cfg(c_bindings)]
1342                 use super::OfferWithDerivedMetadataBuilder as OfferBuilder;
1343                 let offer = OfferBuilder
1344                         ::deriving_signing_pubkey(node_id, &expanded_key, &entropy, &secp_ctx)
1345                         .amount_msats(1000)
1346                         .path(blinded_path)
1347                         .build().unwrap();
1348                 assert_ne!(offer.signing_pubkey(), Some(node_id));
1349
1350                 let invoice_request = offer.request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1351                         .build().unwrap()
1352                         .sign(payer_sign).unwrap();
1353                 match invoice_request.verify(&expanded_key, &secp_ctx) {
1354                         Ok(invoice_request) => assert_eq!(invoice_request.offer_id, offer.id()),
1355                         Err(_) => panic!("unexpected error"),
1356                 }
1357
1358                 // Fails verification with altered offer field
1359                 let mut tlv_stream = offer.as_tlv_stream();
1360                 tlv_stream.amount = Some(100);
1361
1362                 let mut encoded_offer = Vec::new();
1363                 tlv_stream.write(&mut encoded_offer).unwrap();
1364
1365                 let invoice_request = Offer::try_from(encoded_offer).unwrap()
1366                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1367                         .build().unwrap()
1368                         .sign(payer_sign).unwrap();
1369                 assert!(invoice_request.verify(&expanded_key, &secp_ctx).is_err());
1370
1371                 // Fails verification with altered signing pubkey
1372                 let mut tlv_stream = offer.as_tlv_stream();
1373                 let signing_pubkey = pubkey(1);
1374                 tlv_stream.node_id = Some(&signing_pubkey);
1375
1376                 let mut encoded_offer = Vec::new();
1377                 tlv_stream.write(&mut encoded_offer).unwrap();
1378
1379                 let invoice_request = Offer::try_from(encoded_offer).unwrap()
1380                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1381                         .build().unwrap()
1382                         .sign(payer_sign).unwrap();
1383                 assert!(invoice_request.verify(&expanded_key, &secp_ctx).is_err());
1384         }
1385
1386         #[test]
1387         fn builds_offer_with_amount() {
1388                 let bitcoin_amount = Amount::Bitcoin { amount_msats: 1000 };
1389                 let currency_amount = Amount::Currency { iso4217_code: *b"USD", amount: 10 };
1390
1391                 let offer = OfferBuilder::new(pubkey(42))
1392                         .amount_msats(1000)
1393                         .build()
1394                         .unwrap();
1395                 let tlv_stream = offer.as_tlv_stream();
1396                 assert_eq!(offer.amount(), Some(bitcoin_amount));
1397                 assert_eq!(tlv_stream.amount, Some(1000));
1398                 assert_eq!(tlv_stream.currency, None);
1399
1400                 #[cfg(not(c_bindings))]
1401                 let builder = OfferBuilder::new(pubkey(42))
1402                         .amount(currency_amount.clone());
1403                 #[cfg(c_bindings)]
1404                 let mut builder = OfferBuilder::new(pubkey(42));
1405                 #[cfg(c_bindings)]
1406                 builder.amount(currency_amount.clone());
1407                 let tlv_stream = builder.offer.as_tlv_stream();
1408                 assert_eq!(builder.offer.amount, Some(currency_amount.clone()));
1409                 assert_eq!(tlv_stream.amount, Some(10));
1410                 assert_eq!(tlv_stream.currency, Some(b"USD"));
1411                 match builder.build() {
1412                         Ok(_) => panic!("expected error"),
1413                         Err(e) => assert_eq!(e, Bolt12SemanticError::UnsupportedCurrency),
1414                 }
1415
1416                 let offer = OfferBuilder::new(pubkey(42))
1417                         .amount(currency_amount.clone())
1418                         .amount(bitcoin_amount.clone())
1419                         .build()
1420                         .unwrap();
1421                 let tlv_stream = offer.as_tlv_stream();
1422                 assert_eq!(tlv_stream.amount, Some(1000));
1423                 assert_eq!(tlv_stream.currency, None);
1424
1425                 let invalid_amount = Amount::Bitcoin { amount_msats: MAX_VALUE_MSAT + 1 };
1426                 match OfferBuilder::new(pubkey(42)).amount(invalid_amount).build() {
1427                         Ok(_) => panic!("expected error"),
1428                         Err(e) => assert_eq!(e, Bolt12SemanticError::InvalidAmount),
1429                 }
1430         }
1431
1432         #[test]
1433         fn builds_offer_with_description() {
1434                 let offer = OfferBuilder::new(pubkey(42))
1435                         .description("foo".into())
1436                         .build()
1437                         .unwrap();
1438                 assert_eq!(offer.description(), Some(PrintableString("foo")));
1439                 assert_eq!(offer.as_tlv_stream().description, Some(&String::from("foo")));
1440
1441                 let offer = OfferBuilder::new(pubkey(42))
1442                         .description("foo".into())
1443                         .description("bar".into())
1444                         .build()
1445                         .unwrap();
1446                 assert_eq!(offer.description(), Some(PrintableString("bar")));
1447                 assert_eq!(offer.as_tlv_stream().description, Some(&String::from("bar")));
1448
1449                 let offer = OfferBuilder::new(pubkey(42))
1450                         .amount_msats(1000)
1451                         .build()
1452                         .unwrap();
1453                 assert_eq!(offer.description(), Some(PrintableString("")));
1454                 assert_eq!(offer.as_tlv_stream().description, Some(&String::from("")));
1455         }
1456
1457         #[test]
1458         fn builds_offer_with_features() {
1459                 let offer = OfferBuilder::new(pubkey(42))
1460                         .features_unchecked(OfferFeatures::unknown())
1461                         .build()
1462                         .unwrap();
1463                 assert_eq!(offer.offer_features(), &OfferFeatures::unknown());
1464                 assert_eq!(offer.as_tlv_stream().features, Some(&OfferFeatures::unknown()));
1465
1466                 let offer = OfferBuilder::new(pubkey(42))
1467                         .features_unchecked(OfferFeatures::unknown())
1468                         .features_unchecked(OfferFeatures::empty())
1469                         .build()
1470                         .unwrap();
1471                 assert_eq!(offer.offer_features(), &OfferFeatures::empty());
1472                 assert_eq!(offer.as_tlv_stream().features, None);
1473         }
1474
1475         #[test]
1476         fn builds_offer_with_absolute_expiry() {
1477                 let future_expiry = Duration::from_secs(u64::max_value());
1478                 let past_expiry = Duration::from_secs(0);
1479                 let now = future_expiry - Duration::from_secs(1_000);
1480
1481                 let offer = OfferBuilder::new(pubkey(42))
1482                         .absolute_expiry(future_expiry)
1483                         .build()
1484                         .unwrap();
1485                 #[cfg(feature = "std")]
1486                 assert!(!offer.is_expired());
1487                 assert!(!offer.is_expired_no_std(now));
1488                 assert_eq!(offer.absolute_expiry(), Some(future_expiry));
1489                 assert_eq!(offer.as_tlv_stream().absolute_expiry, Some(future_expiry.as_secs()));
1490
1491                 let offer = OfferBuilder::new(pubkey(42))
1492                         .absolute_expiry(future_expiry)
1493                         .absolute_expiry(past_expiry)
1494                         .build()
1495                         .unwrap();
1496                 #[cfg(feature = "std")]
1497                 assert!(offer.is_expired());
1498                 assert!(offer.is_expired_no_std(now));
1499                 assert_eq!(offer.absolute_expiry(), Some(past_expiry));
1500                 assert_eq!(offer.as_tlv_stream().absolute_expiry, Some(past_expiry.as_secs()));
1501         }
1502
1503         #[test]
1504         fn builds_offer_with_paths() {
1505                 let paths = vec![
1506                         BlindedPath {
1507                                 introduction_node: IntroductionNode::NodeId(pubkey(40)),
1508                                 blinding_point: pubkey(41),
1509                                 blinded_hops: vec![
1510                                         BlindedHop { blinded_node_id: pubkey(43), encrypted_payload: vec![0; 43] },
1511                                         BlindedHop { blinded_node_id: pubkey(44), encrypted_payload: vec![0; 44] },
1512                                 ],
1513                         },
1514                         BlindedPath {
1515                                 introduction_node: IntroductionNode::NodeId(pubkey(40)),
1516                                 blinding_point: pubkey(41),
1517                                 blinded_hops: vec![
1518                                         BlindedHop { blinded_node_id: pubkey(45), encrypted_payload: vec![0; 45] },
1519                                         BlindedHop { blinded_node_id: pubkey(46), encrypted_payload: vec![0; 46] },
1520                                 ],
1521                         },
1522                 ];
1523
1524                 let offer = OfferBuilder::new(pubkey(42))
1525                         .path(paths[0].clone())
1526                         .path(paths[1].clone())
1527                         .build()
1528                         .unwrap();
1529                 let tlv_stream = offer.as_tlv_stream();
1530                 assert_eq!(offer.paths(), paths.as_slice());
1531                 assert_eq!(offer.signing_pubkey(), Some(pubkey(42)));
1532                 assert_ne!(pubkey(42), pubkey(44));
1533                 assert_eq!(tlv_stream.paths, Some(&paths));
1534                 assert_eq!(tlv_stream.node_id, Some(&pubkey(42)));
1535         }
1536
1537         #[test]
1538         fn builds_offer_with_issuer() {
1539                 let offer = OfferBuilder::new(pubkey(42))
1540                         .issuer("foo".into())
1541                         .build()
1542                         .unwrap();
1543                 assert_eq!(offer.issuer(), Some(PrintableString("foo")));
1544                 assert_eq!(offer.as_tlv_stream().issuer, Some(&String::from("foo")));
1545
1546                 let offer = OfferBuilder::new(pubkey(42))
1547                         .issuer("foo".into())
1548                         .issuer("bar".into())
1549                         .build()
1550                         .unwrap();
1551                 assert_eq!(offer.issuer(), Some(PrintableString("bar")));
1552                 assert_eq!(offer.as_tlv_stream().issuer, Some(&String::from("bar")));
1553         }
1554
1555         #[test]
1556         fn builds_offer_with_supported_quantity() {
1557                 let one = NonZeroU64::new(1).unwrap();
1558                 let ten = NonZeroU64::new(10).unwrap();
1559
1560                 let offer = OfferBuilder::new(pubkey(42))
1561                         .supported_quantity(Quantity::One)
1562                         .build()
1563                         .unwrap();
1564                 let tlv_stream = offer.as_tlv_stream();
1565                 assert!(!offer.expects_quantity());
1566                 assert_eq!(offer.supported_quantity(), Quantity::One);
1567                 assert_eq!(tlv_stream.quantity_max, None);
1568
1569                 let offer = OfferBuilder::new(pubkey(42))
1570                         .supported_quantity(Quantity::Unbounded)
1571                         .build()
1572                         .unwrap();
1573                 let tlv_stream = offer.as_tlv_stream();
1574                 assert!(offer.expects_quantity());
1575                 assert_eq!(offer.supported_quantity(), Quantity::Unbounded);
1576                 assert_eq!(tlv_stream.quantity_max, Some(0));
1577
1578                 let offer = OfferBuilder::new(pubkey(42))
1579                         .supported_quantity(Quantity::Bounded(ten))
1580                         .build()
1581                         .unwrap();
1582                 let tlv_stream = offer.as_tlv_stream();
1583                 assert!(offer.expects_quantity());
1584                 assert_eq!(offer.supported_quantity(), Quantity::Bounded(ten));
1585                 assert_eq!(tlv_stream.quantity_max, Some(10));
1586
1587                 let offer = OfferBuilder::new(pubkey(42))
1588                         .supported_quantity(Quantity::Bounded(one))
1589                         .build()
1590                         .unwrap();
1591                 let tlv_stream = offer.as_tlv_stream();
1592                 assert!(offer.expects_quantity());
1593                 assert_eq!(offer.supported_quantity(), Quantity::Bounded(one));
1594                 assert_eq!(tlv_stream.quantity_max, Some(1));
1595
1596                 let offer = OfferBuilder::new(pubkey(42))
1597                         .supported_quantity(Quantity::Bounded(ten))
1598                         .supported_quantity(Quantity::One)
1599                         .build()
1600                         .unwrap();
1601                 let tlv_stream = offer.as_tlv_stream();
1602                 assert!(!offer.expects_quantity());
1603                 assert_eq!(offer.supported_quantity(), Quantity::One);
1604                 assert_eq!(tlv_stream.quantity_max, None);
1605         }
1606
1607         #[test]
1608         fn fails_requesting_invoice_with_unknown_required_features() {
1609                 match OfferBuilder::new(pubkey(42))
1610                         .features_unchecked(OfferFeatures::unknown())
1611                         .build().unwrap()
1612                         .request_invoice(vec![1; 32], pubkey(43))
1613                 {
1614                         Ok(_) => panic!("expected error"),
1615                         Err(e) => assert_eq!(e, Bolt12SemanticError::UnknownRequiredFeatures),
1616                 }
1617         }
1618
1619         #[test]
1620         fn parses_offer_with_chains() {
1621                 let offer = OfferBuilder::new(pubkey(42))
1622                         .chain(Network::Bitcoin)
1623                         .chain(Network::Testnet)
1624                         .build()
1625                         .unwrap();
1626                 if let Err(e) = offer.to_string().parse::<Offer>() {
1627                         panic!("error parsing offer: {:?}", e);
1628                 }
1629         }
1630
1631         #[test]
1632         fn parses_offer_with_amount() {
1633                 let offer = OfferBuilder::new(pubkey(42))
1634                         .amount(Amount::Bitcoin { amount_msats: 1000 })
1635                         .build()
1636                         .unwrap();
1637                 if let Err(e) = offer.to_string().parse::<Offer>() {
1638                         panic!("error parsing offer: {:?}", e);
1639                 }
1640
1641                 let mut tlv_stream = offer.as_tlv_stream();
1642                 tlv_stream.amount = Some(1000);
1643                 tlv_stream.currency = Some(b"USD");
1644
1645                 let mut encoded_offer = Vec::new();
1646                 tlv_stream.write(&mut encoded_offer).unwrap();
1647
1648                 if let Err(e) = Offer::try_from(encoded_offer) {
1649                         panic!("error parsing offer: {:?}", e);
1650                 }
1651
1652                 let mut tlv_stream = offer.as_tlv_stream();
1653                 tlv_stream.amount = None;
1654                 tlv_stream.currency = Some(b"USD");
1655
1656                 let mut encoded_offer = Vec::new();
1657                 tlv_stream.write(&mut encoded_offer).unwrap();
1658
1659                 match Offer::try_from(encoded_offer) {
1660                         Ok(_) => panic!("expected error"),
1661                         Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingAmount)),
1662                 }
1663
1664                 let mut tlv_stream = offer.as_tlv_stream();
1665                 tlv_stream.amount = Some(MAX_VALUE_MSAT + 1);
1666                 tlv_stream.currency = None;
1667
1668                 let mut encoded_offer = Vec::new();
1669                 tlv_stream.write(&mut encoded_offer).unwrap();
1670
1671                 match Offer::try_from(encoded_offer) {
1672                         Ok(_) => panic!("expected error"),
1673                         Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::InvalidAmount)),
1674                 }
1675         }
1676
1677         #[test]
1678         fn parses_offer_with_description() {
1679                 let offer = OfferBuilder::new(pubkey(42)).build().unwrap();
1680                 if let Err(e) = offer.to_string().parse::<Offer>() {
1681                         panic!("error parsing offer: {:?}", e);
1682                 }
1683
1684                 let offer = OfferBuilder::new(pubkey(42))
1685                         .description("foo".to_string())
1686                         .amount_msats(1000)
1687                         .build().unwrap();
1688                 if let Err(e) = offer.to_string().parse::<Offer>() {
1689                         panic!("error parsing offer: {:?}", e);
1690                 }
1691
1692                 let mut tlv_stream = offer.as_tlv_stream();
1693                 tlv_stream.description = None;
1694
1695                 let mut encoded_offer = Vec::new();
1696                 tlv_stream.write(&mut encoded_offer).unwrap();
1697
1698                 match Offer::try_from(encoded_offer) {
1699                         Ok(_) => panic!("expected error"),
1700                         Err(e) => {
1701                                 assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingDescription));
1702                         },
1703                 }
1704         }
1705
1706         #[test]
1707         fn parses_offer_with_paths() {
1708                 let offer = OfferBuilder::new(pubkey(42))
1709                         .path(BlindedPath {
1710                                 introduction_node: IntroductionNode::NodeId(pubkey(40)),
1711                                 blinding_point: pubkey(41),
1712                                 blinded_hops: vec![
1713                                         BlindedHop { blinded_node_id: pubkey(43), encrypted_payload: vec![0; 43] },
1714                                         BlindedHop { blinded_node_id: pubkey(44), encrypted_payload: vec![0; 44] },
1715                                 ],
1716                         })
1717                         .path(BlindedPath {
1718                                 introduction_node: IntroductionNode::NodeId(pubkey(40)),
1719                                 blinding_point: pubkey(41),
1720                                 blinded_hops: vec![
1721                                         BlindedHop { blinded_node_id: pubkey(45), encrypted_payload: vec![0; 45] },
1722                                         BlindedHop { blinded_node_id: pubkey(46), encrypted_payload: vec![0; 46] },
1723                                 ],
1724                         })
1725                         .build()
1726                         .unwrap();
1727                 if let Err(e) = offer.to_string().parse::<Offer>() {
1728                         panic!("error parsing offer: {:?}", e);
1729                 }
1730
1731                 let offer = OfferBuilder::new(pubkey(42))
1732                         .path(BlindedPath {
1733                                 introduction_node: IntroductionNode::NodeId(pubkey(40)),
1734                                 blinding_point: pubkey(41),
1735                                 blinded_hops: vec![
1736                                         BlindedHop { blinded_node_id: pubkey(43), encrypted_payload: vec![0; 43] },
1737                                         BlindedHop { blinded_node_id: pubkey(44), encrypted_payload: vec![0; 44] },
1738                                 ],
1739                         })
1740                         .clear_signing_pubkey()
1741                         .build()
1742                         .unwrap();
1743                 if let Err(e) = offer.to_string().parse::<Offer>() {
1744                         panic!("error parsing offer: {:?}", e);
1745                 }
1746
1747                 let mut builder = OfferBuilder::new(pubkey(42));
1748                 builder.offer.paths = Some(vec![]);
1749
1750                 let offer = builder.build().unwrap();
1751                 match offer.to_string().parse::<Offer>() {
1752                         Ok(_) => panic!("expected error"),
1753                         Err(e) => {
1754                                 assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingPaths));
1755                         },
1756                 }
1757         }
1758
1759         #[test]
1760         fn parses_offer_with_quantity() {
1761                 let offer = OfferBuilder::new(pubkey(42))
1762                         .supported_quantity(Quantity::One)
1763                         .build()
1764                         .unwrap();
1765                 if let Err(e) = offer.to_string().parse::<Offer>() {
1766                         panic!("error parsing offer: {:?}", e);
1767                 }
1768
1769                 let offer = OfferBuilder::new(pubkey(42))
1770                         .supported_quantity(Quantity::Unbounded)
1771                         .build()
1772                         .unwrap();
1773                 if let Err(e) = offer.to_string().parse::<Offer>() {
1774                         panic!("error parsing offer: {:?}", e);
1775                 }
1776
1777                 let offer = OfferBuilder::new(pubkey(42))
1778                         .supported_quantity(Quantity::Bounded(NonZeroU64::new(10).unwrap()))
1779                         .build()
1780                         .unwrap();
1781                 if let Err(e) = offer.to_string().parse::<Offer>() {
1782                         panic!("error parsing offer: {:?}", e);
1783                 }
1784
1785                 let offer = OfferBuilder::new(pubkey(42))
1786                         .supported_quantity(Quantity::Bounded(NonZeroU64::new(1).unwrap()))
1787                         .build()
1788                         .unwrap();
1789                 if let Err(e) = offer.to_string().parse::<Offer>() {
1790                         panic!("error parsing offer: {:?}", e);
1791                 }
1792         }
1793
1794         #[test]
1795         fn parses_offer_with_node_id() {
1796                 let offer = OfferBuilder::new(pubkey(42)).build().unwrap();
1797                 if let Err(e) = offer.to_string().parse::<Offer>() {
1798                         panic!("error parsing offer: {:?}", e);
1799                 }
1800
1801                 let mut tlv_stream = offer.as_tlv_stream();
1802                 tlv_stream.node_id = None;
1803
1804                 let mut encoded_offer = Vec::new();
1805                 tlv_stream.write(&mut encoded_offer).unwrap();
1806
1807                 match Offer::try_from(encoded_offer) {
1808                         Ok(_) => panic!("expected error"),
1809                         Err(e) => {
1810                                 assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingSigningPubkey));
1811                         },
1812                 }
1813         }
1814
1815         #[test]
1816         fn fails_parsing_offer_with_extra_tlv_records() {
1817                 let offer = OfferBuilder::new(pubkey(42)).build().unwrap();
1818
1819                 let mut encoded_offer = Vec::new();
1820                 offer.write(&mut encoded_offer).unwrap();
1821                 BigSize(80).write(&mut encoded_offer).unwrap();
1822                 BigSize(32).write(&mut encoded_offer).unwrap();
1823                 [42u8; 32].write(&mut encoded_offer).unwrap();
1824
1825                 match Offer::try_from(encoded_offer) {
1826                         Ok(_) => panic!("expected error"),
1827                         Err(e) => assert_eq!(e, Bolt12ParseError::Decode(DecodeError::InvalidValue)),
1828                 }
1829         }
1830 }
1831
1832 #[cfg(test)]
1833 mod bolt12_tests {
1834         use super::{Bolt12ParseError, Bolt12SemanticError, Offer};
1835         use crate::ln::msgs::DecodeError;
1836
1837         #[test]
1838         fn parses_bech32_encoded_offers() {
1839                 let offers = [
1840                         // Minimal bolt12 offer
1841                         "lno1pgx9getnwss8vetrw3hhyuckyypwa3eyt44h6txtxquqh7lz5djge4afgfjn7k4rgrkuag0jsd5xvxg",
1842
1843                         // for testnet
1844                         "lno1qgsyxjtl6luzd9t3pr62xr7eemp6awnejusgf6gw45q75vcfqqqqqqq2p32x2um5ypmx2cm5dae8x93pqthvwfzadd7jejes8q9lhc4rvjxd022zv5l44g6qah82ru5rdpnpj",
1845
1846                         // for bitcoin (redundant)
1847                         "lno1qgsxlc5vp2m0rvmjcxn2y34wv0m5lyc7sdj7zksgn35dvxgqqqqqqqq2p32x2um5ypmx2cm5dae8x93pqthvwfzadd7jejes8q9lhc4rvjxd022zv5l44g6qah82ru5rdpnpj",
1848
1849                         // for bitcoin or liquidv1
1850                         "lno1qfqpge38tqmzyrdjj3x2qkdr5y80dlfw56ztq6yd9sme995g3gsxqqm0u2xq4dh3kdevrf4zg6hx8a60jv0gxe0ptgyfc6xkryqqqqqqqq9qc4r9wd6zqan9vd6x7unnzcss9mk8y3wkklfvevcrszlmu23kfrxh49px20665dqwmn4p72pksese",
1851
1852                         // with metadata
1853                         "lno1qsgqqqqqqqqqqqqqqqqqqqqqqqqqqzsv23jhxapqwejkxar0wfe3vggzamrjghtt05kvkvpcp0a79gmy3nt6jsn98ad2xs8de6sl9qmgvcvs",
1854
1855                         // with amount
1856                         "lno1pqpzwyq2p32x2um5ypmx2cm5dae8x93pqthvwfzadd7jejes8q9lhc4rvjxd022zv5l44g6qah82ru5rdpnpj",
1857
1858                         // with currency
1859                         "lno1qcp4256ypqpzwyq2p32x2um5ypmx2cm5dae8x93pqthvwfzadd7jejes8q9lhc4rvjxd022zv5l44g6qah82ru5rdpnpj",
1860
1861                         // with expiry
1862                         "lno1pgx9getnwss8vetrw3hhyucwq3ay997czcss9mk8y3wkklfvevcrszlmu23kfrxh49px20665dqwmn4p72pksese",
1863
1864                         // with issuer
1865                         "lno1pgx9getnwss8vetrw3hhyucjy358garswvaz7tmzdak8gvfj9ehhyeeqgf85c4p3xgsxjmnyw4ehgunfv4e3vggzamrjghtt05kvkvpcp0a79gmy3nt6jsn98ad2xs8de6sl9qmgvcvs",
1866
1867                         // with quantity
1868                         "lno1pgx9getnwss8vetrw3hhyuc5qyz3vggzamrjghtt05kvkvpcp0a79gmy3nt6jsn98ad2xs8de6sl9qmgvcvs",
1869
1870                         // with unlimited (or unknown) quantity
1871                         "lno1pgx9getnwss8vetrw3hhyuc5qqtzzqhwcuj966ma9n9nqwqtl032xeyv6755yeflt235pmww58egx6rxry",
1872
1873                         // with single quantity (weird but valid)
1874                         "lno1pgx9getnwss8vetrw3hhyuc5qyq3vggzamrjghtt05kvkvpcp0a79gmy3nt6jsn98ad2xs8de6sl9qmgvcvs",
1875
1876                         // with feature
1877                         "lno1pgx9getnwss8vetrw3hhyucvp5yqqqqqqqqqqqqqqqqqqqqkyypwa3eyt44h6txtxquqh7lz5djge4afgfjn7k4rgrkuag0jsd5xvxg",
1878
1879                         // with blinded path via Bob (0x424242...), blinding 020202...
1880                         "lno1pgx9getnwss8vetrw3hhyucs5ypjgef743p5fzqq9nqxh0ah7y87rzv3ud0eleps9kl2d5348hq2k8qzqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgqpqqqqqqqqqqqqqqqqqqqqqqqqqqqzqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqqzq3zyg3zyg3zyg3vggzamrjghtt05kvkvpcp0a79gmy3nt6jsn98ad2xs8de6sl9qmgvcvs",
1881
1882                         // ... and with sciddir introduction node
1883                         "lno1pgx9getnwss8vetrw3hhyucs3yqqqqqqqqqqqqp2qgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqqyqqqqqqqqqqqqqqqqqqqqqqqqqqqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqqgzyg3zyg3zyg3z93pqthvwfzadd7jejes8q9lhc4rvjxd022zv5l44g6qah82ru5rdpnpj",
1884
1885                         // ... and with second blinded path via Carol (0x434343...), blinding 020202...
1886                         "lno1pgx9getnwss8vetrw3hhyucsl5q5yqeyv5l2cs6y3qqzesrth7mlzrlp3xg7xhulusczm04x6g6nms9trspqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqqsqqqqqqqqqqqqqqqqqqqqqqqqqqpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqsqpqg3zyg3zyg3zygz0uc7h32x9s0aecdhxlk075kn046aafpuuyw8f5j652t3vha2yqrsyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqsqzqqqqqqqqqqqqqqqqqqqqqqqqqqqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqqyzyg3zyg3zyg3zzcss9mk8y3wkklfvevcrszlmu23kfrxh49px20665dqwmn4p72pksese",
1887
1888                         // unknown odd field
1889                         "lno1pgx9getnwss8vetrw3hhyuckyypwa3eyt44h6txtxquqh7lz5djge4afgfjn7k4rgrkuag0jsd5xvxfppf5x2mrvdamk7unvvs",
1890                 ];
1891                 for encoded_offer in &offers {
1892                         if let Err(e) = encoded_offer.parse::<Offer>() {
1893                                 panic!("Invalid offer ({:?}): {}", e, encoded_offer);
1894                         }
1895                 }
1896         }
1897
1898         #[test]
1899         fn fails_parsing_bech32_encoded_offers() {
1900                 // Malformed: fields out of order
1901                 assert_eq!(
1902                         "lno1zcssyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszpgz5znzfgdzs".parse::<Offer>(),
1903                         Err(Bolt12ParseError::Decode(DecodeError::InvalidValue)),
1904                 );
1905
1906                 // Malformed: unknown even TLV type 78
1907                 assert_eq!(
1908                         "lno1pgz5znzfgdz3vggzqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpysgr0u2xq4dh3kdevrf4zg6hx8a60jv0gxe0ptgyfc6xkryqqqqqqqq".parse::<Offer>(),
1909                         Err(Bolt12ParseError::Decode(DecodeError::UnknownRequiredFeature)),
1910                 );
1911
1912                 // Malformed: empty
1913                 assert_eq!(
1914                         "lno1".parse::<Offer>(),
1915                         Err(Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingSigningPubkey)),
1916                 );
1917
1918                 // Malformed: truncated at type
1919                 assert_eq!(
1920                         "lno1pg".parse::<Offer>(),
1921                         Err(Bolt12ParseError::Decode(DecodeError::ShortRead)),
1922                 );
1923
1924                 // Malformed: truncated in length
1925                 assert_eq!(
1926                         "lno1pt7s".parse::<Offer>(),
1927                         Err(Bolt12ParseError::Decode(DecodeError::ShortRead)),
1928                 );
1929
1930                 // Malformed: truncated after length
1931                 assert_eq!(
1932                         "lno1pgpq".parse::<Offer>(),
1933                         Err(Bolt12ParseError::Decode(DecodeError::ShortRead)),
1934                 );
1935
1936                 // Malformed: truncated in description
1937                 assert_eq!(
1938                         "lno1pgpyz".parse::<Offer>(),
1939                         Err(Bolt12ParseError::Decode(DecodeError::ShortRead)),
1940                 );
1941
1942                 // Malformed: invalid offer_chains length
1943                 assert_eq!(
1944                         "lno1qgqszzs9g9xyjs69zcssyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqsz".parse::<Offer>(),
1945                         Err(Bolt12ParseError::Decode(DecodeError::ShortRead)),
1946                 );
1947
1948                 // Malformed: truncated currency UTF-8
1949                 assert_eq!(
1950                         "lno1qcqcqzs9g9xyjs69zcssyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqsz".parse::<Offer>(),
1951                         Err(Bolt12ParseError::Decode(DecodeError::ShortRead)),
1952                 );
1953
1954                 // Malformed: invalid currency UTF-8
1955                 assert_eq!(
1956                         "lno1qcpgqsg2q4q5cj2rg5tzzqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqg".parse::<Offer>(),
1957                         Err(Bolt12ParseError::Decode(DecodeError::ShortRead)),
1958                 );
1959
1960                 // Malformed: truncated description UTF-8
1961                 assert_eq!(
1962                         "lno1pgqcq93pqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqy".parse::<Offer>(),
1963                         Err(Bolt12ParseError::Decode(DecodeError::InvalidValue)),
1964                 );
1965
1966                 // Malformed: invalid description UTF-8
1967                 assert_eq!(
1968                         "lno1pgpgqsgkyypqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqs".parse::<Offer>(),
1969                         Err(Bolt12ParseError::Decode(DecodeError::InvalidValue)),
1970                 );
1971
1972                 // Malformed: truncated offer_paths
1973                 assert_eq!(
1974                         "lno1pgz5znzfgdz3qqgpzcssyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqsz".parse::<Offer>(),
1975                         Err(Bolt12ParseError::Decode(DecodeError::ShortRead)),
1976                 );
1977
1978                 // Malformed: zero num_hops in blinded_path
1979                 assert_eq!(
1980                         "lno1pgz5znzfgdz3qqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqsqzcssyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqsz".parse::<Offer>(),
1981                         Err(Bolt12ParseError::Decode(DecodeError::ShortRead)),
1982                 );
1983
1984                 // Malformed: truncated onionmsg_hop in blinded_path
1985                 assert_eq!(
1986                         "lno1pgz5znzfgdz3qqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqspqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqgkyypqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqs".parse::<Offer>(),
1987                         Err(Bolt12ParseError::Decode(DecodeError::ShortRead)),
1988                 );
1989
1990                 // Malformed: bad first_node_id in blinded_path
1991                 assert_eq!(
1992                         "lno1pgz5znzfgdz3qqcrqvpsxqcrqvpsxqcrqvpsxqcrqvpsxqcrqvpsxqcrqvpsxqcrqvpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqspqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqgqzcssyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqsz".parse::<Offer>(),
1993                         Err(Bolt12ParseError::Decode(DecodeError::ShortRead)),
1994                 );
1995
1996                 // Malformed: bad blinding in blinded_path
1997                 assert_eq!(
1998                         "lno1pgz5znzfgdz3qqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpsxqcrqvpsxqcrqvpsxqcrqvpsxqcrqvpsxqcrqvpsxqcrqvpsxqcpqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqgqzcssyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqsz".parse::<Offer>(),
1999                         Err(Bolt12ParseError::Decode(DecodeError::ShortRead)),
2000                 );
2001
2002                 // Malformed: bad blinded_node_id in onionmsg_hop
2003                 assert_eq!(
2004                         "lno1pgz5znzfgdz3qqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqspqvpsxqcrqvpsxqcrqvpsxqcrqvpsxqcrqvpsxqcrqvpsxqcrqvpsxqgqzcssyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqsz".parse::<Offer>(),
2005                         Err(Bolt12ParseError::Decode(DecodeError::ShortRead)),
2006                 );
2007
2008                 // Malformed: truncated issuer UTF-8
2009                 assert_eq!(
2010                         "lno1pgz5znzfgdz3yqvqzcssyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqsz".parse::<Offer>(),
2011                         Err(Bolt12ParseError::Decode(DecodeError::InvalidValue)),
2012                 );
2013
2014                 // Malformed: invalid issuer UTF-8
2015                 assert_eq!(
2016                         "lno1pgz5znzfgdz3yq5qgytzzqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqg".parse::<Offer>(),
2017                         Err(Bolt12ParseError::Decode(DecodeError::InvalidValue)),
2018                 );
2019
2020                 // Malformed: invalid offer_node_id
2021                 assert_eq!(
2022                         "lno1pgz5znzfgdz3vggzqvpsxqcrqvpsxqcrqvpsxqcrqvpsxqcrqvpsxqcrqvpsxqcrqvps".parse::<Offer>(),
2023                         Err(Bolt12ParseError::Decode(DecodeError::InvalidValue)),
2024                 );
2025
2026                 // Contains type >= 80
2027                 assert_eq!(
2028                         "lno1pgz5znzfgdz3vggzqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgpqyqszqgp9qgr0u2xq4dh3kdevrf4zg6hx8a60jv0gxe0ptgyfc6xkryqqqqqqqq".parse::<Offer>(),
2029                         Err(Bolt12ParseError::Decode(DecodeError::InvalidValue)),
2030                 );
2031
2032                 // TODO: Resolved in spec https://github.com/lightning/bolts/pull/798/files#r1334851959
2033                 // Contains unknown feature 22
2034                 assert!(
2035                         "lno1pgx9getnwss8vetrw3hhyucvqdqqqqqkyypwa3eyt44h6txtxquqh7lz5djge4afgfjn7k4rgrkuag0jsd5xvxg".parse::<Offer>().is_ok()
2036                 );
2037
2038                 // Missing offer_description
2039                 assert_eq!(
2040                         // TODO: Match the spec once it is updated.
2041                         "lno1pqpq86qkyypwa3eyt44h6txtxquqh7lz5djge4afgfjn7k4rgrkuag0jsd5xvxg".parse::<Offer>(),
2042                         Err(Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingDescription)),
2043                 );
2044
2045                 // Missing offer_node_id"
2046                 assert_eq!(
2047                         "lno1pgx9getnwss8vetrw3hhyuc".parse::<Offer>(),
2048                         Err(Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingSigningPubkey)),
2049                 );
2050         }
2051 }