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 `offer` messages.
12 //! An [`Offer`] represents an "offer to be paid." It is typically constructed by a merchant and
13 //! published as a QR code to be scanned by a customer. The customer uses the offer to request an
14 //! invoice from the merchant to be paid.
17 //! extern crate bitcoin;
18 //! extern crate core;
19 //! extern crate lightning;
21 //! use core::convert::TryFrom;
22 //! use core::num::NonZeroU64;
23 //! use core::time::Duration;
25 //! use bitcoin::secp256k1::{KeyPair, PublicKey, Secp256k1, SecretKey};
26 //! use lightning::offers::offer::{Offer, OfferBuilder, Quantity};
27 //! use lightning::offers::parse::Bolt12ParseError;
28 //! use lightning::util::ser::{Readable, Writeable};
30 //! # use lightning::blinded_path::BlindedPath;
31 //! # #[cfg(feature = "std")]
32 //! # use std::time::SystemTime;
34 //! # fn create_blinded_path() -> BlindedPath { unimplemented!() }
35 //! # fn create_another_blinded_path() -> BlindedPath { unimplemented!() }
37 //! # #[cfg(feature = "std")]
38 //! # fn build() -> Result<(), Bolt12ParseError> {
39 //! let secp_ctx = Secp256k1::new();
40 //! let keys = KeyPair::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
41 //! let pubkey = PublicKey::from(keys);
43 //! let expiration = SystemTime::now() + Duration::from_secs(24 * 60 * 60);
44 //! let offer = OfferBuilder::new("coffee, large".to_string(), pubkey)
45 //! .amount_msats(20_000)
46 //! .supported_quantity(Quantity::Unbounded)
47 //! .absolute_expiry(expiration.duration_since(SystemTime::UNIX_EPOCH).unwrap())
48 //! .issuer("Foo Bar".to_string())
49 //! .path(create_blinded_path())
50 //! .path(create_another_blinded_path())
53 //! // Encode as a bech32 string for use in a QR code.
54 //! let encoded_offer = offer.to_string();
56 //! // Parse from a bech32 string after scanning from a QR code.
57 //! let offer = encoded_offer.parse::<Offer>()?;
59 //! // Encode offer as raw bytes.
60 //! let mut bytes = Vec::new();
61 //! offer.write(&mut bytes).unwrap();
63 //! // Decode raw bytes into an offer.
64 //! let offer = Offer::try_from(bytes)?;
69 use bitcoin::blockdata::constants::ChainHash;
70 use bitcoin::network::constants::Network;
71 use bitcoin::secp256k1::{KeyPair, PublicKey, Secp256k1, self};
72 use core::convert::TryFrom;
73 use core::num::NonZeroU64;
75 use core::str::FromStr;
76 use core::time::Duration;
77 use crate::sign::EntropySource;
79 use crate::blinded_path::BlindedPath;
80 use crate::ln::features::OfferFeatures;
81 use crate::ln::inbound_payment::{ExpandedKey, IV_LEN, Nonce};
82 use crate::ln::msgs::MAX_VALUE_MSAT;
83 use crate::offers::invoice_request::{DerivedPayerId, ExplicitPayerId, InvoiceRequestBuilder};
84 use crate::offers::merkle::TlvStream;
85 use crate::offers::parse::{Bech32Encode, Bolt12ParseError, Bolt12SemanticError, ParsedMessage};
86 use crate::offers::signer::{Metadata, MetadataMaterial, self};
87 use crate::util::ser::{HighZeroBytesDroppedBigSize, WithoutLength, Writeable, Writer};
88 use crate::util::string::PrintableString;
90 use crate::prelude::*;
92 #[cfg(feature = "std")]
93 use std::time::SystemTime;
95 pub(super) const IV_BYTES: &[u8; IV_LEN] = b"LDK Offer ~~~~~~";
97 /// Builds an [`Offer`] for the "offer to be paid" flow.
99 /// See [module-level documentation] for usage.
101 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
103 /// [module-level documentation]: self
104 pub struct OfferBuilder<'a, M: MetadataStrategy, T: secp256k1::Signing> {
105 offer: OfferContents,
106 metadata_strategy: core::marker::PhantomData<M>,
107 secp_ctx: Option<&'a Secp256k1<T>>,
110 /// Indicates how [`Offer::metadata`] may be set.
112 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
113 pub trait MetadataStrategy {}
115 /// [`Offer::metadata`] may be explicitly set or left empty.
117 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
118 pub struct ExplicitMetadata {}
120 /// [`Offer::metadata`] will be derived.
122 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
123 pub struct DerivedMetadata {}
125 impl MetadataStrategy for ExplicitMetadata {}
126 impl MetadataStrategy for DerivedMetadata {}
128 impl<'a> OfferBuilder<'a, ExplicitMetadata, secp256k1::SignOnly> {
129 /// Creates a new builder for an offer setting the [`Offer::description`] and using the
130 /// [`Offer::signing_pubkey`] for signing invoices. The associated secret key must be remembered
131 /// while the offer is valid.
133 /// Use a different pubkey per offer to avoid correlating offers.
134 pub fn new(description: String, signing_pubkey: PublicKey) -> Self {
136 offer: OfferContents {
137 chains: None, metadata: None, amount: None, description,
138 features: OfferFeatures::empty(), absolute_expiry: None, issuer: None, paths: None,
139 supported_quantity: Quantity::One, signing_pubkey,
141 metadata_strategy: core::marker::PhantomData,
146 /// Sets the [`Offer::metadata`] to the given bytes.
148 /// Successive calls to this method will override the previous setting.
149 pub fn metadata(mut self, metadata: Vec<u8>) -> Result<Self, Bolt12SemanticError> {
150 self.offer.metadata = Some(Metadata::Bytes(metadata));
155 impl<'a, T: secp256k1::Signing> OfferBuilder<'a, DerivedMetadata, T> {
156 /// Similar to [`OfferBuilder::new`] except, if [`OfferBuilder::path`] is called, the signing
157 /// pubkey is derived from the given [`ExpandedKey`] and [`EntropySource`]. This provides
158 /// recipient privacy by using a different signing pubkey for each offer. Otherwise, the
159 /// provided `node_id` is used for the signing pubkey.
161 /// Also, sets the metadata when [`OfferBuilder::build`] is called such that it can be used by
162 /// [`InvoiceRequest::verify`] to determine if the request was produced for the offer given an
165 /// [`InvoiceRequest::verify`]: crate::offers::invoice_request::InvoiceRequest::verify
166 /// [`ExpandedKey`]: crate::ln::inbound_payment::ExpandedKey
167 pub fn deriving_signing_pubkey<ES: Deref>(
168 description: String, node_id: PublicKey, expanded_key: &ExpandedKey, entropy_source: ES,
169 secp_ctx: &'a Secp256k1<T>
170 ) -> Self where ES::Target: EntropySource {
171 let nonce = Nonce::from_entropy_source(entropy_source);
172 let derivation_material = MetadataMaterial::new(nonce, expanded_key, IV_BYTES);
173 let metadata = Metadata::DerivedSigningPubkey(derivation_material);
175 offer: OfferContents {
176 chains: None, metadata: Some(metadata), amount: None, description,
177 features: OfferFeatures::empty(), absolute_expiry: None, issuer: None, paths: None,
178 supported_quantity: Quantity::One, signing_pubkey: node_id,
180 metadata_strategy: core::marker::PhantomData,
181 secp_ctx: Some(secp_ctx),
186 impl<'a, M: MetadataStrategy, T: secp256k1::Signing> OfferBuilder<'a, M, T> {
187 /// Adds the chain hash of the given [`Network`] to [`Offer::chains`]. If not called,
188 /// the chain hash of [`Network::Bitcoin`] is assumed to be the only one supported.
190 /// See [`Offer::chains`] on how this relates to the payment currency.
192 /// Successive calls to this method will add another chain hash.
193 pub fn chain(mut self, network: Network) -> Self {
194 let chains = self.offer.chains.get_or_insert_with(Vec::new);
195 let chain = ChainHash::using_genesis_block(network);
196 if !chains.contains(&chain) {
203 /// Sets the [`Offer::amount`] as an [`Amount::Bitcoin`].
205 /// Successive calls to this method will override the previous setting.
206 pub fn amount_msats(self, amount_msats: u64) -> Self {
207 self.amount(Amount::Bitcoin { amount_msats })
210 /// Sets the [`Offer::amount`].
212 /// Successive calls to this method will override the previous setting.
213 pub(super) fn amount(mut self, amount: Amount) -> Self {
214 self.offer.amount = Some(amount);
218 /// Sets the [`Offer::absolute_expiry`] as seconds since the Unix epoch. Any expiry that has
219 /// already passed is valid and can be checked for using [`Offer::is_expired`].
221 /// Successive calls to this method will override the previous setting.
222 pub fn absolute_expiry(mut self, absolute_expiry: Duration) -> Self {
223 self.offer.absolute_expiry = Some(absolute_expiry);
227 /// Sets the [`Offer::issuer`].
229 /// Successive calls to this method will override the previous setting.
230 pub fn issuer(mut self, issuer: String) -> Self {
231 self.offer.issuer = Some(issuer);
235 /// Adds a blinded path to [`Offer::paths`]. Must include at least one path if only connected by
236 /// private channels or if [`Offer::signing_pubkey`] is not a public node id.
238 /// Successive calls to this method will add another blinded path. Caller is responsible for not
239 /// adding duplicate paths.
240 pub fn path(mut self, path: BlindedPath) -> Self {
241 self.offer.paths.get_or_insert_with(Vec::new).push(path);
245 /// Sets the quantity of items for [`Offer::supported_quantity`]. If not called, defaults to
246 /// [`Quantity::One`].
248 /// Successive calls to this method will override the previous setting.
249 pub fn supported_quantity(mut self, quantity: Quantity) -> Self {
250 self.offer.supported_quantity = quantity;
254 /// Builds an [`Offer`] from the builder's settings.
255 pub fn build(mut self) -> Result<Offer, Bolt12SemanticError> {
256 match self.offer.amount {
257 Some(Amount::Bitcoin { amount_msats }) => {
258 if amount_msats > MAX_VALUE_MSAT {
259 return Err(Bolt12SemanticError::InvalidAmount);
262 Some(Amount::Currency { .. }) => return Err(Bolt12SemanticError::UnsupportedCurrency),
266 if let Some(chains) = &self.offer.chains {
267 if chains.len() == 1 && chains[0] == self.offer.implied_chain() {
268 self.offer.chains = None;
272 Ok(self.build_without_checks())
275 fn build_without_checks(mut self) -> Offer {
276 // Create the metadata for stateless verification of an InvoiceRequest.
277 if let Some(mut metadata) = self.offer.metadata.take() {
278 if metadata.has_derivation_material() {
279 if self.offer.paths.is_none() {
280 metadata = metadata.without_keys();
283 let mut tlv_stream = self.offer.as_tlv_stream();
284 debug_assert_eq!(tlv_stream.metadata, None);
285 tlv_stream.metadata = None;
286 if metadata.derives_keys() {
287 tlv_stream.node_id = None;
290 let (derived_metadata, keys) = metadata.derive_from(tlv_stream, self.secp_ctx);
291 metadata = derived_metadata;
292 if let Some(keys) = keys {
293 self.offer.signing_pubkey = keys.public_key();
297 self.offer.metadata = Some(metadata);
300 let mut bytes = Vec::new();
301 self.offer.write(&mut bytes).unwrap();
303 Offer { bytes, contents: self.offer }
308 impl<'a, M: MetadataStrategy, T: secp256k1::Signing> OfferBuilder<'a, M, T> {
309 fn features_unchecked(mut self, features: OfferFeatures) -> Self {
310 self.offer.features = features;
314 pub(super) fn build_unchecked(self) -> Offer {
315 self.build_without_checks()
319 /// An `Offer` is a potentially long-lived proposal for payment of a good or service.
321 /// An offer is a precursor to an [`InvoiceRequest`]. A merchant publishes an offer from which a
322 /// customer may request an [`Bolt12Invoice`] for a specific quantity and using an amount sufficient
323 /// to cover that quantity (i.e., at least `quantity * amount`). See [`Offer::amount`].
325 /// Offers may be denominated in currency other than bitcoin but are ultimately paid using the
328 /// Through the use of [`BlindedPath`]s, offers provide recipient privacy.
330 /// [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
331 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
332 #[derive(Clone, Debug)]
333 #[cfg_attr(test, derive(PartialEq))]
335 // The serialized offer. Needed when creating an `InvoiceRequest` if the offer contains unknown
337 pub(super) bytes: Vec<u8>,
338 pub(super) contents: OfferContents,
341 /// The contents of an [`Offer`], which may be shared with an [`InvoiceRequest`] or a
342 /// [`Bolt12Invoice`].
344 /// [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
345 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
346 #[derive(Clone, Debug)]
347 #[cfg_attr(test, derive(PartialEq))]
348 pub(super) struct OfferContents {
349 chains: Option<Vec<ChainHash>>,
350 metadata: Option<Metadata>,
351 amount: Option<Amount>,
353 features: OfferFeatures,
354 absolute_expiry: Option<Duration>,
355 issuer: Option<String>,
356 paths: Option<Vec<BlindedPath>>,
357 supported_quantity: Quantity,
358 signing_pubkey: PublicKey,
362 // TODO: Return a slice once ChainHash has constants.
363 // - https://github.com/rust-bitcoin/rust-bitcoin/pull/1283
364 // - https://github.com/rust-bitcoin/rust-bitcoin/pull/1286
365 /// The chains that may be used when paying a requested invoice (e.g., bitcoin mainnet).
366 /// Payments must be denominated in units of the minimal lightning-payable unit (e.g., msats)
367 /// for the selected chain.
368 pub fn chains(&self) -> Vec<ChainHash> {
369 self.contents.chains()
372 pub(super) fn implied_chain(&self) -> ChainHash {
373 self.contents.implied_chain()
376 /// Returns whether the given chain is supported by the offer.
377 pub fn supports_chain(&self, chain: ChainHash) -> bool {
378 self.contents.supports_chain(chain)
381 // TODO: Link to corresponding method in `InvoiceRequest`.
382 /// Opaque bytes set by the originator. Useful for authentication and validating fields since it
383 /// is reflected in `invoice_request` messages along with all the other fields from the `offer`.
384 pub fn metadata(&self) -> Option<&Vec<u8>> {
385 self.contents.metadata()
388 /// The minimum amount required for a successful payment of a single item.
389 pub fn amount(&self) -> Option<&Amount> {
390 self.contents.amount()
393 /// A complete description of the purpose of the payment. Intended to be displayed to the user
394 /// but with the caveat that it has not been verified in any way.
395 pub fn description(&self) -> PrintableString {
396 self.contents.description()
399 /// Features pertaining to the offer.
400 pub fn features(&self) -> &OfferFeatures {
401 &self.contents.features
404 /// Duration since the Unix epoch when an invoice should no longer be requested.
406 /// If `None`, the offer does not expire.
407 pub fn absolute_expiry(&self) -> Option<Duration> {
408 self.contents.absolute_expiry
411 /// Whether the offer has expired.
412 #[cfg(feature = "std")]
413 pub fn is_expired(&self) -> bool {
414 self.contents.is_expired()
417 /// The issuer of the offer, possibly beginning with `user@domain` or `domain`. Intended to be
418 /// displayed to the user but with the caveat that it has not been verified in any way.
419 pub fn issuer(&self) -> Option<PrintableString> {
420 self.contents.issuer.as_ref().map(|issuer| PrintableString(issuer.as_str()))
423 /// Paths to the recipient originating from publicly reachable nodes. Blinded paths provide
424 /// recipient privacy by obfuscating its node id.
425 pub fn paths(&self) -> &[BlindedPath] {
426 self.contents.paths.as_ref().map(|paths| paths.as_slice()).unwrap_or(&[])
429 /// The quantity of items supported.
430 pub fn supported_quantity(&self) -> Quantity {
431 self.contents.supported_quantity()
434 /// Returns whether the given quantity is valid for the offer.
435 pub fn is_valid_quantity(&self, quantity: u64) -> bool {
436 self.contents.is_valid_quantity(quantity)
439 /// Returns whether a quantity is expected in an [`InvoiceRequest`] for the offer.
441 /// [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
442 pub fn expects_quantity(&self) -> bool {
443 self.contents.expects_quantity()
446 /// The public key used by the recipient to sign invoices.
447 pub fn signing_pubkey(&self) -> PublicKey {
448 self.contents.signing_pubkey()
451 /// Similar to [`Offer::request_invoice`] except it:
452 /// - derives the [`InvoiceRequest::payer_id`] such that a different key can be used for each
454 /// - sets the [`InvoiceRequest::metadata`] when [`InvoiceRequestBuilder::build`] is called such
455 /// that it can be used by [`Bolt12Invoice::verify`] to determine if the invoice was requested
456 /// using a base [`ExpandedKey`] from which the payer id was derived.
458 /// Useful to protect the sender's privacy.
460 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
462 /// [`InvoiceRequest::payer_id`]: crate::offers::invoice_request::InvoiceRequest::payer_id
463 /// [`InvoiceRequest::metadata`]: crate::offers::invoice_request::InvoiceRequest::metadata
464 /// [`Bolt12Invoice::verify`]: crate::offers::invoice::Bolt12Invoice::verify
465 /// [`ExpandedKey`]: crate::ln::inbound_payment::ExpandedKey
466 pub fn request_invoice_deriving_payer_id<'a, 'b, ES: Deref, T: secp256k1::Signing>(
467 &'a self, expanded_key: &ExpandedKey, entropy_source: ES, secp_ctx: &'b Secp256k1<T>
468 ) -> Result<InvoiceRequestBuilder<'a, 'b, DerivedPayerId, T>, Bolt12SemanticError>
470 ES::Target: EntropySource,
472 if self.features().requires_unknown_bits() {
473 return Err(Bolt12SemanticError::UnknownRequiredFeatures);
476 Ok(InvoiceRequestBuilder::deriving_payer_id(self, expanded_key, entropy_source, secp_ctx))
479 /// Similar to [`Offer::request_invoice_deriving_payer_id`] except uses `payer_id` for the
480 /// [`InvoiceRequest::payer_id`] instead of deriving a different key for each request.
482 /// Useful for recurring payments using the same `payer_id` with different invoices.
484 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
486 /// [`InvoiceRequest::payer_id`]: crate::offers::invoice_request::InvoiceRequest::payer_id
487 pub fn request_invoice_deriving_metadata<ES: Deref>(
488 &self, payer_id: PublicKey, expanded_key: &ExpandedKey, entropy_source: ES
489 ) -> Result<InvoiceRequestBuilder<ExplicitPayerId, secp256k1::SignOnly>, Bolt12SemanticError>
491 ES::Target: EntropySource,
493 if self.features().requires_unknown_bits() {
494 return Err(Bolt12SemanticError::UnknownRequiredFeatures);
497 Ok(InvoiceRequestBuilder::deriving_metadata(self, payer_id, expanded_key, entropy_source))
500 /// Creates an [`InvoiceRequestBuilder`] for the offer with the given `metadata` and `payer_id`,
501 /// which will be reflected in the `Bolt12Invoice` response.
503 /// The `metadata` is useful for including information about the derivation of `payer_id` such
504 /// that invoice response handling can be stateless. Also serves as payer-provided entropy while
505 /// hashing in the signature calculation.
507 /// This should not leak any information such as by using a simple BIP-32 derivation path.
508 /// Otherwise, payments may be correlated.
510 /// Errors if the offer contains unknown required features.
512 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
514 /// [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
515 pub fn request_invoice(
516 &self, metadata: Vec<u8>, payer_id: PublicKey
517 ) -> Result<InvoiceRequestBuilder<ExplicitPayerId, secp256k1::SignOnly>, Bolt12SemanticError> {
518 if self.features().requires_unknown_bits() {
519 return Err(Bolt12SemanticError::UnknownRequiredFeatures);
522 Ok(InvoiceRequestBuilder::new(self, metadata, payer_id))
526 pub(super) fn as_tlv_stream(&self) -> OfferTlvStreamRef {
527 self.contents.as_tlv_stream()
531 impl AsRef<[u8]> for Offer {
532 fn as_ref(&self) -> &[u8] {
538 pub fn chains(&self) -> Vec<ChainHash> {
539 self.chains.as_ref().cloned().unwrap_or_else(|| vec![self.implied_chain()])
542 pub fn implied_chain(&self) -> ChainHash {
543 ChainHash::using_genesis_block(Network::Bitcoin)
546 pub fn supports_chain(&self, chain: ChainHash) -> bool {
547 self.chains().contains(&chain)
550 pub fn metadata(&self) -> Option<&Vec<u8>> {
551 self.metadata.as_ref().and_then(|metadata| metadata.as_bytes())
554 pub fn description(&self) -> PrintableString {
555 PrintableString(&self.description)
558 #[cfg(feature = "std")]
559 pub(super) fn is_expired(&self) -> bool {
560 match self.absolute_expiry {
561 Some(seconds_from_epoch) => match SystemTime::UNIX_EPOCH.elapsed() {
562 Ok(elapsed) => elapsed > seconds_from_epoch,
569 pub fn amount(&self) -> Option<&Amount> {
573 pub(super) fn check_amount_msats_for_quantity(
574 &self, amount_msats: Option<u64>, quantity: Option<u64>
575 ) -> Result<(), Bolt12SemanticError> {
576 let offer_amount_msats = match self.amount {
578 Some(Amount::Bitcoin { amount_msats }) => amount_msats,
579 Some(Amount::Currency { .. }) => return Err(Bolt12SemanticError::UnsupportedCurrency),
582 if !self.expects_quantity() || quantity.is_some() {
583 let expected_amount_msats = offer_amount_msats.checked_mul(quantity.unwrap_or(1))
584 .ok_or(Bolt12SemanticError::InvalidAmount)?;
585 let amount_msats = amount_msats.unwrap_or(expected_amount_msats);
587 if amount_msats < expected_amount_msats {
588 return Err(Bolt12SemanticError::InsufficientAmount);
591 if amount_msats > MAX_VALUE_MSAT {
592 return Err(Bolt12SemanticError::InvalidAmount);
599 pub fn supported_quantity(&self) -> Quantity {
600 self.supported_quantity
603 pub(super) fn check_quantity(&self, quantity: Option<u64>) -> Result<(), Bolt12SemanticError> {
604 let expects_quantity = self.expects_quantity();
606 None if expects_quantity => Err(Bolt12SemanticError::MissingQuantity),
607 Some(_) if !expects_quantity => Err(Bolt12SemanticError::UnexpectedQuantity),
608 Some(quantity) if !self.is_valid_quantity(quantity) => {
609 Err(Bolt12SemanticError::InvalidQuantity)
615 fn is_valid_quantity(&self, quantity: u64) -> bool {
616 match self.supported_quantity {
617 Quantity::Bounded(n) => quantity <= n.get(),
618 Quantity::Unbounded => quantity > 0,
619 Quantity::One => quantity == 1,
623 fn expects_quantity(&self) -> bool {
624 match self.supported_quantity {
625 Quantity::Bounded(_) => true,
626 Quantity::Unbounded => true,
627 Quantity::One => false,
631 pub(super) fn signing_pubkey(&self) -> PublicKey {
635 /// Verifies that the offer metadata was produced from the offer in the TLV stream.
636 pub(super) fn verify<T: secp256k1::Signing>(
637 &self, bytes: &[u8], key: &ExpandedKey, secp_ctx: &Secp256k1<T>
638 ) -> Result<Option<KeyPair>, ()> {
639 match self.metadata() {
641 let tlv_stream = TlvStream::new(bytes).range(OFFER_TYPES).filter(|record| {
642 match record.r#type {
643 OFFER_METADATA_TYPE => false,
644 OFFER_NODE_ID_TYPE => !self.metadata.as_ref().unwrap().derives_keys(),
648 signer::verify_metadata(
649 metadata, key, IV_BYTES, self.signing_pubkey(), tlv_stream, secp_ctx
656 pub(super) fn as_tlv_stream(&self) -> OfferTlvStreamRef {
657 let (currency, amount) = match &self.amount {
658 None => (None, None),
659 Some(Amount::Bitcoin { amount_msats }) => (None, Some(*amount_msats)),
660 Some(Amount::Currency { iso4217_code, amount }) => (
661 Some(iso4217_code), Some(*amount)
666 if self.features == OfferFeatures::empty() { None } else { Some(&self.features) }
670 chains: self.chains.as_ref(),
671 metadata: self.metadata(),
674 description: Some(&self.description),
676 absolute_expiry: self.absolute_expiry.map(|duration| duration.as_secs()),
677 paths: self.paths.as_ref(),
678 issuer: self.issuer.as_ref(),
679 quantity_max: self.supported_quantity.to_tlv_record(),
680 node_id: Some(&self.signing_pubkey),
685 impl Writeable for Offer {
686 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
687 WithoutLength(&self.bytes).write(writer)
691 impl Writeable for OfferContents {
692 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
693 self.as_tlv_stream().write(writer)
697 /// The minimum amount required for an item in an [`Offer`], denominated in either bitcoin or
698 /// another currency.
699 #[derive(Clone, Debug, PartialEq)]
701 /// An amount of bitcoin.
703 /// The amount in millisatoshi.
706 /// An amount of currency specified using ISO 4712.
708 /// The currency that the amount is denominated in.
709 iso4217_code: CurrencyCode,
710 /// The amount in the currency unit adjusted by the ISO 4712 exponent (e.g., USD cents).
715 /// An ISO 4712 three-letter currency code (e.g., USD).
716 pub type CurrencyCode = [u8; 3];
718 /// Quantity of items supported by an [`Offer`].
719 #[derive(Clone, Copy, Debug, PartialEq)]
721 /// Up to a specific number of items (inclusive). Use when more than one item can be requested
722 /// but is limited (e.g., because of per customer or inventory limits).
724 /// May be used with `NonZeroU64::new(1)` but prefer to use [`Quantity::One`] if only one item
727 /// One or more items. Use when more than one item can be requested without any limit.
729 /// Only one item. Use when only a single item can be requested.
734 fn to_tlv_record(&self) -> Option<u64> {
736 Quantity::Bounded(n) => Some(n.get()),
737 Quantity::Unbounded => Some(0),
738 Quantity::One => None,
743 /// Valid type range for offer TLV records.
744 pub(super) const OFFER_TYPES: core::ops::Range<u64> = 1..80;
746 /// TLV record type for [`Offer::metadata`].
747 const OFFER_METADATA_TYPE: u64 = 4;
749 /// TLV record type for [`Offer::signing_pubkey`].
750 const OFFER_NODE_ID_TYPE: u64 = 22;
752 tlv_stream!(OfferTlvStream, OfferTlvStreamRef, OFFER_TYPES, {
753 (2, chains: (Vec<ChainHash>, WithoutLength)),
754 (OFFER_METADATA_TYPE, metadata: (Vec<u8>, WithoutLength)),
755 (6, currency: CurrencyCode),
756 (8, amount: (u64, HighZeroBytesDroppedBigSize)),
757 (10, description: (String, WithoutLength)),
758 (12, features: (OfferFeatures, WithoutLength)),
759 (14, absolute_expiry: (u64, HighZeroBytesDroppedBigSize)),
760 (16, paths: (Vec<BlindedPath>, WithoutLength)),
761 (18, issuer: (String, WithoutLength)),
762 (20, quantity_max: (u64, HighZeroBytesDroppedBigSize)),
763 (OFFER_NODE_ID_TYPE, node_id: PublicKey),
766 impl Bech32Encode for Offer {
767 const BECH32_HRP: &'static str = "lno";
770 impl FromStr for Offer {
771 type Err = Bolt12ParseError;
773 fn from_str(s: &str) -> Result<Self, <Self as FromStr>::Err> {
774 Self::from_bech32_str(s)
778 impl TryFrom<Vec<u8>> for Offer {
779 type Error = Bolt12ParseError;
781 fn try_from(bytes: Vec<u8>) -> Result<Self, Self::Error> {
782 let offer = ParsedMessage::<OfferTlvStream>::try_from(bytes)?;
783 let ParsedMessage { bytes, tlv_stream } = offer;
784 let contents = OfferContents::try_from(tlv_stream)?;
785 Ok(Offer { bytes, contents })
789 impl TryFrom<OfferTlvStream> for OfferContents {
790 type Error = Bolt12SemanticError;
792 fn try_from(tlv_stream: OfferTlvStream) -> Result<Self, Self::Error> {
794 chains, metadata, currency, amount, description, features, absolute_expiry, paths,
795 issuer, quantity_max, node_id,
798 let metadata = metadata.map(|metadata| Metadata::Bytes(metadata));
800 let amount = match (currency, amount) {
801 (None, None) => None,
802 (None, Some(amount_msats)) if amount_msats > MAX_VALUE_MSAT => {
803 return Err(Bolt12SemanticError::InvalidAmount);
805 (None, Some(amount_msats)) => Some(Amount::Bitcoin { amount_msats }),
806 (Some(_), None) => return Err(Bolt12SemanticError::MissingAmount),
807 (Some(iso4217_code), Some(amount)) => Some(Amount::Currency { iso4217_code, amount }),
810 let description = match description {
811 None => return Err(Bolt12SemanticError::MissingDescription),
812 Some(description) => description,
815 let features = features.unwrap_or_else(OfferFeatures::empty);
817 let absolute_expiry = absolute_expiry
818 .map(|seconds_from_epoch| Duration::from_secs(seconds_from_epoch));
820 let supported_quantity = match quantity_max {
821 None => Quantity::One,
822 Some(0) => Quantity::Unbounded,
823 Some(n) => Quantity::Bounded(NonZeroU64::new(n).unwrap()),
826 let signing_pubkey = match node_id {
827 None => return Err(Bolt12SemanticError::MissingSigningPubkey),
828 Some(node_id) => node_id,
832 chains, metadata, amount, description, features, absolute_expiry, issuer, paths,
833 supported_quantity, signing_pubkey,
838 impl core::fmt::Display for Offer {
839 fn fmt(&self, f: &mut core::fmt::Formatter) -> Result<(), core::fmt::Error> {
840 self.fmt_bech32_str(f)
846 use super::{Amount, Offer, OfferBuilder, OfferTlvStreamRef, Quantity};
848 use bitcoin::blockdata::constants::ChainHash;
849 use bitcoin::network::constants::Network;
850 use bitcoin::secp256k1::Secp256k1;
851 use core::convert::TryFrom;
852 use core::num::NonZeroU64;
853 use core::time::Duration;
854 use crate::blinded_path::{BlindedHop, BlindedPath};
855 use crate::sign::KeyMaterial;
856 use crate::ln::features::OfferFeatures;
857 use crate::ln::inbound_payment::ExpandedKey;
858 use crate::ln::msgs::{DecodeError, MAX_VALUE_MSAT};
859 use crate::offers::parse::{Bolt12ParseError, Bolt12SemanticError};
860 use crate::offers::test_utils::*;
861 use crate::util::ser::{BigSize, Writeable};
862 use crate::util::string::PrintableString;
865 fn builds_offer_with_defaults() {
866 let offer = OfferBuilder::new("foo".into(), pubkey(42)).build().unwrap();
868 let mut buffer = Vec::new();
869 offer.write(&mut buffer).unwrap();
871 assert_eq!(offer.bytes, buffer.as_slice());
872 assert_eq!(offer.chains(), vec![ChainHash::using_genesis_block(Network::Bitcoin)]);
873 assert!(offer.supports_chain(ChainHash::using_genesis_block(Network::Bitcoin)));
874 assert_eq!(offer.metadata(), None);
875 assert_eq!(offer.amount(), None);
876 assert_eq!(offer.description(), PrintableString("foo"));
877 assert_eq!(offer.features(), &OfferFeatures::empty());
878 assert_eq!(offer.absolute_expiry(), None);
879 #[cfg(feature = "std")]
880 assert!(!offer.is_expired());
881 assert_eq!(offer.paths(), &[]);
882 assert_eq!(offer.issuer(), None);
883 assert_eq!(offer.supported_quantity(), Quantity::One);
884 assert_eq!(offer.signing_pubkey(), pubkey(42));
887 offer.as_tlv_stream(),
893 description: Some(&String::from("foo")),
895 absolute_expiry: None,
899 node_id: Some(&pubkey(42)),
903 if let Err(e) = Offer::try_from(buffer) {
904 panic!("error parsing offer: {:?}", e);
909 fn builds_offer_with_chains() {
910 let mainnet = ChainHash::using_genesis_block(Network::Bitcoin);
911 let testnet = ChainHash::using_genesis_block(Network::Testnet);
913 let offer = OfferBuilder::new("foo".into(), pubkey(42))
914 .chain(Network::Bitcoin)
917 assert!(offer.supports_chain(mainnet));
918 assert_eq!(offer.chains(), vec![mainnet]);
919 assert_eq!(offer.as_tlv_stream().chains, None);
921 let offer = OfferBuilder::new("foo".into(), pubkey(42))
922 .chain(Network::Testnet)
925 assert!(offer.supports_chain(testnet));
926 assert_eq!(offer.chains(), vec![testnet]);
927 assert_eq!(offer.as_tlv_stream().chains, Some(&vec![testnet]));
929 let offer = OfferBuilder::new("foo".into(), pubkey(42))
930 .chain(Network::Testnet)
931 .chain(Network::Testnet)
934 assert!(offer.supports_chain(testnet));
935 assert_eq!(offer.chains(), vec![testnet]);
936 assert_eq!(offer.as_tlv_stream().chains, Some(&vec![testnet]));
938 let offer = OfferBuilder::new("foo".into(), pubkey(42))
939 .chain(Network::Bitcoin)
940 .chain(Network::Testnet)
943 assert!(offer.supports_chain(mainnet));
944 assert!(offer.supports_chain(testnet));
945 assert_eq!(offer.chains(), vec![mainnet, testnet]);
946 assert_eq!(offer.as_tlv_stream().chains, Some(&vec![mainnet, testnet]));
950 fn builds_offer_with_metadata() {
951 let offer = OfferBuilder::new("foo".into(), pubkey(42))
952 .metadata(vec![42; 32]).unwrap()
955 assert_eq!(offer.metadata(), Some(&vec![42; 32]));
956 assert_eq!(offer.as_tlv_stream().metadata, Some(&vec![42; 32]));
958 let offer = OfferBuilder::new("foo".into(), pubkey(42))
959 .metadata(vec![42; 32]).unwrap()
960 .metadata(vec![43; 32]).unwrap()
963 assert_eq!(offer.metadata(), Some(&vec![43; 32]));
964 assert_eq!(offer.as_tlv_stream().metadata, Some(&vec![43; 32]));
968 fn builds_offer_with_metadata_derived() {
969 let desc = "foo".to_string();
970 let node_id = recipient_pubkey();
971 let expanded_key = ExpandedKey::new(&KeyMaterial([42; 32]));
972 let entropy = FixedEntropy {};
973 let secp_ctx = Secp256k1::new();
975 let offer = OfferBuilder
976 ::deriving_signing_pubkey(desc, node_id, &expanded_key, &entropy, &secp_ctx)
979 assert_eq!(offer.signing_pubkey(), node_id);
981 let invoice_request = offer.request_invoice(vec![1; 32], payer_pubkey()).unwrap()
983 .sign(payer_sign).unwrap();
984 assert!(invoice_request.verify(&expanded_key, &secp_ctx).is_ok());
986 // Fails verification with altered offer field
987 let mut tlv_stream = offer.as_tlv_stream();
988 tlv_stream.amount = Some(100);
990 let mut encoded_offer = Vec::new();
991 tlv_stream.write(&mut encoded_offer).unwrap();
993 let invoice_request = Offer::try_from(encoded_offer).unwrap()
994 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
996 .sign(payer_sign).unwrap();
997 assert!(invoice_request.verify(&expanded_key, &secp_ctx).is_err());
999 // Fails verification with altered metadata
1000 let mut tlv_stream = offer.as_tlv_stream();
1001 let metadata = tlv_stream.metadata.unwrap().iter().copied().rev().collect();
1002 tlv_stream.metadata = Some(&metadata);
1004 let mut encoded_offer = Vec::new();
1005 tlv_stream.write(&mut encoded_offer).unwrap();
1007 let invoice_request = Offer::try_from(encoded_offer).unwrap()
1008 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1010 .sign(payer_sign).unwrap();
1011 assert!(invoice_request.verify(&expanded_key, &secp_ctx).is_err());
1015 fn builds_offer_with_derived_signing_pubkey() {
1016 let desc = "foo".to_string();
1017 let node_id = recipient_pubkey();
1018 let expanded_key = ExpandedKey::new(&KeyMaterial([42; 32]));
1019 let entropy = FixedEntropy {};
1020 let secp_ctx = Secp256k1::new();
1022 let blinded_path = BlindedPath {
1023 introduction_node_id: pubkey(40),
1024 blinding_point: pubkey(41),
1026 BlindedHop { blinded_node_id: pubkey(42), encrypted_payload: vec![0; 43] },
1027 BlindedHop { blinded_node_id: node_id, encrypted_payload: vec![0; 44] },
1031 let offer = OfferBuilder
1032 ::deriving_signing_pubkey(desc, node_id, &expanded_key, &entropy, &secp_ctx)
1036 assert_ne!(offer.signing_pubkey(), node_id);
1038 let invoice_request = offer.request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1040 .sign(payer_sign).unwrap();
1041 assert!(invoice_request.verify(&expanded_key, &secp_ctx).is_ok());
1043 // Fails verification with altered offer field
1044 let mut tlv_stream = offer.as_tlv_stream();
1045 tlv_stream.amount = Some(100);
1047 let mut encoded_offer = Vec::new();
1048 tlv_stream.write(&mut encoded_offer).unwrap();
1050 let invoice_request = Offer::try_from(encoded_offer).unwrap()
1051 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1053 .sign(payer_sign).unwrap();
1054 assert!(invoice_request.verify(&expanded_key, &secp_ctx).is_err());
1056 // Fails verification with altered signing pubkey
1057 let mut tlv_stream = offer.as_tlv_stream();
1058 let signing_pubkey = pubkey(1);
1059 tlv_stream.node_id = Some(&signing_pubkey);
1061 let mut encoded_offer = Vec::new();
1062 tlv_stream.write(&mut encoded_offer).unwrap();
1064 let invoice_request = Offer::try_from(encoded_offer).unwrap()
1065 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1067 .sign(payer_sign).unwrap();
1068 assert!(invoice_request.verify(&expanded_key, &secp_ctx).is_err());
1072 fn builds_offer_with_amount() {
1073 let bitcoin_amount = Amount::Bitcoin { amount_msats: 1000 };
1074 let currency_amount = Amount::Currency { iso4217_code: *b"USD", amount: 10 };
1076 let offer = OfferBuilder::new("foo".into(), pubkey(42))
1080 let tlv_stream = offer.as_tlv_stream();
1081 assert_eq!(offer.amount(), Some(&bitcoin_amount));
1082 assert_eq!(tlv_stream.amount, Some(1000));
1083 assert_eq!(tlv_stream.currency, None);
1085 let builder = OfferBuilder::new("foo".into(), pubkey(42))
1086 .amount(currency_amount.clone());
1087 let tlv_stream = builder.offer.as_tlv_stream();
1088 assert_eq!(builder.offer.amount, Some(currency_amount.clone()));
1089 assert_eq!(tlv_stream.amount, Some(10));
1090 assert_eq!(tlv_stream.currency, Some(b"USD"));
1091 match builder.build() {
1092 Ok(_) => panic!("expected error"),
1093 Err(e) => assert_eq!(e, Bolt12SemanticError::UnsupportedCurrency),
1096 let offer = OfferBuilder::new("foo".into(), pubkey(42))
1097 .amount(currency_amount.clone())
1098 .amount(bitcoin_amount.clone())
1101 let tlv_stream = offer.as_tlv_stream();
1102 assert_eq!(tlv_stream.amount, Some(1000));
1103 assert_eq!(tlv_stream.currency, None);
1105 let invalid_amount = Amount::Bitcoin { amount_msats: MAX_VALUE_MSAT + 1 };
1106 match OfferBuilder::new("foo".into(), pubkey(42)).amount(invalid_amount).build() {
1107 Ok(_) => panic!("expected error"),
1108 Err(e) => assert_eq!(e, Bolt12SemanticError::InvalidAmount),
1113 fn builds_offer_with_features() {
1114 let offer = OfferBuilder::new("foo".into(), pubkey(42))
1115 .features_unchecked(OfferFeatures::unknown())
1118 assert_eq!(offer.features(), &OfferFeatures::unknown());
1119 assert_eq!(offer.as_tlv_stream().features, Some(&OfferFeatures::unknown()));
1121 let offer = OfferBuilder::new("foo".into(), pubkey(42))
1122 .features_unchecked(OfferFeatures::unknown())
1123 .features_unchecked(OfferFeatures::empty())
1126 assert_eq!(offer.features(), &OfferFeatures::empty());
1127 assert_eq!(offer.as_tlv_stream().features, None);
1131 fn builds_offer_with_absolute_expiry() {
1132 let future_expiry = Duration::from_secs(u64::max_value());
1133 let past_expiry = Duration::from_secs(0);
1135 let offer = OfferBuilder::new("foo".into(), pubkey(42))
1136 .absolute_expiry(future_expiry)
1139 #[cfg(feature = "std")]
1140 assert!(!offer.is_expired());
1141 assert_eq!(offer.absolute_expiry(), Some(future_expiry));
1142 assert_eq!(offer.as_tlv_stream().absolute_expiry, Some(future_expiry.as_secs()));
1144 let offer = OfferBuilder::new("foo".into(), pubkey(42))
1145 .absolute_expiry(future_expiry)
1146 .absolute_expiry(past_expiry)
1149 #[cfg(feature = "std")]
1150 assert!(offer.is_expired());
1151 assert_eq!(offer.absolute_expiry(), Some(past_expiry));
1152 assert_eq!(offer.as_tlv_stream().absolute_expiry, Some(past_expiry.as_secs()));
1156 fn builds_offer_with_paths() {
1159 introduction_node_id: pubkey(40),
1160 blinding_point: pubkey(41),
1162 BlindedHop { blinded_node_id: pubkey(43), encrypted_payload: vec![0; 43] },
1163 BlindedHop { blinded_node_id: pubkey(44), encrypted_payload: vec![0; 44] },
1167 introduction_node_id: pubkey(40),
1168 blinding_point: pubkey(41),
1170 BlindedHop { blinded_node_id: pubkey(45), encrypted_payload: vec![0; 45] },
1171 BlindedHop { blinded_node_id: pubkey(46), encrypted_payload: vec![0; 46] },
1176 let offer = OfferBuilder::new("foo".into(), pubkey(42))
1177 .path(paths[0].clone())
1178 .path(paths[1].clone())
1181 let tlv_stream = offer.as_tlv_stream();
1182 assert_eq!(offer.paths(), paths.as_slice());
1183 assert_eq!(offer.signing_pubkey(), pubkey(42));
1184 assert_ne!(pubkey(42), pubkey(44));
1185 assert_eq!(tlv_stream.paths, Some(&paths));
1186 assert_eq!(tlv_stream.node_id, Some(&pubkey(42)));
1190 fn builds_offer_with_issuer() {
1191 let offer = OfferBuilder::new("foo".into(), pubkey(42))
1192 .issuer("bar".into())
1195 assert_eq!(offer.issuer(), Some(PrintableString("bar")));
1196 assert_eq!(offer.as_tlv_stream().issuer, Some(&String::from("bar")));
1198 let offer = OfferBuilder::new("foo".into(), pubkey(42))
1199 .issuer("bar".into())
1200 .issuer("baz".into())
1203 assert_eq!(offer.issuer(), Some(PrintableString("baz")));
1204 assert_eq!(offer.as_tlv_stream().issuer, Some(&String::from("baz")));
1208 fn builds_offer_with_supported_quantity() {
1209 let one = NonZeroU64::new(1).unwrap();
1210 let ten = NonZeroU64::new(10).unwrap();
1212 let offer = OfferBuilder::new("foo".into(), pubkey(42))
1213 .supported_quantity(Quantity::One)
1216 let tlv_stream = offer.as_tlv_stream();
1217 assert_eq!(offer.supported_quantity(), Quantity::One);
1218 assert_eq!(tlv_stream.quantity_max, None);
1220 let offer = OfferBuilder::new("foo".into(), pubkey(42))
1221 .supported_quantity(Quantity::Unbounded)
1224 let tlv_stream = offer.as_tlv_stream();
1225 assert_eq!(offer.supported_quantity(), Quantity::Unbounded);
1226 assert_eq!(tlv_stream.quantity_max, Some(0));
1228 let offer = OfferBuilder::new("foo".into(), pubkey(42))
1229 .supported_quantity(Quantity::Bounded(ten))
1232 let tlv_stream = offer.as_tlv_stream();
1233 assert_eq!(offer.supported_quantity(), Quantity::Bounded(ten));
1234 assert_eq!(tlv_stream.quantity_max, Some(10));
1236 let offer = OfferBuilder::new("foo".into(), pubkey(42))
1237 .supported_quantity(Quantity::Bounded(one))
1240 let tlv_stream = offer.as_tlv_stream();
1241 assert_eq!(offer.supported_quantity(), Quantity::Bounded(one));
1242 assert_eq!(tlv_stream.quantity_max, Some(1));
1244 let offer = OfferBuilder::new("foo".into(), pubkey(42))
1245 .supported_quantity(Quantity::Bounded(ten))
1246 .supported_quantity(Quantity::One)
1249 let tlv_stream = offer.as_tlv_stream();
1250 assert_eq!(offer.supported_quantity(), Quantity::One);
1251 assert_eq!(tlv_stream.quantity_max, None);
1255 fn fails_requesting_invoice_with_unknown_required_features() {
1256 match OfferBuilder::new("foo".into(), pubkey(42))
1257 .features_unchecked(OfferFeatures::unknown())
1259 .request_invoice(vec![1; 32], pubkey(43))
1261 Ok(_) => panic!("expected error"),
1262 Err(e) => assert_eq!(e, Bolt12SemanticError::UnknownRequiredFeatures),
1267 fn parses_offer_with_chains() {
1268 let offer = OfferBuilder::new("foo".into(), pubkey(42))
1269 .chain(Network::Bitcoin)
1270 .chain(Network::Testnet)
1273 if let Err(e) = offer.to_string().parse::<Offer>() {
1274 panic!("error parsing offer: {:?}", e);
1279 fn parses_offer_with_amount() {
1280 let offer = OfferBuilder::new("foo".into(), pubkey(42))
1281 .amount(Amount::Bitcoin { amount_msats: 1000 })
1284 if let Err(e) = offer.to_string().parse::<Offer>() {
1285 panic!("error parsing offer: {:?}", e);
1288 let mut tlv_stream = offer.as_tlv_stream();
1289 tlv_stream.amount = Some(1000);
1290 tlv_stream.currency = Some(b"USD");
1292 let mut encoded_offer = Vec::new();
1293 tlv_stream.write(&mut encoded_offer).unwrap();
1295 if let Err(e) = Offer::try_from(encoded_offer) {
1296 panic!("error parsing offer: {:?}", e);
1299 let mut tlv_stream = offer.as_tlv_stream();
1300 tlv_stream.amount = None;
1301 tlv_stream.currency = Some(b"USD");
1303 let mut encoded_offer = Vec::new();
1304 tlv_stream.write(&mut encoded_offer).unwrap();
1306 match Offer::try_from(encoded_offer) {
1307 Ok(_) => panic!("expected error"),
1308 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingAmount)),
1311 let mut tlv_stream = offer.as_tlv_stream();
1312 tlv_stream.amount = Some(MAX_VALUE_MSAT + 1);
1313 tlv_stream.currency = None;
1315 let mut encoded_offer = Vec::new();
1316 tlv_stream.write(&mut encoded_offer).unwrap();
1318 match Offer::try_from(encoded_offer) {
1319 Ok(_) => panic!("expected error"),
1320 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::InvalidAmount)),
1325 fn parses_offer_with_description() {
1326 let offer = OfferBuilder::new("foo".into(), pubkey(42)).build().unwrap();
1327 if let Err(e) = offer.to_string().parse::<Offer>() {
1328 panic!("error parsing offer: {:?}", e);
1331 let mut tlv_stream = offer.as_tlv_stream();
1332 tlv_stream.description = None;
1334 let mut encoded_offer = Vec::new();
1335 tlv_stream.write(&mut encoded_offer).unwrap();
1337 match Offer::try_from(encoded_offer) {
1338 Ok(_) => panic!("expected error"),
1340 assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingDescription));
1346 fn parses_offer_with_paths() {
1347 let offer = OfferBuilder::new("foo".into(), pubkey(42))
1349 introduction_node_id: pubkey(40),
1350 blinding_point: pubkey(41),
1352 BlindedHop { blinded_node_id: pubkey(43), encrypted_payload: vec![0; 43] },
1353 BlindedHop { blinded_node_id: pubkey(44), encrypted_payload: vec![0; 44] },
1357 introduction_node_id: pubkey(40),
1358 blinding_point: pubkey(41),
1360 BlindedHop { blinded_node_id: pubkey(45), encrypted_payload: vec![0; 45] },
1361 BlindedHop { blinded_node_id: pubkey(46), encrypted_payload: vec![0; 46] },
1366 if let Err(e) = offer.to_string().parse::<Offer>() {
1367 panic!("error parsing offer: {:?}", e);
1370 let mut builder = OfferBuilder::new("foo".into(), pubkey(42));
1371 builder.offer.paths = Some(vec![]);
1373 let offer = builder.build().unwrap();
1374 if let Err(e) = offer.to_string().parse::<Offer>() {
1375 panic!("error parsing offer: {:?}", e);
1380 fn parses_offer_with_quantity() {
1381 let offer = OfferBuilder::new("foo".into(), pubkey(42))
1382 .supported_quantity(Quantity::One)
1385 if let Err(e) = offer.to_string().parse::<Offer>() {
1386 panic!("error parsing offer: {:?}", e);
1389 let offer = OfferBuilder::new("foo".into(), pubkey(42))
1390 .supported_quantity(Quantity::Unbounded)
1393 if let Err(e) = offer.to_string().parse::<Offer>() {
1394 panic!("error parsing offer: {:?}", e);
1397 let offer = OfferBuilder::new("foo".into(), pubkey(42))
1398 .supported_quantity(Quantity::Bounded(NonZeroU64::new(10).unwrap()))
1401 if let Err(e) = offer.to_string().parse::<Offer>() {
1402 panic!("error parsing offer: {:?}", e);
1405 let offer = OfferBuilder::new("foo".into(), pubkey(42))
1406 .supported_quantity(Quantity::Bounded(NonZeroU64::new(1).unwrap()))
1409 if let Err(e) = offer.to_string().parse::<Offer>() {
1410 panic!("error parsing offer: {:?}", e);
1415 fn parses_offer_with_node_id() {
1416 let offer = OfferBuilder::new("foo".into(), pubkey(42)).build().unwrap();
1417 if let Err(e) = offer.to_string().parse::<Offer>() {
1418 panic!("error parsing offer: {:?}", e);
1421 let mut tlv_stream = offer.as_tlv_stream();
1422 tlv_stream.node_id = None;
1424 let mut encoded_offer = Vec::new();
1425 tlv_stream.write(&mut encoded_offer).unwrap();
1427 match Offer::try_from(encoded_offer) {
1428 Ok(_) => panic!("expected error"),
1430 assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingSigningPubkey));
1436 fn fails_parsing_offer_with_extra_tlv_records() {
1437 let offer = OfferBuilder::new("foo".into(), pubkey(42)).build().unwrap();
1439 let mut encoded_offer = Vec::new();
1440 offer.write(&mut encoded_offer).unwrap();
1441 BigSize(80).write(&mut encoded_offer).unwrap();
1442 BigSize(32).write(&mut encoded_offer).unwrap();
1443 [42u8; 32].write(&mut encoded_offer).unwrap();
1445 match Offer::try_from(encoded_offer) {
1446 Ok(_) => panic!("expected error"),
1447 Err(e) => assert_eq!(e, Bolt12ParseError::Decode(DecodeError::InvalidValue)),
1454 use super::{Bolt12ParseError, Offer};
1455 use bitcoin::bech32;
1456 use crate::ln::msgs::DecodeError;
1459 fn encodes_offer_as_bech32_without_checksum() {
1460 let encoded_offer = "lno1pqps7sjqpgtyzm3qv4uxzmtsd3jjqer9wd3hy6tsw35k7msjzfpy7nz5yqcnygrfdej82um5wf5k2uckyypwa3eyt44h6txtxquqh7lz5djge4afgfjn7k4rgrkuag0jsd5xvxg";
1461 let offer = dbg!(encoded_offer.parse::<Offer>().unwrap());
1462 let reencoded_offer = offer.to_string();
1463 dbg!(reencoded_offer.parse::<Offer>().unwrap());
1464 assert_eq!(reencoded_offer, encoded_offer);
1468 fn parses_bech32_encoded_offers() {
1470 // BOLT 12 test vectors
1471 "lno1pqps7sjqpgtyzm3qv4uxzmtsd3jjqer9wd3hy6tsw35k7msjzfpy7nz5yqcnygrfdej82um5wf5k2uckyypwa3eyt44h6txtxquqh7lz5djge4afgfjn7k4rgrkuag0jsd5xvxg",
1472 "l+no1pqps7sjqpgtyzm3qv4uxzmtsd3jjqer9wd3hy6tsw35k7msjzfpy7nz5yqcnygrfdej82um5wf5k2uckyypwa3eyt44h6txtxquqh7lz5djge4afgfjn7k4rgrkuag0jsd5xvxg",
1473 "lno1pqps7sjqpgt+yzm3qv4uxzmtsd3jjqer9wd3hy6tsw3+5k7msjzfpy7nz5yqcn+ygrfdej82um5wf5k2uckyypwa3eyt44h6txtxquqh7lz5djge4afgfjn7k4rgrkuag0jsd+5xvxg",
1474 "lno1pqps7sjqpgt+ yzm3qv4uxzmtsd3jjqer9wd3hy6tsw3+ 5k7msjzfpy7nz5yqcn+\nygrfdej82um5wf5k2uckyypwa3eyt44h6txtxquqh7lz5djge4afgfjn7k4rgrkuag0jsd+\r\n 5xvxg",
1476 for encoded_offer in &offers {
1477 if let Err(e) = encoded_offer.parse::<Offer>() {
1478 panic!("Invalid offer ({:?}): {}", e, encoded_offer);
1484 fn fails_parsing_bech32_encoded_offers_with_invalid_continuations() {
1486 // BOLT 12 test vectors
1487 "lno1pqps7sjqpgtyzm3qv4uxzmtsd3jjqer9wd3hy6tsw35k7msjzfpy7nz5yqcnygrfdej82um5wf5k2uckyypwa3eyt44h6txtxquqh7lz5djge4afgfjn7k4rgrkuag0jsd5xvxg+",
1488 "lno1pqps7sjqpgtyzm3qv4uxzmtsd3jjqer9wd3hy6tsw35k7msjzfpy7nz5yqcnygrfdej82um5wf5k2uckyypwa3eyt44h6txtxquqh7lz5djge4afgfjn7k4rgrkuag0jsd5xvxg+ ",
1489 "+lno1pqps7sjqpgtyzm3qv4uxzmtsd3jjqer9wd3hy6tsw35k7msjzfpy7nz5yqcnygrfdej82um5wf5k2uckyypwa3eyt44h6txtxquqh7lz5djge4afgfjn7k4rgrkuag0jsd5xvxg",
1490 "+ lno1pqps7sjqpgtyzm3qv4uxzmtsd3jjqer9wd3hy6tsw35k7msjzfpy7nz5yqcnygrfdej82um5wf5k2uckyypwa3eyt44h6txtxquqh7lz5djge4afgfjn7k4rgrkuag0jsd5xvxg",
1491 "ln++o1pqps7sjqpgtyzm3qv4uxzmtsd3jjqer9wd3hy6tsw35k7msjzfpy7nz5yqcnygrfdej82um5wf5k2uckyypwa3eyt44h6txtxquqh7lz5djge4afgfjn7k4rgrkuag0jsd5xvxg",
1493 for encoded_offer in &offers {
1494 match encoded_offer.parse::<Offer>() {
1495 Ok(_) => panic!("Valid offer: {}", encoded_offer),
1496 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidContinuation),
1503 fn fails_parsing_bech32_encoded_offer_with_invalid_hrp() {
1504 let encoded_offer = "lni1pqps7sjqpgtyzm3qv4uxzmtsd3jjqer9wd3hy6tsw35k7msjzfpy7nz5yqcnygrfdej82um5wf5k2uckyypwa3eyt44h6txtxquqh7lz5djge4afgfjn7k4rgrkuag0jsd5xvxg";
1505 match encoded_offer.parse::<Offer>() {
1506 Ok(_) => panic!("Valid offer: {}", encoded_offer),
1507 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidBech32Hrp),
1512 fn fails_parsing_bech32_encoded_offer_with_invalid_bech32_data() {
1513 let encoded_offer = "lno1pqps7sjqpgtyzm3qv4uxzmtsd3jjqer9wd3hy6tsw35k7msjzfpy7nz5yqcnygrfdej82um5wf5k2uckyypwa3eyt44h6txtxquqh7lz5djge4afgfjn7k4rgrkuag0jsd5xvxo";
1514 match encoded_offer.parse::<Offer>() {
1515 Ok(_) => panic!("Valid offer: {}", encoded_offer),
1516 Err(e) => assert_eq!(e, Bolt12ParseError::Bech32(bech32::Error::InvalidChar('o'))),
1521 fn fails_parsing_bech32_encoded_offer_with_invalid_tlv_data() {
1522 let encoded_offer = "lno1pqps7sjqpgtyzm3qv4uxzmtsd3jjqer9wd3hy6tsw35k7msjzfpy7nz5yqcnygrfdej82um5wf5k2uckyypwa3eyt44h6txtxquqh7lz5djge4afgfjn7k4rgrkuag0jsd5xvxgqqqqq";
1523 match encoded_offer.parse::<Offer>() {
1524 Ok(_) => panic!("Valid offer: {}", encoded_offer),
1525 Err(e) => assert_eq!(e, Bolt12ParseError::Decode(DecodeError::InvalidValue)),