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::channelmanager::PaymentId;
114 use crate::ln::features::{BlindedHopFeatures, Bolt12InvoiceFeatures, InvoiceRequestFeatures, OfferFeatures};
115 use crate::ln::inbound_payment::ExpandedKey;
116 use crate::ln::msgs::DecodeError;
117 use crate::offers::invoice_request::{INVOICE_REQUEST_PAYER_ID_TYPE, INVOICE_REQUEST_TYPES, IV_BYTES as INVOICE_REQUEST_IV_BYTES, InvoiceRequest, InvoiceRequestContents, InvoiceRequestTlvStream, InvoiceRequestTlvStreamRef};
118 use crate::offers::merkle::{SignError, SignatureTlvStream, SignatureTlvStreamRef, TaggedHash, TlvStream, WithoutSignatures, self};
119 use crate::offers::offer::{Amount, OFFER_TYPES, OfferTlvStream, OfferTlvStreamRef, Quantity};
120 use crate::offers::parse::{Bolt12ParseError, Bolt12SemanticError, ParsedMessage};
121 use crate::offers::payer::{PAYER_METADATA_TYPE, PayerTlvStream, PayerTlvStreamRef};
122 use crate::offers::refund::{IV_BYTES as REFUND_IV_BYTES, Refund, RefundContents};
123 use crate::offers::signer;
124 use crate::util::ser::{HighZeroBytesDroppedBigSize, Iterable, SeekReadable, WithoutLength, Writeable, Writer};
125 use crate::util::string::PrintableString;
127 use crate::prelude::*;
129 #[cfg(feature = "std")]
130 use std::time::SystemTime;
132 pub(crate) const DEFAULT_RELATIVE_EXPIRY: Duration = Duration::from_secs(7200);
134 /// Tag for the hash function used when signing a [`Bolt12Invoice`]'s merkle root.
135 pub const SIGNATURE_TAG: &'static str = concat!("lightning", "invoice", "signature");
137 /// Builds a [`Bolt12Invoice`] from either:
138 /// - an [`InvoiceRequest`] for the "offer to be paid" flow or
139 /// - a [`Refund`] for the "offer for money" flow.
141 /// See [module-level documentation] for usage.
143 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
145 /// [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
146 /// [`Refund`]: crate::offers::refund::Refund
147 /// [module-level documentation]: self
148 pub struct InvoiceBuilder<'a, S: SigningPubkeyStrategy> {
149 invreq_bytes: &'a Vec<u8>,
150 invoice: InvoiceContents,
151 signing_pubkey_strategy: S,
154 /// Indicates how [`Bolt12Invoice::signing_pubkey`] was set.
156 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
157 pub trait SigningPubkeyStrategy {}
159 /// [`Bolt12Invoice::signing_pubkey`] was explicitly set.
161 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
162 pub struct ExplicitSigningPubkey {}
164 /// [`Bolt12Invoice::signing_pubkey`] was derived.
166 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
167 pub struct DerivedSigningPubkey(KeyPair);
169 impl SigningPubkeyStrategy for ExplicitSigningPubkey {}
170 impl SigningPubkeyStrategy for DerivedSigningPubkey {}
172 impl<'a> InvoiceBuilder<'a, ExplicitSigningPubkey> {
173 pub(super) fn for_offer(
174 invoice_request: &'a InvoiceRequest, payment_paths: Vec<(BlindedPayInfo, BlindedPath)>,
175 created_at: Duration, payment_hash: PaymentHash
176 ) -> Result<Self, Bolt12SemanticError> {
177 let amount_msats = Self::check_amount_msats(invoice_request)?;
178 let signing_pubkey = invoice_request.contents.inner.offer.signing_pubkey();
179 let contents = InvoiceContents::ForOffer {
180 invoice_request: invoice_request.contents.clone(),
181 fields: Self::fields(
182 payment_paths, created_at, payment_hash, amount_msats, signing_pubkey
186 Self::new(&invoice_request.bytes, contents, ExplicitSigningPubkey {})
189 pub(super) fn for_refund(
190 refund: &'a Refund, payment_paths: Vec<(BlindedPayInfo, BlindedPath)>, created_at: Duration,
191 payment_hash: PaymentHash, signing_pubkey: PublicKey
192 ) -> Result<Self, Bolt12SemanticError> {
193 let amount_msats = refund.amount_msats();
194 let contents = InvoiceContents::ForRefund {
195 refund: refund.contents.clone(),
196 fields: Self::fields(
197 payment_paths, created_at, payment_hash, amount_msats, signing_pubkey
201 Self::new(&refund.bytes, contents, ExplicitSigningPubkey {})
205 impl<'a> InvoiceBuilder<'a, DerivedSigningPubkey> {
206 pub(super) fn for_offer_using_keys(
207 invoice_request: &'a InvoiceRequest, payment_paths: Vec<(BlindedPayInfo, BlindedPath)>,
208 created_at: Duration, payment_hash: PaymentHash, keys: KeyPair
209 ) -> Result<Self, Bolt12SemanticError> {
210 let amount_msats = Self::check_amount_msats(invoice_request)?;
211 let signing_pubkey = invoice_request.contents.inner.offer.signing_pubkey();
212 let contents = InvoiceContents::ForOffer {
213 invoice_request: invoice_request.contents.clone(),
214 fields: Self::fields(
215 payment_paths, created_at, payment_hash, amount_msats, signing_pubkey
219 Self::new(&invoice_request.bytes, contents, DerivedSigningPubkey(keys))
222 pub(super) fn for_refund_using_keys(
223 refund: &'a Refund, payment_paths: Vec<(BlindedPayInfo, BlindedPath)>, created_at: Duration,
224 payment_hash: PaymentHash, keys: KeyPair,
225 ) -> Result<Self, Bolt12SemanticError> {
226 let amount_msats = refund.amount_msats();
227 let signing_pubkey = keys.public_key();
228 let contents = InvoiceContents::ForRefund {
229 refund: refund.contents.clone(),
230 fields: Self::fields(
231 payment_paths, created_at, payment_hash, amount_msats, signing_pubkey
235 Self::new(&refund.bytes, contents, DerivedSigningPubkey(keys))
239 impl<'a, S: SigningPubkeyStrategy> InvoiceBuilder<'a, S> {
240 fn check_amount_msats(invoice_request: &InvoiceRequest) -> Result<u64, Bolt12SemanticError> {
241 match invoice_request.amount_msats() {
242 Some(amount_msats) => Ok(amount_msats),
243 None => match invoice_request.contents.inner.offer.amount() {
244 Some(Amount::Bitcoin { amount_msats }) => {
245 amount_msats.checked_mul(invoice_request.quantity().unwrap_or(1))
246 .ok_or(Bolt12SemanticError::InvalidAmount)
248 Some(Amount::Currency { .. }) => Err(Bolt12SemanticError::UnsupportedCurrency),
249 None => Err(Bolt12SemanticError::MissingAmount),
255 payment_paths: Vec<(BlindedPayInfo, BlindedPath)>, created_at: Duration,
256 payment_hash: PaymentHash, amount_msats: u64, signing_pubkey: PublicKey
259 payment_paths, created_at, relative_expiry: None, payment_hash, amount_msats,
260 fallbacks: None, features: Bolt12InvoiceFeatures::empty(), signing_pubkey,
265 invreq_bytes: &'a Vec<u8>, contents: InvoiceContents, signing_pubkey_strategy: S
266 ) -> Result<Self, Bolt12SemanticError> {
267 if contents.fields().payment_paths.is_empty() {
268 return Err(Bolt12SemanticError::MissingPaths);
271 Ok(Self { invreq_bytes, invoice: contents, signing_pubkey_strategy })
274 /// Sets the [`Bolt12Invoice::relative_expiry`] as seconds since [`Bolt12Invoice::created_at`].
275 /// Any expiry that has already passed is valid and can be checked for using
276 /// [`Bolt12Invoice::is_expired`].
278 /// Successive calls to this method will override the previous setting.
279 pub fn relative_expiry(mut self, relative_expiry_secs: u32) -> Self {
280 let relative_expiry = Duration::from_secs(relative_expiry_secs as u64);
281 self.invoice.fields_mut().relative_expiry = Some(relative_expiry);
285 /// Adds a P2WSH address to [`Bolt12Invoice::fallbacks`].
287 /// Successive calls to this method will add another address. Caller is responsible for not
288 /// adding duplicate addresses and only calling if capable of receiving to P2WSH addresses.
289 pub fn fallback_v0_p2wsh(mut self, script_hash: &WScriptHash) -> Self {
290 let address = FallbackAddress {
291 version: WitnessVersion::V0.to_num(),
292 program: Vec::from(&script_hash.into_inner()[..]),
294 self.invoice.fields_mut().fallbacks.get_or_insert_with(Vec::new).push(address);
298 /// Adds a P2WPKH address to [`Bolt12Invoice::fallbacks`].
300 /// Successive calls to this method will add another address. Caller is responsible for not
301 /// adding duplicate addresses and only calling if capable of receiving to P2WPKH addresses.
302 pub fn fallback_v0_p2wpkh(mut self, pubkey_hash: &WPubkeyHash) -> Self {
303 let address = FallbackAddress {
304 version: WitnessVersion::V0.to_num(),
305 program: Vec::from(&pubkey_hash.into_inner()[..]),
307 self.invoice.fields_mut().fallbacks.get_or_insert_with(Vec::new).push(address);
311 /// Adds a P2TR address to [`Bolt12Invoice::fallbacks`].
313 /// Successive calls to this method will add another address. Caller is responsible for not
314 /// adding duplicate addresses and only calling if capable of receiving to P2TR addresses.
316 /// This is not exported to bindings users as TweakedPublicKey isn't yet mapped.
317 pub fn fallback_v1_p2tr_tweaked(mut self, output_key: &TweakedPublicKey) -> Self {
318 let address = FallbackAddress {
319 version: WitnessVersion::V1.to_num(),
320 program: Vec::from(&output_key.serialize()[..]),
322 self.invoice.fields_mut().fallbacks.get_or_insert_with(Vec::new).push(address);
326 /// Sets [`Bolt12Invoice::invoice_features`] to indicate MPP may be used. Otherwise, MPP is
328 pub fn allow_mpp(mut self) -> Self {
329 self.invoice.fields_mut().features.set_basic_mpp_optional();
334 impl<'a> InvoiceBuilder<'a, ExplicitSigningPubkey> {
335 /// Builds an unsigned [`Bolt12Invoice`] after checking for valid semantics. It can be signed by
336 /// [`UnsignedBolt12Invoice::sign`].
337 pub fn build(self) -> Result<UnsignedBolt12Invoice, Bolt12SemanticError> {
338 #[cfg(feature = "std")] {
339 if self.invoice.is_offer_or_refund_expired() {
340 return Err(Bolt12SemanticError::AlreadyExpired);
344 let InvoiceBuilder { invreq_bytes, invoice, .. } = self;
345 Ok(UnsignedBolt12Invoice::new(invreq_bytes, invoice))
349 impl<'a> InvoiceBuilder<'a, DerivedSigningPubkey> {
350 /// Builds a signed [`Bolt12Invoice`] after checking for valid semantics.
351 pub fn build_and_sign<T: secp256k1::Signing>(
352 self, secp_ctx: &Secp256k1<T>
353 ) -> Result<Bolt12Invoice, Bolt12SemanticError> {
354 #[cfg(feature = "std")] {
355 if self.invoice.is_offer_or_refund_expired() {
356 return Err(Bolt12SemanticError::AlreadyExpired);
361 invreq_bytes, invoice, signing_pubkey_strategy: DerivedSigningPubkey(keys)
363 let unsigned_invoice = UnsignedBolt12Invoice::new(invreq_bytes, invoice);
365 let invoice = unsigned_invoice
366 .sign::<_, Infallible>(
367 |message| Ok(secp_ctx.sign_schnorr_no_aux_rand(message.as_ref().as_digest(), &keys))
374 /// A semantically valid [`Bolt12Invoice`] that hasn't been signed.
378 /// This is serialized as a TLV stream, which includes TLV records from the originating message. As
379 /// such, it may include unknown, odd TLV records.
380 pub struct UnsignedBolt12Invoice {
382 contents: InvoiceContents,
383 tagged_hash: TaggedHash,
386 impl UnsignedBolt12Invoice {
387 fn new(invreq_bytes: &[u8], contents: InvoiceContents) -> Self {
388 // Use the invoice_request bytes instead of the invoice_request TLV stream as the latter may
389 // have contained unknown TLV records, which are not stored in `InvoiceRequestContents` or
391 let (_, _, _, invoice_tlv_stream) = contents.as_tlv_stream();
392 let invoice_request_bytes = WithoutSignatures(invreq_bytes);
393 let unsigned_tlv_stream = (invoice_request_bytes, invoice_tlv_stream);
395 let mut bytes = Vec::new();
396 unsigned_tlv_stream.write(&mut bytes).unwrap();
398 let tagged_hash = TaggedHash::new(SIGNATURE_TAG, &bytes);
400 Self { bytes, contents, tagged_hash }
403 /// Returns the [`TaggedHash`] of the invoice to sign.
404 pub fn tagged_hash(&self) -> &TaggedHash {
408 /// Signs the [`TaggedHash`] of the invoice using the given function.
410 /// Note: The hash computation may have included unknown, odd TLV records.
412 /// This is not exported to bindings users as functions aren't currently mapped.
413 pub(crate) fn sign<F, E>(mut self, sign: F) -> Result<Bolt12Invoice, SignError<E>>
415 F: FnOnce(&Self) -> Result<Signature, E>
417 let pubkey = self.contents.fields().signing_pubkey;
418 let signature = merkle::sign_message(sign, &self, pubkey)?;
420 // Append the signature TLV record to the bytes.
421 let signature_tlv_stream = SignatureTlvStreamRef {
422 signature: Some(&signature),
424 signature_tlv_stream.write(&mut self.bytes).unwrap();
428 contents: self.contents,
434 impl AsRef<TaggedHash> for UnsignedBolt12Invoice {
435 fn as_ref(&self) -> &TaggedHash {
440 /// A `Bolt12Invoice` is a payment request, typically corresponding to an [`Offer`] or a [`Refund`].
442 /// An invoice may be sent in response to an [`InvoiceRequest`] in the case of an offer or sent
443 /// directly after scanning a refund. It includes all the information needed to pay a recipient.
445 /// [`Offer`]: crate::offers::offer::Offer
446 /// [`Refund`]: crate::offers::refund::Refund
447 /// [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
448 #[derive(Clone, Debug)]
449 #[cfg_attr(test, derive(PartialEq))]
450 pub struct Bolt12Invoice {
452 contents: InvoiceContents,
453 signature: Signature,
456 /// The contents of an [`Bolt12Invoice`] for responding to either an [`Offer`] or a [`Refund`].
458 /// [`Offer`]: crate::offers::offer::Offer
459 /// [`Refund`]: crate::offers::refund::Refund
460 #[derive(Clone, Debug)]
461 #[cfg_attr(test, derive(PartialEq))]
462 enum InvoiceContents {
463 /// Contents for an [`Bolt12Invoice`] corresponding to an [`Offer`].
465 /// [`Offer`]: crate::offers::offer::Offer
467 invoice_request: InvoiceRequestContents,
468 fields: InvoiceFields,
470 /// Contents for an [`Bolt12Invoice`] corresponding to a [`Refund`].
472 /// [`Refund`]: crate::offers::refund::Refund
474 refund: RefundContents,
475 fields: InvoiceFields,
479 /// Invoice-specific fields for an `invoice` message.
480 #[derive(Clone, Debug, PartialEq)]
481 struct InvoiceFields {
482 payment_paths: Vec<(BlindedPayInfo, BlindedPath)>,
483 created_at: Duration,
484 relative_expiry: Option<Duration>,
485 payment_hash: PaymentHash,
487 fallbacks: Option<Vec<FallbackAddress>>,
488 features: Bolt12InvoiceFeatures,
489 signing_pubkey: PublicKey,
492 macro_rules! invoice_accessors { ($self: ident, $contents: expr) => {
493 /// The chains that may be used when paying a requested invoice.
495 /// From [`Offer::chains`]; `None` if the invoice was created in response to a [`Refund`].
497 /// [`Offer::chains`]: crate::offers::offer::Offer::chains
498 pub fn offer_chains(&$self) -> Option<Vec<ChainHash>> {
499 $contents.offer_chains()
502 /// The chain that must be used when paying the invoice; selected from [`offer_chains`] if the
503 /// invoice originated from an offer.
505 /// From [`InvoiceRequest::chain`] or [`Refund::chain`].
507 /// [`offer_chains`]: Self::offer_chains
508 /// [`InvoiceRequest::chain`]: crate::offers::invoice_request::InvoiceRequest::chain
509 pub fn chain(&$self) -> ChainHash {
513 /// Opaque bytes set by the originating [`Offer`].
515 /// From [`Offer::metadata`]; `None` if the invoice was created in response to a [`Refund`] or
516 /// if the [`Offer`] did not set it.
518 /// [`Offer`]: crate::offers::offer::Offer
519 /// [`Offer::metadata`]: crate::offers::offer::Offer::metadata
520 pub fn metadata(&$self) -> Option<&Vec<u8>> {
524 /// The minimum amount required for a successful payment of a single item.
526 /// From [`Offer::amount`]; `None` if the invoice was created in response to a [`Refund`] or if
527 /// the [`Offer`] did not set it.
529 /// [`Offer`]: crate::offers::offer::Offer
530 /// [`Offer::amount`]: crate::offers::offer::Offer::amount
531 pub fn amount(&$self) -> Option<&Amount> {
535 /// Features pertaining to the originating [`Offer`].
537 /// From [`Offer::offer_features`]; `None` if the invoice was created in response to a
540 /// [`Offer`]: crate::offers::offer::Offer
541 /// [`Offer::offer_features`]: crate::offers::offer::Offer::offer_features
542 pub fn offer_features(&$self) -> Option<&OfferFeatures> {
543 $contents.offer_features()
546 /// A complete description of the purpose of the originating offer or refund.
548 /// From [`Offer::description`] or [`Refund::description`].
550 /// [`Offer::description`]: crate::offers::offer::Offer::description
551 pub fn description(&$self) -> PrintableString {
552 $contents.description()
555 /// Duration since the Unix epoch when an invoice should no longer be requested.
557 /// From [`Offer::absolute_expiry`] or [`Refund::absolute_expiry`].
559 /// [`Offer::absolute_expiry`]: crate::offers::offer::Offer::absolute_expiry
560 pub fn absolute_expiry(&$self) -> Option<Duration> {
561 $contents.absolute_expiry()
564 /// The issuer of the offer or refund.
566 /// From [`Offer::issuer`] or [`Refund::issuer`].
568 /// [`Offer::issuer`]: crate::offers::offer::Offer::issuer
569 pub fn issuer(&$self) -> Option<PrintableString> {
573 /// Paths to the recipient originating from publicly reachable nodes.
575 /// From [`Offer::paths`] or [`Refund::paths`].
577 /// [`Offer::paths`]: crate::offers::offer::Offer::paths
578 pub fn message_paths(&$self) -> &[BlindedPath] {
579 $contents.message_paths()
582 /// The quantity of items supported.
584 /// From [`Offer::supported_quantity`]; `None` if the invoice was created in response to a
587 /// [`Offer::supported_quantity`]: crate::offers::offer::Offer::supported_quantity
588 pub fn supported_quantity(&$self) -> Option<Quantity> {
589 $contents.supported_quantity()
592 /// An unpredictable series of bytes from the payer.
594 /// From [`InvoiceRequest::payer_metadata`] or [`Refund::payer_metadata`].
595 pub fn payer_metadata(&$self) -> &[u8] {
596 $contents.payer_metadata()
599 /// Features pertaining to requesting an invoice.
601 /// From [`InvoiceRequest::invoice_request_features`] or [`Refund::features`].
602 pub fn invoice_request_features(&$self) -> &InvoiceRequestFeatures {
603 &$contents.invoice_request_features()
606 /// The quantity of items requested or refunded for.
608 /// From [`InvoiceRequest::quantity`] or [`Refund::quantity`].
609 pub fn quantity(&$self) -> Option<u64> {
613 /// A possibly transient pubkey used to sign the invoice request or to send an invoice for a
614 /// refund in case there are no [`message_paths`].
616 /// [`message_paths`]: Self::message_paths
617 pub fn payer_id(&$self) -> PublicKey {
621 /// A payer-provided note reflected back in the invoice.
623 /// From [`InvoiceRequest::payer_note`] or [`Refund::payer_note`].
624 pub fn payer_note(&$self) -> Option<PrintableString> {
625 $contents.payer_note()
628 /// Paths to the recipient originating from publicly reachable nodes, including information
629 /// needed for routing payments across them.
631 /// Blinded paths provide recipient privacy by obfuscating its node id. Note, however, that this
632 /// privacy is lost if a public node id is used for [`Bolt12Invoice::signing_pubkey`].
634 /// This is not exported to bindings users as slices with non-reference types cannot be ABI
635 /// matched in another language.
636 pub fn payment_paths(&$self) -> &[(BlindedPayInfo, BlindedPath)] {
637 $contents.payment_paths()
640 /// Duration since the Unix epoch when the invoice was created.
641 pub fn created_at(&$self) -> Duration {
642 $contents.created_at()
645 /// Duration since [`Bolt12Invoice::created_at`] when the invoice has expired and therefore
646 /// should no longer be paid.
647 pub fn relative_expiry(&$self) -> Duration {
648 $contents.relative_expiry()
651 /// Whether the invoice has expired.
652 #[cfg(feature = "std")]
653 pub fn is_expired(&$self) -> bool {
654 $contents.is_expired()
657 /// SHA256 hash of the payment preimage that will be given in return for paying the invoice.
658 pub fn payment_hash(&$self) -> PaymentHash {
659 $contents.payment_hash()
662 /// The minimum amount required for a successful payment of the invoice.
663 pub fn amount_msats(&$self) -> u64 {
664 $contents.amount_msats()
667 /// Fallback addresses for paying the invoice on-chain, in order of most-preferred to
670 /// This is not exported to bindings users as Address is not yet mapped
671 pub fn fallbacks(&$self) -> Vec<Address> {
672 $contents.fallbacks()
675 /// Features pertaining to paying an invoice.
676 pub fn invoice_features(&$self) -> &Bolt12InvoiceFeatures {
680 /// The public key corresponding to the key used to sign the invoice.
681 pub fn signing_pubkey(&$self) -> PublicKey {
682 $contents.signing_pubkey()
686 impl UnsignedBolt12Invoice {
687 invoice_accessors!(self, self.contents);
691 invoice_accessors!(self, self.contents);
693 /// Signature of the invoice verified using [`Bolt12Invoice::signing_pubkey`].
694 pub fn signature(&self) -> Signature {
698 /// Hash that was used for signing the invoice.
699 pub fn signable_hash(&self) -> [u8; 32] {
700 merkle::message_digest(SIGNATURE_TAG, &self.bytes).as_ref().clone()
703 /// Verifies that the invoice was for a request or refund created using the given key. Returns
704 /// the associated [`PaymentId`] to use when sending the payment.
705 pub fn verify<T: secp256k1::Signing>(
706 &self, key: &ExpandedKey, secp_ctx: &Secp256k1<T>
707 ) -> Result<PaymentId, ()> {
708 self.contents.verify(TlvStream::new(&self.bytes), key, secp_ctx)
712 pub(super) fn as_tlv_stream(&self) -> FullInvoiceTlvStreamRef {
713 let (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, invoice_tlv_stream) =
714 self.contents.as_tlv_stream();
715 let signature_tlv_stream = SignatureTlvStreamRef {
716 signature: Some(&self.signature),
718 (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, invoice_tlv_stream,
719 signature_tlv_stream)
723 impl InvoiceContents {
724 /// Whether the original offer or refund has expired.
725 #[cfg(feature = "std")]
726 fn is_offer_or_refund_expired(&self) -> bool {
728 InvoiceContents::ForOffer { invoice_request, .. } =>
729 invoice_request.inner.offer.is_expired(),
730 InvoiceContents::ForRefund { refund, .. } => refund.is_expired(),
734 fn offer_chains(&self) -> Option<Vec<ChainHash>> {
736 InvoiceContents::ForOffer { invoice_request, .. } =>
737 Some(invoice_request.inner.offer.chains()),
738 InvoiceContents::ForRefund { .. } => None,
742 fn chain(&self) -> ChainHash {
744 InvoiceContents::ForOffer { invoice_request, .. } => invoice_request.chain(),
745 InvoiceContents::ForRefund { refund, .. } => refund.chain(),
749 fn metadata(&self) -> Option<&Vec<u8>> {
751 InvoiceContents::ForOffer { invoice_request, .. } =>
752 invoice_request.inner.offer.metadata(),
753 InvoiceContents::ForRefund { .. } => None,
757 fn amount(&self) -> Option<&Amount> {
759 InvoiceContents::ForOffer { invoice_request, .. } =>
760 invoice_request.inner.offer.amount(),
761 InvoiceContents::ForRefund { .. } => None,
765 fn description(&self) -> PrintableString {
767 InvoiceContents::ForOffer { invoice_request, .. } => {
768 invoice_request.inner.offer.description()
770 InvoiceContents::ForRefund { refund, .. } => refund.description(),
774 fn offer_features(&self) -> Option<&OfferFeatures> {
776 InvoiceContents::ForOffer { invoice_request, .. } => {
777 Some(invoice_request.inner.offer.features())
779 InvoiceContents::ForRefund { .. } => None,
783 fn absolute_expiry(&self) -> Option<Duration> {
785 InvoiceContents::ForOffer { invoice_request, .. } => {
786 invoice_request.inner.offer.absolute_expiry()
788 InvoiceContents::ForRefund { refund, .. } => refund.absolute_expiry(),
792 fn issuer(&self) -> Option<PrintableString> {
794 InvoiceContents::ForOffer { invoice_request, .. } => {
795 invoice_request.inner.offer.issuer()
797 InvoiceContents::ForRefund { refund, .. } => refund.issuer(),
801 fn message_paths(&self) -> &[BlindedPath] {
803 InvoiceContents::ForOffer { invoice_request, .. } => {
804 invoice_request.inner.offer.paths()
806 InvoiceContents::ForRefund { refund, .. } => refund.paths(),
810 fn supported_quantity(&self) -> Option<Quantity> {
812 InvoiceContents::ForOffer { invoice_request, .. } => {
813 Some(invoice_request.inner.offer.supported_quantity())
815 InvoiceContents::ForRefund { .. } => None,
819 fn payer_metadata(&self) -> &[u8] {
821 InvoiceContents::ForOffer { invoice_request, .. } => invoice_request.metadata(),
822 InvoiceContents::ForRefund { refund, .. } => refund.metadata(),
826 fn invoice_request_features(&self) -> &InvoiceRequestFeatures {
828 InvoiceContents::ForOffer { invoice_request, .. } => invoice_request.features(),
829 InvoiceContents::ForRefund { refund, .. } => refund.features(),
833 fn quantity(&self) -> Option<u64> {
835 InvoiceContents::ForOffer { invoice_request, .. } => invoice_request.quantity(),
836 InvoiceContents::ForRefund { refund, .. } => refund.quantity(),
840 fn payer_id(&self) -> PublicKey {
842 InvoiceContents::ForOffer { invoice_request, .. } => invoice_request.payer_id(),
843 InvoiceContents::ForRefund { refund, .. } => refund.payer_id(),
847 fn payer_note(&self) -> Option<PrintableString> {
849 InvoiceContents::ForOffer { invoice_request, .. } => invoice_request.payer_note(),
850 InvoiceContents::ForRefund { refund, .. } => refund.payer_note(),
854 fn payment_paths(&self) -> &[(BlindedPayInfo, BlindedPath)] {
855 &self.fields().payment_paths[..]
858 fn created_at(&self) -> Duration {
859 self.fields().created_at
862 fn relative_expiry(&self) -> Duration {
863 self.fields().relative_expiry.unwrap_or(DEFAULT_RELATIVE_EXPIRY)
866 #[cfg(feature = "std")]
867 fn is_expired(&self) -> bool {
868 let absolute_expiry = self.created_at().checked_add(self.relative_expiry());
869 match absolute_expiry {
870 Some(seconds_from_epoch) => match SystemTime::UNIX_EPOCH.elapsed() {
871 Ok(elapsed) => elapsed > seconds_from_epoch,
878 fn payment_hash(&self) -> PaymentHash {
879 self.fields().payment_hash
882 fn amount_msats(&self) -> u64 {
883 self.fields().amount_msats
886 fn fallbacks(&self) -> Vec<Address> {
887 let chain = self.chain();
888 let network = if chain == ChainHash::using_genesis_block(Network::Bitcoin) {
890 } else if chain == ChainHash::using_genesis_block(Network::Testnet) {
892 } else if chain == ChainHash::using_genesis_block(Network::Signet) {
894 } else if chain == ChainHash::using_genesis_block(Network::Regtest) {
900 let to_valid_address = |address: &FallbackAddress| {
901 let version = match WitnessVersion::try_from(address.version) {
902 Ok(version) => version,
903 Err(_) => return None,
906 let program = &address.program;
907 if program.len() < 2 || program.len() > 40 {
911 let address = Address {
912 payload: Payload::WitnessProgram {
914 program: program.clone(),
919 if !address.is_standard() && version == WitnessVersion::V0 {
926 self.fields().fallbacks
928 .map(|fallbacks| fallbacks.iter().filter_map(to_valid_address).collect())
929 .unwrap_or_else(Vec::new)
932 fn features(&self) -> &Bolt12InvoiceFeatures {
933 &self.fields().features
936 fn signing_pubkey(&self) -> PublicKey {
937 self.fields().signing_pubkey
940 fn fields(&self) -> &InvoiceFields {
942 InvoiceContents::ForOffer { fields, .. } => fields,
943 InvoiceContents::ForRefund { fields, .. } => fields,
947 fn fields_mut(&mut self) -> &mut InvoiceFields {
949 InvoiceContents::ForOffer { fields, .. } => fields,
950 InvoiceContents::ForRefund { fields, .. } => fields,
954 fn verify<T: secp256k1::Signing>(
955 &self, tlv_stream: TlvStream<'_>, key: &ExpandedKey, secp_ctx: &Secp256k1<T>
956 ) -> Result<PaymentId, ()> {
957 let offer_records = tlv_stream.clone().range(OFFER_TYPES);
958 let invreq_records = tlv_stream.range(INVOICE_REQUEST_TYPES).filter(|record| {
959 match record.r#type {
960 PAYER_METADATA_TYPE => false, // Should be outside range
961 INVOICE_REQUEST_PAYER_ID_TYPE => !self.derives_keys(),
965 let tlv_stream = offer_records.chain(invreq_records);
967 let (metadata, payer_id, iv_bytes) = match self {
968 InvoiceContents::ForOffer { invoice_request, .. } => {
969 (invoice_request.metadata(), invoice_request.payer_id(), INVOICE_REQUEST_IV_BYTES)
971 InvoiceContents::ForRefund { refund, .. } => {
972 (refund.metadata(), refund.payer_id(), REFUND_IV_BYTES)
976 signer::verify_payer_metadata(metadata, key, iv_bytes, payer_id, tlv_stream, secp_ctx)
979 fn derives_keys(&self) -> bool {
981 InvoiceContents::ForOffer { invoice_request, .. } => invoice_request.derives_keys(),
982 InvoiceContents::ForRefund { refund, .. } => refund.derives_keys(),
986 fn as_tlv_stream(&self) -> PartialInvoiceTlvStreamRef {
987 let (payer, offer, invoice_request) = match self {
988 InvoiceContents::ForOffer { invoice_request, .. } => invoice_request.as_tlv_stream(),
989 InvoiceContents::ForRefund { refund, .. } => refund.as_tlv_stream(),
991 let invoice = self.fields().as_tlv_stream();
993 (payer, offer, invoice_request, invoice)
998 fn as_tlv_stream(&self) -> InvoiceTlvStreamRef {
1000 if self.features == Bolt12InvoiceFeatures::empty() { None }
1001 else { Some(&self.features) }
1004 InvoiceTlvStreamRef {
1005 paths: Some(Iterable(self.payment_paths.iter().map(|(_, path)| path))),
1006 blindedpay: Some(Iterable(self.payment_paths.iter().map(|(payinfo, _)| payinfo))),
1007 created_at: Some(self.created_at.as_secs()),
1008 relative_expiry: self.relative_expiry.map(|duration| duration.as_secs() as u32),
1009 payment_hash: Some(&self.payment_hash),
1010 amount: Some(self.amount_msats),
1011 fallbacks: self.fallbacks.as_ref(),
1013 node_id: Some(&self.signing_pubkey),
1018 impl Writeable for UnsignedBolt12Invoice {
1019 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
1020 WithoutLength(&self.bytes).write(writer)
1024 impl Writeable for Bolt12Invoice {
1025 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
1026 WithoutLength(&self.bytes).write(writer)
1030 impl Writeable for InvoiceContents {
1031 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
1032 self.as_tlv_stream().write(writer)
1036 impl TryFrom<Vec<u8>> for UnsignedBolt12Invoice {
1037 type Error = Bolt12ParseError;
1039 fn try_from(bytes: Vec<u8>) -> Result<Self, Self::Error> {
1040 let invoice = ParsedMessage::<PartialInvoiceTlvStream>::try_from(bytes)?;
1041 let ParsedMessage { bytes, tlv_stream } = invoice;
1043 payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, invoice_tlv_stream,
1045 let contents = InvoiceContents::try_from(
1046 (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, invoice_tlv_stream)
1049 let tagged_hash = TaggedHash::new(SIGNATURE_TAG, &bytes);
1051 Ok(UnsignedBolt12Invoice { bytes, contents, tagged_hash })
1055 impl TryFrom<Vec<u8>> for Bolt12Invoice {
1056 type Error = Bolt12ParseError;
1058 fn try_from(bytes: Vec<u8>) -> Result<Self, Self::Error> {
1059 let parsed_invoice = ParsedMessage::<FullInvoiceTlvStream>::try_from(bytes)?;
1060 Bolt12Invoice::try_from(parsed_invoice)
1064 tlv_stream!(InvoiceTlvStream, InvoiceTlvStreamRef, 160..240, {
1065 (160, paths: (Vec<BlindedPath>, WithoutLength, Iterable<'a, BlindedPathIter<'a>, BlindedPath>)),
1066 (162, blindedpay: (Vec<BlindedPayInfo>, WithoutLength, Iterable<'a, BlindedPayInfoIter<'a>, BlindedPayInfo>)),
1067 (164, created_at: (u64, HighZeroBytesDroppedBigSize)),
1068 (166, relative_expiry: (u32, HighZeroBytesDroppedBigSize)),
1069 (168, payment_hash: PaymentHash),
1070 (170, amount: (u64, HighZeroBytesDroppedBigSize)),
1071 (172, fallbacks: (Vec<FallbackAddress>, WithoutLength)),
1072 (174, features: (Bolt12InvoiceFeatures, WithoutLength)),
1073 (176, node_id: PublicKey),
1076 type BlindedPathIter<'a> = core::iter::Map<
1077 core::slice::Iter<'a, (BlindedPayInfo, BlindedPath)>,
1078 for<'r> fn(&'r (BlindedPayInfo, BlindedPath)) -> &'r BlindedPath,
1081 type BlindedPayInfoIter<'a> = core::iter::Map<
1082 core::slice::Iter<'a, (BlindedPayInfo, BlindedPath)>,
1083 for<'r> fn(&'r (BlindedPayInfo, BlindedPath)) -> &'r BlindedPayInfo,
1086 /// Information needed to route a payment across a [`BlindedPath`].
1087 #[derive(Clone, Debug, Hash, Eq, PartialEq)]
1088 pub struct BlindedPayInfo {
1089 /// Base fee charged (in millisatoshi) for the entire blinded path.
1090 pub fee_base_msat: u32,
1092 /// Liquidity fee charged (in millionths of the amount transferred) for the entire blinded path
1093 /// (i.e., 10,000 is 1%).
1094 pub fee_proportional_millionths: u32,
1096 /// Number of blocks subtracted from an incoming HTLC's `cltv_expiry` for the entire blinded
1098 pub cltv_expiry_delta: u16,
1100 /// The minimum HTLC value (in millisatoshi) that is acceptable to all channel peers on the
1101 /// blinded path from the introduction node to the recipient, accounting for any fees, i.e., as
1102 /// seen by the recipient.
1103 pub htlc_minimum_msat: u64,
1105 /// The maximum HTLC value (in millisatoshi) that is acceptable to all channel peers on the
1106 /// blinded path from the introduction node to the recipient, accounting for any fees, i.e., as
1107 /// seen by the recipient.
1108 pub htlc_maximum_msat: u64,
1110 /// Features set in `encrypted_data_tlv` for the `encrypted_recipient_data` TLV record in an
1112 pub features: BlindedHopFeatures,
1115 impl_writeable!(BlindedPayInfo, {
1117 fee_proportional_millionths,
1124 /// Wire representation for an on-chain fallback address.
1125 #[derive(Clone, Debug, PartialEq)]
1126 pub(super) struct FallbackAddress {
1131 impl_writeable!(FallbackAddress, { version, program });
1133 type FullInvoiceTlvStream =
1134 (PayerTlvStream, OfferTlvStream, InvoiceRequestTlvStream, InvoiceTlvStream, SignatureTlvStream);
1137 type FullInvoiceTlvStreamRef<'a> = (
1138 PayerTlvStreamRef<'a>,
1139 OfferTlvStreamRef<'a>,
1140 InvoiceRequestTlvStreamRef<'a>,
1141 InvoiceTlvStreamRef<'a>,
1142 SignatureTlvStreamRef<'a>,
1145 impl SeekReadable for FullInvoiceTlvStream {
1146 fn read<R: io::Read + io::Seek>(r: &mut R) -> Result<Self, DecodeError> {
1147 let payer = SeekReadable::read(r)?;
1148 let offer = SeekReadable::read(r)?;
1149 let invoice_request = SeekReadable::read(r)?;
1150 let invoice = SeekReadable::read(r)?;
1151 let signature = SeekReadable::read(r)?;
1153 Ok((payer, offer, invoice_request, invoice, signature))
1157 type PartialInvoiceTlvStream =
1158 (PayerTlvStream, OfferTlvStream, InvoiceRequestTlvStream, InvoiceTlvStream);
1160 type PartialInvoiceTlvStreamRef<'a> = (
1161 PayerTlvStreamRef<'a>,
1162 OfferTlvStreamRef<'a>,
1163 InvoiceRequestTlvStreamRef<'a>,
1164 InvoiceTlvStreamRef<'a>,
1167 impl SeekReadable for PartialInvoiceTlvStream {
1168 fn read<R: io::Read + io::Seek>(r: &mut R) -> Result<Self, DecodeError> {
1169 let payer = SeekReadable::read(r)?;
1170 let offer = SeekReadable::read(r)?;
1171 let invoice_request = SeekReadable::read(r)?;
1172 let invoice = SeekReadable::read(r)?;
1174 Ok((payer, offer, invoice_request, invoice))
1178 impl TryFrom<ParsedMessage<FullInvoiceTlvStream>> for Bolt12Invoice {
1179 type Error = Bolt12ParseError;
1181 fn try_from(invoice: ParsedMessage<FullInvoiceTlvStream>) -> Result<Self, Self::Error> {
1182 let ParsedMessage { bytes, tlv_stream } = invoice;
1184 payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, invoice_tlv_stream,
1185 SignatureTlvStream { signature },
1187 let contents = InvoiceContents::try_from(
1188 (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, invoice_tlv_stream)
1191 let signature = match signature {
1192 None => return Err(Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingSignature)),
1193 Some(signature) => signature,
1195 let message = TaggedHash::new(SIGNATURE_TAG, &bytes);
1196 let pubkey = contents.fields().signing_pubkey;
1197 merkle::verify_signature(&signature, message, pubkey)?;
1199 Ok(Bolt12Invoice { bytes, contents, signature })
1203 impl TryFrom<PartialInvoiceTlvStream> for InvoiceContents {
1204 type Error = Bolt12SemanticError;
1206 fn try_from(tlv_stream: PartialInvoiceTlvStream) -> Result<Self, Self::Error> {
1210 invoice_request_tlv_stream,
1212 paths, blindedpay, created_at, relative_expiry, payment_hash, amount, fallbacks,
1217 let payment_paths = match (blindedpay, paths) {
1218 (_, None) => return Err(Bolt12SemanticError::MissingPaths),
1219 (None, _) => return Err(Bolt12SemanticError::InvalidPayInfo),
1220 (_, Some(paths)) if paths.is_empty() => return Err(Bolt12SemanticError::MissingPaths),
1221 (Some(blindedpay), Some(paths)) if paths.len() != blindedpay.len() => {
1222 return Err(Bolt12SemanticError::InvalidPayInfo);
1224 (Some(blindedpay), Some(paths)) => {
1225 blindedpay.into_iter().zip(paths.into_iter()).collect::<Vec<_>>()
1229 let created_at = match created_at {
1230 None => return Err(Bolt12SemanticError::MissingCreationTime),
1231 Some(timestamp) => Duration::from_secs(timestamp),
1234 let relative_expiry = relative_expiry
1235 .map(Into::<u64>::into)
1236 .map(Duration::from_secs);
1238 let payment_hash = match payment_hash {
1239 None => return Err(Bolt12SemanticError::MissingPaymentHash),
1240 Some(payment_hash) => payment_hash,
1243 let amount_msats = match amount {
1244 None => return Err(Bolt12SemanticError::MissingAmount),
1245 Some(amount) => amount,
1248 let features = features.unwrap_or_else(Bolt12InvoiceFeatures::empty);
1250 let signing_pubkey = match node_id {
1251 None => return Err(Bolt12SemanticError::MissingSigningPubkey),
1252 Some(node_id) => node_id,
1255 let fields = InvoiceFields {
1256 payment_paths, created_at, relative_expiry, payment_hash, amount_msats, fallbacks,
1257 features, signing_pubkey,
1260 match offer_tlv_stream.node_id {
1261 Some(expected_signing_pubkey) => {
1262 if fields.signing_pubkey != expected_signing_pubkey {
1263 return Err(Bolt12SemanticError::InvalidSigningPubkey);
1266 let invoice_request = InvoiceRequestContents::try_from(
1267 (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream)
1269 Ok(InvoiceContents::ForOffer { invoice_request, fields })
1272 let refund = RefundContents::try_from(
1273 (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream)
1275 Ok(InvoiceContents::ForRefund { refund, fields })
1283 use super::{Bolt12Invoice, DEFAULT_RELATIVE_EXPIRY, FallbackAddress, FullInvoiceTlvStreamRef, InvoiceTlvStreamRef, SIGNATURE_TAG, UnsignedBolt12Invoice};
1285 use bitcoin::blockdata::constants::ChainHash;
1286 use bitcoin::blockdata::script::Script;
1287 use bitcoin::hashes::Hash;
1288 use bitcoin::network::constants::Network;
1289 use bitcoin::secp256k1::{Message, Secp256k1, XOnlyPublicKey, self};
1290 use bitcoin::util::address::{Address, Payload, WitnessVersion};
1291 use bitcoin::util::schnorr::TweakedPublicKey;
1292 use core::convert::TryFrom;
1293 use core::time::Duration;
1294 use crate::blinded_path::{BlindedHop, BlindedPath};
1295 use crate::sign::KeyMaterial;
1296 use crate::ln::features::{Bolt12InvoiceFeatures, InvoiceRequestFeatures, OfferFeatures};
1297 use crate::ln::inbound_payment::ExpandedKey;
1298 use crate::ln::msgs::DecodeError;
1299 use crate::offers::invoice_request::InvoiceRequestTlvStreamRef;
1300 use crate::offers::merkle::{SignError, SignatureTlvStreamRef, TaggedHash, self};
1301 use crate::offers::offer::{Amount, OfferBuilder, OfferTlvStreamRef, Quantity};
1302 use crate::offers::parse::{Bolt12ParseError, Bolt12SemanticError};
1303 use crate::offers::payer::PayerTlvStreamRef;
1304 use crate::offers::refund::RefundBuilder;
1305 use crate::offers::test_utils::*;
1306 use crate::util::ser::{BigSize, Iterable, Writeable};
1307 use crate::util::string::PrintableString;
1310 fn to_bytes(&self) -> Vec<u8>;
1313 impl<'a> ToBytes for FullInvoiceTlvStreamRef<'a> {
1314 fn to_bytes(&self) -> Vec<u8> {
1315 let mut buffer = Vec::new();
1316 self.0.write(&mut buffer).unwrap();
1317 self.1.write(&mut buffer).unwrap();
1318 self.2.write(&mut buffer).unwrap();
1319 self.3.write(&mut buffer).unwrap();
1320 self.4.write(&mut buffer).unwrap();
1326 fn builds_invoice_for_offer_with_defaults() {
1327 let payment_paths = payment_paths();
1328 let payment_hash = payment_hash();
1330 let unsigned_invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
1333 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1335 .sign(payer_sign).unwrap()
1336 .respond_with_no_std(payment_paths.clone(), payment_hash, now).unwrap()
1339 let mut buffer = Vec::new();
1340 unsigned_invoice.write(&mut buffer).unwrap();
1342 assert_eq!(unsigned_invoice.bytes, buffer.as_slice());
1343 assert_eq!(unsigned_invoice.payer_metadata(), &[1; 32]);
1344 assert_eq!(unsigned_invoice.offer_chains(), Some(vec![ChainHash::using_genesis_block(Network::Bitcoin)]));
1345 assert_eq!(unsigned_invoice.metadata(), None);
1346 assert_eq!(unsigned_invoice.amount(), Some(&Amount::Bitcoin { amount_msats: 1000 }));
1347 assert_eq!(unsigned_invoice.description(), PrintableString("foo"));
1348 assert_eq!(unsigned_invoice.offer_features(), Some(&OfferFeatures::empty()));
1349 assert_eq!(unsigned_invoice.absolute_expiry(), None);
1350 assert_eq!(unsigned_invoice.message_paths(), &[]);
1351 assert_eq!(unsigned_invoice.issuer(), None);
1352 assert_eq!(unsigned_invoice.supported_quantity(), Some(Quantity::One));
1353 assert_eq!(unsigned_invoice.signing_pubkey(), recipient_pubkey());
1354 assert_eq!(unsigned_invoice.chain(), ChainHash::using_genesis_block(Network::Bitcoin));
1355 assert_eq!(unsigned_invoice.amount_msats(), 1000);
1356 assert_eq!(unsigned_invoice.invoice_request_features(), &InvoiceRequestFeatures::empty());
1357 assert_eq!(unsigned_invoice.quantity(), None);
1358 assert_eq!(unsigned_invoice.payer_id(), payer_pubkey());
1359 assert_eq!(unsigned_invoice.payer_note(), None);
1360 assert_eq!(unsigned_invoice.payment_paths(), payment_paths.as_slice());
1361 assert_eq!(unsigned_invoice.created_at(), now);
1362 assert_eq!(unsigned_invoice.relative_expiry(), DEFAULT_RELATIVE_EXPIRY);
1363 #[cfg(feature = "std")]
1364 assert!(!unsigned_invoice.is_expired());
1365 assert_eq!(unsigned_invoice.payment_hash(), payment_hash);
1366 assert_eq!(unsigned_invoice.amount_msats(), 1000);
1367 assert_eq!(unsigned_invoice.fallbacks(), vec![]);
1368 assert_eq!(unsigned_invoice.invoice_features(), &Bolt12InvoiceFeatures::empty());
1369 assert_eq!(unsigned_invoice.signing_pubkey(), recipient_pubkey());
1371 match UnsignedBolt12Invoice::try_from(buffer) {
1372 Err(e) => panic!("error parsing unsigned invoice: {:?}", e),
1374 assert_eq!(parsed.bytes, unsigned_invoice.bytes);
1375 assert_eq!(parsed.tagged_hash, unsigned_invoice.tagged_hash);
1379 let invoice = unsigned_invoice.sign(recipient_sign).unwrap();
1381 let mut buffer = Vec::new();
1382 invoice.write(&mut buffer).unwrap();
1384 assert_eq!(invoice.bytes, buffer.as_slice());
1385 assert_eq!(invoice.payer_metadata(), &[1; 32]);
1386 assert_eq!(invoice.offer_chains(), Some(vec![ChainHash::using_genesis_block(Network::Bitcoin)]));
1387 assert_eq!(invoice.metadata(), None);
1388 assert_eq!(invoice.amount(), Some(&Amount::Bitcoin { amount_msats: 1000 }));
1389 assert_eq!(invoice.description(), PrintableString("foo"));
1390 assert_eq!(invoice.offer_features(), Some(&OfferFeatures::empty()));
1391 assert_eq!(invoice.absolute_expiry(), None);
1392 assert_eq!(invoice.message_paths(), &[]);
1393 assert_eq!(invoice.issuer(), None);
1394 assert_eq!(invoice.supported_quantity(), Some(Quantity::One));
1395 assert_eq!(invoice.signing_pubkey(), recipient_pubkey());
1396 assert_eq!(invoice.chain(), ChainHash::using_genesis_block(Network::Bitcoin));
1397 assert_eq!(invoice.amount_msats(), 1000);
1398 assert_eq!(invoice.invoice_request_features(), &InvoiceRequestFeatures::empty());
1399 assert_eq!(invoice.quantity(), None);
1400 assert_eq!(invoice.payer_id(), payer_pubkey());
1401 assert_eq!(invoice.payer_note(), None);
1402 assert_eq!(invoice.payment_paths(), payment_paths.as_slice());
1403 assert_eq!(invoice.created_at(), now);
1404 assert_eq!(invoice.relative_expiry(), DEFAULT_RELATIVE_EXPIRY);
1405 #[cfg(feature = "std")]
1406 assert!(!invoice.is_expired());
1407 assert_eq!(invoice.payment_hash(), payment_hash);
1408 assert_eq!(invoice.amount_msats(), 1000);
1409 assert_eq!(invoice.fallbacks(), vec![]);
1410 assert_eq!(invoice.invoice_features(), &Bolt12InvoiceFeatures::empty());
1411 assert_eq!(invoice.signing_pubkey(), recipient_pubkey());
1413 let message = TaggedHash::new(SIGNATURE_TAG, &invoice.bytes);
1414 assert!(merkle::verify_signature(&invoice.signature, message, recipient_pubkey()).is_ok());
1416 let digest = Message::from_slice(&invoice.signable_hash()).unwrap();
1417 let pubkey = recipient_pubkey().into();
1418 let secp_ctx = Secp256k1::verification_only();
1419 assert!(secp_ctx.verify_schnorr(&invoice.signature, &digest, &pubkey).is_ok());
1422 invoice.as_tlv_stream(),
1424 PayerTlvStreamRef { metadata: Some(&vec![1; 32]) },
1430 description: Some(&String::from("foo")),
1432 absolute_expiry: None,
1436 node_id: Some(&recipient_pubkey()),
1438 InvoiceRequestTlvStreamRef {
1443 payer_id: Some(&payer_pubkey()),
1446 InvoiceTlvStreamRef {
1447 paths: Some(Iterable(payment_paths.iter().map(|(_, path)| path))),
1448 blindedpay: Some(Iterable(payment_paths.iter().map(|(payinfo, _)| payinfo))),
1449 created_at: Some(now.as_secs()),
1450 relative_expiry: None,
1451 payment_hash: Some(&payment_hash),
1455 node_id: Some(&recipient_pubkey()),
1457 SignatureTlvStreamRef { signature: Some(&invoice.signature()) },
1461 if let Err(e) = Bolt12Invoice::try_from(buffer) {
1462 panic!("error parsing invoice: {:?}", e);
1467 fn builds_invoice_for_refund_with_defaults() {
1468 let payment_paths = payment_paths();
1469 let payment_hash = payment_hash();
1471 let invoice = RefundBuilder::new("foo".into(), vec![1; 32], payer_pubkey(), 1000).unwrap()
1473 .respond_with_no_std(payment_paths.clone(), payment_hash, recipient_pubkey(), now)
1476 .sign(recipient_sign).unwrap();
1478 let mut buffer = Vec::new();
1479 invoice.write(&mut buffer).unwrap();
1481 assert_eq!(invoice.bytes, buffer.as_slice());
1482 assert_eq!(invoice.payer_metadata(), &[1; 32]);
1483 assert_eq!(invoice.offer_chains(), None);
1484 assert_eq!(invoice.metadata(), None);
1485 assert_eq!(invoice.amount(), None);
1486 assert_eq!(invoice.description(), PrintableString("foo"));
1487 assert_eq!(invoice.offer_features(), None);
1488 assert_eq!(invoice.absolute_expiry(), None);
1489 assert_eq!(invoice.message_paths(), &[]);
1490 assert_eq!(invoice.issuer(), None);
1491 assert_eq!(invoice.supported_quantity(), None);
1492 assert_eq!(invoice.signing_pubkey(), recipient_pubkey());
1493 assert_eq!(invoice.chain(), ChainHash::using_genesis_block(Network::Bitcoin));
1494 assert_eq!(invoice.amount_msats(), 1000);
1495 assert_eq!(invoice.invoice_request_features(), &InvoiceRequestFeatures::empty());
1496 assert_eq!(invoice.quantity(), None);
1497 assert_eq!(invoice.payer_id(), payer_pubkey());
1498 assert_eq!(invoice.payer_note(), None);
1499 assert_eq!(invoice.payment_paths(), payment_paths.as_slice());
1500 assert_eq!(invoice.created_at(), now);
1501 assert_eq!(invoice.relative_expiry(), DEFAULT_RELATIVE_EXPIRY);
1502 #[cfg(feature = "std")]
1503 assert!(!invoice.is_expired());
1504 assert_eq!(invoice.payment_hash(), payment_hash);
1505 assert_eq!(invoice.amount_msats(), 1000);
1506 assert_eq!(invoice.fallbacks(), vec![]);
1507 assert_eq!(invoice.invoice_features(), &Bolt12InvoiceFeatures::empty());
1508 assert_eq!(invoice.signing_pubkey(), recipient_pubkey());
1510 let message = TaggedHash::new(SIGNATURE_TAG, &invoice.bytes);
1511 assert!(merkle::verify_signature(&invoice.signature, message, recipient_pubkey()).is_ok());
1514 invoice.as_tlv_stream(),
1516 PayerTlvStreamRef { metadata: Some(&vec![1; 32]) },
1522 description: Some(&String::from("foo")),
1524 absolute_expiry: None,
1530 InvoiceRequestTlvStreamRef {
1535 payer_id: Some(&payer_pubkey()),
1538 InvoiceTlvStreamRef {
1539 paths: Some(Iterable(payment_paths.iter().map(|(_, path)| path))),
1540 blindedpay: Some(Iterable(payment_paths.iter().map(|(payinfo, _)| payinfo))),
1541 created_at: Some(now.as_secs()),
1542 relative_expiry: None,
1543 payment_hash: Some(&payment_hash),
1547 node_id: Some(&recipient_pubkey()),
1549 SignatureTlvStreamRef { signature: Some(&invoice.signature()) },
1553 if let Err(e) = Bolt12Invoice::try_from(buffer) {
1554 panic!("error parsing invoice: {:?}", e);
1558 #[cfg(feature = "std")]
1560 fn builds_invoice_from_offer_with_expiration() {
1561 let future_expiry = Duration::from_secs(u64::max_value());
1562 let past_expiry = Duration::from_secs(0);
1564 if let Err(e) = OfferBuilder::new("foo".into(), recipient_pubkey())
1566 .absolute_expiry(future_expiry)
1568 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1570 .sign(payer_sign).unwrap()
1571 .respond_with(payment_paths(), payment_hash())
1575 panic!("error building invoice: {:?}", e);
1578 match OfferBuilder::new("foo".into(), recipient_pubkey())
1580 .absolute_expiry(past_expiry)
1582 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1584 .sign(payer_sign).unwrap()
1585 .respond_with(payment_paths(), payment_hash())
1589 Ok(_) => panic!("expected error"),
1590 Err(e) => assert_eq!(e, Bolt12SemanticError::AlreadyExpired),
1594 #[cfg(feature = "std")]
1596 fn builds_invoice_from_refund_with_expiration() {
1597 let future_expiry = Duration::from_secs(u64::max_value());
1598 let past_expiry = Duration::from_secs(0);
1600 if let Err(e) = RefundBuilder::new("foo".into(), vec![1; 32], payer_pubkey(), 1000).unwrap()
1601 .absolute_expiry(future_expiry)
1603 .respond_with(payment_paths(), payment_hash(), recipient_pubkey())
1607 panic!("error building invoice: {:?}", e);
1610 match RefundBuilder::new("foo".into(), vec![1; 32], payer_pubkey(), 1000).unwrap()
1611 .absolute_expiry(past_expiry)
1613 .respond_with(payment_paths(), payment_hash(), recipient_pubkey())
1617 Ok(_) => panic!("expected error"),
1618 Err(e) => assert_eq!(e, Bolt12SemanticError::AlreadyExpired),
1623 fn builds_invoice_from_offer_using_derived_keys() {
1624 let desc = "foo".to_string();
1625 let node_id = recipient_pubkey();
1626 let expanded_key = ExpandedKey::new(&KeyMaterial([42; 32]));
1627 let entropy = FixedEntropy {};
1628 let secp_ctx = Secp256k1::new();
1630 let blinded_path = BlindedPath {
1631 introduction_node_id: pubkey(40),
1632 blinding_point: pubkey(41),
1634 BlindedHop { blinded_node_id: pubkey(42), encrypted_payload: vec![0; 43] },
1635 BlindedHop { blinded_node_id: node_id, encrypted_payload: vec![0; 44] },
1639 let offer = OfferBuilder
1640 ::deriving_signing_pubkey(desc, node_id, &expanded_key, &entropy, &secp_ctx)
1644 let invoice_request = offer.request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1646 .sign(payer_sign).unwrap();
1648 if let Err(e) = invoice_request.clone()
1649 .verify(&expanded_key, &secp_ctx).unwrap()
1650 .respond_using_derived_keys_no_std(payment_paths(), payment_hash(), now()).unwrap()
1651 .build_and_sign(&secp_ctx)
1653 panic!("error building invoice: {:?}", e);
1656 let expanded_key = ExpandedKey::new(&KeyMaterial([41; 32]));
1657 assert!(invoice_request.verify(&expanded_key, &secp_ctx).is_err());
1659 let desc = "foo".to_string();
1660 let offer = OfferBuilder
1661 ::deriving_signing_pubkey(desc, node_id, &expanded_key, &entropy, &secp_ctx)
1663 // Omit the path so that node_id is used for the signing pubkey instead of deriving
1665 let invoice_request = offer.request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1667 .sign(payer_sign).unwrap();
1669 match invoice_request
1670 .verify(&expanded_key, &secp_ctx).unwrap()
1671 .respond_using_derived_keys_no_std(payment_paths(), payment_hash(), now())
1673 Ok(_) => panic!("expected error"),
1674 Err(e) => assert_eq!(e, Bolt12SemanticError::InvalidMetadata),
1679 fn builds_invoice_from_refund_using_derived_keys() {
1680 let expanded_key = ExpandedKey::new(&KeyMaterial([42; 32]));
1681 let entropy = FixedEntropy {};
1682 let secp_ctx = Secp256k1::new();
1684 let refund = RefundBuilder::new("foo".into(), vec![1; 32], payer_pubkey(), 1000).unwrap()
1687 if let Err(e) = refund
1688 .respond_using_derived_keys_no_std(
1689 payment_paths(), payment_hash(), now(), &expanded_key, &entropy
1692 .build_and_sign(&secp_ctx)
1694 panic!("error building invoice: {:?}", e);
1699 fn builds_invoice_with_relative_expiry() {
1701 let one_hour = Duration::from_secs(3600);
1703 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
1706 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1708 .sign(payer_sign).unwrap()
1709 .respond_with_no_std(payment_paths(), payment_hash(), now).unwrap()
1710 .relative_expiry(one_hour.as_secs() as u32)
1712 .sign(recipient_sign).unwrap();
1713 let (_, _, _, tlv_stream, _) = invoice.as_tlv_stream();
1714 #[cfg(feature = "std")]
1715 assert!(!invoice.is_expired());
1716 assert_eq!(invoice.relative_expiry(), one_hour);
1717 assert_eq!(tlv_stream.relative_expiry, Some(one_hour.as_secs() as u32));
1719 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
1722 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1724 .sign(payer_sign).unwrap()
1725 .respond_with_no_std(payment_paths(), payment_hash(), now - one_hour).unwrap()
1726 .relative_expiry(one_hour.as_secs() as u32 - 1)
1728 .sign(recipient_sign).unwrap();
1729 let (_, _, _, tlv_stream, _) = invoice.as_tlv_stream();
1730 #[cfg(feature = "std")]
1731 assert!(invoice.is_expired());
1732 assert_eq!(invoice.relative_expiry(), one_hour - Duration::from_secs(1));
1733 assert_eq!(tlv_stream.relative_expiry, Some(one_hour.as_secs() as u32 - 1));
1737 fn builds_invoice_with_amount_from_request() {
1738 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
1741 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1742 .amount_msats(1001).unwrap()
1744 .sign(payer_sign).unwrap()
1745 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
1747 .sign(recipient_sign).unwrap();
1748 let (_, _, _, tlv_stream, _) = invoice.as_tlv_stream();
1749 assert_eq!(invoice.amount_msats(), 1001);
1750 assert_eq!(tlv_stream.amount, Some(1001));
1754 fn builds_invoice_with_quantity_from_request() {
1755 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
1757 .supported_quantity(Quantity::Unbounded)
1759 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1760 .quantity(2).unwrap()
1762 .sign(payer_sign).unwrap()
1763 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
1765 .sign(recipient_sign).unwrap();
1766 let (_, _, _, tlv_stream, _) = invoice.as_tlv_stream();
1767 assert_eq!(invoice.amount_msats(), 2000);
1768 assert_eq!(tlv_stream.amount, Some(2000));
1770 match OfferBuilder::new("foo".into(), recipient_pubkey())
1772 .supported_quantity(Quantity::Unbounded)
1774 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1775 .quantity(u64::max_value()).unwrap()
1777 .sign(payer_sign).unwrap()
1778 .respond_with_no_std(payment_paths(), payment_hash(), now())
1780 Ok(_) => panic!("expected error"),
1781 Err(e) => assert_eq!(e, Bolt12SemanticError::InvalidAmount),
1786 fn builds_invoice_with_fallback_address() {
1787 let script = Script::new();
1788 let pubkey = bitcoin::util::key::PublicKey::new(recipient_pubkey());
1789 let x_only_pubkey = XOnlyPublicKey::from_keypair(&recipient_keys()).0;
1790 let tweaked_pubkey = TweakedPublicKey::dangerous_assume_tweaked(x_only_pubkey);
1792 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
1795 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1797 .sign(payer_sign).unwrap()
1798 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
1799 .fallback_v0_p2wsh(&script.wscript_hash())
1800 .fallback_v0_p2wpkh(&pubkey.wpubkey_hash().unwrap())
1801 .fallback_v1_p2tr_tweaked(&tweaked_pubkey)
1803 .sign(recipient_sign).unwrap();
1804 let (_, _, _, tlv_stream, _) = invoice.as_tlv_stream();
1806 invoice.fallbacks(),
1808 Address::p2wsh(&script, Network::Bitcoin),
1809 Address::p2wpkh(&pubkey, Network::Bitcoin).unwrap(),
1810 Address::p2tr_tweaked(tweaked_pubkey, Network::Bitcoin),
1814 tlv_stream.fallbacks,
1817 version: WitnessVersion::V0.to_num(),
1818 program: Vec::from(&script.wscript_hash().into_inner()[..]),
1821 version: WitnessVersion::V0.to_num(),
1822 program: Vec::from(&pubkey.wpubkey_hash().unwrap().into_inner()[..]),
1825 version: WitnessVersion::V1.to_num(),
1826 program: Vec::from(&tweaked_pubkey.serialize()[..]),
1833 fn builds_invoice_with_allow_mpp() {
1834 let mut features = Bolt12InvoiceFeatures::empty();
1835 features.set_basic_mpp_optional();
1837 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
1840 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1842 .sign(payer_sign).unwrap()
1843 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
1846 .sign(recipient_sign).unwrap();
1847 let (_, _, _, tlv_stream, _) = invoice.as_tlv_stream();
1848 assert_eq!(invoice.invoice_features(), &features);
1849 assert_eq!(tlv_stream.features, Some(&features));
1853 fn fails_signing_invoice() {
1854 match OfferBuilder::new("foo".into(), recipient_pubkey())
1857 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1859 .sign(payer_sign).unwrap()
1860 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
1864 Ok(_) => panic!("expected error"),
1865 Err(e) => assert_eq!(e, SignError::Signing(())),
1868 match OfferBuilder::new("foo".into(), recipient_pubkey())
1871 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1873 .sign(payer_sign).unwrap()
1874 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
1878 Ok(_) => panic!("expected error"),
1879 Err(e) => assert_eq!(e, SignError::Verification(secp256k1::Error::InvalidSignature)),
1884 fn parses_invoice_with_payment_paths() {
1885 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
1888 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1890 .sign(payer_sign).unwrap()
1891 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
1893 .sign(recipient_sign).unwrap();
1895 let mut buffer = Vec::new();
1896 invoice.write(&mut buffer).unwrap();
1898 if let Err(e) = Bolt12Invoice::try_from(buffer) {
1899 panic!("error parsing invoice: {:?}", e);
1902 let mut tlv_stream = invoice.as_tlv_stream();
1903 tlv_stream.3.paths = None;
1905 match Bolt12Invoice::try_from(tlv_stream.to_bytes()) {
1906 Ok(_) => panic!("expected error"),
1907 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingPaths)),
1910 let mut tlv_stream = invoice.as_tlv_stream();
1911 tlv_stream.3.blindedpay = None;
1913 match Bolt12Invoice::try_from(tlv_stream.to_bytes()) {
1914 Ok(_) => panic!("expected error"),
1915 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::InvalidPayInfo)),
1918 let empty_payment_paths = vec![];
1919 let mut tlv_stream = invoice.as_tlv_stream();
1920 tlv_stream.3.paths = Some(Iterable(empty_payment_paths.iter().map(|(_, path)| path)));
1922 match Bolt12Invoice::try_from(tlv_stream.to_bytes()) {
1923 Ok(_) => panic!("expected error"),
1924 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingPaths)),
1927 let mut payment_paths = payment_paths();
1928 payment_paths.pop();
1929 let mut tlv_stream = invoice.as_tlv_stream();
1930 tlv_stream.3.blindedpay = Some(Iterable(payment_paths.iter().map(|(payinfo, _)| payinfo)));
1932 match Bolt12Invoice::try_from(tlv_stream.to_bytes()) {
1933 Ok(_) => panic!("expected error"),
1934 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::InvalidPayInfo)),
1939 fn parses_invoice_with_created_at() {
1940 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
1943 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1945 .sign(payer_sign).unwrap()
1946 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
1948 .sign(recipient_sign).unwrap();
1950 let mut buffer = Vec::new();
1951 invoice.write(&mut buffer).unwrap();
1953 if let Err(e) = Bolt12Invoice::try_from(buffer) {
1954 panic!("error parsing invoice: {:?}", e);
1957 let mut tlv_stream = invoice.as_tlv_stream();
1958 tlv_stream.3.created_at = None;
1960 match Bolt12Invoice::try_from(tlv_stream.to_bytes()) {
1961 Ok(_) => panic!("expected error"),
1963 assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingCreationTime));
1969 fn parses_invoice_with_relative_expiry() {
1970 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
1973 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1975 .sign(payer_sign).unwrap()
1976 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
1977 .relative_expiry(3600)
1979 .sign(recipient_sign).unwrap();
1981 let mut buffer = Vec::new();
1982 invoice.write(&mut buffer).unwrap();
1984 match Bolt12Invoice::try_from(buffer) {
1985 Ok(invoice) => assert_eq!(invoice.relative_expiry(), Duration::from_secs(3600)),
1986 Err(e) => panic!("error parsing invoice: {:?}", e),
1991 fn parses_invoice_with_payment_hash() {
1992 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
1995 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1997 .sign(payer_sign).unwrap()
1998 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2000 .sign(recipient_sign).unwrap();
2002 let mut buffer = Vec::new();
2003 invoice.write(&mut buffer).unwrap();
2005 if let Err(e) = Bolt12Invoice::try_from(buffer) {
2006 panic!("error parsing invoice: {:?}", e);
2009 let mut tlv_stream = invoice.as_tlv_stream();
2010 tlv_stream.3.payment_hash = None;
2012 match Bolt12Invoice::try_from(tlv_stream.to_bytes()) {
2013 Ok(_) => panic!("expected error"),
2015 assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingPaymentHash));
2021 fn parses_invoice_with_amount() {
2022 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
2025 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2027 .sign(payer_sign).unwrap()
2028 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2030 .sign(recipient_sign).unwrap();
2032 let mut buffer = Vec::new();
2033 invoice.write(&mut buffer).unwrap();
2035 if let Err(e) = Bolt12Invoice::try_from(buffer) {
2036 panic!("error parsing invoice: {:?}", e);
2039 let mut tlv_stream = invoice.as_tlv_stream();
2040 tlv_stream.3.amount = None;
2042 match Bolt12Invoice::try_from(tlv_stream.to_bytes()) {
2043 Ok(_) => panic!("expected error"),
2044 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingAmount)),
2049 fn parses_invoice_with_allow_mpp() {
2050 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
2053 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2055 .sign(payer_sign).unwrap()
2056 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2059 .sign(recipient_sign).unwrap();
2061 let mut buffer = Vec::new();
2062 invoice.write(&mut buffer).unwrap();
2064 match Bolt12Invoice::try_from(buffer) {
2066 let mut features = Bolt12InvoiceFeatures::empty();
2067 features.set_basic_mpp_optional();
2068 assert_eq!(invoice.invoice_features(), &features);
2070 Err(e) => panic!("error parsing invoice: {:?}", e),
2075 fn parses_invoice_with_fallback_address() {
2076 let script = Script::new();
2077 let pubkey = bitcoin::util::key::PublicKey::new(recipient_pubkey());
2078 let x_only_pubkey = XOnlyPublicKey::from_keypair(&recipient_keys()).0;
2079 let tweaked_pubkey = TweakedPublicKey::dangerous_assume_tweaked(x_only_pubkey);
2081 let offer = OfferBuilder::new("foo".into(), recipient_pubkey())
2084 let invoice_request = offer
2085 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2087 .sign(payer_sign).unwrap();
2088 let mut invoice_builder = invoice_request
2089 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2090 .fallback_v0_p2wsh(&script.wscript_hash())
2091 .fallback_v0_p2wpkh(&pubkey.wpubkey_hash().unwrap())
2092 .fallback_v1_p2tr_tweaked(&tweaked_pubkey);
2094 // Only standard addresses will be included.
2095 let fallbacks = invoice_builder.invoice.fields_mut().fallbacks.as_mut().unwrap();
2096 // Non-standard addresses
2097 fallbacks.push(FallbackAddress { version: 1, program: vec![0u8; 41] });
2098 fallbacks.push(FallbackAddress { version: 2, program: vec![0u8; 1] });
2099 fallbacks.push(FallbackAddress { version: 17, program: vec![0u8; 40] });
2101 fallbacks.push(FallbackAddress { version: 1, program: vec![0u8; 33] });
2102 fallbacks.push(FallbackAddress { version: 2, program: vec![0u8; 40] });
2104 let invoice = invoice_builder.build().unwrap().sign(recipient_sign).unwrap();
2105 let mut buffer = Vec::new();
2106 invoice.write(&mut buffer).unwrap();
2108 match Bolt12Invoice::try_from(buffer) {
2111 invoice.fallbacks(),
2113 Address::p2wsh(&script, Network::Bitcoin),
2114 Address::p2wpkh(&pubkey, Network::Bitcoin).unwrap(),
2115 Address::p2tr_tweaked(tweaked_pubkey, Network::Bitcoin),
2117 payload: Payload::WitnessProgram {
2118 version: WitnessVersion::V1,
2119 program: vec![0u8; 33],
2121 network: Network::Bitcoin,
2124 payload: Payload::WitnessProgram {
2125 version: WitnessVersion::V2,
2126 program: vec![0u8; 40],
2128 network: Network::Bitcoin,
2133 Err(e) => panic!("error parsing invoice: {:?}", e),
2138 fn parses_invoice_with_node_id() {
2139 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
2142 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2144 .sign(payer_sign).unwrap()
2145 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2147 .sign(recipient_sign).unwrap();
2149 let mut buffer = Vec::new();
2150 invoice.write(&mut buffer).unwrap();
2152 if let Err(e) = Bolt12Invoice::try_from(buffer) {
2153 panic!("error parsing invoice: {:?}", e);
2156 let mut tlv_stream = invoice.as_tlv_stream();
2157 tlv_stream.3.node_id = None;
2159 match Bolt12Invoice::try_from(tlv_stream.to_bytes()) {
2160 Ok(_) => panic!("expected error"),
2162 assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingSigningPubkey));
2166 let invalid_pubkey = payer_pubkey();
2167 let mut tlv_stream = invoice.as_tlv_stream();
2168 tlv_stream.3.node_id = Some(&invalid_pubkey);
2170 match Bolt12Invoice::try_from(tlv_stream.to_bytes()) {
2171 Ok(_) => panic!("expected error"),
2173 assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::InvalidSigningPubkey));
2179 fn fails_parsing_invoice_without_signature() {
2180 let mut buffer = Vec::new();
2181 OfferBuilder::new("foo".into(), recipient_pubkey())
2184 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2186 .sign(payer_sign).unwrap()
2187 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2190 .write(&mut buffer).unwrap();
2192 match Bolt12Invoice::try_from(buffer) {
2193 Ok(_) => panic!("expected error"),
2194 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingSignature)),
2199 fn fails_parsing_invoice_with_invalid_signature() {
2200 let mut invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
2203 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2205 .sign(payer_sign).unwrap()
2206 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2208 .sign(recipient_sign).unwrap();
2209 let last_signature_byte = invoice.bytes.last_mut().unwrap();
2210 *last_signature_byte = last_signature_byte.wrapping_add(1);
2212 let mut buffer = Vec::new();
2213 invoice.write(&mut buffer).unwrap();
2215 match Bolt12Invoice::try_from(buffer) {
2216 Ok(_) => panic!("expected error"),
2218 assert_eq!(e, Bolt12ParseError::InvalidSignature(secp256k1::Error::InvalidSignature));
2224 fn fails_parsing_invoice_with_extra_tlv_records() {
2225 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
2228 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2230 .sign(payer_sign).unwrap()
2231 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2233 .sign(recipient_sign).unwrap();
2235 let mut encoded_invoice = Vec::new();
2236 invoice.write(&mut encoded_invoice).unwrap();
2237 BigSize(1002).write(&mut encoded_invoice).unwrap();
2238 BigSize(32).write(&mut encoded_invoice).unwrap();
2239 [42u8; 32].write(&mut encoded_invoice).unwrap();
2241 match Bolt12Invoice::try_from(encoded_invoice) {
2242 Ok(_) => panic!("expected error"),
2243 Err(e) => assert_eq!(e, Bolt12ParseError::Decode(DecodeError::InvalidValue)),