1 // This file is Copyright its original authors, visible in version control
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
10 //! Data structures and encoding for `invoice` messages.
12 //! A [`Bolt12Invoice`] can be built from a parsed [`InvoiceRequest`] for the "offer to be paid"
13 //! flow or from a [`Refund`] as an "offer for money" flow. The expected recipient of the payment
14 //! then sends the invoice to the intended payer, who will then pay it.
16 //! The payment recipient must include a [`PaymentHash`], so as to reveal the preimage upon payment
17 //! receipt, and one or more [`BlindedPath`]s for the payer to use when sending the payment.
20 //! extern crate bitcoin;
21 //! extern crate lightning;
23 //! use bitcoin::hashes::Hash;
24 //! use bitcoin::secp256k1::{KeyPair, PublicKey, Secp256k1, SecretKey};
25 //! use core::convert::{Infallible, TryFrom};
26 //! use lightning::offers::invoice_request::InvoiceRequest;
27 //! use lightning::offers::refund::Refund;
28 //! use lightning::util::ser::Writeable;
30 //! # use lightning::ln::PaymentHash;
31 //! # use lightning::offers::invoice::BlindedPayInfo;
32 //! # use lightning::blinded_path::BlindedPath;
34 //! # fn create_payment_paths() -> Vec<(BlindedPayInfo, BlindedPath)> { unimplemented!() }
35 //! # fn create_payment_hash() -> PaymentHash { unimplemented!() }
37 //! # fn parse_invoice_request(bytes: Vec<u8>) -> Result<(), lightning::offers::parse::Bolt12ParseError> {
38 //! let payment_paths = create_payment_paths();
39 //! let payment_hash = create_payment_hash();
40 //! let secp_ctx = Secp256k1::new();
41 //! let keys = KeyPair::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32])?);
42 //! let pubkey = PublicKey::from(keys);
43 //! let wpubkey_hash = bitcoin::util::key::PublicKey::new(pubkey).wpubkey_hash().unwrap();
44 //! let mut buffer = Vec::new();
46 //! // Invoice for the "offer to be paid" flow.
47 //! InvoiceRequest::try_from(bytes)?
48 #![cfg_attr(feature = "std", doc = "
49 .respond_with(payment_paths, payment_hash)?
51 #![cfg_attr(not(feature = "std"), doc = "
52 .respond_with_no_std(payment_paths, payment_hash, core::time::Duration::from_secs(0))?
54 //! .relative_expiry(3600)
56 //! .fallback_v0_p2wpkh(&wpubkey_hash)
58 //! .sign::<_, Infallible>(
59 //! |message| Ok(secp_ctx.sign_schnorr_no_aux_rand(message.as_ref().as_digest(), &keys))
61 //! .expect("failed verifying signature")
62 //! .write(&mut buffer)
67 //! # fn parse_refund(bytes: Vec<u8>) -> Result<(), lightning::offers::parse::Bolt12ParseError> {
68 //! # let payment_paths = create_payment_paths();
69 //! # let payment_hash = create_payment_hash();
70 //! # let secp_ctx = Secp256k1::new();
71 //! # let keys = KeyPair::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32])?);
72 //! # let pubkey = PublicKey::from(keys);
73 //! # let wpubkey_hash = bitcoin::util::key::PublicKey::new(pubkey).wpubkey_hash().unwrap();
74 //! # let mut buffer = Vec::new();
76 //! // Invoice for the "offer for money" flow.
78 //! .parse::<Refund>()?
79 #![cfg_attr(feature = "std", doc = "
80 .respond_with(payment_paths, payment_hash, pubkey)?
82 #![cfg_attr(not(feature = "std"), doc = "
83 .respond_with_no_std(payment_paths, payment_hash, pubkey, core::time::Duration::from_secs(0))?
85 //! .relative_expiry(3600)
87 //! .fallback_v0_p2wpkh(&wpubkey_hash)
89 //! .sign::<_, Infallible>(
90 //! |message| Ok(secp_ctx.sign_schnorr_no_aux_rand(message.as_ref().as_digest(), &keys))
92 //! .expect("failed verifying signature")
93 //! .write(&mut buffer)
100 use bitcoin::blockdata::constants::ChainHash;
101 use bitcoin::hash_types::{WPubkeyHash, WScriptHash};
102 use bitcoin::hashes::Hash;
103 use bitcoin::network::constants::Network;
104 use bitcoin::secp256k1::{KeyPair, PublicKey, Secp256k1, self};
105 use bitcoin::secp256k1::schnorr::Signature;
106 use bitcoin::util::address::{Address, Payload, WitnessVersion};
107 use bitcoin::util::schnorr::TweakedPublicKey;
108 use core::convert::{AsRef, Infallible, TryFrom};
109 use core::time::Duration;
111 use crate::blinded_path::BlindedPath;
112 use crate::ln::PaymentHash;
113 use crate::ln::features::{BlindedHopFeatures, Bolt12InvoiceFeatures, InvoiceRequestFeatures, OfferFeatures};
114 use crate::ln::inbound_payment::ExpandedKey;
115 use crate::ln::msgs::DecodeError;
116 use crate::offers::invoice_request::{INVOICE_REQUEST_PAYER_ID_TYPE, INVOICE_REQUEST_TYPES, IV_BYTES as INVOICE_REQUEST_IV_BYTES, InvoiceRequest, InvoiceRequestContents, InvoiceRequestTlvStream, InvoiceRequestTlvStreamRef};
117 use crate::offers::merkle::{SignError, SignatureTlvStream, SignatureTlvStreamRef, TaggedHash, TlvStream, WithoutSignatures, self};
118 use crate::offers::offer::{Amount, OFFER_TYPES, OfferTlvStream, OfferTlvStreamRef, Quantity};
119 use crate::offers::parse::{Bolt12ParseError, Bolt12SemanticError, ParsedMessage};
120 use crate::offers::payer::{PAYER_METADATA_TYPE, PayerTlvStream, PayerTlvStreamRef};
121 use crate::offers::refund::{IV_BYTES as REFUND_IV_BYTES, Refund, RefundContents};
122 use crate::offers::signer;
123 use crate::util::ser::{HighZeroBytesDroppedBigSize, Iterable, SeekReadable, WithoutLength, Writeable, Writer};
124 use crate::util::string::PrintableString;
126 use crate::prelude::*;
128 #[cfg(feature = "std")]
129 use std::time::SystemTime;
131 const DEFAULT_RELATIVE_EXPIRY: Duration = Duration::from_secs(7200);
133 /// Tag for the hash function used when signing a [`Bolt12Invoice`]'s merkle root.
134 pub const SIGNATURE_TAG: &'static str = concat!("lightning", "invoice", "signature");
136 /// Builds a [`Bolt12Invoice`] from either:
137 /// - an [`InvoiceRequest`] for the "offer to be paid" flow or
138 /// - a [`Refund`] for the "offer for money" flow.
140 /// See [module-level documentation] for usage.
142 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
144 /// [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
145 /// [`Refund`]: crate::offers::refund::Refund
146 /// [module-level documentation]: self
147 pub struct InvoiceBuilder<'a, S: SigningPubkeyStrategy> {
148 invreq_bytes: &'a Vec<u8>,
149 invoice: InvoiceContents,
150 signing_pubkey_strategy: S,
153 /// Indicates how [`Bolt12Invoice::signing_pubkey`] was set.
155 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
156 pub trait SigningPubkeyStrategy {}
158 /// [`Bolt12Invoice::signing_pubkey`] was explicitly set.
160 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
161 pub struct ExplicitSigningPubkey {}
163 /// [`Bolt12Invoice::signing_pubkey`] was derived.
165 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
166 pub struct DerivedSigningPubkey(KeyPair);
168 impl SigningPubkeyStrategy for ExplicitSigningPubkey {}
169 impl SigningPubkeyStrategy for DerivedSigningPubkey {}
171 impl<'a> InvoiceBuilder<'a, ExplicitSigningPubkey> {
172 pub(super) fn for_offer(
173 invoice_request: &'a InvoiceRequest, payment_paths: Vec<(BlindedPayInfo, BlindedPath)>,
174 created_at: Duration, payment_hash: PaymentHash
175 ) -> Result<Self, Bolt12SemanticError> {
176 let amount_msats = Self::check_amount_msats(invoice_request)?;
177 let signing_pubkey = invoice_request.contents.inner.offer.signing_pubkey();
178 let contents = InvoiceContents::ForOffer {
179 invoice_request: invoice_request.contents.clone(),
180 fields: Self::fields(
181 payment_paths, created_at, payment_hash, amount_msats, signing_pubkey
185 Self::new(&invoice_request.bytes, contents, ExplicitSigningPubkey {})
188 pub(super) fn for_refund(
189 refund: &'a Refund, payment_paths: Vec<(BlindedPayInfo, BlindedPath)>, created_at: Duration,
190 payment_hash: PaymentHash, signing_pubkey: PublicKey
191 ) -> Result<Self, Bolt12SemanticError> {
192 let amount_msats = refund.amount_msats();
193 let contents = InvoiceContents::ForRefund {
194 refund: refund.contents.clone(),
195 fields: Self::fields(
196 payment_paths, created_at, payment_hash, amount_msats, signing_pubkey
200 Self::new(&refund.bytes, contents, ExplicitSigningPubkey {})
204 impl<'a> InvoiceBuilder<'a, DerivedSigningPubkey> {
205 pub(super) fn for_offer_using_keys(
206 invoice_request: &'a InvoiceRequest, payment_paths: Vec<(BlindedPayInfo, BlindedPath)>,
207 created_at: Duration, payment_hash: PaymentHash, keys: KeyPair
208 ) -> Result<Self, Bolt12SemanticError> {
209 let amount_msats = Self::check_amount_msats(invoice_request)?;
210 let signing_pubkey = invoice_request.contents.inner.offer.signing_pubkey();
211 let contents = InvoiceContents::ForOffer {
212 invoice_request: invoice_request.contents.clone(),
213 fields: Self::fields(
214 payment_paths, created_at, payment_hash, amount_msats, signing_pubkey
218 Self::new(&invoice_request.bytes, contents, DerivedSigningPubkey(keys))
221 pub(super) fn for_refund_using_keys(
222 refund: &'a Refund, payment_paths: Vec<(BlindedPayInfo, BlindedPath)>, created_at: Duration,
223 payment_hash: PaymentHash, keys: KeyPair,
224 ) -> Result<Self, Bolt12SemanticError> {
225 let amount_msats = refund.amount_msats();
226 let signing_pubkey = keys.public_key();
227 let contents = InvoiceContents::ForRefund {
228 refund: refund.contents.clone(),
229 fields: Self::fields(
230 payment_paths, created_at, payment_hash, amount_msats, signing_pubkey
234 Self::new(&refund.bytes, contents, DerivedSigningPubkey(keys))
238 impl<'a, S: SigningPubkeyStrategy> InvoiceBuilder<'a, S> {
239 fn check_amount_msats(invoice_request: &InvoiceRequest) -> Result<u64, Bolt12SemanticError> {
240 match invoice_request.amount_msats() {
241 Some(amount_msats) => Ok(amount_msats),
242 None => match invoice_request.contents.inner.offer.amount() {
243 Some(Amount::Bitcoin { amount_msats }) => {
244 amount_msats.checked_mul(invoice_request.quantity().unwrap_or(1))
245 .ok_or(Bolt12SemanticError::InvalidAmount)
247 Some(Amount::Currency { .. }) => Err(Bolt12SemanticError::UnsupportedCurrency),
248 None => Err(Bolt12SemanticError::MissingAmount),
254 payment_paths: Vec<(BlindedPayInfo, BlindedPath)>, created_at: Duration,
255 payment_hash: PaymentHash, amount_msats: u64, signing_pubkey: PublicKey
258 payment_paths, created_at, relative_expiry: None, payment_hash, amount_msats,
259 fallbacks: None, features: Bolt12InvoiceFeatures::empty(), signing_pubkey,
264 invreq_bytes: &'a Vec<u8>, contents: InvoiceContents, signing_pubkey_strategy: S
265 ) -> Result<Self, Bolt12SemanticError> {
266 if contents.fields().payment_paths.is_empty() {
267 return Err(Bolt12SemanticError::MissingPaths);
270 Ok(Self { invreq_bytes, invoice: contents, signing_pubkey_strategy })
273 /// Sets the [`Bolt12Invoice::relative_expiry`] as seconds since [`Bolt12Invoice::created_at`].
274 /// Any expiry that has already passed is valid and can be checked for using
275 /// [`Bolt12Invoice::is_expired`].
277 /// Successive calls to this method will override the previous setting.
278 pub fn relative_expiry(mut self, relative_expiry_secs: u32) -> Self {
279 let relative_expiry = Duration::from_secs(relative_expiry_secs as u64);
280 self.invoice.fields_mut().relative_expiry = Some(relative_expiry);
284 /// Adds a P2WSH address to [`Bolt12Invoice::fallbacks`].
286 /// Successive calls to this method will add another address. Caller is responsible for not
287 /// adding duplicate addresses and only calling if capable of receiving to P2WSH addresses.
288 pub fn fallback_v0_p2wsh(mut self, script_hash: &WScriptHash) -> Self {
289 let address = FallbackAddress {
290 version: WitnessVersion::V0.to_num(),
291 program: Vec::from(&script_hash.into_inner()[..]),
293 self.invoice.fields_mut().fallbacks.get_or_insert_with(Vec::new).push(address);
297 /// Adds a P2WPKH address to [`Bolt12Invoice::fallbacks`].
299 /// Successive calls to this method will add another address. Caller is responsible for not
300 /// adding duplicate addresses and only calling if capable of receiving to P2WPKH addresses.
301 pub fn fallback_v0_p2wpkh(mut self, pubkey_hash: &WPubkeyHash) -> Self {
302 let address = FallbackAddress {
303 version: WitnessVersion::V0.to_num(),
304 program: Vec::from(&pubkey_hash.into_inner()[..]),
306 self.invoice.fields_mut().fallbacks.get_or_insert_with(Vec::new).push(address);
310 /// Adds a P2TR address to [`Bolt12Invoice::fallbacks`].
312 /// Successive calls to this method will add another address. Caller is responsible for not
313 /// adding duplicate addresses and only calling if capable of receiving to P2TR addresses.
314 pub fn fallback_v1_p2tr_tweaked(mut self, output_key: &TweakedPublicKey) -> Self {
315 let address = FallbackAddress {
316 version: WitnessVersion::V1.to_num(),
317 program: Vec::from(&output_key.serialize()[..]),
319 self.invoice.fields_mut().fallbacks.get_or_insert_with(Vec::new).push(address);
323 /// Sets [`Bolt12Invoice::invoice_features`] to indicate MPP may be used. Otherwise, MPP is
325 pub fn allow_mpp(mut self) -> Self {
326 self.invoice.fields_mut().features.set_basic_mpp_optional();
331 impl<'a> InvoiceBuilder<'a, ExplicitSigningPubkey> {
332 /// Builds an unsigned [`Bolt12Invoice`] after checking for valid semantics. It can be signed by
333 /// [`UnsignedBolt12Invoice::sign`].
334 pub fn build(self) -> Result<UnsignedBolt12Invoice, Bolt12SemanticError> {
335 #[cfg(feature = "std")] {
336 if self.invoice.is_offer_or_refund_expired() {
337 return Err(Bolt12SemanticError::AlreadyExpired);
341 let InvoiceBuilder { invreq_bytes, invoice, .. } = self;
342 Ok(UnsignedBolt12Invoice::new(invreq_bytes, invoice))
346 impl<'a> InvoiceBuilder<'a, DerivedSigningPubkey> {
347 /// Builds a signed [`Bolt12Invoice`] after checking for valid semantics.
348 pub fn build_and_sign<T: secp256k1::Signing>(
349 self, secp_ctx: &Secp256k1<T>
350 ) -> Result<Bolt12Invoice, Bolt12SemanticError> {
351 #[cfg(feature = "std")] {
352 if self.invoice.is_offer_or_refund_expired() {
353 return Err(Bolt12SemanticError::AlreadyExpired);
358 invreq_bytes, invoice, signing_pubkey_strategy: DerivedSigningPubkey(keys)
360 let unsigned_invoice = UnsignedBolt12Invoice::new(invreq_bytes, invoice);
362 let invoice = unsigned_invoice
363 .sign::<_, Infallible>(
364 |message| Ok(secp_ctx.sign_schnorr_no_aux_rand(message.as_ref().as_digest(), &keys))
371 /// A semantically valid [`Bolt12Invoice`] that hasn't been signed.
375 /// This is serialized as a TLV stream, which includes TLV records from the originating message. As
376 /// such, it may include unknown, odd TLV records.
377 pub struct UnsignedBolt12Invoice {
379 contents: InvoiceContents,
380 tagged_hash: TaggedHash,
383 impl UnsignedBolt12Invoice {
384 fn new(invreq_bytes: &[u8], contents: InvoiceContents) -> Self {
385 // Use the invoice_request bytes instead of the invoice_request TLV stream as the latter may
386 // have contained unknown TLV records, which are not stored in `InvoiceRequestContents` or
388 let (_, _, _, invoice_tlv_stream) = contents.as_tlv_stream();
389 let invoice_request_bytes = WithoutSignatures(invreq_bytes);
390 let unsigned_tlv_stream = (invoice_request_bytes, invoice_tlv_stream);
392 let mut bytes = Vec::new();
393 unsigned_tlv_stream.write(&mut bytes).unwrap();
395 let tagged_hash = TaggedHash::new(SIGNATURE_TAG, &bytes);
397 Self { bytes, contents, tagged_hash }
400 /// Returns the [`TaggedHash`] of the invoice to sign.
401 pub fn tagged_hash(&self) -> &TaggedHash {
405 /// Signs the [`TaggedHash`] of the invoice using the given function.
407 /// Note: The hash computation may have included unknown, odd TLV records.
409 /// This is not exported to bindings users as functions aren't currently mapped.
410 pub fn sign<F, E>(mut self, sign: F) -> Result<Bolt12Invoice, SignError<E>>
412 F: FnOnce(&Self) -> Result<Signature, E>
414 let pubkey = self.contents.fields().signing_pubkey;
415 let signature = merkle::sign_message(sign, &self, pubkey)?;
417 // Append the signature TLV record to the bytes.
418 let signature_tlv_stream = SignatureTlvStreamRef {
419 signature: Some(&signature),
421 signature_tlv_stream.write(&mut self.bytes).unwrap();
425 contents: self.contents,
431 impl AsRef<TaggedHash> for UnsignedBolt12Invoice {
432 fn as_ref(&self) -> &TaggedHash {
437 /// A `Bolt12Invoice` is a payment request, typically corresponding to an [`Offer`] or a [`Refund`].
439 /// An invoice may be sent in response to an [`InvoiceRequest`] in the case of an offer or sent
440 /// directly after scanning a refund. It includes all the information needed to pay a recipient.
442 /// [`Offer`]: crate::offers::offer::Offer
443 /// [`Refund`]: crate::offers::refund::Refund
444 /// [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
445 #[derive(Clone, Debug)]
446 #[cfg_attr(test, derive(PartialEq))]
447 pub struct Bolt12Invoice {
449 contents: InvoiceContents,
450 signature: Signature,
453 /// The contents of an [`Bolt12Invoice`] for responding to either an [`Offer`] or a [`Refund`].
455 /// [`Offer`]: crate::offers::offer::Offer
456 /// [`Refund`]: crate::offers::refund::Refund
457 #[derive(Clone, Debug)]
458 #[cfg_attr(test, derive(PartialEq))]
459 enum InvoiceContents {
460 /// Contents for an [`Bolt12Invoice`] corresponding to an [`Offer`].
462 /// [`Offer`]: crate::offers::offer::Offer
464 invoice_request: InvoiceRequestContents,
465 fields: InvoiceFields,
467 /// Contents for an [`Bolt12Invoice`] corresponding to a [`Refund`].
469 /// [`Refund`]: crate::offers::refund::Refund
471 refund: RefundContents,
472 fields: InvoiceFields,
476 /// Invoice-specific fields for an `invoice` message.
477 #[derive(Clone, Debug, PartialEq)]
478 struct InvoiceFields {
479 payment_paths: Vec<(BlindedPayInfo, BlindedPath)>,
480 created_at: Duration,
481 relative_expiry: Option<Duration>,
482 payment_hash: PaymentHash,
484 fallbacks: Option<Vec<FallbackAddress>>,
485 features: Bolt12InvoiceFeatures,
486 signing_pubkey: PublicKey,
489 macro_rules! invoice_accessors { ($self: ident, $contents: expr) => {
490 /// The chains that may be used when paying a requested invoice.
492 /// From [`Offer::chains`]; `None` if the invoice was created in response to a [`Refund`].
494 /// [`Offer::chains`]: crate::offers::offer::Offer::chains
495 pub fn offer_chains(&$self) -> Option<Vec<ChainHash>> {
496 $contents.offer_chains()
499 /// The chain that must be used when paying the invoice; selected from [`offer_chains`] if the
500 /// invoice originated from an offer.
502 /// From [`InvoiceRequest::chain`] or [`Refund::chain`].
504 /// [`offer_chains`]: Self::offer_chains
505 /// [`InvoiceRequest::chain`]: crate::offers::invoice_request::InvoiceRequest::chain
506 pub fn chain(&$self) -> ChainHash {
510 /// Opaque bytes set by the originating [`Offer`].
512 /// From [`Offer::metadata`]; `None` if the invoice was created in response to a [`Refund`] or
513 /// if the [`Offer`] did not set it.
515 /// [`Offer`]: crate::offers::offer::Offer
516 /// [`Offer::metadata`]: crate::offers::offer::Offer::metadata
517 pub fn metadata(&$self) -> Option<&Vec<u8>> {
521 /// The minimum amount required for a successful payment of a single item.
523 /// From [`Offer::amount`]; `None` if the invoice was created in response to a [`Refund`] or if
524 /// the [`Offer`] did not set it.
526 /// [`Offer`]: crate::offers::offer::Offer
527 /// [`Offer::amount`]: crate::offers::offer::Offer::amount
528 pub fn amount(&$self) -> Option<&Amount> {
532 /// Features pertaining to the originating [`Offer`].
534 /// From [`Offer::offer_features`]; `None` if the invoice was created in response to a
537 /// [`Offer`]: crate::offers::offer::Offer
538 /// [`Offer::offer_features`]: crate::offers::offer::Offer::offer_features
539 pub fn offer_features(&$self) -> Option<&OfferFeatures> {
540 $contents.offer_features()
543 /// A complete description of the purpose of the originating offer or refund.
545 /// From [`Offer::description`] or [`Refund::description`].
547 /// [`Offer::description`]: crate::offers::offer::Offer::description
548 pub fn description(&$self) -> PrintableString {
549 $contents.description()
552 /// Duration since the Unix epoch when an invoice should no longer be requested.
554 /// From [`Offer::absolute_expiry`] or [`Refund::absolute_expiry`].
556 /// [`Offer::absolute_expiry`]: crate::offers::offer::Offer::absolute_expiry
557 pub fn absolute_expiry(&$self) -> Option<Duration> {
558 $contents.absolute_expiry()
561 /// The issuer of the offer or refund.
563 /// From [`Offer::issuer`] or [`Refund::issuer`].
565 /// [`Offer::issuer`]: crate::offers::offer::Offer::issuer
566 pub fn issuer(&$self) -> Option<PrintableString> {
570 /// Paths to the recipient originating from publicly reachable nodes.
572 /// From [`Offer::paths`] or [`Refund::paths`].
574 /// [`Offer::paths`]: crate::offers::offer::Offer::paths
575 pub fn message_paths(&$self) -> &[BlindedPath] {
576 $contents.message_paths()
579 /// The quantity of items supported.
581 /// From [`Offer::supported_quantity`]; `None` if the invoice was created in response to a
584 /// [`Offer::supported_quantity`]: crate::offers::offer::Offer::supported_quantity
585 pub fn supported_quantity(&$self) -> Option<Quantity> {
586 $contents.supported_quantity()
589 /// An unpredictable series of bytes from the payer.
591 /// From [`InvoiceRequest::payer_metadata`] or [`Refund::payer_metadata`].
592 pub fn payer_metadata(&$self) -> &[u8] {
593 $contents.payer_metadata()
596 /// Features pertaining to requesting an invoice.
598 /// From [`InvoiceRequest::invoice_request_features`] or [`Refund::features`].
599 pub fn invoice_request_features(&$self) -> &InvoiceRequestFeatures {
600 &$contents.invoice_request_features()
603 /// The quantity of items requested or refunded for.
605 /// From [`InvoiceRequest::quantity`] or [`Refund::quantity`].
606 pub fn quantity(&$self) -> Option<u64> {
610 /// A possibly transient pubkey used to sign the invoice request or to send an invoice for a
611 /// refund in case there are no [`message_paths`].
613 /// [`message_paths`]: Self::message_paths
614 pub fn payer_id(&$self) -> PublicKey {
618 /// A payer-provided note reflected back in the invoice.
620 /// From [`InvoiceRequest::payer_note`] or [`Refund::payer_note`].
621 pub fn payer_note(&$self) -> Option<PrintableString> {
622 $contents.payer_note()
625 /// Paths to the recipient originating from publicly reachable nodes, including information
626 /// needed for routing payments across them.
628 /// Blinded paths provide recipient privacy by obfuscating its node id. Note, however, that this
629 /// privacy is lost if a public node id is used for [`Bolt12Invoice::signing_pubkey`].
631 /// This is not exported to bindings users as slices with non-reference types cannot be ABI
632 /// matched in another language.
633 pub fn payment_paths(&$self) -> &[(BlindedPayInfo, BlindedPath)] {
634 $contents.payment_paths()
637 /// Duration since the Unix epoch when the invoice was created.
638 pub fn created_at(&$self) -> Duration {
639 $contents.created_at()
642 /// Duration since [`Bolt12Invoice::created_at`] when the invoice has expired and therefore
643 /// should no longer be paid.
644 pub fn relative_expiry(&$self) -> Duration {
645 $contents.relative_expiry()
648 /// Whether the invoice has expired.
649 #[cfg(feature = "std")]
650 pub fn is_expired(&$self) -> bool {
651 $contents.is_expired()
654 /// SHA256 hash of the payment preimage that will be given in return for paying the invoice.
655 pub fn payment_hash(&$self) -> PaymentHash {
656 $contents.payment_hash()
659 /// The minimum amount required for a successful payment of the invoice.
660 pub fn amount_msats(&$self) -> u64 {
661 $contents.amount_msats()
664 /// Fallback addresses for paying the invoice on-chain, in order of most-preferred to
666 pub fn fallbacks(&$self) -> Vec<Address> {
667 $contents.fallbacks()
670 /// Features pertaining to paying an invoice.
671 pub fn invoice_features(&$self) -> &Bolt12InvoiceFeatures {
675 /// The public key corresponding to the key used to sign the invoice.
676 pub fn signing_pubkey(&$self) -> PublicKey {
677 $contents.signing_pubkey()
681 impl UnsignedBolt12Invoice {
682 invoice_accessors!(self, self.contents);
686 invoice_accessors!(self, self.contents);
688 /// Signature of the invoice verified using [`Bolt12Invoice::signing_pubkey`].
689 pub fn signature(&self) -> Signature {
693 /// Hash that was used for signing the invoice.
694 pub fn signable_hash(&self) -> [u8; 32] {
695 merkle::message_digest(SIGNATURE_TAG, &self.bytes).as_ref().clone()
698 /// Verifies that the invoice was for a request or refund created using the given key.
699 pub fn verify<T: secp256k1::Signing>(
700 &self, key: &ExpandedKey, secp_ctx: &Secp256k1<T>
702 self.contents.verify(TlvStream::new(&self.bytes), key, secp_ctx)
706 pub(super) fn as_tlv_stream(&self) -> FullInvoiceTlvStreamRef {
707 let (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, invoice_tlv_stream) =
708 self.contents.as_tlv_stream();
709 let signature_tlv_stream = SignatureTlvStreamRef {
710 signature: Some(&self.signature),
712 (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, invoice_tlv_stream,
713 signature_tlv_stream)
717 impl InvoiceContents {
718 /// Whether the original offer or refund has expired.
719 #[cfg(feature = "std")]
720 fn is_offer_or_refund_expired(&self) -> bool {
722 InvoiceContents::ForOffer { invoice_request, .. } =>
723 invoice_request.inner.offer.is_expired(),
724 InvoiceContents::ForRefund { refund, .. } => refund.is_expired(),
728 fn offer_chains(&self) -> Option<Vec<ChainHash>> {
730 InvoiceContents::ForOffer { invoice_request, .. } =>
731 Some(invoice_request.inner.offer.chains()),
732 InvoiceContents::ForRefund { .. } => None,
736 fn chain(&self) -> ChainHash {
738 InvoiceContents::ForOffer { invoice_request, .. } => invoice_request.chain(),
739 InvoiceContents::ForRefund { refund, .. } => refund.chain(),
743 fn metadata(&self) -> Option<&Vec<u8>> {
745 InvoiceContents::ForOffer { invoice_request, .. } =>
746 invoice_request.inner.offer.metadata(),
747 InvoiceContents::ForRefund { .. } => None,
751 fn amount(&self) -> Option<&Amount> {
753 InvoiceContents::ForOffer { invoice_request, .. } =>
754 invoice_request.inner.offer.amount(),
755 InvoiceContents::ForRefund { .. } => None,
759 fn description(&self) -> PrintableString {
761 InvoiceContents::ForOffer { invoice_request, .. } => {
762 invoice_request.inner.offer.description()
764 InvoiceContents::ForRefund { refund, .. } => refund.description(),
768 fn offer_features(&self) -> Option<&OfferFeatures> {
770 InvoiceContents::ForOffer { invoice_request, .. } => {
771 Some(invoice_request.inner.offer.features())
773 InvoiceContents::ForRefund { .. } => None,
777 fn absolute_expiry(&self) -> Option<Duration> {
779 InvoiceContents::ForOffer { invoice_request, .. } => {
780 invoice_request.inner.offer.absolute_expiry()
782 InvoiceContents::ForRefund { refund, .. } => refund.absolute_expiry(),
786 fn issuer(&self) -> Option<PrintableString> {
788 InvoiceContents::ForOffer { invoice_request, .. } => {
789 invoice_request.inner.offer.issuer()
791 InvoiceContents::ForRefund { refund, .. } => refund.issuer(),
795 fn message_paths(&self) -> &[BlindedPath] {
797 InvoiceContents::ForOffer { invoice_request, .. } => {
798 invoice_request.inner.offer.paths()
800 InvoiceContents::ForRefund { refund, .. } => refund.paths(),
804 fn supported_quantity(&self) -> Option<Quantity> {
806 InvoiceContents::ForOffer { invoice_request, .. } => {
807 Some(invoice_request.inner.offer.supported_quantity())
809 InvoiceContents::ForRefund { .. } => None,
813 fn payer_metadata(&self) -> &[u8] {
815 InvoiceContents::ForOffer { invoice_request, .. } => invoice_request.metadata(),
816 InvoiceContents::ForRefund { refund, .. } => refund.metadata(),
820 fn invoice_request_features(&self) -> &InvoiceRequestFeatures {
822 InvoiceContents::ForOffer { invoice_request, .. } => invoice_request.features(),
823 InvoiceContents::ForRefund { refund, .. } => refund.features(),
827 fn quantity(&self) -> Option<u64> {
829 InvoiceContents::ForOffer { invoice_request, .. } => invoice_request.quantity(),
830 InvoiceContents::ForRefund { refund, .. } => refund.quantity(),
834 fn payer_id(&self) -> PublicKey {
836 InvoiceContents::ForOffer { invoice_request, .. } => invoice_request.payer_id(),
837 InvoiceContents::ForRefund { refund, .. } => refund.payer_id(),
841 fn payer_note(&self) -> Option<PrintableString> {
843 InvoiceContents::ForOffer { invoice_request, .. } => invoice_request.payer_note(),
844 InvoiceContents::ForRefund { refund, .. } => refund.payer_note(),
848 fn payment_paths(&self) -> &[(BlindedPayInfo, BlindedPath)] {
849 &self.fields().payment_paths[..]
852 fn created_at(&self) -> Duration {
853 self.fields().created_at
856 fn relative_expiry(&self) -> Duration {
857 self.fields().relative_expiry.unwrap_or(DEFAULT_RELATIVE_EXPIRY)
860 #[cfg(feature = "std")]
861 fn is_expired(&self) -> bool {
862 let absolute_expiry = self.created_at().checked_add(self.relative_expiry());
863 match absolute_expiry {
864 Some(seconds_from_epoch) => match SystemTime::UNIX_EPOCH.elapsed() {
865 Ok(elapsed) => elapsed > seconds_from_epoch,
872 fn payment_hash(&self) -> PaymentHash {
873 self.fields().payment_hash
876 fn amount_msats(&self) -> u64 {
877 self.fields().amount_msats
880 fn fallbacks(&self) -> Vec<Address> {
881 let chain = self.chain();
882 let network = if chain == ChainHash::using_genesis_block(Network::Bitcoin) {
884 } else if chain == ChainHash::using_genesis_block(Network::Testnet) {
886 } else if chain == ChainHash::using_genesis_block(Network::Signet) {
888 } else if chain == ChainHash::using_genesis_block(Network::Regtest) {
894 let to_valid_address = |address: &FallbackAddress| {
895 let version = match WitnessVersion::try_from(address.version) {
896 Ok(version) => version,
897 Err(_) => return None,
900 let program = &address.program;
901 if program.len() < 2 || program.len() > 40 {
905 let address = Address {
906 payload: Payload::WitnessProgram {
908 program: program.clone(),
913 if !address.is_standard() && version == WitnessVersion::V0 {
920 self.fields().fallbacks
922 .map(|fallbacks| fallbacks.iter().filter_map(to_valid_address).collect())
923 .unwrap_or_else(Vec::new)
926 fn features(&self) -> &Bolt12InvoiceFeatures {
927 &self.fields().features
930 fn signing_pubkey(&self) -> PublicKey {
931 self.fields().signing_pubkey
934 fn fields(&self) -> &InvoiceFields {
936 InvoiceContents::ForOffer { fields, .. } => fields,
937 InvoiceContents::ForRefund { fields, .. } => fields,
941 fn fields_mut(&mut self) -> &mut InvoiceFields {
943 InvoiceContents::ForOffer { fields, .. } => fields,
944 InvoiceContents::ForRefund { fields, .. } => fields,
948 fn verify<T: secp256k1::Signing>(
949 &self, tlv_stream: TlvStream<'_>, key: &ExpandedKey, secp_ctx: &Secp256k1<T>
951 let offer_records = tlv_stream.clone().range(OFFER_TYPES);
952 let invreq_records = tlv_stream.range(INVOICE_REQUEST_TYPES).filter(|record| {
953 match record.r#type {
954 PAYER_METADATA_TYPE => false, // Should be outside range
955 INVOICE_REQUEST_PAYER_ID_TYPE => !self.derives_keys(),
959 let tlv_stream = offer_records.chain(invreq_records);
961 let (metadata, payer_id, iv_bytes) = match self {
962 InvoiceContents::ForOffer { invoice_request, .. } => {
963 (invoice_request.metadata(), invoice_request.payer_id(), INVOICE_REQUEST_IV_BYTES)
965 InvoiceContents::ForRefund { refund, .. } => {
966 (refund.metadata(), refund.payer_id(), REFUND_IV_BYTES)
970 match signer::verify_metadata(metadata, key, iv_bytes, payer_id, tlv_stream, secp_ctx) {
976 fn derives_keys(&self) -> bool {
978 InvoiceContents::ForOffer { invoice_request, .. } => invoice_request.derives_keys(),
979 InvoiceContents::ForRefund { refund, .. } => refund.derives_keys(),
983 fn as_tlv_stream(&self) -> PartialInvoiceTlvStreamRef {
984 let (payer, offer, invoice_request) = match self {
985 InvoiceContents::ForOffer { invoice_request, .. } => invoice_request.as_tlv_stream(),
986 InvoiceContents::ForRefund { refund, .. } => refund.as_tlv_stream(),
988 let invoice = self.fields().as_tlv_stream();
990 (payer, offer, invoice_request, invoice)
995 fn as_tlv_stream(&self) -> InvoiceTlvStreamRef {
997 if self.features == Bolt12InvoiceFeatures::empty() { None }
998 else { Some(&self.features) }
1001 InvoiceTlvStreamRef {
1002 paths: Some(Iterable(self.payment_paths.iter().map(|(_, path)| path))),
1003 blindedpay: Some(Iterable(self.payment_paths.iter().map(|(payinfo, _)| payinfo))),
1004 created_at: Some(self.created_at.as_secs()),
1005 relative_expiry: self.relative_expiry.map(|duration| duration.as_secs() as u32),
1006 payment_hash: Some(&self.payment_hash),
1007 amount: Some(self.amount_msats),
1008 fallbacks: self.fallbacks.as_ref(),
1010 node_id: Some(&self.signing_pubkey),
1015 impl Writeable for UnsignedBolt12Invoice {
1016 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
1017 WithoutLength(&self.bytes).write(writer)
1021 impl Writeable for Bolt12Invoice {
1022 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
1023 WithoutLength(&self.bytes).write(writer)
1027 impl Writeable for InvoiceContents {
1028 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
1029 self.as_tlv_stream().write(writer)
1033 impl TryFrom<Vec<u8>> for UnsignedBolt12Invoice {
1034 type Error = Bolt12ParseError;
1036 fn try_from(bytes: Vec<u8>) -> Result<Self, Self::Error> {
1037 let invoice = ParsedMessage::<PartialInvoiceTlvStream>::try_from(bytes)?;
1038 let ParsedMessage { bytes, tlv_stream } = invoice;
1040 payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, invoice_tlv_stream,
1042 let contents = InvoiceContents::try_from(
1043 (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, invoice_tlv_stream)
1046 let tagged_hash = TaggedHash::new(SIGNATURE_TAG, &bytes);
1048 Ok(UnsignedBolt12Invoice { bytes, contents, tagged_hash })
1052 impl TryFrom<Vec<u8>> for Bolt12Invoice {
1053 type Error = Bolt12ParseError;
1055 fn try_from(bytes: Vec<u8>) -> Result<Self, Self::Error> {
1056 let parsed_invoice = ParsedMessage::<FullInvoiceTlvStream>::try_from(bytes)?;
1057 Bolt12Invoice::try_from(parsed_invoice)
1061 tlv_stream!(InvoiceTlvStream, InvoiceTlvStreamRef, 160..240, {
1062 (160, paths: (Vec<BlindedPath>, WithoutLength, Iterable<'a, BlindedPathIter<'a>, BlindedPath>)),
1063 (162, blindedpay: (Vec<BlindedPayInfo>, WithoutLength, Iterable<'a, BlindedPayInfoIter<'a>, BlindedPayInfo>)),
1064 (164, created_at: (u64, HighZeroBytesDroppedBigSize)),
1065 (166, relative_expiry: (u32, HighZeroBytesDroppedBigSize)),
1066 (168, payment_hash: PaymentHash),
1067 (170, amount: (u64, HighZeroBytesDroppedBigSize)),
1068 (172, fallbacks: (Vec<FallbackAddress>, WithoutLength)),
1069 (174, features: (Bolt12InvoiceFeatures, WithoutLength)),
1070 (176, node_id: PublicKey),
1073 type BlindedPathIter<'a> = core::iter::Map<
1074 core::slice::Iter<'a, (BlindedPayInfo, BlindedPath)>,
1075 for<'r> fn(&'r (BlindedPayInfo, BlindedPath)) -> &'r BlindedPath,
1078 type BlindedPayInfoIter<'a> = core::iter::Map<
1079 core::slice::Iter<'a, (BlindedPayInfo, BlindedPath)>,
1080 for<'r> fn(&'r (BlindedPayInfo, BlindedPath)) -> &'r BlindedPayInfo,
1083 /// Information needed to route a payment across a [`BlindedPath`].
1084 #[derive(Clone, Debug, Hash, Eq, PartialEq)]
1085 pub struct BlindedPayInfo {
1086 /// Base fee charged (in millisatoshi) for the entire blinded path.
1087 pub fee_base_msat: u32,
1089 /// Liquidity fee charged (in millionths of the amount transferred) for the entire blinded path
1090 /// (i.e., 10,000 is 1%).
1091 pub fee_proportional_millionths: u32,
1093 /// Number of blocks subtracted from an incoming HTLC's `cltv_expiry` for the entire blinded
1095 pub cltv_expiry_delta: u16,
1097 /// The minimum HTLC value (in millisatoshi) that is acceptable to all channel peers on the
1098 /// blinded path from the introduction node to the recipient, accounting for any fees, i.e., as
1099 /// seen by the recipient.
1100 pub htlc_minimum_msat: u64,
1102 /// The maximum HTLC value (in millisatoshi) that is acceptable to all channel peers on the
1103 /// blinded path from the introduction node to the recipient, accounting for any fees, i.e., as
1104 /// seen by the recipient.
1105 pub htlc_maximum_msat: u64,
1107 /// Features set in `encrypted_data_tlv` for the `encrypted_recipient_data` TLV record in an
1109 pub features: BlindedHopFeatures,
1112 impl_writeable!(BlindedPayInfo, {
1114 fee_proportional_millionths,
1121 /// Wire representation for an on-chain fallback address.
1122 #[derive(Clone, Debug, PartialEq)]
1123 pub(super) struct FallbackAddress {
1128 impl_writeable!(FallbackAddress, { version, program });
1130 type FullInvoiceTlvStream =
1131 (PayerTlvStream, OfferTlvStream, InvoiceRequestTlvStream, InvoiceTlvStream, SignatureTlvStream);
1134 type FullInvoiceTlvStreamRef<'a> = (
1135 PayerTlvStreamRef<'a>,
1136 OfferTlvStreamRef<'a>,
1137 InvoiceRequestTlvStreamRef<'a>,
1138 InvoiceTlvStreamRef<'a>,
1139 SignatureTlvStreamRef<'a>,
1142 impl SeekReadable for FullInvoiceTlvStream {
1143 fn read<R: io::Read + io::Seek>(r: &mut R) -> Result<Self, DecodeError> {
1144 let payer = SeekReadable::read(r)?;
1145 let offer = SeekReadable::read(r)?;
1146 let invoice_request = SeekReadable::read(r)?;
1147 let invoice = SeekReadable::read(r)?;
1148 let signature = SeekReadable::read(r)?;
1150 Ok((payer, offer, invoice_request, invoice, signature))
1154 type PartialInvoiceTlvStream =
1155 (PayerTlvStream, OfferTlvStream, InvoiceRequestTlvStream, InvoiceTlvStream);
1157 type PartialInvoiceTlvStreamRef<'a> = (
1158 PayerTlvStreamRef<'a>,
1159 OfferTlvStreamRef<'a>,
1160 InvoiceRequestTlvStreamRef<'a>,
1161 InvoiceTlvStreamRef<'a>,
1164 impl SeekReadable for PartialInvoiceTlvStream {
1165 fn read<R: io::Read + io::Seek>(r: &mut R) -> Result<Self, DecodeError> {
1166 let payer = SeekReadable::read(r)?;
1167 let offer = SeekReadable::read(r)?;
1168 let invoice_request = SeekReadable::read(r)?;
1169 let invoice = SeekReadable::read(r)?;
1171 Ok((payer, offer, invoice_request, invoice))
1175 impl TryFrom<ParsedMessage<FullInvoiceTlvStream>> for Bolt12Invoice {
1176 type Error = Bolt12ParseError;
1178 fn try_from(invoice: ParsedMessage<FullInvoiceTlvStream>) -> Result<Self, Self::Error> {
1179 let ParsedMessage { bytes, tlv_stream } = invoice;
1181 payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, invoice_tlv_stream,
1182 SignatureTlvStream { signature },
1184 let contents = InvoiceContents::try_from(
1185 (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, invoice_tlv_stream)
1188 let signature = match signature {
1189 None => return Err(Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingSignature)),
1190 Some(signature) => signature,
1192 let message = TaggedHash::new(SIGNATURE_TAG, &bytes);
1193 let pubkey = contents.fields().signing_pubkey;
1194 merkle::verify_signature(&signature, message, pubkey)?;
1196 Ok(Bolt12Invoice { bytes, contents, signature })
1200 impl TryFrom<PartialInvoiceTlvStream> for InvoiceContents {
1201 type Error = Bolt12SemanticError;
1203 fn try_from(tlv_stream: PartialInvoiceTlvStream) -> Result<Self, Self::Error> {
1207 invoice_request_tlv_stream,
1209 paths, blindedpay, created_at, relative_expiry, payment_hash, amount, fallbacks,
1214 let payment_paths = match (blindedpay, paths) {
1215 (_, None) => return Err(Bolt12SemanticError::MissingPaths),
1216 (None, _) => return Err(Bolt12SemanticError::InvalidPayInfo),
1217 (_, Some(paths)) if paths.is_empty() => return Err(Bolt12SemanticError::MissingPaths),
1218 (Some(blindedpay), Some(paths)) if paths.len() != blindedpay.len() => {
1219 return Err(Bolt12SemanticError::InvalidPayInfo);
1221 (Some(blindedpay), Some(paths)) => {
1222 blindedpay.into_iter().zip(paths.into_iter()).collect::<Vec<_>>()
1226 let created_at = match created_at {
1227 None => return Err(Bolt12SemanticError::MissingCreationTime),
1228 Some(timestamp) => Duration::from_secs(timestamp),
1231 let relative_expiry = relative_expiry
1232 .map(Into::<u64>::into)
1233 .map(Duration::from_secs);
1235 let payment_hash = match payment_hash {
1236 None => return Err(Bolt12SemanticError::MissingPaymentHash),
1237 Some(payment_hash) => payment_hash,
1240 let amount_msats = match amount {
1241 None => return Err(Bolt12SemanticError::MissingAmount),
1242 Some(amount) => amount,
1245 let features = features.unwrap_or_else(Bolt12InvoiceFeatures::empty);
1247 let signing_pubkey = match node_id {
1248 None => return Err(Bolt12SemanticError::MissingSigningPubkey),
1249 Some(node_id) => node_id,
1252 let fields = InvoiceFields {
1253 payment_paths, created_at, relative_expiry, payment_hash, amount_msats, fallbacks,
1254 features, signing_pubkey,
1257 match offer_tlv_stream.node_id {
1258 Some(expected_signing_pubkey) => {
1259 if fields.signing_pubkey != expected_signing_pubkey {
1260 return Err(Bolt12SemanticError::InvalidSigningPubkey);
1263 let invoice_request = InvoiceRequestContents::try_from(
1264 (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream)
1266 Ok(InvoiceContents::ForOffer { invoice_request, fields })
1269 let refund = RefundContents::try_from(
1270 (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream)
1272 Ok(InvoiceContents::ForRefund { refund, fields })
1280 use super::{Bolt12Invoice, DEFAULT_RELATIVE_EXPIRY, FallbackAddress, FullInvoiceTlvStreamRef, InvoiceTlvStreamRef, SIGNATURE_TAG, UnsignedBolt12Invoice};
1282 use bitcoin::blockdata::constants::ChainHash;
1283 use bitcoin::blockdata::script::Script;
1284 use bitcoin::hashes::Hash;
1285 use bitcoin::network::constants::Network;
1286 use bitcoin::secp256k1::{Message, Secp256k1, XOnlyPublicKey, self};
1287 use bitcoin::util::address::{Address, Payload, WitnessVersion};
1288 use bitcoin::util::schnorr::TweakedPublicKey;
1289 use core::convert::TryFrom;
1290 use core::time::Duration;
1291 use crate::blinded_path::{BlindedHop, BlindedPath};
1292 use crate::sign::KeyMaterial;
1293 use crate::ln::features::{Bolt12InvoiceFeatures, InvoiceRequestFeatures, OfferFeatures};
1294 use crate::ln::inbound_payment::ExpandedKey;
1295 use crate::ln::msgs::DecodeError;
1296 use crate::offers::invoice_request::InvoiceRequestTlvStreamRef;
1297 use crate::offers::merkle::{SignError, SignatureTlvStreamRef, TaggedHash, self};
1298 use crate::offers::offer::{Amount, OfferBuilder, OfferTlvStreamRef, Quantity};
1299 use crate::offers::parse::{Bolt12ParseError, Bolt12SemanticError};
1300 use crate::offers::payer::PayerTlvStreamRef;
1301 use crate::offers::refund::RefundBuilder;
1302 use crate::offers::test_utils::*;
1303 use crate::util::ser::{BigSize, Iterable, Writeable};
1304 use crate::util::string::PrintableString;
1307 fn to_bytes(&self) -> Vec<u8>;
1310 impl<'a> ToBytes for FullInvoiceTlvStreamRef<'a> {
1311 fn to_bytes(&self) -> Vec<u8> {
1312 let mut buffer = Vec::new();
1313 self.0.write(&mut buffer).unwrap();
1314 self.1.write(&mut buffer).unwrap();
1315 self.2.write(&mut buffer).unwrap();
1316 self.3.write(&mut buffer).unwrap();
1317 self.4.write(&mut buffer).unwrap();
1323 fn builds_invoice_for_offer_with_defaults() {
1324 let payment_paths = payment_paths();
1325 let payment_hash = payment_hash();
1327 let unsigned_invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
1330 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1332 .sign(payer_sign).unwrap()
1333 .respond_with_no_std(payment_paths.clone(), payment_hash, now).unwrap()
1336 let mut buffer = Vec::new();
1337 unsigned_invoice.write(&mut buffer).unwrap();
1339 assert_eq!(unsigned_invoice.bytes, buffer.as_slice());
1340 assert_eq!(unsigned_invoice.payer_metadata(), &[1; 32]);
1341 assert_eq!(unsigned_invoice.offer_chains(), Some(vec![ChainHash::using_genesis_block(Network::Bitcoin)]));
1342 assert_eq!(unsigned_invoice.metadata(), None);
1343 assert_eq!(unsigned_invoice.amount(), Some(&Amount::Bitcoin { amount_msats: 1000 }));
1344 assert_eq!(unsigned_invoice.description(), PrintableString("foo"));
1345 assert_eq!(unsigned_invoice.offer_features(), Some(&OfferFeatures::empty()));
1346 assert_eq!(unsigned_invoice.absolute_expiry(), None);
1347 assert_eq!(unsigned_invoice.message_paths(), &[]);
1348 assert_eq!(unsigned_invoice.issuer(), None);
1349 assert_eq!(unsigned_invoice.supported_quantity(), Some(Quantity::One));
1350 assert_eq!(unsigned_invoice.signing_pubkey(), recipient_pubkey());
1351 assert_eq!(unsigned_invoice.chain(), ChainHash::using_genesis_block(Network::Bitcoin));
1352 assert_eq!(unsigned_invoice.amount_msats(), 1000);
1353 assert_eq!(unsigned_invoice.invoice_request_features(), &InvoiceRequestFeatures::empty());
1354 assert_eq!(unsigned_invoice.quantity(), None);
1355 assert_eq!(unsigned_invoice.payer_id(), payer_pubkey());
1356 assert_eq!(unsigned_invoice.payer_note(), None);
1357 assert_eq!(unsigned_invoice.payment_paths(), payment_paths.as_slice());
1358 assert_eq!(unsigned_invoice.created_at(), now);
1359 assert_eq!(unsigned_invoice.relative_expiry(), DEFAULT_RELATIVE_EXPIRY);
1360 #[cfg(feature = "std")]
1361 assert!(!unsigned_invoice.is_expired());
1362 assert_eq!(unsigned_invoice.payment_hash(), payment_hash);
1363 assert_eq!(unsigned_invoice.amount_msats(), 1000);
1364 assert_eq!(unsigned_invoice.fallbacks(), vec![]);
1365 assert_eq!(unsigned_invoice.invoice_features(), &Bolt12InvoiceFeatures::empty());
1366 assert_eq!(unsigned_invoice.signing_pubkey(), recipient_pubkey());
1368 match UnsignedBolt12Invoice::try_from(buffer) {
1369 Err(e) => panic!("error parsing unsigned invoice: {:?}", e),
1371 assert_eq!(parsed.bytes, unsigned_invoice.bytes);
1372 assert_eq!(parsed.tagged_hash, unsigned_invoice.tagged_hash);
1376 let invoice = unsigned_invoice.sign(recipient_sign).unwrap();
1378 let mut buffer = Vec::new();
1379 invoice.write(&mut buffer).unwrap();
1381 assert_eq!(invoice.bytes, buffer.as_slice());
1382 assert_eq!(invoice.payer_metadata(), &[1; 32]);
1383 assert_eq!(invoice.offer_chains(), Some(vec![ChainHash::using_genesis_block(Network::Bitcoin)]));
1384 assert_eq!(invoice.metadata(), None);
1385 assert_eq!(invoice.amount(), Some(&Amount::Bitcoin { amount_msats: 1000 }));
1386 assert_eq!(invoice.description(), PrintableString("foo"));
1387 assert_eq!(invoice.offer_features(), Some(&OfferFeatures::empty()));
1388 assert_eq!(invoice.absolute_expiry(), None);
1389 assert_eq!(invoice.message_paths(), &[]);
1390 assert_eq!(invoice.issuer(), None);
1391 assert_eq!(invoice.supported_quantity(), Some(Quantity::One));
1392 assert_eq!(invoice.signing_pubkey(), recipient_pubkey());
1393 assert_eq!(invoice.chain(), ChainHash::using_genesis_block(Network::Bitcoin));
1394 assert_eq!(invoice.amount_msats(), 1000);
1395 assert_eq!(invoice.invoice_request_features(), &InvoiceRequestFeatures::empty());
1396 assert_eq!(invoice.quantity(), None);
1397 assert_eq!(invoice.payer_id(), payer_pubkey());
1398 assert_eq!(invoice.payer_note(), None);
1399 assert_eq!(invoice.payment_paths(), payment_paths.as_slice());
1400 assert_eq!(invoice.created_at(), now);
1401 assert_eq!(invoice.relative_expiry(), DEFAULT_RELATIVE_EXPIRY);
1402 #[cfg(feature = "std")]
1403 assert!(!invoice.is_expired());
1404 assert_eq!(invoice.payment_hash(), payment_hash);
1405 assert_eq!(invoice.amount_msats(), 1000);
1406 assert_eq!(invoice.fallbacks(), vec![]);
1407 assert_eq!(invoice.invoice_features(), &Bolt12InvoiceFeatures::empty());
1408 assert_eq!(invoice.signing_pubkey(), recipient_pubkey());
1410 let message = TaggedHash::new(SIGNATURE_TAG, &invoice.bytes);
1411 assert!(merkle::verify_signature(&invoice.signature, message, recipient_pubkey()).is_ok());
1413 let digest = Message::from_slice(&invoice.signable_hash()).unwrap();
1414 let pubkey = recipient_pubkey().into();
1415 let secp_ctx = Secp256k1::verification_only();
1416 assert!(secp_ctx.verify_schnorr(&invoice.signature, &digest, &pubkey).is_ok());
1419 invoice.as_tlv_stream(),
1421 PayerTlvStreamRef { metadata: Some(&vec![1; 32]) },
1427 description: Some(&String::from("foo")),
1429 absolute_expiry: None,
1433 node_id: Some(&recipient_pubkey()),
1435 InvoiceRequestTlvStreamRef {
1440 payer_id: Some(&payer_pubkey()),
1443 InvoiceTlvStreamRef {
1444 paths: Some(Iterable(payment_paths.iter().map(|(_, path)| path))),
1445 blindedpay: Some(Iterable(payment_paths.iter().map(|(payinfo, _)| payinfo))),
1446 created_at: Some(now.as_secs()),
1447 relative_expiry: None,
1448 payment_hash: Some(&payment_hash),
1452 node_id: Some(&recipient_pubkey()),
1454 SignatureTlvStreamRef { signature: Some(&invoice.signature()) },
1458 if let Err(e) = Bolt12Invoice::try_from(buffer) {
1459 panic!("error parsing invoice: {:?}", e);
1464 fn builds_invoice_for_refund_with_defaults() {
1465 let payment_paths = payment_paths();
1466 let payment_hash = payment_hash();
1468 let invoice = RefundBuilder::new("foo".into(), vec![1; 32], payer_pubkey(), 1000).unwrap()
1470 .respond_with_no_std(payment_paths.clone(), payment_hash, recipient_pubkey(), now)
1473 .sign(recipient_sign).unwrap();
1475 let mut buffer = Vec::new();
1476 invoice.write(&mut buffer).unwrap();
1478 assert_eq!(invoice.bytes, buffer.as_slice());
1479 assert_eq!(invoice.payer_metadata(), &[1; 32]);
1480 assert_eq!(invoice.offer_chains(), None);
1481 assert_eq!(invoice.metadata(), None);
1482 assert_eq!(invoice.amount(), None);
1483 assert_eq!(invoice.description(), PrintableString("foo"));
1484 assert_eq!(invoice.offer_features(), None);
1485 assert_eq!(invoice.absolute_expiry(), None);
1486 assert_eq!(invoice.message_paths(), &[]);
1487 assert_eq!(invoice.issuer(), None);
1488 assert_eq!(invoice.supported_quantity(), None);
1489 assert_eq!(invoice.signing_pubkey(), recipient_pubkey());
1490 assert_eq!(invoice.chain(), ChainHash::using_genesis_block(Network::Bitcoin));
1491 assert_eq!(invoice.amount_msats(), 1000);
1492 assert_eq!(invoice.invoice_request_features(), &InvoiceRequestFeatures::empty());
1493 assert_eq!(invoice.quantity(), None);
1494 assert_eq!(invoice.payer_id(), payer_pubkey());
1495 assert_eq!(invoice.payer_note(), None);
1496 assert_eq!(invoice.payment_paths(), payment_paths.as_slice());
1497 assert_eq!(invoice.created_at(), now);
1498 assert_eq!(invoice.relative_expiry(), DEFAULT_RELATIVE_EXPIRY);
1499 #[cfg(feature = "std")]
1500 assert!(!invoice.is_expired());
1501 assert_eq!(invoice.payment_hash(), payment_hash);
1502 assert_eq!(invoice.amount_msats(), 1000);
1503 assert_eq!(invoice.fallbacks(), vec![]);
1504 assert_eq!(invoice.invoice_features(), &Bolt12InvoiceFeatures::empty());
1505 assert_eq!(invoice.signing_pubkey(), recipient_pubkey());
1507 let message = TaggedHash::new(SIGNATURE_TAG, &invoice.bytes);
1508 assert!(merkle::verify_signature(&invoice.signature, message, recipient_pubkey()).is_ok());
1511 invoice.as_tlv_stream(),
1513 PayerTlvStreamRef { metadata: Some(&vec![1; 32]) },
1519 description: Some(&String::from("foo")),
1521 absolute_expiry: None,
1527 InvoiceRequestTlvStreamRef {
1532 payer_id: Some(&payer_pubkey()),
1535 InvoiceTlvStreamRef {
1536 paths: Some(Iterable(payment_paths.iter().map(|(_, path)| path))),
1537 blindedpay: Some(Iterable(payment_paths.iter().map(|(payinfo, _)| payinfo))),
1538 created_at: Some(now.as_secs()),
1539 relative_expiry: None,
1540 payment_hash: Some(&payment_hash),
1544 node_id: Some(&recipient_pubkey()),
1546 SignatureTlvStreamRef { signature: Some(&invoice.signature()) },
1550 if let Err(e) = Bolt12Invoice::try_from(buffer) {
1551 panic!("error parsing invoice: {:?}", e);
1555 #[cfg(feature = "std")]
1557 fn builds_invoice_from_offer_with_expiration() {
1558 let future_expiry = Duration::from_secs(u64::max_value());
1559 let past_expiry = Duration::from_secs(0);
1561 if let Err(e) = OfferBuilder::new("foo".into(), recipient_pubkey())
1563 .absolute_expiry(future_expiry)
1565 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1567 .sign(payer_sign).unwrap()
1568 .respond_with(payment_paths(), payment_hash())
1572 panic!("error building invoice: {:?}", e);
1575 match OfferBuilder::new("foo".into(), recipient_pubkey())
1577 .absolute_expiry(past_expiry)
1579 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1581 .sign(payer_sign).unwrap()
1582 .respond_with(payment_paths(), payment_hash())
1586 Ok(_) => panic!("expected error"),
1587 Err(e) => assert_eq!(e, Bolt12SemanticError::AlreadyExpired),
1591 #[cfg(feature = "std")]
1593 fn builds_invoice_from_refund_with_expiration() {
1594 let future_expiry = Duration::from_secs(u64::max_value());
1595 let past_expiry = Duration::from_secs(0);
1597 if let Err(e) = RefundBuilder::new("foo".into(), vec![1; 32], payer_pubkey(), 1000).unwrap()
1598 .absolute_expiry(future_expiry)
1600 .respond_with(payment_paths(), payment_hash(), recipient_pubkey())
1604 panic!("error building invoice: {:?}", e);
1607 match RefundBuilder::new("foo".into(), vec![1; 32], payer_pubkey(), 1000).unwrap()
1608 .absolute_expiry(past_expiry)
1610 .respond_with(payment_paths(), payment_hash(), recipient_pubkey())
1614 Ok(_) => panic!("expected error"),
1615 Err(e) => assert_eq!(e, Bolt12SemanticError::AlreadyExpired),
1620 fn builds_invoice_from_offer_using_derived_keys() {
1621 let desc = "foo".to_string();
1622 let node_id = recipient_pubkey();
1623 let expanded_key = ExpandedKey::new(&KeyMaterial([42; 32]));
1624 let entropy = FixedEntropy {};
1625 let secp_ctx = Secp256k1::new();
1627 let blinded_path = BlindedPath {
1628 introduction_node_id: pubkey(40),
1629 blinding_point: pubkey(41),
1631 BlindedHop { blinded_node_id: pubkey(42), encrypted_payload: vec![0; 43] },
1632 BlindedHop { blinded_node_id: node_id, encrypted_payload: vec![0; 44] },
1636 let offer = OfferBuilder
1637 ::deriving_signing_pubkey(desc, node_id, &expanded_key, &entropy, &secp_ctx)
1641 let invoice_request = offer.request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1643 .sign(payer_sign).unwrap();
1645 if let Err(e) = invoice_request
1646 .verify_and_respond_using_derived_keys_no_std(
1647 payment_paths(), payment_hash(), now(), &expanded_key, &secp_ctx
1650 .build_and_sign(&secp_ctx)
1652 panic!("error building invoice: {:?}", e);
1655 let expanded_key = ExpandedKey::new(&KeyMaterial([41; 32]));
1656 match invoice_request.verify_and_respond_using_derived_keys_no_std(
1657 payment_paths(), payment_hash(), now(), &expanded_key, &secp_ctx
1659 Ok(_) => panic!("expected error"),
1660 Err(e) => assert_eq!(e, Bolt12SemanticError::InvalidMetadata),
1663 let desc = "foo".to_string();
1664 let offer = OfferBuilder
1665 ::deriving_signing_pubkey(desc, node_id, &expanded_key, &entropy, &secp_ctx)
1668 let invoice_request = offer.request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1670 .sign(payer_sign).unwrap();
1672 match invoice_request.verify_and_respond_using_derived_keys_no_std(
1673 payment_paths(), payment_hash(), now(), &expanded_key, &secp_ctx
1675 Ok(_) => panic!("expected error"),
1676 Err(e) => assert_eq!(e, Bolt12SemanticError::InvalidMetadata),
1681 fn builds_invoice_from_refund_using_derived_keys() {
1682 let expanded_key = ExpandedKey::new(&KeyMaterial([42; 32]));
1683 let entropy = FixedEntropy {};
1684 let secp_ctx = Secp256k1::new();
1686 let refund = RefundBuilder::new("foo".into(), vec![1; 32], payer_pubkey(), 1000).unwrap()
1689 if let Err(e) = refund
1690 .respond_using_derived_keys_no_std(
1691 payment_paths(), payment_hash(), now(), &expanded_key, &entropy
1694 .build_and_sign(&secp_ctx)
1696 panic!("error building invoice: {:?}", e);
1701 fn builds_invoice_with_relative_expiry() {
1703 let one_hour = Duration::from_secs(3600);
1705 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
1708 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1710 .sign(payer_sign).unwrap()
1711 .respond_with_no_std(payment_paths(), payment_hash(), now).unwrap()
1712 .relative_expiry(one_hour.as_secs() as u32)
1714 .sign(recipient_sign).unwrap();
1715 let (_, _, _, tlv_stream, _) = invoice.as_tlv_stream();
1716 #[cfg(feature = "std")]
1717 assert!(!invoice.is_expired());
1718 assert_eq!(invoice.relative_expiry(), one_hour);
1719 assert_eq!(tlv_stream.relative_expiry, Some(one_hour.as_secs() as u32));
1721 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
1724 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1726 .sign(payer_sign).unwrap()
1727 .respond_with_no_std(payment_paths(), payment_hash(), now - one_hour).unwrap()
1728 .relative_expiry(one_hour.as_secs() as u32 - 1)
1730 .sign(recipient_sign).unwrap();
1731 let (_, _, _, tlv_stream, _) = invoice.as_tlv_stream();
1732 #[cfg(feature = "std")]
1733 assert!(invoice.is_expired());
1734 assert_eq!(invoice.relative_expiry(), one_hour - Duration::from_secs(1));
1735 assert_eq!(tlv_stream.relative_expiry, Some(one_hour.as_secs() as u32 - 1));
1739 fn builds_invoice_with_amount_from_request() {
1740 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
1743 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1744 .amount_msats(1001).unwrap()
1746 .sign(payer_sign).unwrap()
1747 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
1749 .sign(recipient_sign).unwrap();
1750 let (_, _, _, tlv_stream, _) = invoice.as_tlv_stream();
1751 assert_eq!(invoice.amount_msats(), 1001);
1752 assert_eq!(tlv_stream.amount, Some(1001));
1756 fn builds_invoice_with_quantity_from_request() {
1757 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
1759 .supported_quantity(Quantity::Unbounded)
1761 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1762 .quantity(2).unwrap()
1764 .sign(payer_sign).unwrap()
1765 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
1767 .sign(recipient_sign).unwrap();
1768 let (_, _, _, tlv_stream, _) = invoice.as_tlv_stream();
1769 assert_eq!(invoice.amount_msats(), 2000);
1770 assert_eq!(tlv_stream.amount, Some(2000));
1772 match OfferBuilder::new("foo".into(), recipient_pubkey())
1774 .supported_quantity(Quantity::Unbounded)
1776 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1777 .quantity(u64::max_value()).unwrap()
1779 .sign(payer_sign).unwrap()
1780 .respond_with_no_std(payment_paths(), payment_hash(), now())
1782 Ok(_) => panic!("expected error"),
1783 Err(e) => assert_eq!(e, Bolt12SemanticError::InvalidAmount),
1788 fn builds_invoice_with_fallback_address() {
1789 let script = Script::new();
1790 let pubkey = bitcoin::util::key::PublicKey::new(recipient_pubkey());
1791 let x_only_pubkey = XOnlyPublicKey::from_keypair(&recipient_keys()).0;
1792 let tweaked_pubkey = TweakedPublicKey::dangerous_assume_tweaked(x_only_pubkey);
1794 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
1797 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1799 .sign(payer_sign).unwrap()
1800 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
1801 .fallback_v0_p2wsh(&script.wscript_hash())
1802 .fallback_v0_p2wpkh(&pubkey.wpubkey_hash().unwrap())
1803 .fallback_v1_p2tr_tweaked(&tweaked_pubkey)
1805 .sign(recipient_sign).unwrap();
1806 let (_, _, _, tlv_stream, _) = invoice.as_tlv_stream();
1808 invoice.fallbacks(),
1810 Address::p2wsh(&script, Network::Bitcoin),
1811 Address::p2wpkh(&pubkey, Network::Bitcoin).unwrap(),
1812 Address::p2tr_tweaked(tweaked_pubkey, Network::Bitcoin),
1816 tlv_stream.fallbacks,
1819 version: WitnessVersion::V0.to_num(),
1820 program: Vec::from(&script.wscript_hash().into_inner()[..]),
1823 version: WitnessVersion::V0.to_num(),
1824 program: Vec::from(&pubkey.wpubkey_hash().unwrap().into_inner()[..]),
1827 version: WitnessVersion::V1.to_num(),
1828 program: Vec::from(&tweaked_pubkey.serialize()[..]),
1835 fn builds_invoice_with_allow_mpp() {
1836 let mut features = Bolt12InvoiceFeatures::empty();
1837 features.set_basic_mpp_optional();
1839 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
1842 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1844 .sign(payer_sign).unwrap()
1845 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
1848 .sign(recipient_sign).unwrap();
1849 let (_, _, _, tlv_stream, _) = invoice.as_tlv_stream();
1850 assert_eq!(invoice.invoice_features(), &features);
1851 assert_eq!(tlv_stream.features, Some(&features));
1855 fn fails_signing_invoice() {
1856 match OfferBuilder::new("foo".into(), recipient_pubkey())
1859 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1861 .sign(payer_sign).unwrap()
1862 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
1866 Ok(_) => panic!("expected error"),
1867 Err(e) => assert_eq!(e, SignError::Signing(())),
1870 match OfferBuilder::new("foo".into(), recipient_pubkey())
1873 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1875 .sign(payer_sign).unwrap()
1876 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
1880 Ok(_) => panic!("expected error"),
1881 Err(e) => assert_eq!(e, SignError::Verification(secp256k1::Error::InvalidSignature)),
1886 fn parses_invoice_with_payment_paths() {
1887 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
1890 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1892 .sign(payer_sign).unwrap()
1893 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
1895 .sign(recipient_sign).unwrap();
1897 let mut buffer = Vec::new();
1898 invoice.write(&mut buffer).unwrap();
1900 if let Err(e) = Bolt12Invoice::try_from(buffer) {
1901 panic!("error parsing invoice: {:?}", e);
1904 let mut tlv_stream = invoice.as_tlv_stream();
1905 tlv_stream.3.paths = None;
1907 match Bolt12Invoice::try_from(tlv_stream.to_bytes()) {
1908 Ok(_) => panic!("expected error"),
1909 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingPaths)),
1912 let mut tlv_stream = invoice.as_tlv_stream();
1913 tlv_stream.3.blindedpay = None;
1915 match Bolt12Invoice::try_from(tlv_stream.to_bytes()) {
1916 Ok(_) => panic!("expected error"),
1917 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::InvalidPayInfo)),
1920 let empty_payment_paths = vec![];
1921 let mut tlv_stream = invoice.as_tlv_stream();
1922 tlv_stream.3.paths = Some(Iterable(empty_payment_paths.iter().map(|(_, path)| path)));
1924 match Bolt12Invoice::try_from(tlv_stream.to_bytes()) {
1925 Ok(_) => panic!("expected error"),
1926 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingPaths)),
1929 let mut payment_paths = payment_paths();
1930 payment_paths.pop();
1931 let mut tlv_stream = invoice.as_tlv_stream();
1932 tlv_stream.3.blindedpay = Some(Iterable(payment_paths.iter().map(|(payinfo, _)| payinfo)));
1934 match Bolt12Invoice::try_from(tlv_stream.to_bytes()) {
1935 Ok(_) => panic!("expected error"),
1936 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::InvalidPayInfo)),
1941 fn parses_invoice_with_created_at() {
1942 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
1945 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1947 .sign(payer_sign).unwrap()
1948 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
1950 .sign(recipient_sign).unwrap();
1952 let mut buffer = Vec::new();
1953 invoice.write(&mut buffer).unwrap();
1955 if let Err(e) = Bolt12Invoice::try_from(buffer) {
1956 panic!("error parsing invoice: {:?}", e);
1959 let mut tlv_stream = invoice.as_tlv_stream();
1960 tlv_stream.3.created_at = None;
1962 match Bolt12Invoice::try_from(tlv_stream.to_bytes()) {
1963 Ok(_) => panic!("expected error"),
1965 assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingCreationTime));
1971 fn parses_invoice_with_relative_expiry() {
1972 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
1975 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1977 .sign(payer_sign).unwrap()
1978 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
1979 .relative_expiry(3600)
1981 .sign(recipient_sign).unwrap();
1983 let mut buffer = Vec::new();
1984 invoice.write(&mut buffer).unwrap();
1986 match Bolt12Invoice::try_from(buffer) {
1987 Ok(invoice) => assert_eq!(invoice.relative_expiry(), Duration::from_secs(3600)),
1988 Err(e) => panic!("error parsing invoice: {:?}", e),
1993 fn parses_invoice_with_payment_hash() {
1994 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
1997 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1999 .sign(payer_sign).unwrap()
2000 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2002 .sign(recipient_sign).unwrap();
2004 let mut buffer = Vec::new();
2005 invoice.write(&mut buffer).unwrap();
2007 if let Err(e) = Bolt12Invoice::try_from(buffer) {
2008 panic!("error parsing invoice: {:?}", e);
2011 let mut tlv_stream = invoice.as_tlv_stream();
2012 tlv_stream.3.payment_hash = None;
2014 match Bolt12Invoice::try_from(tlv_stream.to_bytes()) {
2015 Ok(_) => panic!("expected error"),
2017 assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingPaymentHash));
2023 fn parses_invoice_with_amount() {
2024 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
2027 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2029 .sign(payer_sign).unwrap()
2030 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2032 .sign(recipient_sign).unwrap();
2034 let mut buffer = Vec::new();
2035 invoice.write(&mut buffer).unwrap();
2037 if let Err(e) = Bolt12Invoice::try_from(buffer) {
2038 panic!("error parsing invoice: {:?}", e);
2041 let mut tlv_stream = invoice.as_tlv_stream();
2042 tlv_stream.3.amount = None;
2044 match Bolt12Invoice::try_from(tlv_stream.to_bytes()) {
2045 Ok(_) => panic!("expected error"),
2046 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingAmount)),
2051 fn parses_invoice_with_allow_mpp() {
2052 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
2055 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2057 .sign(payer_sign).unwrap()
2058 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2061 .sign(recipient_sign).unwrap();
2063 let mut buffer = Vec::new();
2064 invoice.write(&mut buffer).unwrap();
2066 match Bolt12Invoice::try_from(buffer) {
2068 let mut features = Bolt12InvoiceFeatures::empty();
2069 features.set_basic_mpp_optional();
2070 assert_eq!(invoice.invoice_features(), &features);
2072 Err(e) => panic!("error parsing invoice: {:?}", e),
2077 fn parses_invoice_with_fallback_address() {
2078 let script = Script::new();
2079 let pubkey = bitcoin::util::key::PublicKey::new(recipient_pubkey());
2080 let x_only_pubkey = XOnlyPublicKey::from_keypair(&recipient_keys()).0;
2081 let tweaked_pubkey = TweakedPublicKey::dangerous_assume_tweaked(x_only_pubkey);
2083 let offer = OfferBuilder::new("foo".into(), recipient_pubkey())
2086 let invoice_request = offer
2087 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2089 .sign(payer_sign).unwrap();
2090 let mut invoice_builder = invoice_request
2091 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2092 .fallback_v0_p2wsh(&script.wscript_hash())
2093 .fallback_v0_p2wpkh(&pubkey.wpubkey_hash().unwrap())
2094 .fallback_v1_p2tr_tweaked(&tweaked_pubkey);
2096 // Only standard addresses will be included.
2097 let fallbacks = invoice_builder.invoice.fields_mut().fallbacks.as_mut().unwrap();
2098 // Non-standard addresses
2099 fallbacks.push(FallbackAddress { version: 1, program: vec![0u8; 41] });
2100 fallbacks.push(FallbackAddress { version: 2, program: vec![0u8; 1] });
2101 fallbacks.push(FallbackAddress { version: 17, program: vec![0u8; 40] });
2103 fallbacks.push(FallbackAddress { version: 1, program: vec![0u8; 33] });
2104 fallbacks.push(FallbackAddress { version: 2, program: vec![0u8; 40] });
2106 let invoice = invoice_builder.build().unwrap().sign(recipient_sign).unwrap();
2107 let mut buffer = Vec::new();
2108 invoice.write(&mut buffer).unwrap();
2110 match Bolt12Invoice::try_from(buffer) {
2113 invoice.fallbacks(),
2115 Address::p2wsh(&script, Network::Bitcoin),
2116 Address::p2wpkh(&pubkey, Network::Bitcoin).unwrap(),
2117 Address::p2tr_tweaked(tweaked_pubkey, Network::Bitcoin),
2119 payload: Payload::WitnessProgram {
2120 version: WitnessVersion::V1,
2121 program: vec![0u8; 33],
2123 network: Network::Bitcoin,
2126 payload: Payload::WitnessProgram {
2127 version: WitnessVersion::V2,
2128 program: vec![0u8; 40],
2130 network: Network::Bitcoin,
2135 Err(e) => panic!("error parsing invoice: {:?}", e),
2140 fn parses_invoice_with_node_id() {
2141 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
2144 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2146 .sign(payer_sign).unwrap()
2147 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2149 .sign(recipient_sign).unwrap();
2151 let mut buffer = Vec::new();
2152 invoice.write(&mut buffer).unwrap();
2154 if let Err(e) = Bolt12Invoice::try_from(buffer) {
2155 panic!("error parsing invoice: {:?}", e);
2158 let mut tlv_stream = invoice.as_tlv_stream();
2159 tlv_stream.3.node_id = None;
2161 match Bolt12Invoice::try_from(tlv_stream.to_bytes()) {
2162 Ok(_) => panic!("expected error"),
2164 assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingSigningPubkey));
2168 let invalid_pubkey = payer_pubkey();
2169 let mut tlv_stream = invoice.as_tlv_stream();
2170 tlv_stream.3.node_id = Some(&invalid_pubkey);
2172 match Bolt12Invoice::try_from(tlv_stream.to_bytes()) {
2173 Ok(_) => panic!("expected error"),
2175 assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::InvalidSigningPubkey));
2181 fn fails_parsing_invoice_without_signature() {
2182 let mut buffer = Vec::new();
2183 OfferBuilder::new("foo".into(), recipient_pubkey())
2186 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2188 .sign(payer_sign).unwrap()
2189 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2192 .write(&mut buffer).unwrap();
2194 match Bolt12Invoice::try_from(buffer) {
2195 Ok(_) => panic!("expected error"),
2196 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingSignature)),
2201 fn fails_parsing_invoice_with_invalid_signature() {
2202 let mut invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
2205 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2207 .sign(payer_sign).unwrap()
2208 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2210 .sign(recipient_sign).unwrap();
2211 let last_signature_byte = invoice.bytes.last_mut().unwrap();
2212 *last_signature_byte = last_signature_byte.wrapping_add(1);
2214 let mut buffer = Vec::new();
2215 invoice.write(&mut buffer).unwrap();
2217 match Bolt12Invoice::try_from(buffer) {
2218 Ok(_) => panic!("expected error"),
2220 assert_eq!(e, Bolt12ParseError::InvalidSignature(secp256k1::Error::InvalidSignature));
2226 fn fails_parsing_invoice_with_extra_tlv_records() {
2227 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
2230 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2232 .sign(payer_sign).unwrap()
2233 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2235 .sign(recipient_sign).unwrap();
2237 let mut encoded_invoice = Vec::new();
2238 invoice.write(&mut encoded_invoice).unwrap();
2239 BigSize(1002).write(&mut encoded_invoice).unwrap();
2240 BigSize(32).write(&mut encoded_invoice).unwrap();
2241 [42u8; 32].write(&mut encoded_invoice).unwrap();
2243 match Bolt12Invoice::try_from(encoded_invoice) {
2244 Ok(_) => panic!("expected error"),
2245 Err(e) => assert_eq!(e, Bolt12ParseError::Decode(DecodeError::InvalidValue)),