_ 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 a [`Bolt12Invoice`].
  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 //! [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
  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 lightning::ln::features::OfferFeatures;
  29 //! use lightning::offers::invoice_request::UnsignedInvoiceRequest;
  30 //! use lightning::offers::offer::Offer;
  31 //! use lightning::util::ser::Writeable;
  32 //!
  33 //! # fn parse() -> Result<(), lightning::offers::parse::Bolt12ParseError> {
  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 //! # use lightning::offers::invoice_request::{ExplicitPayerId, InvoiceRequestBuilder};
  40 //! # <InvoiceRequestBuilder<ExplicitPayerId, _>>::from(
  41 //! "lno1qcp4256ypq"
  42 //!     .parse::<Offer>()?
  43 //!     .request_invoice(vec![42; 64], pubkey)?
  44 //! # )
  45 //!     .chain(Network::Testnet)?
  46 //!     .amount_msats(1000)?
  47 //!     .quantity(5)?
  48 //!     .payer_note("foo".to_string())
  49 //!     .build()?
  50 //!     .sign(|message: &UnsignedInvoiceRequest|
  51 //!         Ok(secp_ctx.sign_schnorr_no_aux_rand(message.as_ref().as_digest(), &keys))
  52 //!     )
  53 //!     .expect("failed verifying signature")
  54 //!     .write(&mut buffer)
  55 //!     .unwrap();
  56 //! # Ok(())
  57 //! # }
  58 //! ```
  59
  60 use bitcoin::blockdata::constants::ChainHash;
  61 use bitcoin::network::constants::Network;
  62 use bitcoin::secp256k1::{KeyPair, PublicKey, Secp256k1, self};
  63 use bitcoin::secp256k1::schnorr::Signature;
  64 use core::ops::Deref;
  65 use crate::sign::EntropySource;
  66 use crate::io;
  67 use crate::blinded_path::BlindedPath;
  68 use crate::ln::PaymentHash;
  69 use crate::ln::channelmanager::PaymentId;
  70 use crate::ln::features::InvoiceRequestFeatures;
  71 use crate::ln::inbound_payment::{ExpandedKey, IV_LEN, Nonce};
  72 use crate::ln::msgs::DecodeError;
  73 use crate::offers::invoice::BlindedPayInfo;
  74 use crate::offers::merkle::{SignError, SignFn, SignatureTlvStream, SignatureTlvStreamRef, TaggedHash, self};
  75 use crate::offers::offer::{Offer, OfferContents, OfferId, OfferTlvStream, OfferTlvStreamRef};
  76 use crate::offers::parse::{Bolt12ParseError, ParsedMessage, Bolt12SemanticError};
  77 use crate::offers::payer::{PayerContents, PayerTlvStream, PayerTlvStreamRef};
  78 use crate::offers::signer::{Metadata, MetadataMaterial};
  79 use crate::util::ser::{HighZeroBytesDroppedBigSize, Readable, SeekReadable, WithoutLength, Writeable, Writer};
  80 use crate::util::string::{PrintableString, UntrustedString};
  81
  82 #[cfg(not(c_bindings))]
  83 use {
  84         crate::offers::invoice::{DerivedSigningPubkey, ExplicitSigningPubkey, InvoiceBuilder},
  85 };
  86 #[cfg(c_bindings)]
  87 use {
  88         crate::offers::invoice::{InvoiceWithDerivedSigningPubkeyBuilder, InvoiceWithExplicitSigningPubkeyBuilder},
  89 };
  90
  91 #[allow(unused_imports)]
  92 use crate::prelude::*;
  93
  94 /// Tag for the hash function used when signing an [`InvoiceRequest`]'s merkle root.
  95 pub const SIGNATURE_TAG: &'static str = concat!("lightning", "invoice_request", "signature");
  96
  97 pub(super) const IV_BYTES: &[u8; IV_LEN] = b"LDK Invreq ~~~~~";
  98
  99 /// Builds an [`InvoiceRequest`] from an [`Offer`] for the "offer to be paid" flow.
 100 ///
 101 /// See [module-level documentation] for usage.
 102 ///
 103 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
 104 ///
 105 /// [module-level documentation]: self
 106 pub struct InvoiceRequestBuilder<'a, 'b, P: PayerIdStrategy, T: secp256k1::Signing> {
 107         offer: &'a Offer,
 108         invoice_request: InvoiceRequestContentsWithoutPayerId,
 109         payer_id: Option<PublicKey>,
 110         payer_id_strategy: core::marker::PhantomData<P>,
 111         secp_ctx: Option<&'b Secp256k1<T>>,
 112 }
 113
 114 /// Builds an [`InvoiceRequest`] from an [`Offer`] for the "offer to be paid" flow.
 115 ///
 116 /// See [module-level documentation] for usage.
 117 ///
 118 /// [module-level documentation]: self
 119 #[cfg(c_bindings)]
 120 pub struct InvoiceRequestWithExplicitPayerIdBuilder<'a, 'b> {
 121         offer: &'a Offer,
 122         invoice_request: InvoiceRequestContentsWithoutPayerId,
 123         payer_id: Option<PublicKey>,
 124         payer_id_strategy: core::marker::PhantomData<ExplicitPayerId>,
 125         secp_ctx: Option<&'b Secp256k1<secp256k1::All>>,
 126 }
 127
 128 /// Builds an [`InvoiceRequest`] from an [`Offer`] for the "offer to be paid" flow.
 129 ///
 130 /// See [module-level documentation] for usage.
 131 ///
 132 /// [module-level documentation]: self
 133 #[cfg(c_bindings)]
 134 pub struct InvoiceRequestWithDerivedPayerIdBuilder<'a, 'b> {
 135         offer: &'a Offer,
 136         invoice_request: InvoiceRequestContentsWithoutPayerId,
 137         payer_id: Option<PublicKey>,
 138         payer_id_strategy: core::marker::PhantomData<DerivedPayerId>,
 139         secp_ctx: Option<&'b Secp256k1<secp256k1::All>>,
 140 }
 141
 142 /// Indicates how [`InvoiceRequest::payer_id`] will be set.
 143 ///
 144 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
 145 pub trait PayerIdStrategy {}
 146
 147 /// [`InvoiceRequest::payer_id`] will be explicitly set.
 148 ///
 149 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
 150 pub struct ExplicitPayerId {}
 151
 152 /// [`InvoiceRequest::payer_id`] will be derived.
 153 ///
 154 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
 155 pub struct DerivedPayerId {}
 156
 157 impl PayerIdStrategy for ExplicitPayerId {}
 158 impl PayerIdStrategy for DerivedPayerId {}
 159
 160 macro_rules! invoice_request_explicit_payer_id_builder_methods { ($self: ident, $self_type: ty) => {
 161         #[cfg_attr(c_bindings, allow(dead_code))]
 162         pub(super) fn new(offer: &'a Offer, metadata: Vec<u8>, payer_id: PublicKey) -> Self {
 163                 Self {
 164                         offer,
 165                         invoice_request: Self::create_contents(offer, Metadata::Bytes(metadata)),
 166                         payer_id: Some(payer_id),
 167                         payer_id_strategy: core::marker::PhantomData,
 168                         secp_ctx: None,
 169                 }
 170         }
 171
 172         #[cfg_attr(c_bindings, allow(dead_code))]
 173         pub(super) fn deriving_metadata<ES: Deref>(
 174                 offer: &'a Offer, payer_id: PublicKey, expanded_key: &ExpandedKey, entropy_source: ES,
 175                 payment_id: PaymentId,
 176         ) -> Self where ES::Target: EntropySource {
 177                 let nonce = Nonce::from_entropy_source(entropy_source);
 178                 let payment_id = Some(payment_id);
 179                 let derivation_material = MetadataMaterial::new(nonce, expanded_key, IV_BYTES, payment_id);
 180                 let metadata = Metadata::Derived(derivation_material);
 181                 Self {
 182                         offer,
 183                         invoice_request: Self::create_contents(offer, metadata),
 184                         payer_id: Some(payer_id),
 185                         payer_id_strategy: core::marker::PhantomData,
 186                         secp_ctx: None,
 187                 }
 188         }
 189
 190         /// Builds an unsigned [`InvoiceRequest`] after checking for valid semantics. It can be signed
 191         /// by [`UnsignedInvoiceRequest::sign`].
 192         pub fn build($self: $self_type) -> Result<UnsignedInvoiceRequest, Bolt12SemanticError> {
 193                 let (unsigned_invoice_request, keys, _) = $self.build_with_checks()?;
 194                 debug_assert!(keys.is_none());
 195                 Ok(unsigned_invoice_request)
 196         }
 197 } }
 198
 199 macro_rules! invoice_request_derived_payer_id_builder_methods { (
 200         $self: ident, $self_type: ty, $secp_context: ty
 201 ) => {
 202         #[cfg_attr(c_bindings, allow(dead_code))]
 203         pub(super) fn deriving_payer_id<ES: Deref>(
 204                 offer: &'a Offer, expanded_key: &ExpandedKey, entropy_source: ES,
 205                 secp_ctx: &'b Secp256k1<$secp_context>, payment_id: PaymentId
 206         ) -> Self where ES::Target: EntropySource {
 207                 let nonce = Nonce::from_entropy_source(entropy_source);
 208                 let payment_id = Some(payment_id);
 209                 let derivation_material = MetadataMaterial::new(nonce, expanded_key, IV_BYTES, payment_id);
 210                 let metadata = Metadata::DerivedSigningPubkey(derivation_material);
 211                 Self {
 212                         offer,
 213                         invoice_request: Self::create_contents(offer, metadata),
 214                         payer_id: None,
 215                         payer_id_strategy: core::marker::PhantomData,
 216                         secp_ctx: Some(secp_ctx),
 217                 }
 218         }
 219
 220         /// Builds a signed [`InvoiceRequest`] after checking for valid semantics.
 221         pub fn build_and_sign($self: $self_type) -> Result<InvoiceRequest, Bolt12SemanticError> {
 222                 let (unsigned_invoice_request, keys, secp_ctx) = $self.build_with_checks()?;
 223                 #[cfg(c_bindings)]
 224                 let mut unsigned_invoice_request = unsigned_invoice_request;
 225                 debug_assert!(keys.is_some());
 226
 227                 let secp_ctx = secp_ctx.unwrap();
 228                 let keys = keys.unwrap();
 229                 let invoice_request = unsigned_invoice_request
 230                         .sign(|message: &UnsignedInvoiceRequest|
 231                                 Ok(secp_ctx.sign_schnorr_no_aux_rand(message.as_ref().as_digest(), &keys))
 232                         )
 233                         .unwrap();
 234                 Ok(invoice_request)
 235         }
 236 } }
 237
 238 macro_rules! invoice_request_builder_methods { (
 239         $self: ident, $self_type: ty, $return_type: ty, $return_value: expr, $secp_context: ty $(, $self_mut: tt)?
 240 ) => {
 241         #[cfg_attr(c_bindings, allow(dead_code))]
 242         fn create_contents(offer: &Offer, metadata: Metadata) -> InvoiceRequestContentsWithoutPayerId {
 243                 let offer = offer.contents.clone();
 244                 InvoiceRequestContentsWithoutPayerId {
 245                         payer: PayerContents(metadata), offer, chain: None, amount_msats: None,
 246                         features: InvoiceRequestFeatures::empty(), quantity: None, payer_note: None,
 247                 }
 248         }
 249
 250         /// Sets the [`InvoiceRequest::chain`] of the given [`Network`] for paying an invoice. If not
 251         /// called, [`Network::Bitcoin`] is assumed. Errors if the chain for `network` is not supported
 252         /// by the offer.
 253         ///
 254         /// Successive calls to this method will override the previous setting.
 255         pub fn chain($self: $self_type, network: Network) -> Result<$return_type, Bolt12SemanticError> {
 256                 $self.chain_hash(ChainHash::using_genesis_block(network))
 257         }
 258
 259         /// Sets the [`InvoiceRequest::chain`] for paying an invoice. If not called, the chain hash of
 260         /// [`Network::Bitcoin`] is assumed. Errors if the chain for `network` is not supported by the
 261         /// offer.
 262         ///
 263         /// Successive calls to this method will override the previous setting.
 264         pub(crate) fn chain_hash($($self_mut)* $self: $self_type, chain: ChainHash) -> Result<$return_type, Bolt12SemanticError> {
 265                 if !$self.offer.supports_chain(chain) {
 266                         return Err(Bolt12SemanticError::UnsupportedChain);
 267                 }
 268
 269                 $self.invoice_request.chain = Some(chain);
 270                 Ok($return_value)
 271         }
 272
 273         /// Sets the [`InvoiceRequest::amount_msats`] for paying an invoice. Errors if `amount_msats` is
 274         /// not at least the expected invoice amount (i.e., [`Offer::amount`] times [`quantity`]).
 275         ///
 276         /// Successive calls to this method will override the previous setting.
 277         ///
 278         /// [`quantity`]: Self::quantity
 279         pub fn amount_msats($($self_mut)* $self: $self_type, amount_msats: u64) -> Result<$return_type, Bolt12SemanticError> {
 280                 $self.invoice_request.offer.check_amount_msats_for_quantity(
 281                         Some(amount_msats), $self.invoice_request.quantity
 282                 )?;
 283                 $self.invoice_request.amount_msats = Some(amount_msats);
 284                 Ok($return_value)
 285         }
 286
 287         /// Sets [`InvoiceRequest::quantity`] of items. If not set, `1` is assumed. Errors if `quantity`
 288         /// does not conform to [`Offer::is_valid_quantity`].
 289         ///
 290         /// Successive calls to this method will override the previous setting.
 291         pub fn quantity($($self_mut)* $self: $self_type, quantity: u64) -> Result<$return_type, Bolt12SemanticError> {
 292                 $self.invoice_request.offer.check_quantity(Some(quantity))?;
 293                 $self.invoice_request.quantity = Some(quantity);
 294                 Ok($return_value)
 295         }
 296
 297         /// Sets the [`InvoiceRequest::payer_note`].
 298         ///
 299         /// Successive calls to this method will override the previous setting.
 300         pub fn payer_note($($self_mut)* $self: $self_type, payer_note: String) -> $return_type {
 301                 $self.invoice_request.payer_note = Some(payer_note);
 302                 $return_value
 303         }
 304
 305         fn build_with_checks($($self_mut)* $self: $self_type) -> Result<
 306                 (UnsignedInvoiceRequest, Option<KeyPair>, Option<&'b Secp256k1<$secp_context>>),
 307                 Bolt12SemanticError
 308         > {
 309                 #[cfg(feature = "std")] {
 310                         if $self.offer.is_expired() {
 311                                 return Err(Bolt12SemanticError::AlreadyExpired);
 312                         }
 313                 }
 314
 315                 let chain = $self.invoice_request.chain();
 316                 if !$self.offer.supports_chain(chain) {
 317                         return Err(Bolt12SemanticError::UnsupportedChain);
 318                 }
 319
 320                 if chain == $self.offer.implied_chain() {
 321                         $self.invoice_request.chain = None;
 322                 }
 323
 324                 if $self.offer.amount().is_none() && $self.invoice_request.amount_msats.is_none() {
 325                         return Err(Bolt12SemanticError::MissingAmount);
 326                 }
 327
 328                 $self.invoice_request.offer.check_quantity($self.invoice_request.quantity)?;
 329                 $self.invoice_request.offer.check_amount_msats_for_quantity(
 330                         $self.invoice_request.amount_msats, $self.invoice_request.quantity
 331                 )?;
 332
 333                 Ok($self.build_without_checks())
 334         }
 335
 336         fn build_without_checks($($self_mut)* $self: $self_type) ->
 337                 (UnsignedInvoiceRequest, Option<KeyPair>, Option<&'b Secp256k1<$secp_context>>)
 338         {
 339                 // Create the metadata for stateless verification of a Bolt12Invoice.
 340                 let mut keys = None;
 341                 let secp_ctx = $self.secp_ctx.clone();
 342                 if $self.invoice_request.payer.0.has_derivation_material() {
 343                         let mut metadata = core::mem::take(&mut $self.invoice_request.payer.0);
 344
 345                         let mut tlv_stream = $self.invoice_request.as_tlv_stream();
 346                         debug_assert!(tlv_stream.2.payer_id.is_none());
 347                         tlv_stream.0.metadata = None;
 348                         if !metadata.derives_payer_keys() {
 349                                 tlv_stream.2.payer_id = $self.payer_id.as_ref();
 350                         }
 351
 352                         let (derived_metadata, derived_keys) = metadata.derive_from(tlv_stream, $self.secp_ctx);
 353                         metadata = derived_metadata;
 354                         keys = derived_keys;
 355                         if let Some(keys) = keys {
 356                                 debug_assert!($self.payer_id.is_none());
 357                                 $self.payer_id = Some(keys.public_key());
 358                         }
 359
 360                         $self.invoice_request.payer.0 = metadata;
 361                 }
 362
 363                 debug_assert!($self.invoice_request.payer.0.as_bytes().is_some());
 364                 debug_assert!($self.payer_id.is_some());
 365                 let payer_id = $self.payer_id.unwrap();
 366
 367                 let invoice_request = InvoiceRequestContents {
 368                         #[cfg(not(c_bindings))]
 369                         inner: $self.invoice_request,
 370                         #[cfg(c_bindings)]
 371                         inner: $self.invoice_request.clone(),
 372                         payer_id,
 373                 };
 374                 let unsigned_invoice_request = UnsignedInvoiceRequest::new($self.offer, invoice_request);
 375
 376                 (unsigned_invoice_request, keys, secp_ctx)
 377         }
 378 } }
 379
 380 #[cfg(test)]
 381 macro_rules! invoice_request_builder_test_methods { (
 382         $self: ident, $self_type: ty, $return_type: ty, $return_value: expr $(, $self_mut: tt)?
 383 ) => {
 384         #[cfg_attr(c_bindings, allow(dead_code))]
 385         fn chain_unchecked($($self_mut)* $self: $self_type, network: Network) -> $return_type {
 386                 let chain = ChainHash::using_genesis_block(network);
 387                 $self.invoice_request.chain = Some(chain);
 388                 $return_value
 389         }
 390
 391         #[cfg_attr(c_bindings, allow(dead_code))]
 392         fn amount_msats_unchecked($($self_mut)* $self: $self_type, amount_msats: u64) -> $return_type {
 393                 $self.invoice_request.amount_msats = Some(amount_msats);
 394                 $return_value
 395         }
 396
 397         #[cfg_attr(c_bindings, allow(dead_code))]
 398         fn features_unchecked($($self_mut)* $self: $self_type, features: InvoiceRequestFeatures) -> $return_type {
 399                 $self.invoice_request.features = features;
 400                 $return_value
 401         }
 402
 403         #[cfg_attr(c_bindings, allow(dead_code))]
 404         fn quantity_unchecked($($self_mut)* $self: $self_type, quantity: u64) -> $return_type {
 405                 $self.invoice_request.quantity = Some(quantity);
 406                 $return_value
 407         }
 408
 409         #[cfg_attr(c_bindings, allow(dead_code))]
 410         pub(super) fn build_unchecked($self: $self_type) -> UnsignedInvoiceRequest {
 411                 $self.build_without_checks().0
 412         }
 413 } }
 414
 415 impl<'a, 'b, T: secp256k1::Signing> InvoiceRequestBuilder<'a, 'b, ExplicitPayerId, T> {
 416         invoice_request_explicit_payer_id_builder_methods!(self, Self);
 417 }
 418
 419 impl<'a, 'b, T: secp256k1::Signing> InvoiceRequestBuilder<'a, 'b, DerivedPayerId, T> {
 420         invoice_request_derived_payer_id_builder_methods!(self, Self, T);
 421 }
 422
 423 impl<'a, 'b, P: PayerIdStrategy, T: secp256k1::Signing> InvoiceRequestBuilder<'a, 'b, P, T> {
 424         invoice_request_builder_methods!(self, Self, Self, self, T, mut);
 425
 426         #[cfg(test)]
 427         invoice_request_builder_test_methods!(self, Self, Self, self, mut);
 428 }
 429
 430 #[cfg(all(c_bindings, not(test)))]
 431 impl<'a, 'b> InvoiceRequestWithExplicitPayerIdBuilder<'a, 'b> {
 432         invoice_request_explicit_payer_id_builder_methods!(self, &mut Self);
 433         invoice_request_builder_methods!(self, &mut Self, (), (), secp256k1::All);
 434 }
 435
 436 #[cfg(all(c_bindings, test))]
 437 impl<'a, 'b> InvoiceRequestWithExplicitPayerIdBuilder<'a, 'b> {
 438         invoice_request_explicit_payer_id_builder_methods!(self, &mut Self);
 439         invoice_request_builder_methods!(self, &mut Self, &mut Self, self, secp256k1::All);
 440         invoice_request_builder_test_methods!(self, &mut Self, &mut Self, self);
 441 }
 442
 443 #[cfg(all(c_bindings, not(test)))]
 444 impl<'a, 'b> InvoiceRequestWithDerivedPayerIdBuilder<'a, 'b> {
 445         invoice_request_derived_payer_id_builder_methods!(self, &mut Self, secp256k1::All);
 446         invoice_request_builder_methods!(self, &mut Self, (), (), secp256k1::All);
 447 }
 448
 449 #[cfg(all(c_bindings, test))]
 450 impl<'a, 'b> InvoiceRequestWithDerivedPayerIdBuilder<'a, 'b> {
 451         invoice_request_derived_payer_id_builder_methods!(self, &mut Self, secp256k1::All);
 452         invoice_request_builder_methods!(self, &mut Self, &mut Self, self, secp256k1::All);
 453         invoice_request_builder_test_methods!(self, &mut Self, &mut Self, self);
 454 }
 455
 456 #[cfg(c_bindings)]
 457 impl<'a, 'b> From<InvoiceRequestWithExplicitPayerIdBuilder<'a, 'b>>
 458 for InvoiceRequestBuilder<'a, 'b, ExplicitPayerId, secp256k1::All> {
 459         fn from(builder: InvoiceRequestWithExplicitPayerIdBuilder<'a, 'b>) -> Self {
 460                 let InvoiceRequestWithExplicitPayerIdBuilder {
 461                         offer, invoice_request, payer_id, payer_id_strategy, secp_ctx,
 462                 } = builder;
 463
 464                 Self {
 465                         offer, invoice_request, payer_id, payer_id_strategy, secp_ctx,
 466                 }
 467         }
 468 }
 469
 470 #[cfg(c_bindings)]
 471 impl<'a, 'b> From<InvoiceRequestWithDerivedPayerIdBuilder<'a, 'b>>
 472 for InvoiceRequestBuilder<'a, 'b, DerivedPayerId, secp256k1::All> {
 473         fn from(builder: InvoiceRequestWithDerivedPayerIdBuilder<'a, 'b>) -> Self {
 474                 let InvoiceRequestWithDerivedPayerIdBuilder {
 475                         offer, invoice_request, payer_id, payer_id_strategy, secp_ctx,
 476                 } = builder;
 477
 478                 Self {
 479                         offer, invoice_request, payer_id, payer_id_strategy, secp_ctx,
 480                 }
 481         }
 482 }
 483
 484 /// A semantically valid [`InvoiceRequest`] that hasn't been signed.
 485 ///
 486 /// # Serialization
 487 ///
 488 /// This is serialized as a TLV stream, which includes TLV records from the originating message. As
 489 /// such, it may include unknown, odd TLV records.
 490 pub struct UnsignedInvoiceRequest {
 491         bytes: Vec<u8>,
 492         contents: InvoiceRequestContents,
 493         tagged_hash: TaggedHash,
 494 }
 495
 496 /// A function for signing an [`UnsignedInvoiceRequest`].
 497 pub trait SignInvoiceRequestFn {
 498         /// Signs a [`TaggedHash`] computed over the merkle root of `message`'s TLV stream.
 499         fn sign_invoice_request(&self, message: &UnsignedInvoiceRequest) -> Result<Signature, ()>;
 500 }
 501
 502 impl<F> SignInvoiceRequestFn for F
 503 where
 504         F: Fn(&UnsignedInvoiceRequest) -> Result<Signature, ()>,
 505 {
 506         fn sign_invoice_request(&self, message: &UnsignedInvoiceRequest) -> Result<Signature, ()> {
 507                 self(message)
 508         }
 509 }
 510
 511 impl<F> SignFn<UnsignedInvoiceRequest> for F
 512 where
 513         F: SignInvoiceRequestFn,
 514 {
 515         fn sign(&self, message: &UnsignedInvoiceRequest) -> Result<Signature, ()> {
 516                 self.sign_invoice_request(message)
 517         }
 518 }
 519
 520 impl UnsignedInvoiceRequest {
 521         fn new(offer: &Offer, contents: InvoiceRequestContents) -> Self {
 522                 // Use the offer bytes instead of the offer TLV stream as the offer may have contained
 523                 // unknown TLV records, which are not stored in `OfferContents`.
 524                 let (payer_tlv_stream, _offer_tlv_stream, invoice_request_tlv_stream) =
 525                         contents.as_tlv_stream();
 526                 let offer_bytes = WithoutLength(&offer.bytes);
 527                 let unsigned_tlv_stream = (payer_tlv_stream, offer_bytes, invoice_request_tlv_stream);
 528
 529                 let mut bytes = Vec::new();
 530                 unsigned_tlv_stream.write(&mut bytes).unwrap();
 531
 532                 let tagged_hash = TaggedHash::from_valid_tlv_stream_bytes(SIGNATURE_TAG, &bytes);
 533
 534                 Self { bytes, contents, tagged_hash }
 535         }
 536
 537         /// Returns the [`TaggedHash`] of the invoice to sign.
 538         pub fn tagged_hash(&self) -> &TaggedHash {
 539                 &self.tagged_hash
 540         }
 541 }
 542
 543 macro_rules! unsigned_invoice_request_sign_method { (
 544         $self: ident, $self_type: ty $(, $self_mut: tt)?
 545 ) => {
 546         /// Signs the [`TaggedHash`] of the invoice request using the given function.
 547         ///
 548         /// Note: The hash computation may have included unknown, odd TLV records.
 549         pub fn sign<F: SignInvoiceRequestFn>(
 550                 $($self_mut)* $self: $self_type, sign: F
 551         ) -> Result<InvoiceRequest, SignError> {
 552                 let pubkey = $self.contents.payer_id;
 553                 let signature = merkle::sign_message(sign, &$self, pubkey)?;
 554
 555                 // Append the signature TLV record to the bytes.
 556                 let signature_tlv_stream = SignatureTlvStreamRef {
 557                         signature: Some(&signature),
 558                 };
 559                 signature_tlv_stream.write(&mut $self.bytes).unwrap();
 560
 561                 Ok(InvoiceRequest {
 562                         #[cfg(not(c_bindings))]
 563                         bytes: $self.bytes,
 564                         #[cfg(c_bindings)]
 565                         bytes: $self.bytes.clone(),
 566                         #[cfg(not(c_bindings))]
 567                         contents: $self.contents,
 568                         #[cfg(c_bindings)]
 569                         contents: $self.contents.clone(),
 570                         signature,
 571                 })
 572         }
 573 } }
 574
 575 #[cfg(not(c_bindings))]
 576 impl UnsignedInvoiceRequest {
 577         unsigned_invoice_request_sign_method!(self, Self, mut);
 578 }
 579
 580 #[cfg(c_bindings)]
 581 impl UnsignedInvoiceRequest {
 582         unsigned_invoice_request_sign_method!(self, &mut Self);
 583 }
 584
 585 impl AsRef<TaggedHash> for UnsignedInvoiceRequest {
 586         fn as_ref(&self) -> &TaggedHash {
 587                 &self.tagged_hash
 588         }
 589 }
 590
 591 /// An `InvoiceRequest` is a request for a [`Bolt12Invoice`] formulated from an [`Offer`].
 592 ///
 593 /// An offer may provide choices such as quantity, amount, chain, features, etc. An invoice request
 594 /// specifies these such that its recipient can send an invoice for payment.
 595 ///
 596 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
 597 /// [`Offer`]: crate::offers::offer::Offer
 598 #[derive(Clone, Debug)]
 599 #[cfg_attr(test, derive(PartialEq))]
 600 pub struct InvoiceRequest {
 601         pub(super) bytes: Vec<u8>,
 602         pub(super) contents: InvoiceRequestContents,
 603         signature: Signature,
 604 }
 605
 606 /// An [`InvoiceRequest`] that has been verified by [`InvoiceRequest::verify`] and exposes different
 607 /// ways to respond depending on whether the signing keys were derived.
 608 #[derive(Clone, Debug)]
 609 pub struct VerifiedInvoiceRequest {
 610         /// The identifier of the [`Offer`] for which the [`InvoiceRequest`] was made.
 611         pub offer_id: OfferId,
 612
 613         /// The verified request.
 614         inner: InvoiceRequest,
 615
 616         /// Keys used for signing a [`Bolt12Invoice`] if they can be derived.
 617         ///
 618         /// If `Some`, must call [`respond_using_derived_keys`] when responding. Otherwise, call
 619         /// [`respond_with`].
 620         ///
 621         /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
 622         /// [`respond_using_derived_keys`]: Self::respond_using_derived_keys
 623         /// [`respond_with`]: Self::respond_with
 624         pub keys: Option<KeyPair>,
 625 }
 626
 627 /// The contents of an [`InvoiceRequest`], which may be shared with an [`Bolt12Invoice`].
 628 ///
 629 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
 630 #[derive(Clone, Debug)]
 631 #[cfg_attr(test, derive(PartialEq))]
 632 pub(super) struct InvoiceRequestContents {
 633         pub(super) inner: InvoiceRequestContentsWithoutPayerId,
 634         payer_id: PublicKey,
 635 }
 636
 637 #[derive(Clone, Debug)]
 638 #[cfg_attr(test, derive(PartialEq))]
 639 pub(super) struct InvoiceRequestContentsWithoutPayerId {
 640         payer: PayerContents,
 641         pub(super) offer: OfferContents,
 642         chain: Option<ChainHash>,
 643         amount_msats: Option<u64>,
 644         features: InvoiceRequestFeatures,
 645         quantity: Option<u64>,
 646         payer_note: Option<String>,
 647 }
 648
 649 macro_rules! invoice_request_accessors { ($self: ident, $contents: expr) => {
 650         /// An unpredictable series of bytes, typically containing information about the derivation of
 651         /// [`payer_id`].
 652         ///
 653         /// [`payer_id`]: Self::payer_id
 654         pub fn payer_metadata(&$self) -> &[u8] {
 655                 $contents.metadata()
 656         }
 657
 658         /// A chain from [`Offer::chains`] that the offer is valid for.
 659         pub fn chain(&$self) -> ChainHash {
 660                 $contents.chain()
 661         }
 662
 663         /// The amount to pay in msats (i.e., the minimum lightning-payable unit for [`chain`]), which
 664         /// must be greater than or equal to [`Offer::amount`], converted if necessary.
 665         ///
 666         /// [`chain`]: Self::chain
 667         pub fn amount_msats(&$self) -> Option<u64> {
 668                 $contents.amount_msats()
 669         }
 670
 671         /// Features pertaining to requesting an invoice.
 672         pub fn invoice_request_features(&$self) -> &InvoiceRequestFeatures {
 673                 &$contents.features()
 674         }
 675
 676         /// The quantity of the offer's item conforming to [`Offer::is_valid_quantity`].
 677         pub fn quantity(&$self) -> Option<u64> {
 678                 $contents.quantity()
 679         }
 680
 681         /// A possibly transient pubkey used to sign the invoice request.
 682         pub fn payer_id(&$self) -> PublicKey {
 683                 $contents.payer_id()
 684         }
 685
 686         /// A payer-provided note which will be seen by the recipient and reflected back in the invoice
 687         /// response.
 688         pub fn payer_note(&$self) -> Option<PrintableString> {
 689                 $contents.payer_note()
 690         }
 691 } }
 692
 693 impl UnsignedInvoiceRequest {
 694         offer_accessors!(self, self.contents.inner.offer);
 695         invoice_request_accessors!(self, self.contents);
 696 }
 697
 698 macro_rules! invoice_request_respond_with_explicit_signing_pubkey_methods { (
 699         $self: ident, $contents: expr, $builder: ty
 700 ) => {
 701         /// Creates an [`InvoiceBuilder`] for the request with the given required fields and using the
 702         /// [`Duration`] since [`std::time::SystemTime::UNIX_EPOCH`] as the creation time.
 703         ///
 704         /// See [`InvoiceRequest::respond_with_no_std`] for further details where the aforementioned
 705         /// creation time is used for the `created_at` parameter.
 706         ///
 707         /// [`Duration`]: core::time::Duration
 708         #[cfg(feature = "std")]
 709         pub fn respond_with(
 710                 &$self, payment_paths: Vec<(BlindedPayInfo, BlindedPath)>, payment_hash: PaymentHash
 711         ) -> Result<$builder, Bolt12SemanticError> {
 712                 let created_at = std::time::SystemTime::now()
 713                         .duration_since(std::time::SystemTime::UNIX_EPOCH)
 714                         .expect("SystemTime::now() should come after SystemTime::UNIX_EPOCH");
 715
 716                 $contents.respond_with_no_std(payment_paths, payment_hash, created_at)
 717         }
 718
 719         /// Creates an [`InvoiceBuilder`] for the request with the given required fields.
 720         ///
 721         /// Unless [`InvoiceBuilder::relative_expiry`] is set, the invoice will expire two hours after
 722         /// `created_at`, which is used to set [`Bolt12Invoice::created_at`]. Useful for `no-std` builds
 723         /// where [`std::time::SystemTime`] is not available.
 724         ///
 725         /// The caller is expected to remember the preimage of `payment_hash` in order to claim a payment
 726         /// for the invoice.
 727         ///
 728         /// The `payment_paths` parameter is useful for maintaining the payment recipient's privacy. It
 729         /// must contain one or more elements ordered from most-preferred to least-preferred, if there's
 730         /// a preference. Note, however, that any privacy is lost if a public node id was used for
 731         /// [`Offer::signing_pubkey`].
 732         ///
 733         /// Errors if the request contains unknown required features.
 734         ///
 735         /// # Note
 736         ///
 737         /// If the originating [`Offer`] was created using [`OfferBuilder::deriving_signing_pubkey`],
 738         /// then use [`InvoiceRequest::verify`] and [`VerifiedInvoiceRequest`] methods instead.
 739         ///
 740         /// [`Bolt12Invoice::created_at`]: crate::offers::invoice::Bolt12Invoice::created_at
 741         /// [`OfferBuilder::deriving_signing_pubkey`]: crate::offers::offer::OfferBuilder::deriving_signing_pubkey
 742         pub fn respond_with_no_std(
 743                 &$self, payment_paths: Vec<(BlindedPayInfo, BlindedPath)>, payment_hash: PaymentHash,
 744                 created_at: core::time::Duration
 745         ) -> Result<$builder, Bolt12SemanticError> {
 746                 if $contents.invoice_request_features().requires_unknown_bits() {
 747                         return Err(Bolt12SemanticError::UnknownRequiredFeatures);
 748                 }
 749
 750                 <$builder>::for_offer(&$contents, payment_paths, created_at, payment_hash)
 751         }
 752 } }
 753
 754 macro_rules! invoice_request_verify_method { ($self: ident, $self_type: ty) => {
 755         /// Verifies that the request was for an offer created using the given key. Returns the verified
 756         /// request which contains the derived keys needed to sign a [`Bolt12Invoice`] for the request
 757         /// if they could be extracted from the metadata.
 758         ///
 759         /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
 760         pub fn verify<
 761                 #[cfg(not(c_bindings))]
 762                 T: secp256k1::Signing
 763         >(
 764                 $self: $self_type, key: &ExpandedKey,
 765                 #[cfg(not(c_bindings))]
 766                 secp_ctx: &Secp256k1<T>,
 767                 #[cfg(c_bindings)]
 768                 secp_ctx: &Secp256k1<secp256k1::All>,
 769         ) -> Result<VerifiedInvoiceRequest, ()> {
 770                 let (offer_id, keys) = $self.contents.inner.offer.verify(&$self.bytes, key, secp_ctx)?;
 771                 Ok(VerifiedInvoiceRequest {
 772                         offer_id,
 773                         #[cfg(not(c_bindings))]
 774                         inner: $self,
 775                         #[cfg(c_bindings)]
 776                         inner: $self.clone(),
 777                         keys,
 778                 })
 779         }
 780
 781 } }
 782
 783 #[cfg(not(c_bindings))]
 784 impl InvoiceRequest {
 785         offer_accessors!(self, self.contents.inner.offer);
 786         invoice_request_accessors!(self, self.contents);
 787         invoice_request_respond_with_explicit_signing_pubkey_methods!(self, self, InvoiceBuilder<ExplicitSigningPubkey>);
 788         invoice_request_verify_method!(self, Self);
 789 }
 790
 791 #[cfg(c_bindings)]
 792 impl InvoiceRequest {
 793         offer_accessors!(self, self.contents.inner.offer);
 794         invoice_request_accessors!(self, self.contents);
 795         invoice_request_respond_with_explicit_signing_pubkey_methods!(self, self, InvoiceWithExplicitSigningPubkeyBuilder);
 796         invoice_request_verify_method!(self, &Self);
 797 }
 798
 799 impl InvoiceRequest {
 800         /// Signature of the invoice request using [`payer_id`].
 801         ///
 802         /// [`payer_id`]: Self::payer_id
 803         pub fn signature(&self) -> Signature {
 804                 self.signature
 805         }
 806
 807         pub(crate) fn as_tlv_stream(&self) -> FullInvoiceRequestTlvStreamRef {
 808                 let (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream) =
 809                         self.contents.as_tlv_stream();
 810                 let signature_tlv_stream = SignatureTlvStreamRef {
 811                         signature: Some(&self.signature),
 812                 };
 813                 (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, signature_tlv_stream)
 814         }
 815 }
 816
 817 macro_rules! invoice_request_respond_with_derived_signing_pubkey_methods { (
 818         $self: ident, $contents: expr, $builder: ty
 819 ) => {
 820         /// Creates an [`InvoiceBuilder`] for the request using the given required fields and that uses
 821         /// derived signing keys from the originating [`Offer`] to sign the [`Bolt12Invoice`]. Must use
 822         /// the same [`ExpandedKey`] as the one used to create the offer.
 823         ///
 824         /// See [`InvoiceRequest::respond_with`] for further details.
 825         ///
 826         /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
 827         #[cfg(feature = "std")]
 828         pub fn respond_using_derived_keys(
 829                 &$self, payment_paths: Vec<(BlindedPayInfo, BlindedPath)>, payment_hash: PaymentHash
 830         ) -> Result<$builder, Bolt12SemanticError> {
 831                 let created_at = std::time::SystemTime::now()
 832                         .duration_since(std::time::SystemTime::UNIX_EPOCH)
 833                         .expect("SystemTime::now() should come after SystemTime::UNIX_EPOCH");
 834
 835                 $self.respond_using_derived_keys_no_std(payment_paths, payment_hash, created_at)
 836         }
 837
 838         /// Creates an [`InvoiceBuilder`] for the request using the given required fields and that uses
 839         /// derived signing keys from the originating [`Offer`] to sign the [`Bolt12Invoice`]. Must use
 840         /// the same [`ExpandedKey`] as the one used to create the offer.
 841         ///
 842         /// See [`InvoiceRequest::respond_with_no_std`] for further details.
 843         ///
 844         /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
 845         pub fn respond_using_derived_keys_no_std(
 846                 &$self, payment_paths: Vec<(BlindedPayInfo, BlindedPath)>, payment_hash: PaymentHash,
 847                 created_at: core::time::Duration
 848         ) -> Result<$builder, Bolt12SemanticError> {
 849                 if $self.inner.invoice_request_features().requires_unknown_bits() {
 850                         return Err(Bolt12SemanticError::UnknownRequiredFeatures);
 851                 }
 852
 853                 let keys = match $self.keys {
 854                         None => return Err(Bolt12SemanticError::InvalidMetadata),
 855                         Some(keys) => keys,
 856                 };
 857
 858                 <$builder>::for_offer_using_keys(
 859                         &$self.inner, payment_paths, created_at, payment_hash, keys
 860                 )
 861         }
 862 } }
 863
 864 impl VerifiedInvoiceRequest {
 865         offer_accessors!(self, self.inner.contents.inner.offer);
 866         invoice_request_accessors!(self, self.inner.contents);
 867         #[cfg(not(c_bindings))]
 868         invoice_request_respond_with_explicit_signing_pubkey_methods!(self, self.inner, InvoiceBuilder<ExplicitSigningPubkey>);
 869         #[cfg(c_bindings)]
 870         invoice_request_respond_with_explicit_signing_pubkey_methods!(self, self.inner, InvoiceWithExplicitSigningPubkeyBuilder);
 871         #[cfg(not(c_bindings))]
 872         invoice_request_respond_with_derived_signing_pubkey_methods!(self, self.inner, InvoiceBuilder<DerivedSigningPubkey>);
 873         #[cfg(c_bindings)]
 874         invoice_request_respond_with_derived_signing_pubkey_methods!(self, self.inner, InvoiceWithDerivedSigningPubkeyBuilder);
 875
 876         pub(crate) fn fields(&self) -> InvoiceRequestFields {
 877                 let InvoiceRequestContents {
 878                         payer_id,
 879                         inner: InvoiceRequestContentsWithoutPayerId {
 880                                 payer: _, offer: _, chain: _, amount_msats: _, features: _, quantity, payer_note
 881                         },
 882                 } = &self.inner.contents;
 883
 884                 InvoiceRequestFields {
 885                         payer_id: *payer_id,
 886                         quantity: *quantity,
 887                         payer_note_truncated: payer_note.clone()
 888                                 .map(|mut s| { s.truncate(PAYER_NOTE_LIMIT); UntrustedString(s) }),
 889                 }
 890         }
 891 }
 892
 893 impl InvoiceRequestContents {
 894         pub(super) fn metadata(&self) -> &[u8] {
 895                 self.inner.metadata()
 896         }
 897
 898         pub(super) fn derives_keys(&self) -> bool {
 899                 self.inner.payer.0.derives_payer_keys()
 900         }
 901
 902         pub(super) fn chain(&self) -> ChainHash {
 903                 self.inner.chain()
 904         }
 905
 906         pub(super) fn amount_msats(&self) -> Option<u64> {
 907                 self.inner.amount_msats
 908         }
 909
 910         pub(super) fn features(&self) -> &InvoiceRequestFeatures {
 911                 &self.inner.features
 912         }
 913
 914         pub(super) fn quantity(&self) -> Option<u64> {
 915                 self.inner.quantity
 916         }
 917
 918         pub(super) fn payer_id(&self) -> PublicKey {
 919                 self.payer_id
 920         }
 921
 922         pub(super) fn payer_note(&self) -> Option<PrintableString> {
 923                 self.inner.payer_note.as_ref()
 924                         .map(|payer_note| PrintableString(payer_note.as_str()))
 925         }
 926
 927         pub(super) fn as_tlv_stream(&self) -> PartialInvoiceRequestTlvStreamRef {
 928                 let (payer, offer, mut invoice_request) = self.inner.as_tlv_stream();
 929                 invoice_request.payer_id = Some(&self.payer_id);
 930                 (payer, offer, invoice_request)
 931         }
 932 }
 933
 934 impl InvoiceRequestContentsWithoutPayerId {
 935         pub(super) fn metadata(&self) -> &[u8] {
 936                 self.payer.0.as_bytes().map(|bytes| bytes.as_slice()).unwrap_or(&[])
 937         }
 938
 939         pub(super) fn chain(&self) -> ChainHash {
 940                 self.chain.unwrap_or_else(|| self.offer.implied_chain())
 941         }
 942
 943         pub(super) fn as_tlv_stream(&self) -> PartialInvoiceRequestTlvStreamRef {
 944                 let payer = PayerTlvStreamRef {
 945                         metadata: self.payer.0.as_bytes(),
 946                 };
 947
 948                 let offer = self.offer.as_tlv_stream();
 949
 950                 let features = {
 951                         if self.features == InvoiceRequestFeatures::empty() { None }
 952                         else { Some(&self.features) }
 953                 };
 954
 955                 let invoice_request = InvoiceRequestTlvStreamRef {
 956                         chain: self.chain.as_ref(),
 957                         amount: self.amount_msats,
 958                         features,
 959                         quantity: self.quantity,
 960                         payer_id: None,
 961                         payer_note: self.payer_note.as_ref(),
 962                 };
 963
 964                 (payer, offer, invoice_request)
 965         }
 966 }
 967
 968 impl Writeable for UnsignedInvoiceRequest {
 969         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
 970                 WithoutLength(&self.bytes).write(writer)
 971         }
 972 }
 973
 974 impl Writeable for InvoiceRequest {
 975         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
 976                 WithoutLength(&self.bytes).write(writer)
 977         }
 978 }
 979
 980 impl Writeable for InvoiceRequestContents {
 981         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
 982                 self.as_tlv_stream().write(writer)
 983         }
 984 }
 985
 986 /// Valid type range for invoice_request TLV records.
 987 pub(super) const INVOICE_REQUEST_TYPES: core::ops::Range<u64> = 80..160;
 988
 989 /// TLV record type for [`InvoiceRequest::payer_id`] and [`Refund::payer_id`].
 990 ///
 991 /// [`Refund::payer_id`]: crate::offers::refund::Refund::payer_id
 992 pub(super) const INVOICE_REQUEST_PAYER_ID_TYPE: u64 = 88;
 993
 994 tlv_stream!(InvoiceRequestTlvStream, InvoiceRequestTlvStreamRef, INVOICE_REQUEST_TYPES, {
 995         (80, chain: ChainHash),
 996         (82, amount: (u64, HighZeroBytesDroppedBigSize)),
 997         (84, features: (InvoiceRequestFeatures, WithoutLength)),
 998         (86, quantity: (u64, HighZeroBytesDroppedBigSize)),
 999         (INVOICE_REQUEST_PAYER_ID_TYPE, payer_id: PublicKey),
1000         (89, payer_note: (String, WithoutLength)),
1001 });
1002
1003 type FullInvoiceRequestTlvStream =
1004         (PayerTlvStream, OfferTlvStream, InvoiceRequestTlvStream, SignatureTlvStream);
1005
1006 type FullInvoiceRequestTlvStreamRef<'a> = (
1007         PayerTlvStreamRef<'a>,
1008         OfferTlvStreamRef<'a>,
1009         InvoiceRequestTlvStreamRef<'a>,
1010         SignatureTlvStreamRef<'a>,
1011 );
1012
1013 impl SeekReadable for FullInvoiceRequestTlvStream {
1014         fn read<R: io::Read + io::Seek>(r: &mut R) -> Result<Self, DecodeError> {
1015                 let payer = SeekReadable::read(r)?;
1016                 let offer = SeekReadable::read(r)?;
1017                 let invoice_request = SeekReadable::read(r)?;
1018                 let signature = SeekReadable::read(r)?;
1019
1020                 Ok((payer, offer, invoice_request, signature))
1021         }
1022 }
1023
1024 type PartialInvoiceRequestTlvStream = (PayerTlvStream, OfferTlvStream, InvoiceRequestTlvStream);
1025
1026 type PartialInvoiceRequestTlvStreamRef<'a> = (
1027         PayerTlvStreamRef<'a>,
1028         OfferTlvStreamRef<'a>,
1029         InvoiceRequestTlvStreamRef<'a>,
1030 );
1031
1032 impl TryFrom<Vec<u8>> for UnsignedInvoiceRequest {
1033         type Error = Bolt12ParseError;
1034
1035         fn try_from(bytes: Vec<u8>) -> Result<Self, Self::Error> {
1036                 let invoice_request = ParsedMessage::<PartialInvoiceRequestTlvStream>::try_from(bytes)?;
1037                 let ParsedMessage { bytes, tlv_stream } = invoice_request;
1038                 let (
1039                         payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream,
1040                 ) = tlv_stream;
1041                 let contents = InvoiceRequestContents::try_from(
1042                         (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream)
1043                 )?;
1044
1045                 let tagged_hash = TaggedHash::from_valid_tlv_stream_bytes(SIGNATURE_TAG, &bytes);
1046
1047                 Ok(UnsignedInvoiceRequest { bytes, contents, tagged_hash })
1048         }
1049 }
1050
1051 impl TryFrom<Vec<u8>> for InvoiceRequest {
1052         type Error = Bolt12ParseError;
1053
1054         fn try_from(bytes: Vec<u8>) -> Result<Self, Self::Error> {
1055                 let invoice_request = ParsedMessage::<FullInvoiceRequestTlvStream>::try_from(bytes)?;
1056                 let ParsedMessage { bytes, tlv_stream } = invoice_request;
1057                 let (
1058                         payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream,
1059                         SignatureTlvStream { signature },
1060                 ) = tlv_stream;
1061                 let contents = InvoiceRequestContents::try_from(
1062                         (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream)
1063                 )?;
1064
1065                 let signature = match signature {
1066                         None => return Err(Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingSignature)),
1067                         Some(signature) => signature,
1068                 };
1069                 let message = TaggedHash::from_valid_tlv_stream_bytes(SIGNATURE_TAG, &bytes);
1070                 merkle::verify_signature(&signature, &message, contents.payer_id)?;
1071
1072                 Ok(InvoiceRequest { bytes, contents, signature })
1073         }
1074 }
1075
1076 impl TryFrom<PartialInvoiceRequestTlvStream> for InvoiceRequestContents {
1077         type Error = Bolt12SemanticError;
1078
1079         fn try_from(tlv_stream: PartialInvoiceRequestTlvStream) -> Result<Self, Self::Error> {
1080                 let (
1081                         PayerTlvStream { metadata },
1082                         offer_tlv_stream,
1083                         InvoiceRequestTlvStream { chain, amount, features, quantity, payer_id, payer_note },
1084                 ) = tlv_stream;
1085
1086                 let payer = match metadata {
1087                         None => return Err(Bolt12SemanticError::MissingPayerMetadata),
1088                         Some(metadata) => PayerContents(Metadata::Bytes(metadata)),
1089                 };
1090                 let offer = OfferContents::try_from(offer_tlv_stream)?;
1091
1092                 if !offer.supports_chain(chain.unwrap_or_else(|| offer.implied_chain())) {
1093                         return Err(Bolt12SemanticError::UnsupportedChain);
1094                 }
1095
1096                 if offer.amount().is_none() && amount.is_none() {
1097                         return Err(Bolt12SemanticError::MissingAmount);
1098                 }
1099
1100                 offer.check_quantity(quantity)?;
1101                 offer.check_amount_msats_for_quantity(amount, quantity)?;
1102
1103                 let features = features.unwrap_or_else(InvoiceRequestFeatures::empty);
1104
1105                 let payer_id = match payer_id {
1106                         None => return Err(Bolt12SemanticError::MissingPayerId),
1107                         Some(payer_id) => payer_id,
1108                 };
1109
1110                 Ok(InvoiceRequestContents {
1111                         inner: InvoiceRequestContentsWithoutPayerId {
1112                                 payer, offer, chain, amount_msats: amount, features, quantity, payer_note,
1113                         },
1114                         payer_id,
1115                 })
1116         }
1117 }
1118
1119 /// Fields sent in an [`InvoiceRequest`] message to include in [`PaymentContext::Bolt12Offer`].
1120 ///
1121 /// [`PaymentContext::Bolt12Offer`]: crate::blinded_path::payment::PaymentContext::Bolt12Offer
1122 #[derive(Clone, Debug, Eq, PartialEq)]
1123 pub struct InvoiceRequestFields {
1124         /// A possibly transient pubkey used to sign the invoice request.
1125         pub payer_id: PublicKey,
1126
1127         /// The quantity of the offer's item conforming to [`Offer::is_valid_quantity`].
1128         pub quantity: Option<u64>,
1129
1130         /// A payer-provided note which will be seen by the recipient and reflected back in the invoice
1131         /// response. Truncated to [`PAYER_NOTE_LIMIT`] characters.
1132         pub payer_note_truncated: Option<UntrustedString>,
1133 }
1134
1135 /// The maximum number of characters included in [`InvoiceRequestFields::payer_note_truncated`].
1136 pub const PAYER_NOTE_LIMIT: usize = 512;
1137
1138 impl Writeable for InvoiceRequestFields {
1139         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
1140                 write_tlv_fields!(writer, {
1141                         (0, self.payer_id, required),
1142                         (2, self.quantity.map(|v| HighZeroBytesDroppedBigSize(v)), option),
1143                         (4, self.payer_note_truncated.as_ref().map(|s| WithoutLength(&s.0)), option),
1144                 });
1145                 Ok(())
1146         }
1147 }
1148
1149 impl Readable for InvoiceRequestFields {
1150         fn read<R: io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
1151                 _init_and_read_len_prefixed_tlv_fields!(reader, {
1152                         (0, payer_id, required),
1153                         (2, quantity, (option, encoding: (u64, HighZeroBytesDroppedBigSize))),
1154                         (4, payer_note_truncated, (option, encoding: (String, WithoutLength))),
1155                 });
1156
1157                 Ok(InvoiceRequestFields {
1158                         payer_id: payer_id.0.unwrap(),
1159                         quantity,
1160                         payer_note_truncated: payer_note_truncated.map(|s| UntrustedString(s)),
1161                 })
1162         }
1163 }
1164
1165 #[cfg(test)]
1166 mod tests {
1167         use super::{InvoiceRequest, InvoiceRequestFields, InvoiceRequestTlvStreamRef, PAYER_NOTE_LIMIT, SIGNATURE_TAG, UnsignedInvoiceRequest};
1168
1169         use bitcoin::blockdata::constants::ChainHash;
1170         use bitcoin::network::constants::Network;
1171         use bitcoin::secp256k1::{KeyPair, Secp256k1, SecretKey, self};
1172         use core::num::NonZeroU64;
1173         #[cfg(feature = "std")]
1174         use core::time::Duration;
1175         use crate::sign::KeyMaterial;
1176         use crate::ln::channelmanager::PaymentId;
1177         use crate::ln::features::{InvoiceRequestFeatures, OfferFeatures};
1178         use crate::ln::inbound_payment::ExpandedKey;
1179         use crate::ln::msgs::{DecodeError, MAX_VALUE_MSAT};
1180         use crate::offers::invoice::{Bolt12Invoice, SIGNATURE_TAG as INVOICE_SIGNATURE_TAG};
1181         use crate::offers::merkle::{SignError, SignatureTlvStreamRef, TaggedHash, self};
1182         use crate::offers::offer::{Amount, OfferTlvStreamRef, Quantity};
1183         #[cfg(not(c_bindings))]
1184         use {
1185                 crate::offers::offer::OfferBuilder,
1186         };
1187         #[cfg(c_bindings)]
1188         use {
1189                 crate::offers::offer::OfferWithExplicitMetadataBuilder as OfferBuilder,
1190         };
1191         use crate::offers::parse::{Bolt12ParseError, Bolt12SemanticError};
1192         use crate::offers::payer::PayerTlvStreamRef;
1193         use crate::offers::test_utils::*;
1194         use crate::util::ser::{BigSize, Readable, Writeable};
1195         use crate::util::string::{PrintableString, UntrustedString};
1196
1197         #[test]
1198         fn builds_invoice_request_with_defaults() {
1199                 let unsigned_invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1200                         .amount_msats(1000)
1201                         .build().unwrap()
1202                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1203                         .build().unwrap();
1204                 #[cfg(c_bindings)]
1205                 let mut unsigned_invoice_request = unsigned_invoice_request;
1206
1207                 let mut buffer = Vec::new();
1208                 unsigned_invoice_request.write(&mut buffer).unwrap();
1209
1210                 assert_eq!(unsigned_invoice_request.bytes, buffer.as_slice());
1211                 assert_eq!(unsigned_invoice_request.payer_metadata(), &[1; 32]);
1212                 assert_eq!(unsigned_invoice_request.chains(), vec![ChainHash::using_genesis_block(Network::Bitcoin)]);
1213                 assert_eq!(unsigned_invoice_request.metadata(), None);
1214                 assert_eq!(unsigned_invoice_request.amount(), Some(&Amount::Bitcoin { amount_msats: 1000 }));
1215                 assert_eq!(unsigned_invoice_request.description(), PrintableString("foo"));
1216                 assert_eq!(unsigned_invoice_request.offer_features(), &OfferFeatures::empty());
1217                 assert_eq!(unsigned_invoice_request.absolute_expiry(), None);
1218                 assert_eq!(unsigned_invoice_request.paths(), &[]);
1219                 assert_eq!(unsigned_invoice_request.issuer(), None);
1220                 assert_eq!(unsigned_invoice_request.supported_quantity(), Quantity::One);
1221                 assert_eq!(unsigned_invoice_request.signing_pubkey(), recipient_pubkey());
1222                 assert_eq!(unsigned_invoice_request.chain(), ChainHash::using_genesis_block(Network::Bitcoin));
1223                 assert_eq!(unsigned_invoice_request.amount_msats(), None);
1224                 assert_eq!(unsigned_invoice_request.invoice_request_features(), &InvoiceRequestFeatures::empty());
1225                 assert_eq!(unsigned_invoice_request.quantity(), None);
1226                 assert_eq!(unsigned_invoice_request.payer_id(), payer_pubkey());
1227                 assert_eq!(unsigned_invoice_request.payer_note(), None);
1228
1229                 match UnsignedInvoiceRequest::try_from(buffer) {
1230                         Err(e) => panic!("error parsing unsigned invoice request: {:?}", e),
1231                         Ok(parsed) => {
1232                                 assert_eq!(parsed.bytes, unsigned_invoice_request.bytes);
1233                                 assert_eq!(parsed.tagged_hash, unsigned_invoice_request.tagged_hash);
1234                         },
1235                 }
1236
1237                 let invoice_request = unsigned_invoice_request.sign(payer_sign).unwrap();
1238
1239                 let mut buffer = Vec::new();
1240                 invoice_request.write(&mut buffer).unwrap();
1241
1242                 assert_eq!(invoice_request.bytes, buffer.as_slice());
1243                 assert_eq!(invoice_request.payer_metadata(), &[1; 32]);
1244                 assert_eq!(invoice_request.chains(), vec![ChainHash::using_genesis_block(Network::Bitcoin)]);
1245                 assert_eq!(invoice_request.metadata(), None);
1246                 assert_eq!(invoice_request.amount(), Some(&Amount::Bitcoin { amount_msats: 1000 }));
1247                 assert_eq!(invoice_request.description(), PrintableString("foo"));
1248                 assert_eq!(invoice_request.offer_features(), &OfferFeatures::empty());
1249                 assert_eq!(invoice_request.absolute_expiry(), None);
1250                 assert_eq!(invoice_request.paths(), &[]);
1251                 assert_eq!(invoice_request.issuer(), None);
1252                 assert_eq!(invoice_request.supported_quantity(), Quantity::One);
1253                 assert_eq!(invoice_request.signing_pubkey(), recipient_pubkey());
1254                 assert_eq!(invoice_request.chain(), ChainHash::using_genesis_block(Network::Bitcoin));
1255                 assert_eq!(invoice_request.amount_msats(), None);
1256                 assert_eq!(invoice_request.invoice_request_features(), &InvoiceRequestFeatures::empty());
1257                 assert_eq!(invoice_request.quantity(), None);
1258                 assert_eq!(invoice_request.payer_id(), payer_pubkey());
1259                 assert_eq!(invoice_request.payer_note(), None);
1260
1261                 let message = TaggedHash::from_valid_tlv_stream_bytes(SIGNATURE_TAG, &invoice_request.bytes);
1262                 assert!(merkle::verify_signature(&invoice_request.signature, &message, payer_pubkey()).is_ok());
1263
1264                 assert_eq!(
1265                         invoice_request.as_tlv_stream(),
1266                         (
1267                                 PayerTlvStreamRef { metadata: Some(&vec![1; 32]) },
1268                                 OfferTlvStreamRef {
1269                                         chains: None,
1270                                         metadata: None,
1271                                         currency: None,
1272                                         amount: Some(1000),
1273                                         description: Some(&String::from("foo")),
1274                                         features: None,
1275                                         absolute_expiry: None,
1276                                         paths: None,
1277                                         issuer: None,
1278                                         quantity_max: None,
1279                                         node_id: Some(&recipient_pubkey()),
1280                                 },
1281                                 InvoiceRequestTlvStreamRef {
1282                                         chain: None,
1283                                         amount: None,
1284                                         features: None,
1285                                         quantity: None,
1286                                         payer_id: Some(&payer_pubkey()),
1287                                         payer_note: None,
1288                                 },
1289                                 SignatureTlvStreamRef { signature: Some(&invoice_request.signature()) },
1290                         ),
1291                 );
1292
1293                 if let Err(e) = InvoiceRequest::try_from(buffer) {
1294                         panic!("error parsing invoice request: {:?}", e);
1295                 }
1296         }
1297
1298         #[cfg(feature = "std")]
1299         #[test]
1300         fn builds_invoice_request_from_offer_with_expiration() {
1301                 let future_expiry = Duration::from_secs(u64::max_value());
1302                 let past_expiry = Duration::from_secs(0);
1303
1304                 if let Err(e) = OfferBuilder::new("foo".into(), recipient_pubkey())
1305                         .amount_msats(1000)
1306                         .absolute_expiry(future_expiry)
1307                         .build().unwrap()
1308                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1309                         .build()
1310                 {
1311                         panic!("error building invoice_request: {:?}", e);
1312                 }
1313
1314                 match OfferBuilder::new("foo".into(), recipient_pubkey())
1315                         .amount_msats(1000)
1316                         .absolute_expiry(past_expiry)
1317                         .build().unwrap()
1318                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1319                         .build()
1320                 {
1321                         Ok(_) => panic!("expected error"),
1322                         Err(e) => assert_eq!(e, Bolt12SemanticError::AlreadyExpired),
1323                 }
1324         }
1325
1326         #[test]
1327         fn builds_invoice_request_with_derived_metadata() {
1328                 let payer_id = payer_pubkey();
1329                 let expanded_key = ExpandedKey::new(&KeyMaterial([42; 32]));
1330                 let entropy = FixedEntropy {};
1331                 let secp_ctx = Secp256k1::new();
1332                 let payment_id = PaymentId([1; 32]);
1333
1334                 let offer = OfferBuilder::new("foo".into(), recipient_pubkey())
1335                         .amount_msats(1000)
1336                         .build().unwrap();
1337                 let invoice_request = offer
1338                         .request_invoice_deriving_metadata(payer_id, &expanded_key, &entropy, payment_id)
1339                         .unwrap()
1340                         .build().unwrap()
1341                         .sign(payer_sign).unwrap();
1342                 assert_eq!(invoice_request.payer_id(), payer_pubkey());
1343
1344                 let invoice = invoice_request.respond_with_no_std(payment_paths(), payment_hash(), now())
1345                         .unwrap()
1346                         .build().unwrap()
1347                         .sign(recipient_sign).unwrap();
1348                 match invoice.verify(&expanded_key, &secp_ctx) {
1349                         Ok(payment_id) => assert_eq!(payment_id, PaymentId([1; 32])),
1350                         Err(()) => panic!("verification failed"),
1351                 }
1352
1353                 // Fails verification with altered fields
1354                 let (
1355                         payer_tlv_stream, offer_tlv_stream, mut invoice_request_tlv_stream,
1356                         mut invoice_tlv_stream, mut signature_tlv_stream
1357                 ) = invoice.as_tlv_stream();
1358                 invoice_request_tlv_stream.amount = Some(2000);
1359                 invoice_tlv_stream.amount = Some(2000);
1360
1361                 let tlv_stream =
1362                         (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, invoice_tlv_stream);
1363                 let mut bytes = Vec::new();
1364                 tlv_stream.write(&mut bytes).unwrap();
1365
1366                 let message = TaggedHash::from_valid_tlv_stream_bytes(INVOICE_SIGNATURE_TAG, &bytes);
1367                 let signature = merkle::sign_message(recipient_sign, &message, recipient_pubkey()).unwrap();
1368                 signature_tlv_stream.signature = Some(&signature);
1369
1370                 let mut encoded_invoice = bytes;
1371                 signature_tlv_stream.write(&mut encoded_invoice).unwrap();
1372
1373                 let invoice = Bolt12Invoice::try_from(encoded_invoice).unwrap();
1374                 assert!(invoice.verify(&expanded_key, &secp_ctx).is_err());
1375
1376                 // Fails verification with altered metadata
1377                 let (
1378                         mut payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, invoice_tlv_stream,
1379                         mut signature_tlv_stream
1380                 ) = invoice.as_tlv_stream();
1381                 let metadata = payer_tlv_stream.metadata.unwrap().iter().copied().rev().collect();
1382                 payer_tlv_stream.metadata = Some(&metadata);
1383
1384                 let tlv_stream =
1385                         (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, invoice_tlv_stream);
1386                 let mut bytes = Vec::new();
1387                 tlv_stream.write(&mut bytes).unwrap();
1388
1389                 let message = TaggedHash::from_valid_tlv_stream_bytes(INVOICE_SIGNATURE_TAG, &bytes);
1390                 let signature = merkle::sign_message(recipient_sign, &message, recipient_pubkey()).unwrap();
1391                 signature_tlv_stream.signature = Some(&signature);
1392
1393                 let mut encoded_invoice = bytes;
1394                 signature_tlv_stream.write(&mut encoded_invoice).unwrap();
1395
1396                 let invoice = Bolt12Invoice::try_from(encoded_invoice).unwrap();
1397                 assert!(invoice.verify(&expanded_key, &secp_ctx).is_err());
1398         }
1399
1400         #[test]
1401         fn builds_invoice_request_with_derived_payer_id() {
1402                 let expanded_key = ExpandedKey::new(&KeyMaterial([42; 32]));
1403                 let entropy = FixedEntropy {};
1404                 let secp_ctx = Secp256k1::new();
1405                 let payment_id = PaymentId([1; 32]);
1406
1407                 let offer = OfferBuilder::new("foo".into(), recipient_pubkey())
1408                         .amount_msats(1000)
1409                         .build().unwrap();
1410                 let invoice_request = offer
1411                         .request_invoice_deriving_payer_id(&expanded_key, &entropy, &secp_ctx, payment_id)
1412                         .unwrap()
1413                         .build_and_sign()
1414                         .unwrap();
1415
1416                 let invoice = invoice_request.respond_with_no_std(payment_paths(), payment_hash(), now())
1417                         .unwrap()
1418                         .build().unwrap()
1419                         .sign(recipient_sign).unwrap();
1420                 match invoice.verify(&expanded_key, &secp_ctx) {
1421                         Ok(payment_id) => assert_eq!(payment_id, PaymentId([1; 32])),
1422                         Err(()) => panic!("verification failed"),
1423                 }
1424
1425                 // Fails verification with altered fields
1426                 let (
1427                         payer_tlv_stream, offer_tlv_stream, mut invoice_request_tlv_stream,
1428                         mut invoice_tlv_stream, mut signature_tlv_stream
1429                 ) = invoice.as_tlv_stream();
1430                 invoice_request_tlv_stream.amount = Some(2000);
1431                 invoice_tlv_stream.amount = Some(2000);
1432
1433                 let tlv_stream =
1434                         (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, invoice_tlv_stream);
1435                 let mut bytes = Vec::new();
1436                 tlv_stream.write(&mut bytes).unwrap();
1437
1438                 let message = TaggedHash::from_valid_tlv_stream_bytes(INVOICE_SIGNATURE_TAG, &bytes);
1439                 let signature = merkle::sign_message(recipient_sign, &message, recipient_pubkey()).unwrap();
1440                 signature_tlv_stream.signature = Some(&signature);
1441
1442                 let mut encoded_invoice = bytes;
1443                 signature_tlv_stream.write(&mut encoded_invoice).unwrap();
1444
1445                 let invoice = Bolt12Invoice::try_from(encoded_invoice).unwrap();
1446                 assert!(invoice.verify(&expanded_key, &secp_ctx).is_err());
1447
1448                 // Fails verification with altered payer id
1449                 let (
1450                         payer_tlv_stream, offer_tlv_stream, mut invoice_request_tlv_stream, invoice_tlv_stream,
1451                         mut signature_tlv_stream
1452                 ) = invoice.as_tlv_stream();
1453                 let payer_id = pubkey(1);
1454                 invoice_request_tlv_stream.payer_id = Some(&payer_id);
1455
1456                 let tlv_stream =
1457                         (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, invoice_tlv_stream);
1458                 let mut bytes = Vec::new();
1459                 tlv_stream.write(&mut bytes).unwrap();
1460
1461                 let message = TaggedHash::from_valid_tlv_stream_bytes(INVOICE_SIGNATURE_TAG, &bytes);
1462                 let signature = merkle::sign_message(recipient_sign, &message, recipient_pubkey()).unwrap();
1463                 signature_tlv_stream.signature = Some(&signature);
1464
1465                 let mut encoded_invoice = bytes;
1466                 signature_tlv_stream.write(&mut encoded_invoice).unwrap();
1467
1468                 let invoice = Bolt12Invoice::try_from(encoded_invoice).unwrap();
1469                 assert!(invoice.verify(&expanded_key, &secp_ctx).is_err());
1470         }
1471
1472         #[test]
1473         fn builds_invoice_request_with_chain() {
1474                 let mainnet = ChainHash::using_genesis_block(Network::Bitcoin);
1475                 let testnet = ChainHash::using_genesis_block(Network::Testnet);
1476
1477                 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1478                         .amount_msats(1000)
1479                         .build().unwrap()
1480                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1481                         .chain(Network::Bitcoin).unwrap()
1482                         .build().unwrap()
1483                         .sign(payer_sign).unwrap();
1484                 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1485                 assert_eq!(invoice_request.chain(), mainnet);
1486                 assert_eq!(tlv_stream.chain, None);
1487
1488                 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1489                         .amount_msats(1000)
1490                         .chain(Network::Testnet)
1491                         .build().unwrap()
1492                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1493                         .chain(Network::Testnet).unwrap()
1494                         .build().unwrap()
1495                         .sign(payer_sign).unwrap();
1496                 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1497                 assert_eq!(invoice_request.chain(), testnet);
1498                 assert_eq!(tlv_stream.chain, Some(&testnet));
1499
1500                 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1501                         .amount_msats(1000)
1502                         .chain(Network::Bitcoin)
1503                         .chain(Network::Testnet)
1504                         .build().unwrap()
1505                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1506                         .chain(Network::Bitcoin).unwrap()
1507                         .build().unwrap()
1508                         .sign(payer_sign).unwrap();
1509                 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1510                 assert_eq!(invoice_request.chain(), mainnet);
1511                 assert_eq!(tlv_stream.chain, None);
1512
1513                 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1514                         .amount_msats(1000)
1515                         .chain(Network::Bitcoin)
1516                         .chain(Network::Testnet)
1517                         .build().unwrap()
1518                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1519                         .chain(Network::Bitcoin).unwrap()
1520                         .chain(Network::Testnet).unwrap()
1521                         .build().unwrap()
1522                         .sign(payer_sign).unwrap();
1523                 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1524                 assert_eq!(invoice_request.chain(), testnet);
1525                 assert_eq!(tlv_stream.chain, Some(&testnet));
1526
1527                 match OfferBuilder::new("foo".into(), recipient_pubkey())
1528                         .amount_msats(1000)
1529                         .chain(Network::Testnet)
1530                         .build().unwrap()
1531                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1532                         .chain(Network::Bitcoin)
1533                 {
1534                         Ok(_) => panic!("expected error"),
1535                         Err(e) => assert_eq!(e, Bolt12SemanticError::UnsupportedChain),
1536                 }
1537
1538                 match OfferBuilder::new("foo".into(), recipient_pubkey())
1539                         .amount_msats(1000)
1540                         .chain(Network::Testnet)
1541                         .build().unwrap()
1542                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1543                         .build()
1544                 {
1545                         Ok(_) => panic!("expected error"),
1546                         Err(e) => assert_eq!(e, Bolt12SemanticError::UnsupportedChain),
1547                 }
1548         }
1549
1550         #[test]
1551         fn builds_invoice_request_with_amount() {
1552                 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1553                         .amount_msats(1000)
1554                         .build().unwrap()
1555                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1556                         .amount_msats(1000).unwrap()
1557                         .build().unwrap()
1558                         .sign(payer_sign).unwrap();
1559                 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1560                 assert_eq!(invoice_request.amount_msats(), Some(1000));
1561                 assert_eq!(tlv_stream.amount, Some(1000));
1562
1563                 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1564                         .amount_msats(1000)
1565                         .build().unwrap()
1566                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1567                         .amount_msats(1001).unwrap()
1568                         .amount_msats(1000).unwrap()
1569                         .build().unwrap()
1570                         .sign(payer_sign).unwrap();
1571                 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1572                 assert_eq!(invoice_request.amount_msats(), Some(1000));
1573                 assert_eq!(tlv_stream.amount, Some(1000));
1574
1575                 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1576                         .amount_msats(1000)
1577                         .build().unwrap()
1578                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1579                         .amount_msats(1001).unwrap()
1580                         .build().unwrap()
1581                         .sign(payer_sign).unwrap();
1582                 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1583                 assert_eq!(invoice_request.amount_msats(), Some(1001));
1584                 assert_eq!(tlv_stream.amount, Some(1001));
1585
1586                 match OfferBuilder::new("foo".into(), recipient_pubkey())
1587                         .amount_msats(1000)
1588                         .build().unwrap()
1589                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1590                         .amount_msats(999)
1591                 {
1592                         Ok(_) => panic!("expected error"),
1593                         Err(e) => assert_eq!(e, Bolt12SemanticError::InsufficientAmount),
1594                 }
1595
1596                 match OfferBuilder::new("foo".into(), recipient_pubkey())
1597                         .amount_msats(1000)
1598                         .supported_quantity(Quantity::Unbounded)
1599                         .build().unwrap()
1600                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1601                         .quantity(2).unwrap()
1602                         .amount_msats(1000)
1603                 {
1604                         Ok(_) => panic!("expected error"),
1605                         Err(e) => assert_eq!(e, Bolt12SemanticError::InsufficientAmount),
1606                 }
1607
1608                 match OfferBuilder::new("foo".into(), recipient_pubkey())
1609                         .amount_msats(1000)
1610                         .build().unwrap()
1611                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1612                         .amount_msats(MAX_VALUE_MSAT + 1)
1613                 {
1614                         Ok(_) => panic!("expected error"),
1615                         Err(e) => assert_eq!(e, Bolt12SemanticError::InvalidAmount),
1616                 }
1617
1618                 match OfferBuilder::new("foo".into(), recipient_pubkey())
1619                         .amount_msats(1000)
1620                         .supported_quantity(Quantity::Unbounded)
1621                         .build().unwrap()
1622                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1623                         .amount_msats(1000).unwrap()
1624                         .quantity(2).unwrap()
1625                         .build()
1626                 {
1627                         Ok(_) => panic!("expected error"),
1628                         Err(e) => assert_eq!(e, Bolt12SemanticError::InsufficientAmount),
1629                 }
1630
1631                 match OfferBuilder::new("foo".into(), recipient_pubkey())
1632                         .build().unwrap()
1633                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1634                         .build()
1635                 {
1636                         Ok(_) => panic!("expected error"),
1637                         Err(e) => assert_eq!(e, Bolt12SemanticError::MissingAmount),
1638                 }
1639
1640                 match OfferBuilder::new("foo".into(), recipient_pubkey())
1641                         .amount_msats(1000)
1642                         .supported_quantity(Quantity::Unbounded)
1643                         .build().unwrap()
1644                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1645                         .quantity(u64::max_value()).unwrap()
1646                         .build()
1647                 {
1648                         Ok(_) => panic!("expected error"),
1649                         Err(e) => assert_eq!(e, Bolt12SemanticError::InvalidAmount),
1650                 }
1651         }
1652
1653         #[test]
1654         fn builds_invoice_request_with_features() {
1655                 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1656                         .amount_msats(1000)
1657                         .build().unwrap()
1658                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1659                         .features_unchecked(InvoiceRequestFeatures::unknown())
1660                         .build().unwrap()
1661                         .sign(payer_sign).unwrap();
1662                 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1663                 assert_eq!(invoice_request.invoice_request_features(), &InvoiceRequestFeatures::unknown());
1664                 assert_eq!(tlv_stream.features, Some(&InvoiceRequestFeatures::unknown()));
1665
1666                 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1667                         .amount_msats(1000)
1668                         .build().unwrap()
1669                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1670                         .features_unchecked(InvoiceRequestFeatures::unknown())
1671                         .features_unchecked(InvoiceRequestFeatures::empty())
1672                         .build().unwrap()
1673                         .sign(payer_sign).unwrap();
1674                 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1675                 assert_eq!(invoice_request.invoice_request_features(), &InvoiceRequestFeatures::empty());
1676                 assert_eq!(tlv_stream.features, None);
1677         }
1678
1679         #[test]
1680         fn builds_invoice_request_with_quantity() {
1681                 let one = NonZeroU64::new(1).unwrap();
1682                 let ten = NonZeroU64::new(10).unwrap();
1683
1684                 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1685                         .amount_msats(1000)
1686                         .supported_quantity(Quantity::One)
1687                         .build().unwrap()
1688                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1689                         .build().unwrap()
1690                         .sign(payer_sign).unwrap();
1691                 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1692                 assert_eq!(invoice_request.quantity(), None);
1693                 assert_eq!(tlv_stream.quantity, None);
1694
1695                 match OfferBuilder::new("foo".into(), recipient_pubkey())
1696                         .amount_msats(1000)
1697                         .supported_quantity(Quantity::One)
1698                         .build().unwrap()
1699                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1700                         .amount_msats(2_000).unwrap()
1701                         .quantity(2)
1702                 {
1703                         Ok(_) => panic!("expected error"),
1704                         Err(e) => assert_eq!(e, Bolt12SemanticError::UnexpectedQuantity),
1705                 }
1706
1707                 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1708                         .amount_msats(1000)
1709                         .supported_quantity(Quantity::Bounded(ten))
1710                         .build().unwrap()
1711                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1712                         .amount_msats(10_000).unwrap()
1713                         .quantity(10).unwrap()
1714                         .build().unwrap()
1715                         .sign(payer_sign).unwrap();
1716                 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1717                 assert_eq!(invoice_request.amount_msats(), Some(10_000));
1718                 assert_eq!(tlv_stream.amount, Some(10_000));
1719
1720                 match OfferBuilder::new("foo".into(), recipient_pubkey())
1721                         .amount_msats(1000)
1722                         .supported_quantity(Quantity::Bounded(ten))
1723                         .build().unwrap()
1724                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1725                         .amount_msats(11_000).unwrap()
1726                         .quantity(11)
1727                 {
1728                         Ok(_) => panic!("expected error"),
1729                         Err(e) => assert_eq!(e, Bolt12SemanticError::InvalidQuantity),
1730                 }
1731
1732                 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1733                         .amount_msats(1000)
1734                         .supported_quantity(Quantity::Unbounded)
1735                         .build().unwrap()
1736                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1737                         .amount_msats(2_000).unwrap()
1738                         .quantity(2).unwrap()
1739                         .build().unwrap()
1740                         .sign(payer_sign).unwrap();
1741                 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1742                 assert_eq!(invoice_request.amount_msats(), Some(2_000));
1743                 assert_eq!(tlv_stream.amount, Some(2_000));
1744
1745                 match OfferBuilder::new("foo".into(), recipient_pubkey())
1746                         .amount_msats(1000)
1747                         .supported_quantity(Quantity::Unbounded)
1748                         .build().unwrap()
1749                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1750                         .build()
1751                 {
1752                         Ok(_) => panic!("expected error"),
1753                         Err(e) => assert_eq!(e, Bolt12SemanticError::MissingQuantity),
1754                 }
1755
1756                 match OfferBuilder::new("foo".into(), recipient_pubkey())
1757                         .amount_msats(1000)
1758                         .supported_quantity(Quantity::Bounded(one))
1759                         .build().unwrap()
1760                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1761                         .build()
1762                 {
1763                         Ok(_) => panic!("expected error"),
1764                         Err(e) => assert_eq!(e, Bolt12SemanticError::MissingQuantity),
1765                 }
1766         }
1767
1768         #[test]
1769         fn builds_invoice_request_with_payer_note() {
1770                 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1771                         .amount_msats(1000)
1772                         .build().unwrap()
1773                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1774                         .payer_note("bar".into())
1775                         .build().unwrap()
1776                         .sign(payer_sign).unwrap();
1777                 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1778                 assert_eq!(invoice_request.payer_note(), Some(PrintableString("bar")));
1779                 assert_eq!(tlv_stream.payer_note, Some(&String::from("bar")));
1780
1781                 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1782                         .amount_msats(1000)
1783                         .build().unwrap()
1784                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1785                         .payer_note("bar".into())
1786                         .payer_note("baz".into())
1787                         .build().unwrap()
1788                         .sign(payer_sign).unwrap();
1789                 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1790                 assert_eq!(invoice_request.payer_note(), Some(PrintableString("baz")));
1791                 assert_eq!(tlv_stream.payer_note, Some(&String::from("baz")));
1792         }
1793
1794         #[test]
1795         fn fails_signing_invoice_request() {
1796                 match OfferBuilder::new("foo".into(), recipient_pubkey())
1797                         .amount_msats(1000)
1798                         .build().unwrap()
1799                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1800                         .build().unwrap()
1801                         .sign(fail_sign)
1802                 {
1803                         Ok(_) => panic!("expected error"),
1804                         Err(e) => assert_eq!(e, SignError::Signing),
1805                 }
1806
1807                 match OfferBuilder::new("foo".into(), recipient_pubkey())
1808                         .amount_msats(1000)
1809                         .build().unwrap()
1810                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1811                         .build().unwrap()
1812                         .sign(recipient_sign)
1813                 {
1814                         Ok(_) => panic!("expected error"),
1815                         Err(e) => assert_eq!(e, SignError::Verification(secp256k1::Error::InvalidSignature)),
1816                 }
1817         }
1818
1819         #[test]
1820         fn fails_responding_with_unknown_required_features() {
1821                 match OfferBuilder::new("foo".into(), recipient_pubkey())
1822                         .amount_msats(1000)
1823                         .build().unwrap()
1824                         .request_invoice(vec![42; 32], payer_pubkey()).unwrap()
1825                         .features_unchecked(InvoiceRequestFeatures::unknown())
1826                         .build().unwrap()
1827                         .sign(payer_sign).unwrap()
1828                         .respond_with_no_std(payment_paths(), payment_hash(), now())
1829                 {
1830                         Ok(_) => panic!("expected error"),
1831                         Err(e) => assert_eq!(e, Bolt12SemanticError::UnknownRequiredFeatures),
1832                 }
1833         }
1834
1835         #[test]
1836         fn parses_invoice_request_with_metadata() {
1837                 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1838                         .amount_msats(1000)
1839                         .build().unwrap()
1840                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1841                         .build().unwrap()
1842                         .sign(payer_sign).unwrap();
1843
1844                 let mut buffer = Vec::new();
1845                 invoice_request.write(&mut buffer).unwrap();
1846
1847                 if let Err(e) = InvoiceRequest::try_from(buffer) {
1848                         panic!("error parsing invoice_request: {:?}", e);
1849                 }
1850         }
1851
1852         #[test]
1853         fn parses_invoice_request_with_chain() {
1854                 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1855                         .amount_msats(1000)
1856                         .build().unwrap()
1857                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1858                         .chain(Network::Bitcoin).unwrap()
1859                         .build().unwrap()
1860                         .sign(payer_sign).unwrap();
1861
1862                 let mut buffer = Vec::new();
1863                 invoice_request.write(&mut buffer).unwrap();
1864
1865                 if let Err(e) = InvoiceRequest::try_from(buffer) {
1866                         panic!("error parsing invoice_request: {:?}", e);
1867                 }
1868
1869                 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1870                         .amount_msats(1000)
1871                         .build().unwrap()
1872                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1873                         .chain_unchecked(Network::Testnet)
1874                         .build_unchecked()
1875                         .sign(payer_sign).unwrap();
1876
1877                 let mut buffer = Vec::new();
1878                 invoice_request.write(&mut buffer).unwrap();
1879
1880                 match InvoiceRequest::try_from(buffer) {
1881                         Ok(_) => panic!("expected error"),
1882                         Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::UnsupportedChain)),
1883                 }
1884         }
1885
1886         #[test]
1887         fn parses_invoice_request_with_amount() {
1888                 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1889                         .amount_msats(1000)
1890                         .build().unwrap()
1891                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1892                         .build().unwrap()
1893                         .sign(payer_sign).unwrap();
1894
1895                 let mut buffer = Vec::new();
1896                 invoice_request.write(&mut buffer).unwrap();
1897
1898                 if let Err(e) = InvoiceRequest::try_from(buffer) {
1899                         panic!("error parsing invoice_request: {:?}", e);
1900                 }
1901
1902                 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1903                         .build().unwrap()
1904                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1905                         .amount_msats(1000).unwrap()
1906                         .build().unwrap()
1907                         .sign(payer_sign).unwrap();
1908
1909                 let mut buffer = Vec::new();
1910                 invoice_request.write(&mut buffer).unwrap();
1911
1912                 if let Err(e) = InvoiceRequest::try_from(buffer) {
1913                         panic!("error parsing invoice_request: {:?}", e);
1914                 }
1915
1916                 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1917                         .build().unwrap()
1918                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1919                         .build_unchecked()
1920                         .sign(payer_sign).unwrap();
1921
1922                 let mut buffer = Vec::new();
1923                 invoice_request.write(&mut buffer).unwrap();
1924
1925                 match InvoiceRequest::try_from(buffer) {
1926                         Ok(_) => panic!("expected error"),
1927                         Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingAmount)),
1928                 }
1929
1930                 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1931                         .amount_msats(1000)
1932                         .build().unwrap()
1933                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1934                         .amount_msats_unchecked(999)
1935                         .build_unchecked()
1936                         .sign(payer_sign).unwrap();
1937
1938                 let mut buffer = Vec::new();
1939                 invoice_request.write(&mut buffer).unwrap();
1940
1941                 match InvoiceRequest::try_from(buffer) {
1942                         Ok(_) => panic!("expected error"),
1943                         Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::InsufficientAmount)),
1944                 }
1945
1946                 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1947                         .amount(Amount::Currency { iso4217_code: *b"USD", amount: 1000 })
1948                         .build_unchecked()
1949                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1950                         .build_unchecked()
1951                         .sign(payer_sign).unwrap();
1952
1953                 let mut buffer = Vec::new();
1954                 invoice_request.write(&mut buffer).unwrap();
1955
1956                 match InvoiceRequest::try_from(buffer) {
1957                         Ok(_) => panic!("expected error"),
1958                         Err(e) => {
1959                                 assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::UnsupportedCurrency));
1960                         },
1961                 }
1962
1963                 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1964                         .amount_msats(1000)
1965                         .supported_quantity(Quantity::Unbounded)
1966                         .build().unwrap()
1967                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1968                         .quantity(u64::max_value()).unwrap()
1969                         .build_unchecked()
1970                         .sign(payer_sign).unwrap();
1971
1972                 let mut buffer = Vec::new();
1973                 invoice_request.write(&mut buffer).unwrap();
1974
1975                 match InvoiceRequest::try_from(buffer) {
1976                         Ok(_) => panic!("expected error"),
1977                         Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::InvalidAmount)),
1978                 }
1979         }
1980
1981         #[test]
1982         fn parses_invoice_request_with_quantity() {
1983                 let one = NonZeroU64::new(1).unwrap();
1984                 let ten = NonZeroU64::new(10).unwrap();
1985
1986                 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1987                         .amount_msats(1000)
1988                         .supported_quantity(Quantity::One)
1989                         .build().unwrap()
1990                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1991                         .build().unwrap()
1992                         .sign(payer_sign).unwrap();
1993
1994                 let mut buffer = Vec::new();
1995                 invoice_request.write(&mut buffer).unwrap();
1996
1997                 if let Err(e) = InvoiceRequest::try_from(buffer) {
1998                         panic!("error parsing invoice_request: {:?}", e);
1999                 }
2000
2001                 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
2002                         .amount_msats(1000)
2003                         .supported_quantity(Quantity::One)
2004                         .build().unwrap()
2005                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2006                         .amount_msats(2_000).unwrap()
2007                         .quantity_unchecked(2)
2008                         .build_unchecked()
2009                         .sign(payer_sign).unwrap();
2010
2011                 let mut buffer = Vec::new();
2012                 invoice_request.write(&mut buffer).unwrap();
2013
2014                 match InvoiceRequest::try_from(buffer) {
2015                         Ok(_) => panic!("expected error"),
2016                         Err(e) => {
2017                                 assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::UnexpectedQuantity));
2018                         },
2019                 }
2020
2021                 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
2022                         .amount_msats(1000)
2023                         .supported_quantity(Quantity::Bounded(ten))
2024                         .build().unwrap()
2025                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2026                         .amount_msats(10_000).unwrap()
2027                         .quantity(10).unwrap()
2028                         .build().unwrap()
2029                         .sign(payer_sign).unwrap();
2030
2031                 let mut buffer = Vec::new();
2032                 invoice_request.write(&mut buffer).unwrap();
2033
2034                 if let Err(e) = InvoiceRequest::try_from(buffer) {
2035                         panic!("error parsing invoice_request: {:?}", e);
2036                 }
2037
2038                 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
2039                         .amount_msats(1000)
2040                         .supported_quantity(Quantity::Bounded(ten))
2041                         .build().unwrap()
2042                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2043                         .amount_msats(11_000).unwrap()
2044                         .quantity_unchecked(11)
2045                         .build_unchecked()
2046                         .sign(payer_sign).unwrap();
2047
2048                 let mut buffer = Vec::new();
2049                 invoice_request.write(&mut buffer).unwrap();
2050
2051                 match InvoiceRequest::try_from(buffer) {
2052                         Ok(_) => panic!("expected error"),
2053                         Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::InvalidQuantity)),
2054                 }
2055
2056                 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
2057                         .amount_msats(1000)
2058                         .supported_quantity(Quantity::Unbounded)
2059                         .build().unwrap()
2060                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2061                         .amount_msats(2_000).unwrap()
2062                         .quantity(2).unwrap()
2063                         .build().unwrap()
2064                         .sign(payer_sign).unwrap();
2065
2066                 let mut buffer = Vec::new();
2067                 invoice_request.write(&mut buffer).unwrap();
2068
2069                 if let Err(e) = InvoiceRequest::try_from(buffer) {
2070                         panic!("error parsing invoice_request: {:?}", e);
2071                 }
2072
2073                 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
2074                         .amount_msats(1000)
2075                         .supported_quantity(Quantity::Unbounded)
2076                         .build().unwrap()
2077                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2078                         .build_unchecked()
2079                         .sign(payer_sign).unwrap();
2080
2081                 let mut buffer = Vec::new();
2082                 invoice_request.write(&mut buffer).unwrap();
2083
2084                 match InvoiceRequest::try_from(buffer) {
2085                         Ok(_) => panic!("expected error"),
2086                         Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingQuantity)),
2087                 }
2088
2089                 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
2090                         .amount_msats(1000)
2091                         .supported_quantity(Quantity::Bounded(one))
2092                         .build().unwrap()
2093                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2094                         .build_unchecked()
2095                         .sign(payer_sign).unwrap();
2096
2097                 let mut buffer = Vec::new();
2098                 invoice_request.write(&mut buffer).unwrap();
2099
2100                 match InvoiceRequest::try_from(buffer) {
2101                         Ok(_) => panic!("expected error"),
2102                         Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingQuantity)),
2103                 }
2104         }
2105
2106         #[test]
2107         fn fails_parsing_invoice_request_without_metadata() {
2108                 let offer = OfferBuilder::new("foo".into(), recipient_pubkey())
2109                         .amount_msats(1000)
2110                         .build().unwrap();
2111                 let unsigned_invoice_request = offer.request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2112                         .build().unwrap();
2113                 let mut tlv_stream = unsigned_invoice_request.contents.as_tlv_stream();
2114                 tlv_stream.0.metadata = None;
2115
2116                 let mut buffer = Vec::new();
2117                 tlv_stream.write(&mut buffer).unwrap();
2118
2119                 match InvoiceRequest::try_from(buffer) {
2120                         Ok(_) => panic!("expected error"),
2121                         Err(e) => {
2122                                 assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingPayerMetadata));
2123                         },
2124                 }
2125         }
2126
2127         #[test]
2128         fn fails_parsing_invoice_request_without_payer_id() {
2129                 let offer = OfferBuilder::new("foo".into(), recipient_pubkey())
2130                         .amount_msats(1000)
2131                         .build().unwrap();
2132                 let unsigned_invoice_request = offer.request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2133                         .build().unwrap();
2134                 let mut tlv_stream = unsigned_invoice_request.contents.as_tlv_stream();
2135                 tlv_stream.2.payer_id = None;
2136
2137                 let mut buffer = Vec::new();
2138                 tlv_stream.write(&mut buffer).unwrap();
2139
2140                 match InvoiceRequest::try_from(buffer) {
2141                         Ok(_) => panic!("expected error"),
2142                         Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingPayerId)),
2143                 }
2144         }
2145
2146         #[test]
2147         fn fails_parsing_invoice_request_without_node_id() {
2148                 let offer = OfferBuilder::new("foo".into(), recipient_pubkey())
2149                         .amount_msats(1000)
2150                         .build().unwrap();
2151                 let unsigned_invoice_request = offer.request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2152                         .build().unwrap();
2153                 let mut tlv_stream = unsigned_invoice_request.contents.as_tlv_stream();
2154                 tlv_stream.1.node_id = None;
2155
2156                 let mut buffer = Vec::new();
2157                 tlv_stream.write(&mut buffer).unwrap();
2158
2159                 match InvoiceRequest::try_from(buffer) {
2160                         Ok(_) => panic!("expected error"),
2161                         Err(e) => {
2162                                 assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingSigningPubkey));
2163                         },
2164                 }
2165         }
2166
2167         #[test]
2168         fn fails_parsing_invoice_request_without_signature() {
2169                 let mut buffer = Vec::new();
2170                 OfferBuilder::new("foo".into(), recipient_pubkey())
2171                         .amount_msats(1000)
2172                         .build().unwrap()
2173                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2174                         .build().unwrap()
2175                         .contents
2176                         .write(&mut buffer).unwrap();
2177
2178                 match InvoiceRequest::try_from(buffer) {
2179                         Ok(_) => panic!("expected error"),
2180                         Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingSignature)),
2181                 }
2182         }
2183
2184         #[test]
2185         fn fails_parsing_invoice_request_with_invalid_signature() {
2186                 let mut invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
2187                         .amount_msats(1000)
2188                         .build().unwrap()
2189                         .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2190                         .build().unwrap()
2191                         .sign(payer_sign).unwrap();
2192                 let last_signature_byte = invoice_request.bytes.last_mut().unwrap();
2193                 *last_signature_byte = last_signature_byte.wrapping_add(1);
2194
2195                 let mut buffer = Vec::new();
2196                 invoice_request.write(&mut buffer).unwrap();
2197
2198                 match InvoiceRequest::try_from(buffer) {
2199                         Ok(_) => panic!("expected error"),
2200                         Err(e) => {
2201                                 assert_eq!(e, Bolt12ParseError::InvalidSignature(secp256k1::Error::InvalidSignature));
2202                         },
2203                 }
2204         }
2205
2206         #[test]
2207         fn fails_parsing_invoice_request_with_extra_tlv_records() {
2208                 let secp_ctx = Secp256k1::new();
2209                 let keys = KeyPair::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
2210                 let invoice_request = OfferBuilder::new("foo".into(), keys.public_key())
2211                         .amount_msats(1000)
2212                         .build().unwrap()
2213                         .request_invoice(vec![1; 32], keys.public_key()).unwrap()
2214                         .build().unwrap()
2215                         .sign(|message: &UnsignedInvoiceRequest|
2216                                 Ok(secp_ctx.sign_schnorr_no_aux_rand(message.as_ref().as_digest(), &keys))
2217                         )
2218                         .unwrap();
2219
2220                 let mut encoded_invoice_request = Vec::new();
2221                 invoice_request.write(&mut encoded_invoice_request).unwrap();
2222                 BigSize(1002).write(&mut encoded_invoice_request).unwrap();
2223                 BigSize(32).write(&mut encoded_invoice_request).unwrap();
2224                 [42u8; 32].write(&mut encoded_invoice_request).unwrap();
2225
2226                 match InvoiceRequest::try_from(encoded_invoice_request) {
2227                         Ok(_) => panic!("expected error"),
2228                         Err(e) => assert_eq!(e, Bolt12ParseError::Decode(DecodeError::InvalidValue)),
2229                 }
2230         }
2231
2232         #[test]
2233         fn copies_verified_invoice_request_fields() {
2234                 let desc = "foo".to_string();
2235                 let node_id = recipient_pubkey();
2236                 let expanded_key = ExpandedKey::new(&KeyMaterial([42; 32]));
2237                 let entropy = FixedEntropy {};
2238                 let secp_ctx = Secp256k1::new();
2239
2240                 #[cfg(c_bindings)]
2241                 use crate::offers::offer::OfferWithDerivedMetadataBuilder as OfferBuilder;
2242                 let offer = OfferBuilder
2243                         ::deriving_signing_pubkey(desc, node_id, &expanded_key, &entropy, &secp_ctx)
2244                         .chain(Network::Testnet)
2245                         .amount_msats(1000)
2246                         .supported_quantity(Quantity::Unbounded)
2247                         .build().unwrap();
2248                 assert_eq!(offer.signing_pubkey(), node_id);
2249
2250                 let invoice_request = offer.request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2251                         .chain(Network::Testnet).unwrap()
2252                         .quantity(1).unwrap()
2253                         .payer_note("0".repeat(PAYER_NOTE_LIMIT * 2))
2254                         .build().unwrap()
2255                         .sign(payer_sign).unwrap();
2256                 match invoice_request.verify(&expanded_key, &secp_ctx) {
2257                         Ok(invoice_request) => {
2258                                 let fields = invoice_request.fields();
2259                                 assert_eq!(invoice_request.offer_id, offer.id());
2260                                 assert_eq!(
2261                                         fields,
2262                                         InvoiceRequestFields {
2263                                                 payer_id: payer_pubkey(),
2264                                                 quantity: Some(1),
2265                                                 payer_note_truncated: Some(UntrustedString("0".repeat(PAYER_NOTE_LIMIT))),
2266                                         }
2267                                 );
2268
2269                                 let mut buffer = Vec::new();
2270                                 fields.write(&mut buffer).unwrap();
2271
2272                                 let deserialized_fields: InvoiceRequestFields =
2273                                         Readable::read(&mut buffer.as_slice()).unwrap();
2274                                 assert_eq!(deserialized_fields, fields);
2275                         },
2276                         Err(_) => panic!("unexpected error"),
2277                 }
2278         }
2279 }