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 refunds.
12 //! A [`Refund`] is an "offer for money" and is typically constructed by a merchant and presented
13 //! directly to the customer. The recipient responds with a [`Bolt12Invoice`] to be paid.
15 //! This is an [`InvoiceRequest`] produced *not* in response to an [`Offer`].
17 //! [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
18 //! [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
19 //! [`Offer`]: crate::offers::offer::Offer
24 //! extern crate bitcoin;
25 //! extern crate core;
26 //! extern crate lightning;
28 //! use core::convert::TryFrom;
29 //! use core::time::Duration;
31 //! use bitcoin::network::constants::Network;
32 //! use bitcoin::secp256k1::{KeyPair, PublicKey, Secp256k1, SecretKey};
33 //! use lightning::offers::parse::Bolt12ParseError;
34 //! use lightning::offers::refund::{Refund, RefundBuilder};
35 //! use lightning::util::ser::{Readable, Writeable};
37 //! # use lightning::blinded_path::BlindedPath;
38 //! # #[cfg(feature = "std")]
39 //! # use std::time::SystemTime;
41 //! # fn create_blinded_path() -> BlindedPath { unimplemented!() }
42 //! # fn create_another_blinded_path() -> BlindedPath { unimplemented!() }
44 //! # #[cfg(feature = "std")]
45 //! # fn build() -> Result<(), Bolt12ParseError> {
46 //! let secp_ctx = Secp256k1::new();
47 //! let keys = KeyPair::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
48 //! let pubkey = PublicKey::from(keys);
50 //! let expiration = SystemTime::now() + Duration::from_secs(24 * 60 * 60);
51 //! let refund = RefundBuilder::new("coffee, large".to_string(), vec![1; 32], pubkey, 20_000)?
52 //! .absolute_expiry(expiration.duration_since(SystemTime::UNIX_EPOCH).unwrap())
53 //! .issuer("Foo Bar".to_string())
54 //! .path(create_blinded_path())
55 //! .path(create_another_blinded_path())
56 //! .chain(Network::Bitcoin)
57 //! .payer_note("refund for order #12345".to_string())
60 //! // Encode as a bech32 string for use in a QR code.
61 //! let encoded_refund = refund.to_string();
63 //! // Parse from a bech32 string after scanning from a QR code.
64 //! let refund = encoded_refund.parse::<Refund>()?;
66 //! // Encode refund as raw bytes.
67 //! let mut bytes = Vec::new();
68 //! refund.write(&mut bytes).unwrap();
70 //! // Decode raw bytes into an refund.
71 //! let refund = Refund::try_from(bytes)?;
78 //! If constructing a [`Refund`] for use with a [`ChannelManager`], use
79 //! [`ChannelManager::create_refund_builder`] instead of [`RefundBuilder::new`].
81 //! [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
82 //! [`ChannelManager::create_refund_builder`]: crate::ln::channelmanager::ChannelManager::create_refund_builder
84 use bitcoin::blockdata::constants::ChainHash;
85 use bitcoin::network::constants::Network;
86 use bitcoin::secp256k1::{PublicKey, Secp256k1, self};
87 use core::hash::{Hash, Hasher};
89 use core::str::FromStr;
90 use core::time::Duration;
91 use crate::sign::EntropySource;
93 use crate::blinded_path::BlindedPath;
94 use crate::ln::PaymentHash;
95 use crate::ln::channelmanager::PaymentId;
96 use crate::ln::features::InvoiceRequestFeatures;
97 use crate::ln::inbound_payment::{ExpandedKey, IV_LEN, Nonce};
98 use crate::ln::msgs::{DecodeError, MAX_VALUE_MSAT};
99 use crate::offers::invoice::BlindedPayInfo;
100 use crate::offers::invoice_request::{InvoiceRequestTlvStream, InvoiceRequestTlvStreamRef};
101 use crate::offers::offer::{OfferTlvStream, OfferTlvStreamRef};
102 use crate::offers::parse::{Bech32Encode, Bolt12ParseError, Bolt12SemanticError, ParsedMessage};
103 use crate::offers::payer::{PayerContents, PayerTlvStream, PayerTlvStreamRef};
104 use crate::offers::signer::{Metadata, MetadataMaterial, self};
105 use crate::util::ser::{SeekReadable, WithoutLength, Writeable, Writer};
106 use crate::util::string::PrintableString;
108 #[cfg(not(c_bindings))]
110 crate::offers::invoice::{DerivedSigningPubkey, ExplicitSigningPubkey, InvoiceBuilder},
114 crate::offers::invoice::{InvoiceWithDerivedSigningPubkeyBuilder, InvoiceWithExplicitSigningPubkeyBuilder},
117 #[allow(unused_imports)]
118 use crate::prelude::*;
120 #[cfg(feature = "std")]
121 use std::time::SystemTime;
123 pub(super) const IV_BYTES: &[u8; IV_LEN] = b"LDK Refund ~~~~~";
125 /// Builds a [`Refund`] for the "offer for money" flow.
127 /// See [module-level documentation] for usage.
129 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
131 /// [module-level documentation]: self
132 pub struct RefundBuilder<'a, T: secp256k1::Signing> {
133 refund: RefundContents,
134 secp_ctx: Option<&'a Secp256k1<T>>,
137 /// Builds a [`Refund`] for the "offer for money" flow.
139 /// See [module-level documentation] for usage.
141 /// [module-level documentation]: self
143 pub struct RefundMaybeWithDerivedMetadataBuilder<'a> {
144 refund: RefundContents,
145 secp_ctx: Option<&'a Secp256k1<secp256k1::All>>,
148 macro_rules! refund_explicit_metadata_builder_methods { () => {
149 /// Creates a new builder for a refund using the [`Refund::payer_id`] for the public node id to
150 /// send to if no [`Refund::paths`] are set. Otherwise, it may be a transient pubkey.
152 /// Additionally, sets the required [`Refund::description`], [`Refund::payer_metadata`], and
153 /// [`Refund::amount_msats`].
157 /// If constructing a [`Refund`] for use with a [`ChannelManager`], use
158 /// [`ChannelManager::create_refund_builder`] instead of [`RefundBuilder::new`].
160 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
161 /// [`ChannelManager::create_refund_builder`]: crate::ln::channelmanager::ChannelManager::create_refund_builder
163 description: String, metadata: Vec<u8>, payer_id: PublicKey, amount_msats: u64
164 ) -> Result<Self, Bolt12SemanticError> {
165 if amount_msats > MAX_VALUE_MSAT {
166 return Err(Bolt12SemanticError::InvalidAmount);
169 let metadata = Metadata::Bytes(metadata);
171 refund: RefundContents {
172 payer: PayerContents(metadata), description, absolute_expiry: None, issuer: None,
173 paths: None, chain: None, amount_msats, features: InvoiceRequestFeatures::empty(),
174 quantity: None, payer_id, payer_note: None,
181 macro_rules! refund_builder_methods { (
182 $self: ident, $self_type: ty, $return_type: ty, $return_value: expr, $secp_context: ty $(, $self_mut: tt)?
184 /// Similar to [`RefundBuilder::new`] except, if [`RefundBuilder::path`] is called, the payer id
185 /// is derived from the given [`ExpandedKey`] and nonce. This provides sender privacy by using a
186 /// different payer id for each refund, assuming a different nonce is used. Otherwise, the
187 /// provided `node_id` is used for the payer id.
189 /// Also, sets the metadata when [`RefundBuilder::build`] is called such that it can be used to
190 /// verify that an [`InvoiceRequest`] was produced for the refund given an [`ExpandedKey`].
192 /// The `payment_id` is encrypted in the metadata and should be unique. This ensures that only
193 /// one invoice will be paid for the refund and that payments can be uniquely identified.
195 /// [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
196 /// [`ExpandedKey`]: crate::ln::inbound_payment::ExpandedKey
197 pub fn deriving_payer_id<ES: Deref>(
198 description: String, node_id: PublicKey, expanded_key: &ExpandedKey, entropy_source: ES,
199 secp_ctx: &'a Secp256k1<$secp_context>, amount_msats: u64, payment_id: PaymentId
200 ) -> Result<Self, Bolt12SemanticError> where ES::Target: EntropySource {
201 if amount_msats > MAX_VALUE_MSAT {
202 return Err(Bolt12SemanticError::InvalidAmount);
205 let nonce = Nonce::from_entropy_source(entropy_source);
206 let payment_id = Some(payment_id);
207 let derivation_material = MetadataMaterial::new(nonce, expanded_key, IV_BYTES, payment_id);
208 let metadata = Metadata::DerivedSigningPubkey(derivation_material);
210 refund: RefundContents {
211 payer: PayerContents(metadata), description, absolute_expiry: None, issuer: None,
212 paths: None, chain: None, amount_msats, features: InvoiceRequestFeatures::empty(),
213 quantity: None, payer_id: node_id, payer_note: None,
215 secp_ctx: Some(secp_ctx),
219 /// Sets the [`Refund::absolute_expiry`] as seconds since the Unix epoch. Any expiry that has
220 /// already passed is valid and can be checked for using [`Refund::is_expired`].
222 /// Successive calls to this method will override the previous setting.
223 pub fn absolute_expiry($($self_mut)* $self: $self_type, absolute_expiry: Duration) -> $return_type {
224 $self.refund.absolute_expiry = Some(absolute_expiry);
228 /// Sets the [`Refund::issuer`].
230 /// Successive calls to this method will override the previous setting.
231 pub fn issuer($($self_mut)* $self: $self_type, issuer: String) -> $return_type {
232 $self.refund.issuer = Some(issuer);
236 /// Adds a blinded path to [`Refund::paths`]. Must include at least one path if only connected
237 /// by private channels or if [`Refund::payer_id`] is not a public node id.
239 /// Successive calls to this method will add another blinded path. Caller is responsible for not
240 /// adding duplicate paths.
241 pub fn path($($self_mut)* $self: $self_type, path: BlindedPath) -> $return_type {
242 $self.refund.paths.get_or_insert_with(Vec::new).push(path);
246 /// Sets the [`Refund::chain`] of the given [`Network`] for paying an invoice. If not
247 /// called, [`Network::Bitcoin`] is assumed.
249 /// Successive calls to this method will override the previous setting.
250 pub fn chain($self: $self_type, network: Network) -> $return_type {
251 $self.chain_hash(ChainHash::using_genesis_block(network))
254 /// Sets the [`Refund::chain`] of the given [`ChainHash`] for paying an invoice. If not called,
255 /// [`Network::Bitcoin`] is assumed.
257 /// Successive calls to this method will override the previous setting.
258 pub(crate) fn chain_hash($($self_mut)* $self: $self_type, chain: ChainHash) -> $return_type {
259 $self.refund.chain = Some(chain);
263 /// Sets [`Refund::quantity`] of items. This is purely for informational purposes. It is useful
264 /// when the refund pertains to a [`Bolt12Invoice`] that paid for more than one item from an
265 /// [`Offer`] as specified by [`InvoiceRequest::quantity`].
267 /// Successive calls to this method will override the previous setting.
269 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
270 /// [`InvoiceRequest::quantity`]: crate::offers::invoice_request::InvoiceRequest::quantity
271 /// [`Offer`]: crate::offers::offer::Offer
272 pub fn quantity($($self_mut)* $self: $self_type, quantity: u64) -> $return_type {
273 $self.refund.quantity = Some(quantity);
277 /// Sets the [`Refund::payer_note`].
279 /// Successive calls to this method will override the previous setting.
280 pub fn payer_note($($self_mut)* $self: $self_type, payer_note: String) -> $return_type {
281 $self.refund.payer_note = Some(payer_note);
285 /// Builds a [`Refund`] after checking for valid semantics.
286 pub fn build($($self_mut)* $self: $self_type) -> Result<Refund, Bolt12SemanticError> {
287 if $self.refund.chain() == $self.refund.implied_chain() {
288 $self.refund.chain = None;
291 // Create the metadata for stateless verification of a Bolt12Invoice.
292 if $self.refund.payer.0.has_derivation_material() {
293 let mut metadata = core::mem::take(&mut $self.refund.payer.0);
295 if $self.refund.paths.is_none() {
296 metadata = metadata.without_keys();
299 let mut tlv_stream = $self.refund.as_tlv_stream();
300 tlv_stream.0.metadata = None;
301 if metadata.derives_payer_keys() {
302 tlv_stream.2.payer_id = None;
305 let (derived_metadata, keys) = metadata.derive_from(tlv_stream, $self.secp_ctx);
306 metadata = derived_metadata;
307 if let Some(keys) = keys {
308 $self.refund.payer_id = keys.public_key();
311 $self.refund.payer.0 = metadata;
314 let mut bytes = Vec::new();
315 $self.refund.write(&mut bytes).unwrap();
319 #[cfg(not(c_bindings))]
320 contents: $self.refund,
322 contents: $self.refund.clone(),
328 macro_rules! refund_builder_test_methods { (
329 $self: ident, $self_type: ty, $return_type: ty, $return_value: expr $(, $self_mut: tt)?
331 #[cfg_attr(c_bindings, allow(dead_code))]
332 pub(crate) fn clear_paths($($self_mut)* $self: $self_type) -> $return_type {
333 $self.refund.paths = None;
337 #[cfg_attr(c_bindings, allow(dead_code))]
338 fn features_unchecked($($self_mut)* $self: $self_type, features: InvoiceRequestFeatures) -> $return_type {
339 $self.refund.features = features;
344 impl<'a> RefundBuilder<'a, secp256k1::SignOnly> {
345 refund_explicit_metadata_builder_methods!();
348 impl<'a, T: secp256k1::Signing> RefundBuilder<'a, T> {
349 refund_builder_methods!(self, Self, Self, self, T, mut);
352 refund_builder_test_methods!(self, Self, Self, self, mut);
355 #[cfg(all(c_bindings, not(test)))]
356 impl<'a> RefundMaybeWithDerivedMetadataBuilder<'a> {
357 refund_explicit_metadata_builder_methods!();
358 refund_builder_methods!(self, &mut Self, (), (), secp256k1::All);
361 #[cfg(all(c_bindings, test))]
362 impl<'a> RefundMaybeWithDerivedMetadataBuilder<'a> {
363 refund_explicit_metadata_builder_methods!();
364 refund_builder_methods!(self, &mut Self, &mut Self, self, secp256k1::All);
365 refund_builder_test_methods!(self, &mut Self, &mut Self, self);
369 impl<'a> From<RefundBuilder<'a, secp256k1::All>>
370 for RefundMaybeWithDerivedMetadataBuilder<'a> {
371 fn from(builder: RefundBuilder<'a, secp256k1::All>) -> Self {
372 let RefundBuilder { refund, secp_ctx } = builder;
374 Self { refund, secp_ctx }
379 impl<'a> From<RefundMaybeWithDerivedMetadataBuilder<'a>>
380 for RefundBuilder<'a, secp256k1::All> {
381 fn from(builder: RefundMaybeWithDerivedMetadataBuilder<'a>) -> Self {
382 let RefundMaybeWithDerivedMetadataBuilder { refund, secp_ctx } = builder;
384 Self { refund, secp_ctx }
388 /// A `Refund` is a request to send an [`Bolt12Invoice`] without a preceding [`Offer`].
390 /// Typically, after an invoice is paid, the recipient may publish a refund allowing the sender to
391 /// recoup their funds. A refund may be used more generally as an "offer for money", such as with a
394 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
395 /// [`Offer`]: crate::offers::offer::Offer
396 #[derive(Clone, Debug)]
398 pub(super) bytes: Vec<u8>,
399 pub(super) contents: RefundContents,
402 /// The contents of a [`Refund`], which may be shared with an [`Bolt12Invoice`].
404 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
405 #[derive(Clone, Debug)]
406 #[cfg_attr(test, derive(PartialEq))]
407 pub(super) struct RefundContents {
408 payer: PayerContents,
411 absolute_expiry: Option<Duration>,
412 issuer: Option<String>,
413 paths: Option<Vec<BlindedPath>>,
414 // invoice_request fields
415 chain: Option<ChainHash>,
417 features: InvoiceRequestFeatures,
418 quantity: Option<u64>,
420 payer_note: Option<String>,
424 /// A complete description of the purpose of the refund. Intended to be displayed to the user
425 /// but with the caveat that it has not been verified in any way.
426 pub fn description(&self) -> PrintableString {
427 self.contents.description()
430 /// Duration since the Unix epoch when an invoice should no longer be sent.
432 /// If `None`, the refund does not expire.
433 pub fn absolute_expiry(&self) -> Option<Duration> {
434 self.contents.absolute_expiry()
437 /// Whether the refund has expired.
438 #[cfg(feature = "std")]
439 pub fn is_expired(&self) -> bool {
440 self.contents.is_expired()
443 /// Whether the refund has expired given the duration since the Unix epoch.
444 pub fn is_expired_no_std(&self, duration_since_epoch: Duration) -> bool {
445 self.contents.is_expired_no_std(duration_since_epoch)
448 /// The issuer of the refund, possibly beginning with `user@domain` or `domain`. Intended to be
449 /// displayed to the user but with the caveat that it has not been verified in any way.
450 pub fn issuer(&self) -> Option<PrintableString> {
451 self.contents.issuer()
454 /// Paths to the sender originating from publicly reachable nodes. Blinded paths provide sender
455 /// privacy by obfuscating its node id.
456 pub fn paths(&self) -> &[BlindedPath] {
457 self.contents.paths()
460 /// An unpredictable series of bytes, typically containing information about the derivation of
463 /// [`payer_id`]: Self::payer_id
464 pub fn payer_metadata(&self) -> &[u8] {
465 self.contents.metadata()
468 /// A chain that the refund is valid for.
469 pub fn chain(&self) -> ChainHash {
470 self.contents.chain()
473 /// The amount to refund in msats (i.e., the minimum lightning-payable unit for [`chain`]).
475 /// [`chain`]: Self::chain
476 pub fn amount_msats(&self) -> u64 {
477 self.contents.amount_msats()
480 /// Features pertaining to requesting an invoice.
481 pub fn features(&self) -> &InvoiceRequestFeatures {
482 &self.contents.features()
485 /// The quantity of an item that refund is for.
486 pub fn quantity(&self) -> Option<u64> {
487 self.contents.quantity()
490 /// A public node id to send to in the case where there are no [`paths`]. Otherwise, a possibly
491 /// transient pubkey.
493 /// [`paths`]: Self::paths
494 pub fn payer_id(&self) -> PublicKey {
495 self.contents.payer_id()
498 /// Payer provided note to include in the invoice.
499 pub fn payer_note(&self) -> Option<PrintableString> {
500 self.contents.payer_note()
504 macro_rules! respond_with_explicit_signing_pubkey_methods { ($self: ident, $builder: ty) => {
505 /// Creates an [`InvoiceBuilder`] for the refund with the given required fields and using the
506 /// [`Duration`] since [`std::time::SystemTime::UNIX_EPOCH`] as the creation time.
508 /// See [`Refund::respond_with_no_std`] for further details where the aforementioned creation
509 /// time is used for the `created_at` parameter.
511 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
513 /// [`Duration`]: core::time::Duration
514 #[cfg(feature = "std")]
516 &$self, payment_paths: Vec<(BlindedPayInfo, BlindedPath)>, payment_hash: PaymentHash,
517 signing_pubkey: PublicKey,
518 ) -> Result<$builder, Bolt12SemanticError> {
519 let created_at = std::time::SystemTime::now()
520 .duration_since(std::time::SystemTime::UNIX_EPOCH)
521 .expect("SystemTime::now() should come after SystemTime::UNIX_EPOCH");
523 $self.respond_with_no_std(payment_paths, payment_hash, signing_pubkey, created_at)
526 /// Creates an [`InvoiceBuilder`] for the refund with the given required fields.
528 /// Unless [`InvoiceBuilder::relative_expiry`] is set, the invoice will expire two hours after
529 /// `created_at`, which is used to set [`Bolt12Invoice::created_at`]. Useful for `no-std` builds
530 /// where [`std::time::SystemTime`] is not available.
532 /// The caller is expected to remember the preimage of `payment_hash` in order to
533 /// claim a payment for the invoice.
535 /// The `signing_pubkey` is required to sign the invoice since refunds are not in response to an
536 /// offer, which does have a `signing_pubkey`.
538 /// The `payment_paths` parameter is useful for maintaining the payment recipient's privacy. It
539 /// must contain one or more elements ordered from most-preferred to least-preferred, if there's
540 /// a preference. Note, however, that any privacy is lost if a public node id is used for
541 /// `signing_pubkey`.
543 /// Errors if the request contains unknown required features.
545 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
547 /// [`Bolt12Invoice::created_at`]: crate::offers::invoice::Bolt12Invoice::created_at
548 pub fn respond_with_no_std(
549 &$self, payment_paths: Vec<(BlindedPayInfo, BlindedPath)>, payment_hash: PaymentHash,
550 signing_pubkey: PublicKey, created_at: Duration
551 ) -> Result<$builder, Bolt12SemanticError> {
552 if $self.features().requires_unknown_bits() {
553 return Err(Bolt12SemanticError::UnknownRequiredFeatures);
556 <$builder>::for_refund($self, payment_paths, created_at, payment_hash, signing_pubkey)
560 macro_rules! respond_with_derived_signing_pubkey_methods { ($self: ident, $builder: ty) => {
561 /// Creates an [`InvoiceBuilder`] for the refund using the given required fields and that uses
562 /// derived signing keys to sign the [`Bolt12Invoice`].
564 /// See [`Refund::respond_with`] for further details.
566 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
568 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
569 #[cfg(feature = "std")]
570 pub fn respond_using_derived_keys<ES: Deref>(
571 &$self, payment_paths: Vec<(BlindedPayInfo, BlindedPath)>, payment_hash: PaymentHash,
572 expanded_key: &ExpandedKey, entropy_source: ES
573 ) -> Result<$builder, Bolt12SemanticError>
575 ES::Target: EntropySource,
577 let created_at = std::time::SystemTime::now()
578 .duration_since(std::time::SystemTime::UNIX_EPOCH)
579 .expect("SystemTime::now() should come after SystemTime::UNIX_EPOCH");
581 $self.respond_using_derived_keys_no_std(
582 payment_paths, payment_hash, created_at, expanded_key, entropy_source
586 /// Creates an [`InvoiceBuilder`] for the refund using the given required fields and that uses
587 /// derived signing keys to sign the [`Bolt12Invoice`].
589 /// See [`Refund::respond_with_no_std`] for further details.
591 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
593 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
594 pub fn respond_using_derived_keys_no_std<ES: Deref>(
595 &$self, payment_paths: Vec<(BlindedPayInfo, BlindedPath)>, payment_hash: PaymentHash,
596 created_at: core::time::Duration, expanded_key: &ExpandedKey, entropy_source: ES
597 ) -> Result<$builder, Bolt12SemanticError>
599 ES::Target: EntropySource,
601 if $self.features().requires_unknown_bits() {
602 return Err(Bolt12SemanticError::UnknownRequiredFeatures);
605 let nonce = Nonce::from_entropy_source(entropy_source);
606 let keys = signer::derive_keys(nonce, expanded_key);
607 <$builder>::for_refund_using_keys($self, payment_paths, created_at, payment_hash, keys)
611 #[cfg(not(c_bindings))]
613 respond_with_explicit_signing_pubkey_methods!(self, InvoiceBuilder<ExplicitSigningPubkey>);
614 respond_with_derived_signing_pubkey_methods!(self, InvoiceBuilder<DerivedSigningPubkey>);
619 respond_with_explicit_signing_pubkey_methods!(self, InvoiceWithExplicitSigningPubkeyBuilder);
620 respond_with_derived_signing_pubkey_methods!(self, InvoiceWithDerivedSigningPubkeyBuilder);
625 fn as_tlv_stream(&self) -> RefundTlvStreamRef {
626 self.contents.as_tlv_stream()
630 impl AsRef<[u8]> for Refund {
631 fn as_ref(&self) -> &[u8] {
636 impl PartialEq for Refund {
637 fn eq(&self, other: &Self) -> bool {
638 self.bytes.eq(&other.bytes)
642 impl Eq for Refund {}
644 impl Hash for Refund {
645 fn hash<H: Hasher>(&self, state: &mut H) {
646 self.bytes.hash(state);
650 impl RefundContents {
651 pub fn description(&self) -> PrintableString {
652 PrintableString(&self.description)
655 pub fn absolute_expiry(&self) -> Option<Duration> {
659 #[cfg(feature = "std")]
660 pub(super) fn is_expired(&self) -> bool {
661 SystemTime::UNIX_EPOCH
663 .map(|duration_since_epoch| self.is_expired_no_std(duration_since_epoch))
667 pub(super) fn is_expired_no_std(&self, duration_since_epoch: Duration) -> bool {
669 .map(|absolute_expiry| duration_since_epoch > absolute_expiry)
673 pub fn issuer(&self) -> Option<PrintableString> {
674 self.issuer.as_ref().map(|issuer| PrintableString(issuer.as_str()))
677 pub fn paths(&self) -> &[BlindedPath] {
678 self.paths.as_ref().map(|paths| paths.as_slice()).unwrap_or(&[])
681 pub(super) fn metadata(&self) -> &[u8] {
682 self.payer.0.as_bytes().map(|bytes| bytes.as_slice()).unwrap_or(&[])
685 pub(super) fn chain(&self) -> ChainHash {
686 self.chain.unwrap_or_else(|| self.implied_chain())
689 pub fn implied_chain(&self) -> ChainHash {
690 ChainHash::using_genesis_block(Network::Bitcoin)
693 pub fn amount_msats(&self) -> u64 {
697 /// Features pertaining to requesting an invoice.
698 pub fn features(&self) -> &InvoiceRequestFeatures {
702 /// The quantity of an item that refund is for.
703 pub fn quantity(&self) -> Option<u64> {
707 /// A public node id to send to in the case where there are no [`paths`]. Otherwise, a possibly
708 /// transient pubkey.
710 /// [`paths`]: Self::paths
711 pub fn payer_id(&self) -> PublicKey {
715 /// Payer provided note to include in the invoice.
716 pub fn payer_note(&self) -> Option<PrintableString> {
717 self.payer_note.as_ref().map(|payer_note| PrintableString(payer_note.as_str()))
720 pub(super) fn derives_keys(&self) -> bool {
721 self.payer.0.derives_payer_keys()
724 pub(super) fn as_tlv_stream(&self) -> RefundTlvStreamRef {
725 let payer = PayerTlvStreamRef {
726 metadata: self.payer.0.as_bytes(),
729 let offer = OfferTlvStreamRef {
734 description: Some(&self.description),
736 absolute_expiry: self.absolute_expiry.map(|duration| duration.as_secs()),
737 paths: self.paths.as_ref(),
738 issuer: self.issuer.as_ref(),
744 if self.features == InvoiceRequestFeatures::empty() { None }
745 else { Some(&self.features) }
748 let invoice_request = InvoiceRequestTlvStreamRef {
749 chain: self.chain.as_ref(),
750 amount: Some(self.amount_msats),
752 quantity: self.quantity,
753 payer_id: Some(&self.payer_id),
754 payer_note: self.payer_note.as_ref(),
757 (payer, offer, invoice_request)
761 impl Writeable for Refund {
762 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
763 WithoutLength(&self.bytes).write(writer)
767 impl Writeable for RefundContents {
768 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
769 self.as_tlv_stream().write(writer)
773 type RefundTlvStream = (PayerTlvStream, OfferTlvStream, InvoiceRequestTlvStream);
775 type RefundTlvStreamRef<'a> = (
776 PayerTlvStreamRef<'a>,
777 OfferTlvStreamRef<'a>,
778 InvoiceRequestTlvStreamRef<'a>,
781 impl SeekReadable for RefundTlvStream {
782 fn read<R: io::Read + io::Seek>(r: &mut R) -> Result<Self, DecodeError> {
783 let payer = SeekReadable::read(r)?;
784 let offer = SeekReadable::read(r)?;
785 let invoice_request = SeekReadable::read(r)?;
787 Ok((payer, offer, invoice_request))
791 impl Bech32Encode for Refund {
792 const BECH32_HRP: &'static str = "lnr";
795 impl FromStr for Refund {
796 type Err = Bolt12ParseError;
798 fn from_str(s: &str) -> Result<Self, <Self as FromStr>::Err> {
799 Refund::from_bech32_str(s)
803 impl TryFrom<Vec<u8>> for Refund {
804 type Error = Bolt12ParseError;
806 fn try_from(bytes: Vec<u8>) -> Result<Self, Self::Error> {
807 let refund = ParsedMessage::<RefundTlvStream>::try_from(bytes)?;
808 let ParsedMessage { bytes, tlv_stream } = refund;
809 let contents = RefundContents::try_from(tlv_stream)?;
811 Ok(Refund { bytes, contents })
815 impl TryFrom<RefundTlvStream> for RefundContents {
816 type Error = Bolt12SemanticError;
818 fn try_from(tlv_stream: RefundTlvStream) -> Result<Self, Self::Error> {
820 PayerTlvStream { metadata: payer_metadata },
822 chains, metadata, currency, amount: offer_amount, description,
823 features: offer_features, absolute_expiry, paths, issuer, quantity_max, node_id,
825 InvoiceRequestTlvStream { chain, amount, features, quantity, payer_id, payer_note },
828 let payer = match payer_metadata {
829 None => return Err(Bolt12SemanticError::MissingPayerMetadata),
830 Some(metadata) => PayerContents(Metadata::Bytes(metadata)),
833 if metadata.is_some() {
834 return Err(Bolt12SemanticError::UnexpectedMetadata);
837 if chains.is_some() {
838 return Err(Bolt12SemanticError::UnexpectedChain);
841 if currency.is_some() || offer_amount.is_some() {
842 return Err(Bolt12SemanticError::UnexpectedAmount);
845 let description = match description {
846 None => return Err(Bolt12SemanticError::MissingDescription),
847 Some(description) => description,
850 if offer_features.is_some() {
851 return Err(Bolt12SemanticError::UnexpectedFeatures);
854 let absolute_expiry = absolute_expiry.map(Duration::from_secs);
856 if quantity_max.is_some() {
857 return Err(Bolt12SemanticError::UnexpectedQuantity);
860 if node_id.is_some() {
861 return Err(Bolt12SemanticError::UnexpectedSigningPubkey);
864 let amount_msats = match amount {
865 None => return Err(Bolt12SemanticError::MissingAmount),
866 Some(amount_msats) if amount_msats > MAX_VALUE_MSAT => {
867 return Err(Bolt12SemanticError::InvalidAmount);
869 Some(amount_msats) => amount_msats,
872 let features = features.unwrap_or_else(InvoiceRequestFeatures::empty);
874 let payer_id = match payer_id {
875 None => return Err(Bolt12SemanticError::MissingPayerId),
876 Some(payer_id) => payer_id,
880 payer, description, absolute_expiry, issuer, paths, chain, amount_msats, features,
881 quantity, payer_id, payer_note,
886 impl core::fmt::Display for Refund {
887 fn fmt(&self, f: &mut core::fmt::Formatter) -> Result<(), core::fmt::Error> {
888 self.fmt_bech32_str(f)
894 use super::{Refund, RefundTlvStreamRef};
895 #[cfg(not(c_bindings))]
897 super::RefundBuilder,
901 super::RefundMaybeWithDerivedMetadataBuilder as RefundBuilder,
904 use bitcoin::blockdata::constants::ChainHash;
905 use bitcoin::network::constants::Network;
906 use bitcoin::secp256k1::{KeyPair, Secp256k1, SecretKey};
908 use core::time::Duration;
910 use crate::blinded_path::{BlindedHop, BlindedPath, IntroductionNode};
911 use crate::sign::KeyMaterial;
912 use crate::ln::channelmanager::PaymentId;
913 use crate::ln::features::{InvoiceRequestFeatures, OfferFeatures};
914 use crate::ln::inbound_payment::ExpandedKey;
915 use crate::ln::msgs::{DecodeError, MAX_VALUE_MSAT};
916 use crate::offers::invoice_request::InvoiceRequestTlvStreamRef;
917 use crate::offers::offer::OfferTlvStreamRef;
918 use crate::offers::parse::{Bolt12ParseError, Bolt12SemanticError};
919 use crate::offers::payer::PayerTlvStreamRef;
920 use crate::offers::test_utils::*;
921 use crate::util::ser::{BigSize, Writeable};
922 use crate::util::string::PrintableString;
923 use crate::prelude::*;
926 fn to_bytes(&self) -> Vec<u8>;
929 impl<'a> ToBytes for RefundTlvStreamRef<'a> {
930 fn to_bytes(&self) -> Vec<u8> {
931 let mut buffer = Vec::new();
932 self.write(&mut buffer).unwrap();
938 fn builds_refund_with_defaults() {
939 let refund = RefundBuilder::new("foo".into(), vec![1; 32], payer_pubkey(), 1000).unwrap()
942 let mut buffer = Vec::new();
943 refund.write(&mut buffer).unwrap();
945 assert_eq!(refund.bytes, buffer.as_slice());
946 assert_eq!(refund.payer_metadata(), &[1; 32]);
947 assert_eq!(refund.description(), PrintableString("foo"));
948 assert_eq!(refund.absolute_expiry(), None);
949 #[cfg(feature = "std")]
950 assert!(!refund.is_expired());
951 assert_eq!(refund.paths(), &[]);
952 assert_eq!(refund.issuer(), None);
953 assert_eq!(refund.chain(), ChainHash::using_genesis_block(Network::Bitcoin));
954 assert_eq!(refund.amount_msats(), 1000);
955 assert_eq!(refund.features(), &InvoiceRequestFeatures::empty());
956 assert_eq!(refund.payer_id(), payer_pubkey());
957 assert_eq!(refund.payer_note(), None);
960 refund.as_tlv_stream(),
962 PayerTlvStreamRef { metadata: Some(&vec![1; 32]) },
968 description: Some(&String::from("foo")),
970 absolute_expiry: None,
976 InvoiceRequestTlvStreamRef {
981 payer_id: Some(&payer_pubkey()),
987 if let Err(e) = Refund::try_from(buffer) {
988 panic!("error parsing refund: {:?}", e);
993 fn fails_building_refund_with_invalid_amount() {
994 match RefundBuilder::new("foo".into(), vec![1; 32], payer_pubkey(), MAX_VALUE_MSAT + 1) {
995 Ok(_) => panic!("expected error"),
996 Err(e) => assert_eq!(e, Bolt12SemanticError::InvalidAmount),
1001 fn builds_refund_with_metadata_derived() {
1002 let desc = "foo".to_string();
1003 let node_id = payer_pubkey();
1004 let expanded_key = ExpandedKey::new(&KeyMaterial([42; 32]));
1005 let entropy = FixedEntropy {};
1006 let secp_ctx = Secp256k1::new();
1007 let payment_id = PaymentId([1; 32]);
1009 let refund = RefundBuilder
1010 ::deriving_payer_id(desc, node_id, &expanded_key, &entropy, &secp_ctx, 1000, payment_id)
1013 assert_eq!(refund.payer_id(), node_id);
1015 // Fails verification with altered fields
1016 let invoice = refund
1017 .respond_with_no_std(payment_paths(), payment_hash(), recipient_pubkey(), now())
1020 .sign(recipient_sign).unwrap();
1021 match invoice.verify(&expanded_key, &secp_ctx) {
1022 Ok(payment_id) => assert_eq!(payment_id, PaymentId([1; 32])),
1023 Err(()) => panic!("verification failed"),
1026 let mut tlv_stream = refund.as_tlv_stream();
1027 tlv_stream.2.amount = Some(2000);
1029 let mut encoded_refund = Vec::new();
1030 tlv_stream.write(&mut encoded_refund).unwrap();
1032 let invoice = Refund::try_from(encoded_refund).unwrap()
1033 .respond_with_no_std(payment_paths(), payment_hash(), recipient_pubkey(), now())
1036 .sign(recipient_sign).unwrap();
1037 assert!(invoice.verify(&expanded_key, &secp_ctx).is_err());
1039 // Fails verification with altered metadata
1040 let mut tlv_stream = refund.as_tlv_stream();
1041 let metadata = tlv_stream.0.metadata.unwrap().iter().copied().rev().collect();
1042 tlv_stream.0.metadata = Some(&metadata);
1044 let mut encoded_refund = Vec::new();
1045 tlv_stream.write(&mut encoded_refund).unwrap();
1047 let invoice = Refund::try_from(encoded_refund).unwrap()
1048 .respond_with_no_std(payment_paths(), payment_hash(), recipient_pubkey(), now())
1051 .sign(recipient_sign).unwrap();
1052 assert!(invoice.verify(&expanded_key, &secp_ctx).is_err());
1056 fn builds_refund_with_derived_payer_id() {
1057 let desc = "foo".to_string();
1058 let node_id = payer_pubkey();
1059 let expanded_key = ExpandedKey::new(&KeyMaterial([42; 32]));
1060 let entropy = FixedEntropy {};
1061 let secp_ctx = Secp256k1::new();
1062 let payment_id = PaymentId([1; 32]);
1064 let blinded_path = BlindedPath {
1065 introduction_node: IntroductionNode::NodeId(pubkey(40)),
1066 blinding_point: pubkey(41),
1068 BlindedHop { blinded_node_id: pubkey(43), encrypted_payload: vec![0; 43] },
1069 BlindedHop { blinded_node_id: node_id, encrypted_payload: vec![0; 44] },
1073 let refund = RefundBuilder
1074 ::deriving_payer_id(desc, node_id, &expanded_key, &entropy, &secp_ctx, 1000, payment_id)
1078 assert_ne!(refund.payer_id(), node_id);
1080 let invoice = refund
1081 .respond_with_no_std(payment_paths(), payment_hash(), recipient_pubkey(), now())
1084 .sign(recipient_sign).unwrap();
1085 match invoice.verify(&expanded_key, &secp_ctx) {
1086 Ok(payment_id) => assert_eq!(payment_id, PaymentId([1; 32])),
1087 Err(()) => panic!("verification failed"),
1090 // Fails verification with altered fields
1091 let mut tlv_stream = refund.as_tlv_stream();
1092 tlv_stream.2.amount = Some(2000);
1094 let mut encoded_refund = Vec::new();
1095 tlv_stream.write(&mut encoded_refund).unwrap();
1097 let invoice = Refund::try_from(encoded_refund).unwrap()
1098 .respond_with_no_std(payment_paths(), payment_hash(), recipient_pubkey(), now())
1101 .sign(recipient_sign).unwrap();
1102 assert!(invoice.verify(&expanded_key, &secp_ctx).is_err());
1104 // Fails verification with altered payer_id
1105 let mut tlv_stream = refund.as_tlv_stream();
1106 let payer_id = pubkey(1);
1107 tlv_stream.2.payer_id = Some(&payer_id);
1109 let mut encoded_refund = Vec::new();
1110 tlv_stream.write(&mut encoded_refund).unwrap();
1112 let invoice = Refund::try_from(encoded_refund).unwrap()
1113 .respond_with_no_std(payment_paths(), payment_hash(), recipient_pubkey(), now())
1116 .sign(recipient_sign).unwrap();
1117 assert!(invoice.verify(&expanded_key, &secp_ctx).is_err());
1121 fn builds_refund_with_absolute_expiry() {
1122 let future_expiry = Duration::from_secs(u64::max_value());
1123 let past_expiry = Duration::from_secs(0);
1124 let now = future_expiry - Duration::from_secs(1_000);
1126 let refund = RefundBuilder::new("foo".into(), vec![1; 32], payer_pubkey(), 1000).unwrap()
1127 .absolute_expiry(future_expiry)
1130 let (_, tlv_stream, _) = refund.as_tlv_stream();
1131 #[cfg(feature = "std")]
1132 assert!(!refund.is_expired());
1133 assert!(!refund.is_expired_no_std(now));
1134 assert_eq!(refund.absolute_expiry(), Some(future_expiry));
1135 assert_eq!(tlv_stream.absolute_expiry, Some(future_expiry.as_secs()));
1137 let refund = RefundBuilder::new("foo".into(), vec![1; 32], payer_pubkey(), 1000).unwrap()
1138 .absolute_expiry(future_expiry)
1139 .absolute_expiry(past_expiry)
1142 let (_, tlv_stream, _) = refund.as_tlv_stream();
1143 #[cfg(feature = "std")]
1144 assert!(refund.is_expired());
1145 assert!(refund.is_expired_no_std(now));
1146 assert_eq!(refund.absolute_expiry(), Some(past_expiry));
1147 assert_eq!(tlv_stream.absolute_expiry, Some(past_expiry.as_secs()));
1151 fn builds_refund_with_paths() {
1154 introduction_node: IntroductionNode::NodeId(pubkey(40)),
1155 blinding_point: pubkey(41),
1157 BlindedHop { blinded_node_id: pubkey(43), encrypted_payload: vec![0; 43] },
1158 BlindedHop { blinded_node_id: pubkey(44), encrypted_payload: vec![0; 44] },
1162 introduction_node: IntroductionNode::NodeId(pubkey(40)),
1163 blinding_point: pubkey(41),
1165 BlindedHop { blinded_node_id: pubkey(45), encrypted_payload: vec![0; 45] },
1166 BlindedHop { blinded_node_id: pubkey(46), encrypted_payload: vec![0; 46] },
1171 let refund = RefundBuilder::new("foo".into(), vec![1; 32], payer_pubkey(), 1000).unwrap()
1172 .path(paths[0].clone())
1173 .path(paths[1].clone())
1176 let (_, offer_tlv_stream, invoice_request_tlv_stream) = refund.as_tlv_stream();
1177 assert_eq!(refund.paths(), paths.as_slice());
1178 assert_eq!(refund.payer_id(), pubkey(42));
1179 assert_ne!(pubkey(42), pubkey(44));
1180 assert_eq!(offer_tlv_stream.paths, Some(&paths));
1181 assert_eq!(invoice_request_tlv_stream.payer_id, Some(&pubkey(42)));
1185 fn builds_refund_with_issuer() {
1186 let refund = RefundBuilder::new("foo".into(), vec![1; 32], payer_pubkey(), 1000).unwrap()
1187 .issuer("bar".into())
1190 let (_, tlv_stream, _) = refund.as_tlv_stream();
1191 assert_eq!(refund.issuer(), Some(PrintableString("bar")));
1192 assert_eq!(tlv_stream.issuer, Some(&String::from("bar")));
1194 let refund = RefundBuilder::new("foo".into(), vec![1; 32], payer_pubkey(), 1000).unwrap()
1195 .issuer("bar".into())
1196 .issuer("baz".into())
1199 let (_, tlv_stream, _) = refund.as_tlv_stream();
1200 assert_eq!(refund.issuer(), Some(PrintableString("baz")));
1201 assert_eq!(tlv_stream.issuer, Some(&String::from("baz")));
1205 fn builds_refund_with_chain() {
1206 let mainnet = ChainHash::using_genesis_block(Network::Bitcoin);
1207 let testnet = ChainHash::using_genesis_block(Network::Testnet);
1209 let refund = RefundBuilder::new("foo".into(), vec![1; 32], payer_pubkey(), 1000).unwrap()
1210 .chain(Network::Bitcoin)
1212 let (_, _, tlv_stream) = refund.as_tlv_stream();
1213 assert_eq!(refund.chain(), mainnet);
1214 assert_eq!(tlv_stream.chain, None);
1216 let refund = RefundBuilder::new("foo".into(), vec![1; 32], payer_pubkey(), 1000).unwrap()
1217 .chain(Network::Testnet)
1219 let (_, _, tlv_stream) = refund.as_tlv_stream();
1220 assert_eq!(refund.chain(), testnet);
1221 assert_eq!(tlv_stream.chain, Some(&testnet));
1223 let refund = RefundBuilder::new("foo".into(), vec![1; 32], payer_pubkey(), 1000).unwrap()
1224 .chain(Network::Regtest)
1225 .chain(Network::Testnet)
1227 let (_, _, tlv_stream) = refund.as_tlv_stream();
1228 assert_eq!(refund.chain(), testnet);
1229 assert_eq!(tlv_stream.chain, Some(&testnet));
1233 fn builds_refund_with_quantity() {
1234 let refund = RefundBuilder::new("foo".into(), vec![1; 32], payer_pubkey(), 1000).unwrap()
1237 let (_, _, tlv_stream) = refund.as_tlv_stream();
1238 assert_eq!(refund.quantity(), Some(10));
1239 assert_eq!(tlv_stream.quantity, Some(10));
1241 let refund = RefundBuilder::new("foo".into(), vec![1; 32], payer_pubkey(), 1000).unwrap()
1245 let (_, _, tlv_stream) = refund.as_tlv_stream();
1246 assert_eq!(refund.quantity(), Some(1));
1247 assert_eq!(tlv_stream.quantity, Some(1));
1251 fn builds_refund_with_payer_note() {
1252 let refund = RefundBuilder::new("foo".into(), vec![1; 32], payer_pubkey(), 1000).unwrap()
1253 .payer_note("bar".into())
1255 let (_, _, tlv_stream) = refund.as_tlv_stream();
1256 assert_eq!(refund.payer_note(), Some(PrintableString("bar")));
1257 assert_eq!(tlv_stream.payer_note, Some(&String::from("bar")));
1259 let refund = RefundBuilder::new("foo".into(), vec![1; 32], payer_pubkey(), 1000).unwrap()
1260 .payer_note("bar".into())
1261 .payer_note("baz".into())
1263 let (_, _, tlv_stream) = refund.as_tlv_stream();
1264 assert_eq!(refund.payer_note(), Some(PrintableString("baz")));
1265 assert_eq!(tlv_stream.payer_note, Some(&String::from("baz")));
1269 fn fails_responding_with_unknown_required_features() {
1270 match RefundBuilder::new("foo".into(), vec![1; 32], payer_pubkey(), 1000).unwrap()
1271 .features_unchecked(InvoiceRequestFeatures::unknown())
1273 .respond_with_no_std(payment_paths(), payment_hash(), recipient_pubkey(), now())
1275 Ok(_) => panic!("expected error"),
1276 Err(e) => assert_eq!(e, Bolt12SemanticError::UnknownRequiredFeatures),
1281 fn parses_refund_with_metadata() {
1282 let refund = RefundBuilder::new("foo".into(), vec![1; 32], payer_pubkey(), 1000).unwrap()
1284 if let Err(e) = refund.to_string().parse::<Refund>() {
1285 panic!("error parsing refund: {:?}", e);
1288 let mut tlv_stream = refund.as_tlv_stream();
1289 tlv_stream.0.metadata = None;
1291 match Refund::try_from(tlv_stream.to_bytes()) {
1292 Ok(_) => panic!("expected error"),
1294 assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingPayerMetadata));
1300 fn parses_refund_with_description() {
1301 let refund = RefundBuilder::new("foo".into(), vec![1; 32], payer_pubkey(), 1000).unwrap()
1303 if let Err(e) = refund.to_string().parse::<Refund>() {
1304 panic!("error parsing refund: {:?}", e);
1307 let mut tlv_stream = refund.as_tlv_stream();
1308 tlv_stream.1.description = None;
1310 match Refund::try_from(tlv_stream.to_bytes()) {
1311 Ok(_) => panic!("expected error"),
1313 assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingDescription));
1319 fn parses_refund_with_amount() {
1320 let refund = RefundBuilder::new("foo".into(), vec![1; 32], payer_pubkey(), 1000).unwrap()
1322 if let Err(e) = refund.to_string().parse::<Refund>() {
1323 panic!("error parsing refund: {:?}", e);
1326 let mut tlv_stream = refund.as_tlv_stream();
1327 tlv_stream.2.amount = None;
1329 match Refund::try_from(tlv_stream.to_bytes()) {
1330 Ok(_) => panic!("expected error"),
1332 assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingAmount));
1336 let mut tlv_stream = refund.as_tlv_stream();
1337 tlv_stream.2.amount = Some(MAX_VALUE_MSAT + 1);
1339 match Refund::try_from(tlv_stream.to_bytes()) {
1340 Ok(_) => panic!("expected error"),
1342 assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::InvalidAmount));
1348 fn parses_refund_with_payer_id() {
1349 let refund = RefundBuilder::new("foo".into(), vec![1; 32], payer_pubkey(), 1000).unwrap()
1351 if let Err(e) = refund.to_string().parse::<Refund>() {
1352 panic!("error parsing refund: {:?}", e);
1355 let mut tlv_stream = refund.as_tlv_stream();
1356 tlv_stream.2.payer_id = None;
1358 match Refund::try_from(tlv_stream.to_bytes()) {
1359 Ok(_) => panic!("expected error"),
1361 assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingPayerId));
1367 fn parses_refund_with_optional_fields() {
1368 let past_expiry = Duration::from_secs(0);
1371 introduction_node: IntroductionNode::NodeId(pubkey(40)),
1372 blinding_point: pubkey(41),
1374 BlindedHop { blinded_node_id: pubkey(43), encrypted_payload: vec![0; 43] },
1375 BlindedHop { blinded_node_id: pubkey(44), encrypted_payload: vec![0; 44] },
1379 introduction_node: IntroductionNode::NodeId(pubkey(40)),
1380 blinding_point: pubkey(41),
1382 BlindedHop { blinded_node_id: pubkey(45), encrypted_payload: vec![0; 45] },
1383 BlindedHop { blinded_node_id: pubkey(46), encrypted_payload: vec![0; 46] },
1388 let refund = RefundBuilder::new("foo".into(), vec![1; 32], payer_pubkey(), 1000).unwrap()
1389 .absolute_expiry(past_expiry)
1390 .issuer("bar".into())
1391 .path(paths[0].clone())
1392 .path(paths[1].clone())
1393 .chain(Network::Testnet)
1394 .features_unchecked(InvoiceRequestFeatures::unknown())
1396 .payer_note("baz".into())
1399 match refund.to_string().parse::<Refund>() {
1401 assert_eq!(refund.absolute_expiry(), Some(past_expiry));
1402 #[cfg(feature = "std")]
1403 assert!(refund.is_expired());
1404 assert_eq!(refund.paths(), &paths[..]);
1405 assert_eq!(refund.issuer(), Some(PrintableString("bar")));
1406 assert_eq!(refund.chain(), ChainHash::using_genesis_block(Network::Testnet));
1407 assert_eq!(refund.features(), &InvoiceRequestFeatures::unknown());
1408 assert_eq!(refund.quantity(), Some(10));
1409 assert_eq!(refund.payer_note(), Some(PrintableString("baz")));
1411 Err(e) => panic!("error parsing refund: {:?}", e),
1416 fn fails_parsing_refund_with_unexpected_fields() {
1417 let refund = RefundBuilder::new("foo".into(), vec![1; 32], payer_pubkey(), 1000).unwrap()
1419 if let Err(e) = refund.to_string().parse::<Refund>() {
1420 panic!("error parsing refund: {:?}", e);
1423 let metadata = vec![42; 32];
1424 let mut tlv_stream = refund.as_tlv_stream();
1425 tlv_stream.1.metadata = Some(&metadata);
1427 match Refund::try_from(tlv_stream.to_bytes()) {
1428 Ok(_) => panic!("expected error"),
1430 assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::UnexpectedMetadata));
1434 let chains = vec![ChainHash::using_genesis_block(Network::Testnet)];
1435 let mut tlv_stream = refund.as_tlv_stream();
1436 tlv_stream.1.chains = Some(&chains);
1438 match Refund::try_from(tlv_stream.to_bytes()) {
1439 Ok(_) => panic!("expected error"),
1441 assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::UnexpectedChain));
1445 let mut tlv_stream = refund.as_tlv_stream();
1446 tlv_stream.1.currency = Some(&b"USD");
1447 tlv_stream.1.amount = Some(1000);
1449 match Refund::try_from(tlv_stream.to_bytes()) {
1450 Ok(_) => panic!("expected error"),
1452 assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::UnexpectedAmount));
1456 let features = OfferFeatures::unknown();
1457 let mut tlv_stream = refund.as_tlv_stream();
1458 tlv_stream.1.features = Some(&features);
1460 match Refund::try_from(tlv_stream.to_bytes()) {
1461 Ok(_) => panic!("expected error"),
1463 assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::UnexpectedFeatures));
1467 let mut tlv_stream = refund.as_tlv_stream();
1468 tlv_stream.1.quantity_max = Some(10);
1470 match Refund::try_from(tlv_stream.to_bytes()) {
1471 Ok(_) => panic!("expected error"),
1473 assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::UnexpectedQuantity));
1477 let node_id = payer_pubkey();
1478 let mut tlv_stream = refund.as_tlv_stream();
1479 tlv_stream.1.node_id = Some(&node_id);
1481 match Refund::try_from(tlv_stream.to_bytes()) {
1482 Ok(_) => panic!("expected error"),
1484 assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::UnexpectedSigningPubkey));
1490 fn fails_parsing_refund_with_extra_tlv_records() {
1491 let secp_ctx = Secp256k1::new();
1492 let keys = KeyPair::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
1493 let refund = RefundBuilder::new("foo".into(), vec![1; 32], keys.public_key(), 1000).unwrap()
1496 let mut encoded_refund = Vec::new();
1497 refund.write(&mut encoded_refund).unwrap();
1498 BigSize(1002).write(&mut encoded_refund).unwrap();
1499 BigSize(32).write(&mut encoded_refund).unwrap();
1500 [42u8; 32].write(&mut encoded_refund).unwrap();
1502 match Refund::try_from(encoded_refund) {
1503 Ok(_) => panic!("expected error"),
1504 Err(e) => assert_eq!(e, Bolt12ParseError::Decode(DecodeError::InvalidValue)),