_ Git - rust-lightning/blob - lightning/src/offers/invoice_request.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 `invoice_request` messages.
  11 //!
  12 //! An [`InvoiceRequest`] can be built from a parsed [`Offer`] as an "offer to be paid". It is
  13 //! typically constructed by a customer and sent to the merchant who had published the corresponding
  14 //! offer. The recipient of the request responds with an [`Invoice`].
  15 //!
  16 //! For an "offer for money" (e.g., refund, ATM withdrawal), where an offer doesn't exist as a
  17 //! precursor, see [`Refund`].
  18 //!
  19 //! [`Invoice`]: crate::offers::invoice::Invoice
  20 //! [`Refund`]: crate::offers::refund::Refund
  21 //!
  22 //! ```
  23 //! extern crate bitcoin;
  24 //! extern crate lightning;
  25 //!
  26 //! use bitcoin::network::constants::Network;
  27 //! use bitcoin::secp256k1::{KeyPair, PublicKey, Secp256k1, SecretKey};
  28 //! use core::convert::Infallible;
  29 //! use lightning::ln::features::OfferFeatures;
  30 //! use lightning::offers::offer::Offer;
  31 //! use lightning::util::ser::Writeable;
  32 //!
  33 //! # fn parse() -> Result<(), lightning::offers::parse::ParseError> {
  34 //! let secp_ctx = Secp256k1::new();
  35 //! let keys = KeyPair::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32])?);
  36 //! let pubkey = PublicKey::from(keys);
  37 //! let mut buffer = Vec::new();
  38 //!
  39 //! "lno1qcp4256ypq"
  40 //!     .parse::<Offer>()?
  41 //!     .request_invoice(vec![42; 64], pubkey)?
  42 //!     .chain(Network::Testnet)?
  43 //!     .amount_msats(1000)?
  44 //!     .quantity(5)?
  45 //!     .payer_note("foo".to_string())
  46 //!     .build()?
  47 //!     .sign::<_, Infallible>(|digest| Ok(secp_ctx.sign_schnorr_no_aux_rand(digest, &keys)))
  48 //!     .expect("failed verifying signature")
  49 //!     .write(&mut buffer)
  50 //!     .unwrap();
  51 //! # Ok(())
  52 //! # }
  53 //! ```
  54
  55 use bitcoin::blockdata::constants::ChainHash;
  56 use bitcoin::network::constants::Network;
  57 use bitcoin::secp256k1::{Message, PublicKey};
  58 use bitcoin::secp256k1::schnorr::Signature;
  59 use core::convert::TryFrom;
  60 use crate::io;
  61 use crate::ln::PaymentHash;
  62 use crate::ln::features::InvoiceRequestFeatures;
  63 use crate::ln::msgs::DecodeError;
  64 use crate::offers::invoice::{BlindedPayInfo, InvoiceBuilder};
  65 use crate::offers::merkle::{SignError, SignatureTlvStream, SignatureTlvStreamRef, self};
  66 use crate::offers::offer::{Offer, OfferContents, OfferTlvStream, OfferTlvStreamRef};
  67 use crate::offers::parse::{ParseError, ParsedMessage, SemanticError};
  68 use crate::offers::payer::{PayerContents, PayerTlvStream, PayerTlvStreamRef};
  69 use crate::onion_message::BlindedPath;
  70 use crate::util::ser::{HighZeroBytesDroppedBigSize, SeekReadable, WithoutLength, Writeable, Writer};
  71 use crate::util::string::PrintableString;
  72
  73 use crate::prelude::*;
  74
  75 const SIGNATURE_TAG: &'static str = concat!("lightning", "invoice_request", "signature");
  76
  77 /// Builds an [`InvoiceRequest`] from an [`Offer`] for the "offer to be paid" flow.
  78 ///
  79 /// See [module-level documentation] for usage.
  80 ///
  81 /// [module-level documentation]: self
  82 pub struct InvoiceRequestBuilder<'a> {
  83         offer: &'a Offer,
  84         invoice_request: InvoiceRequestContents,
  85 }
  86
  87 impl<'a> InvoiceRequestBuilder<'a> {
  88         pub(super) fn new(offer: &'a Offer, metadata: Vec<u8>, payer_id: PublicKey) -> Self {
  89                 Self {
  90                         offer,
  91                         invoice_request: InvoiceRequestContents {
  92                                 payer: PayerContents(metadata), offer: offer.contents.clone(), chain: None,
  93                                 amount_msats: None, features: InvoiceRequestFeatures::empty(), quantity: None,
  94                                 payer_id, payer_note: None,
  95                         },
  96                 }
  97         }
  98
  99         /// Sets the [`InvoiceRequest::chain`] of the given [`Network`] for paying an invoice. If not
 100         /// called, [`Network::Bitcoin`] is assumed. Errors if the chain for `network` is not supported
 101         /// by the offer.
 102         ///
 103         /// Successive calls to this method will override the previous setting.
 104         pub fn chain(mut self, network: Network) -> Result<Self, SemanticError> {
 105                 let chain = ChainHash::using_genesis_block(network);
 106                 if !self.offer.supports_chain(chain) {
 107                         return Err(SemanticError::UnsupportedChain);
 108                 }
 109
 110                 self.invoice_request.chain = Some(chain);
 111                 Ok(self)
 112         }
 113
 114         /// Sets the [`InvoiceRequest::amount_msats`] for paying an invoice. Errors if `amount_msats` is
 115         /// not at least the expected invoice amount (i.e., [`Offer::amount`] times [`quantity`]).
 116         ///
 117         /// Successive calls to this method will override the previous setting.
 118         ///
 119         /// [`quantity`]: Self::quantity
 120         pub fn amount_msats(mut self, amount_msats: u64) -> Result<Self, SemanticError> {
 121                 self.invoice_request.offer.check_amount_msats_for_quantity(
 122                         Some(amount_msats), self.invoice_request.quantity
 123                 )?;
 124                 self.invoice_request.amount_msats = Some(amount_msats);
 125                 Ok(self)
 126         }
 127
 128         /// Sets [`InvoiceRequest::quantity`] of items. If not set, `1` is assumed. Errors if `quantity`
 129         /// does not conform to [`Offer::is_valid_quantity`].
 130         ///
 131         /// Successive calls to this method will override the previous setting.
 132         pub fn quantity(mut self, quantity: u64) -> Result<Self, SemanticError> {
 133                 self.invoice_request.offer.check_quantity(Some(quantity))?;
 134                 self.invoice_request.quantity = Some(quantity);
 135                 Ok(self)
 136         }
 137
 138         /// Sets the [`InvoiceRequest::payer_note`].
 139         ///
 140         /// Successive calls to this method will override the previous setting.
 141         pub fn payer_note(mut self, payer_note: String) -> Self {
 142                 self.invoice_request.payer_note = Some(payer_note);
 143                 self
 144         }
 145
 146         /// Builds an unsigned [`InvoiceRequest`] after checking for valid semantics. It can be signed
 147         /// by [`UnsignedInvoiceRequest::sign`].
 148         pub fn build(mut self) -> Result<UnsignedInvoiceRequest<'a>, SemanticError> {
 149                 #[cfg(feature = "std")] {
 150                         if self.offer.is_expired() {
 151                                 return Err(SemanticError::AlreadyExpired);
 152                         }
 153                 }
 154
 155                 let chain = self.invoice_request.chain();
 156                 if !self.offer.supports_chain(chain) {
 157                         return Err(SemanticError::UnsupportedChain);
 158                 }
 159
 160                 if chain == self.offer.implied_chain() {
 161                         self.invoice_request.chain = None;
 162                 }
 163
 164                 if self.offer.amount().is_none() && self.invoice_request.amount_msats.is_none() {
 165                         return Err(SemanticError::MissingAmount);
 166                 }
 167
 168                 self.invoice_request.offer.check_quantity(self.invoice_request.quantity)?;
 169                 self.invoice_request.offer.check_amount_msats_for_quantity(
 170                         self.invoice_request.amount_msats, self.invoice_request.quantity
 171                 )?;
 172
 173                 let InvoiceRequestBuilder { offer, invoice_request } = self;
 174                 Ok(UnsignedInvoiceRequest { offer, invoice_request })
 175         }
 176 }
 177
 178 #[cfg(test)]
 179 impl<'a> InvoiceRequestBuilder<'a> {
 180         fn chain_unchecked(mut self, network: Network) -> Self {
 181                 let chain = ChainHash::using_genesis_block(network);
 182                 self.invoice_request.chain = Some(chain);
 183                 self
 184         }
 185
 186         fn amount_msats_unchecked(mut self, amount_msats: u64) -> Self {
 187                 self.invoice_request.amount_msats = Some(amount_msats);
 188                 self
 189         }
 190
 191         fn features_unchecked(mut self, features: InvoiceRequestFeatures) -> Self {
 192                 self.invoice_request.features = features;
 193                 self
 194         }
 195
 196         fn quantity_unchecked(mut self, quantity: u64) -> Self {
 197                 self.invoice_request.quantity = Some(quantity);
 198                 self
 199         }
 200
 201         pub(super) fn build_unchecked(self) -> UnsignedInvoiceRequest<'a> {
 202                 let InvoiceRequestBuilder { offer, invoice_request } = self;
 203                 UnsignedInvoiceRequest { offer, invoice_request }
 204         }
 205 }
 206
 207 /// A semantically valid [`InvoiceRequest`] that hasn't been signed.
 208 pub struct UnsignedInvoiceRequest<'a> {
 209         offer: &'a Offer,
 210         invoice_request: InvoiceRequestContents,
 211 }
 212
 213 impl<'a> UnsignedInvoiceRequest<'a> {
 214         /// Signs the invoice request using the given function.
 215         pub fn sign<F, E>(self, sign: F) -> Result<InvoiceRequest, SignError<E>>
 216         where
 217                 F: FnOnce(&Message) -> Result<Signature, E>
 218         {
 219                 // Use the offer bytes instead of the offer TLV stream as the offer may have contained
 220                 // unknown TLV records, which are not stored in `OfferContents`.
 221                 let (payer_tlv_stream, _offer_tlv_stream, invoice_request_tlv_stream) =
 222                         self.invoice_request.as_tlv_stream();
 223                 let offer_bytes = WithoutLength(&self.offer.bytes);
 224                 let unsigned_tlv_stream = (payer_tlv_stream, offer_bytes, invoice_request_tlv_stream);
 225
 226                 let mut bytes = Vec::new();
 227                 unsigned_tlv_stream.write(&mut bytes).unwrap();
 228
 229                 let pubkey = self.invoice_request.payer_id;
 230                 let signature = merkle::sign_message(sign, SIGNATURE_TAG, &bytes, pubkey)?;
 231
 232                 // Append the signature TLV record to the bytes.
 233                 let signature_tlv_stream = SignatureTlvStreamRef {
 234                         signature: Some(&signature),
 235                 };
 236                 signature_tlv_stream.write(&mut bytes).unwrap();
 237
 238                 Ok(InvoiceRequest {
 239                         bytes,
 240                         contents: self.invoice_request,
 241                         signature,
 242                 })
 243         }
 244 }
 245
 246 /// An `InvoiceRequest` is a request for an [`Invoice`] formulated from an [`Offer`].
 247 ///
 248 /// An offer may provide choices such as quantity, amount, chain, features, etc. An invoice request
 249 /// specifies these such that its recipient can send an invoice for payment.
 250 ///
 251 /// [`Invoice`]: crate::offers::invoice::Invoice
 252 /// [`Offer`]: crate::offers::offer::Offer
 253 #[derive(Clone, Debug, PartialEq)]
 254 pub struct InvoiceRequest {
 255         pub(super) bytes: Vec<u8>,
 256         pub(super) contents: InvoiceRequestContents,
 257         signature: Signature,
 258 }
 259
 260 /// The contents of an [`InvoiceRequest`], which may be shared with an [`Invoice`].
 261 ///
 262 /// [`Invoice`]: crate::offers::invoice::Invoice
 263 #[derive(Clone, Debug, PartialEq)]
 264 pub(super) struct InvoiceRequestContents {
 265         payer: PayerContents,
 266         pub(super) offer: OfferContents,
 267         chain: Option<ChainHash>,
 268         amount_msats: Option<u64>,
 269         features: InvoiceRequestFeatures,
 270         quantity: Option<u64>,
 271         payer_id: PublicKey,
 272         payer_note: Option<String>,
 273 }
 274
 275 impl InvoiceRequest {
 276         /// An unpredictable series of bytes, typically containing information about the derivation of
 277         /// [`payer_id`].
 278         ///
 279         /// [`payer_id`]: Self::payer_id
 280         pub fn metadata(&self) -> &[u8] {
 281                 &self.contents.payer.0[..]
 282         }
 283
 284         /// A chain from [`Offer::chains`] that the offer is valid for.
 285         pub fn chain(&self) -> ChainHash {
 286                 self.contents.chain()
 287         }
 288
 289         /// The amount to pay in msats (i.e., the minimum lightning-payable unit for [`chain`]), which
 290         /// must be greater than or equal to [`Offer::amount`], converted if necessary.
 291         ///
 292         /// [`chain`]: Self::chain
 293         pub fn amount_msats(&self) -> Option<u64> {
 294                 self.contents.amount_msats
 295         }
 296
 297         /// Features pertaining to requesting an invoice.
 298         pub fn features(&self) -> &InvoiceRequestFeatures {
 299                 &self.contents.features
 300         }
 301
 302         /// The quantity of the offer's item conforming to [`Offer::is_valid_quantity`].
 303         pub fn quantity(&self) -> Option<u64> {
 304                 self.contents.quantity
 305         }
 306
 307         /// A possibly transient pubkey used to sign the invoice request.
 308         pub fn payer_id(&self) -> PublicKey {
 309                 self.contents.payer_id
 310         }
 311
 312         /// A payer-provided note which will be seen by the recipient and reflected back in the invoice
 313         /// response.
 314         pub fn payer_note(&self) -> Option<PrintableString> {
 315                 self.contents.payer_note.as_ref().map(|payer_note| PrintableString(payer_note.as_str()))
 316         }
 317
 318         /// Signature of the invoice request using [`payer_id`].
 319         ///
 320         /// [`payer_id`]: Self::payer_id
 321         pub fn signature(&self) -> Signature {
 322                 self.signature
 323         }
 324
 325         /// Creates an [`Invoice`] for the request with the given required fields and using the
 326         /// [`Duration`] since [`std::time::SystemTime::UNIX_EPOCH`] as the creation time.
 327         ///
 328         /// See [`InvoiceRequest::respond_with_no_std`] for further details where the aforementioned
 329         /// creation time is used for the `created_at` parameter.
 330         ///
 331         /// [`Invoice`]: crate::offers::invoice::Invoice
 332         /// [`Duration`]: core::time::Duration
 333         #[cfg(feature = "std")]
 334         pub fn respond_with(
 335                 &self, payment_paths: Vec<(BlindedPath, BlindedPayInfo)>, payment_hash: PaymentHash
 336         ) -> Result<InvoiceBuilder, SemanticError> {
 337                 let created_at = std::time::SystemTime::now()
 338                         .duration_since(std::time::SystemTime::UNIX_EPOCH)
 339                         .expect("SystemTime::now() should come after SystemTime::UNIX_EPOCH");
 340
 341                 self.respond_with_no_std(payment_paths, payment_hash, created_at)
 342         }
 343
 344         /// Creates an [`Invoice`] for the request with the given required fields.
 345         ///
 346         /// Unless [`InvoiceBuilder::relative_expiry`] is set, the invoice will expire two hours after
 347         /// `created_at`, which is used to set [`Invoice::created_at`]. Useful for `no-std` builds where
 348         /// [`std::time::SystemTime`] is not available.
 349         ///
 350         /// The caller is expected to remember the preimage of `payment_hash` in order to claim a payment
 351         /// for the invoice.
 352         ///
 353         /// The `payment_paths` parameter is useful for maintaining the payment recipient's privacy. It
 354         /// must contain one or more elements ordered from most-preferred to least-preferred, if there's
 355         /// a preference. Note, however, that any privacy is lost if a public node id was used for
 356         /// [`Offer::signing_pubkey`].
 357         ///
 358         /// Errors if the request contains unknown required features.
 359         ///
 360         /// [`Invoice`]: crate::offers::invoice::Invoice
 361         /// [`Invoice::created_at`]: crate::offers::invoice::Invoice::created_at
 362         pub fn respond_with_no_std(
 363                 &self, payment_paths: Vec<(BlindedPath, BlindedPayInfo)>, payment_hash: PaymentHash,
 364                 created_at: core::time::Duration
 365         ) -> Result<InvoiceBuilder, SemanticError> {
 366                 if self.features().requires_unknown_bits() {
 367                         return Err(SemanticError::UnknownRequiredFeatures);
 368                 }
 369
 370                 InvoiceBuilder::for_offer(self, payment_paths, created_at, payment_hash)
 371         }
 372
 373         #[cfg(test)]
 374         fn as_tlv_stream(&self) -> FullInvoiceRequestTlvStreamRef {
 375                 let (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream) =
 376                         self.contents.as_tlv_stream();
 377                 let signature_tlv_stream = SignatureTlvStreamRef {
 378                         signature: Some(&self.signature),
 379                 };
 380                 (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, signature_tlv_stream)
 381         }
 382 }
 383
 384 impl InvoiceRequestContents {
 385         pub(super) fn chain(&self) -> ChainHash {
 386                 self.chain.unwrap_or_else(|| self.offer.implied_chain())
 387         }
 388
 389         pub(super) fn as_tlv_stream(&self) -> PartialInvoiceRequestTlvStreamRef {
 390                 let payer = PayerTlvStreamRef {
 391                         metadata: Some(&self.payer.0),
 392                 };
 393
 394                 let offer = self.offer.as_tlv_stream();
 395
 396                 let features = {
 397                         if self.features == InvoiceRequestFeatures::empty() { None }
 398                         else { Some(&self.features) }
 399                 };
 400
 401                 let invoice_request = InvoiceRequestTlvStreamRef {
 402                         chain: self.chain.as_ref(),
 403                         amount: self.amount_msats,
 404                         features,
 405                         quantity: self.quantity,
 406                         payer_id: Some(&self.payer_id),
 407                         payer_note: self.payer_note.as_ref(),
 408                 };
 409
 410                 (payer, offer, invoice_request)
 411         }
 412 }
 413
 414 impl Writeable for InvoiceRequest {
 415         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
 416                 WithoutLength(&self.bytes).write(writer)
 417         }
 418 }
 419
 420 impl Writeable for InvoiceRequestContents {
 421         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
 422                 self.as_tlv_stream().write(writer)
 423         }
 424 }
 425
 426 tlv_stream!(InvoiceRequestTlvStream, InvoiceRequestTlvStreamRef, 80..160, {
 427         (80, chain: ChainHash),
 428         (82, amount: (u64, HighZeroBytesDroppedBigSize)),
 429         (84, features: (InvoiceRequestFeatures, WithoutLength)),
 430         (86, quantity: (u64, HighZeroBytesDroppedBigSize)),
 431         (88, payer_id: PublicKey),
 432         (89, payer_note: (String, WithoutLength)),
 433 });
 434
 435 type FullInvoiceRequestTlvStream =
 436         (PayerTlvStream, OfferTlvStream, InvoiceRequestTlvStream, SignatureTlvStream);
 437
 438 #[cfg(test)]
 439 type FullInvoiceRequestTlvStreamRef<'a> = (
 440         PayerTlvStreamRef<'a>,
 441         OfferTlvStreamRef<'a>,
 442         InvoiceRequestTlvStreamRef<'a>,
 443         SignatureTlvStreamRef<'a>,
 444 );
 445
 446 impl SeekReadable for FullInvoiceRequestTlvStream {
 447         fn read<R: io::Read + io::Seek>(r: &mut R) -> Result<Self, DecodeError> {
 448                 let payer = SeekReadable::read(r)?;
 449                 let offer = SeekReadable::read(r)?;
 450                 let invoice_request = SeekReadable::read(r)?;
 451                 let signature = SeekReadable::read(r)?;
 452
 453                 Ok((payer, offer, invoice_request, signature))
 454         }
 455 }
 456
 457 type PartialInvoiceRequestTlvStream = (PayerTlvStream, OfferTlvStream, InvoiceRequestTlvStream);
 458
 459 type PartialInvoiceRequestTlvStreamRef<'a> = (
 460         PayerTlvStreamRef<'a>,
 461         OfferTlvStreamRef<'a>,
 462         InvoiceRequestTlvStreamRef<'a>,
 463 );
 464
 465 impl TryFrom<Vec<u8>> for InvoiceRequest {
 466         type Error = ParseError;
 467
 468         fn try_from(bytes: Vec<u8>) -> Result<Self, Self::Error> {
 469                 let invoice_request = ParsedMessage::<FullInvoiceRequestTlvStream>::try_from(bytes)?;
 470                 let ParsedMessage { bytes, tlv_stream } = invoice_request;
 471                 let (
 472                         payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream,
 473                         SignatureTlvStream { signature },
 474                 ) = tlv_stream;
 475                 let contents = InvoiceRequestContents::try_from(
 476                         (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream)
 477                 )?;
 478
 479                 let signature = match signature {
 480                         None => return Err(ParseError::InvalidSemantics(SemanticError::MissingSignature)),
 481                         Some(signature) => signature,
 482                 };
 483                 merkle::verify_signature(&signature, SIGNATURE_TAG, &bytes, contents.payer_id)?;
 484
 485                 Ok(InvoiceRequest { bytes, contents, signature })
 486         }
 487 }
 488
 489 impl TryFrom<PartialInvoiceRequestTlvStream> for InvoiceRequestContents {
 490         type Error = SemanticError;
 491
 492         fn try_from(tlv_stream: PartialInvoiceRequestTlvStream) -> Result<Self, Self::Error> {
 493                 let (
 494                         PayerTlvStream { metadata },
 495                         offer_tlv_stream,
 496                         InvoiceRequestTlvStream { chain, amount, features, quantity, payer_id, payer_note },
 497                 ) = tlv_stream;
 498
 499                 let payer = match metadata {
 500                         None => return Err(SemanticError::MissingPayerMetadata),
 501                         Some(metadata) => PayerContents(metadata),
 502                 };
 503                 let offer = OfferContents::try_from(offer_tlv_stream)?;
 504
 505                 if !offer.supports_chain(chain.unwrap_or_else(|| offer.implied_chain())) {
 506                         return Err(SemanticError::UnsupportedChain);
 507                 }
 508
 509                 if offer.amount().is_none() && amount.is_none() {
 510                         return Err(SemanticError::MissingAmount);
 511                 }
 512
 513                 offer.check_quantity(quantity)?;
 514                 offer.check_amount_msats_for_quantity(amount, quantity)?;
 515
 516                 let features = features.unwrap_or_else(InvoiceRequestFeatures::empty);
 517
 518                 let payer_id = match payer_id {
 519                         None => return Err(SemanticError::MissingPayerId),
 520                         Some(payer_id) => payer_id,
 521                 };
 522
 523                 Ok(InvoiceRequestContents {
 524                         payer, offer, chain, amount_msats: amount, features, quantity, payer_id, payer_note,
 525                 })
 526         }
 527 }
 528
 529 #[cfg(test)]
 530 mod tests {
 531         use super::{InvoiceRequest, InvoiceRequestTlvStreamRef, SIGNATURE_TAG};
 532
 533         use bitcoin::blockdata::constants::ChainHash;
 534         use bitcoin::network::constants::Network;
 535         use bitcoin::secp256k1::{KeyPair, Message, PublicKey, Secp256k1, SecretKey, self};
 536         use bitcoin::secp256k1::schnorr::Signature;
 537         use core::convert::{Infallible, TryFrom};
 538         use core::num::NonZeroU64;
 539         #[cfg(feature = "std")]
 540         use core::time::Duration;
 541         use crate::ln::features::InvoiceRequestFeatures;
 542         use crate::ln::msgs::{DecodeError, MAX_VALUE_MSAT};
 543         use crate::offers::merkle::{SignError, SignatureTlvStreamRef, self};
 544         use crate::offers::offer::{Amount, OfferBuilder, OfferTlvStreamRef, Quantity};
 545         use crate::offers::parse::{ParseError, SemanticError};
 546         use crate::offers::payer::PayerTlvStreamRef;
 547         use crate::util::ser::{BigSize, Writeable};
 548         use crate::util::string::PrintableString;
 549
 550         fn payer_keys() -> KeyPair {
 551                 let secp_ctx = Secp256k1::new();
 552                 KeyPair::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap())
 553         }
 554
 555         fn payer_sign(digest: &Message) -> Result<Signature, Infallible> {
 556                 let secp_ctx = Secp256k1::new();
 557                 let keys = KeyPair::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
 558                 Ok(secp_ctx.sign_schnorr_no_aux_rand(digest, &keys))
 559         }
 560
 561         fn payer_pubkey() -> PublicKey {
 562                 payer_keys().public_key()
 563         }
 564
 565         fn recipient_sign(digest: &Message) -> Result<Signature, Infallible> {
 566                 let secp_ctx = Secp256k1::new();
 567                 let keys = KeyPair::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[43; 32]).unwrap());
 568                 Ok(secp_ctx.sign_schnorr_no_aux_rand(digest, &keys))
 569         }
 570
 571         fn recipient_pubkey() -> PublicKey {
 572                 let secp_ctx = Secp256k1::new();
 573                 KeyPair::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[43; 32]).unwrap()).public_key()
 574         }
 575
 576         #[test]
 577         fn builds_invoice_request_with_defaults() {
 578                 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
 579                         .amount_msats(1000)
 580                         .build().unwrap()
 581                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
 582                         .build().unwrap()
 583                         .sign(payer_sign).unwrap();
 584
 585                 let mut buffer = Vec::new();
 586                 invoice_request.write(&mut buffer).unwrap();
 587
 588                 assert_eq!(invoice_request.bytes, buffer.as_slice());
 589                 assert_eq!(invoice_request.metadata(), &[1; 32]);
 590                 assert_eq!(invoice_request.chain(), ChainHash::using_genesis_block(Network::Bitcoin));
 591                 assert_eq!(invoice_request.amount_msats(), None);
 592                 assert_eq!(invoice_request.features(), &InvoiceRequestFeatures::empty());
 593                 assert_eq!(invoice_request.quantity(), None);
 594                 assert_eq!(invoice_request.payer_id(), payer_pubkey());
 595                 assert_eq!(invoice_request.payer_note(), None);
 596                 assert!(
 597                         merkle::verify_signature(
 598                                 &invoice_request.signature, SIGNATURE_TAG, &invoice_request.bytes, payer_pubkey()
 599                         ).is_ok()
 600                 );
 601
 602                 assert_eq!(
 603                         invoice_request.as_tlv_stream(),
 604                         (
 605                                 PayerTlvStreamRef { metadata: Some(&vec![1; 32]) },
 606                                 OfferTlvStreamRef {
 607                                         chains: None,
 608                                         metadata: None,
 609                                         currency: None,
 610                                         amount: Some(1000),
 611                                         description: Some(&String::from("foo")),
 612                                         features: None,
 613                                         absolute_expiry: None,
 614                                         paths: None,
 615                                         issuer: None,
 616                                         quantity_max: None,
 617                                         node_id: Some(&recipient_pubkey()),
 618                                 },
 619                                 InvoiceRequestTlvStreamRef {
 620                                         chain: None,
 621                                         amount: None,
 622                                         features: None,
 623                                         quantity: None,
 624                                         payer_id: Some(&payer_pubkey()),
 625                                         payer_note: None,
 626                                 },
 627                                 SignatureTlvStreamRef { signature: Some(&invoice_request.signature()) },
 628                         ),
 629                 );
 630
 631                 if let Err(e) = InvoiceRequest::try_from(buffer) {
 632                         panic!("error parsing invoice request: {:?}", e);
 633                 }
 634         }
 635
 636         #[cfg(feature = "std")]
 637         #[test]
 638         fn builds_invoice_request_from_offer_with_expiration() {
 639                 let future_expiry = Duration::from_secs(u64::max_value());
 640                 let past_expiry = Duration::from_secs(0);
 641
 642                 if let Err(e) = OfferBuilder::new("foo".into(), recipient_pubkey())
 643                         .amount_msats(1000)
 644                         .absolute_expiry(future_expiry)
 645                         .build().unwrap()
 646                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
 647                         .build()
 648                 {
 649                         panic!("error building invoice_request: {:?}", e);
 650                 }
 651
 652                 match OfferBuilder::new("foo".into(), recipient_pubkey())
 653                         .amount_msats(1000)
 654                         .absolute_expiry(past_expiry)
 655                         .build().unwrap()
 656                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
 657                         .build()
 658                 {
 659                         Ok(_) => panic!("expected error"),
 660                         Err(e) => assert_eq!(e, SemanticError::AlreadyExpired),
 661                 }
 662         }
 663
 664         #[test]
 665         fn builds_invoice_request_with_chain() {
 666                 let mainnet = ChainHash::using_genesis_block(Network::Bitcoin);
 667                 let testnet = ChainHash::using_genesis_block(Network::Testnet);
 668
 669                 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
 670                         .amount_msats(1000)
 671                         .build().unwrap()
 672                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
 673                         .chain(Network::Bitcoin).unwrap()
 674                         .build().unwrap()
 675                         .sign(payer_sign).unwrap();
 676                 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
 677                 assert_eq!(invoice_request.chain(), mainnet);
 678                 assert_eq!(tlv_stream.chain, None);
 679
 680                 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
 681                         .amount_msats(1000)
 682                         .chain(Network::Testnet)
 683                         .build().unwrap()
 684                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
 685                         .chain(Network::Testnet).unwrap()
 686                         .build().unwrap()
 687                         .sign(payer_sign).unwrap();
 688                 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
 689                 assert_eq!(invoice_request.chain(), testnet);
 690                 assert_eq!(tlv_stream.chain, Some(&testnet));
 691
 692                 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
 693                         .amount_msats(1000)
 694                         .chain(Network::Bitcoin)
 695                         .chain(Network::Testnet)
 696                         .build().unwrap()
 697                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
 698                         .chain(Network::Bitcoin).unwrap()
 699                         .build().unwrap()
 700                         .sign(payer_sign).unwrap();
 701                 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
 702                 assert_eq!(invoice_request.chain(), mainnet);
 703                 assert_eq!(tlv_stream.chain, None);
 704
 705                 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
 706                         .amount_msats(1000)
 707                         .chain(Network::Bitcoin)
 708                         .chain(Network::Testnet)
 709                         .build().unwrap()
 710                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
 711                         .chain(Network::Bitcoin).unwrap()
 712                         .chain(Network::Testnet).unwrap()
 713                         .build().unwrap()
 714                         .sign(payer_sign).unwrap();
 715                 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
 716                 assert_eq!(invoice_request.chain(), testnet);
 717                 assert_eq!(tlv_stream.chain, Some(&testnet));
 718
 719                 match OfferBuilder::new("foo".into(), recipient_pubkey())
 720                         .amount_msats(1000)
 721                         .chain(Network::Testnet)
 722                         .build().unwrap()
 723                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
 724                         .chain(Network::Bitcoin)
 725                 {
 726                         Ok(_) => panic!("expected error"),
 727                         Err(e) => assert_eq!(e, SemanticError::UnsupportedChain),
 728                 }
 729
 730                 match OfferBuilder::new("foo".into(), recipient_pubkey())
 731                         .amount_msats(1000)
 732                         .chain(Network::Testnet)
 733                         .build().unwrap()
 734                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
 735                         .build()
 736                 {
 737                         Ok(_) => panic!("expected error"),
 738                         Err(e) => assert_eq!(e, SemanticError::UnsupportedChain),
 739                 }
 740         }
 741
 742         #[test]
 743         fn builds_invoice_request_with_amount() {
 744                 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
 745                         .amount_msats(1000)
 746                         .build().unwrap()
 747                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
 748                         .amount_msats(1000).unwrap()
 749                         .build().unwrap()
 750                         .sign(payer_sign).unwrap();
 751                 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
 752                 assert_eq!(invoice_request.amount_msats(), Some(1000));
 753                 assert_eq!(tlv_stream.amount, Some(1000));
 754
 755                 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
 756                         .amount_msats(1000)
 757                         .build().unwrap()
 758                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
 759                         .amount_msats(1001).unwrap()
 760                         .amount_msats(1000).unwrap()
 761                         .build().unwrap()
 762                         .sign(payer_sign).unwrap();
 763                 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
 764                 assert_eq!(invoice_request.amount_msats(), Some(1000));
 765                 assert_eq!(tlv_stream.amount, Some(1000));
 766
 767                 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
 768                         .amount_msats(1000)
 769                         .build().unwrap()
 770                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
 771                         .amount_msats(1001).unwrap()
 772                         .build().unwrap()
 773                         .sign(payer_sign).unwrap();
 774                 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
 775                 assert_eq!(invoice_request.amount_msats(), Some(1001));
 776                 assert_eq!(tlv_stream.amount, Some(1001));
 777
 778                 match OfferBuilder::new("foo".into(), recipient_pubkey())
 779                         .amount_msats(1000)
 780                         .build().unwrap()
 781                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
 782                         .amount_msats(999)
 783                 {
 784                         Ok(_) => panic!("expected error"),
 785                         Err(e) => assert_eq!(e, SemanticError::InsufficientAmount),
 786                 }
 787
 788                 match OfferBuilder::new("foo".into(), recipient_pubkey())
 789                         .amount_msats(1000)
 790                         .supported_quantity(Quantity::Unbounded)
 791                         .build().unwrap()
 792                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
 793                         .quantity(2).unwrap()
 794                         .amount_msats(1000)
 795                 {
 796                         Ok(_) => panic!("expected error"),
 797                         Err(e) => assert_eq!(e, SemanticError::InsufficientAmount),
 798                 }
 799
 800                 match OfferBuilder::new("foo".into(), recipient_pubkey())
 801                         .amount_msats(1000)
 802                         .build().unwrap()
 803                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
 804                         .amount_msats(MAX_VALUE_MSAT + 1)
 805                 {
 806                         Ok(_) => panic!("expected error"),
 807                         Err(e) => assert_eq!(e, SemanticError::InvalidAmount),
 808                 }
 809
 810                 match OfferBuilder::new("foo".into(), recipient_pubkey())
 811                         .amount_msats(1000)
 812                         .supported_quantity(Quantity::Unbounded)
 813                         .build().unwrap()
 814                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
 815                         .amount_msats(1000).unwrap()
 816                         .quantity(2).unwrap()
 817                         .build()
 818                 {
 819                         Ok(_) => panic!("expected error"),
 820                         Err(e) => assert_eq!(e, SemanticError::InsufficientAmount),
 821                 }
 822
 823                 match OfferBuilder::new("foo".into(), recipient_pubkey())
 824                         .build().unwrap()
 825                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
 826                         .build()
 827                 {
 828                         Ok(_) => panic!("expected error"),
 829                         Err(e) => assert_eq!(e, SemanticError::MissingAmount),
 830                 }
 831         }
 832
 833         #[test]
 834         fn builds_invoice_request_with_features() {
 835                 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
 836                         .amount_msats(1000)
 837                         .build().unwrap()
 838                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
 839                         .features_unchecked(InvoiceRequestFeatures::unknown())
 840                         .build().unwrap()
 841                         .sign(payer_sign).unwrap();
 842                 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
 843                 assert_eq!(invoice_request.features(), &InvoiceRequestFeatures::unknown());
 844                 assert_eq!(tlv_stream.features, Some(&InvoiceRequestFeatures::unknown()));
 845
 846                 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
 847                         .amount_msats(1000)
 848                         .build().unwrap()
 849                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
 850                         .features_unchecked(InvoiceRequestFeatures::unknown())
 851                         .features_unchecked(InvoiceRequestFeatures::empty())
 852                         .build().unwrap()
 853                         .sign(payer_sign).unwrap();
 854                 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
 855                 assert_eq!(invoice_request.features(), &InvoiceRequestFeatures::empty());
 856                 assert_eq!(tlv_stream.features, None);
 857         }
 858
 859         #[test]
 860         fn builds_invoice_request_with_quantity() {
 861                 let one = NonZeroU64::new(1).unwrap();
 862                 let ten = NonZeroU64::new(10).unwrap();
 863
 864                 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
 865                         .amount_msats(1000)
 866                         .supported_quantity(Quantity::One)
 867                         .build().unwrap()
 868                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
 869                         .build().unwrap()
 870                         .sign(payer_sign).unwrap();
 871                 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
 872                 assert_eq!(invoice_request.quantity(), None);
 873                 assert_eq!(tlv_stream.quantity, None);
 874
 875                 match OfferBuilder::new("foo".into(), recipient_pubkey())
 876                         .amount_msats(1000)
 877                         .supported_quantity(Quantity::One)
 878                         .build().unwrap()
 879                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
 880                         .amount_msats(2_000).unwrap()
 881                         .quantity(2)
 882                 {
 883                         Ok(_) => panic!("expected error"),
 884                         Err(e) => assert_eq!(e, SemanticError::UnexpectedQuantity),
 885                 }
 886
 887                 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
 888                         .amount_msats(1000)
 889                         .supported_quantity(Quantity::Bounded(ten))
 890                         .build().unwrap()
 891                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
 892                         .amount_msats(10_000).unwrap()
 893                         .quantity(10).unwrap()
 894                         .build().unwrap()
 895                         .sign(payer_sign).unwrap();
 896                 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
 897                 assert_eq!(invoice_request.amount_msats(), Some(10_000));
 898                 assert_eq!(tlv_stream.amount, Some(10_000));
 899
 900                 match OfferBuilder::new("foo".into(), recipient_pubkey())
 901                         .amount_msats(1000)
 902                         .supported_quantity(Quantity::Bounded(ten))
 903                         .build().unwrap()
 904                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
 905                         .amount_msats(11_000).unwrap()
 906                         .quantity(11)
 907                 {
 908                         Ok(_) => panic!("expected error"),
 909                         Err(e) => assert_eq!(e, SemanticError::InvalidQuantity),
 910                 }
 911
 912                 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
 913                         .amount_msats(1000)
 914                         .supported_quantity(Quantity::Unbounded)
 915                         .build().unwrap()
 916                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
 917                         .amount_msats(2_000).unwrap()
 918                         .quantity(2).unwrap()
 919                         .build().unwrap()
 920                         .sign(payer_sign).unwrap();
 921                 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
 922                 assert_eq!(invoice_request.amount_msats(), Some(2_000));
 923                 assert_eq!(tlv_stream.amount, Some(2_000));
 924
 925                 match OfferBuilder::new("foo".into(), recipient_pubkey())
 926                         .amount_msats(1000)
 927                         .supported_quantity(Quantity::Unbounded)
 928                         .build().unwrap()
 929                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
 930                         .build()
 931                 {
 932                         Ok(_) => panic!("expected error"),
 933                         Err(e) => assert_eq!(e, SemanticError::MissingQuantity),
 934                 }
 935
 936                 match OfferBuilder::new("foo".into(), recipient_pubkey())
 937                         .amount_msats(1000)
 938                         .supported_quantity(Quantity::Bounded(one))
 939                         .build().unwrap()
 940                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
 941                         .build()
 942                 {
 943                         Ok(_) => panic!("expected error"),
 944                         Err(e) => assert_eq!(e, SemanticError::MissingQuantity),
 945                 }
 946         }
 947
 948         #[test]
 949         fn builds_invoice_request_with_payer_note() {
 950                 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
 951                         .amount_msats(1000)
 952                         .build().unwrap()
 953                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
 954                         .payer_note("bar".into())
 955                         .build().unwrap()
 956                         .sign(payer_sign).unwrap();
 957                 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
 958                 assert_eq!(invoice_request.payer_note(), Some(PrintableString("bar")));
 959                 assert_eq!(tlv_stream.payer_note, Some(&String::from("bar")));
 960
 961                 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
 962                         .amount_msats(1000)
 963                         .build().unwrap()
 964                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
 965                         .payer_note("bar".into())
 966                         .payer_note("baz".into())
 967                         .build().unwrap()
 968                         .sign(payer_sign).unwrap();
 969                 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
 970                 assert_eq!(invoice_request.payer_note(), Some(PrintableString("baz")));
 971                 assert_eq!(tlv_stream.payer_note, Some(&String::from("baz")));
 972         }
 973
 974         #[test]
 975         fn fails_signing_invoice_request() {
 976                 match OfferBuilder::new("foo".into(), recipient_pubkey())
 977                         .amount_msats(1000)
 978                         .build().unwrap()
 979                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
 980                         .build().unwrap()
 981                         .sign(|_| Err(()))
 982                 {
 983                         Ok(_) => panic!("expected error"),
 984                         Err(e) => assert_eq!(e, SignError::Signing(())),
 985                 }
 986
 987                 match OfferBuilder::new("foo".into(), recipient_pubkey())
 988                         .amount_msats(1000)
 989                         .build().unwrap()
 990                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
 991                         .build().unwrap()
 992                         .sign(recipient_sign)
 993                 {
 994                         Ok(_) => panic!("expected error"),
 995                         Err(e) => assert_eq!(e, SignError::Verification(secp256k1::Error::InvalidSignature)),
 996                 }
 997         }
 998
 999         #[test]
1000         fn parses_invoice_request_with_metadata() {
1001                 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1002                         .amount_msats(1000)
1003                         .build().unwrap()
1004                         .request_invoice(vec![42; 32], payer_pubkey()).unwrap()
1005                         .build().unwrap()
1006                         .sign(payer_sign).unwrap();
1007
1008                 let mut buffer = Vec::new();
1009                 invoice_request.write(&mut buffer).unwrap();
1010
1011                 if let Err(e) = InvoiceRequest::try_from(buffer) {
1012                         panic!("error parsing invoice_request: {:?}", e);
1013                 }
1014         }
1015
1016         #[test]
1017         fn parses_invoice_request_with_chain() {
1018                 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1019                         .amount_msats(1000)
1020                         .build().unwrap()
1021                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1022                         .chain(Network::Bitcoin).unwrap()
1023                         .build().unwrap()
1024                         .sign(payer_sign).unwrap();
1025
1026                 let mut buffer = Vec::new();
1027                 invoice_request.write(&mut buffer).unwrap();
1028
1029                 if let Err(e) = InvoiceRequest::try_from(buffer) {
1030                         panic!("error parsing invoice_request: {:?}", e);
1031                 }
1032
1033                 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1034                         .amount_msats(1000)
1035                         .build().unwrap()
1036                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1037                         .chain_unchecked(Network::Testnet)
1038                         .build_unchecked()
1039                         .sign(payer_sign).unwrap();
1040
1041                 let mut buffer = Vec::new();
1042                 invoice_request.write(&mut buffer).unwrap();
1043
1044                 match InvoiceRequest::try_from(buffer) {
1045                         Ok(_) => panic!("expected error"),
1046                         Err(e) => assert_eq!(e, ParseError::InvalidSemantics(SemanticError::UnsupportedChain)),
1047                 }
1048         }
1049
1050         #[test]
1051         fn parses_invoice_request_with_amount() {
1052                 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1053                         .amount_msats(1000)
1054                         .build().unwrap()
1055                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1056                         .build().unwrap()
1057                         .sign(payer_sign).unwrap();
1058
1059                 let mut buffer = Vec::new();
1060                 invoice_request.write(&mut buffer).unwrap();
1061
1062                 if let Err(e) = InvoiceRequest::try_from(buffer) {
1063                         panic!("error parsing invoice_request: {:?}", e);
1064                 }
1065
1066                 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1067                         .build().unwrap()
1068                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1069                         .amount_msats(1000).unwrap()
1070                         .build().unwrap()
1071                         .sign(payer_sign).unwrap();
1072
1073                 let mut buffer = Vec::new();
1074                 invoice_request.write(&mut buffer).unwrap();
1075
1076                 if let Err(e) = InvoiceRequest::try_from(buffer) {
1077                         panic!("error parsing invoice_request: {:?}", e);
1078                 }
1079
1080                 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1081                         .build().unwrap()
1082                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1083                         .build_unchecked()
1084                         .sign(payer_sign).unwrap();
1085
1086                 let mut buffer = Vec::new();
1087                 invoice_request.write(&mut buffer).unwrap();
1088
1089                 match InvoiceRequest::try_from(buffer) {
1090                         Ok(_) => panic!("expected error"),
1091                         Err(e) => assert_eq!(e, ParseError::InvalidSemantics(SemanticError::MissingAmount)),
1092                 }
1093
1094                 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1095                         .amount_msats(1000)
1096                         .build().unwrap()
1097                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1098                         .amount_msats_unchecked(999)
1099                         .build_unchecked()
1100                         .sign(payer_sign).unwrap();
1101
1102                 let mut buffer = Vec::new();
1103                 invoice_request.write(&mut buffer).unwrap();
1104
1105                 match InvoiceRequest::try_from(buffer) {
1106                         Ok(_) => panic!("expected error"),
1107                         Err(e) => assert_eq!(e, ParseError::InvalidSemantics(SemanticError::InsufficientAmount)),
1108                 }
1109
1110                 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1111                         .amount(Amount::Currency { iso4217_code: *b"USD", amount: 1000 })
1112                         .build_unchecked()
1113                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1114                         .build_unchecked()
1115                         .sign(payer_sign).unwrap();
1116
1117                 let mut buffer = Vec::new();
1118                 invoice_request.write(&mut buffer).unwrap();
1119
1120                 match InvoiceRequest::try_from(buffer) {
1121                         Ok(_) => panic!("expected error"),
1122                         Err(e) => {
1123                                 assert_eq!(e, ParseError::InvalidSemantics(SemanticError::UnsupportedCurrency));
1124                         },
1125                 }
1126         }
1127
1128         #[test]
1129         fn parses_invoice_request_with_quantity() {
1130                 let one = NonZeroU64::new(1).unwrap();
1131                 let ten = NonZeroU64::new(10).unwrap();
1132
1133                 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1134                         .amount_msats(1000)
1135                         .supported_quantity(Quantity::One)
1136                         .build().unwrap()
1137                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1138                         .build().unwrap()
1139                         .sign(payer_sign).unwrap();
1140
1141                 let mut buffer = Vec::new();
1142                 invoice_request.write(&mut buffer).unwrap();
1143
1144                 if let Err(e) = InvoiceRequest::try_from(buffer) {
1145                         panic!("error parsing invoice_request: {:?}", e);
1146                 }
1147
1148                 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1149                         .amount_msats(1000)
1150                         .supported_quantity(Quantity::One)
1151                         .build().unwrap()
1152                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1153                         .amount_msats(2_000).unwrap()
1154                         .quantity_unchecked(2)
1155                         .build_unchecked()
1156                         .sign(payer_sign).unwrap();
1157
1158                 let mut buffer = Vec::new();
1159                 invoice_request.write(&mut buffer).unwrap();
1160
1161                 match InvoiceRequest::try_from(buffer) {
1162                         Ok(_) => panic!("expected error"),
1163                         Err(e) => {
1164                                 assert_eq!(e, ParseError::InvalidSemantics(SemanticError::UnexpectedQuantity));
1165                         },
1166                 }
1167
1168                 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1169                         .amount_msats(1000)
1170                         .supported_quantity(Quantity::Bounded(ten))
1171                         .build().unwrap()
1172                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1173                         .amount_msats(10_000).unwrap()
1174                         .quantity(10).unwrap()
1175                         .build().unwrap()
1176                         .sign(payer_sign).unwrap();
1177
1178                 let mut buffer = Vec::new();
1179                 invoice_request.write(&mut buffer).unwrap();
1180
1181                 if let Err(e) = InvoiceRequest::try_from(buffer) {
1182                         panic!("error parsing invoice_request: {:?}", e);
1183                 }
1184
1185                 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1186                         .amount_msats(1000)
1187                         .supported_quantity(Quantity::Bounded(ten))
1188                         .build().unwrap()
1189                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1190                         .amount_msats(11_000).unwrap()
1191                         .quantity_unchecked(11)
1192                         .build_unchecked()
1193                         .sign(payer_sign).unwrap();
1194
1195                 let mut buffer = Vec::new();
1196                 invoice_request.write(&mut buffer).unwrap();
1197
1198                 match InvoiceRequest::try_from(buffer) {
1199                         Ok(_) => panic!("expected error"),
1200                         Err(e) => assert_eq!(e, ParseError::InvalidSemantics(SemanticError::InvalidQuantity)),
1201                 }
1202
1203                 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1204                         .amount_msats(1000)
1205                         .supported_quantity(Quantity::Unbounded)
1206                         .build().unwrap()
1207                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1208                         .amount_msats(2_000).unwrap()
1209                         .quantity(2).unwrap()
1210                         .build().unwrap()
1211                         .sign(payer_sign).unwrap();
1212
1213                 let mut buffer = Vec::new();
1214                 invoice_request.write(&mut buffer).unwrap();
1215
1216                 if let Err(e) = InvoiceRequest::try_from(buffer) {
1217                         panic!("error parsing invoice_request: {:?}", e);
1218                 }
1219
1220                 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1221                         .amount_msats(1000)
1222                         .supported_quantity(Quantity::Unbounded)
1223                         .build().unwrap()
1224                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1225                         .build_unchecked()
1226                         .sign(payer_sign).unwrap();
1227
1228                 let mut buffer = Vec::new();
1229                 invoice_request.write(&mut buffer).unwrap();
1230
1231                 match InvoiceRequest::try_from(buffer) {
1232                         Ok(_) => panic!("expected error"),
1233                         Err(e) => assert_eq!(e, ParseError::InvalidSemantics(SemanticError::MissingQuantity)),
1234                 }
1235
1236                 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1237                         .amount_msats(1000)
1238                         .supported_quantity(Quantity::Bounded(one))
1239                         .build().unwrap()
1240                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1241                         .build_unchecked()
1242                         .sign(payer_sign).unwrap();
1243
1244                 let mut buffer = Vec::new();
1245                 invoice_request.write(&mut buffer).unwrap();
1246
1247                 match InvoiceRequest::try_from(buffer) {
1248                         Ok(_) => panic!("expected error"),
1249                         Err(e) => assert_eq!(e, ParseError::InvalidSemantics(SemanticError::MissingQuantity)),
1250                 }
1251         }
1252
1253         #[test]
1254         fn fails_parsing_invoice_request_without_metadata() {
1255                 let offer = OfferBuilder::new("foo".into(), recipient_pubkey())
1256                         .amount_msats(1000)
1257                         .build().unwrap();
1258                 let unsigned_invoice_request = offer.request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1259                         .build().unwrap();
1260                 let mut tlv_stream = unsigned_invoice_request.invoice_request.as_tlv_stream();
1261                 tlv_stream.0.metadata = None;
1262
1263                 let mut buffer = Vec::new();
1264                 tlv_stream.write(&mut buffer).unwrap();
1265
1266                 match InvoiceRequest::try_from(buffer) {
1267                         Ok(_) => panic!("expected error"),
1268                         Err(e) => {
1269                                 assert_eq!(e, ParseError::InvalidSemantics(SemanticError::MissingPayerMetadata));
1270                         },
1271                 }
1272         }
1273
1274         #[test]
1275         fn fails_parsing_invoice_request_without_payer_id() {
1276                 let offer = OfferBuilder::new("foo".into(), recipient_pubkey())
1277                         .amount_msats(1000)
1278                         .build().unwrap();
1279                 let unsigned_invoice_request = offer.request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1280                         .build().unwrap();
1281                 let mut tlv_stream = unsigned_invoice_request.invoice_request.as_tlv_stream();
1282                 tlv_stream.2.payer_id = None;
1283
1284                 let mut buffer = Vec::new();
1285                 tlv_stream.write(&mut buffer).unwrap();
1286
1287                 match InvoiceRequest::try_from(buffer) {
1288                         Ok(_) => panic!("expected error"),
1289                         Err(e) => assert_eq!(e, ParseError::InvalidSemantics(SemanticError::MissingPayerId)),
1290                 }
1291         }
1292
1293         #[test]
1294         fn fails_parsing_invoice_request_without_node_id() {
1295                 let offer = OfferBuilder::new("foo".into(), recipient_pubkey())
1296                         .amount_msats(1000)
1297                         .build().unwrap();
1298                 let unsigned_invoice_request = offer.request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1299                         .build().unwrap();
1300                 let mut tlv_stream = unsigned_invoice_request.invoice_request.as_tlv_stream();
1301                 tlv_stream.1.node_id = None;
1302
1303                 let mut buffer = Vec::new();
1304                 tlv_stream.write(&mut buffer).unwrap();
1305
1306                 match InvoiceRequest::try_from(buffer) {
1307                         Ok(_) => panic!("expected error"),
1308                         Err(e) => {
1309                                 assert_eq!(e, ParseError::InvalidSemantics(SemanticError::MissingSigningPubkey));
1310                         },
1311                 }
1312         }
1313
1314         #[test]
1315         fn fails_parsing_invoice_request_without_signature() {
1316                 let mut buffer = Vec::new();
1317                 OfferBuilder::new("foo".into(), recipient_pubkey())
1318                         .amount_msats(1000)
1319                         .build().unwrap()
1320                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1321                         .build().unwrap()
1322                         .invoice_request
1323                         .write(&mut buffer).unwrap();
1324
1325                 match InvoiceRequest::try_from(buffer) {
1326                         Ok(_) => panic!("expected error"),
1327                         Err(e) => assert_eq!(e, ParseError::InvalidSemantics(SemanticError::MissingSignature)),
1328                 }
1329         }
1330
1331         #[test]
1332         fn fails_parsing_invoice_request_with_invalid_signature() {
1333                 let mut invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1334                         .amount_msats(1000)
1335                         .build().unwrap()
1336                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1337                         .build().unwrap()
1338                         .sign(payer_sign).unwrap();
1339                 let last_signature_byte = invoice_request.bytes.last_mut().unwrap();
1340                 *last_signature_byte = last_signature_byte.wrapping_add(1);
1341
1342                 let mut buffer = Vec::new();
1343                 invoice_request.write(&mut buffer).unwrap();
1344
1345                 match InvoiceRequest::try_from(buffer) {
1346                         Ok(_) => panic!("expected error"),
1347                         Err(e) => {
1348                                 assert_eq!(e, ParseError::InvalidSignature(secp256k1::Error::InvalidSignature));
1349                         },
1350                 }
1351         }
1352
1353         #[test]
1354         fn fails_parsing_invoice_request_with_extra_tlv_records() {
1355                 let secp_ctx = Secp256k1::new();
1356                 let keys = KeyPair::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
1357                 let invoice_request = OfferBuilder::new("foo".into(), keys.public_key())
1358                         .amount_msats(1000)
1359                         .build().unwrap()
1360                         .request_invoice(vec![1; 32], keys.public_key()).unwrap()
1361                         .build().unwrap()
1362                         .sign::<_, Infallible>(|digest| Ok(secp_ctx.sign_schnorr_no_aux_rand(digest, &keys)))
1363                         .unwrap();
1364
1365                 let mut encoded_invoice_request = Vec::new();
1366                 invoice_request.write(&mut encoded_invoice_request).unwrap();
1367                 BigSize(1002).write(&mut encoded_invoice_request).unwrap();
1368                 BigSize(32).write(&mut encoded_invoice_request).unwrap();
1369                 [42u8; 32].write(&mut encoded_invoice_request).unwrap();
1370
1371                 match InvoiceRequest::try_from(encoded_invoice_request) {
1372                         Ok(_) => panic!("expected error"),
1373                         Err(e) => assert_eq!(e, ParseError::Decode(DecodeError::InvalidValue)),
1374                 }
1375         }
1376 }