_ 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 //! ```
  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, PartialEq)]
 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, PartialEq)]
 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.checked_mul(quantity.unwrap_or(1))
 435                                 .ok_or(SemanticError::InvalidAmount)?;
 436                         let amount_msats = amount_msats.unwrap_or(expected_amount_msats);
 437
 438                         if amount_msats < expected_amount_msats {
 439                                 return Err(SemanticError::InsufficientAmount);
 440                         }
 441
 442                         if amount_msats > MAX_VALUE_MSAT {
 443                                 return Err(SemanticError::InvalidAmount);
 444                         }
 445                 }
 446
 447                 Ok(())
 448         }
 449
 450         pub fn supported_quantity(&self) -> Quantity {
 451                 self.supported_quantity
 452         }
 453
 454         pub(super) fn check_quantity(&self, quantity: Option<u64>) -> Result<(), SemanticError> {
 455                 let expects_quantity = self.expects_quantity();
 456                 match quantity {
 457                         None if expects_quantity => Err(SemanticError::MissingQuantity),
 458                         Some(_) if !expects_quantity => Err(SemanticError::UnexpectedQuantity),
 459                         Some(quantity) if !self.is_valid_quantity(quantity) => {
 460                                 Err(SemanticError::InvalidQuantity)
 461                         },
 462                         _ => Ok(()),
 463                 }
 464         }
 465
 466         fn is_valid_quantity(&self, quantity: u64) -> bool {
 467                 match self.supported_quantity {
 468                         Quantity::Bounded(n) => quantity <= n.get(),
 469                         Quantity::Unbounded => quantity > 0,
 470                         Quantity::One => quantity == 1,
 471                 }
 472         }
 473
 474         fn expects_quantity(&self) -> bool {
 475                 match self.supported_quantity {
 476                         Quantity::Bounded(_) => true,
 477                         Quantity::Unbounded => true,
 478                         Quantity::One => false,
 479                 }
 480         }
 481
 482         pub(super) fn signing_pubkey(&self) -> PublicKey {
 483                 self.signing_pubkey
 484         }
 485
 486         pub(super) fn as_tlv_stream(&self) -> OfferTlvStreamRef {
 487                 let (currency, amount) = match &self.amount {
 488                         None => (None, None),
 489                         Some(Amount::Bitcoin { amount_msats }) => (None, Some(*amount_msats)),
 490                         Some(Amount::Currency { iso4217_code, amount }) => (
 491                                 Some(iso4217_code), Some(*amount)
 492                         ),
 493                 };
 494
 495                 let features = {
 496                         if self.features == OfferFeatures::empty() { None } else { Some(&self.features) }
 497                 };
 498
 499                 OfferTlvStreamRef {
 500                         chains: self.chains.as_ref(),
 501                         metadata: self.metadata.as_ref(),
 502                         currency,
 503                         amount,
 504                         description: Some(&self.description),
 505                         features,
 506                         absolute_expiry: self.absolute_expiry.map(|duration| duration.as_secs()),
 507                         paths: self.paths.as_ref(),
 508                         issuer: self.issuer.as_ref(),
 509                         quantity_max: self.supported_quantity.to_tlv_record(),
 510                         node_id: Some(&self.signing_pubkey),
 511                 }
 512         }
 513 }
 514
 515 impl Writeable for Offer {
 516         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
 517                 WithoutLength(&self.bytes).write(writer)
 518         }
 519 }
 520
 521 impl Writeable for OfferContents {
 522         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
 523                 self.as_tlv_stream().write(writer)
 524         }
 525 }
 526
 527 /// The minimum amount required for an item in an [`Offer`], denominated in either bitcoin or
 528 /// another currency.
 529 #[derive(Clone, Debug, PartialEq)]
 530 pub enum Amount {
 531         /// An amount of bitcoin.
 532         Bitcoin {
 533                 /// The amount in millisatoshi.
 534                 amount_msats: u64,
 535         },
 536         /// An amount of currency specified using ISO 4712.
 537         Currency {
 538                 /// The currency that the amount is denominated in.
 539                 iso4217_code: CurrencyCode,
 540                 /// The amount in the currency unit adjusted by the ISO 4712 exponent (e.g., USD cents).
 541                 amount: u64,
 542         },
 543 }
 544
 545 /// An ISO 4712 three-letter currency code (e.g., USD).
 546 pub type CurrencyCode = [u8; 3];
 547
 548 /// Quantity of items supported by an [`Offer`].
 549 #[derive(Clone, Copy, Debug, PartialEq)]
 550 pub enum Quantity {
 551         /// Up to a specific number of items (inclusive). Use when more than one item can be requested
 552         /// but is limited (e.g., because of per customer or inventory limits).
 553         ///
 554         /// May be used with `NonZeroU64::new(1)` but prefer to use [`Quantity::One`] if only one item
 555         /// is supported.
 556         Bounded(NonZeroU64),
 557         /// One or more items. Use when more than one item can be requested without any limit.
 558         Unbounded,
 559         /// Only one item. Use when only a single item can be requested.
 560         One,
 561 }
 562
 563 impl Quantity {
 564         fn to_tlv_record(&self) -> Option<u64> {
 565                 match self {
 566                         Quantity::Bounded(n) => Some(n.get()),
 567                         Quantity::Unbounded => Some(0),
 568                         Quantity::One => None,
 569                 }
 570         }
 571 }
 572
 573 tlv_stream!(OfferTlvStream, OfferTlvStreamRef, 1..80, {
 574         (2, chains: (Vec<ChainHash>, WithoutLength)),
 575         (4, metadata: (Vec<u8>, WithoutLength)),
 576         (6, currency: CurrencyCode),
 577         (8, amount: (u64, HighZeroBytesDroppedBigSize)),
 578         (10, description: (String, WithoutLength)),
 579         (12, features: (OfferFeatures, WithoutLength)),
 580         (14, absolute_expiry: (u64, HighZeroBytesDroppedBigSize)),
 581         (16, paths: (Vec<BlindedPath>, WithoutLength)),
 582         (18, issuer: (String, WithoutLength)),
 583         (20, quantity_max: (u64, HighZeroBytesDroppedBigSize)),
 584         (22, node_id: PublicKey),
 585 });
 586
 587 impl Bech32Encode for Offer {
 588         const BECH32_HRP: &'static str = "lno";
 589 }
 590
 591 impl FromStr for Offer {
 592         type Err = ParseError;
 593
 594         fn from_str(s: &str) -> Result<Self, <Self as FromStr>::Err> {
 595                 Self::from_bech32_str(s)
 596         }
 597 }
 598
 599 impl TryFrom<Vec<u8>> for Offer {
 600         type Error = ParseError;
 601
 602         fn try_from(bytes: Vec<u8>) -> Result<Self, Self::Error> {
 603                 let offer = ParsedMessage::<OfferTlvStream>::try_from(bytes)?;
 604                 let ParsedMessage { bytes, tlv_stream } = offer;
 605                 let contents = OfferContents::try_from(tlv_stream)?;
 606                 Ok(Offer { bytes, contents })
 607         }
 608 }
 609
 610 impl TryFrom<OfferTlvStream> for OfferContents {
 611         type Error = SemanticError;
 612
 613         fn try_from(tlv_stream: OfferTlvStream) -> Result<Self, Self::Error> {
 614                 let OfferTlvStream {
 615                         chains, metadata, currency, amount, description, features, absolute_expiry, paths,
 616                         issuer, quantity_max, node_id,
 617                 } = tlv_stream;
 618
 619                 let amount = match (currency, amount) {
 620                         (None, None) => None,
 621                         (None, Some(amount_msats)) if amount_msats > MAX_VALUE_MSAT => {
 622                                 return Err(SemanticError::InvalidAmount);
 623                         },
 624                         (None, Some(amount_msats)) => Some(Amount::Bitcoin { amount_msats }),
 625                         (Some(_), None) => return Err(SemanticError::MissingAmount),
 626                         (Some(iso4217_code), Some(amount)) => Some(Amount::Currency { iso4217_code, amount }),
 627                 };
 628
 629                 let description = match description {
 630                         None => return Err(SemanticError::MissingDescription),
 631                         Some(description) => description,
 632                 };
 633
 634                 let features = features.unwrap_or_else(OfferFeatures::empty);
 635
 636                 let absolute_expiry = absolute_expiry
 637                         .map(|seconds_from_epoch| Duration::from_secs(seconds_from_epoch));
 638
 639                 let supported_quantity = match quantity_max {
 640                         None => Quantity::One,
 641                         Some(0) => Quantity::Unbounded,
 642                         Some(n) => Quantity::Bounded(NonZeroU64::new(n).unwrap()),
 643                 };
 644
 645                 let signing_pubkey = match node_id {
 646                         None => return Err(SemanticError::MissingSigningPubkey),
 647                         Some(node_id) => node_id,
 648                 };
 649
 650                 Ok(OfferContents {
 651                         chains, metadata, amount, description, features, absolute_expiry, issuer, paths,
 652                         supported_quantity, signing_pubkey,
 653                 })
 654         }
 655 }
 656
 657 impl core::fmt::Display for Offer {
 658         fn fmt(&self, f: &mut core::fmt::Formatter) -> Result<(), core::fmt::Error> {
 659                 self.fmt_bech32_str(f)
 660         }
 661 }
 662
 663 #[cfg(test)]
 664 mod tests {
 665         use super::{Amount, Offer, OfferBuilder, OfferTlvStreamRef, Quantity};
 666
 667         use bitcoin::blockdata::constants::ChainHash;
 668         use bitcoin::network::constants::Network;
 669         use bitcoin::secp256k1::{PublicKey, Secp256k1, SecretKey};
 670         use core::convert::TryFrom;
 671         use core::num::NonZeroU64;
 672         use core::time::Duration;
 673         use crate::ln::features::OfferFeatures;
 674         use crate::ln::msgs::{DecodeError, MAX_VALUE_MSAT};
 675         use crate::offers::parse::{ParseError, SemanticError};
 676         use crate::onion_message::{BlindedHop, BlindedPath};
 677         use crate::util::ser::{BigSize, Writeable};
 678         use crate::util::string::PrintableString;
 679
 680         fn pubkey(byte: u8) -> PublicKey {
 681                 let secp_ctx = Secp256k1::new();
 682                 PublicKey::from_secret_key(&secp_ctx, &privkey(byte))
 683         }
 684
 685         fn privkey(byte: u8) -> SecretKey {
 686                 SecretKey::from_slice(&[byte; 32]).unwrap()
 687         }
 688
 689         #[test]
 690         fn builds_offer_with_defaults() {
 691                 let offer = OfferBuilder::new("foo".into(), pubkey(42)).build().unwrap();
 692
 693                 let mut buffer = Vec::new();
 694                 offer.write(&mut buffer).unwrap();
 695
 696                 assert_eq!(offer.bytes, buffer.as_slice());
 697                 assert_eq!(offer.chains(), vec![ChainHash::using_genesis_block(Network::Bitcoin)]);
 698                 assert!(offer.supports_chain(ChainHash::using_genesis_block(Network::Bitcoin)));
 699                 assert_eq!(offer.metadata(), None);
 700                 assert_eq!(offer.amount(), None);
 701                 assert_eq!(offer.description(), PrintableString("foo"));
 702                 assert_eq!(offer.features(), &OfferFeatures::empty());
 703                 assert_eq!(offer.absolute_expiry(), None);
 704                 #[cfg(feature = "std")]
 705                 assert!(!offer.is_expired());
 706                 assert_eq!(offer.paths(), &[]);
 707                 assert_eq!(offer.issuer(), None);
 708                 assert_eq!(offer.supported_quantity(), Quantity::One);
 709                 assert_eq!(offer.signing_pubkey(), pubkey(42));
 710
 711                 assert_eq!(
 712                         offer.as_tlv_stream(),
 713                         OfferTlvStreamRef {
 714                                 chains: None,
 715                                 metadata: None,
 716                                 currency: None,
 717                                 amount: None,
 718                                 description: Some(&String::from("foo")),
 719                                 features: None,
 720                                 absolute_expiry: None,
 721                                 paths: None,
 722                                 issuer: None,
 723                                 quantity_max: None,
 724                                 node_id: Some(&pubkey(42)),
 725                         },
 726                 );
 727
 728                 if let Err(e) = Offer::try_from(buffer) {
 729                         panic!("error parsing offer: {:?}", e);
 730                 }
 731         }
 732
 733         #[test]
 734         fn builds_offer_with_chains() {
 735                 let mainnet = ChainHash::using_genesis_block(Network::Bitcoin);
 736                 let testnet = ChainHash::using_genesis_block(Network::Testnet);
 737
 738                 let offer = OfferBuilder::new("foo".into(), pubkey(42))
 739                         .chain(Network::Bitcoin)
 740                         .build()
 741                         .unwrap();
 742                 assert!(offer.supports_chain(mainnet));
 743                 assert_eq!(offer.chains(), vec![mainnet]);
 744                 assert_eq!(offer.as_tlv_stream().chains, None);
 745
 746                 let offer = OfferBuilder::new("foo".into(), pubkey(42))
 747                         .chain(Network::Testnet)
 748                         .build()
 749                         .unwrap();
 750                 assert!(offer.supports_chain(testnet));
 751                 assert_eq!(offer.chains(), vec![testnet]);
 752                 assert_eq!(offer.as_tlv_stream().chains, Some(&vec![testnet]));
 753
 754                 let offer = OfferBuilder::new("foo".into(), pubkey(42))
 755                         .chain(Network::Testnet)
 756                         .chain(Network::Testnet)
 757                         .build()
 758                         .unwrap();
 759                 assert!(offer.supports_chain(testnet));
 760                 assert_eq!(offer.chains(), vec![testnet]);
 761                 assert_eq!(offer.as_tlv_stream().chains, Some(&vec![testnet]));
 762
 763                 let offer = OfferBuilder::new("foo".into(), pubkey(42))
 764                         .chain(Network::Bitcoin)
 765                         .chain(Network::Testnet)
 766                         .build()
 767                         .unwrap();
 768                 assert!(offer.supports_chain(mainnet));
 769                 assert!(offer.supports_chain(testnet));
 770                 assert_eq!(offer.chains(), vec![mainnet, testnet]);
 771                 assert_eq!(offer.as_tlv_stream().chains, Some(&vec![mainnet, testnet]));
 772         }
 773
 774         #[test]
 775         fn builds_offer_with_metadata() {
 776                 let offer = OfferBuilder::new("foo".into(), pubkey(42))
 777                         .metadata(vec![42; 32])
 778                         .build()
 779                         .unwrap();
 780                 assert_eq!(offer.metadata(), Some(&vec![42; 32]));
 781                 assert_eq!(offer.as_tlv_stream().metadata, Some(&vec![42; 32]));
 782
 783                 let offer = OfferBuilder::new("foo".into(), pubkey(42))
 784                         .metadata(vec![42; 32])
 785                         .metadata(vec![43; 32])
 786                         .build()
 787                         .unwrap();
 788                 assert_eq!(offer.metadata(), Some(&vec![43; 32]));
 789                 assert_eq!(offer.as_tlv_stream().metadata, Some(&vec![43; 32]));
 790         }
 791
 792         #[test]
 793         fn builds_offer_with_amount() {
 794                 let bitcoin_amount = Amount::Bitcoin { amount_msats: 1000 };
 795                 let currency_amount = Amount::Currency { iso4217_code: *b"USD", amount: 10 };
 796
 797                 let offer = OfferBuilder::new("foo".into(), pubkey(42))
 798                         .amount_msats(1000)
 799                         .build()
 800                         .unwrap();
 801                 let tlv_stream = offer.as_tlv_stream();
 802                 assert_eq!(offer.amount(), Some(&bitcoin_amount));
 803                 assert_eq!(tlv_stream.amount, Some(1000));
 804                 assert_eq!(tlv_stream.currency, None);
 805
 806                 let builder = OfferBuilder::new("foo".into(), pubkey(42))
 807                         .amount(currency_amount.clone());
 808                 let tlv_stream = builder.offer.as_tlv_stream();
 809                 assert_eq!(builder.offer.amount, Some(currency_amount.clone()));
 810                 assert_eq!(tlv_stream.amount, Some(10));
 811                 assert_eq!(tlv_stream.currency, Some(b"USD"));
 812                 match builder.build() {
 813                         Ok(_) => panic!("expected error"),
 814                         Err(e) => assert_eq!(e, SemanticError::UnsupportedCurrency),
 815                 }
 816
 817                 let offer = OfferBuilder::new("foo".into(), pubkey(42))
 818                         .amount(currency_amount.clone())
 819                         .amount(bitcoin_amount.clone())
 820                         .build()
 821                         .unwrap();
 822                 let tlv_stream = offer.as_tlv_stream();
 823                 assert_eq!(tlv_stream.amount, Some(1000));
 824                 assert_eq!(tlv_stream.currency, None);
 825
 826                 let invalid_amount = Amount::Bitcoin { amount_msats: MAX_VALUE_MSAT + 1 };
 827                 match OfferBuilder::new("foo".into(), pubkey(42)).amount(invalid_amount).build() {
 828                         Ok(_) => panic!("expected error"),
 829                         Err(e) => assert_eq!(e, SemanticError::InvalidAmount),
 830                 }
 831         }
 832
 833         #[test]
 834         fn builds_offer_with_features() {
 835                 let offer = OfferBuilder::new("foo".into(), pubkey(42))
 836                         .features_unchecked(OfferFeatures::unknown())
 837                         .build()
 838                         .unwrap();
 839                 assert_eq!(offer.features(), &OfferFeatures::unknown());
 840                 assert_eq!(offer.as_tlv_stream().features, Some(&OfferFeatures::unknown()));
 841
 842                 let offer = OfferBuilder::new("foo".into(), pubkey(42))
 843                         .features_unchecked(OfferFeatures::unknown())
 844                         .features_unchecked(OfferFeatures::empty())
 845                         .build()
 846                         .unwrap();
 847                 assert_eq!(offer.features(), &OfferFeatures::empty());
 848                 assert_eq!(offer.as_tlv_stream().features, None);
 849         }
 850
 851         #[test]
 852         fn builds_offer_with_absolute_expiry() {
 853                 let future_expiry = Duration::from_secs(u64::max_value());
 854                 let past_expiry = Duration::from_secs(0);
 855
 856                 let offer = OfferBuilder::new("foo".into(), pubkey(42))
 857                         .absolute_expiry(future_expiry)
 858                         .build()
 859                         .unwrap();
 860                 #[cfg(feature = "std")]
 861                 assert!(!offer.is_expired());
 862                 assert_eq!(offer.absolute_expiry(), Some(future_expiry));
 863                 assert_eq!(offer.as_tlv_stream().absolute_expiry, Some(future_expiry.as_secs()));
 864
 865                 let offer = OfferBuilder::new("foo".into(), pubkey(42))
 866                         .absolute_expiry(future_expiry)
 867                         .absolute_expiry(past_expiry)
 868                         .build()
 869                         .unwrap();
 870                 #[cfg(feature = "std")]
 871                 assert!(offer.is_expired());
 872                 assert_eq!(offer.absolute_expiry(), Some(past_expiry));
 873                 assert_eq!(offer.as_tlv_stream().absolute_expiry, Some(past_expiry.as_secs()));
 874         }
 875
 876         #[test]
 877         fn builds_offer_with_paths() {
 878                 let paths = vec![
 879                         BlindedPath {
 880                                 introduction_node_id: pubkey(40),
 881                                 blinding_point: pubkey(41),
 882                                 blinded_hops: vec![
 883                                         BlindedHop { blinded_node_id: pubkey(43), encrypted_payload: vec![0; 43] },
 884                                         BlindedHop { blinded_node_id: pubkey(44), encrypted_payload: vec![0; 44] },
 885                                 ],
 886                         },
 887                         BlindedPath {
 888                                 introduction_node_id: pubkey(40),
 889                                 blinding_point: pubkey(41),
 890                                 blinded_hops: vec![
 891                                         BlindedHop { blinded_node_id: pubkey(45), encrypted_payload: vec![0; 45] },
 892                                         BlindedHop { blinded_node_id: pubkey(46), encrypted_payload: vec![0; 46] },
 893                                 ],
 894                         },
 895                 ];
 896
 897                 let offer = OfferBuilder::new("foo".into(), pubkey(42))
 898                         .path(paths[0].clone())
 899                         .path(paths[1].clone())
 900                         .build()
 901                         .unwrap();
 902                 let tlv_stream = offer.as_tlv_stream();
 903                 assert_eq!(offer.paths(), paths.as_slice());
 904                 assert_eq!(offer.signing_pubkey(), pubkey(42));
 905                 assert_ne!(pubkey(42), pubkey(44));
 906                 assert_eq!(tlv_stream.paths, Some(&paths));
 907                 assert_eq!(tlv_stream.node_id, Some(&pubkey(42)));
 908         }
 909
 910         #[test]
 911         fn builds_offer_with_issuer() {
 912                 let offer = OfferBuilder::new("foo".into(), pubkey(42))
 913                         .issuer("bar".into())
 914                         .build()
 915                         .unwrap();
 916                 assert_eq!(offer.issuer(), Some(PrintableString("bar")));
 917                 assert_eq!(offer.as_tlv_stream().issuer, Some(&String::from("bar")));
 918
 919                 let offer = OfferBuilder::new("foo".into(), pubkey(42))
 920                         .issuer("bar".into())
 921                         .issuer("baz".into())
 922                         .build()
 923                         .unwrap();
 924                 assert_eq!(offer.issuer(), Some(PrintableString("baz")));
 925                 assert_eq!(offer.as_tlv_stream().issuer, Some(&String::from("baz")));
 926         }
 927
 928         #[test]
 929         fn builds_offer_with_supported_quantity() {
 930                 let one = NonZeroU64::new(1).unwrap();
 931                 let ten = NonZeroU64::new(10).unwrap();
 932
 933                 let offer = OfferBuilder::new("foo".into(), pubkey(42))
 934                         .supported_quantity(Quantity::One)
 935                         .build()
 936                         .unwrap();
 937                 let tlv_stream = offer.as_tlv_stream();
 938                 assert_eq!(offer.supported_quantity(), Quantity::One);
 939                 assert_eq!(tlv_stream.quantity_max, None);
 940
 941                 let offer = OfferBuilder::new("foo".into(), pubkey(42))
 942                         .supported_quantity(Quantity::Unbounded)
 943                         .build()
 944                         .unwrap();
 945                 let tlv_stream = offer.as_tlv_stream();
 946                 assert_eq!(offer.supported_quantity(), Quantity::Unbounded);
 947                 assert_eq!(tlv_stream.quantity_max, Some(0));
 948
 949                 let offer = OfferBuilder::new("foo".into(), pubkey(42))
 950                         .supported_quantity(Quantity::Bounded(ten))
 951                         .build()
 952                         .unwrap();
 953                 let tlv_stream = offer.as_tlv_stream();
 954                 assert_eq!(offer.supported_quantity(), Quantity::Bounded(ten));
 955                 assert_eq!(tlv_stream.quantity_max, Some(10));
 956
 957                 let offer = OfferBuilder::new("foo".into(), pubkey(42))
 958                         .supported_quantity(Quantity::Bounded(one))
 959                         .build()
 960                         .unwrap();
 961                 let tlv_stream = offer.as_tlv_stream();
 962                 assert_eq!(offer.supported_quantity(), Quantity::Bounded(one));
 963                 assert_eq!(tlv_stream.quantity_max, Some(1));
 964
 965                 let offer = OfferBuilder::new("foo".into(), pubkey(42))
 966                         .supported_quantity(Quantity::Bounded(ten))
 967                         .supported_quantity(Quantity::One)
 968                         .build()
 969                         .unwrap();
 970                 let tlv_stream = offer.as_tlv_stream();
 971                 assert_eq!(offer.supported_quantity(), Quantity::One);
 972                 assert_eq!(tlv_stream.quantity_max, None);
 973         }
 974
 975         #[test]
 976         fn fails_requesting_invoice_with_unknown_required_features() {
 977                 match OfferBuilder::new("foo".into(), pubkey(42))
 978                         .features_unchecked(OfferFeatures::unknown())
 979                         .build().unwrap()
 980                         .request_invoice(vec![1; 32], pubkey(43))
 981                 {
 982                         Ok(_) => panic!("expected error"),
 983                         Err(e) => assert_eq!(e, SemanticError::UnknownRequiredFeatures),
 984                 }
 985         }
 986
 987         #[test]
 988         fn parses_offer_with_chains() {
 989                 let offer = OfferBuilder::new("foo".into(), pubkey(42))
 990                         .chain(Network::Bitcoin)
 991                         .chain(Network::Testnet)
 992                         .build()
 993                         .unwrap();
 994                 if let Err(e) = offer.to_string().parse::<Offer>() {
 995                         panic!("error parsing offer: {:?}", e);
 996                 }
 997         }
 998
 999         #[test]
1000         fn parses_offer_with_amount() {
1001                 let offer = OfferBuilder::new("foo".into(), pubkey(42))
1002                         .amount(Amount::Bitcoin { amount_msats: 1000 })
1003                         .build()
1004                         .unwrap();
1005                 if let Err(e) = offer.to_string().parse::<Offer>() {
1006                         panic!("error parsing offer: {:?}", e);
1007                 }
1008
1009                 let mut tlv_stream = offer.as_tlv_stream();
1010                 tlv_stream.amount = Some(1000);
1011                 tlv_stream.currency = Some(b"USD");
1012
1013                 let mut encoded_offer = Vec::new();
1014                 tlv_stream.write(&mut encoded_offer).unwrap();
1015
1016                 if let Err(e) = Offer::try_from(encoded_offer) {
1017                         panic!("error parsing offer: {:?}", e);
1018                 }
1019
1020                 let mut tlv_stream = offer.as_tlv_stream();
1021                 tlv_stream.amount = None;
1022                 tlv_stream.currency = Some(b"USD");
1023
1024                 let mut encoded_offer = Vec::new();
1025                 tlv_stream.write(&mut encoded_offer).unwrap();
1026
1027                 match Offer::try_from(encoded_offer) {
1028                         Ok(_) => panic!("expected error"),
1029                         Err(e) => assert_eq!(e, ParseError::InvalidSemantics(SemanticError::MissingAmount)),
1030                 }
1031
1032                 let mut tlv_stream = offer.as_tlv_stream();
1033                 tlv_stream.amount = Some(MAX_VALUE_MSAT + 1);
1034                 tlv_stream.currency = None;
1035
1036                 let mut encoded_offer = Vec::new();
1037                 tlv_stream.write(&mut encoded_offer).unwrap();
1038
1039                 match Offer::try_from(encoded_offer) {
1040                         Ok(_) => panic!("expected error"),
1041                         Err(e) => assert_eq!(e, ParseError::InvalidSemantics(SemanticError::InvalidAmount)),
1042                 }
1043         }
1044
1045         #[test]
1046         fn parses_offer_with_description() {
1047                 let offer = OfferBuilder::new("foo".into(), pubkey(42)).build().unwrap();
1048                 if let Err(e) = offer.to_string().parse::<Offer>() {
1049                         panic!("error parsing offer: {:?}", e);
1050                 }
1051
1052                 let mut tlv_stream = offer.as_tlv_stream();
1053                 tlv_stream.description = None;
1054
1055                 let mut encoded_offer = Vec::new();
1056                 tlv_stream.write(&mut encoded_offer).unwrap();
1057
1058                 match Offer::try_from(encoded_offer) {
1059                         Ok(_) => panic!("expected error"),
1060                         Err(e) => {
1061                                 assert_eq!(e, ParseError::InvalidSemantics(SemanticError::MissingDescription));
1062                         },
1063                 }
1064         }
1065
1066         #[test]
1067         fn parses_offer_with_paths() {
1068                 let offer = OfferBuilder::new("foo".into(), pubkey(42))
1069                         .path(BlindedPath {
1070                                 introduction_node_id: pubkey(40),
1071                                 blinding_point: pubkey(41),
1072                                 blinded_hops: vec![
1073                                         BlindedHop { blinded_node_id: pubkey(43), encrypted_payload: vec![0; 43] },
1074                                         BlindedHop { blinded_node_id: pubkey(44), encrypted_payload: vec![0; 44] },
1075                                 ],
1076                         })
1077                         .path(BlindedPath {
1078                                 introduction_node_id: pubkey(40),
1079                                 blinding_point: pubkey(41),
1080                                 blinded_hops: vec![
1081                                         BlindedHop { blinded_node_id: pubkey(45), encrypted_payload: vec![0; 45] },
1082                                         BlindedHop { blinded_node_id: pubkey(46), encrypted_payload: vec![0; 46] },
1083                                 ],
1084                         })
1085                         .build()
1086                         .unwrap();
1087                 if let Err(e) = offer.to_string().parse::<Offer>() {
1088                         panic!("error parsing offer: {:?}", e);
1089                 }
1090
1091                 let mut builder = OfferBuilder::new("foo".into(), pubkey(42));
1092                 builder.offer.paths = Some(vec![]);
1093
1094                 let offer = builder.build().unwrap();
1095                 if let Err(e) = offer.to_string().parse::<Offer>() {
1096                         panic!("error parsing offer: {:?}", e);
1097                 }
1098         }
1099
1100         #[test]
1101         fn parses_offer_with_quantity() {
1102                 let offer = OfferBuilder::new("foo".into(), pubkey(42))
1103                         .supported_quantity(Quantity::One)
1104                         .build()
1105                         .unwrap();
1106                 if let Err(e) = offer.to_string().parse::<Offer>() {
1107                         panic!("error parsing offer: {:?}", e);
1108                 }
1109
1110                 let offer = OfferBuilder::new("foo".into(), pubkey(42))
1111                         .supported_quantity(Quantity::Unbounded)
1112                         .build()
1113                         .unwrap();
1114                 if let Err(e) = offer.to_string().parse::<Offer>() {
1115                         panic!("error parsing offer: {:?}", e);
1116                 }
1117
1118                 let offer = OfferBuilder::new("foo".into(), pubkey(42))
1119                         .supported_quantity(Quantity::Bounded(NonZeroU64::new(10).unwrap()))
1120                         .build()
1121                         .unwrap();
1122                 if let Err(e) = offer.to_string().parse::<Offer>() {
1123                         panic!("error parsing offer: {:?}", e);
1124                 }
1125
1126                 let offer = OfferBuilder::new("foo".into(), pubkey(42))
1127                         .supported_quantity(Quantity::Bounded(NonZeroU64::new(1).unwrap()))
1128                         .build()
1129                         .unwrap();
1130                 if let Err(e) = offer.to_string().parse::<Offer>() {
1131                         panic!("error parsing offer: {:?}", e);
1132                 }
1133         }
1134
1135         #[test]
1136         fn parses_offer_with_node_id() {
1137                 let offer = OfferBuilder::new("foo".into(), pubkey(42)).build().unwrap();
1138                 if let Err(e) = offer.to_string().parse::<Offer>() {
1139                         panic!("error parsing offer: {:?}", e);
1140                 }
1141
1142                 let mut tlv_stream = offer.as_tlv_stream();
1143                 tlv_stream.node_id = None;
1144
1145                 let mut encoded_offer = Vec::new();
1146                 tlv_stream.write(&mut encoded_offer).unwrap();
1147
1148                 match Offer::try_from(encoded_offer) {
1149                         Ok(_) => panic!("expected error"),
1150                         Err(e) => {
1151                                 assert_eq!(e, ParseError::InvalidSemantics(SemanticError::MissingSigningPubkey));
1152                         },
1153                 }
1154         }
1155
1156         #[test]
1157         fn fails_parsing_offer_with_extra_tlv_records() {
1158                 let offer = OfferBuilder::new("foo".into(), pubkey(42)).build().unwrap();
1159
1160                 let mut encoded_offer = Vec::new();
1161                 offer.write(&mut encoded_offer).unwrap();
1162                 BigSize(80).write(&mut encoded_offer).unwrap();
1163                 BigSize(32).write(&mut encoded_offer).unwrap();
1164                 [42u8; 32].write(&mut encoded_offer).unwrap();
1165
1166                 match Offer::try_from(encoded_offer) {
1167                         Ok(_) => panic!("expected error"),
1168                         Err(e) => assert_eq!(e, ParseError::Decode(DecodeError::InvalidValue)),
1169                 }
1170         }
1171 }
1172
1173 #[cfg(test)]
1174 mod bech32_tests {
1175         use super::{Offer, ParseError};
1176         use bitcoin::bech32;
1177         use crate::ln::msgs::DecodeError;
1178
1179         // TODO: Remove once test vectors are updated.
1180         #[ignore]
1181         #[test]
1182         fn encodes_offer_as_bech32_without_checksum() {
1183                 let encoded_offer = "lno1qcp4256ypqpq86q2pucnq42ngssx2an9wfujqerp0y2pqun4wd68jtn00fkxzcnn9ehhyec6qgqsz83qfwdpl28qqmc78ymlvhmxcsywdk5wrjnj36jryg488qwlrnzyjczlqsp9nyu4phcg6dqhlhzgxagfu7zh3d9re0sqp9ts2yfugvnnm9gxkcnnnkdpa084a6t520h5zhkxsdnghvpukvd43lastpwuh73k29qsy";
1184                 let offer = dbg!(encoded_offer.parse::<Offer>().unwrap());
1185                 let reencoded_offer = offer.to_string();
1186                 dbg!(reencoded_offer.parse::<Offer>().unwrap());
1187                 assert_eq!(reencoded_offer, encoded_offer);
1188         }
1189
1190         // TODO: Remove once test vectors are updated.
1191         #[ignore]
1192         #[test]
1193         fn parses_bech32_encoded_offers() {
1194                 let offers = [
1195                         // BOLT 12 test vectors
1196                         "lno1qcp4256ypqpq86q2pucnq42ngssx2an9wfujqerp0y2pqun4wd68jtn00fkxzcnn9ehhyec6qgqsz83qfwdpl28qqmc78ymlvhmxcsywdk5wrjnj36jryg488qwlrnzyjczlqsp9nyu4phcg6dqhlhzgxagfu7zh3d9re0sqp9ts2yfugvnnm9gxkcnnnkdpa084a6t520h5zhkxsdnghvpukvd43lastpwuh73k29qsy",
1197                         "l+no1qcp4256ypqpq86q2pucnq42ngssx2an9wfujqerp0y2pqun4wd68jtn00fkxzcnn9ehhyec6qgqsz83qfwdpl28qqmc78ymlvhmxcsywdk5wrjnj36jryg488qwlrnzyjczlqsp9nyu4phcg6dqhlhzgxagfu7zh3d9re0sqp9ts2yfugvnnm9gxkcnnnkdpa084a6t520h5zhkxsdnghvpukvd43lastpwuh73k29qsy",
1198                         "l+no1qcp4256ypqpq86q2pucnq42ngssx2an9wfujqerp0y2pqun4wd68jtn00fkxzcnn9ehhyec6qgqsz83qfwdpl28qqmc78ymlvhmxcsywdk5wrjnj36jryg488qwlrnzyjczlqsp9nyu4phcg6dqhlhzgxagfu7zh3d9re0sqp9ts2yfugvnnm9gxkcnnnkdpa084a6t520h5zhkxsdnghvpukvd43lastpwuh73k29qsy",
1199                         "lno1qcp4256ypqpq+86q2pucnq42ngssx2an9wfujqerp0y2pqun4wd68jtn0+0fkxzcnn9ehhyec6qgqsz83qfwdpl28qqmc78ymlvhmxcsywdk5wrjnj36jryg488qwlrnzyjczlqsp9nyu4phcg6dqhlhzgxagfu7zh3d9re0+sqp9ts2yfugvnnm9gxkcnnnkdpa084a6t520h5zhkxsdnghvpukvd43lastpwuh73k29qs+y",
1200                         "lno1qcp4256ypqpq+ 86q2pucnq42ngssx2an9wfujqerp0y2pqun4wd68jtn0+  0fkxzcnn9ehhyec6qgqsz83qfwdpl28qqmc78ymlvhmxcsywdk5wrjnj36jryg488qwlrnzyjczlqsp9nyu4phcg6dqhlhzgxagfu7zh3d9re0+\nsqp9ts2yfugvnnm9gxkcnnnkdpa084a6t520h5zhkxsdnghvpukvd43l+\r\nastpwuh73k29qs+\r  y",
1201                         // Two blinded paths
1202                         "lno1qcp4256ypqpq86q2pucnq42ngssx2an9wfujqerp0yg06qg2qdd7t628sgykwj5kuc837qmlv9m9gr7sq8ap6erfgacv26nhp8zzcqgzhdvttlk22pw8fmwqqrvzst792mj35ypylj886ljkcmug03wg6heqqsqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqq6muh550qsfva9fdes0ruph7ctk2s8aqq06r4jxj3msc448wzwy9sqs9w6ckhlv55zuwnkuqqxc9qhu24h9rggzflyw04l9d3hcslzu340jqpqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqq2pqun4wd68jtn00fkxzcnn9ehhyec6qgqsz83qfwdpl28qqmc78ymlvhmxcsywdk5wrjnj36jryg488qwlrnzyjczlqsp9nyu4phcg6dqhlhzgxagfu7zh3d9re0sqp9ts2yfugvnnm9gxkcnnnkdpa084a6t520h5zhkxsdnghvpukvd43lastpwuh73k29qsy",
1203                 ];
1204                 for encoded_offer in &offers {
1205                         if let Err(e) = encoded_offer.parse::<Offer>() {
1206                                 panic!("Invalid offer ({:?}): {}", e, encoded_offer);
1207                         }
1208                 }
1209         }
1210
1211         #[test]
1212         fn fails_parsing_bech32_encoded_offers_with_invalid_continuations() {
1213                 let offers = [
1214                         // BOLT 12 test vectors
1215                         "lno1qcp4256ypqpq86q2pucnq42ngssx2an9wfujqerp0y2pqun4wd68jtn00fkxzcnn9ehhyec6qgqsz83qfwdpl28qqmc78ymlvhmxcsywdk5wrjnj36jryg488qwlrnzyjczlqsp9nyu4phcg6dqhlhzgxagfu7zh3d9re0sqp9ts2yfugvnnm9gxkcnnnkdpa084a6t520h5zhkxsdnghvpukvd43lastpwuh73k29qsy+",
1216                         "lno1qcp4256ypqpq86q2pucnq42ngssx2an9wfujqerp0y2pqun4wd68jtn00fkxzcnn9ehhyec6qgqsz83qfwdpl28qqmc78ymlvhmxcsywdk5wrjnj36jryg488qwlrnzyjczlqsp9nyu4phcg6dqhlhzgxagfu7zh3d9re0sqp9ts2yfugvnnm9gxkcnnnkdpa084a6t520h5zhkxsdnghvpukvd43lastpwuh73k29qsy+ ",
1217                         "+lno1qcp4256ypqpq86q2pucnq42ngssx2an9wfujqerp0y2pqun4wd68jtn00fkxzcnn9ehhyec6qgqsz83qfwdpl28qqmc78ymlvhmxcsywdk5wrjnj36jryg488qwlrnzyjczlqsp9nyu4phcg6dqhlhzgxagfu7zh3d9re0sqp9ts2yfugvnnm9gxkcnnnkdpa084a6t520h5zhkxsdnghvpukvd43lastpwuh73k29qsy",
1218                         "+ lno1qcp4256ypqpq86q2pucnq42ngssx2an9wfujqerp0y2pqun4wd68jtn00fkxzcnn9ehhyec6qgqsz83qfwdpl28qqmc78ymlvhmxcsywdk5wrjnj36jryg488qwlrnzyjczlqsp9nyu4phcg6dqhlhzgxagfu7zh3d9re0sqp9ts2yfugvnnm9gxkcnnnkdpa084a6t520h5zhkxsdnghvpukvd43lastpwuh73k29qsy",
1219                         "ln++o1qcp4256ypqpq86q2pucnq42ngssx2an9wfujqerp0y2pqun4wd68jtn00fkxzcnn9ehhyec6qgqsz83qfwdpl28qqmc78ymlvhmxcsywdk5wrjnj36jryg488qwlrnzyjczlqsp9nyu4phcg6dqhlhzgxagfu7zh3d9re0sqp9ts2yfugvnnm9gxkcnnnkdpa084a6t520h5zhkxsdnghvpukvd43lastpwuh73k29qsy",
1220                 ];
1221                 for encoded_offer in &offers {
1222                         match encoded_offer.parse::<Offer>() {
1223                                 Ok(_) => panic!("Valid offer: {}", encoded_offer),
1224                                 Err(e) => assert_eq!(e, ParseError::InvalidContinuation),
1225                         }
1226                 }
1227
1228         }
1229
1230         #[test]
1231         fn fails_parsing_bech32_encoded_offer_with_invalid_hrp() {
1232                 let encoded_offer = "lni1qcp4256ypqpq86q2pucnq42ngssx2an9wfujqerp0y2pqun4wd68jtn00fkxzcnn9ehhyec6qgqsz83qfwdpl28qqmc78ymlvhmxcsywdk5wrjnj36jryg488qwlrnzyjczlqsp9nyu4phcg6dqhlhzgxagfu7zh3d9re0sqp9ts2yfugvnnm9gxkcnnnkdpa084a6t520h5zhkxsdnghvpukvd43lastpwuh73k29qsy";
1233                 match encoded_offer.parse::<Offer>() {
1234                         Ok(_) => panic!("Valid offer: {}", encoded_offer),
1235                         Err(e) => assert_eq!(e, ParseError::InvalidBech32Hrp),
1236                 }
1237         }
1238
1239         #[test]
1240         fn fails_parsing_bech32_encoded_offer_with_invalid_bech32_data() {
1241                 let encoded_offer = "lno1qcp4256ypqpq86q2pucnq42ngssx2an9wfujqerp0y2pqun4wd68jtn00fkxzcnn9ehhyec6qgqsz83qfwdpl28qqmc78ymlvhmxcsywdk5wrjnj36jryg488qwlrnzyjczlqsp9nyu4phcg6dqhlhzgxagfu7zh3d9re0sqp9ts2yfugvnnm9gxkcnnnkdpa084a6t520h5zhkxsdnghvpukvd43lastpwuh73k29qso";
1242                 match encoded_offer.parse::<Offer>() {
1243                         Ok(_) => panic!("Valid offer: {}", encoded_offer),
1244                         Err(e) => assert_eq!(e, ParseError::Bech32(bech32::Error::InvalidChar('o'))),
1245                 }
1246         }
1247
1248         #[test]
1249         fn fails_parsing_bech32_encoded_offer_with_invalid_tlv_data() {
1250                 let encoded_offer = "lno1qcp4256ypqpq86q2pucnq42ngssx2an9wfujqerp0y2pqun4wd68jtn00fkxzcnn9ehhyec6qgqsz83qfwdpl28qqmc78ymlvhmxcsywdk5wrjnj36jryg488qwlrnzyjczlqsp9nyu4phcg6dqhlhzgxagfu7zh3d9re0sqp9ts2yfugvnnm9gxkcnnnkdpa084a6t520h5zhkxsdnghvpukvd43lastpwuh73k29qsyqqqqq";
1251                 match encoded_offer.parse::<Offer>() {
1252                         Ok(_) => panic!("Valid offer: {}", encoded_offer),
1253                         Err(e) => assert_eq!(e, ParseError::Decode(DecodeError::InvalidValue)),
1254                 }
1255         }
1256 }