1 #![deny(rustdoc::broken_intra_doc_links)]
2 #![deny(rustdoc::private_intra_doc_links)]
5 #![deny(non_upper_case_globals)]
6 #![deny(non_camel_case_types)]
7 #![deny(non_snake_case)]
10 #![cfg_attr(docsrs, feature(doc_auto_cfg))]
12 #![cfg_attr(feature = "strict", deny(warnings))]
13 #![cfg_attr(all(not(feature = "std"), not(test)), no_std)]
15 //! This crate provides data structures to represent
16 //! [lightning BOLT11](https://github.com/lightning/bolts/blob/master/11-payment-encoding.md)
17 //! invoices and functions to create, encode and decode these. If you just want to use the standard
18 //! en-/decoding functionality this should get you started:
20 //! * For parsing use `str::parse::<Bolt11Invoice>(&self)` (see [`Bolt11Invoice::from_str`])
21 //! * For constructing invoices use the [`InvoiceBuilder`]
22 //! * For serializing invoices use the [`Display`]/[`ToString`] traits
24 //! [`Bolt11Invoice::from_str`]: crate::Bolt11Invoice#impl-FromStr
26 #[cfg(not(any(feature = "std", feature = "no-std")))]
27 compile_error!("at least one of the `std` or `no-std` features must be enabled");
33 #[macro_use] extern crate lightning;
34 extern crate num_traits;
35 extern crate secp256k1;
37 #[cfg(any(test, feature = "std"))]
39 #[cfg(feature = "serde")]
42 #[cfg(feature = "std")]
43 use std::time::SystemTime;
46 use bitcoin::{Address, Network, PubkeyHash, ScriptHash};
47 use bitcoin::address::{Payload, WitnessProgram, WitnessVersion};
48 use bitcoin::hashes::{Hash, sha256};
49 use lightning::ln::features::Bolt11InvoiceFeatures;
50 use lightning::util::invoice::construct_invoice_preimage;
52 use secp256k1::PublicKey;
53 use secp256k1::{Message, Secp256k1};
54 use secp256k1::ecdsa::RecoverableSignature;
56 use core::cmp::Ordering;
57 use core::fmt::{Display, Formatter, self};
58 use core::iter::FilterMap;
59 use core::num::ParseIntError;
61 use core::slice::Iter;
62 use core::time::Duration;
65 #[cfg(feature = "serde")]
66 use serde::{Deserialize, Deserializer,Serialize, Serializer, de::Error};
69 pub use lightning::ln::PaymentSecret;
71 pub use lightning::routing::router::{RouteHint, RouteHintHop};
73 pub use lightning::routing::gossip::RoutingFees;
74 use lightning::util::string::UntrustedString;
80 #[allow(unused_imports)]
82 pub use alloc::{vec, vec::Vec, string::String};
84 pub use alloc::string::ToString;
87 use crate::prelude::*;
89 /// Errors that indicate what is wrong with the invoice. They have some granularity for debug
90 /// reasons, but should generally result in an "invalid BOLT11 invoice" message for the user.
91 #[allow(missing_docs)]
92 #[derive(PartialEq, Eq, Debug, Clone)]
93 pub enum Bolt11ParseError {
94 Bech32Error(bech32::Error),
95 ParseAmountError(ParseIntError),
96 MalformedSignature(secp256k1::Error),
102 UnexpectedEndOfTaggedFields,
103 DescriptionDecodeError(str::Utf8Error),
105 IntegerOverflowError,
106 InvalidSegWitProgramLength,
107 InvalidPubKeyHashLength,
108 InvalidScriptHashLength,
110 InvalidSliceLength(String),
112 /// Not an error, but used internally to signal that a part of the invoice should be ignored
113 /// according to BOLT11
117 /// Indicates that something went wrong while parsing or validating the invoice. Parsing errors
118 /// should be mostly seen as opaque and are only there for debugging reasons. Semantic errors
119 /// like wrong signatures, missing fields etc. could mean that someone tampered with the invoice.
120 #[derive(PartialEq, Eq, Debug, Clone)]
121 pub enum ParseOrSemanticError {
122 /// The invoice couldn't be decoded
123 ParseError(Bolt11ParseError),
125 /// The invoice could be decoded but violates the BOLT11 standard
126 SemanticError(crate::Bolt11SemanticError),
129 /// The number of bits used to represent timestamps as defined in BOLT 11.
130 const TIMESTAMP_BITS: usize = 35;
132 /// The maximum timestamp as [`Duration::as_secs`] since the Unix epoch allowed by [`BOLT 11`].
134 /// [BOLT 11]: https://github.com/lightning/bolts/blob/master/11-payment-encoding.md
135 pub const MAX_TIMESTAMP: u64 = (1 << TIMESTAMP_BITS) - 1;
137 /// Default expiry time as defined by [BOLT 11].
139 /// [BOLT 11]: https://github.com/lightning/bolts/blob/master/11-payment-encoding.md
140 pub const DEFAULT_EXPIRY_TIME: u64 = 3600;
142 /// Default minimum final CLTV expiry as defined by [BOLT 11].
144 /// Note that this is *not* the same value as rust-lightning's minimum CLTV expiry, which is
145 /// provided in [`MIN_FINAL_CLTV_EXPIRY_DELTA`].
147 /// [BOLT 11]: https://github.com/lightning/bolts/blob/master/11-payment-encoding.md
148 /// [`MIN_FINAL_CLTV_EXPIRY_DELTA`]: lightning::ln::channelmanager::MIN_FINAL_CLTV_EXPIRY_DELTA
149 pub const DEFAULT_MIN_FINAL_CLTV_EXPIRY_DELTA: u64 = 18;
151 /// Builder for [`Bolt11Invoice`]s. It's the most convenient and advised way to use this library. It
152 /// ensures that only a semantically and syntactically correct invoice can be built using it.
155 /// extern crate secp256k1;
156 /// extern crate lightning;
157 /// extern crate lightning_invoice;
158 /// extern crate bitcoin;
160 /// use bitcoin::hashes::Hash;
161 /// use bitcoin::hashes::sha256;
163 /// use secp256k1::Secp256k1;
164 /// use secp256k1::SecretKey;
166 /// use lightning::ln::PaymentSecret;
168 /// use lightning_invoice::{Currency, InvoiceBuilder};
170 /// # #[cfg(not(feature = "std"))]
172 /// # #[cfg(feature = "std")]
174 /// let private_key = SecretKey::from_slice(
176 /// 0xe1, 0x26, 0xf6, 0x8f, 0x7e, 0xaf, 0xcc, 0x8b, 0x74, 0xf5, 0x4d, 0x26, 0x9f,
177 /// 0xe2, 0x06, 0xbe, 0x71, 0x50, 0x00, 0xf9, 0x4d, 0xac, 0x06, 0x7d, 0x1c, 0x04,
178 /// 0xa8, 0xca, 0x3b, 0x2d, 0xb7, 0x34
182 /// let payment_hash = sha256::Hash::from_slice(&[0; 32][..]).unwrap();
183 /// let payment_secret = PaymentSecret([42u8; 32]);
185 /// let invoice = InvoiceBuilder::new(Currency::Bitcoin)
186 /// .description("Coins pls!".into())
187 /// .payment_hash(payment_hash)
188 /// .payment_secret(payment_secret)
189 /// .current_timestamp()
190 /// .min_final_cltv_expiry_delta(144)
191 /// .build_signed(|hash| {
192 /// Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key)
196 /// assert!(invoice.to_string().starts_with("lnbc1"));
200 /// # Type parameters
201 /// The two parameters `D` and `H` signal if the builder already contains the correct amount of the
203 /// * `D`: exactly one [`TaggedField::Description`] or [`TaggedField::DescriptionHash`]
204 /// * `H`: exactly one [`TaggedField::PaymentHash`]
205 /// * `T`: the timestamp is set
206 /// * `C`: the CLTV expiry is set
207 /// * `S`: the payment secret is set
208 /// * `M`: payment metadata is set
210 /// This is not exported to bindings users as we likely need to manually select one set of boolean type parameters.
211 #[derive(Eq, PartialEq, Debug, Clone)]
212 pub struct InvoiceBuilder<D: tb::Bool, H: tb::Bool, T: tb::Bool, C: tb::Bool, S: tb::Bool, M: tb::Bool> {
215 si_prefix: Option<SiPrefix>,
216 timestamp: Option<PositiveTimestamp>,
217 tagged_fields: Vec<TaggedField>,
218 error: Option<CreationError>,
220 phantom_d: core::marker::PhantomData<D>,
221 phantom_h: core::marker::PhantomData<H>,
222 phantom_t: core::marker::PhantomData<T>,
223 phantom_c: core::marker::PhantomData<C>,
224 phantom_s: core::marker::PhantomData<S>,
225 phantom_m: core::marker::PhantomData<M>,
228 /// Represents a syntactically and semantically correct lightning BOLT11 invoice.
230 /// There are three ways to construct a `Bolt11Invoice`:
231 /// 1. using [`InvoiceBuilder`]
232 /// 2. using [`Bolt11Invoice::from_signed`]
233 /// 3. using `str::parse::<Bolt11Invoice>(&str)` (see [`Bolt11Invoice::from_str`])
235 /// [`Bolt11Invoice::from_str`]: crate::Bolt11Invoice#impl-FromStr
236 #[derive(Eq, PartialEq, Debug, Clone, Hash, Ord, PartialOrd)]
237 pub struct Bolt11Invoice {
238 signed_invoice: SignedRawBolt11Invoice,
241 /// Represents the description of an invoice which has to be either a directly included string or
242 /// a hash of a description provided out of band.
244 /// This is not exported to bindings users as we don't have a good way to map the reference lifetimes making this
245 /// practically impossible to use safely in languages like C.
246 #[derive(Eq, PartialEq, Debug, Clone, Ord, PartialOrd)]
247 pub enum Bolt11InvoiceDescription<'f> {
248 /// Reference to the directly supplied description in the invoice
249 Direct(&'f Description),
251 /// Reference to the description's hash included in the invoice
255 impl<'f> Display for Bolt11InvoiceDescription<'f> {
256 fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
258 Bolt11InvoiceDescription::Direct(desc) => write!(f, "{}", desc.0),
259 Bolt11InvoiceDescription::Hash(hash) => write!(f, "{}", hash.0),
264 /// Represents a signed [`RawBolt11Invoice`] with cached hash. The signature is not checked and may be
268 /// The hash has to be either from the deserialized invoice or from the serialized [`RawBolt11Invoice`].
269 #[derive(Eq, PartialEq, Debug, Clone, Hash, Ord, PartialOrd)]
270 pub struct SignedRawBolt11Invoice {
271 /// The raw invoice that the signature belongs to
272 raw_invoice: RawBolt11Invoice,
274 /// Hash of the [`RawBolt11Invoice`] that will be used to check the signature.
276 /// * if the `SignedRawBolt11Invoice` was deserialized the hash is of from the original encoded form,
277 /// since it's not guaranteed that encoding it again will lead to the same result since integers
278 /// could have been encoded with leading zeroes etc.
279 /// * if the `SignedRawBolt11Invoice` was constructed manually the hash will be the calculated hash
280 /// from the [`RawBolt11Invoice`]
283 /// signature of the payment request
284 signature: Bolt11InvoiceSignature,
287 /// Represents an syntactically correct [`Bolt11Invoice`] for a payment on the lightning network,
288 /// but without the signature information.
289 /// Decoding and encoding should not lead to information loss but may lead to different hashes.
291 /// For methods without docs see the corresponding methods in [`Bolt11Invoice`].
292 #[derive(Eq, PartialEq, Debug, Clone, Hash, Ord, PartialOrd)]
293 pub struct RawBolt11Invoice {
294 /// human readable part
298 pub data: RawDataPart,
301 /// Data of the [`RawBolt11Invoice`] that is encoded in the human readable part.
303 /// This is not exported to bindings users as we don't yet support `Option<Enum>`
304 #[derive(Eq, PartialEq, Debug, Clone, Hash, Ord, PartialOrd)]
306 /// The currency deferred from the 3rd and 4th character of the bech32 transaction
307 pub currency: Currency,
309 /// The amount that, multiplied by the SI prefix, has to be payed
310 pub raw_amount: Option<u64>,
312 /// SI prefix that gets multiplied with the `raw_amount`
313 pub si_prefix: Option<SiPrefix>,
316 /// Data of the [`RawBolt11Invoice`] that is encoded in the data part
317 #[derive(Eq, PartialEq, Debug, Clone, Hash, Ord, PartialOrd)]
318 pub struct RawDataPart {
319 /// generation time of the invoice
320 pub timestamp: PositiveTimestamp,
322 /// tagged fields of the payment request
323 pub tagged_fields: Vec<RawTaggedField>,
326 /// A timestamp that refers to a date after 1 January 1970.
330 /// The Unix timestamp representing the stored time has to be positive and no greater than
331 /// [`MAX_TIMESTAMP`].
332 #[derive(Eq, PartialEq, Debug, Clone, Hash, Ord, PartialOrd)]
333 pub struct PositiveTimestamp(Duration);
335 /// SI prefixes for the human readable part
336 #[derive(Eq, PartialEq, Debug, Clone, Copy, Hash, Ord, PartialOrd)]
349 /// Returns the multiplier to go from a BTC value to picoBTC implied by this SiPrefix.
350 /// This is effectively 10^12 * the prefix multiplier
351 pub fn multiplier(&self) -> u64 {
353 SiPrefix::Milli => 1_000_000_000,
354 SiPrefix::Micro => 1_000_000,
355 SiPrefix::Nano => 1_000,
360 /// Returns all enum variants of `SiPrefix` sorted in descending order of their associated
363 /// This is not exported to bindings users as we don't yet support a slice of enums, and also because this function
364 /// isn't the most critical to expose.
365 pub fn values_desc() -> &'static [SiPrefix] {
366 use crate::SiPrefix::*;
367 static VALUES: [SiPrefix; 4] = [Milli, Micro, Nano, Pico];
372 /// Enum representing the crypto currencies (or networks) supported by this library
373 #[derive(Clone, Debug, Hash, Eq, PartialEq, Ord, PartialOrd)]
391 impl From<Network> for Currency {
392 fn from(network: Network) -> Self {
394 Network::Bitcoin => Currency::Bitcoin,
395 Network::Testnet => Currency::BitcoinTestnet,
396 Network::Regtest => Currency::Regtest,
397 Network::Signet => Currency::Signet,
399 debug_assert!(false, "Need to handle new rust-bitcoin network type");
406 impl From<Currency> for Network {
407 fn from(currency: Currency) -> Self {
409 Currency::Bitcoin => Network::Bitcoin,
410 Currency::BitcoinTestnet => Network::Testnet,
411 Currency::Regtest => Network::Regtest,
412 Currency::Simnet => Network::Regtest,
413 Currency::Signet => Network::Signet,
418 /// Tagged field which may have an unknown tag
420 /// This is not exported to bindings users as we don't currently support TaggedField
421 #[derive(Clone, Debug, Hash, Eq, PartialEq, Ord, PartialOrd)]
422 pub enum RawTaggedField {
423 /// Parsed tagged field with known tag
424 KnownSemantics(TaggedField),
425 /// tagged field which was not parsed due to an unknown tag or undefined field semantics
426 UnknownSemantics(Vec<u5>),
429 /// Tagged field with known tag
431 /// For descriptions of the enum values please refer to the enclosed type's docs.
433 /// This is not exported to bindings users as we don't yet support enum variants with the same name the struct contained
435 #[allow(missing_docs)]
436 #[derive(Clone, Debug, Hash, Eq, PartialEq, Ord, PartialOrd)]
437 pub enum TaggedField {
439 Description(Description),
440 PayeePubKey(PayeePubKey),
441 DescriptionHash(Sha256),
442 ExpiryTime(ExpiryTime),
443 MinFinalCltvExpiryDelta(MinFinalCltvExpiryDelta),
445 PrivateRoute(PrivateRoute),
446 PaymentSecret(PaymentSecret),
447 PaymentMetadata(Vec<u8>),
448 Features(Bolt11InvoiceFeatures),
452 #[derive(Clone, Debug, Hash, Eq, PartialEq, Ord, PartialOrd)]
453 pub struct Sha256(/// This is not exported to bindings users as the native hash types are not currently mapped
457 /// Constructs a new [`Sha256`] from the given bytes, which are assumed to be the output of a
458 /// single sha256 hash.
460 pub fn from_bytes(bytes: &[u8; 32]) -> Self {
461 Self(sha256::Hash::from_slice(bytes).expect("from_slice only fails if len is not 32"))
465 /// Description string
468 /// The description can be at most 639 __bytes__ long
469 #[derive(Clone, Debug, Hash, Eq, PartialEq, Ord, PartialOrd, Default)]
470 pub struct Description(UntrustedString);
473 #[derive(Clone, Debug, Hash, Eq, PartialEq, Ord, PartialOrd)]
474 pub struct PayeePubKey(pub PublicKey);
476 /// Positive duration that defines when (relatively to the timestamp) in the future the invoice
478 #[derive(Clone, Debug, Hash, Eq, PartialEq, Ord, PartialOrd)]
479 pub struct ExpiryTime(Duration);
481 /// `min_final_cltv_expiry_delta` to use for the last HTLC in the route
482 #[derive(Clone, Debug, Hash, Eq, PartialEq, Ord, PartialOrd)]
483 pub struct MinFinalCltvExpiryDelta(pub u64);
485 /// Fallback address in case no LN payment is possible
486 #[allow(missing_docs)]
487 #[derive(Clone, Debug, Hash, Eq, PartialEq, Ord, PartialOrd)]
490 version: WitnessVersion,
493 PubKeyHash(PubkeyHash),
494 ScriptHash(ScriptHash),
497 /// Recoverable signature
498 #[derive(Clone, Debug, Hash, Eq, PartialEq)]
499 pub struct Bolt11InvoiceSignature(pub RecoverableSignature);
501 impl PartialOrd for Bolt11InvoiceSignature {
502 fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
503 Some(self.cmp(other))
507 impl Ord for Bolt11InvoiceSignature {
508 fn cmp(&self, other: &Self) -> Ordering {
509 self.0.serialize_compact().1.cmp(&other.0.serialize_compact().1)
513 /// Private routing information
516 /// The encoded route has to be <1024 5bit characters long (<=639 bytes or <=12 hops)
518 #[derive(Clone, Debug, Hash, Eq, PartialEq, Ord, PartialOrd)]
519 pub struct PrivateRoute(RouteHint);
521 /// Tag constants as specified in BOLT11
522 #[allow(missing_docs)]
524 pub const TAG_PAYMENT_HASH: u8 = 1;
525 pub const TAG_DESCRIPTION: u8 = 13;
526 pub const TAG_PAYEE_PUB_KEY: u8 = 19;
527 pub const TAG_DESCRIPTION_HASH: u8 = 23;
528 pub const TAG_EXPIRY_TIME: u8 = 6;
529 pub const TAG_MIN_FINAL_CLTV_EXPIRY_DELTA: u8 = 24;
530 pub const TAG_FALLBACK: u8 = 9;
531 pub const TAG_PRIVATE_ROUTE: u8 = 3;
532 pub const TAG_PAYMENT_SECRET: u8 = 16;
533 pub const TAG_PAYMENT_METADATA: u8 = 27;
534 pub const TAG_FEATURES: u8 = 5;
537 impl InvoiceBuilder<tb::False, tb::False, tb::False, tb::False, tb::False, tb::False> {
538 /// Construct new, empty `InvoiceBuilder`. All necessary fields have to be filled first before
539 /// `InvoiceBuilder::build(self)` becomes available.
540 pub fn new(currency: Currency) -> Self {
546 tagged_fields: Vec::with_capacity(8),
549 phantom_d: core::marker::PhantomData,
550 phantom_h: core::marker::PhantomData,
551 phantom_t: core::marker::PhantomData,
552 phantom_c: core::marker::PhantomData,
553 phantom_s: core::marker::PhantomData,
554 phantom_m: core::marker::PhantomData,
559 impl<D: tb::Bool, H: tb::Bool, T: tb::Bool, C: tb::Bool, S: tb::Bool, M: tb::Bool> InvoiceBuilder<D, H, T, C, S, M> {
560 /// Helper function to set the completeness flags.
561 fn set_flags<DN: tb::Bool, HN: tb::Bool, TN: tb::Bool, CN: tb::Bool, SN: tb::Bool, MN: tb::Bool>(self) -> InvoiceBuilder<DN, HN, TN, CN, SN, MN> {
562 InvoiceBuilder::<DN, HN, TN, CN, SN, MN> {
563 currency: self.currency,
565 si_prefix: self.si_prefix,
566 timestamp: self.timestamp,
567 tagged_fields: self.tagged_fields,
570 phantom_d: core::marker::PhantomData,
571 phantom_h: core::marker::PhantomData,
572 phantom_t: core::marker::PhantomData,
573 phantom_c: core::marker::PhantomData,
574 phantom_s: core::marker::PhantomData,
575 phantom_m: core::marker::PhantomData,
579 /// Sets the amount in millisatoshis. The optimal SI prefix is chosen automatically.
580 pub fn amount_milli_satoshis(mut self, amount_msat: u64) -> Self {
581 let amount = amount_msat * 10; // Invoices are denominated in "pico BTC"
582 let biggest_possible_si_prefix = SiPrefix::values_desc()
584 .find(|prefix| amount % prefix.multiplier() == 0)
585 .expect("Pico should always match");
586 self.amount = Some(amount / biggest_possible_si_prefix.multiplier());
587 self.si_prefix = Some(*biggest_possible_si_prefix);
591 /// Sets the payee's public key.
592 pub fn payee_pub_key(mut self, pub_key: PublicKey) -> Self {
593 self.tagged_fields.push(TaggedField::PayeePubKey(PayeePubKey(pub_key)));
597 /// Sets the expiry time, dropping the subsecond part (which is not representable in BOLT 11
599 pub fn expiry_time(mut self, expiry_time: Duration) -> Self {
600 self.tagged_fields.push(TaggedField::ExpiryTime(ExpiryTime::from_duration(expiry_time)));
604 /// Adds a fallback address.
605 pub fn fallback(mut self, fallback: Fallback) -> Self {
606 self.tagged_fields.push(TaggedField::Fallback(fallback));
610 /// Adds a private route.
611 pub fn private_route(mut self, hint: RouteHint) -> Self {
612 match PrivateRoute::new(hint) {
613 Ok(r) => self.tagged_fields.push(TaggedField::PrivateRoute(r)),
614 Err(e) => self.error = Some(e),
620 impl<D: tb::Bool, H: tb::Bool, C: tb::Bool, S: tb::Bool, M: tb::Bool> InvoiceBuilder<D, H, tb::True, C, S, M> {
621 /// Builds a [`RawBolt11Invoice`] if no [`CreationError`] occurred while construction any of the
623 pub fn build_raw(self) -> Result<RawBolt11Invoice, CreationError> {
625 // If an error occurred at any time before, return it now
626 if let Some(e) = self.error {
631 currency: self.currency,
632 raw_amount: self.amount,
633 si_prefix: self.si_prefix,
636 let timestamp = self.timestamp.expect("ensured to be Some(t) by type T");
638 let tagged_fields = self.tagged_fields.into_iter().map(|tf| {
639 RawTaggedField::KnownSemantics(tf)
640 }).collect::<Vec<_>>();
642 let data = RawDataPart {
647 Ok(RawBolt11Invoice {
654 impl<H: tb::Bool, T: tb::Bool, C: tb::Bool, S: tb::Bool, M: tb::Bool> InvoiceBuilder<tb::False, H, T, C, S, M> {
655 /// Set the description. This function is only available if no description (hash) was set.
656 pub fn description(mut self, description: String) -> InvoiceBuilder<tb::True, H, T, C, S, M> {
657 match Description::new(description) {
658 Ok(d) => self.tagged_fields.push(TaggedField::Description(d)),
659 Err(e) => self.error = Some(e),
664 /// Set the description hash. This function is only available if no description (hash) was set.
665 pub fn description_hash(mut self, description_hash: sha256::Hash) -> InvoiceBuilder<tb::True, H, T, C, S, M> {
666 self.tagged_fields.push(TaggedField::DescriptionHash(Sha256(description_hash)));
670 /// Set the description or description hash. This function is only available if no description (hash) was set.
671 pub fn invoice_description(self, description: Bolt11InvoiceDescription) -> InvoiceBuilder<tb::True, H, T, C, S, M> {
673 Bolt11InvoiceDescription::Direct(desc) => {
674 self.description(desc.clone().into_inner().0)
676 Bolt11InvoiceDescription::Hash(hash) => {
677 self.description_hash(hash.0)
683 impl<D: tb::Bool, T: tb::Bool, C: tb::Bool, S: tb::Bool, M: tb::Bool> InvoiceBuilder<D, tb::False, T, C, S, M> {
684 /// Set the payment hash. This function is only available if no payment hash was set.
685 pub fn payment_hash(mut self, hash: sha256::Hash) -> InvoiceBuilder<D, tb::True, T, C, S, M> {
686 self.tagged_fields.push(TaggedField::PaymentHash(Sha256(hash)));
691 impl<D: tb::Bool, H: tb::Bool, C: tb::Bool, S: tb::Bool, M: tb::Bool> InvoiceBuilder<D, H, tb::False, C, S, M> {
692 /// Sets the timestamp to a specific [`SystemTime`].
693 #[cfg(feature = "std")]
694 pub fn timestamp(mut self, time: SystemTime) -> InvoiceBuilder<D, H, tb::True, C, S, M> {
695 match PositiveTimestamp::from_system_time(time) {
696 Ok(t) => self.timestamp = Some(t),
697 Err(e) => self.error = Some(e),
703 /// Sets the timestamp to a duration since the Unix epoch, dropping the subsecond part (which
704 /// is not representable in BOLT 11 invoices).
705 pub fn duration_since_epoch(mut self, time: Duration) -> InvoiceBuilder<D, H, tb::True, C, S, M> {
706 match PositiveTimestamp::from_duration_since_epoch(time) {
707 Ok(t) => self.timestamp = Some(t),
708 Err(e) => self.error = Some(e),
714 /// Sets the timestamp to the current system time.
715 #[cfg(feature = "std")]
716 pub fn current_timestamp(mut self) -> InvoiceBuilder<D, H, tb::True, C, S, M> {
717 let now = PositiveTimestamp::from_system_time(SystemTime::now());
718 self.timestamp = Some(now.expect("for the foreseeable future this shouldn't happen"));
723 impl<D: tb::Bool, H: tb::Bool, T: tb::Bool, S: tb::Bool, M: tb::Bool> InvoiceBuilder<D, H, T, tb::False, S, M> {
724 /// Sets `min_final_cltv_expiry_delta`.
725 pub fn min_final_cltv_expiry_delta(mut self, min_final_cltv_expiry_delta: u64) -> InvoiceBuilder<D, H, T, tb::True, S, M> {
726 self.tagged_fields.push(TaggedField::MinFinalCltvExpiryDelta(MinFinalCltvExpiryDelta(min_final_cltv_expiry_delta)));
731 impl<D: tb::Bool, H: tb::Bool, T: tb::Bool, C: tb::Bool, M: tb::Bool> InvoiceBuilder<D, H, T, C, tb::False, M> {
732 /// Sets the payment secret and relevant features.
733 pub fn payment_secret(mut self, payment_secret: PaymentSecret) -> InvoiceBuilder<D, H, T, C, tb::True, M> {
734 let mut found_features = false;
735 for field in self.tagged_fields.iter_mut() {
736 if let TaggedField::Features(f) = field {
737 found_features = true;
738 f.set_variable_length_onion_required();
739 f.set_payment_secret_required();
742 self.tagged_fields.push(TaggedField::PaymentSecret(payment_secret));
744 let mut features = Bolt11InvoiceFeatures::empty();
745 features.set_variable_length_onion_required();
746 features.set_payment_secret_required();
747 self.tagged_fields.push(TaggedField::Features(features));
753 impl<D: tb::Bool, H: tb::Bool, T: tb::Bool, C: tb::Bool, S: tb::Bool> InvoiceBuilder<D, H, T, C, S, tb::False> {
754 /// Sets the payment metadata.
756 /// By default features are set to *optionally* allow the sender to include the payment metadata.
757 /// If you wish to require that the sender include the metadata (and fail to parse the invoice if
758 /// they don't support payment metadata fields), you need to call
759 /// [`InvoiceBuilder::require_payment_metadata`] after this.
760 pub fn payment_metadata(mut self, payment_metadata: Vec<u8>) -> InvoiceBuilder<D, H, T, C, S, tb::True> {
761 self.tagged_fields.push(TaggedField::PaymentMetadata(payment_metadata));
762 let mut found_features = false;
763 for field in self.tagged_fields.iter_mut() {
764 if let TaggedField::Features(f) = field {
765 found_features = true;
766 f.set_payment_metadata_optional();
770 let mut features = Bolt11InvoiceFeatures::empty();
771 features.set_payment_metadata_optional();
772 self.tagged_fields.push(TaggedField::Features(features));
778 impl<D: tb::Bool, H: tb::Bool, T: tb::Bool, C: tb::Bool, S: tb::Bool> InvoiceBuilder<D, H, T, C, S, tb::True> {
779 /// Sets forwarding of payment metadata as required. A reader of the invoice which does not
780 /// support sending payment metadata will fail to read the invoice.
781 pub fn require_payment_metadata(mut self) -> InvoiceBuilder<D, H, T, C, S, tb::True> {
782 for field in self.tagged_fields.iter_mut() {
783 if let TaggedField::Features(f) = field {
784 f.set_payment_metadata_required();
791 impl<D: tb::Bool, H: tb::Bool, T: tb::Bool, C: tb::Bool, M: tb::Bool> InvoiceBuilder<D, H, T, C, tb::True, M> {
792 /// Sets the `basic_mpp` feature as optional.
793 pub fn basic_mpp(mut self) -> Self {
794 for field in self.tagged_fields.iter_mut() {
795 if let TaggedField::Features(f) = field {
796 f.set_basic_mpp_optional();
803 impl<M: tb::Bool> InvoiceBuilder<tb::True, tb::True, tb::True, tb::True, tb::True, M> {
804 /// Builds and signs an invoice using the supplied `sign_function`. This function MAY NOT fail
805 /// and MUST produce a recoverable signature valid for the given hash and if applicable also for
806 /// the included payee public key.
807 pub fn build_signed<F>(self, sign_function: F) -> Result<Bolt11Invoice, CreationError>
808 where F: FnOnce(&Message) -> RecoverableSignature
810 let invoice = self.try_build_signed::<_, ()>(|hash| {
811 Ok(sign_function(hash))
816 Err(SignOrCreationError::CreationError(e)) => Err(e),
817 Err(SignOrCreationError::SignError(())) => unreachable!(),
821 /// Builds and signs an invoice using the supplied `sign_function`. This function MAY fail with
822 /// an error of type `E` and MUST produce a recoverable signature valid for the given hash and
823 /// if applicable also for the included payee public key.
824 pub fn try_build_signed<F, E>(self, sign_function: F) -> Result<Bolt11Invoice, SignOrCreationError<E>>
825 where F: FnOnce(&Message) -> Result<RecoverableSignature, E>
827 let raw = match self.build_raw() {
829 Err(e) => return Err(SignOrCreationError::CreationError(e)),
832 let signed = match raw.sign(sign_function) {
834 Err(e) => return Err(SignOrCreationError::SignError(e)),
837 let invoice = Bolt11Invoice {
838 signed_invoice: signed,
841 invoice.check_field_counts().expect("should be ensured by type signature of builder");
842 invoice.check_feature_bits().expect("should be ensured by type signature of builder");
843 invoice.check_amount().expect("should be ensured by type signature of builder");
850 impl SignedRawBolt11Invoice {
851 /// Disassembles the `SignedRawBolt11Invoice` into its three parts:
853 /// 2. hash of the raw invoice
855 pub fn into_parts(self) -> (RawBolt11Invoice, [u8; 32], Bolt11InvoiceSignature) {
856 (self.raw_invoice, self.hash, self.signature)
859 /// The [`RawBolt11Invoice`] which was signed.
860 pub fn raw_invoice(&self) -> &RawBolt11Invoice {
864 /// The hash of the [`RawBolt11Invoice`] that was signed.
865 pub fn signable_hash(&self) -> &[u8; 32] {
869 /// Signature for the invoice.
870 pub fn signature(&self) -> &Bolt11InvoiceSignature {
874 /// Recovers the public key used for signing the invoice from the recoverable signature.
875 pub fn recover_payee_pub_key(&self) -> Result<PayeePubKey, secp256k1::Error> {
876 let hash = Message::from_slice(&self.hash[..])
877 .expect("Hash is 32 bytes long, same as MESSAGE_SIZE");
879 Ok(PayeePubKey(Secp256k1::new().recover_ecdsa(
885 /// Checks if the signature is valid for the included payee public key or if none exists if it's
886 /// valid for the recovered signature (which should always be true?).
887 pub fn check_signature(&self) -> bool {
888 let included_pub_key = self.raw_invoice.payee_pub_key();
890 let mut recovered_pub_key = Option::None;
891 if recovered_pub_key.is_none() {
892 let recovered = match self.recover_payee_pub_key() {
894 Err(_) => return false,
896 recovered_pub_key = Some(recovered);
899 let pub_key = included_pub_key.or(recovered_pub_key.as_ref())
900 .expect("One is always present");
902 let hash = Message::from_slice(&self.hash[..])
903 .expect("Hash is 32 bytes long, same as MESSAGE_SIZE");
905 let secp_context = Secp256k1::new();
906 let verification_result = secp_context.verify_ecdsa(
908 &self.signature.to_standard(),
912 match verification_result {
919 /// Finds the first element of an enum stream of a given variant and extracts one member of the
920 /// variant. If no element was found `None` gets returned.
922 /// The following example would extract the first B.
930 /// let elements = vec![Enum::A(1), Enum::A(2), Enum::B(3), Enum::A(4)];
932 /// assert_eq!(find_extract!(elements.iter(), Enum::B(x), x), Some(3u16));
934 macro_rules! find_extract {
935 ($iter:expr, $enm:pat, $enm_var:ident) => {
936 find_all_extract!($iter, $enm, $enm_var).next()
940 /// Finds the all elements of an enum stream of a given variant and extracts one member of the
941 /// variant through an iterator.
943 /// The following example would extract all A.
951 /// let elements = vec![Enum::A(1), Enum::A(2), Enum::B(3), Enum::A(4)];
954 /// find_all_extract!(elements.iter(), Enum::A(x), x).collect::<Vec<u8>>(),
955 /// vec![1u8, 2u8, 4u8]
958 macro_rules! find_all_extract {
959 ($iter:expr, $enm:pat, $enm_var:ident) => {
960 $iter.filter_map(|tf| match *tf {
961 $enm => Some($enm_var),
967 #[allow(missing_docs)]
968 impl RawBolt11Invoice {
969 /// Hash the HRP as bytes and signatureless data part.
970 fn hash_from_parts(hrp_bytes: &[u8], data_without_signature: &[u5]) -> [u8; 32] {
971 let preimage = construct_invoice_preimage(hrp_bytes, data_without_signature);
972 let mut hash: [u8; 32] = Default::default();
973 hash.copy_from_slice(&sha256::Hash::hash(&preimage)[..]);
977 /// Calculate the hash of the encoded `RawBolt11Invoice` which should be signed.
978 pub fn signable_hash(&self) -> [u8; 32] {
979 use bech32::ToBase32;
981 RawBolt11Invoice::hash_from_parts(
982 self.hrp.to_string().as_bytes(),
983 &self.data.to_base32()
987 /// Signs the invoice using the supplied `sign_method`. This function MAY fail with an error of
988 /// type `E`. Since the signature of a [`SignedRawBolt11Invoice`] is not required to be valid there
989 /// are no constraints regarding the validity of the produced signature.
991 /// This is not exported to bindings users as we don't currently support passing function pointers into methods
993 pub fn sign<F, E>(self, sign_method: F) -> Result<SignedRawBolt11Invoice, E>
994 where F: FnOnce(&Message) -> Result<RecoverableSignature, E>
996 let raw_hash = self.signable_hash();
997 let hash = Message::from_slice(&raw_hash[..])
998 .expect("Hash is 32 bytes long, same as MESSAGE_SIZE");
999 let signature = sign_method(&hash)?;
1001 Ok(SignedRawBolt11Invoice {
1004 signature: Bolt11InvoiceSignature(signature),
1008 /// Returns an iterator over all tagged fields with known semantics.
1010 /// This is not exported to bindings users as there is not yet a manual mapping for a FilterMap
1011 pub fn known_tagged_fields(&self)
1012 -> FilterMap<Iter<RawTaggedField>, fn(&RawTaggedField) -> Option<&TaggedField>>
1014 // For 1.14.0 compatibility: closures' types can't be written an fn()->() in the
1015 // function's type signature.
1016 // TODO: refactor once impl Trait is available
1017 fn match_raw(raw: &RawTaggedField) -> Option<&TaggedField> {
1019 RawTaggedField::KnownSemantics(ref tf) => Some(tf),
1024 self.data.tagged_fields.iter().filter_map(match_raw )
1027 pub fn payment_hash(&self) -> Option<&Sha256> {
1028 find_extract!(self.known_tagged_fields(), TaggedField::PaymentHash(ref x), x)
1031 pub fn description(&self) -> Option<&Description> {
1032 find_extract!(self.known_tagged_fields(), TaggedField::Description(ref x), x)
1035 pub fn payee_pub_key(&self) -> Option<&PayeePubKey> {
1036 find_extract!(self.known_tagged_fields(), TaggedField::PayeePubKey(ref x), x)
1039 pub fn description_hash(&self) -> Option<&Sha256> {
1040 find_extract!(self.known_tagged_fields(), TaggedField::DescriptionHash(ref x), x)
1043 pub fn expiry_time(&self) -> Option<&ExpiryTime> {
1044 find_extract!(self.known_tagged_fields(), TaggedField::ExpiryTime(ref x), x)
1047 pub fn min_final_cltv_expiry_delta(&self) -> Option<&MinFinalCltvExpiryDelta> {
1048 find_extract!(self.known_tagged_fields(), TaggedField::MinFinalCltvExpiryDelta(ref x), x)
1051 pub fn payment_secret(&self) -> Option<&PaymentSecret> {
1052 find_extract!(self.known_tagged_fields(), TaggedField::PaymentSecret(ref x), x)
1055 pub fn payment_metadata(&self) -> Option<&Vec<u8>> {
1056 find_extract!(self.known_tagged_fields(), TaggedField::PaymentMetadata(ref x), x)
1059 pub fn features(&self) -> Option<&Bolt11InvoiceFeatures> {
1060 find_extract!(self.known_tagged_fields(), TaggedField::Features(ref x), x)
1063 /// This is not exported to bindings users as we don't support Vec<&NonOpaqueType>
1064 pub fn fallbacks(&self) -> Vec<&Fallback> {
1065 find_all_extract!(self.known_tagged_fields(), TaggedField::Fallback(ref x), x).collect()
1068 pub fn private_routes(&self) -> Vec<&PrivateRoute> {
1069 find_all_extract!(self.known_tagged_fields(), TaggedField::PrivateRoute(ref x), x).collect()
1072 pub fn amount_pico_btc(&self) -> Option<u64> {
1073 self.hrp.raw_amount.map(|v| {
1074 v * self.hrp.si_prefix.as_ref().map_or(1_000_000_000_000, |si| { si.multiplier() })
1078 pub fn currency(&self) -> Currency {
1079 self.hrp.currency.clone()
1083 impl PositiveTimestamp {
1084 /// Creates a `PositiveTimestamp` from a Unix timestamp in the range `0..=MAX_TIMESTAMP`.
1086 /// Otherwise, returns a [`CreationError::TimestampOutOfBounds`].
1087 pub fn from_unix_timestamp(unix_seconds: u64) -> Result<Self, CreationError> {
1088 if unix_seconds <= MAX_TIMESTAMP {
1089 Ok(Self(Duration::from_secs(unix_seconds)))
1091 Err(CreationError::TimestampOutOfBounds)
1095 /// Creates a `PositiveTimestamp` from a [`SystemTime`] with a corresponding Unix timestamp in
1096 /// the range `0..=MAX_TIMESTAMP`.
1098 /// Note that the subsecond part is dropped as it is not representable in BOLT 11 invoices.
1100 /// Otherwise, returns a [`CreationError::TimestampOutOfBounds`].
1101 #[cfg(feature = "std")]
1102 pub fn from_system_time(time: SystemTime) -> Result<Self, CreationError> {
1103 time.duration_since(SystemTime::UNIX_EPOCH)
1104 .map(Self::from_duration_since_epoch)
1105 .unwrap_or(Err(CreationError::TimestampOutOfBounds))
1108 /// Creates a `PositiveTimestamp` from a [`Duration`] since the Unix epoch in the range
1109 /// `0..=MAX_TIMESTAMP`.
1111 /// Note that the subsecond part is dropped as it is not representable in BOLT 11 invoices.
1113 /// Otherwise, returns a [`CreationError::TimestampOutOfBounds`].
1114 pub fn from_duration_since_epoch(duration: Duration) -> Result<Self, CreationError> {
1115 Self::from_unix_timestamp(duration.as_secs())
1118 /// Returns the Unix timestamp representing the stored time
1119 pub fn as_unix_timestamp(&self) -> u64 {
1123 /// Returns the duration of the stored time since the Unix epoch
1124 pub fn as_duration_since_epoch(&self) -> Duration {
1128 /// Returns the [`SystemTime`] representing the stored time
1129 #[cfg(feature = "std")]
1130 pub fn as_time(&self) -> SystemTime {
1131 SystemTime::UNIX_EPOCH + self.0
1135 impl From<PositiveTimestamp> for Duration {
1136 fn from(val: PositiveTimestamp) -> Self {
1141 #[cfg(feature = "std")]
1142 impl From<PositiveTimestamp> for SystemTime {
1143 fn from(val: PositiveTimestamp) -> Self {
1144 SystemTime::UNIX_EPOCH + val.0
1148 impl Bolt11Invoice {
1149 /// The hash of the [`RawBolt11Invoice`] that was signed.
1150 pub fn signable_hash(&self) -> [u8; 32] {
1151 self.signed_invoice.hash
1154 /// Transform the `Bolt11Invoice` into its unchecked version.
1155 pub fn into_signed_raw(self) -> SignedRawBolt11Invoice {
1159 /// Check that all mandatory fields are present
1160 fn check_field_counts(&self) -> Result<(), Bolt11SemanticError> {
1161 // "A writer MUST include exactly one p field […]."
1162 let payment_hash_cnt = self.tagged_fields().filter(|&tf| match *tf {
1163 TaggedField::PaymentHash(_) => true,
1166 if payment_hash_cnt < 1 {
1167 return Err(Bolt11SemanticError::NoPaymentHash);
1168 } else if payment_hash_cnt > 1 {
1169 return Err(Bolt11SemanticError::MultiplePaymentHashes);
1172 // "A writer MUST include either exactly one d or exactly one h field."
1173 let description_cnt = self.tagged_fields().filter(|&tf| match *tf {
1174 TaggedField::Description(_) | TaggedField::DescriptionHash(_) => true,
1177 if description_cnt < 1 {
1178 return Err(Bolt11SemanticError::NoDescription);
1179 } else if description_cnt > 1 {
1180 return Err(Bolt11SemanticError::MultipleDescriptions);
1183 self.check_payment_secret()?;
1188 /// Checks that there is exactly one payment secret field
1189 fn check_payment_secret(&self) -> Result<(), Bolt11SemanticError> {
1190 // "A writer MUST include exactly one `s` field."
1191 let payment_secret_count = self.tagged_fields().filter(|&tf| match *tf {
1192 TaggedField::PaymentSecret(_) => true,
1195 if payment_secret_count < 1 {
1196 return Err(Bolt11SemanticError::NoPaymentSecret);
1197 } else if payment_secret_count > 1 {
1198 return Err(Bolt11SemanticError::MultiplePaymentSecrets);
1204 /// Check that amount is a whole number of millisatoshis
1205 fn check_amount(&self) -> Result<(), Bolt11SemanticError> {
1206 if let Some(amount_pico_btc) = self.amount_pico_btc() {
1207 if amount_pico_btc % 10 != 0 {
1208 return Err(Bolt11SemanticError::ImpreciseAmount);
1214 /// Check that feature bits are set as required
1215 fn check_feature_bits(&self) -> Result<(), Bolt11SemanticError> {
1216 self.check_payment_secret()?;
1218 // "A writer MUST set an s field if and only if the payment_secret feature is set."
1219 // (this requirement has been since removed, and we now require the payment secret
1220 // feature bit always).
1221 let features = self.tagged_fields().find(|&tf| match *tf {
1222 TaggedField::Features(_) => true,
1226 None => Err(Bolt11SemanticError::InvalidFeatures),
1227 Some(TaggedField::Features(features)) => {
1228 if features.requires_unknown_bits() {
1229 Err(Bolt11SemanticError::InvalidFeatures)
1230 } else if !features.supports_payment_secret() {
1231 Err(Bolt11SemanticError::InvalidFeatures)
1236 Some(_) => unreachable!(),
1240 /// Check that the invoice is signed correctly and that key recovery works
1241 pub fn check_signature(&self) -> Result<(), Bolt11SemanticError> {
1242 match self.signed_invoice.recover_payee_pub_key() {
1243 Err(secp256k1::Error::InvalidRecoveryId) =>
1244 return Err(Bolt11SemanticError::InvalidRecoveryId),
1245 Err(secp256k1::Error::InvalidSignature) =>
1246 return Err(Bolt11SemanticError::InvalidSignature),
1247 Err(e) => panic!("no other error may occur, got {:?}", e),
1251 if !self.signed_invoice.check_signature() {
1252 return Err(Bolt11SemanticError::InvalidSignature);
1258 /// Constructs a `Bolt11Invoice` from a [`SignedRawBolt11Invoice`] by checking all its invariants.
1260 /// use lightning_invoice::*;
1262 /// let invoice = "lnbc100p1psj9jhxdqud3jxktt5w46x7unfv9kz6mn0v3jsnp4q0d3p2sfluzdx45tqcs\
1263 /// h2pu5qc7lgq0xs578ngs6s0s68ua4h7cvspp5q6rmq35js88zp5dvwrv9m459tnk2zunwj5jalqtyxqulh0l\
1264 /// 5gflssp5nf55ny5gcrfl30xuhzj3nphgj27rstekmr9fw3ny5989s300gyus9qyysgqcqpcrzjqw2sxwe993\
1265 /// h5pcm4dxzpvttgza8zhkqxpgffcrf5v25nwpr3cmfg7z54kuqq8rgqqqqqqqq2qqqqq9qq9qrzjqd0ylaqcl\
1266 /// j9424x9m8h2vcukcgnm6s56xfgu3j78zyqzhgs4hlpzvznlugqq9vsqqqqqqqlgqqqqqeqq9qrzjqwldmj9d\
1267 /// ha74df76zhx6l9we0vjdquygcdt3kssupehe64g6yyp5yz5rhuqqwccqqyqqqqlgqqqqjcqq9qrzjqf9e58a\
1268 /// guqr0rcun0ajlvmzq3ek63cw2w282gv3z5uupmuwvgjtq2z55qsqqg6qqqyqqqrtnqqqzq3cqygrzjqvphms\
1269 /// ywntrrhqjcraumvc4y6r8v4z5v593trte429v4hredj7ms5z52usqq9ngqqqqqqqlgqqqqqqgq9qrzjq2v0v\
1270 /// p62g49p7569ev48cmulecsxe59lvaw3wlxm7r982zxa9zzj7z5l0cqqxusqqyqqqqlgqqqqqzsqygarl9fh3\
1271 /// 8s0gyuxjjgux34w75dnc6xp2l35j7es3jd4ugt3lu0xzre26yg5m7ke54n2d5sym4xcmxtl8238xxvw5h5h5\
1272 /// j5r6drg6k6zcqj0fcwg";
1274 /// let signed = invoice.parse::<SignedRawBolt11Invoice>().unwrap();
1276 /// assert!(Bolt11Invoice::from_signed(signed).is_ok());
1278 pub fn from_signed(signed_invoice: SignedRawBolt11Invoice) -> Result<Self, Bolt11SemanticError> {
1279 let invoice = Bolt11Invoice {
1282 invoice.check_field_counts()?;
1283 invoice.check_feature_bits()?;
1284 invoice.check_signature()?;
1285 invoice.check_amount()?;
1290 /// Returns the `Bolt11Invoice`'s timestamp (should equal its creation time)
1291 #[cfg(feature = "std")]
1292 pub fn timestamp(&self) -> SystemTime {
1293 self.signed_invoice.raw_invoice().data.timestamp.as_time()
1296 /// Returns the `Bolt11Invoice`'s timestamp as a duration since the Unix epoch
1297 pub fn duration_since_epoch(&self) -> Duration {
1298 self.signed_invoice.raw_invoice().data.timestamp.0
1301 /// Returns an iterator over all tagged fields of this `Bolt11Invoice`.
1303 /// This is not exported to bindings users as there is not yet a manual mapping for a FilterMap
1304 pub fn tagged_fields(&self)
1305 -> FilterMap<Iter<RawTaggedField>, fn(&RawTaggedField) -> Option<&TaggedField>> {
1306 self.signed_invoice.raw_invoice().known_tagged_fields()
1309 /// Returns the hash to which we will receive the preimage on completion of the payment
1310 pub fn payment_hash(&self) -> &sha256::Hash {
1311 &self.signed_invoice.payment_hash().expect("checked by constructor").0
1314 /// Return the description or a hash of it for longer ones
1316 /// This is not exported to bindings users because we don't yet export Bolt11InvoiceDescription
1317 pub fn description(&self) -> Bolt11InvoiceDescription {
1318 if let Some(direct) = self.signed_invoice.description() {
1319 return Bolt11InvoiceDescription::Direct(direct);
1320 } else if let Some(hash) = self.signed_invoice.description_hash() {
1321 return Bolt11InvoiceDescription::Hash(hash);
1323 unreachable!("ensured by constructor");
1326 /// Get the payee's public key if one was included in the invoice
1327 pub fn payee_pub_key(&self) -> Option<&PublicKey> {
1328 self.signed_invoice.payee_pub_key().map(|x| &x.0)
1331 /// Get the payment secret if one was included in the invoice
1332 pub fn payment_secret(&self) -> &PaymentSecret {
1333 self.signed_invoice.payment_secret().expect("was checked by constructor")
1336 /// Get the payment metadata blob if one was included in the invoice
1337 pub fn payment_metadata(&self) -> Option<&Vec<u8>> {
1338 self.signed_invoice.payment_metadata()
1341 /// Get the invoice features if they were included in the invoice
1342 pub fn features(&self) -> Option<&Bolt11InvoiceFeatures> {
1343 self.signed_invoice.features()
1346 /// Recover the payee's public key (only to be used if none was included in the invoice)
1347 pub fn recover_payee_pub_key(&self) -> PublicKey {
1348 self.signed_invoice.recover_payee_pub_key().expect("was checked by constructor").0
1351 /// Returns the Duration since the Unix epoch at which the invoice expires.
1352 /// Returning None if overflow occurred.
1353 pub fn expires_at(&self) -> Option<Duration> {
1354 self.duration_since_epoch().checked_add(self.expiry_time())
1357 /// Returns the invoice's expiry time, if present, otherwise [`DEFAULT_EXPIRY_TIME`].
1358 pub fn expiry_time(&self) -> Duration {
1359 self.signed_invoice.expiry_time()
1361 .unwrap_or(Duration::from_secs(DEFAULT_EXPIRY_TIME))
1364 /// Returns whether the invoice has expired.
1365 #[cfg(feature = "std")]
1366 pub fn is_expired(&self) -> bool {
1367 Self::is_expired_from_epoch(&self.timestamp(), self.expiry_time())
1370 /// Returns whether the expiry time from the given epoch has passed.
1371 #[cfg(feature = "std")]
1372 pub(crate) fn is_expired_from_epoch(epoch: &SystemTime, expiry_time: Duration) -> bool {
1373 match epoch.elapsed() {
1374 Ok(elapsed) => elapsed > expiry_time,
1379 /// Returns the Duration remaining until the invoice expires.
1380 #[cfg(feature = "std")]
1381 pub fn duration_until_expiry(&self) -> Duration {
1382 SystemTime::now().duration_since(SystemTime::UNIX_EPOCH)
1383 .map(|now| self.expiration_remaining_from_epoch(now))
1384 .unwrap_or(Duration::from_nanos(0))
1387 /// Returns the Duration remaining until the invoice expires given the current time.
1388 /// `time` is the timestamp as a duration since the Unix epoch.
1389 pub fn expiration_remaining_from_epoch(&self, time: Duration) -> Duration {
1390 self.expires_at().map(|x| x.checked_sub(time)).flatten().unwrap_or(Duration::from_nanos(0))
1393 /// Returns whether the expiry time would pass at the given point in time.
1394 /// `at_time` is the timestamp as a duration since the Unix epoch.
1395 pub fn would_expire(&self, at_time: Duration) -> bool {
1396 self.duration_since_epoch()
1397 .checked_add(self.expiry_time())
1398 .unwrap_or_else(|| Duration::new(u64::max_value(), 1_000_000_000 - 1)) < at_time
1401 /// Returns the invoice's `min_final_cltv_expiry_delta` time, if present, otherwise
1402 /// [`DEFAULT_MIN_FINAL_CLTV_EXPIRY_DELTA`].
1403 pub fn min_final_cltv_expiry_delta(&self) -> u64 {
1404 self.signed_invoice.min_final_cltv_expiry_delta()
1406 .unwrap_or(DEFAULT_MIN_FINAL_CLTV_EXPIRY_DELTA)
1409 /// Returns a list of all fallback addresses
1411 /// This is not exported to bindings users as we don't support Vec<&NonOpaqueType>
1412 pub fn fallbacks(&self) -> Vec<&Fallback> {
1413 self.signed_invoice.fallbacks()
1416 /// Returns a list of all fallback addresses as [`Address`]es
1417 pub fn fallback_addresses(&self) -> Vec<Address> {
1418 self.fallbacks().iter().filter_map(|fallback| {
1419 let payload = match fallback {
1420 Fallback::SegWitProgram { version, program } => {
1421 match WitnessProgram::new(*version, program.clone()) {
1422 Ok(witness_program) => Payload::WitnessProgram(witness_program),
1423 Err(_) => return None,
1426 Fallback::PubKeyHash(pkh) => {
1427 Payload::PubkeyHash(*pkh)
1429 Fallback::ScriptHash(sh) => {
1430 Payload::ScriptHash(*sh)
1434 Some(Address::new(self.network(), payload))
1438 /// Returns a list of all routes included in the invoice
1439 pub fn private_routes(&self) -> Vec<&PrivateRoute> {
1440 self.signed_invoice.private_routes()
1443 /// Returns a list of all routes included in the invoice as the underlying hints
1444 pub fn route_hints(&self) -> Vec<RouteHint> {
1446 self.signed_invoice.known_tagged_fields(), TaggedField::PrivateRoute(ref x), x
1447 ).map(|route| (**route).clone()).collect()
1450 /// Returns the currency for which the invoice was issued
1451 pub fn currency(&self) -> Currency {
1452 self.signed_invoice.currency()
1455 /// Returns the network for which the invoice was issued
1457 /// This is not exported to bindings users, see [`Self::currency`] instead.
1458 pub fn network(&self) -> Network {
1459 self.signed_invoice.currency().into()
1462 /// Returns the amount if specified in the invoice as millisatoshis.
1463 pub fn amount_milli_satoshis(&self) -> Option<u64> {
1464 self.signed_invoice.amount_pico_btc().map(|v| v / 10)
1467 /// Returns the amount if specified in the invoice as pico BTC.
1468 fn amount_pico_btc(&self) -> Option<u64> {
1469 self.signed_invoice.amount_pico_btc()
1473 impl From<TaggedField> for RawTaggedField {
1474 fn from(tf: TaggedField) -> Self {
1475 RawTaggedField::KnownSemantics(tf)
1480 /// Numeric representation of the field's tag
1481 pub fn tag(&self) -> u5 {
1482 let tag = match *self {
1483 TaggedField::PaymentHash(_) => constants::TAG_PAYMENT_HASH,
1484 TaggedField::Description(_) => constants::TAG_DESCRIPTION,
1485 TaggedField::PayeePubKey(_) => constants::TAG_PAYEE_PUB_KEY,
1486 TaggedField::DescriptionHash(_) => constants::TAG_DESCRIPTION_HASH,
1487 TaggedField::ExpiryTime(_) => constants::TAG_EXPIRY_TIME,
1488 TaggedField::MinFinalCltvExpiryDelta(_) => constants::TAG_MIN_FINAL_CLTV_EXPIRY_DELTA,
1489 TaggedField::Fallback(_) => constants::TAG_FALLBACK,
1490 TaggedField::PrivateRoute(_) => constants::TAG_PRIVATE_ROUTE,
1491 TaggedField::PaymentSecret(_) => constants::TAG_PAYMENT_SECRET,
1492 TaggedField::PaymentMetadata(_) => constants::TAG_PAYMENT_METADATA,
1493 TaggedField::Features(_) => constants::TAG_FEATURES,
1496 u5::try_from_u8(tag).expect("all tags defined are <32")
1502 /// Creates a new `Description` if `description` is at most 1023 __bytes__ long,
1503 /// returns [`CreationError::DescriptionTooLong`] otherwise
1505 /// Please note that single characters may use more than one byte due to UTF8 encoding.
1506 pub fn new(description: String) -> Result<Description, CreationError> {
1507 if description.len() > 639 {
1508 Err(CreationError::DescriptionTooLong)
1510 Ok(Description(UntrustedString(description)))
1514 /// Returns the underlying description [`UntrustedString`]
1515 pub fn into_inner(self) -> UntrustedString {
1520 impl Display for Description {
1521 fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
1522 write!(f, "{}", self.0)
1526 impl From<PublicKey> for PayeePubKey {
1527 fn from(pk: PublicKey) -> Self {
1532 impl Deref for PayeePubKey {
1533 type Target = PublicKey;
1535 fn deref(&self) -> &PublicKey {
1541 /// Construct an `ExpiryTime` from seconds.
1542 pub fn from_seconds(seconds: u64) -> ExpiryTime {
1543 ExpiryTime(Duration::from_secs(seconds))
1546 /// Construct an `ExpiryTime` from a [`Duration`], dropping the sub-second part.
1547 pub fn from_duration(duration: Duration) -> ExpiryTime {
1548 Self::from_seconds(duration.as_secs())
1551 /// Returns the expiry time in seconds
1552 pub fn as_seconds(&self) -> u64 {
1556 /// Returns a reference to the underlying [`Duration`] (=expiry time)
1557 pub fn as_duration(&self) -> &Duration {
1563 /// Creates a new (partial) route from a list of hops
1564 pub fn new(hops: RouteHint) -> Result<PrivateRoute, CreationError> {
1565 if hops.0.len() <= 12 {
1566 Ok(PrivateRoute(hops))
1568 Err(CreationError::RouteTooLong)
1572 /// Returns the underlying list of hops
1573 pub fn into_inner(self) -> RouteHint {
1578 impl From<PrivateRoute> for RouteHint {
1579 fn from(val: PrivateRoute) -> Self {
1584 impl Deref for PrivateRoute {
1585 type Target = RouteHint;
1587 fn deref(&self) -> &RouteHint {
1592 impl Deref for Bolt11InvoiceSignature {
1593 type Target = RecoverableSignature;
1595 fn deref(&self) -> &RecoverableSignature {
1600 impl Deref for SignedRawBolt11Invoice {
1601 type Target = RawBolt11Invoice;
1603 fn deref(&self) -> &RawBolt11Invoice {
1608 /// Errors that may occur when constructing a new [`RawBolt11Invoice`] or [`Bolt11Invoice`]
1609 #[derive(Eq, PartialEq, Debug, Clone)]
1610 pub enum CreationError {
1611 /// The supplied description string was longer than 639 __bytes__ (see [`Description::new`])
1614 /// The specified route has too many hops and can't be encoded
1617 /// The Unix timestamp of the supplied date is less than zero or greater than 35-bits
1618 TimestampOutOfBounds,
1620 /// The supplied millisatoshi amount was greater than the total bitcoin supply.
1623 /// Route hints were required for this invoice and were missing. Applies to
1624 /// [phantom invoices].
1626 /// [phantom invoices]: crate::utils::create_phantom_invoice
1629 /// The provided `min_final_cltv_expiry_delta` was less than [`MIN_FINAL_CLTV_EXPIRY_DELTA`].
1631 /// [`MIN_FINAL_CLTV_EXPIRY_DELTA`]: lightning::ln::channelmanager::MIN_FINAL_CLTV_EXPIRY_DELTA
1632 MinFinalCltvExpiryDeltaTooShort,
1635 impl Display for CreationError {
1636 fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
1638 CreationError::DescriptionTooLong => f.write_str("The supplied description string was longer than 639 bytes"),
1639 CreationError::RouteTooLong => f.write_str("The specified route has too many hops and can't be encoded"),
1640 CreationError::TimestampOutOfBounds => f.write_str("The Unix timestamp of the supplied date is less than zero or greater than 35-bits"),
1641 CreationError::InvalidAmount => f.write_str("The supplied millisatoshi amount was greater than the total bitcoin supply"),
1642 CreationError::MissingRouteHints => f.write_str("The invoice required route hints and they weren't provided"),
1643 CreationError::MinFinalCltvExpiryDeltaTooShort => f.write_str(
1644 "The supplied final CLTV expiry delta was less than LDK's `MIN_FINAL_CLTV_EXPIRY_DELTA`"),
1649 #[cfg(feature = "std")]
1650 impl std::error::Error for CreationError { }
1652 /// Errors that may occur when converting a [`RawBolt11Invoice`] to a [`Bolt11Invoice`]. They relate to
1653 /// the requirements sections in BOLT #11
1654 #[derive(Eq, PartialEq, Debug, Clone)]
1655 pub enum Bolt11SemanticError {
1656 /// The invoice is missing the mandatory payment hash
1659 /// The invoice has multiple payment hashes which isn't allowed
1660 MultiplePaymentHashes,
1662 /// No description or description hash are part of the invoice
1665 /// The invoice contains multiple descriptions and/or description hashes which isn't allowed
1666 MultipleDescriptions,
1668 /// The invoice is missing the mandatory payment secret, which all modern lightning nodes
1672 /// The invoice contains multiple payment secrets
1673 MultiplePaymentSecrets,
1675 /// The invoice's features are invalid
1678 /// The recovery id doesn't fit the signature/pub key
1681 /// The invoice's signature is invalid
1684 /// The invoice's amount was not a whole number of millisatoshis
1688 impl Display for Bolt11SemanticError {
1689 fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
1691 Bolt11SemanticError::NoPaymentHash => f.write_str("The invoice is missing the mandatory payment hash"),
1692 Bolt11SemanticError::MultiplePaymentHashes => f.write_str("The invoice has multiple payment hashes which isn't allowed"),
1693 Bolt11SemanticError::NoDescription => f.write_str("No description or description hash are part of the invoice"),
1694 Bolt11SemanticError::MultipleDescriptions => f.write_str("The invoice contains multiple descriptions and/or description hashes which isn't allowed"),
1695 Bolt11SemanticError::NoPaymentSecret => f.write_str("The invoice is missing the mandatory payment secret"),
1696 Bolt11SemanticError::MultiplePaymentSecrets => f.write_str("The invoice contains multiple payment secrets"),
1697 Bolt11SemanticError::InvalidFeatures => f.write_str("The invoice's features are invalid"),
1698 Bolt11SemanticError::InvalidRecoveryId => f.write_str("The recovery id doesn't fit the signature/pub key"),
1699 Bolt11SemanticError::InvalidSignature => f.write_str("The invoice's signature is invalid"),
1700 Bolt11SemanticError::ImpreciseAmount => f.write_str("The invoice's amount was not a whole number of millisatoshis"),
1705 #[cfg(feature = "std")]
1706 impl std::error::Error for Bolt11SemanticError { }
1708 /// When signing using a fallible method either an user-supplied `SignError` or a [`CreationError`]
1710 #[derive(Eq, PartialEq, Debug, Clone)]
1711 pub enum SignOrCreationError<S = ()> {
1712 /// An error occurred during signing
1715 /// An error occurred while building the transaction
1716 CreationError(CreationError),
1719 impl<S> Display for SignOrCreationError<S> {
1720 fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
1722 SignOrCreationError::SignError(_) => f.write_str("An error occurred during signing"),
1723 SignOrCreationError::CreationError(err) => err.fmt(f),
1728 #[cfg(feature = "serde")]
1729 impl Serialize for Bolt11Invoice {
1730 fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where S: Serializer {
1731 serializer.serialize_str(self.to_string().as_str())
1734 #[cfg(feature = "serde")]
1735 impl<'de> Deserialize<'de> for Bolt11Invoice {
1736 fn deserialize<D>(deserializer: D) -> Result<Bolt11Invoice, D::Error> where D: Deserializer<'de> {
1737 let bolt11 = String::deserialize(deserializer)?
1738 .parse::<Bolt11Invoice>()
1739 .map_err(|e| D::Error::custom(format_args!("{:?}", e)))?;
1747 use bitcoin::ScriptBuf;
1748 use bitcoin::hashes::sha256;
1749 use std::str::FromStr;
1752 fn test_system_time_bounds_assumptions() {
1754 crate::PositiveTimestamp::from_unix_timestamp(crate::MAX_TIMESTAMP + 1),
1755 Err(crate::CreationError::TimestampOutOfBounds)
1760 fn test_calc_invoice_hash() {
1761 use crate::{RawBolt11Invoice, RawHrp, RawDataPart, Currency, PositiveTimestamp};
1762 use crate::TaggedField::*;
1764 let invoice = RawBolt11Invoice {
1766 currency: Currency::Bitcoin,
1771 timestamp: PositiveTimestamp::from_unix_timestamp(1496314658).unwrap(),
1772 tagged_fields: vec![
1773 PaymentHash(crate::Sha256(sha256::Hash::from_str(
1774 "0001020304050607080900010203040506070809000102030405060708090102"
1775 ).unwrap())).into(),
1776 Description(crate::Description::new(
1777 "Please consider supporting this project".to_owned()
1783 let expected_hash = [
1784 0xc3, 0xd4, 0xe8, 0x3f, 0x64, 0x6f, 0xa7, 0x9a, 0x39, 0x3d, 0x75, 0x27, 0x7b, 0x1d,
1785 0x85, 0x8d, 0xb1, 0xd1, 0xf7, 0xab, 0x71, 0x37, 0xdc, 0xb7, 0x83, 0x5d, 0xb2, 0xec,
1786 0xd5, 0x18, 0xe1, 0xc9
1789 assert_eq!(invoice.signable_hash(), expected_hash)
1793 fn test_check_signature() {
1794 use crate::TaggedField::*;
1795 use secp256k1::Secp256k1;
1796 use secp256k1::ecdsa::{RecoveryId, RecoverableSignature};
1797 use secp256k1::{SecretKey, PublicKey};
1798 use crate::{SignedRawBolt11Invoice, Bolt11InvoiceSignature, RawBolt11Invoice, RawHrp, RawDataPart, Currency, Sha256,
1801 let invoice = SignedRawBolt11Invoice {
1802 raw_invoice: RawBolt11Invoice {
1804 currency: Currency::Bitcoin,
1809 timestamp: PositiveTimestamp::from_unix_timestamp(1496314658).unwrap(),
1810 tagged_fields: vec ! [
1811 PaymentHash(Sha256(sha256::Hash::from_str(
1812 "0001020304050607080900010203040506070809000102030405060708090102"
1813 ).unwrap())).into(),
1815 crate::Description::new(
1816 "Please consider supporting this project".to_owned()
1823 0xc3, 0xd4, 0xe8, 0x3f, 0x64, 0x6f, 0xa7, 0x9a, 0x39, 0x3d, 0x75, 0x27,
1824 0x7b, 0x1d, 0x85, 0x8d, 0xb1, 0xd1, 0xf7, 0xab, 0x71, 0x37, 0xdc, 0xb7,
1825 0x83, 0x5d, 0xb2, 0xec, 0xd5, 0x18, 0xe1, 0xc9
1827 signature: Bolt11InvoiceSignature(RecoverableSignature::from_compact(
1829 0x38u8, 0xec, 0x68, 0x91, 0x34, 0x5e, 0x20, 0x41, 0x45, 0xbe, 0x8a,
1830 0x3a, 0x99, 0xde, 0x38, 0xe9, 0x8a, 0x39, 0xd6, 0xa5, 0x69, 0x43,
1831 0x4e, 0x18, 0x45, 0xc8, 0xaf, 0x72, 0x05, 0xaf, 0xcf, 0xcc, 0x7f,
1832 0x42, 0x5f, 0xcd, 0x14, 0x63, 0xe9, 0x3c, 0x32, 0x88, 0x1e, 0xad,
1833 0x0d, 0x6e, 0x35, 0x6d, 0x46, 0x7e, 0xc8, 0xc0, 0x25, 0x53, 0xf9,
1834 0xaa, 0xb1, 0x5e, 0x57, 0x38, 0xb1, 0x1f, 0x12, 0x7f
1836 RecoveryId::from_i32(0).unwrap()
1840 assert!(invoice.check_signature());
1842 let private_key = SecretKey::from_slice(
1844 0xe1, 0x26, 0xf6, 0x8f, 0x7e, 0xaf, 0xcc, 0x8b, 0x74, 0xf5, 0x4d, 0x26, 0x9f, 0xe2,
1845 0x06, 0xbe, 0x71, 0x50, 0x00, 0xf9, 0x4d, 0xac, 0x06, 0x7d, 0x1c, 0x04, 0xa8, 0xca,
1846 0x3b, 0x2d, 0xb7, 0x34
1849 let public_key = PublicKey::from_secret_key(&Secp256k1::new(), &private_key);
1851 assert_eq!(invoice.recover_payee_pub_key(), Ok(crate::PayeePubKey(public_key)));
1853 let (raw_invoice, _, _) = invoice.into_parts();
1854 let new_signed = raw_invoice.sign::<_, ()>(|hash| {
1855 Ok(Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key))
1858 assert!(new_signed.check_signature());
1862 fn test_check_feature_bits() {
1863 use crate::TaggedField::*;
1864 use lightning::ln::features::Bolt11InvoiceFeatures;
1865 use secp256k1::Secp256k1;
1866 use secp256k1::SecretKey;
1867 use crate::{Bolt11Invoice, RawBolt11Invoice, RawHrp, RawDataPart, Currency, Sha256, PositiveTimestamp,
1868 Bolt11SemanticError};
1870 let private_key = SecretKey::from_slice(&[42; 32]).unwrap();
1871 let payment_secret = lightning::ln::PaymentSecret([21; 32]);
1872 let invoice_template = RawBolt11Invoice {
1874 currency: Currency::Bitcoin,
1879 timestamp: PositiveTimestamp::from_unix_timestamp(1496314658).unwrap(),
1880 tagged_fields: vec ! [
1881 PaymentHash(Sha256(sha256::Hash::from_str(
1882 "0001020304050607080900010203040506070809000102030405060708090102"
1883 ).unwrap())).into(),
1885 crate::Description::new(
1886 "Please consider supporting this project".to_owned()
1895 let mut invoice = invoice_template.clone();
1896 invoice.data.tagged_fields.push(PaymentSecret(payment_secret).into());
1897 invoice.sign::<_, ()>(|hash| Ok(Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key)))
1899 assert_eq!(Bolt11Invoice::from_signed(invoice), Err(Bolt11SemanticError::InvalidFeatures));
1901 // Missing feature bits
1903 let mut invoice = invoice_template.clone();
1904 invoice.data.tagged_fields.push(PaymentSecret(payment_secret).into());
1905 invoice.data.tagged_fields.push(Features(Bolt11InvoiceFeatures::empty()).into());
1906 invoice.sign::<_, ()>(|hash| Ok(Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key)))
1908 assert_eq!(Bolt11Invoice::from_signed(invoice), Err(Bolt11SemanticError::InvalidFeatures));
1910 let mut payment_secret_features = Bolt11InvoiceFeatures::empty();
1911 payment_secret_features.set_payment_secret_required();
1913 // Including payment secret and feature bits
1915 let mut invoice = invoice_template.clone();
1916 invoice.data.tagged_fields.push(PaymentSecret(payment_secret).into());
1917 invoice.data.tagged_fields.push(Features(payment_secret_features.clone()).into());
1918 invoice.sign::<_, ()>(|hash| Ok(Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key)))
1920 assert!(Bolt11Invoice::from_signed(invoice).is_ok());
1922 // No payment secret or features
1924 let invoice = invoice_template.clone();
1925 invoice.sign::<_, ()>(|hash| Ok(Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key)))
1927 assert_eq!(Bolt11Invoice::from_signed(invoice), Err(Bolt11SemanticError::NoPaymentSecret));
1929 // No payment secret or feature bits
1931 let mut invoice = invoice_template.clone();
1932 invoice.data.tagged_fields.push(Features(Bolt11InvoiceFeatures::empty()).into());
1933 invoice.sign::<_, ()>(|hash| Ok(Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key)))
1935 assert_eq!(Bolt11Invoice::from_signed(invoice), Err(Bolt11SemanticError::NoPaymentSecret));
1937 // Missing payment secret
1939 let mut invoice = invoice_template.clone();
1940 invoice.data.tagged_fields.push(Features(payment_secret_features).into());
1941 invoice.sign::<_, ()>(|hash| Ok(Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key)))
1943 assert_eq!(Bolt11Invoice::from_signed(invoice), Err(Bolt11SemanticError::NoPaymentSecret));
1945 // Multiple payment secrets
1947 let mut invoice = invoice_template;
1948 invoice.data.tagged_fields.push(PaymentSecret(payment_secret).into());
1949 invoice.data.tagged_fields.push(PaymentSecret(payment_secret).into());
1950 invoice.sign::<_, ()>(|hash| Ok(Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key)))
1952 assert_eq!(Bolt11Invoice::from_signed(invoice), Err(Bolt11SemanticError::MultiplePaymentSecrets));
1956 fn test_builder_amount() {
1959 let builder = InvoiceBuilder::new(Currency::Bitcoin)
1960 .description("Test".into())
1961 .payment_hash(sha256::Hash::from_slice(&[0;32][..]).unwrap())
1962 .duration_since_epoch(Duration::from_secs(1234567));
1964 let invoice = builder.clone()
1965 .amount_milli_satoshis(1500)
1969 assert_eq!(invoice.hrp.si_prefix, Some(SiPrefix::Nano));
1970 assert_eq!(invoice.hrp.raw_amount, Some(15));
1973 let invoice = builder
1974 .amount_milli_satoshis(150)
1978 assert_eq!(invoice.hrp.si_prefix, Some(SiPrefix::Pico));
1979 assert_eq!(invoice.hrp.raw_amount, Some(1500));
1983 fn test_builder_fail() {
1985 use lightning::routing::router::RouteHintHop;
1986 use std::iter::FromIterator;
1987 use secp256k1::PublicKey;
1989 let builder = InvoiceBuilder::new(Currency::Bitcoin)
1990 .payment_hash(sha256::Hash::from_slice(&[0;32][..]).unwrap())
1991 .duration_since_epoch(Duration::from_secs(1234567))
1992 .min_final_cltv_expiry_delta(144);
1994 let too_long_string = String::from_iter(
1995 (0..1024).map(|_| '?')
1998 let long_desc_res = builder.clone()
1999 .description(too_long_string)
2001 assert_eq!(long_desc_res, Err(CreationError::DescriptionTooLong));
2003 let route_hop = RouteHintHop {
2004 src_node_id: PublicKey::from_slice(
2006 0x03, 0x9e, 0x03, 0xa9, 0x01, 0xb8, 0x55, 0x34, 0xff, 0x1e, 0x92, 0xc4,
2007 0x3c, 0x74, 0x43, 0x1f, 0x7c, 0xe7, 0x20, 0x46, 0x06, 0x0f, 0xcf, 0x7a,
2008 0x95, 0xc3, 0x7e, 0x14, 0x8f, 0x78, 0xc7, 0x72, 0x55
2011 short_channel_id: 0,
2014 proportional_millionths: 0,
2016 cltv_expiry_delta: 0,
2017 htlc_minimum_msat: None,
2018 htlc_maximum_msat: None,
2020 let too_long_route = RouteHint(vec![route_hop; 13]);
2021 let long_route_res = builder.clone()
2022 .description("Test".into())
2023 .private_route(too_long_route)
2025 assert_eq!(long_route_res, Err(CreationError::RouteTooLong));
2027 let sign_error_res = builder
2028 .description("Test".into())
2029 .payment_secret(PaymentSecret([0; 32]))
2030 .try_build_signed(|_| {
2031 Err("ImaginaryError")
2033 assert_eq!(sign_error_res, Err(SignOrCreationError::SignError("ImaginaryError")));
2037 fn test_builder_ok() {
2039 use lightning::routing::router::RouteHintHop;
2040 use secp256k1::Secp256k1;
2041 use secp256k1::{SecretKey, PublicKey};
2042 use std::time::Duration;
2044 let secp_ctx = Secp256k1::new();
2046 let private_key = SecretKey::from_slice(
2048 0xe1, 0x26, 0xf6, 0x8f, 0x7e, 0xaf, 0xcc, 0x8b, 0x74, 0xf5, 0x4d, 0x26, 0x9f, 0xe2,
2049 0x06, 0xbe, 0x71, 0x50, 0x00, 0xf9, 0x4d, 0xac, 0x06, 0x7d, 0x1c, 0x04, 0xa8, 0xca,
2050 0x3b, 0x2d, 0xb7, 0x34
2053 let public_key = PublicKey::from_secret_key(&secp_ctx, &private_key);
2055 let route_1 = RouteHint(vec![
2057 src_node_id: public_key,
2058 short_channel_id: de::parse_int_be(&[123; 8], 256).expect("short chan ID slice too big?"),
2061 proportional_millionths: 1,
2063 cltv_expiry_delta: 145,
2064 htlc_minimum_msat: None,
2065 htlc_maximum_msat: None,
2068 src_node_id: public_key,
2069 short_channel_id: de::parse_int_be(&[42; 8], 256).expect("short chan ID slice too big?"),
2072 proportional_millionths: 2,
2074 cltv_expiry_delta: 146,
2075 htlc_minimum_msat: None,
2076 htlc_maximum_msat: None,
2080 let route_2 = RouteHint(vec![
2082 src_node_id: public_key,
2083 short_channel_id: 0,
2086 proportional_millionths: 3,
2088 cltv_expiry_delta: 147,
2089 htlc_minimum_msat: None,
2090 htlc_maximum_msat: None,
2093 src_node_id: public_key,
2094 short_channel_id: de::parse_int_be(&[1; 8], 256).expect("short chan ID slice too big?"),
2097 proportional_millionths: 4,
2099 cltv_expiry_delta: 148,
2100 htlc_minimum_msat: None,
2101 htlc_maximum_msat: None,
2105 let builder = InvoiceBuilder::new(Currency::BitcoinTestnet)
2106 .amount_milli_satoshis(123)
2107 .duration_since_epoch(Duration::from_secs(1234567))
2108 .payee_pub_key(public_key)
2109 .expiry_time(Duration::from_secs(54321))
2110 .min_final_cltv_expiry_delta(144)
2111 .fallback(Fallback::PubKeyHash(PubkeyHash::from_slice(&[0;20]).unwrap()))
2112 .private_route(route_1.clone())
2113 .private_route(route_2.clone())
2114 .description_hash(sha256::Hash::from_slice(&[3;32][..]).unwrap())
2115 .payment_hash(sha256::Hash::from_slice(&[21;32][..]).unwrap())
2116 .payment_secret(PaymentSecret([42; 32]))
2119 let invoice = builder.clone().build_signed(|hash| {
2120 secp_ctx.sign_ecdsa_recoverable(hash, &private_key)
2123 assert!(invoice.check_signature().is_ok());
2124 assert_eq!(invoice.tagged_fields().count(), 10);
2126 assert_eq!(invoice.amount_milli_satoshis(), Some(123));
2127 assert_eq!(invoice.amount_pico_btc(), Some(1230));
2128 assert_eq!(invoice.currency(), Currency::BitcoinTestnet);
2129 #[cfg(feature = "std")]
2131 invoice.timestamp().duration_since(SystemTime::UNIX_EPOCH).unwrap().as_secs(),
2134 assert_eq!(invoice.payee_pub_key(), Some(&public_key));
2135 assert_eq!(invoice.expiry_time(), Duration::from_secs(54321));
2136 assert_eq!(invoice.min_final_cltv_expiry_delta(), 144);
2137 assert_eq!(invoice.fallbacks(), vec![&Fallback::PubKeyHash(PubkeyHash::from_slice(&[0;20]).unwrap())]);
2138 let address = Address::from_script(&ScriptBuf::new_p2pkh(&PubkeyHash::from_slice(&[0;20]).unwrap()), Network::Testnet).unwrap();
2139 assert_eq!(invoice.fallback_addresses(), vec![address]);
2140 assert_eq!(invoice.private_routes(), vec![&PrivateRoute(route_1), &PrivateRoute(route_2)]);
2142 invoice.description(),
2143 Bolt11InvoiceDescription::Hash(&Sha256(sha256::Hash::from_slice(&[3;32][..]).unwrap()))
2145 assert_eq!(invoice.payment_hash(), &sha256::Hash::from_slice(&[21;32][..]).unwrap());
2146 assert_eq!(invoice.payment_secret(), &PaymentSecret([42; 32]));
2148 let mut expected_features = Bolt11InvoiceFeatures::empty();
2149 expected_features.set_variable_length_onion_required();
2150 expected_features.set_payment_secret_required();
2151 expected_features.set_basic_mpp_optional();
2152 assert_eq!(invoice.features(), Some(&expected_features));
2154 let raw_invoice = builder.build_raw().unwrap();
2155 assert_eq!(raw_invoice, *invoice.into_signed_raw().raw_invoice())
2159 fn test_default_values() {
2161 use secp256k1::Secp256k1;
2162 use secp256k1::SecretKey;
2164 let signed_invoice = InvoiceBuilder::new(Currency::Bitcoin)
2165 .description("Test".into())
2166 .payment_hash(sha256::Hash::from_slice(&[0;32][..]).unwrap())
2167 .payment_secret(PaymentSecret([0; 32]))
2168 .duration_since_epoch(Duration::from_secs(1234567))
2171 .sign::<_, ()>(|hash| {
2172 let privkey = SecretKey::from_slice(&[41; 32]).unwrap();
2173 let secp_ctx = Secp256k1::new();
2174 Ok(secp_ctx.sign_ecdsa_recoverable(hash, &privkey))
2177 let invoice = Bolt11Invoice::from_signed(signed_invoice).unwrap();
2179 assert_eq!(invoice.min_final_cltv_expiry_delta(), DEFAULT_MIN_FINAL_CLTV_EXPIRY_DELTA);
2180 assert_eq!(invoice.expiry_time(), Duration::from_secs(DEFAULT_EXPIRY_TIME));
2181 assert!(!invoice.would_expire(Duration::from_secs(1234568)));
2185 fn test_expiration() {
2187 use secp256k1::Secp256k1;
2188 use secp256k1::SecretKey;
2190 let signed_invoice = InvoiceBuilder::new(Currency::Bitcoin)
2191 .description("Test".into())
2192 .payment_hash(sha256::Hash::from_slice(&[0;32][..]).unwrap())
2193 .payment_secret(PaymentSecret([0; 32]))
2194 .duration_since_epoch(Duration::from_secs(1234567))
2197 .sign::<_, ()>(|hash| {
2198 let privkey = SecretKey::from_slice(&[41; 32]).unwrap();
2199 let secp_ctx = Secp256k1::new();
2200 Ok(secp_ctx.sign_ecdsa_recoverable(hash, &privkey))
2203 let invoice = Bolt11Invoice::from_signed(signed_invoice).unwrap();
2205 assert!(invoice.would_expire(Duration::from_secs(1234567 + DEFAULT_EXPIRY_TIME + 1)));
2208 #[cfg(feature = "serde")]
2211 let invoice_str = "lnbc100p1psj9jhxdqud3jxktt5w46x7unfv9kz6mn0v3jsnp4q0d3p2sfluzdx45tqcs\
2212 h2pu5qc7lgq0xs578ngs6s0s68ua4h7cvspp5q6rmq35js88zp5dvwrv9m459tnk2zunwj5jalqtyxqulh0l\
2213 5gflssp5nf55ny5gcrfl30xuhzj3nphgj27rstekmr9fw3ny5989s300gyus9qyysgqcqpcrzjqw2sxwe993\
2214 h5pcm4dxzpvttgza8zhkqxpgffcrf5v25nwpr3cmfg7z54kuqq8rgqqqqqqqq2qqqqq9qq9qrzjqd0ylaqcl\
2215 j9424x9m8h2vcukcgnm6s56xfgu3j78zyqzhgs4hlpzvznlugqq9vsqqqqqqqlgqqqqqeqq9qrzjqwldmj9d\
2216 ha74df76zhx6l9we0vjdquygcdt3kssupehe64g6yyp5yz5rhuqqwccqqyqqqqlgqqqqjcqq9qrzjqf9e58a\
2217 guqr0rcun0ajlvmzq3ek63cw2w282gv3z5uupmuwvgjtq2z55qsqqg6qqqyqqqrtnqqqzq3cqygrzjqvphms\
2218 ywntrrhqjcraumvc4y6r8v4z5v593trte429v4hredj7ms5z52usqq9ngqqqqqqqlgqqqqqqgq9qrzjq2v0v\
2219 p62g49p7569ev48cmulecsxe59lvaw3wlxm7r982zxa9zzj7z5l0cqqxusqqyqqqqlgqqqqqzsqygarl9fh3\
2220 8s0gyuxjjgux34w75dnc6xp2l35j7es3jd4ugt3lu0xzre26yg5m7ke54n2d5sym4xcmxtl8238xxvw5h5h5\
2221 j5r6drg6k6zcqj0fcwg";
2222 let invoice = invoice_str.parse::<super::Bolt11Invoice>().unwrap();
2223 let serialized_invoice = serde_json::to_string(&invoice).unwrap();
2224 let deserialized_invoice: super::Bolt11Invoice = serde_json::from_str(serialized_invoice.as_str()).unwrap();
2225 assert_eq!(invoice, deserialized_invoice);
2226 assert_eq!(invoice_str, deserialized_invoice.to_string().as_str());
2227 assert_eq!(invoice_str, serialized_invoice.as_str().trim_matches('\"'));