_ 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 //! ```ignore
  17 //! extern crate bitcoin;
  18 //! extern crate core;
  19 //! extern crate lightning;
  20 //!
  21 //! use core::convert::TryFrom;
  22 //! use core::num::NonZeroU64;
  23 //! use core::time::Duration;
  24 //!
  25 //! use bitcoin::secp256k1::{KeyPair, PublicKey, Secp256k1, SecretKey};
  26 //! use lightning::offers::offer::{Offer, OfferBuilder, Quantity};
  27 //! use lightning::offers::parse::ParseError;
  28 //! use lightning::util::ser::{Readable, Writeable};
  29 //!
  30 //! # use lightning::onion_message::BlindedPath;
  31 //! # #[cfg(feature = "std")]
  32 //! # use std::time::SystemTime;
  33 //! #
  34 //! # fn create_blinded_path() -> BlindedPath { unimplemented!() }
  35 //! # fn create_another_blinded_path() -> BlindedPath { unimplemented!() }
  36 //! #
  37 //! # #[cfg(feature = "std")]
  38 //! # fn build() -> Result<(), ParseError> {
  39 //! let secp_ctx = Secp256k1::new();
  40 //! let keys = KeyPair::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
  41 //! let pubkey = PublicKey::from(keys);
  42 //!
  43 //! let expiration = SystemTime::now() + Duration::from_secs(24 * 60 * 60);
  44 //! let offer = OfferBuilder::new("coffee, large".to_string(), pubkey)
  45 //!     .amount_msats(20_000)
  46 //!     .supported_quantity(Quantity::Unbounded)
  47 //!     .absolute_expiry(expiration.duration_since(SystemTime::UNIX_EPOCH).unwrap())
  48 //!     .issuer("Foo Bar".to_string())
  49 //!     .path(create_blinded_path())
  50 //!     .path(create_another_blinded_path())
  51 //!     .build()?;
  52 //!
  53 //! // Encode as a bech32 string for use in a QR code.
  54 //! let encoded_offer = offer.to_string();
  55 //!
  56 //! // Parse from a bech32 string after scanning from a QR code.
  57 //! let offer = encoded_offer.parse::<Offer>()?;
  58 //!
  59 //! // Encode offer as raw bytes.
  60 //! let mut bytes = Vec::new();
  61 //! offer.write(&mut bytes).unwrap();
  62 //!
  63 //! // Decode raw bytes into an offer.
  64 //! let offer = Offer::try_from(bytes)?;
  65 //! # Ok(())
  66 //! # }
  67 //! ```
  68
  69 use bitcoin::blockdata::constants::ChainHash;
  70 use bitcoin::network::constants::Network;
  71 use bitcoin::secp256k1::PublicKey;
  72 use core::convert::TryFrom;
  73 use core::num::NonZeroU64;
  74 use core::str::FromStr;
  75 use core::time::Duration;
  76 use crate::io;
  77 use crate::ln::features::OfferFeatures;
  78 use crate::ln::msgs::MAX_VALUE_MSAT;
  79 use crate::offers::invoice_request::InvoiceRequestBuilder;
  80 use crate::offers::parse::{Bech32Encode, ParseError, ParsedMessage, SemanticError};
  81 use crate::onion_message::BlindedPath;
  82 use crate::util::ser::{HighZeroBytesDroppedBigSize, WithoutLength, Writeable, Writer};
  83 use crate::util::string::PrintableString;
  84
  85 use crate::prelude::*;
  86
  87 #[cfg(feature = "std")]
  88 use std::time::SystemTime;
  89
  90 /// Builds an [`Offer`] for the "offer to be paid" flow.
  91 ///
  92 /// See [module-level documentation] for usage.
  93 ///
  94 /// [module-level documentation]: self
  95 pub struct OfferBuilder {
  96         offer: OfferContents,
  97 }
  98
  99 impl OfferBuilder {
 100         /// Creates a new builder for an offer setting the [`Offer::description`] and using the
 101         /// [`Offer::signing_pubkey`] for signing invoices. The associated secret key must be remembered
 102         /// while the offer is valid.
 103         ///
 104         /// Use a different pubkey per offer to avoid correlating offers.
 105         pub fn new(description: String, signing_pubkey: PublicKey) -> Self {
 106                 let offer = OfferContents {
 107                         chains: None, metadata: None, amount: None, description,
 108                         features: OfferFeatures::empty(), absolute_expiry: None, issuer: None, paths: None,
 109                         supported_quantity: Quantity::One, signing_pubkey,
 110                 };
 111                 OfferBuilder { offer }
 112         }
 113
 114         /// Adds the chain hash of the given [`Network`] to [`Offer::chains`]. If not called,
 115         /// the chain hash of [`Network::Bitcoin`] is assumed to be the only one supported.
 116         ///
 117         /// See [`Offer::chains`] on how this relates to the payment currency.
 118         ///
 119         /// Successive calls to this method will add another chain hash.
 120         pub fn chain(mut self, network: Network) -> Self {
 121                 let chains = self.offer.chains.get_or_insert_with(Vec::new);
 122                 let chain = ChainHash::using_genesis_block(network);
 123                 if !chains.contains(&chain) {
 124                         chains.push(chain);
 125                 }
 126
 127                 self
 128         }
 129
 130         /// Sets the [`Offer::metadata`].
 131         ///
 132         /// Successive calls to this method will override the previous setting.
 133         pub fn metadata(mut self, metadata: Vec<u8>) -> Self {
 134                 self.offer.metadata = Some(metadata);
 135                 self
 136         }
 137
 138         /// Sets the [`Offer::amount`] as an [`Amount::Bitcoin`].
 139         ///
 140         /// Successive calls to this method will override the previous setting.
 141         pub fn amount_msats(self, amount_msats: u64) -> Self {
 142                 self.amount(Amount::Bitcoin { amount_msats })
 143         }
 144
 145         /// Sets the [`Offer::amount`].
 146         ///
 147         /// Successive calls to this method will override the previous setting.
 148         pub(super) fn amount(mut self, amount: Amount) -> Self {
 149                 self.offer.amount = Some(amount);
 150                 self
 151         }
 152
 153         /// Sets the [`Offer::absolute_expiry`] as seconds since the Unix epoch. Any expiry that has
 154         /// already passed is valid and can be checked for using [`Offer::is_expired`].
 155         ///
 156         /// Successive calls to this method will override the previous setting.
 157         pub fn absolute_expiry(mut self, absolute_expiry: Duration) -> Self {
 158                 self.offer.absolute_expiry = Some(absolute_expiry);
 159                 self
 160         }
 161
 162         /// Sets the [`Offer::issuer`].
 163         ///
 164         /// Successive calls to this method will override the previous setting.
 165         pub fn issuer(mut self, issuer: String) -> Self {
 166                 self.offer.issuer = Some(issuer);
 167                 self
 168         }
 169
 170         /// Adds a blinded path to [`Offer::paths`]. Must include at least one path if only connected by
 171         /// private channels or if [`Offer::signing_pubkey`] is not a public node id.
 172         ///
 173         /// Successive calls to this method will add another blinded path. Caller is responsible for not
 174         /// adding duplicate paths.
 175         pub fn path(mut self, path: BlindedPath) -> Self {
 176                 self.offer.paths.get_or_insert_with(Vec::new).push(path);
 177                 self
 178         }
 179
 180         /// Sets the quantity of items for [`Offer::supported_quantity`]. If not called, defaults to
 181         /// [`Quantity::One`].
 182         ///
 183         /// Successive calls to this method will override the previous setting.
 184         pub fn supported_quantity(mut self, quantity: Quantity) -> Self {
 185                 self.offer.supported_quantity = quantity;
 186                 self
 187         }
 188
 189         /// Builds an [`Offer`] from the builder's settings.
 190         pub fn build(mut self) -> Result<Offer, SemanticError> {
 191                 match self.offer.amount {
 192                         Some(Amount::Bitcoin { amount_msats }) => {
 193                                 if amount_msats > MAX_VALUE_MSAT {
 194                                         return Err(SemanticError::InvalidAmount);
 195                                 }
 196                         },
 197                         Some(Amount::Currency { .. }) => return Err(SemanticError::UnsupportedCurrency),
 198                         None => {},
 199                 }
 200
 201                 if let Some(chains) = &self.offer.chains {
 202                         if chains.len() == 1 && chains[0] == self.offer.implied_chain() {
 203                                 self.offer.chains = None;
 204                         }
 205                 }
 206
 207                 let mut bytes = Vec::new();
 208                 self.offer.write(&mut bytes).unwrap();
 209
 210                 Ok(Offer {
 211                         bytes,
 212                         contents: self.offer,
 213                 })
 214         }
 215 }
 216
 217 #[cfg(test)]
 218 impl OfferBuilder {
 219         fn features_unchecked(mut self, features: OfferFeatures) -> Self {
 220                 self.offer.features = features;
 221                 self
 222         }
 223
 224         pub(super) fn build_unchecked(self) -> Offer {
 225                 let mut bytes = Vec::new();
 226                 self.offer.write(&mut bytes).unwrap();
 227
 228                 Offer { bytes, contents: self.offer }
 229         }
 230 }
 231
 232 /// An `Offer` is a potentially long-lived proposal for payment of a good or service.
 233 ///
 234 /// An offer is a precursor to an [`InvoiceRequest`]. A merchant publishes an offer from which a
 235 /// customer may request an [`Invoice`] for a specific quantity and using an amount sufficient to
 236 /// cover that quantity (i.e., at least `quantity * amount`). See [`Offer::amount`].
 237 ///
 238 /// Offers may be denominated in currency other than bitcoin but are ultimately paid using the
 239 /// latter.
 240 ///
 241 /// Through the use of [`BlindedPath`]s, offers provide recipient privacy.
 242 ///
 243 /// [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
 244 /// [`Invoice`]: crate::offers::invoice::Invoice
 245 #[derive(Clone, Debug)]
 246 pub struct Offer {
 247         // The serialized offer. Needed when creating an `InvoiceRequest` if the offer contains unknown
 248         // fields.
 249         pub(super) bytes: Vec<u8>,
 250         pub(super) contents: OfferContents,
 251 }
 252
 253 /// The contents of an [`Offer`], which may be shared with an [`InvoiceRequest`] or an [`Invoice`].
 254 ///
 255 /// [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
 256 /// [`Invoice`]: crate::offers::invoice::Invoice
 257 #[derive(Clone, Debug)]
 258 pub(super) struct OfferContents {
 259         chains: Option<Vec<ChainHash>>,
 260         metadata: Option<Vec<u8>>,
 261         amount: Option<Amount>,
 262         description: String,
 263         features: OfferFeatures,
 264         absolute_expiry: Option<Duration>,
 265         issuer: Option<String>,
 266         paths: Option<Vec<BlindedPath>>,
 267         supported_quantity: Quantity,
 268         signing_pubkey: PublicKey,
 269 }
 270
 271 impl Offer {
 272         // TODO: Return a slice once ChainHash has constants.
 273         // - https://github.com/rust-bitcoin/rust-bitcoin/pull/1283
 274         // - https://github.com/rust-bitcoin/rust-bitcoin/pull/1286
 275         /// The chains that may be used when paying a requested invoice (e.g., bitcoin mainnet).
 276         /// Payments must be denominated in units of the minimal lightning-payable unit (e.g., msats)
 277         /// for the selected chain.
 278         pub fn chains(&self) -> Vec<ChainHash> {
 279                 self.contents.chains()
 280         }
 281
 282         pub(super) fn implied_chain(&self) -> ChainHash {
 283                 self.contents.implied_chain()
 284         }
 285
 286         /// Returns whether the given chain is supported by the offer.
 287         pub fn supports_chain(&self, chain: ChainHash) -> bool {
 288                 self.contents.supports_chain(chain)
 289         }
 290
 291         // TODO: Link to corresponding method in `InvoiceRequest`.
 292         /// Opaque bytes set by the originator. Useful for authentication and validating fields since it
 293         /// is reflected in `invoice_request` messages along with all the other fields from the `offer`.
 294         pub fn metadata(&self) -> Option<&Vec<u8>> {
 295                 self.contents.metadata.as_ref()
 296         }
 297
 298         /// The minimum amount required for a successful payment of a single item.
 299         pub fn amount(&self) -> Option<&Amount> {
 300                 self.contents.amount()
 301         }
 302
 303         /// A complete description of the purpose of the payment. Intended to be displayed to the user
 304         /// but with the caveat that it has not been verified in any way.
 305         pub fn description(&self) -> PrintableString {
 306                 PrintableString(&self.contents.description)
 307         }
 308
 309         /// Features pertaining to the offer.
 310         pub fn features(&self) -> &OfferFeatures {
 311                 &self.contents.features
 312         }
 313
 314         /// Duration since the Unix epoch when an invoice should no longer be requested.
 315         ///
 316         /// If `None`, the offer does not expire.
 317         pub fn absolute_expiry(&self) -> Option<Duration> {
 318                 self.contents.absolute_expiry
 319         }
 320
 321         /// Whether the offer has expired.
 322         #[cfg(feature = "std")]
 323         pub fn is_expired(&self) -> bool {
 324                 self.contents.is_expired()
 325         }
 326
 327         /// The issuer of the offer, possibly beginning with `user@domain` or `domain`. Intended to be
 328         /// displayed to the user but with the caveat that it has not been verified in any way.
 329         pub fn issuer(&self) -> Option<PrintableString> {
 330                 self.contents.issuer.as_ref().map(|issuer| PrintableString(issuer.as_str()))
 331         }
 332
 333         /// Paths to the recipient originating from publicly reachable nodes. Blinded paths provide
 334         /// recipient privacy by obfuscating its node id.
 335         pub fn paths(&self) -> &[BlindedPath] {
 336                 self.contents.paths.as_ref().map(|paths| paths.as_slice()).unwrap_or(&[])
 337         }
 338
 339         /// The quantity of items supported.
 340         pub fn supported_quantity(&self) -> Quantity {
 341                 self.contents.supported_quantity()
 342         }
 343
 344         /// Returns whether the given quantity is valid for the offer.
 345         pub fn is_valid_quantity(&self, quantity: u64) -> bool {
 346                 self.contents.is_valid_quantity(quantity)
 347         }
 348
 349         /// Returns whether a quantity is expected in an [`InvoiceRequest`] for the offer.
 350         ///
 351         /// [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
 352         pub fn expects_quantity(&self) -> bool {
 353                 self.contents.expects_quantity()
 354         }
 355
 356         /// The public key used by the recipient to sign invoices.
 357         pub fn signing_pubkey(&self) -> PublicKey {
 358                 self.contents.signing_pubkey()
 359         }
 360
 361         /// Creates an [`InvoiceRequest`] for the offer with the given `metadata` and `payer_id`, which
 362         /// will be reflected in the `Invoice` response.
 363         ///
 364         /// The `metadata` is useful for including information about the derivation of `payer_id` such
 365         /// that invoice response handling can be stateless. Also serves as payer-provided entropy while
 366         /// hashing in the signature calculation.
 367         ///
 368         /// This should not leak any information such as by using a simple BIP-32 derivation path.
 369         /// Otherwise, payments may be correlated.
 370         ///
 371         /// Errors if the offer contains unknown required features.
 372         ///
 373         /// [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
 374         pub fn request_invoice(
 375                 &self, metadata: Vec<u8>, payer_id: PublicKey
 376         ) -> Result<InvoiceRequestBuilder, SemanticError> {
 377                 if self.features().requires_unknown_bits() {
 378                         return Err(SemanticError::UnknownRequiredFeatures);
 379                 }
 380
 381                 Ok(InvoiceRequestBuilder::new(self, metadata, payer_id))
 382         }
 383
 384         #[cfg(test)]
 385         pub(super) fn as_tlv_stream(&self) -> OfferTlvStreamRef {
 386                 self.contents.as_tlv_stream()
 387         }
 388 }
 389
 390 impl AsRef<[u8]> for Offer {
 391         fn as_ref(&self) -> &[u8] {
 392                 &self.bytes
 393         }
 394 }
 395
 396 impl OfferContents {
 397         pub fn chains(&self) -> Vec<ChainHash> {
 398                 self.chains.as_ref().cloned().unwrap_or_else(|| vec![self.implied_chain()])
 399         }
 400
 401         pub fn implied_chain(&self) -> ChainHash {
 402                 ChainHash::using_genesis_block(Network::Bitcoin)
 403         }
 404
 405         pub fn supports_chain(&self, chain: ChainHash) -> bool {
 406                 self.chains().contains(&chain)
 407         }
 408
 409         #[cfg(feature = "std")]
 410         pub(super) fn is_expired(&self) -> bool {
 411                 match self.absolute_expiry {
 412                         Some(seconds_from_epoch) => match SystemTime::UNIX_EPOCH.elapsed() {
 413                                 Ok(elapsed) => elapsed > seconds_from_epoch,
 414                                 Err(_) => false,
 415                         },
 416                         None => false,
 417                 }
 418         }
 419
 420         pub fn amount(&self) -> Option<&Amount> {
 421                 self.amount.as_ref()
 422         }
 423
 424         pub(super) fn check_amount_msats_for_quantity(
 425                 &self, amount_msats: Option<u64>, quantity: Option<u64>
 426         ) -> Result<(), SemanticError> {
 427                 let offer_amount_msats = match self.amount {
 428                         None => 0,
 429                         Some(Amount::Bitcoin { amount_msats }) => amount_msats,
 430                         Some(Amount::Currency { .. }) => return Err(SemanticError::UnsupportedCurrency),
 431                 };
 432
 433                 if !self.expects_quantity() || quantity.is_some() {
 434                         let expected_amount_msats = offer_amount_msats * quantity.unwrap_or(1);
 435                         let amount_msats = amount_msats.unwrap_or(expected_amount_msats);
 436
 437                         if amount_msats < expected_amount_msats {
 438                                 return Err(SemanticError::InsufficientAmount);
 439                         }
 440
 441                         if amount_msats > MAX_VALUE_MSAT {
 442                                 return Err(SemanticError::InvalidAmount);
 443                         }
 444                 }
 445
 446                 Ok(())
 447         }
 448
 449         pub fn supported_quantity(&self) -> Quantity {
 450                 self.supported_quantity
 451         }
 452
 453         pub(super) fn check_quantity(&self, quantity: Option<u64>) -> Result<(), SemanticError> {
 454                 let expects_quantity = self.expects_quantity();
 455                 match quantity {
 456                         None if expects_quantity => Err(SemanticError::MissingQuantity),
 457                         Some(_) if !expects_quantity => Err(SemanticError::UnexpectedQuantity),
 458                         Some(quantity) if !self.is_valid_quantity(quantity) => {
 459                                 Err(SemanticError::InvalidQuantity)
 460                         },
 461                         _ => Ok(()),
 462                 }
 463         }
 464
 465         fn is_valid_quantity(&self, quantity: u64) -> bool {
 466                 match self.supported_quantity {
 467                         Quantity::Bounded(n) => quantity <= n.get(),
 468                         Quantity::Unbounded => quantity > 0,
 469                         Quantity::One => quantity == 1,
 470                 }
 471         }
 472
 473         fn expects_quantity(&self) -> bool {
 474                 match self.supported_quantity {
 475                         Quantity::Bounded(_) => true,
 476                         Quantity::Unbounded => true,
 477                         Quantity::One => false,
 478                 }
 479         }
 480
 481         pub(super) fn signing_pubkey(&self) -> PublicKey {
 482                 self.signing_pubkey
 483         }
 484
 485         pub(super) fn as_tlv_stream(&self) -> OfferTlvStreamRef {
 486                 let (currency, amount) = match &self.amount {
 487                         None => (None, None),
 488                         Some(Amount::Bitcoin { amount_msats }) => (None, Some(*amount_msats)),
 489                         Some(Amount::Currency { iso4217_code, amount }) => (
 490                                 Some(iso4217_code), Some(*amount)
 491                         ),
 492                 };
 493
 494                 let features = {
 495                         if self.features == OfferFeatures::empty() { None } else { Some(&self.features) }
 496                 };
 497
 498                 OfferTlvStreamRef {
 499                         chains: self.chains.as_ref(),
 500                         metadata: self.metadata.as_ref(),
 501                         currency,
 502                         amount,
 503                         description: Some(&self.description),
 504                         features,
 505                         absolute_expiry: self.absolute_expiry.map(|duration| duration.as_secs()),
 506                         paths: self.paths.as_ref(),
 507                         issuer: self.issuer.as_ref(),
 508                         quantity_max: self.supported_quantity.to_tlv_record(),
 509                         node_id: Some(&self.signing_pubkey),
 510                 }
 511         }
 512 }
 513
 514 impl Writeable for Offer {
 515         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
 516                 WithoutLength(&self.bytes).write(writer)
 517         }
 518 }
 519
 520 impl Writeable for OfferContents {
 521         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
 522                 self.as_tlv_stream().write(writer)
 523         }
 524 }
 525
 526 /// The minimum amount required for an item in an [`Offer`], denominated in either bitcoin or
 527 /// another currency.
 528 #[derive(Clone, Debug, PartialEq)]
 529 pub enum Amount {
 530         /// An amount of bitcoin.
 531         Bitcoin {
 532                 /// The amount in millisatoshi.
 533                 amount_msats: u64,
 534         },
 535         /// An amount of currency specified using ISO 4712.
 536         Currency {
 537                 /// The currency that the amount is denominated in.
 538                 iso4217_code: CurrencyCode,
 539                 /// The amount in the currency unit adjusted by the ISO 4712 exponent (e.g., USD cents).
 540                 amount: u64,
 541         },
 542 }
 543
 544 /// An ISO 4712 three-letter currency code (e.g., USD).
 545 pub type CurrencyCode = [u8; 3];
 546
 547 /// Quantity of items supported by an [`Offer`].
 548 #[derive(Clone, Copy, Debug, PartialEq)]
 549 pub enum Quantity {
 550         /// Up to a specific number of items (inclusive). Use when more than one item can be requested
 551         /// but is limited (e.g., because of per customer or inventory limits).
 552         ///
 553         /// May be used with `NonZeroU64::new(1)` but prefer to use [`Quantity::One`] if only one item
 554         /// is supported.
 555         Bounded(NonZeroU64),
 556         /// One or more items. Use when more than one item can be requested without any limit.
 557         Unbounded,
 558         /// Only one item. Use when only a single item can be requested.
 559         One,
 560 }
 561
 562 impl Quantity {
 563         fn to_tlv_record(&self) -> Option<u64> {
 564                 match self {
 565                         Quantity::Bounded(n) => Some(n.get()),
 566                         Quantity::Unbounded => Some(0),
 567                         Quantity::One => None,
 568                 }
 569         }
 570 }
 571
 572 tlv_stream!(OfferTlvStream, OfferTlvStreamRef, 1..80, {
 573         (2, chains: (Vec<ChainHash>, WithoutLength)),
 574         (4, metadata: (Vec<u8>, WithoutLength)),
 575         (6, currency: CurrencyCode),
 576         (8, amount: (u64, HighZeroBytesDroppedBigSize)),
 577         (10, description: (String, WithoutLength)),
 578         (12, features: (OfferFeatures, WithoutLength)),
 579         (14, absolute_expiry: (u64, HighZeroBytesDroppedBigSize)),
 580         (16, paths: (Vec<BlindedPath>, WithoutLength)),
 581         (18, issuer: (String, WithoutLength)),
 582         (20, quantity_max: (u64, HighZeroBytesDroppedBigSize)),
 583         (22, node_id: PublicKey),
 584 });
 585
 586 impl Bech32Encode for Offer {
 587         const BECH32_HRP: &'static str = "lno";
 588 }
 589
 590 impl FromStr for Offer {
 591         type Err = ParseError;
 592
 593         fn from_str(s: &str) -> Result<Self, <Self as FromStr>::Err> {
 594                 Self::from_bech32_str(s)
 595         }
 596 }
 597
 598 impl TryFrom<Vec<u8>> for Offer {
 599         type Error = ParseError;
 600
 601         fn try_from(bytes: Vec<u8>) -> Result<Self, Self::Error> {
 602                 let offer = ParsedMessage::<OfferTlvStream>::try_from(bytes)?;
 603                 let ParsedMessage { bytes, tlv_stream } = offer;
 604                 let contents = OfferContents::try_from(tlv_stream)?;
 605                 Ok(Offer { bytes, contents })
 606         }
 607 }
 608
 609 impl TryFrom<OfferTlvStream> for OfferContents {
 610         type Error = SemanticError;
 611
 612         fn try_from(tlv_stream: OfferTlvStream) -> Result<Self, Self::Error> {
 613                 let OfferTlvStream {
 614                         chains, metadata, currency, amount, description, features, absolute_expiry, paths,
 615                         issuer, quantity_max, node_id,
 616                 } = tlv_stream;
 617
 618                 let amount = match (currency, amount) {
 619                         (None, None) => None,
 620                         (None, Some(amount_msats)) if amount_msats > MAX_VALUE_MSAT => {
 621                                 return Err(SemanticError::InvalidAmount);
 622                         },
 623                         (None, Some(amount_msats)) => Some(Amount::Bitcoin { amount_msats }),
 624                         (Some(_), None) => return Err(SemanticError::MissingAmount),
 625                         (Some(iso4217_code), Some(amount)) => Some(Amount::Currency { iso4217_code, amount }),
 626                 };
 627
 628                 let description = match description {
 629                         None => return Err(SemanticError::MissingDescription),
 630                         Some(description) => description,
 631                 };
 632
 633                 let features = features.unwrap_or_else(OfferFeatures::empty);
 634
 635                 let absolute_expiry = absolute_expiry
 636                         .map(|seconds_from_epoch| Duration::from_secs(seconds_from_epoch));
 637
 638                 let supported_quantity = match quantity_max {
 639                         None => Quantity::One,
 640                         Some(0) => Quantity::Unbounded,
 641                         Some(n) => Quantity::Bounded(NonZeroU64::new(n).unwrap()),
 642                 };
 643
 644                 let signing_pubkey = match node_id {
 645                         None => return Err(SemanticError::MissingSigningPubkey),
 646                         Some(node_id) => node_id,
 647                 };
 648
 649                 Ok(OfferContents {
 650                         chains, metadata, amount, description, features, absolute_expiry, issuer, paths,
 651                         supported_quantity, signing_pubkey,
 652                 })
 653         }
 654 }
 655
 656 impl core::fmt::Display for Offer {
 657         fn fmt(&self, f: &mut core::fmt::Formatter) -> Result<(), core::fmt::Error> {
 658                 self.fmt_bech32_str(f)
 659         }
 660 }
 661
 662 #[cfg(test)]
 663 mod tests {
 664         use super::{Amount, Offer, OfferBuilder, OfferTlvStreamRef, Quantity};
 665
 666         use bitcoin::blockdata::constants::ChainHash;
 667         use bitcoin::network::constants::Network;
 668         use bitcoin::secp256k1::{PublicKey, Secp256k1, SecretKey};
 669         use core::convert::TryFrom;
 670         use core::num::NonZeroU64;
 671         use core::time::Duration;
 672         use crate::ln::features::OfferFeatures;
 673         use crate::ln::msgs::{DecodeError, MAX_VALUE_MSAT};
 674         use crate::offers::parse::{ParseError, SemanticError};
 675         use crate::onion_message::{BlindedHop, BlindedPath};
 676         use crate::util::ser::{BigSize, Writeable};
 677         use crate::util::string::PrintableString;
 678
 679         fn pubkey(byte: u8) -> PublicKey {
 680                 let secp_ctx = Secp256k1::new();
 681                 PublicKey::from_secret_key(&secp_ctx, &privkey(byte))
 682         }
 683
 684         fn privkey(byte: u8) -> SecretKey {
 685                 SecretKey::from_slice(&[byte; 32]).unwrap()
 686         }
 687
 688         #[test]
 689         fn builds_offer_with_defaults() {
 690                 let offer = OfferBuilder::new("foo".into(), pubkey(42)).build().unwrap();
 691
 692                 let mut buffer = Vec::new();
 693                 offer.write(&mut buffer).unwrap();
 694
 695                 assert_eq!(offer.bytes, buffer.as_slice());
 696                 assert_eq!(offer.chains(), vec![ChainHash::using_genesis_block(Network::Bitcoin)]);
 697                 assert!(offer.supports_chain(ChainHash::using_genesis_block(Network::Bitcoin)));
 698                 assert_eq!(offer.metadata(), None);
 699                 assert_eq!(offer.amount(), None);
 700                 assert_eq!(offer.description(), PrintableString("foo"));
 701                 assert_eq!(offer.features(), &OfferFeatures::empty());
 702                 assert_eq!(offer.absolute_expiry(), None);
 703                 #[cfg(feature = "std")]
 704                 assert!(!offer.is_expired());
 705                 assert_eq!(offer.paths(), &[]);
 706                 assert_eq!(offer.issuer(), None);
 707                 assert_eq!(offer.supported_quantity(), Quantity::One);
 708                 assert_eq!(offer.signing_pubkey(), pubkey(42));
 709
 710                 assert_eq!(
 711                         offer.as_tlv_stream(),
 712                         OfferTlvStreamRef {
 713                                 chains: None,
 714                                 metadata: None,
 715                                 currency: None,
 716                                 amount: None,
 717                                 description: Some(&String::from("foo")),
 718                                 features: None,
 719                                 absolute_expiry: None,
 720                                 paths: None,
 721                                 issuer: None,
 722                                 quantity_max: None,
 723                                 node_id: Some(&pubkey(42)),
 724                         },
 725                 );
 726
 727                 if let Err(e) = Offer::try_from(buffer) {
 728                         panic!("error parsing offer: {:?}", e);
 729                 }
 730         }
 731
 732         #[test]
 733         fn builds_offer_with_chains() {
 734                 let mainnet = ChainHash::using_genesis_block(Network::Bitcoin);
 735                 let testnet = ChainHash::using_genesis_block(Network::Testnet);
 736
 737                 let offer = OfferBuilder::new("foo".into(), pubkey(42))
 738                         .chain(Network::Bitcoin)
 739                         .build()
 740                         .unwrap();
 741                 assert!(offer.supports_chain(mainnet));
 742                 assert_eq!(offer.chains(), vec![mainnet]);
 743                 assert_eq!(offer.as_tlv_stream().chains, None);
 744
 745                 let offer = OfferBuilder::new("foo".into(), pubkey(42))
 746                         .chain(Network::Testnet)
 747                         .build()
 748                         .unwrap();
 749                 assert!(offer.supports_chain(testnet));
 750                 assert_eq!(offer.chains(), vec![testnet]);
 751                 assert_eq!(offer.as_tlv_stream().chains, Some(&vec![testnet]));
 752
 753                 let offer = OfferBuilder::new("foo".into(), pubkey(42))
 754                         .chain(Network::Testnet)
 755                         .chain(Network::Testnet)
 756                         .build()
 757                         .unwrap();
 758                 assert!(offer.supports_chain(testnet));
 759                 assert_eq!(offer.chains(), vec![testnet]);
 760                 assert_eq!(offer.as_tlv_stream().chains, Some(&vec![testnet]));
 761
 762                 let offer = OfferBuilder::new("foo".into(), pubkey(42))
 763                         .chain(Network::Bitcoin)
 764                         .chain(Network::Testnet)
 765                         .build()
 766                         .unwrap();
 767                 assert!(offer.supports_chain(mainnet));
 768                 assert!(offer.supports_chain(testnet));
 769                 assert_eq!(offer.chains(), vec![mainnet, testnet]);
 770                 assert_eq!(offer.as_tlv_stream().chains, Some(&vec![mainnet, testnet]));
 771         }
 772
 773         #[test]
 774         fn builds_offer_with_metadata() {
 775                 let offer = OfferBuilder::new("foo".into(), pubkey(42))
 776                         .metadata(vec![42; 32])
 777                         .build()
 778                         .unwrap();
 779                 assert_eq!(offer.metadata(), Some(&vec![42; 32]));
 780                 assert_eq!(offer.as_tlv_stream().metadata, Some(&vec![42; 32]));
 781
 782                 let offer = OfferBuilder::new("foo".into(), pubkey(42))
 783                         .metadata(vec![42; 32])
 784                         .metadata(vec![43; 32])
 785                         .build()
 786                         .unwrap();
 787                 assert_eq!(offer.metadata(), Some(&vec![43; 32]));
 788                 assert_eq!(offer.as_tlv_stream().metadata, Some(&vec![43; 32]));
 789         }
 790
 791         #[test]
 792         fn builds_offer_with_amount() {
 793                 let bitcoin_amount = Amount::Bitcoin { amount_msats: 1000 };
 794                 let currency_amount = Amount::Currency { iso4217_code: *b"USD", amount: 10 };
 795
 796                 let offer = OfferBuilder::new("foo".into(), pubkey(42))
 797                         .amount_msats(1000)
 798                         .build()
 799                         .unwrap();
 800                 let tlv_stream = offer.as_tlv_stream();
 801                 assert_eq!(offer.amount(), Some(&bitcoin_amount));
 802                 assert_eq!(tlv_stream.amount, Some(1000));
 803                 assert_eq!(tlv_stream.currency, None);
 804
 805                 let builder = OfferBuilder::new("foo".into(), pubkey(42))
 806                         .amount(currency_amount.clone());
 807                 let tlv_stream = builder.offer.as_tlv_stream();
 808                 assert_eq!(builder.offer.amount, Some(currency_amount.clone()));
 809                 assert_eq!(tlv_stream.amount, Some(10));
 810                 assert_eq!(tlv_stream.currency, Some(b"USD"));
 811                 match builder.build() {
 812                         Ok(_) => panic!("expected error"),
 813                         Err(e) => assert_eq!(e, SemanticError::UnsupportedCurrency),
 814                 }
 815
 816                 let offer = OfferBuilder::new("foo".into(), pubkey(42))
 817                         .amount(currency_amount.clone())
 818                         .amount(bitcoin_amount.clone())
 819                         .build()
 820                         .unwrap();
 821                 let tlv_stream = offer.as_tlv_stream();
 822                 assert_eq!(tlv_stream.amount, Some(1000));
 823                 assert_eq!(tlv_stream.currency, None);
 824
 825                 let invalid_amount = Amount::Bitcoin { amount_msats: MAX_VALUE_MSAT + 1 };
 826                 match OfferBuilder::new("foo".into(), pubkey(42)).amount(invalid_amount).build() {
 827                         Ok(_) => panic!("expected error"),
 828                         Err(e) => assert_eq!(e, SemanticError::InvalidAmount),
 829                 }
 830         }
 831
 832         #[test]
 833         fn builds_offer_with_features() {
 834                 let offer = OfferBuilder::new("foo".into(), pubkey(42))
 835                         .features_unchecked(OfferFeatures::unknown())
 836                         .build()
 837                         .unwrap();
 838                 assert_eq!(offer.features(), &OfferFeatures::unknown());
 839                 assert_eq!(offer.as_tlv_stream().features, Some(&OfferFeatures::unknown()));
 840
 841                 let offer = OfferBuilder::new("foo".into(), pubkey(42))
 842                         .features_unchecked(OfferFeatures::unknown())
 843                         .features_unchecked(OfferFeatures::empty())
 844                         .build()
 845                         .unwrap();
 846                 assert_eq!(offer.features(), &OfferFeatures::empty());
 847                 assert_eq!(offer.as_tlv_stream().features, None);
 848         }
 849
 850         #[test]
 851         fn builds_offer_with_absolute_expiry() {
 852                 let future_expiry = Duration::from_secs(u64::max_value());
 853                 let past_expiry = Duration::from_secs(0);
 854
 855                 let offer = OfferBuilder::new("foo".into(), pubkey(42))
 856                         .absolute_expiry(future_expiry)
 857                         .build()
 858                         .unwrap();
 859                 #[cfg(feature = "std")]
 860                 assert!(!offer.is_expired());
 861                 assert_eq!(offer.absolute_expiry(), Some(future_expiry));
 862                 assert_eq!(offer.as_tlv_stream().absolute_expiry, Some(future_expiry.as_secs()));
 863
 864                 let offer = OfferBuilder::new("foo".into(), pubkey(42))
 865                         .absolute_expiry(future_expiry)
 866                         .absolute_expiry(past_expiry)
 867                         .build()
 868                         .unwrap();
 869                 #[cfg(feature = "std")]
 870                 assert!(offer.is_expired());
 871                 assert_eq!(offer.absolute_expiry(), Some(past_expiry));
 872                 assert_eq!(offer.as_tlv_stream().absolute_expiry, Some(past_expiry.as_secs()));
 873         }
 874
 875         #[test]
 876         fn builds_offer_with_paths() {
 877                 let paths = vec![
 878                         BlindedPath {
 879                                 introduction_node_id: pubkey(40),
 880                                 blinding_point: pubkey(41),
 881                                 blinded_hops: vec![
 882                                         BlindedHop { blinded_node_id: pubkey(43), encrypted_payload: vec![0; 43] },
 883                                         BlindedHop { blinded_node_id: pubkey(44), encrypted_payload: vec![0; 44] },
 884                                 ],
 885                         },
 886                         BlindedPath {
 887                                 introduction_node_id: pubkey(40),
 888                                 blinding_point: pubkey(41),
 889                                 blinded_hops: vec![
 890                                         BlindedHop { blinded_node_id: pubkey(45), encrypted_payload: vec![0; 45] },
 891                                         BlindedHop { blinded_node_id: pubkey(46), encrypted_payload: vec![0; 46] },
 892                                 ],
 893                         },
 894                 ];
 895
 896                 let offer = OfferBuilder::new("foo".into(), pubkey(42))
 897                         .path(paths[0].clone())
 898                         .path(paths[1].clone())
 899                         .build()
 900                         .unwrap();
 901                 let tlv_stream = offer.as_tlv_stream();
 902                 assert_eq!(offer.paths(), paths.as_slice());
 903                 assert_eq!(offer.signing_pubkey(), pubkey(42));
 904                 assert_ne!(pubkey(42), pubkey(44));
 905                 assert_eq!(tlv_stream.paths, Some(&paths));
 906                 assert_eq!(tlv_stream.node_id, Some(&pubkey(42)));
 907         }
 908
 909         #[test]
 910         fn builds_offer_with_issuer() {
 911                 let offer = OfferBuilder::new("foo".into(), pubkey(42))
 912                         .issuer("bar".into())
 913                         .build()
 914                         .unwrap();
 915                 assert_eq!(offer.issuer(), Some(PrintableString("bar")));
 916                 assert_eq!(offer.as_tlv_stream().issuer, Some(&String::from("bar")));
 917
 918                 let offer = OfferBuilder::new("foo".into(), pubkey(42))
 919                         .issuer("bar".into())
 920                         .issuer("baz".into())
 921                         .build()
 922                         .unwrap();
 923                 assert_eq!(offer.issuer(), Some(PrintableString("baz")));
 924                 assert_eq!(offer.as_tlv_stream().issuer, Some(&String::from("baz")));
 925         }
 926
 927         #[test]
 928         fn builds_offer_with_supported_quantity() {
 929                 let one = NonZeroU64::new(1).unwrap();
 930                 let ten = NonZeroU64::new(10).unwrap();
 931
 932                 let offer = OfferBuilder::new("foo".into(), pubkey(42))
 933                         .supported_quantity(Quantity::One)
 934                         .build()
 935                         .unwrap();
 936                 let tlv_stream = offer.as_tlv_stream();
 937                 assert_eq!(offer.supported_quantity(), Quantity::One);
 938                 assert_eq!(tlv_stream.quantity_max, None);
 939
 940                 let offer = OfferBuilder::new("foo".into(), pubkey(42))
 941                         .supported_quantity(Quantity::Unbounded)
 942                         .build()
 943                         .unwrap();
 944                 let tlv_stream = offer.as_tlv_stream();
 945                 assert_eq!(offer.supported_quantity(), Quantity::Unbounded);
 946                 assert_eq!(tlv_stream.quantity_max, Some(0));
 947
 948                 let offer = OfferBuilder::new("foo".into(), pubkey(42))
 949                         .supported_quantity(Quantity::Bounded(ten))
 950                         .build()
 951                         .unwrap();
 952                 let tlv_stream = offer.as_tlv_stream();
 953                 assert_eq!(offer.supported_quantity(), Quantity::Bounded(ten));
 954                 assert_eq!(tlv_stream.quantity_max, Some(10));
 955
 956                 let offer = OfferBuilder::new("foo".into(), pubkey(42))
 957                         .supported_quantity(Quantity::Bounded(one))
 958                         .build()
 959                         .unwrap();
 960                 let tlv_stream = offer.as_tlv_stream();
 961                 assert_eq!(offer.supported_quantity(), Quantity::Bounded(one));
 962                 assert_eq!(tlv_stream.quantity_max, Some(1));
 963
 964                 let offer = OfferBuilder::new("foo".into(), pubkey(42))
 965                         .supported_quantity(Quantity::Bounded(ten))
 966                         .supported_quantity(Quantity::One)
 967                         .build()
 968                         .unwrap();
 969                 let tlv_stream = offer.as_tlv_stream();
 970                 assert_eq!(offer.supported_quantity(), Quantity::One);
 971                 assert_eq!(tlv_stream.quantity_max, None);
 972         }
 973
 974         #[test]
 975         fn fails_requesting_invoice_with_unknown_required_features() {
 976                 match OfferBuilder::new("foo".into(), pubkey(42))
 977                         .features_unchecked(OfferFeatures::unknown())
 978                         .build().unwrap()
 979                         .request_invoice(vec![1; 32], pubkey(43))
 980                 {
 981                         Ok(_) => panic!("expected error"),
 982                         Err(e) => assert_eq!(e, SemanticError::UnknownRequiredFeatures),
 983                 }
 984         }
 985
 986         #[test]
 987         fn parses_offer_with_chains() {
 988                 let offer = OfferBuilder::new("foo".into(), pubkey(42))
 989                         .chain(Network::Bitcoin)
 990                         .chain(Network::Testnet)
 991                         .build()
 992                         .unwrap();
 993                 if let Err(e) = offer.to_string().parse::<Offer>() {
 994                         panic!("error parsing offer: {:?}", e);
 995                 }
 996         }
 997
 998         #[test]
 999         fn parses_offer_with_amount() {
1000                 let offer = OfferBuilder::new("foo".into(), pubkey(42))
1001                         .amount(Amount::Bitcoin { amount_msats: 1000 })
1002                         .build()
1003                         .unwrap();
1004                 if let Err(e) = offer.to_string().parse::<Offer>() {
1005                         panic!("error parsing offer: {:?}", e);
1006                 }
1007
1008                 let mut tlv_stream = offer.as_tlv_stream();
1009                 tlv_stream.amount = Some(1000);
1010                 tlv_stream.currency = Some(b"USD");
1011
1012                 let mut encoded_offer = Vec::new();
1013                 tlv_stream.write(&mut encoded_offer).unwrap();
1014
1015                 if let Err(e) = Offer::try_from(encoded_offer) {
1016                         panic!("error parsing offer: {:?}", e);
1017                 }
1018
1019                 let mut tlv_stream = offer.as_tlv_stream();
1020                 tlv_stream.amount = None;
1021                 tlv_stream.currency = Some(b"USD");
1022
1023                 let mut encoded_offer = Vec::new();
1024                 tlv_stream.write(&mut encoded_offer).unwrap();
1025
1026                 match Offer::try_from(encoded_offer) {
1027                         Ok(_) => panic!("expected error"),
1028                         Err(e) => assert_eq!(e, ParseError::InvalidSemantics(SemanticError::MissingAmount)),
1029                 }
1030
1031                 let mut tlv_stream = offer.as_tlv_stream();
1032                 tlv_stream.amount = Some(MAX_VALUE_MSAT + 1);
1033                 tlv_stream.currency = None;
1034
1035                 let mut encoded_offer = Vec::new();
1036                 tlv_stream.write(&mut encoded_offer).unwrap();
1037
1038                 match Offer::try_from(encoded_offer) {
1039                         Ok(_) => panic!("expected error"),
1040                         Err(e) => assert_eq!(e, ParseError::InvalidSemantics(SemanticError::InvalidAmount)),
1041                 }
1042         }
1043
1044         #[test]
1045         fn parses_offer_with_description() {
1046                 let offer = OfferBuilder::new("foo".into(), pubkey(42)).build().unwrap();
1047                 if let Err(e) = offer.to_string().parse::<Offer>() {
1048                         panic!("error parsing offer: {:?}", e);
1049                 }
1050
1051                 let mut tlv_stream = offer.as_tlv_stream();
1052                 tlv_stream.description = None;
1053
1054                 let mut encoded_offer = Vec::new();
1055                 tlv_stream.write(&mut encoded_offer).unwrap();
1056
1057                 match Offer::try_from(encoded_offer) {
1058                         Ok(_) => panic!("expected error"),
1059                         Err(e) => {
1060                                 assert_eq!(e, ParseError::InvalidSemantics(SemanticError::MissingDescription));
1061                         },
1062                 }
1063         }
1064
1065         #[test]
1066         fn parses_offer_with_paths() {
1067                 let offer = OfferBuilder::new("foo".into(), pubkey(42))
1068                         .path(BlindedPath {
1069                                 introduction_node_id: pubkey(40),
1070                                 blinding_point: pubkey(41),
1071                                 blinded_hops: vec![
1072                                         BlindedHop { blinded_node_id: pubkey(43), encrypted_payload: vec![0; 43] },
1073                                         BlindedHop { blinded_node_id: pubkey(44), encrypted_payload: vec![0; 44] },
1074                                 ],
1075                         })
1076                         .path(BlindedPath {
1077                                 introduction_node_id: pubkey(40),
1078                                 blinding_point: pubkey(41),
1079                                 blinded_hops: vec![
1080                                         BlindedHop { blinded_node_id: pubkey(45), encrypted_payload: vec![0; 45] },
1081                                         BlindedHop { blinded_node_id: pubkey(46), encrypted_payload: vec![0; 46] },
1082                                 ],
1083                         })
1084                         .build()
1085                         .unwrap();
1086                 if let Err(e) = offer.to_string().parse::<Offer>() {
1087                         panic!("error parsing offer: {:?}", e);
1088                 }
1089
1090                 let mut builder = OfferBuilder::new("foo".into(), pubkey(42));
1091                 builder.offer.paths = Some(vec![]);
1092
1093                 let offer = builder.build().unwrap();
1094                 if let Err(e) = offer.to_string().parse::<Offer>() {
1095                         panic!("error parsing offer: {:?}", e);
1096                 }
1097         }
1098
1099         #[test]
1100         fn parses_offer_with_quantity() {
1101                 let offer = OfferBuilder::new("foo".into(), pubkey(42))
1102                         .supported_quantity(Quantity::One)
1103                         .build()
1104                         .unwrap();
1105                 if let Err(e) = offer.to_string().parse::<Offer>() {
1106                         panic!("error parsing offer: {:?}", e);
1107                 }
1108
1109                 let offer = OfferBuilder::new("foo".into(), pubkey(42))
1110                         .supported_quantity(Quantity::Unbounded)
1111                         .build()
1112                         .unwrap();
1113                 if let Err(e) = offer.to_string().parse::<Offer>() {
1114                         panic!("error parsing offer: {:?}", e);
1115                 }
1116
1117                 let offer = OfferBuilder::new("foo".into(), pubkey(42))
1118                         .supported_quantity(Quantity::Bounded(NonZeroU64::new(10).unwrap()))
1119                         .build()
1120                         .unwrap();
1121                 if let Err(e) = offer.to_string().parse::<Offer>() {
1122                         panic!("error parsing offer: {:?}", e);
1123                 }
1124
1125                 let offer = OfferBuilder::new("foo".into(), pubkey(42))
1126                         .supported_quantity(Quantity::Bounded(NonZeroU64::new(1).unwrap()))
1127                         .build()
1128                         .unwrap();
1129                 if let Err(e) = offer.to_string().parse::<Offer>() {
1130                         panic!("error parsing offer: {:?}", e);
1131                 }
1132         }
1133
1134         #[test]
1135         fn parses_offer_with_node_id() {
1136                 let offer = OfferBuilder::new("foo".into(), pubkey(42)).build().unwrap();
1137                 if let Err(e) = offer.to_string().parse::<Offer>() {
1138                         panic!("error parsing offer: {:?}", e);
1139                 }
1140
1141                 let mut tlv_stream = offer.as_tlv_stream();
1142                 tlv_stream.node_id = None;
1143
1144                 let mut encoded_offer = Vec::new();
1145                 tlv_stream.write(&mut encoded_offer).unwrap();
1146
1147                 match Offer::try_from(encoded_offer) {
1148                         Ok(_) => panic!("expected error"),
1149                         Err(e) => {
1150                                 assert_eq!(e, ParseError::InvalidSemantics(SemanticError::MissingSigningPubkey));
1151                         },
1152                 }
1153         }
1154
1155         #[test]
1156         fn fails_parsing_offer_with_extra_tlv_records() {
1157                 let offer = OfferBuilder::new("foo".into(), pubkey(42)).build().unwrap();
1158
1159                 let mut encoded_offer = Vec::new();
1160                 offer.write(&mut encoded_offer).unwrap();
1161                 BigSize(80).write(&mut encoded_offer).unwrap();
1162                 BigSize(32).write(&mut encoded_offer).unwrap();
1163                 [42u8; 32].write(&mut encoded_offer).unwrap();
1164
1165                 match Offer::try_from(encoded_offer) {
1166                         Ok(_) => panic!("expected error"),
1167                         Err(e) => assert_eq!(e, ParseError::Decode(DecodeError::InvalidValue)),
1168                 }
1169         }
1170 }
1171
1172 #[cfg(test)]
1173 mod bech32_tests {
1174         use super::{Offer, ParseError};
1175         use bitcoin::bech32;
1176         use crate::ln::msgs::DecodeError;
1177
1178         // TODO: Remove once test vectors are updated.
1179         #[ignore]
1180         #[test]
1181         fn encodes_offer_as_bech32_without_checksum() {
1182                 let encoded_offer = "lno1qcp4256ypqpq86q2pucnq42ngssx2an9wfujqerp0y2pqun4wd68jtn00fkxzcnn9ehhyec6qgqsz83qfwdpl28qqmc78ymlvhmxcsywdk5wrjnj36jryg488qwlrnzyjczlqsp9nyu4phcg6dqhlhzgxagfu7zh3d9re0sqp9ts2yfugvnnm9gxkcnnnkdpa084a6t520h5zhkxsdnghvpukvd43lastpwuh73k29qsy";
1183                 let offer = dbg!(encoded_offer.parse::<Offer>().unwrap());
1184                 let reencoded_offer = offer.to_string();
1185                 dbg!(reencoded_offer.parse::<Offer>().unwrap());
1186                 assert_eq!(reencoded_offer, encoded_offer);
1187         }
1188
1189         // TODO: Remove once test vectors are updated.
1190         #[ignore]
1191         #[test]
1192         fn parses_bech32_encoded_offers() {
1193                 let offers = [
1194                         // BOLT 12 test vectors
1195                         "lno1qcp4256ypqpq86q2pucnq42ngssx2an9wfujqerp0y2pqun4wd68jtn00fkxzcnn9ehhyec6qgqsz83qfwdpl28qqmc78ymlvhmxcsywdk5wrjnj36jryg488qwlrnzyjczlqsp9nyu4phcg6dqhlhzgxagfu7zh3d9re0sqp9ts2yfugvnnm9gxkcnnnkdpa084a6t520h5zhkxsdnghvpukvd43lastpwuh73k29qsy",
1196                         "l+no1qcp4256ypqpq86q2pucnq42ngssx2an9wfujqerp0y2pqun4wd68jtn00fkxzcnn9ehhyec6qgqsz83qfwdpl28qqmc78ymlvhmxcsywdk5wrjnj36jryg488qwlrnzyjczlqsp9nyu4phcg6dqhlhzgxagfu7zh3d9re0sqp9ts2yfugvnnm9gxkcnnnkdpa084a6t520h5zhkxsdnghvpukvd43lastpwuh73k29qsy",
1197                         "l+no1qcp4256ypqpq86q2pucnq42ngssx2an9wfujqerp0y2pqun4wd68jtn00fkxzcnn9ehhyec6qgqsz83qfwdpl28qqmc78ymlvhmxcsywdk5wrjnj36jryg488qwlrnzyjczlqsp9nyu4phcg6dqhlhzgxagfu7zh3d9re0sqp9ts2yfugvnnm9gxkcnnnkdpa084a6t520h5zhkxsdnghvpukvd43lastpwuh73k29qsy",
1198                         "lno1qcp4256ypqpq+86q2pucnq42ngssx2an9wfujqerp0y2pqun4wd68jtn0+0fkxzcnn9ehhyec6qgqsz83qfwdpl28qqmc78ymlvhmxcsywdk5wrjnj36jryg488qwlrnzyjczlqsp9nyu4phcg6dqhlhzgxagfu7zh3d9re0+sqp9ts2yfugvnnm9gxkcnnnkdpa084a6t520h5zhkxsdnghvpukvd43lastpwuh73k29qs+y",
1199                         "lno1qcp4256ypqpq+ 86q2pucnq42ngssx2an9wfujqerp0y2pqun4wd68jtn0+  0fkxzcnn9ehhyec6qgqsz83qfwdpl28qqmc78ymlvhmxcsywdk5wrjnj36jryg488qwlrnzyjczlqsp9nyu4phcg6dqhlhzgxagfu7zh3d9re0+\nsqp9ts2yfugvnnm9gxkcnnnkdpa084a6t520h5zhkxsdnghvpukvd43l+\r\nastpwuh73k29qs+\r  y",
1200                         // Two blinded paths
1201                         "lno1qcp4256ypqpq86q2pucnq42ngssx2an9wfujqerp0yg06qg2qdd7t628sgykwj5kuc837qmlv9m9gr7sq8ap6erfgacv26nhp8zzcqgzhdvttlk22pw8fmwqqrvzst792mj35ypylj886ljkcmug03wg6heqqsqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqq6muh550qsfva9fdes0ruph7ctk2s8aqq06r4jxj3msc448wzwy9sqs9w6ckhlv55zuwnkuqqxc9qhu24h9rggzflyw04l9d3hcslzu340jqpqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqq2pqun4wd68jtn00fkxzcnn9ehhyec6qgqsz83qfwdpl28qqmc78ymlvhmxcsywdk5wrjnj36jryg488qwlrnzyjczlqsp9nyu4phcg6dqhlhzgxagfu7zh3d9re0sqp9ts2yfugvnnm9gxkcnnnkdpa084a6t520h5zhkxsdnghvpukvd43lastpwuh73k29qsy",
1202                 ];
1203                 for encoded_offer in &offers {
1204                         if let Err(e) = encoded_offer.parse::<Offer>() {
1205                                 panic!("Invalid offer ({:?}): {}", e, encoded_offer);
1206                         }
1207                 }
1208         }
1209
1210         #[test]
1211         fn fails_parsing_bech32_encoded_offers_with_invalid_continuations() {
1212                 let offers = [
1213                         // BOLT 12 test vectors
1214                         "lno1qcp4256ypqpq86q2pucnq42ngssx2an9wfujqerp0y2pqun4wd68jtn00fkxzcnn9ehhyec6qgqsz83qfwdpl28qqmc78ymlvhmxcsywdk5wrjnj36jryg488qwlrnzyjczlqsp9nyu4phcg6dqhlhzgxagfu7zh3d9re0sqp9ts2yfugvnnm9gxkcnnnkdpa084a6t520h5zhkxsdnghvpukvd43lastpwuh73k29qsy+",
1215                         "lno1qcp4256ypqpq86q2pucnq42ngssx2an9wfujqerp0y2pqun4wd68jtn00fkxzcnn9ehhyec6qgqsz83qfwdpl28qqmc78ymlvhmxcsywdk5wrjnj36jryg488qwlrnzyjczlqsp9nyu4phcg6dqhlhzgxagfu7zh3d9re0sqp9ts2yfugvnnm9gxkcnnnkdpa084a6t520h5zhkxsdnghvpukvd43lastpwuh73k29qsy+ ",
1216                         "+lno1qcp4256ypqpq86q2pucnq42ngssx2an9wfujqerp0y2pqun4wd68jtn00fkxzcnn9ehhyec6qgqsz83qfwdpl28qqmc78ymlvhmxcsywdk5wrjnj36jryg488qwlrnzyjczlqsp9nyu4phcg6dqhlhzgxagfu7zh3d9re0sqp9ts2yfugvnnm9gxkcnnnkdpa084a6t520h5zhkxsdnghvpukvd43lastpwuh73k29qsy",
1217                         "+ lno1qcp4256ypqpq86q2pucnq42ngssx2an9wfujqerp0y2pqun4wd68jtn00fkxzcnn9ehhyec6qgqsz83qfwdpl28qqmc78ymlvhmxcsywdk5wrjnj36jryg488qwlrnzyjczlqsp9nyu4phcg6dqhlhzgxagfu7zh3d9re0sqp9ts2yfugvnnm9gxkcnnnkdpa084a6t520h5zhkxsdnghvpukvd43lastpwuh73k29qsy",
1218                         "ln++o1qcp4256ypqpq86q2pucnq42ngssx2an9wfujqerp0y2pqun4wd68jtn00fkxzcnn9ehhyec6qgqsz83qfwdpl28qqmc78ymlvhmxcsywdk5wrjnj36jryg488qwlrnzyjczlqsp9nyu4phcg6dqhlhzgxagfu7zh3d9re0sqp9ts2yfugvnnm9gxkcnnnkdpa084a6t520h5zhkxsdnghvpukvd43lastpwuh73k29qsy",
1219                 ];
1220                 for encoded_offer in &offers {
1221                         match encoded_offer.parse::<Offer>() {
1222                                 Ok(_) => panic!("Valid offer: {}", encoded_offer),
1223                                 Err(e) => assert_eq!(e, ParseError::InvalidContinuation),
1224                         }
1225                 }
1226
1227         }
1228
1229         #[test]
1230         fn fails_parsing_bech32_encoded_offer_with_invalid_hrp() {
1231                 let encoded_offer = "lni1qcp4256ypqpq86q2pucnq42ngssx2an9wfujqerp0y2pqun4wd68jtn00fkxzcnn9ehhyec6qgqsz83qfwdpl28qqmc78ymlvhmxcsywdk5wrjnj36jryg488qwlrnzyjczlqsp9nyu4phcg6dqhlhzgxagfu7zh3d9re0sqp9ts2yfugvnnm9gxkcnnnkdpa084a6t520h5zhkxsdnghvpukvd43lastpwuh73k29qsy";
1232                 match encoded_offer.parse::<Offer>() {
1233                         Ok(_) => panic!("Valid offer: {}", encoded_offer),
1234                         Err(e) => assert_eq!(e, ParseError::InvalidBech32Hrp),
1235                 }
1236         }
1237
1238         #[test]
1239         fn fails_parsing_bech32_encoded_offer_with_invalid_bech32_data() {
1240                 let encoded_offer = "lno1qcp4256ypqpq86q2pucnq42ngssx2an9wfujqerp0y2pqun4wd68jtn00fkxzcnn9ehhyec6qgqsz83qfwdpl28qqmc78ymlvhmxcsywdk5wrjnj36jryg488qwlrnzyjczlqsp9nyu4phcg6dqhlhzgxagfu7zh3d9re0sqp9ts2yfugvnnm9gxkcnnnkdpa084a6t520h5zhkxsdnghvpukvd43lastpwuh73k29qso";
1241                 match encoded_offer.parse::<Offer>() {
1242                         Ok(_) => panic!("Valid offer: {}", encoded_offer),
1243                         Err(e) => assert_eq!(e, ParseError::Bech32(bech32::Error::InvalidChar('o'))),
1244                 }
1245         }
1246
1247         #[test]
1248         fn fails_parsing_bech32_encoded_offer_with_invalid_tlv_data() {
1249                 let encoded_offer = "lno1qcp4256ypqpq86q2pucnq42ngssx2an9wfujqerp0y2pqun4wd68jtn00fkxzcnn9ehhyec6qgqsz83qfwdpl28qqmc78ymlvhmxcsywdk5wrjnj36jryg488qwlrnzyjczlqsp9nyu4phcg6dqhlhzgxagfu7zh3d9re0sqp9ts2yfugvnnm9gxkcnnnkdpa084a6t520h5zhkxsdnghvpukvd43lastpwuh73k29qsyqqqqq";
1250                 match encoded_offer.parse::<Offer>() {
1251                         Ok(_) => panic!("Valid offer: {}", encoded_offer),
1252                         Err(e) => assert_eq!(e, ParseError::Decode(DecodeError::InvalidValue)),
1253                 }
1254         }
1255 }