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::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::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 pub(crate) fn amount_msats(
241 invoice_request: &InvoiceRequest
242 ) -> Result<u64, Bolt12SemanticError> {
243 match invoice_request.amount_msats() {
244 Some(amount_msats) => Ok(amount_msats),
245 None => match invoice_request.contents.inner.offer.amount() {
246 Some(Amount::Bitcoin { amount_msats }) => {
247 amount_msats.checked_mul(invoice_request.quantity().unwrap_or(1))
248 .ok_or(Bolt12SemanticError::InvalidAmount)
250 Some(Amount::Currency { .. }) => Err(Bolt12SemanticError::UnsupportedCurrency),
251 None => Err(Bolt12SemanticError::MissingAmount),
257 payment_paths: Vec<(BlindedPayInfo, BlindedPath)>, created_at: Duration,
258 payment_hash: PaymentHash, amount_msats: u64, signing_pubkey: PublicKey
261 payment_paths, created_at, relative_expiry: None, payment_hash, amount_msats,
262 fallbacks: None, features: Bolt12InvoiceFeatures::empty(), signing_pubkey,
267 invreq_bytes: &'a Vec<u8>, contents: InvoiceContents, signing_pubkey_strategy: S
268 ) -> Result<Self, Bolt12SemanticError> {
269 if contents.fields().payment_paths.is_empty() {
270 return Err(Bolt12SemanticError::MissingPaths);
273 Ok(Self { invreq_bytes, invoice: contents, signing_pubkey_strategy })
276 /// Sets the [`Bolt12Invoice::relative_expiry`] as seconds since [`Bolt12Invoice::created_at`].
277 /// Any expiry that has already passed is valid and can be checked for using
278 /// [`Bolt12Invoice::is_expired`].
280 /// Successive calls to this method will override the previous setting.
281 pub fn relative_expiry(mut self, relative_expiry_secs: u32) -> Self {
282 let relative_expiry = Duration::from_secs(relative_expiry_secs as u64);
283 self.invoice.fields_mut().relative_expiry = Some(relative_expiry);
287 /// Adds a P2WSH address to [`Bolt12Invoice::fallbacks`].
289 /// Successive calls to this method will add another address. Caller is responsible for not
290 /// adding duplicate addresses and only calling if capable of receiving to P2WSH addresses.
291 pub fn fallback_v0_p2wsh(mut self, script_hash: &WScriptHash) -> Self {
292 let address = FallbackAddress {
293 version: WitnessVersion::V0.to_num(),
294 program: Vec::from(&script_hash.into_inner()[..]),
296 self.invoice.fields_mut().fallbacks.get_or_insert_with(Vec::new).push(address);
300 /// Adds a P2WPKH address to [`Bolt12Invoice::fallbacks`].
302 /// Successive calls to this method will add another address. Caller is responsible for not
303 /// adding duplicate addresses and only calling if capable of receiving to P2WPKH addresses.
304 pub fn fallback_v0_p2wpkh(mut self, pubkey_hash: &WPubkeyHash) -> Self {
305 let address = FallbackAddress {
306 version: WitnessVersion::V0.to_num(),
307 program: Vec::from(&pubkey_hash.into_inner()[..]),
309 self.invoice.fields_mut().fallbacks.get_or_insert_with(Vec::new).push(address);
313 /// Adds a P2TR address to [`Bolt12Invoice::fallbacks`].
315 /// Successive calls to this method will add another address. Caller is responsible for not
316 /// adding duplicate addresses and only calling if capable of receiving to P2TR addresses.
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 #[cfg(not(feature = "std"))] {
345 if self.invoice.is_offer_or_refund_expired_no_std(self.invoice.created_at()) {
346 return Err(Bolt12SemanticError::AlreadyExpired);
350 let InvoiceBuilder { invreq_bytes, invoice, .. } = self;
351 Ok(UnsignedBolt12Invoice::new(invreq_bytes, invoice))
355 impl<'a> InvoiceBuilder<'a, DerivedSigningPubkey> {
356 /// Builds a signed [`Bolt12Invoice`] after checking for valid semantics.
357 pub fn build_and_sign<T: secp256k1::Signing>(
358 self, secp_ctx: &Secp256k1<T>
359 ) -> Result<Bolt12Invoice, Bolt12SemanticError> {
360 #[cfg(feature = "std")] {
361 if self.invoice.is_offer_or_refund_expired() {
362 return Err(Bolt12SemanticError::AlreadyExpired);
366 #[cfg(not(feature = "std"))] {
367 if self.invoice.is_offer_or_refund_expired_no_std(self.invoice.created_at()) {
368 return Err(Bolt12SemanticError::AlreadyExpired);
373 invreq_bytes, invoice, signing_pubkey_strategy: DerivedSigningPubkey(keys)
375 let unsigned_invoice = UnsignedBolt12Invoice::new(invreq_bytes, invoice);
377 let invoice = unsigned_invoice
378 .sign::<_, Infallible>(
379 |message| Ok(secp_ctx.sign_schnorr_no_aux_rand(message.as_ref().as_digest(), &keys))
386 /// A semantically valid [`Bolt12Invoice`] that hasn't been signed.
390 /// This is serialized as a TLV stream, which includes TLV records from the originating message. As
391 /// such, it may include unknown, odd TLV records.
392 pub struct UnsignedBolt12Invoice {
394 contents: InvoiceContents,
395 tagged_hash: TaggedHash,
398 impl UnsignedBolt12Invoice {
399 fn new(invreq_bytes: &[u8], contents: InvoiceContents) -> Self {
400 // Use the invoice_request bytes instead of the invoice_request TLV stream as the latter may
401 // have contained unknown TLV records, which are not stored in `InvoiceRequestContents` or
403 let (_, _, _, invoice_tlv_stream) = contents.as_tlv_stream();
404 let invoice_request_bytes = WithoutSignatures(invreq_bytes);
405 let unsigned_tlv_stream = (invoice_request_bytes, invoice_tlv_stream);
407 let mut bytes = Vec::new();
408 unsigned_tlv_stream.write(&mut bytes).unwrap();
410 let tagged_hash = TaggedHash::new(SIGNATURE_TAG, &bytes);
412 Self { bytes, contents, tagged_hash }
415 /// Returns the [`TaggedHash`] of the invoice to sign.
416 pub fn tagged_hash(&self) -> &TaggedHash {
420 /// Signs the [`TaggedHash`] of the invoice using the given function.
422 /// Note: The hash computation may have included unknown, odd TLV records.
424 /// This is not exported to bindings users as functions aren't currently mapped.
425 pub fn sign<F, E>(mut self, sign: F) -> Result<Bolt12Invoice, SignError<E>>
427 F: FnOnce(&Self) -> Result<Signature, E>
429 let pubkey = self.contents.fields().signing_pubkey;
430 let signature = merkle::sign_message(sign, &self, pubkey)?;
432 // Append the signature TLV record to the bytes.
433 let signature_tlv_stream = SignatureTlvStreamRef {
434 signature: Some(&signature),
436 signature_tlv_stream.write(&mut self.bytes).unwrap();
440 contents: self.contents,
446 impl AsRef<TaggedHash> for UnsignedBolt12Invoice {
447 fn as_ref(&self) -> &TaggedHash {
452 /// A `Bolt12Invoice` is a payment request, typically corresponding to an [`Offer`] or a [`Refund`].
454 /// An invoice may be sent in response to an [`InvoiceRequest`] in the case of an offer or sent
455 /// directly after scanning a refund. It includes all the information needed to pay a recipient.
457 /// [`Offer`]: crate::offers::offer::Offer
458 /// [`Refund`]: crate::offers::refund::Refund
459 /// [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
460 #[derive(Clone, Debug)]
461 #[cfg_attr(test, derive(PartialEq))]
462 pub struct Bolt12Invoice {
464 contents: InvoiceContents,
465 signature: Signature,
468 /// The contents of an [`Bolt12Invoice`] for responding to either an [`Offer`] or a [`Refund`].
470 /// [`Offer`]: crate::offers::offer::Offer
471 /// [`Refund`]: crate::offers::refund::Refund
472 #[derive(Clone, Debug)]
473 #[cfg_attr(test, derive(PartialEq))]
474 enum InvoiceContents {
475 /// Contents for an [`Bolt12Invoice`] corresponding to an [`Offer`].
477 /// [`Offer`]: crate::offers::offer::Offer
479 invoice_request: InvoiceRequestContents,
480 fields: InvoiceFields,
482 /// Contents for an [`Bolt12Invoice`] corresponding to a [`Refund`].
484 /// [`Refund`]: crate::offers::refund::Refund
486 refund: RefundContents,
487 fields: InvoiceFields,
491 /// Invoice-specific fields for an `invoice` message.
492 #[derive(Clone, Debug, PartialEq)]
493 struct InvoiceFields {
494 payment_paths: Vec<(BlindedPayInfo, BlindedPath)>,
495 created_at: Duration,
496 relative_expiry: Option<Duration>,
497 payment_hash: PaymentHash,
499 fallbacks: Option<Vec<FallbackAddress>>,
500 features: Bolt12InvoiceFeatures,
501 signing_pubkey: PublicKey,
504 macro_rules! invoice_accessors { ($self: ident, $contents: expr) => {
505 /// The chains that may be used when paying a requested invoice.
507 /// From [`Offer::chains`]; `None` if the invoice was created in response to a [`Refund`].
509 /// [`Offer::chains`]: crate::offers::offer::Offer::chains
510 pub fn offer_chains(&$self) -> Option<Vec<ChainHash>> {
511 $contents.offer_chains()
514 /// The chain that must be used when paying the invoice; selected from [`offer_chains`] if the
515 /// invoice originated from an offer.
517 /// From [`InvoiceRequest::chain`] or [`Refund::chain`].
519 /// [`offer_chains`]: Self::offer_chains
520 /// [`InvoiceRequest::chain`]: crate::offers::invoice_request::InvoiceRequest::chain
521 pub fn chain(&$self) -> ChainHash {
525 /// Opaque bytes set by the originating [`Offer`].
527 /// From [`Offer::metadata`]; `None` if the invoice was created in response to a [`Refund`] or
528 /// if the [`Offer`] did not set it.
530 /// [`Offer`]: crate::offers::offer::Offer
531 /// [`Offer::metadata`]: crate::offers::offer::Offer::metadata
532 pub fn metadata(&$self) -> Option<&Vec<u8>> {
536 /// The minimum amount required for a successful payment of a single item.
538 /// From [`Offer::amount`]; `None` if the invoice was created in response to a [`Refund`] or if
539 /// the [`Offer`] did not set it.
541 /// [`Offer`]: crate::offers::offer::Offer
542 /// [`Offer::amount`]: crate::offers::offer::Offer::amount
543 pub fn amount(&$self) -> Option<&Amount> {
547 /// Features pertaining to the originating [`Offer`].
549 /// From [`Offer::offer_features`]; `None` if the invoice was created in response to a
552 /// [`Offer`]: crate::offers::offer::Offer
553 /// [`Offer::offer_features`]: crate::offers::offer::Offer::offer_features
554 pub fn offer_features(&$self) -> Option<&OfferFeatures> {
555 $contents.offer_features()
558 /// A complete description of the purpose of the originating offer or refund.
560 /// From [`Offer::description`] or [`Refund::description`].
562 /// [`Offer::description`]: crate::offers::offer::Offer::description
563 pub fn description(&$self) -> PrintableString {
564 $contents.description()
567 /// Duration since the Unix epoch when an invoice should no longer be requested.
569 /// From [`Offer::absolute_expiry`] or [`Refund::absolute_expiry`].
571 /// [`Offer::absolute_expiry`]: crate::offers::offer::Offer::absolute_expiry
572 pub fn absolute_expiry(&$self) -> Option<Duration> {
573 $contents.absolute_expiry()
576 /// The issuer of the offer or refund.
578 /// From [`Offer::issuer`] or [`Refund::issuer`].
580 /// [`Offer::issuer`]: crate::offers::offer::Offer::issuer
581 pub fn issuer(&$self) -> Option<PrintableString> {
585 /// Paths to the recipient originating from publicly reachable nodes.
587 /// From [`Offer::paths`] or [`Refund::paths`].
589 /// [`Offer::paths`]: crate::offers::offer::Offer::paths
590 pub fn message_paths(&$self) -> &[BlindedPath] {
591 $contents.message_paths()
594 /// The quantity of items supported.
596 /// From [`Offer::supported_quantity`]; `None` if the invoice was created in response to a
599 /// [`Offer::supported_quantity`]: crate::offers::offer::Offer::supported_quantity
600 pub fn supported_quantity(&$self) -> Option<Quantity> {
601 $contents.supported_quantity()
604 /// An unpredictable series of bytes from the payer.
606 /// From [`InvoiceRequest::payer_metadata`] or [`Refund::payer_metadata`].
607 pub fn payer_metadata(&$self) -> &[u8] {
608 $contents.payer_metadata()
611 /// Features pertaining to requesting an invoice.
613 /// From [`InvoiceRequest::invoice_request_features`] or [`Refund::features`].
614 pub fn invoice_request_features(&$self) -> &InvoiceRequestFeatures {
615 &$contents.invoice_request_features()
618 /// The quantity of items requested or refunded for.
620 /// From [`InvoiceRequest::quantity`] or [`Refund::quantity`].
621 pub fn quantity(&$self) -> Option<u64> {
625 /// A possibly transient pubkey used to sign the invoice request or to send an invoice for a
626 /// refund in case there are no [`message_paths`].
628 /// [`message_paths`]: Self::message_paths
629 pub fn payer_id(&$self) -> PublicKey {
633 /// A payer-provided note reflected back in the invoice.
635 /// From [`InvoiceRequest::payer_note`] or [`Refund::payer_note`].
636 pub fn payer_note(&$self) -> Option<PrintableString> {
637 $contents.payer_note()
640 /// Paths to the recipient originating from publicly reachable nodes, including information
641 /// needed for routing payments across them.
643 /// Blinded paths provide recipient privacy by obfuscating its node id. Note, however, that this
644 /// privacy is lost if a public node id is used for [`Bolt12Invoice::signing_pubkey`].
646 /// This is not exported to bindings users as slices with non-reference types cannot be ABI
647 /// matched in another language.
648 pub fn payment_paths(&$self) -> &[(BlindedPayInfo, BlindedPath)] {
649 $contents.payment_paths()
652 /// Duration since the Unix epoch when the invoice was created.
653 pub fn created_at(&$self) -> Duration {
654 $contents.created_at()
657 /// Duration since [`Bolt12Invoice::created_at`] when the invoice has expired and therefore
658 /// should no longer be paid.
659 pub fn relative_expiry(&$self) -> Duration {
660 $contents.relative_expiry()
663 /// Whether the invoice has expired.
664 #[cfg(feature = "std")]
665 pub fn is_expired(&$self) -> bool {
666 $contents.is_expired()
669 /// SHA256 hash of the payment preimage that will be given in return for paying the invoice.
670 pub fn payment_hash(&$self) -> PaymentHash {
671 $contents.payment_hash()
674 /// The minimum amount required for a successful payment of the invoice.
675 pub fn amount_msats(&$self) -> u64 {
676 $contents.amount_msats()
679 /// Fallback addresses for paying the invoice on-chain, in order of most-preferred to
681 pub fn fallbacks(&$self) -> Vec<Address> {
682 $contents.fallbacks()
685 /// Features pertaining to paying an invoice.
686 pub fn invoice_features(&$self) -> &Bolt12InvoiceFeatures {
690 /// The public key corresponding to the key used to sign the invoice.
691 pub fn signing_pubkey(&$self) -> PublicKey {
692 $contents.signing_pubkey()
696 impl UnsignedBolt12Invoice {
697 invoice_accessors!(self, self.contents);
701 invoice_accessors!(self, self.contents);
703 /// Signature of the invoice verified using [`Bolt12Invoice::signing_pubkey`].
704 pub fn signature(&self) -> Signature {
708 /// Hash that was used for signing the invoice.
709 pub fn signable_hash(&self) -> [u8; 32] {
710 merkle::message_digest(SIGNATURE_TAG, &self.bytes).as_ref().clone()
713 /// Verifies that the invoice was for a request or refund created using the given key. Returns
714 /// the associated [`PaymentId`] to use when sending the payment.
715 pub fn verify<T: secp256k1::Signing>(
716 &self, key: &ExpandedKey, secp_ctx: &Secp256k1<T>
717 ) -> Result<PaymentId, ()> {
718 self.contents.verify(TlvStream::new(&self.bytes), key, secp_ctx)
722 pub(super) fn as_tlv_stream(&self) -> FullInvoiceTlvStreamRef {
723 let (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, invoice_tlv_stream) =
724 self.contents.as_tlv_stream();
725 let signature_tlv_stream = SignatureTlvStreamRef {
726 signature: Some(&self.signature),
728 (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, invoice_tlv_stream,
729 signature_tlv_stream)
733 impl InvoiceContents {
734 /// Whether the original offer or refund has expired.
735 #[cfg(feature = "std")]
736 fn is_offer_or_refund_expired(&self) -> bool {
738 InvoiceContents::ForOffer { invoice_request, .. } =>
739 invoice_request.inner.offer.is_expired(),
740 InvoiceContents::ForRefund { refund, .. } => refund.is_expired(),
744 #[cfg(not(feature = "std"))]
745 fn is_offer_or_refund_expired_no_std(&self, duration_since_epoch: Duration) -> bool {
747 InvoiceContents::ForOffer { invoice_request, .. } =>
748 invoice_request.inner.offer.is_expired_no_std(duration_since_epoch),
749 InvoiceContents::ForRefund { refund, .. } =>
750 refund.is_expired_no_std(duration_since_epoch),
754 fn offer_chains(&self) -> Option<Vec<ChainHash>> {
756 InvoiceContents::ForOffer { invoice_request, .. } =>
757 Some(invoice_request.inner.offer.chains()),
758 InvoiceContents::ForRefund { .. } => None,
762 fn chain(&self) -> ChainHash {
764 InvoiceContents::ForOffer { invoice_request, .. } => invoice_request.chain(),
765 InvoiceContents::ForRefund { refund, .. } => refund.chain(),
769 fn metadata(&self) -> Option<&Vec<u8>> {
771 InvoiceContents::ForOffer { invoice_request, .. } =>
772 invoice_request.inner.offer.metadata(),
773 InvoiceContents::ForRefund { .. } => None,
777 fn amount(&self) -> Option<&Amount> {
779 InvoiceContents::ForOffer { invoice_request, .. } =>
780 invoice_request.inner.offer.amount(),
781 InvoiceContents::ForRefund { .. } => None,
785 fn description(&self) -> PrintableString {
787 InvoiceContents::ForOffer { invoice_request, .. } => {
788 invoice_request.inner.offer.description()
790 InvoiceContents::ForRefund { refund, .. } => refund.description(),
794 fn offer_features(&self) -> Option<&OfferFeatures> {
796 InvoiceContents::ForOffer { invoice_request, .. } => {
797 Some(invoice_request.inner.offer.features())
799 InvoiceContents::ForRefund { .. } => None,
803 fn absolute_expiry(&self) -> Option<Duration> {
805 InvoiceContents::ForOffer { invoice_request, .. } => {
806 invoice_request.inner.offer.absolute_expiry()
808 InvoiceContents::ForRefund { refund, .. } => refund.absolute_expiry(),
812 fn issuer(&self) -> Option<PrintableString> {
814 InvoiceContents::ForOffer { invoice_request, .. } => {
815 invoice_request.inner.offer.issuer()
817 InvoiceContents::ForRefund { refund, .. } => refund.issuer(),
821 fn message_paths(&self) -> &[BlindedPath] {
823 InvoiceContents::ForOffer { invoice_request, .. } => {
824 invoice_request.inner.offer.paths()
826 InvoiceContents::ForRefund { refund, .. } => refund.paths(),
830 fn supported_quantity(&self) -> Option<Quantity> {
832 InvoiceContents::ForOffer { invoice_request, .. } => {
833 Some(invoice_request.inner.offer.supported_quantity())
835 InvoiceContents::ForRefund { .. } => None,
839 fn payer_metadata(&self) -> &[u8] {
841 InvoiceContents::ForOffer { invoice_request, .. } => invoice_request.metadata(),
842 InvoiceContents::ForRefund { refund, .. } => refund.metadata(),
846 fn invoice_request_features(&self) -> &InvoiceRequestFeatures {
848 InvoiceContents::ForOffer { invoice_request, .. } => invoice_request.features(),
849 InvoiceContents::ForRefund { refund, .. } => refund.features(),
853 fn quantity(&self) -> Option<u64> {
855 InvoiceContents::ForOffer { invoice_request, .. } => invoice_request.quantity(),
856 InvoiceContents::ForRefund { refund, .. } => refund.quantity(),
860 fn payer_id(&self) -> PublicKey {
862 InvoiceContents::ForOffer { invoice_request, .. } => invoice_request.payer_id(),
863 InvoiceContents::ForRefund { refund, .. } => refund.payer_id(),
867 fn payer_note(&self) -> Option<PrintableString> {
869 InvoiceContents::ForOffer { invoice_request, .. } => invoice_request.payer_note(),
870 InvoiceContents::ForRefund { refund, .. } => refund.payer_note(),
874 fn payment_paths(&self) -> &[(BlindedPayInfo, BlindedPath)] {
875 &self.fields().payment_paths[..]
878 fn created_at(&self) -> Duration {
879 self.fields().created_at
882 fn relative_expiry(&self) -> Duration {
883 self.fields().relative_expiry.unwrap_or(DEFAULT_RELATIVE_EXPIRY)
886 #[cfg(feature = "std")]
887 fn is_expired(&self) -> bool {
888 let absolute_expiry = self.created_at().checked_add(self.relative_expiry());
889 match absolute_expiry {
890 Some(seconds_from_epoch) => match SystemTime::UNIX_EPOCH.elapsed() {
891 Ok(elapsed) => elapsed > seconds_from_epoch,
898 fn payment_hash(&self) -> PaymentHash {
899 self.fields().payment_hash
902 fn amount_msats(&self) -> u64 {
903 self.fields().amount_msats
906 fn fallbacks(&self) -> Vec<Address> {
907 let chain = self.chain();
908 let network = if chain == ChainHash::using_genesis_block(Network::Bitcoin) {
910 } else if chain == ChainHash::using_genesis_block(Network::Testnet) {
912 } else if chain == ChainHash::using_genesis_block(Network::Signet) {
914 } else if chain == ChainHash::using_genesis_block(Network::Regtest) {
920 let to_valid_address = |address: &FallbackAddress| {
921 let version = match WitnessVersion::try_from(address.version) {
922 Ok(version) => version,
923 Err(_) => return None,
926 let program = &address.program;
927 if program.len() < 2 || program.len() > 40 {
931 let address = Address {
932 payload: Payload::WitnessProgram {
934 program: program.clone(),
939 if !address.is_standard() && version == WitnessVersion::V0 {
946 self.fields().fallbacks
948 .map(|fallbacks| fallbacks.iter().filter_map(to_valid_address).collect())
949 .unwrap_or_else(Vec::new)
952 fn features(&self) -> &Bolt12InvoiceFeatures {
953 &self.fields().features
956 fn signing_pubkey(&self) -> PublicKey {
957 self.fields().signing_pubkey
960 fn fields(&self) -> &InvoiceFields {
962 InvoiceContents::ForOffer { fields, .. } => fields,
963 InvoiceContents::ForRefund { fields, .. } => fields,
967 fn fields_mut(&mut self) -> &mut InvoiceFields {
969 InvoiceContents::ForOffer { fields, .. } => fields,
970 InvoiceContents::ForRefund { fields, .. } => fields,
974 fn verify<T: secp256k1::Signing>(
975 &self, tlv_stream: TlvStream<'_>, key: &ExpandedKey, secp_ctx: &Secp256k1<T>
976 ) -> Result<PaymentId, ()> {
977 let offer_records = tlv_stream.clone().range(OFFER_TYPES);
978 let invreq_records = tlv_stream.range(INVOICE_REQUEST_TYPES).filter(|record| {
979 match record.r#type {
980 PAYER_METADATA_TYPE => false, // Should be outside range
981 INVOICE_REQUEST_PAYER_ID_TYPE => !self.derives_keys(),
985 let tlv_stream = offer_records.chain(invreq_records);
987 let (metadata, payer_id, iv_bytes) = match self {
988 InvoiceContents::ForOffer { invoice_request, .. } => {
989 (invoice_request.metadata(), invoice_request.payer_id(), INVOICE_REQUEST_IV_BYTES)
991 InvoiceContents::ForRefund { refund, .. } => {
992 (refund.metadata(), refund.payer_id(), REFUND_IV_BYTES)
996 signer::verify_payer_metadata(metadata, key, iv_bytes, payer_id, tlv_stream, secp_ctx)
999 fn derives_keys(&self) -> bool {
1001 InvoiceContents::ForOffer { invoice_request, .. } => invoice_request.derives_keys(),
1002 InvoiceContents::ForRefund { refund, .. } => refund.derives_keys(),
1006 fn as_tlv_stream(&self) -> PartialInvoiceTlvStreamRef {
1007 let (payer, offer, invoice_request) = match self {
1008 InvoiceContents::ForOffer { invoice_request, .. } => invoice_request.as_tlv_stream(),
1009 InvoiceContents::ForRefund { refund, .. } => refund.as_tlv_stream(),
1011 let invoice = self.fields().as_tlv_stream();
1013 (payer, offer, invoice_request, invoice)
1017 impl InvoiceFields {
1018 fn as_tlv_stream(&self) -> InvoiceTlvStreamRef {
1020 if self.features == Bolt12InvoiceFeatures::empty() { None }
1021 else { Some(&self.features) }
1024 InvoiceTlvStreamRef {
1025 paths: Some(Iterable(self.payment_paths.iter().map(|(_, path)| path))),
1026 blindedpay: Some(Iterable(self.payment_paths.iter().map(|(payinfo, _)| payinfo))),
1027 created_at: Some(self.created_at.as_secs()),
1028 relative_expiry: self.relative_expiry.map(|duration| duration.as_secs() as u32),
1029 payment_hash: Some(&self.payment_hash),
1030 amount: Some(self.amount_msats),
1031 fallbacks: self.fallbacks.as_ref(),
1033 node_id: Some(&self.signing_pubkey),
1038 impl Writeable for UnsignedBolt12Invoice {
1039 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
1040 WithoutLength(&self.bytes).write(writer)
1044 impl Writeable for Bolt12Invoice {
1045 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
1046 WithoutLength(&self.bytes).write(writer)
1050 impl Writeable for InvoiceContents {
1051 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
1052 self.as_tlv_stream().write(writer)
1056 impl TryFrom<Vec<u8>> for UnsignedBolt12Invoice {
1057 type Error = Bolt12ParseError;
1059 fn try_from(bytes: Vec<u8>) -> Result<Self, Self::Error> {
1060 let invoice = ParsedMessage::<PartialInvoiceTlvStream>::try_from(bytes)?;
1061 let ParsedMessage { bytes, tlv_stream } = invoice;
1063 payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, invoice_tlv_stream,
1065 let contents = InvoiceContents::try_from(
1066 (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, invoice_tlv_stream)
1069 let tagged_hash = TaggedHash::new(SIGNATURE_TAG, &bytes);
1071 Ok(UnsignedBolt12Invoice { bytes, contents, tagged_hash })
1075 impl TryFrom<Vec<u8>> for Bolt12Invoice {
1076 type Error = Bolt12ParseError;
1078 fn try_from(bytes: Vec<u8>) -> Result<Self, Self::Error> {
1079 let parsed_invoice = ParsedMessage::<FullInvoiceTlvStream>::try_from(bytes)?;
1080 Bolt12Invoice::try_from(parsed_invoice)
1084 tlv_stream!(InvoiceTlvStream, InvoiceTlvStreamRef, 160..240, {
1085 (160, paths: (Vec<BlindedPath>, WithoutLength, Iterable<'a, BlindedPathIter<'a>, BlindedPath>)),
1086 (162, blindedpay: (Vec<BlindedPayInfo>, WithoutLength, Iterable<'a, BlindedPayInfoIter<'a>, BlindedPayInfo>)),
1087 (164, created_at: (u64, HighZeroBytesDroppedBigSize)),
1088 (166, relative_expiry: (u32, HighZeroBytesDroppedBigSize)),
1089 (168, payment_hash: PaymentHash),
1090 (170, amount: (u64, HighZeroBytesDroppedBigSize)),
1091 (172, fallbacks: (Vec<FallbackAddress>, WithoutLength)),
1092 (174, features: (Bolt12InvoiceFeatures, WithoutLength)),
1093 (176, node_id: PublicKey),
1096 type BlindedPathIter<'a> = core::iter::Map<
1097 core::slice::Iter<'a, (BlindedPayInfo, BlindedPath)>,
1098 for<'r> fn(&'r (BlindedPayInfo, BlindedPath)) -> &'r BlindedPath,
1101 type BlindedPayInfoIter<'a> = core::iter::Map<
1102 core::slice::Iter<'a, (BlindedPayInfo, BlindedPath)>,
1103 for<'r> fn(&'r (BlindedPayInfo, BlindedPath)) -> &'r BlindedPayInfo,
1106 /// Information needed to route a payment across a [`BlindedPath`].
1107 #[derive(Clone, Debug, Hash, Eq, PartialEq)]
1108 pub struct BlindedPayInfo {
1109 /// Base fee charged (in millisatoshi) for the entire blinded path.
1110 pub fee_base_msat: u32,
1112 /// Liquidity fee charged (in millionths of the amount transferred) for the entire blinded path
1113 /// (i.e., 10,000 is 1%).
1114 pub fee_proportional_millionths: u32,
1116 /// Number of blocks subtracted from an incoming HTLC's `cltv_expiry` for the entire blinded
1118 pub cltv_expiry_delta: u16,
1120 /// The minimum HTLC value (in millisatoshi) that is acceptable to all channel peers on the
1121 /// blinded path from the introduction node to the recipient, accounting for any fees, i.e., as
1122 /// seen by the recipient.
1123 pub htlc_minimum_msat: u64,
1125 /// The maximum HTLC value (in millisatoshi) that is acceptable to all channel peers on the
1126 /// blinded path from the introduction node to the recipient, accounting for any fees, i.e., as
1127 /// seen by the recipient.
1128 pub htlc_maximum_msat: u64,
1130 /// Features set in `encrypted_data_tlv` for the `encrypted_recipient_data` TLV record in an
1132 pub features: BlindedHopFeatures,
1135 impl_writeable!(BlindedPayInfo, {
1137 fee_proportional_millionths,
1144 /// Wire representation for an on-chain fallback address.
1145 #[derive(Clone, Debug, PartialEq)]
1146 pub(super) struct FallbackAddress {
1151 impl_writeable!(FallbackAddress, { version, program });
1153 type FullInvoiceTlvStream =
1154 (PayerTlvStream, OfferTlvStream, InvoiceRequestTlvStream, InvoiceTlvStream, SignatureTlvStream);
1157 type FullInvoiceTlvStreamRef<'a> = (
1158 PayerTlvStreamRef<'a>,
1159 OfferTlvStreamRef<'a>,
1160 InvoiceRequestTlvStreamRef<'a>,
1161 InvoiceTlvStreamRef<'a>,
1162 SignatureTlvStreamRef<'a>,
1165 impl SeekReadable for FullInvoiceTlvStream {
1166 fn read<R: io::Read + io::Seek>(r: &mut R) -> Result<Self, DecodeError> {
1167 let payer = SeekReadable::read(r)?;
1168 let offer = SeekReadable::read(r)?;
1169 let invoice_request = SeekReadable::read(r)?;
1170 let invoice = SeekReadable::read(r)?;
1171 let signature = SeekReadable::read(r)?;
1173 Ok((payer, offer, invoice_request, invoice, signature))
1177 type PartialInvoiceTlvStream =
1178 (PayerTlvStream, OfferTlvStream, InvoiceRequestTlvStream, InvoiceTlvStream);
1180 type PartialInvoiceTlvStreamRef<'a> = (
1181 PayerTlvStreamRef<'a>,
1182 OfferTlvStreamRef<'a>,
1183 InvoiceRequestTlvStreamRef<'a>,
1184 InvoiceTlvStreamRef<'a>,
1187 impl SeekReadable for PartialInvoiceTlvStream {
1188 fn read<R: io::Read + io::Seek>(r: &mut R) -> Result<Self, DecodeError> {
1189 let payer = SeekReadable::read(r)?;
1190 let offer = SeekReadable::read(r)?;
1191 let invoice_request = SeekReadable::read(r)?;
1192 let invoice = SeekReadable::read(r)?;
1194 Ok((payer, offer, invoice_request, invoice))
1198 impl TryFrom<ParsedMessage<FullInvoiceTlvStream>> for Bolt12Invoice {
1199 type Error = Bolt12ParseError;
1201 fn try_from(invoice: ParsedMessage<FullInvoiceTlvStream>) -> Result<Self, Self::Error> {
1202 let ParsedMessage { bytes, tlv_stream } = invoice;
1204 payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, invoice_tlv_stream,
1205 SignatureTlvStream { signature },
1207 let contents = InvoiceContents::try_from(
1208 (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, invoice_tlv_stream)
1211 let signature = match signature {
1212 None => return Err(Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingSignature)),
1213 Some(signature) => signature,
1215 let message = TaggedHash::new(SIGNATURE_TAG, &bytes);
1216 let pubkey = contents.fields().signing_pubkey;
1217 merkle::verify_signature(&signature, message, pubkey)?;
1219 Ok(Bolt12Invoice { bytes, contents, signature })
1223 impl TryFrom<PartialInvoiceTlvStream> for InvoiceContents {
1224 type Error = Bolt12SemanticError;
1226 fn try_from(tlv_stream: PartialInvoiceTlvStream) -> Result<Self, Self::Error> {
1230 invoice_request_tlv_stream,
1232 paths, blindedpay, created_at, relative_expiry, payment_hash, amount, fallbacks,
1237 let payment_paths = match (blindedpay, paths) {
1238 (_, None) => return Err(Bolt12SemanticError::MissingPaths),
1239 (None, _) => return Err(Bolt12SemanticError::InvalidPayInfo),
1240 (_, Some(paths)) if paths.is_empty() => return Err(Bolt12SemanticError::MissingPaths),
1241 (Some(blindedpay), Some(paths)) if paths.len() != blindedpay.len() => {
1242 return Err(Bolt12SemanticError::InvalidPayInfo);
1244 (Some(blindedpay), Some(paths)) => {
1245 blindedpay.into_iter().zip(paths.into_iter()).collect::<Vec<_>>()
1249 let created_at = match created_at {
1250 None => return Err(Bolt12SemanticError::MissingCreationTime),
1251 Some(timestamp) => Duration::from_secs(timestamp),
1254 let relative_expiry = relative_expiry
1255 .map(Into::<u64>::into)
1256 .map(Duration::from_secs);
1258 let payment_hash = match payment_hash {
1259 None => return Err(Bolt12SemanticError::MissingPaymentHash),
1260 Some(payment_hash) => payment_hash,
1263 let amount_msats = match amount {
1264 None => return Err(Bolt12SemanticError::MissingAmount),
1265 Some(amount) => amount,
1268 let features = features.unwrap_or_else(Bolt12InvoiceFeatures::empty);
1270 let signing_pubkey = match node_id {
1271 None => return Err(Bolt12SemanticError::MissingSigningPubkey),
1272 Some(node_id) => node_id,
1275 let fields = InvoiceFields {
1276 payment_paths, created_at, relative_expiry, payment_hash, amount_msats, fallbacks,
1277 features, signing_pubkey,
1280 match offer_tlv_stream.node_id {
1281 Some(expected_signing_pubkey) => {
1282 if fields.signing_pubkey != expected_signing_pubkey {
1283 return Err(Bolt12SemanticError::InvalidSigningPubkey);
1286 let invoice_request = InvoiceRequestContents::try_from(
1287 (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream)
1289 Ok(InvoiceContents::ForOffer { invoice_request, fields })
1292 let refund = RefundContents::try_from(
1293 (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream)
1295 Ok(InvoiceContents::ForRefund { refund, fields })
1303 use super::{Bolt12Invoice, DEFAULT_RELATIVE_EXPIRY, FallbackAddress, FullInvoiceTlvStreamRef, InvoiceTlvStreamRef, SIGNATURE_TAG, UnsignedBolt12Invoice};
1305 use bitcoin::blockdata::constants::ChainHash;
1306 use bitcoin::blockdata::script::Script;
1307 use bitcoin::hashes::Hash;
1308 use bitcoin::network::constants::Network;
1309 use bitcoin::secp256k1::{Message, Secp256k1, XOnlyPublicKey, self};
1310 use bitcoin::util::address::{Address, Payload, WitnessVersion};
1311 use bitcoin::util::schnorr::TweakedPublicKey;
1312 use core::convert::TryFrom;
1313 use core::time::Duration;
1314 use crate::blinded_path::{BlindedHop, BlindedPath};
1315 use crate::sign::KeyMaterial;
1316 use crate::ln::features::{Bolt12InvoiceFeatures, InvoiceRequestFeatures, OfferFeatures};
1317 use crate::ln::inbound_payment::ExpandedKey;
1318 use crate::ln::msgs::DecodeError;
1319 use crate::offers::invoice_request::InvoiceRequestTlvStreamRef;
1320 use crate::offers::merkle::{SignError, SignatureTlvStreamRef, TaggedHash, self};
1321 use crate::offers::offer::{Amount, OfferBuilder, OfferTlvStreamRef, Quantity};
1322 use crate::offers::parse::{Bolt12ParseError, Bolt12SemanticError};
1323 use crate::offers::payer::PayerTlvStreamRef;
1324 use crate::offers::refund::RefundBuilder;
1325 use crate::offers::test_utils::*;
1326 use crate::util::ser::{BigSize, Iterable, Writeable};
1327 use crate::util::string::PrintableString;
1330 fn to_bytes(&self) -> Vec<u8>;
1333 impl<'a> ToBytes for FullInvoiceTlvStreamRef<'a> {
1334 fn to_bytes(&self) -> Vec<u8> {
1335 let mut buffer = Vec::new();
1336 self.0.write(&mut buffer).unwrap();
1337 self.1.write(&mut buffer).unwrap();
1338 self.2.write(&mut buffer).unwrap();
1339 self.3.write(&mut buffer).unwrap();
1340 self.4.write(&mut buffer).unwrap();
1346 fn builds_invoice_for_offer_with_defaults() {
1347 let payment_paths = payment_paths();
1348 let payment_hash = payment_hash();
1350 let unsigned_invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
1353 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1355 .sign(payer_sign).unwrap()
1356 .respond_with_no_std(payment_paths.clone(), payment_hash, now).unwrap()
1359 let mut buffer = Vec::new();
1360 unsigned_invoice.write(&mut buffer).unwrap();
1362 assert_eq!(unsigned_invoice.bytes, buffer.as_slice());
1363 assert_eq!(unsigned_invoice.payer_metadata(), &[1; 32]);
1364 assert_eq!(unsigned_invoice.offer_chains(), Some(vec![ChainHash::using_genesis_block(Network::Bitcoin)]));
1365 assert_eq!(unsigned_invoice.metadata(), None);
1366 assert_eq!(unsigned_invoice.amount(), Some(&Amount::Bitcoin { amount_msats: 1000 }));
1367 assert_eq!(unsigned_invoice.description(), PrintableString("foo"));
1368 assert_eq!(unsigned_invoice.offer_features(), Some(&OfferFeatures::empty()));
1369 assert_eq!(unsigned_invoice.absolute_expiry(), None);
1370 assert_eq!(unsigned_invoice.message_paths(), &[]);
1371 assert_eq!(unsigned_invoice.issuer(), None);
1372 assert_eq!(unsigned_invoice.supported_quantity(), Some(Quantity::One));
1373 assert_eq!(unsigned_invoice.signing_pubkey(), recipient_pubkey());
1374 assert_eq!(unsigned_invoice.chain(), ChainHash::using_genesis_block(Network::Bitcoin));
1375 assert_eq!(unsigned_invoice.amount_msats(), 1000);
1376 assert_eq!(unsigned_invoice.invoice_request_features(), &InvoiceRequestFeatures::empty());
1377 assert_eq!(unsigned_invoice.quantity(), None);
1378 assert_eq!(unsigned_invoice.payer_id(), payer_pubkey());
1379 assert_eq!(unsigned_invoice.payer_note(), None);
1380 assert_eq!(unsigned_invoice.payment_paths(), payment_paths.as_slice());
1381 assert_eq!(unsigned_invoice.created_at(), now);
1382 assert_eq!(unsigned_invoice.relative_expiry(), DEFAULT_RELATIVE_EXPIRY);
1383 #[cfg(feature = "std")]
1384 assert!(!unsigned_invoice.is_expired());
1385 assert_eq!(unsigned_invoice.payment_hash(), payment_hash);
1386 assert_eq!(unsigned_invoice.amount_msats(), 1000);
1387 assert_eq!(unsigned_invoice.fallbacks(), vec![]);
1388 assert_eq!(unsigned_invoice.invoice_features(), &Bolt12InvoiceFeatures::empty());
1389 assert_eq!(unsigned_invoice.signing_pubkey(), recipient_pubkey());
1391 match UnsignedBolt12Invoice::try_from(buffer) {
1392 Err(e) => panic!("error parsing unsigned invoice: {:?}", e),
1394 assert_eq!(parsed.bytes, unsigned_invoice.bytes);
1395 assert_eq!(parsed.tagged_hash, unsigned_invoice.tagged_hash);
1399 let invoice = unsigned_invoice.sign(recipient_sign).unwrap();
1401 let mut buffer = Vec::new();
1402 invoice.write(&mut buffer).unwrap();
1404 assert_eq!(invoice.bytes, buffer.as_slice());
1405 assert_eq!(invoice.payer_metadata(), &[1; 32]);
1406 assert_eq!(invoice.offer_chains(), Some(vec![ChainHash::using_genesis_block(Network::Bitcoin)]));
1407 assert_eq!(invoice.metadata(), None);
1408 assert_eq!(invoice.amount(), Some(&Amount::Bitcoin { amount_msats: 1000 }));
1409 assert_eq!(invoice.description(), PrintableString("foo"));
1410 assert_eq!(invoice.offer_features(), Some(&OfferFeatures::empty()));
1411 assert_eq!(invoice.absolute_expiry(), None);
1412 assert_eq!(invoice.message_paths(), &[]);
1413 assert_eq!(invoice.issuer(), None);
1414 assert_eq!(invoice.supported_quantity(), Some(Quantity::One));
1415 assert_eq!(invoice.signing_pubkey(), recipient_pubkey());
1416 assert_eq!(invoice.chain(), ChainHash::using_genesis_block(Network::Bitcoin));
1417 assert_eq!(invoice.amount_msats(), 1000);
1418 assert_eq!(invoice.invoice_request_features(), &InvoiceRequestFeatures::empty());
1419 assert_eq!(invoice.quantity(), None);
1420 assert_eq!(invoice.payer_id(), payer_pubkey());
1421 assert_eq!(invoice.payer_note(), None);
1422 assert_eq!(invoice.payment_paths(), payment_paths.as_slice());
1423 assert_eq!(invoice.created_at(), now);
1424 assert_eq!(invoice.relative_expiry(), DEFAULT_RELATIVE_EXPIRY);
1425 #[cfg(feature = "std")]
1426 assert!(!invoice.is_expired());
1427 assert_eq!(invoice.payment_hash(), payment_hash);
1428 assert_eq!(invoice.amount_msats(), 1000);
1429 assert_eq!(invoice.fallbacks(), vec![]);
1430 assert_eq!(invoice.invoice_features(), &Bolt12InvoiceFeatures::empty());
1431 assert_eq!(invoice.signing_pubkey(), recipient_pubkey());
1433 let message = TaggedHash::new(SIGNATURE_TAG, &invoice.bytes);
1434 assert!(merkle::verify_signature(&invoice.signature, message, recipient_pubkey()).is_ok());
1436 let digest = Message::from_slice(&invoice.signable_hash()).unwrap();
1437 let pubkey = recipient_pubkey().into();
1438 let secp_ctx = Secp256k1::verification_only();
1439 assert!(secp_ctx.verify_schnorr(&invoice.signature, &digest, &pubkey).is_ok());
1442 invoice.as_tlv_stream(),
1444 PayerTlvStreamRef { metadata: Some(&vec![1; 32]) },
1450 description: Some(&String::from("foo")),
1452 absolute_expiry: None,
1456 node_id: Some(&recipient_pubkey()),
1458 InvoiceRequestTlvStreamRef {
1463 payer_id: Some(&payer_pubkey()),
1466 InvoiceTlvStreamRef {
1467 paths: Some(Iterable(payment_paths.iter().map(|(_, path)| path))),
1468 blindedpay: Some(Iterable(payment_paths.iter().map(|(payinfo, _)| payinfo))),
1469 created_at: Some(now.as_secs()),
1470 relative_expiry: None,
1471 payment_hash: Some(&payment_hash),
1475 node_id: Some(&recipient_pubkey()),
1477 SignatureTlvStreamRef { signature: Some(&invoice.signature()) },
1481 if let Err(e) = Bolt12Invoice::try_from(buffer) {
1482 panic!("error parsing invoice: {:?}", e);
1487 fn builds_invoice_for_refund_with_defaults() {
1488 let payment_paths = payment_paths();
1489 let payment_hash = payment_hash();
1491 let invoice = RefundBuilder::new("foo".into(), vec![1; 32], payer_pubkey(), 1000).unwrap()
1493 .respond_with_no_std(payment_paths.clone(), payment_hash, recipient_pubkey(), now)
1496 .sign(recipient_sign).unwrap();
1498 let mut buffer = Vec::new();
1499 invoice.write(&mut buffer).unwrap();
1501 assert_eq!(invoice.bytes, buffer.as_slice());
1502 assert_eq!(invoice.payer_metadata(), &[1; 32]);
1503 assert_eq!(invoice.offer_chains(), None);
1504 assert_eq!(invoice.metadata(), None);
1505 assert_eq!(invoice.amount(), None);
1506 assert_eq!(invoice.description(), PrintableString("foo"));
1507 assert_eq!(invoice.offer_features(), None);
1508 assert_eq!(invoice.absolute_expiry(), None);
1509 assert_eq!(invoice.message_paths(), &[]);
1510 assert_eq!(invoice.issuer(), None);
1511 assert_eq!(invoice.supported_quantity(), None);
1512 assert_eq!(invoice.signing_pubkey(), recipient_pubkey());
1513 assert_eq!(invoice.chain(), ChainHash::using_genesis_block(Network::Bitcoin));
1514 assert_eq!(invoice.amount_msats(), 1000);
1515 assert_eq!(invoice.invoice_request_features(), &InvoiceRequestFeatures::empty());
1516 assert_eq!(invoice.quantity(), None);
1517 assert_eq!(invoice.payer_id(), payer_pubkey());
1518 assert_eq!(invoice.payer_note(), None);
1519 assert_eq!(invoice.payment_paths(), payment_paths.as_slice());
1520 assert_eq!(invoice.created_at(), now);
1521 assert_eq!(invoice.relative_expiry(), DEFAULT_RELATIVE_EXPIRY);
1522 #[cfg(feature = "std")]
1523 assert!(!invoice.is_expired());
1524 assert_eq!(invoice.payment_hash(), payment_hash);
1525 assert_eq!(invoice.amount_msats(), 1000);
1526 assert_eq!(invoice.fallbacks(), vec![]);
1527 assert_eq!(invoice.invoice_features(), &Bolt12InvoiceFeatures::empty());
1528 assert_eq!(invoice.signing_pubkey(), recipient_pubkey());
1530 let message = TaggedHash::new(SIGNATURE_TAG, &invoice.bytes);
1531 assert!(merkle::verify_signature(&invoice.signature, message, recipient_pubkey()).is_ok());
1534 invoice.as_tlv_stream(),
1536 PayerTlvStreamRef { metadata: Some(&vec![1; 32]) },
1542 description: Some(&String::from("foo")),
1544 absolute_expiry: None,
1550 InvoiceRequestTlvStreamRef {
1555 payer_id: Some(&payer_pubkey()),
1558 InvoiceTlvStreamRef {
1559 paths: Some(Iterable(payment_paths.iter().map(|(_, path)| path))),
1560 blindedpay: Some(Iterable(payment_paths.iter().map(|(payinfo, _)| payinfo))),
1561 created_at: Some(now.as_secs()),
1562 relative_expiry: None,
1563 payment_hash: Some(&payment_hash),
1567 node_id: Some(&recipient_pubkey()),
1569 SignatureTlvStreamRef { signature: Some(&invoice.signature()) },
1573 if let Err(e) = Bolt12Invoice::try_from(buffer) {
1574 panic!("error parsing invoice: {:?}", e);
1578 #[cfg(feature = "std")]
1580 fn builds_invoice_from_offer_with_expiration() {
1581 let future_expiry = Duration::from_secs(u64::max_value());
1582 let past_expiry = Duration::from_secs(0);
1584 if let Err(e) = OfferBuilder::new("foo".into(), recipient_pubkey())
1586 .absolute_expiry(future_expiry)
1588 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1590 .sign(payer_sign).unwrap()
1591 .respond_with(payment_paths(), payment_hash())
1595 panic!("error building invoice: {:?}", e);
1598 match OfferBuilder::new("foo".into(), recipient_pubkey())
1600 .absolute_expiry(past_expiry)
1602 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1604 .sign(payer_sign).unwrap()
1605 .respond_with(payment_paths(), payment_hash())
1609 Ok(_) => panic!("expected error"),
1610 Err(e) => assert_eq!(e, Bolt12SemanticError::AlreadyExpired),
1614 #[cfg(feature = "std")]
1616 fn builds_invoice_from_refund_with_expiration() {
1617 let future_expiry = Duration::from_secs(u64::max_value());
1618 let past_expiry = Duration::from_secs(0);
1620 if let Err(e) = RefundBuilder::new("foo".into(), vec![1; 32], payer_pubkey(), 1000).unwrap()
1621 .absolute_expiry(future_expiry)
1623 .respond_with(payment_paths(), payment_hash(), recipient_pubkey())
1627 panic!("error building invoice: {:?}", e);
1630 match RefundBuilder::new("foo".into(), vec![1; 32], payer_pubkey(), 1000).unwrap()
1631 .absolute_expiry(past_expiry)
1633 .respond_with(payment_paths(), payment_hash(), recipient_pubkey())
1637 Ok(_) => panic!("expected error"),
1638 Err(e) => assert_eq!(e, Bolt12SemanticError::AlreadyExpired),
1643 fn builds_invoice_from_offer_using_derived_keys() {
1644 let desc = "foo".to_string();
1645 let node_id = recipient_pubkey();
1646 let expanded_key = ExpandedKey::new(&KeyMaterial([42; 32]));
1647 let entropy = FixedEntropy {};
1648 let secp_ctx = Secp256k1::new();
1650 let blinded_path = BlindedPath {
1651 introduction_node_id: pubkey(40),
1652 blinding_point: pubkey(41),
1654 BlindedHop { blinded_node_id: pubkey(42), encrypted_payload: vec![0; 43] },
1655 BlindedHop { blinded_node_id: node_id, encrypted_payload: vec![0; 44] },
1659 let offer = OfferBuilder
1660 ::deriving_signing_pubkey(desc, node_id, &expanded_key, &entropy, &secp_ctx)
1664 let invoice_request = offer.request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1666 .sign(payer_sign).unwrap();
1668 if let Err(e) = invoice_request.clone()
1669 .verify(&expanded_key, &secp_ctx).unwrap()
1670 .respond_using_derived_keys_no_std(payment_paths(), payment_hash(), now()).unwrap()
1671 .build_and_sign(&secp_ctx)
1673 panic!("error building invoice: {:?}", e);
1676 let expanded_key = ExpandedKey::new(&KeyMaterial([41; 32]));
1677 assert!(invoice_request.verify(&expanded_key, &secp_ctx).is_err());
1679 let desc = "foo".to_string();
1680 let offer = OfferBuilder
1681 ::deriving_signing_pubkey(desc, node_id, &expanded_key, &entropy, &secp_ctx)
1683 // Omit the path so that node_id is used for the signing pubkey instead of deriving
1685 let invoice_request = offer.request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1687 .sign(payer_sign).unwrap();
1689 match invoice_request
1690 .verify(&expanded_key, &secp_ctx).unwrap()
1691 .respond_using_derived_keys_no_std(payment_paths(), payment_hash(), now())
1693 Ok(_) => panic!("expected error"),
1694 Err(e) => assert_eq!(e, Bolt12SemanticError::InvalidMetadata),
1699 fn builds_invoice_from_refund_using_derived_keys() {
1700 let expanded_key = ExpandedKey::new(&KeyMaterial([42; 32]));
1701 let entropy = FixedEntropy {};
1702 let secp_ctx = Secp256k1::new();
1704 let refund = RefundBuilder::new("foo".into(), vec![1; 32], payer_pubkey(), 1000).unwrap()
1707 if let Err(e) = refund
1708 .respond_using_derived_keys_no_std(
1709 payment_paths(), payment_hash(), now(), &expanded_key, &entropy
1712 .build_and_sign(&secp_ctx)
1714 panic!("error building invoice: {:?}", e);
1719 fn builds_invoice_with_relative_expiry() {
1721 let one_hour = Duration::from_secs(3600);
1723 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
1726 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1728 .sign(payer_sign).unwrap()
1729 .respond_with_no_std(payment_paths(), payment_hash(), now).unwrap()
1730 .relative_expiry(one_hour.as_secs() as u32)
1732 .sign(recipient_sign).unwrap();
1733 let (_, _, _, tlv_stream, _) = invoice.as_tlv_stream();
1734 #[cfg(feature = "std")]
1735 assert!(!invoice.is_expired());
1736 assert_eq!(invoice.relative_expiry(), one_hour);
1737 assert_eq!(tlv_stream.relative_expiry, Some(one_hour.as_secs() as u32));
1739 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
1742 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1744 .sign(payer_sign).unwrap()
1745 .respond_with_no_std(payment_paths(), payment_hash(), now - one_hour).unwrap()
1746 .relative_expiry(one_hour.as_secs() as u32 - 1)
1748 .sign(recipient_sign).unwrap();
1749 let (_, _, _, tlv_stream, _) = invoice.as_tlv_stream();
1750 #[cfg(feature = "std")]
1751 assert!(invoice.is_expired());
1752 assert_eq!(invoice.relative_expiry(), one_hour - Duration::from_secs(1));
1753 assert_eq!(tlv_stream.relative_expiry, Some(one_hour.as_secs() as u32 - 1));
1757 fn builds_invoice_with_amount_from_request() {
1758 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
1761 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1762 .amount_msats(1001).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(), 1001);
1770 assert_eq!(tlv_stream.amount, Some(1001));
1774 fn builds_invoice_with_quantity_from_request() {
1775 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
1777 .supported_quantity(Quantity::Unbounded)
1779 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1780 .quantity(2).unwrap()
1782 .sign(payer_sign).unwrap()
1783 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
1785 .sign(recipient_sign).unwrap();
1786 let (_, _, _, tlv_stream, _) = invoice.as_tlv_stream();
1787 assert_eq!(invoice.amount_msats(), 2000);
1788 assert_eq!(tlv_stream.amount, Some(2000));
1790 match OfferBuilder::new("foo".into(), recipient_pubkey())
1792 .supported_quantity(Quantity::Unbounded)
1794 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1795 .quantity(u64::max_value()).unwrap()
1797 .sign(payer_sign).unwrap()
1798 .respond_with_no_std(payment_paths(), payment_hash(), now())
1800 Ok(_) => panic!("expected error"),
1801 Err(e) => assert_eq!(e, Bolt12SemanticError::InvalidAmount),
1806 fn builds_invoice_with_fallback_address() {
1807 let script = Script::new();
1808 let pubkey = bitcoin::util::key::PublicKey::new(recipient_pubkey());
1809 let x_only_pubkey = XOnlyPublicKey::from_keypair(&recipient_keys()).0;
1810 let tweaked_pubkey = TweakedPublicKey::dangerous_assume_tweaked(x_only_pubkey);
1812 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
1815 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1817 .sign(payer_sign).unwrap()
1818 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
1819 .fallback_v0_p2wsh(&script.wscript_hash())
1820 .fallback_v0_p2wpkh(&pubkey.wpubkey_hash().unwrap())
1821 .fallback_v1_p2tr_tweaked(&tweaked_pubkey)
1823 .sign(recipient_sign).unwrap();
1824 let (_, _, _, tlv_stream, _) = invoice.as_tlv_stream();
1826 invoice.fallbacks(),
1828 Address::p2wsh(&script, Network::Bitcoin),
1829 Address::p2wpkh(&pubkey, Network::Bitcoin).unwrap(),
1830 Address::p2tr_tweaked(tweaked_pubkey, Network::Bitcoin),
1834 tlv_stream.fallbacks,
1837 version: WitnessVersion::V0.to_num(),
1838 program: Vec::from(&script.wscript_hash().into_inner()[..]),
1841 version: WitnessVersion::V0.to_num(),
1842 program: Vec::from(&pubkey.wpubkey_hash().unwrap().into_inner()[..]),
1845 version: WitnessVersion::V1.to_num(),
1846 program: Vec::from(&tweaked_pubkey.serialize()[..]),
1853 fn builds_invoice_with_allow_mpp() {
1854 let mut features = Bolt12InvoiceFeatures::empty();
1855 features.set_basic_mpp_optional();
1857 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
1860 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1862 .sign(payer_sign).unwrap()
1863 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
1866 .sign(recipient_sign).unwrap();
1867 let (_, _, _, tlv_stream, _) = invoice.as_tlv_stream();
1868 assert_eq!(invoice.invoice_features(), &features);
1869 assert_eq!(tlv_stream.features, Some(&features));
1873 fn fails_signing_invoice() {
1874 match OfferBuilder::new("foo".into(), recipient_pubkey())
1877 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1879 .sign(payer_sign).unwrap()
1880 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
1884 Ok(_) => panic!("expected error"),
1885 Err(e) => assert_eq!(e, SignError::Signing(())),
1888 match OfferBuilder::new("foo".into(), recipient_pubkey())
1891 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1893 .sign(payer_sign).unwrap()
1894 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
1898 Ok(_) => panic!("expected error"),
1899 Err(e) => assert_eq!(e, SignError::Verification(secp256k1::Error::InvalidSignature)),
1904 fn parses_invoice_with_payment_paths() {
1905 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
1908 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1910 .sign(payer_sign).unwrap()
1911 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
1913 .sign(recipient_sign).unwrap();
1915 let mut buffer = Vec::new();
1916 invoice.write(&mut buffer).unwrap();
1918 if let Err(e) = Bolt12Invoice::try_from(buffer) {
1919 panic!("error parsing invoice: {:?}", e);
1922 let mut tlv_stream = invoice.as_tlv_stream();
1923 tlv_stream.3.paths = None;
1925 match Bolt12Invoice::try_from(tlv_stream.to_bytes()) {
1926 Ok(_) => panic!("expected error"),
1927 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingPaths)),
1930 let mut tlv_stream = invoice.as_tlv_stream();
1931 tlv_stream.3.blindedpay = None;
1933 match Bolt12Invoice::try_from(tlv_stream.to_bytes()) {
1934 Ok(_) => panic!("expected error"),
1935 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::InvalidPayInfo)),
1938 let empty_payment_paths = vec![];
1939 let mut tlv_stream = invoice.as_tlv_stream();
1940 tlv_stream.3.paths = Some(Iterable(empty_payment_paths.iter().map(|(_, path)| path)));
1942 match Bolt12Invoice::try_from(tlv_stream.to_bytes()) {
1943 Ok(_) => panic!("expected error"),
1944 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingPaths)),
1947 let mut payment_paths = payment_paths();
1948 payment_paths.pop();
1949 let mut tlv_stream = invoice.as_tlv_stream();
1950 tlv_stream.3.blindedpay = Some(Iterable(payment_paths.iter().map(|(payinfo, _)| payinfo)));
1952 match Bolt12Invoice::try_from(tlv_stream.to_bytes()) {
1953 Ok(_) => panic!("expected error"),
1954 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::InvalidPayInfo)),
1959 fn parses_invoice_with_created_at() {
1960 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
1963 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1965 .sign(payer_sign).unwrap()
1966 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
1968 .sign(recipient_sign).unwrap();
1970 let mut buffer = Vec::new();
1971 invoice.write(&mut buffer).unwrap();
1973 if let Err(e) = Bolt12Invoice::try_from(buffer) {
1974 panic!("error parsing invoice: {:?}", e);
1977 let mut tlv_stream = invoice.as_tlv_stream();
1978 tlv_stream.3.created_at = None;
1980 match Bolt12Invoice::try_from(tlv_stream.to_bytes()) {
1981 Ok(_) => panic!("expected error"),
1983 assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingCreationTime));
1989 fn parses_invoice_with_relative_expiry() {
1990 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
1993 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1995 .sign(payer_sign).unwrap()
1996 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
1997 .relative_expiry(3600)
1999 .sign(recipient_sign).unwrap();
2001 let mut buffer = Vec::new();
2002 invoice.write(&mut buffer).unwrap();
2004 match Bolt12Invoice::try_from(buffer) {
2005 Ok(invoice) => assert_eq!(invoice.relative_expiry(), Duration::from_secs(3600)),
2006 Err(e) => panic!("error parsing invoice: {:?}", e),
2011 fn parses_invoice_with_payment_hash() {
2012 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
2015 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2017 .sign(payer_sign).unwrap()
2018 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2020 .sign(recipient_sign).unwrap();
2022 let mut buffer = Vec::new();
2023 invoice.write(&mut buffer).unwrap();
2025 if let Err(e) = Bolt12Invoice::try_from(buffer) {
2026 panic!("error parsing invoice: {:?}", e);
2029 let mut tlv_stream = invoice.as_tlv_stream();
2030 tlv_stream.3.payment_hash = None;
2032 match Bolt12Invoice::try_from(tlv_stream.to_bytes()) {
2033 Ok(_) => panic!("expected error"),
2035 assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingPaymentHash));
2041 fn parses_invoice_with_amount() {
2042 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
2045 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2047 .sign(payer_sign).unwrap()
2048 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2050 .sign(recipient_sign).unwrap();
2052 let mut buffer = Vec::new();
2053 invoice.write(&mut buffer).unwrap();
2055 if let Err(e) = Bolt12Invoice::try_from(buffer) {
2056 panic!("error parsing invoice: {:?}", e);
2059 let mut tlv_stream = invoice.as_tlv_stream();
2060 tlv_stream.3.amount = None;
2062 match Bolt12Invoice::try_from(tlv_stream.to_bytes()) {
2063 Ok(_) => panic!("expected error"),
2064 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingAmount)),
2069 fn parses_invoice_with_allow_mpp() {
2070 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
2073 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2075 .sign(payer_sign).unwrap()
2076 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2079 .sign(recipient_sign).unwrap();
2081 let mut buffer = Vec::new();
2082 invoice.write(&mut buffer).unwrap();
2084 match Bolt12Invoice::try_from(buffer) {
2086 let mut features = Bolt12InvoiceFeatures::empty();
2087 features.set_basic_mpp_optional();
2088 assert_eq!(invoice.invoice_features(), &features);
2090 Err(e) => panic!("error parsing invoice: {:?}", e),
2095 fn parses_invoice_with_fallback_address() {
2096 let script = Script::new();
2097 let pubkey = bitcoin::util::key::PublicKey::new(recipient_pubkey());
2098 let x_only_pubkey = XOnlyPublicKey::from_keypair(&recipient_keys()).0;
2099 let tweaked_pubkey = TweakedPublicKey::dangerous_assume_tweaked(x_only_pubkey);
2101 let offer = OfferBuilder::new("foo".into(), recipient_pubkey())
2104 let invoice_request = offer
2105 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2107 .sign(payer_sign).unwrap();
2108 let mut invoice_builder = invoice_request
2109 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2110 .fallback_v0_p2wsh(&script.wscript_hash())
2111 .fallback_v0_p2wpkh(&pubkey.wpubkey_hash().unwrap())
2112 .fallback_v1_p2tr_tweaked(&tweaked_pubkey);
2114 // Only standard addresses will be included.
2115 let fallbacks = invoice_builder.invoice.fields_mut().fallbacks.as_mut().unwrap();
2116 // Non-standard addresses
2117 fallbacks.push(FallbackAddress { version: 1, program: vec![0u8; 41] });
2118 fallbacks.push(FallbackAddress { version: 2, program: vec![0u8; 1] });
2119 fallbacks.push(FallbackAddress { version: 17, program: vec![0u8; 40] });
2121 fallbacks.push(FallbackAddress { version: 1, program: vec![0u8; 33] });
2122 fallbacks.push(FallbackAddress { version: 2, program: vec![0u8; 40] });
2124 let invoice = invoice_builder.build().unwrap().sign(recipient_sign).unwrap();
2125 let mut buffer = Vec::new();
2126 invoice.write(&mut buffer).unwrap();
2128 match Bolt12Invoice::try_from(buffer) {
2131 invoice.fallbacks(),
2133 Address::p2wsh(&script, Network::Bitcoin),
2134 Address::p2wpkh(&pubkey, Network::Bitcoin).unwrap(),
2135 Address::p2tr_tweaked(tweaked_pubkey, Network::Bitcoin),
2137 payload: Payload::WitnessProgram {
2138 version: WitnessVersion::V1,
2139 program: vec![0u8; 33],
2141 network: Network::Bitcoin,
2144 payload: Payload::WitnessProgram {
2145 version: WitnessVersion::V2,
2146 program: vec![0u8; 40],
2148 network: Network::Bitcoin,
2153 Err(e) => panic!("error parsing invoice: {:?}", e),
2158 fn parses_invoice_with_node_id() {
2159 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
2162 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2164 .sign(payer_sign).unwrap()
2165 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2167 .sign(recipient_sign).unwrap();
2169 let mut buffer = Vec::new();
2170 invoice.write(&mut buffer).unwrap();
2172 if let Err(e) = Bolt12Invoice::try_from(buffer) {
2173 panic!("error parsing invoice: {:?}", e);
2176 let mut tlv_stream = invoice.as_tlv_stream();
2177 tlv_stream.3.node_id = None;
2179 match Bolt12Invoice::try_from(tlv_stream.to_bytes()) {
2180 Ok(_) => panic!("expected error"),
2182 assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingSigningPubkey));
2186 let invalid_pubkey = payer_pubkey();
2187 let mut tlv_stream = invoice.as_tlv_stream();
2188 tlv_stream.3.node_id = Some(&invalid_pubkey);
2190 match Bolt12Invoice::try_from(tlv_stream.to_bytes()) {
2191 Ok(_) => panic!("expected error"),
2193 assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::InvalidSigningPubkey));
2199 fn fails_parsing_invoice_without_signature() {
2200 let mut buffer = Vec::new();
2201 OfferBuilder::new("foo".into(), recipient_pubkey())
2204 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2206 .sign(payer_sign).unwrap()
2207 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2210 .write(&mut buffer).unwrap();
2212 match Bolt12Invoice::try_from(buffer) {
2213 Ok(_) => panic!("expected error"),
2214 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingSignature)),
2219 fn fails_parsing_invoice_with_invalid_signature() {
2220 let mut invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
2223 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2225 .sign(payer_sign).unwrap()
2226 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2228 .sign(recipient_sign).unwrap();
2229 let last_signature_byte = invoice.bytes.last_mut().unwrap();
2230 *last_signature_byte = last_signature_byte.wrapping_add(1);
2232 let mut buffer = Vec::new();
2233 invoice.write(&mut buffer).unwrap();
2235 match Bolt12Invoice::try_from(buffer) {
2236 Ok(_) => panic!("expected error"),
2238 assert_eq!(e, Bolt12ParseError::InvalidSignature(secp256k1::Error::InvalidSignature));
2244 fn fails_parsing_invoice_with_extra_tlv_records() {
2245 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
2248 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2250 .sign(payer_sign).unwrap()
2251 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2253 .sign(recipient_sign).unwrap();
2255 let mut encoded_invoice = Vec::new();
2256 invoice.write(&mut encoded_invoice).unwrap();
2257 BigSize(1002).write(&mut encoded_invoice).unwrap();
2258 BigSize(32).write(&mut encoded_invoice).unwrap();
2259 [42u8; 32].write(&mut encoded_invoice).unwrap();
2261 match Bolt12Invoice::try_from(encoded_invoice) {
2262 Ok(_) => panic!("expected error"),
2263 Err(e) => assert_eq!(e, Bolt12ParseError::Decode(DecodeError::InvalidValue)),