2 #![deny(non_upper_case_globals)]
3 #![deny(non_camel_case_types)]
4 #![deny(non_snake_case)]
6 #![deny(broken_intra_doc_links)]
8 #![cfg_attr(feature = "strict", deny(warnings))]
10 //! This crate provides data structures to represent
11 //! [lightning BOLT11](https://github.com/lightningnetwork/lightning-rfc/blob/master/11-payment-encoding.md)
12 //! invoices and functions to create, encode and decode these. If you just want to use the standard
13 //! en-/decoding functionality this should get you started:
15 //! * For parsing use `str::parse::<Invoice>(&self)` (see the docs of `impl FromStr for Invoice`)
16 //! * For constructing invoices use the `InvoiceBuilder`
17 //! * For serializing invoices use the `Display`/`ToString` traits
21 extern crate bitcoin_hashes;
22 extern crate lightning;
23 extern crate num_traits;
24 extern crate secp256k1;
27 use bitcoin_hashes::Hash;
28 use bitcoin_hashes::sha256;
29 use lightning::ln::PaymentSecret;
30 use lightning::ln::features::InvoiceFeatures;
31 #[cfg(any(doc, test))]
32 use lightning::routing::network_graph::RoutingFees;
33 use lightning::routing::router::RouteHint;
35 use secp256k1::key::PublicKey;
36 use secp256k1::{Message, Secp256k1};
37 use secp256k1::recovery::RecoverableSignature;
39 use std::fmt::{Display, Formatter, self};
40 use std::iter::FilterMap;
43 use std::time::{SystemTime, Duration, UNIX_EPOCH};
49 pub use de::{ParseError, ParseOrSemanticError};
51 // TODO: fix before 2037 (see rust PR #55527)
52 /// Defines the maximum UNIX timestamp that can be represented as `SystemTime`. This is checked by
53 /// one of the unit tests, please run them.
54 const SYSTEM_TIME_MAX_UNIX_TIMESTAMP: u64 = std::i32::MAX as u64;
56 /// Allow the expiry time to be up to one year. Since this reduces the range of possible timestamps
57 /// it should be rather low as long as we still have to support 32bit time representations
58 const MAX_EXPIRY_TIME: u64 = 60 * 60 * 24 * 356;
60 /// Default expiry time as defined by [BOLT 11].
62 /// [BOLT 11]: https://github.com/lightningnetwork/lightning-rfc/blob/master/11-payment-encoding.md
63 pub const DEFAULT_EXPIRY_TIME: u64 = 3600;
65 /// Default minimum final CLTV expiry as defined by [BOLT 11].
67 /// Note that this is *not* the same value as rust-lightning's minimum CLTV expiry, which is
68 /// provided in [`MIN_FINAL_CLTV_EXPIRY`].
70 /// [BOLT 11]: https://github.com/lightningnetwork/lightning-rfc/blob/master/11-payment-encoding.md
71 /// [`MIN_FINAL_CLTV_EXPIRY`]: lightning::ln::channelmanager::MIN_FINAL_CLTV_EXPIRY
72 pub const DEFAULT_MIN_FINAL_CLTV_EXPIRY: u64 = 18;
74 /// This function is used as a static assert for the size of `SystemTime`. If the crate fails to
75 /// compile due to it this indicates that your system uses unexpected bounds for `SystemTime`. You
76 /// can remove this functions and run the test `test_system_time_bounds_assumptions`. In any case,
77 /// please open an issue. If all tests pass you should be able to use this library safely by just
78 /// removing this function till we patch it accordingly.
79 fn __system_time_size_check() {
80 // Use 2 * sizeof(u64) as expected size since the expected underlying implementation is storing
81 // a `Duration` since `SystemTime::UNIX_EPOCH`.
82 unsafe { std::mem::transmute_copy::<SystemTime, [u8; 16]>(&UNIX_EPOCH); }
86 /// **Call this function on startup to ensure that all assumptions about the platform are valid.**
88 /// Unfortunately we have to make assumptions about the upper bounds of the `SystemTime` type on
89 /// your platform which we can't fully verify at compile time and which isn't part of it's contract.
90 /// To our best knowledge our assumptions hold for all platforms officially supported by rust, but
91 /// since this check is fast we recommend to do it anyway.
93 /// If this function fails this is considered a bug. Please open an issue describing your
94 /// platform and stating your current system time.
97 /// If the check fails this function panics. By calling this function on startup you ensure that
98 /// this wont happen at an arbitrary later point in time.
99 pub fn check_platform() {
100 // The upper and lower bounds of `SystemTime` are not part of its public contract and are
101 // platform specific. That's why we have to test if our assumptions regarding these bounds
102 // hold on the target platform.
104 // If this test fails on your platform, please don't use the library and open an issue
105 // instead so we can resolve the situation. Currently this library is tested on:
107 let fail_date = UNIX_EPOCH + Duration::from_secs(SYSTEM_TIME_MAX_UNIX_TIMESTAMP);
108 let year = Duration::from_secs(60 * 60 * 24 * 365);
110 // Make sure that the library will keep working for another year
111 assert!(fail_date.duration_since(SystemTime::now()).unwrap() > year);
113 let max_ts = PositiveTimestamp::from_unix_timestamp(
114 SYSTEM_TIME_MAX_UNIX_TIMESTAMP - MAX_EXPIRY_TIME
116 let max_exp = ::ExpiryTime::from_seconds(MAX_EXPIRY_TIME).unwrap();
119 (*max_ts.as_time() + *max_exp.as_duration()).duration_since(UNIX_EPOCH).unwrap().as_secs(),
120 SYSTEM_TIME_MAX_UNIX_TIMESTAMP
125 /// Builder for `Invoice`s. It's the most convenient and advised way to use this library. It ensures
126 /// that only a semantically and syntactically correct Invoice can be built using it.
129 /// extern crate secp256k1;
130 /// extern crate lightning;
131 /// extern crate lightning_invoice;
132 /// extern crate bitcoin_hashes;
134 /// use bitcoin_hashes::Hash;
135 /// use bitcoin_hashes::sha256;
137 /// use secp256k1::Secp256k1;
138 /// use secp256k1::key::SecretKey;
140 /// use lightning::ln::PaymentSecret;
142 /// use lightning_invoice::{Currency, InvoiceBuilder};
145 /// let private_key = SecretKey::from_slice(
147 /// 0xe1, 0x26, 0xf6, 0x8f, 0x7e, 0xaf, 0xcc, 0x8b, 0x74, 0xf5, 0x4d, 0x26, 0x9f,
148 /// 0xe2, 0x06, 0xbe, 0x71, 0x50, 0x00, 0xf9, 0x4d, 0xac, 0x06, 0x7d, 0x1c, 0x04,
149 /// 0xa8, 0xca, 0x3b, 0x2d, 0xb7, 0x34
153 /// let payment_hash = sha256::Hash::from_slice(&[0; 32][..]).unwrap();
154 /// let payment_secret = PaymentSecret([42u8; 32]);
156 /// let invoice = InvoiceBuilder::new(Currency::Bitcoin)
157 /// .description("Coins pls!".into())
158 /// .payment_hash(payment_hash)
159 /// .payment_secret(payment_secret)
160 /// .current_timestamp()
161 /// .min_final_cltv_expiry(144)
162 /// .build_signed(|hash| {
163 /// Secp256k1::new().sign_recoverable(hash, &private_key)
167 /// assert!(invoice.to_string().starts_with("lnbc1"));
171 /// # Type parameters
172 /// The two parameters `D` and `H` signal if the builder already contains the correct amount of the
174 /// * `D`: exactly one `Description` or `DescriptionHash`
175 /// * `H`: exactly one `PaymentHash`
176 /// * `T`: the timestamp is set
178 /// (C-not exported) as we likely need to manually select one set of boolean type parameters.
179 #[derive(Eq, PartialEq, Debug, Clone)]
180 pub struct InvoiceBuilder<D: tb::Bool, H: tb::Bool, T: tb::Bool, C: tb::Bool, S: tb::Bool> {
183 si_prefix: Option<SiPrefix>,
184 timestamp: Option<PositiveTimestamp>,
185 tagged_fields: Vec<TaggedField>,
186 error: Option<CreationError>,
188 phantom_d: std::marker::PhantomData<D>,
189 phantom_h: std::marker::PhantomData<H>,
190 phantom_t: std::marker::PhantomData<T>,
191 phantom_c: std::marker::PhantomData<C>,
192 phantom_s: std::marker::PhantomData<S>,
195 /// Represents a syntactically and semantically correct lightning BOLT11 invoice.
197 /// There are three ways to construct an `Invoice`:
198 /// 1. using `InvoiceBuilder`
199 /// 2. using `Invoice::from_signed(SignedRawInvoice)`
200 /// 3. using `str::parse::<Invoice>(&str)`
201 #[derive(Eq, PartialEq, Debug, Clone)]
203 signed_invoice: SignedRawInvoice,
206 /// Represents the description of an invoice which has to be either a directly included string or
207 /// a hash of a description provided out of band.
209 /// (C-not exported) As we don't have a good way to map the reference lifetimes making this
210 /// practically impossible to use safely in languages like C.
211 #[derive(Eq, PartialEq, Debug, Clone)]
212 pub enum InvoiceDescription<'f> {
213 /// Reference to the directly supplied description in the invoice
214 Direct(&'f Description),
216 /// Reference to the description's hash included in the invoice
220 /// Represents a signed `RawInvoice` with cached hash. The signature is not checked and may be
224 /// The hash has to be either from the deserialized invoice or from the serialized `raw_invoice`.
225 #[derive(Eq, PartialEq, Debug, Clone)]
226 pub struct SignedRawInvoice {
227 /// The rawInvoice that the signature belongs to
228 raw_invoice: RawInvoice,
230 /// Hash of the `RawInvoice` that will be used to check the signature.
232 /// * if the `SignedRawInvoice` was deserialized the hash is of from the original encoded form,
233 /// since it's not guaranteed that encoding it again will lead to the same result since integers
234 /// could have been encoded with leading zeroes etc.
235 /// * if the `SignedRawInvoice` was constructed manually the hash will be the calculated hash
236 /// from the `RawInvoice`
239 /// signature of the payment request
240 signature: InvoiceSignature,
243 /// Represents an syntactically correct Invoice for a payment on the lightning network,
244 /// but without the signature information.
245 /// De- and encoding should not lead to information loss but may lead to different hashes.
247 /// For methods without docs see the corresponding methods in `Invoice`.
248 #[derive(Eq, PartialEq, Debug, Clone)]
249 pub struct RawInvoice {
250 /// human readable part
254 pub data: RawDataPart,
257 /// Data of the `RawInvoice` that is encoded in the human readable part
259 /// (C-not exported) As we don't yet support Option<Enum>
260 #[derive(Eq, PartialEq, Debug, Clone)]
262 /// The currency deferred from the 3rd and 4th character of the bech32 transaction
263 pub currency: Currency,
265 /// The amount that, multiplied by the SI prefix, has to be payed
266 pub raw_amount: Option<u64>,
268 /// SI prefix that gets multiplied with the `raw_amount`
269 pub si_prefix: Option<SiPrefix>,
272 /// Data of the `RawInvoice` that is encoded in the data part
273 #[derive(Eq, PartialEq, Debug, Clone)]
274 pub struct RawDataPart {
275 /// generation time of the invoice
276 pub timestamp: PositiveTimestamp,
278 /// tagged fields of the payment request
279 pub tagged_fields: Vec<RawTaggedField>,
282 /// A timestamp that refers to a date after 1 January 1970 which means its representation as UNIX
283 /// timestamp is positive.
286 /// The UNIX timestamp representing the stored time has to be positive and small enough so that
287 /// a `EpiryTime` can be added to it without an overflow.
288 #[derive(Eq, PartialEq, Debug, Clone)]
289 pub struct PositiveTimestamp(SystemTime);
291 /// SI prefixes for the human readable part
292 #[derive(Eq, PartialEq, Debug, Clone, Copy)]
305 /// Returns the multiplier to go from a BTC value to picoBTC implied by this SiPrefix.
306 /// This is effectively 10^12 * the prefix multiplier
307 pub fn multiplier(&self) -> u64 {
309 SiPrefix::Milli => 1_000_000_000,
310 SiPrefix::Micro => 1_000_000,
311 SiPrefix::Nano => 1_000,
316 /// Returns all enum variants of `SiPrefix` sorted in descending order of their associated
319 /// (C-not exported) As we don't yet support a slice of enums, and also because this function
320 /// isn't the most critical to expose.
321 pub fn values_desc() -> &'static [SiPrefix] {
323 static VALUES: [SiPrefix; 4] = [Milli, Micro, Nano, Pico];
328 /// Enum representing the crypto currencies (or networks) supported by this library
329 #[derive(Clone, Debug, Hash, Eq, PartialEq)]
347 /// Tagged field which may have an unknown tag
349 /// (C-not exported) as we don't currently support TaggedField
350 #[derive(Clone, Debug, Hash, Eq, PartialEq)]
351 pub enum RawTaggedField {
352 /// Parsed tagged field with known tag
353 KnownSemantics(TaggedField),
354 /// tagged field which was not parsed due to an unknown tag or undefined field semantics
355 UnknownSemantics(Vec<u5>),
358 /// Tagged field with known tag
360 /// For descriptions of the enum values please refer to the enclosed type's docs.
362 /// (C-not exported) As we don't yet support enum variants with the same name the struct contained
364 #[allow(missing_docs)]
365 #[derive(Clone, Debug, Hash, Eq, PartialEq)]
366 pub enum TaggedField {
368 Description(Description),
369 PayeePubKey(PayeePubKey),
370 DescriptionHash(Sha256),
371 ExpiryTime(ExpiryTime),
372 MinFinalCltvExpiry(MinFinalCltvExpiry),
374 PrivateRoute(PrivateRoute),
375 PaymentSecret(PaymentSecret),
376 Features(InvoiceFeatures),
380 #[derive(Clone, Debug, Hash, Eq, PartialEq)]
381 pub struct Sha256(pub sha256::Hash);
383 /// Description string
386 /// The description can be at most 639 __bytes__ long
387 #[derive(Clone, Debug, Hash, Eq, PartialEq)]
388 pub struct Description(String);
391 #[derive(Clone, Debug, Hash, Eq, PartialEq)]
392 pub struct PayeePubKey(pub PublicKey);
394 /// Positive duration that defines when (relatively to the timestamp) in the future the invoice
398 /// The number of seconds this expiry time represents has to be in the range
399 /// `0...(SYSTEM_TIME_MAX_UNIX_TIMESTAMP - MAX_EXPIRY_TIME)` to avoid overflows when adding it to a
401 #[derive(Clone, Debug, Hash, Eq, PartialEq)]
402 pub struct ExpiryTime(Duration);
404 /// `min_final_cltv_expiry` to use for the last HTLC in the route
405 #[derive(Clone, Debug, Hash, Eq, PartialEq)]
406 pub struct MinFinalCltvExpiry(pub u64);
408 // TODO: better types instead onf byte arrays
409 /// Fallback address in case no LN payment is possible
410 #[allow(missing_docs)]
411 #[derive(Clone, Debug, Hash, Eq, PartialEq)]
417 PubKeyHash([u8; 20]),
418 ScriptHash([u8; 20]),
421 /// Recoverable signature
422 #[derive(Clone, Debug, Eq, PartialEq)]
423 pub struct InvoiceSignature(pub RecoverableSignature);
425 /// Private routing information
428 /// The encoded route has to be <1024 5bit characters long (<=639 bytes or <=12 hops)
430 #[derive(Clone, Debug, Hash, Eq, PartialEq)]
431 pub struct PrivateRoute(RouteHint);
433 /// Tag constants as specified in BOLT11
434 #[allow(missing_docs)]
436 pub const TAG_PAYMENT_HASH: u8 = 1;
437 pub const TAG_DESCRIPTION: u8 = 13;
438 pub const TAG_PAYEE_PUB_KEY: u8 = 19;
439 pub const TAG_DESCRIPTION_HASH: u8 = 23;
440 pub const TAG_EXPIRY_TIME: u8 = 6;
441 pub const TAG_MIN_FINAL_CLTV_EXPIRY: u8 = 24;
442 pub const TAG_FALLBACK: u8 = 9;
443 pub const TAG_PRIVATE_ROUTE: u8 = 3;
444 pub const TAG_PAYMENT_SECRET: u8 = 16;
445 pub const TAG_FEATURES: u8 = 5;
448 impl InvoiceBuilder<tb::False, tb::False, tb::False, tb::False, tb::False> {
449 /// Construct new, empty `InvoiceBuilder`. All necessary fields have to be filled first before
450 /// `InvoiceBuilder::build(self)` becomes available.
451 pub fn new(currrency: Currency) -> Self {
457 tagged_fields: Vec::new(),
460 phantom_d: std::marker::PhantomData,
461 phantom_h: std::marker::PhantomData,
462 phantom_t: std::marker::PhantomData,
463 phantom_c: std::marker::PhantomData,
464 phantom_s: std::marker::PhantomData,
469 impl<D: tb::Bool, H: tb::Bool, T: tb::Bool, C: tb::Bool, S: tb::Bool> InvoiceBuilder<D, H, T, C, S> {
470 /// Helper function to set the completeness flags.
471 fn set_flags<DN: tb::Bool, HN: tb::Bool, TN: tb::Bool, CN: tb::Bool, SN: tb::Bool>(self) -> InvoiceBuilder<DN, HN, TN, CN, SN> {
472 InvoiceBuilder::<DN, HN, TN, CN, SN> {
473 currency: self.currency,
475 si_prefix: self.si_prefix,
476 timestamp: self.timestamp,
477 tagged_fields: self.tagged_fields,
480 phantom_d: std::marker::PhantomData,
481 phantom_h: std::marker::PhantomData,
482 phantom_t: std::marker::PhantomData,
483 phantom_c: std::marker::PhantomData,
484 phantom_s: std::marker::PhantomData,
488 /// Sets the amount in millisatoshis. The optimal SI prefix is chosen automatically.
489 pub fn amount_milli_satoshis(mut self, amount_msat: u64) -> Self {
490 let amount = amount_msat * 10; // Invoices are denominated in "pico BTC"
491 let biggest_possible_si_prefix = SiPrefix::values_desc()
493 .find(|prefix| amount % prefix.multiplier() == 0)
494 .expect("Pico should always match");
495 self.amount = Some(amount / biggest_possible_si_prefix.multiplier());
496 self.si_prefix = Some(*biggest_possible_si_prefix);
500 /// Sets the payee's public key.
501 pub fn payee_pub_key(mut self, pub_key: PublicKey) -> Self {
502 self.tagged_fields.push(TaggedField::PayeePubKey(PayeePubKey(pub_key)));
506 /// Sets the expiry time
507 pub fn expiry_time(mut self, expiry_time: Duration) -> Self {
508 match ExpiryTime::from_duration(expiry_time) {
509 Ok(t) => self.tagged_fields.push(TaggedField::ExpiryTime(t)),
510 Err(e) => self.error = Some(e),
515 /// Adds a fallback address.
516 pub fn fallback(mut self, fallback: Fallback) -> Self {
517 self.tagged_fields.push(TaggedField::Fallback(fallback));
521 /// Adds a private route.
522 pub fn private_route(mut self, hint: RouteHint) -> Self {
523 match PrivateRoute::new(hint) {
524 Ok(r) => self.tagged_fields.push(TaggedField::PrivateRoute(r)),
525 Err(e) => self.error = Some(e),
531 impl<D: tb::Bool, H: tb::Bool, C: tb::Bool, S: tb::Bool> InvoiceBuilder<D, H, tb::True, C, S> {
532 /// Builds a `RawInvoice` if no `CreationError` occurred while construction any of the fields.
533 pub fn build_raw(self) -> Result<RawInvoice, CreationError> {
535 // If an error occurred at any time before, return it now
536 if let Some(e) = self.error {
541 currency: self.currency,
542 raw_amount: self.amount,
543 si_prefix: self.si_prefix,
546 let timestamp = self.timestamp.expect("ensured to be Some(t) by type T");
548 let tagged_fields = self.tagged_fields.into_iter().map(|tf| {
549 RawTaggedField::KnownSemantics(tf)
550 }).collect::<Vec<_>>();
552 let data = RawDataPart {
553 timestamp: timestamp,
554 tagged_fields: tagged_fields,
564 impl<H: tb::Bool, T: tb::Bool, C: tb::Bool, S: tb::Bool> InvoiceBuilder<tb::False, H, T, C, S> {
565 /// Set the description. This function is only available if no description (hash) was set.
566 pub fn description(mut self, description: String) -> InvoiceBuilder<tb::True, H, T, C, S> {
567 match Description::new(description) {
568 Ok(d) => self.tagged_fields.push(TaggedField::Description(d)),
569 Err(e) => self.error = Some(e),
574 /// Set the description hash. This function is only available if no description (hash) was set.
575 pub fn description_hash(mut self, description_hash: sha256::Hash) -> InvoiceBuilder<tb::True, H, T, C, S> {
576 self.tagged_fields.push(TaggedField::DescriptionHash(Sha256(description_hash)));
581 impl<D: tb::Bool, T: tb::Bool, C: tb::Bool, S: tb::Bool> InvoiceBuilder<D, tb::False, T, C, S> {
582 /// Set the payment hash. This function is only available if no payment hash was set.
583 pub fn payment_hash(mut self, hash: sha256::Hash) -> InvoiceBuilder<D, tb::True, T, C, S> {
584 self.tagged_fields.push(TaggedField::PaymentHash(Sha256(hash)));
589 impl<D: tb::Bool, H: tb::Bool, C: tb::Bool, S: tb::Bool> InvoiceBuilder<D, H, tb::False, C, S> {
590 /// Sets the timestamp.
591 pub fn timestamp(mut self, time: SystemTime) -> InvoiceBuilder<D, H, tb::True, C, S> {
592 match PositiveTimestamp::from_system_time(time) {
593 Ok(t) => self.timestamp = Some(t),
594 Err(e) => self.error = Some(e),
600 /// Sets the timestamp to the current UNIX timestamp.
601 pub fn current_timestamp(mut self) -> InvoiceBuilder<D, H, tb::True, C, S> {
602 let now = PositiveTimestamp::from_system_time(SystemTime::now());
603 self.timestamp = Some(now.expect("for the foreseeable future this shouldn't happen"));
608 impl<D: tb::Bool, H: tb::Bool, T: tb::Bool, S: tb::Bool> InvoiceBuilder<D, H, T, tb::False, S> {
609 /// Sets `min_final_cltv_expiry`.
610 pub fn min_final_cltv_expiry(mut self, min_final_cltv_expiry: u64) -> InvoiceBuilder<D, H, T, tb::True, S> {
611 self.tagged_fields.push(TaggedField::MinFinalCltvExpiry(MinFinalCltvExpiry(min_final_cltv_expiry)));
616 impl<D: tb::Bool, H: tb::Bool, T: tb::Bool, C: tb::Bool> InvoiceBuilder<D, H, T, C, tb::False> {
617 /// Sets the payment secret and relevant features.
618 pub fn payment_secret(mut self, payment_secret: PaymentSecret) -> InvoiceBuilder<D, H, T, C, tb::True> {
619 let features = InvoiceFeatures::empty()
620 .set_variable_length_onion_required()
621 .set_payment_secret_required();
622 self.tagged_fields.push(TaggedField::PaymentSecret(payment_secret));
623 self.tagged_fields.push(TaggedField::Features(features));
628 impl<D: tb::Bool, H: tb::Bool, T: tb::Bool, C: tb::Bool> InvoiceBuilder<D, H, T, C, tb::True> {
629 /// Sets the `basic_mpp` feature as optional.
630 pub fn basic_mpp(mut self) -> Self {
631 self.tagged_fields = self.tagged_fields
633 .map(|field| match field {
634 TaggedField::Features(f) => TaggedField::Features(f.set_basic_mpp_optional()),
642 impl InvoiceBuilder<tb::True, tb::True, tb::True, tb::True, tb::True> {
643 /// Builds and signs an invoice using the supplied `sign_function`. This function MAY NOT fail
644 /// and MUST produce a recoverable signature valid for the given hash and if applicable also for
645 /// the included payee public key.
646 pub fn build_signed<F>(self, sign_function: F) -> Result<Invoice, CreationError>
647 where F: FnOnce(&Message) -> RecoverableSignature
649 let invoice = self.try_build_signed::<_, ()>(|hash| {
650 Ok(sign_function(hash))
655 Err(SignOrCreationError::CreationError(e)) => Err(e),
656 Err(SignOrCreationError::SignError(())) => unreachable!(),
660 /// Builds and signs an invoice using the supplied `sign_function`. This function MAY fail with
661 /// an error of type `E` and MUST produce a recoverable signature valid for the given hash and
662 /// if applicable also for the included payee public key.
663 pub fn try_build_signed<F, E>(self, sign_function: F) -> Result<Invoice, SignOrCreationError<E>>
664 where F: FnOnce(&Message) -> Result<RecoverableSignature, E>
666 let raw = match self.build_raw() {
668 Err(e) => return Err(SignOrCreationError::CreationError(e)),
671 let signed = match raw.sign(sign_function) {
673 Err(e) => return Err(SignOrCreationError::SignError(e)),
676 let invoice = Invoice {
677 signed_invoice: signed,
680 invoice.check_field_counts().expect("should be ensured by type signature of builder");
681 invoice.check_feature_bits().expect("should be ensured by type signature of builder");
682 invoice.check_amount().expect("should be ensured by type signature of builder");
689 impl SignedRawInvoice {
690 /// Disassembles the `SignedRawInvoice` into its three parts:
692 /// 2. hash of the raw invoice
694 pub fn into_parts(self) -> (RawInvoice, [u8; 32], InvoiceSignature) {
695 (self.raw_invoice, self.hash, self.signature)
698 /// The `RawInvoice` which was signed.
699 pub fn raw_invoice(&self) -> &RawInvoice {
703 /// The hash of the `RawInvoice` that was signed.
704 pub fn hash(&self) -> &[u8; 32] {
708 /// InvoiceSignature for the invoice.
709 pub fn signature(&self) -> &InvoiceSignature {
713 /// Recovers the public key used for signing the invoice from the recoverable signature.
714 pub fn recover_payee_pub_key(&self) -> Result<PayeePubKey, secp256k1::Error> {
715 let hash = Message::from_slice(&self.hash[..])
716 .expect("Hash is 32 bytes long, same as MESSAGE_SIZE");
718 Ok(PayeePubKey(Secp256k1::new().recover(
724 /// Checks if the signature is valid for the included payee public key or if none exists if it's
725 /// valid for the recovered signature (which should always be true?).
726 pub fn check_signature(&self) -> bool {
727 let included_pub_key = self.raw_invoice.payee_pub_key();
729 let mut recovered_pub_key = Option::None;
730 if recovered_pub_key.is_none() {
731 let recovered = match self.recover_payee_pub_key() {
733 Err(_) => return false,
735 recovered_pub_key = Some(recovered);
738 let pub_key = included_pub_key.or_else(|| recovered_pub_key.as_ref())
739 .expect("One is always present");
741 let hash = Message::from_slice(&self.hash[..])
742 .expect("Hash is 32 bytes long, same as MESSAGE_SIZE");
744 let secp_context = Secp256k1::new();
745 let verification_result = secp_context.verify(
747 &self.signature.to_standard(),
751 match verification_result {
758 /// Finds the first element of an enum stream of a given variant and extracts one member of the
759 /// variant. If no element was found `None` gets returned.
761 /// The following example would extract the first B.
770 /// let elements = vec![A(1), A(2), B(3), A(4)]
772 /// assert_eq!(find_extract!(elements.iter(), Enum::B(ref x), x), Some(3u16))
774 macro_rules! find_extract {
775 ($iter:expr, $enm:pat, $enm_var:ident) => {
776 find_all_extract!($iter, $enm, $enm_var).next()
780 /// Finds the all elements of an enum stream of a given variant and extracts one member of the
781 /// variant through an iterator.
783 /// The following example would extract all A.
792 /// let elements = vec![A(1), A(2), B(3), A(4)]
795 /// find_all_extract!(elements.iter(), Enum::A(ref x), x).collect::<Vec<u8>>(),
796 /// vec![1u8, 2u8, 4u8])
798 macro_rules! find_all_extract {
799 ($iter:expr, $enm:pat, $enm_var:ident) => {
800 $iter.filter_map(|tf| match *tf {
801 $enm => Some($enm_var),
807 #[allow(missing_docs)]
809 /// Construct the invoice's HRP and signatureless data into a preimage to be hashed.
810 pub(crate) fn construct_invoice_preimage(hrp_bytes: &[u8], data_without_signature: &[u5]) -> Vec<u8> {
811 use bech32::FromBase32;
813 let mut preimage = Vec::<u8>::from(hrp_bytes);
815 let mut data_part = Vec::from(data_without_signature);
816 let overhang = (data_part.len() * 5) % 8;
818 // add padding if data does not end at a byte boundary
819 data_part.push(u5::try_from_u8(0).unwrap());
821 // if overhang is in (1..3) we need to add u5(0) padding two times
823 data_part.push(u5::try_from_u8(0).unwrap());
827 preimage.extend_from_slice(&Vec::<u8>::from_base32(&data_part)
828 .expect("No padding error may occur due to appended zero above."));
832 /// Hash the HRP as bytes and signatureless data part.
833 fn hash_from_parts(hrp_bytes: &[u8], data_without_signature: &[u5]) -> [u8; 32] {
834 let preimage = RawInvoice::construct_invoice_preimage(hrp_bytes, data_without_signature);
835 let mut hash: [u8; 32] = Default::default();
836 hash.copy_from_slice(&sha256::Hash::hash(&preimage)[..]);
840 /// Calculate the hash of the encoded `RawInvoice`
841 pub fn hash(&self) -> [u8; 32] {
842 use bech32::ToBase32;
844 RawInvoice::hash_from_parts(
845 self.hrp.to_string().as_bytes(),
846 &self.data.to_base32()
850 /// Signs the invoice using the supplied `sign_function`. This function MAY fail with an error
851 /// of type `E`. Since the signature of a `SignedRawInvoice` is not required to be valid there
852 /// are no constraints regarding the validity of the produced signature.
854 /// (C-not exported) As we don't currently support passing function pointers into methods
856 pub fn sign<F, E>(self, sign_method: F) -> Result<SignedRawInvoice, E>
857 where F: FnOnce(&Message) -> Result<RecoverableSignature, E>
859 let raw_hash = self.hash();
860 let hash = Message::from_slice(&raw_hash[..])
861 .expect("Hash is 32 bytes long, same as MESSAGE_SIZE");
862 let signature = sign_method(&hash)?;
864 Ok(SignedRawInvoice {
867 signature: InvoiceSignature(signature),
871 /// Returns an iterator over all tagged fields with known semantics.
873 /// (C-not exported) As there is not yet a manual mapping for a FilterMap
874 pub fn known_tagged_fields(&self)
875 -> FilterMap<Iter<RawTaggedField>, fn(&RawTaggedField) -> Option<&TaggedField>>
877 // For 1.14.0 compatibility: closures' types can't be written an fn()->() in the
878 // function's type signature.
879 // TODO: refactor once impl Trait is available
880 fn match_raw(raw: &RawTaggedField) -> Option<&TaggedField> {
882 RawTaggedField::KnownSemantics(ref tf) => Some(tf),
887 self.data.tagged_fields.iter().filter_map(match_raw )
890 pub fn payment_hash(&self) -> Option<&Sha256> {
891 find_extract!(self.known_tagged_fields(), TaggedField::PaymentHash(ref x), x)
894 pub fn description(&self) -> Option<&Description> {
895 find_extract!(self.known_tagged_fields(), TaggedField::Description(ref x), x)
898 pub fn payee_pub_key(&self) -> Option<&PayeePubKey> {
899 find_extract!(self.known_tagged_fields(), TaggedField::PayeePubKey(ref x), x)
902 pub fn description_hash(&self) -> Option<&Sha256> {
903 find_extract!(self.known_tagged_fields(), TaggedField::DescriptionHash(ref x), x)
906 pub fn expiry_time(&self) -> Option<&ExpiryTime> {
907 find_extract!(self.known_tagged_fields(), TaggedField::ExpiryTime(ref x), x)
910 pub fn min_final_cltv_expiry(&self) -> Option<&MinFinalCltvExpiry> {
911 find_extract!(self.known_tagged_fields(), TaggedField::MinFinalCltvExpiry(ref x), x)
914 pub fn payment_secret(&self) -> Option<&PaymentSecret> {
915 find_extract!(self.known_tagged_fields(), TaggedField::PaymentSecret(ref x), x)
918 pub fn features(&self) -> Option<&InvoiceFeatures> {
919 find_extract!(self.known_tagged_fields(), TaggedField::Features(ref x), x)
922 /// (C-not exported) as we don't support Vec<&NonOpaqueType>
923 pub fn fallbacks(&self) -> Vec<&Fallback> {
924 find_all_extract!(self.known_tagged_fields(), TaggedField::Fallback(ref x), x).collect()
927 pub fn private_routes(&self) -> Vec<&PrivateRoute> {
928 find_all_extract!(self.known_tagged_fields(), TaggedField::PrivateRoute(ref x), x).collect()
931 pub fn amount_pico_btc(&self) -> Option<u64> {
932 self.hrp.raw_amount.map(|v| {
933 v * self.hrp.si_prefix.as_ref().map_or(1_000_000_000_000, |si| { si.multiplier() })
937 pub fn currency(&self) -> Currency {
938 self.hrp.currency.clone()
942 impl PositiveTimestamp {
943 /// Create a new `PositiveTimestamp` from a unix timestamp in the Range
944 /// `0...SYSTEM_TIME_MAX_UNIX_TIMESTAMP - MAX_EXPIRY_TIME`, otherwise return a
945 /// `CreationError::TimestampOutOfBounds`.
946 pub fn from_unix_timestamp(unix_seconds: u64) -> Result<Self, CreationError> {
947 if unix_seconds > SYSTEM_TIME_MAX_UNIX_TIMESTAMP - MAX_EXPIRY_TIME {
948 Err(CreationError::TimestampOutOfBounds)
950 Ok(PositiveTimestamp(UNIX_EPOCH + Duration::from_secs(unix_seconds)))
954 /// Create a new `PositiveTimestamp` from a `SystemTime` with a corresponding unix timestamp in
955 /// the Range `0...SYSTEM_TIME_MAX_UNIX_TIMESTAMP - MAX_EXPIRY_TIME`, otherwise return a
956 /// `CreationError::TimestampOutOfBounds`.
957 pub fn from_system_time(time: SystemTime) -> Result<Self, CreationError> {
959 .duration_since(UNIX_EPOCH)
960 .map(|t| t.as_secs() <= SYSTEM_TIME_MAX_UNIX_TIMESTAMP - MAX_EXPIRY_TIME)
963 Ok(PositiveTimestamp(time))
965 Err(CreationError::TimestampOutOfBounds)
969 /// Returns the UNIX timestamp representing the stored time
970 pub fn as_unix_timestamp(&self) -> u64 {
971 self.0.duration_since(UNIX_EPOCH)
972 .expect("ensured by type contract/constructors")
976 /// Returns a reference to the internal `SystemTime` time representation
977 pub fn as_time(&self) -> &SystemTime {
982 impl Into<SystemTime> for PositiveTimestamp {
983 fn into(self) -> SystemTime {
988 impl Deref for PositiveTimestamp {
989 type Target = SystemTime;
991 fn deref(&self) -> &Self::Target {
997 /// Transform the `Invoice` into it's unchecked version
998 pub fn into_signed_raw(self) -> SignedRawInvoice {
1002 /// Check that all mandatory fields are present
1003 fn check_field_counts(&self) -> Result<(), SemanticError> {
1004 // "A writer MUST include exactly one p field […]."
1005 let payment_hash_cnt = self.tagged_fields().filter(|&tf| match *tf {
1006 TaggedField::PaymentHash(_) => true,
1009 if payment_hash_cnt < 1 {
1010 return Err(SemanticError::NoPaymentHash);
1011 } else if payment_hash_cnt > 1 {
1012 return Err(SemanticError::MultiplePaymentHashes);
1015 // "A writer MUST include either exactly one d or exactly one h field."
1016 let description_cnt = self.tagged_fields().filter(|&tf| match *tf {
1017 TaggedField::Description(_) | TaggedField::DescriptionHash(_) => true,
1020 if description_cnt < 1 {
1021 return Err(SemanticError::NoDescription);
1022 } else if description_cnt > 1 {
1023 return Err(SemanticError::MultipleDescriptions);
1026 self.check_payment_secret()?;
1031 /// Checks that there is exactly one payment secret field
1032 fn check_payment_secret(&self) -> Result<(), SemanticError> {
1033 // "A writer MUST include exactly one `s` field."
1034 let payment_secret_count = self.tagged_fields().filter(|&tf| match *tf {
1035 TaggedField::PaymentSecret(_) => true,
1038 if payment_secret_count < 1 {
1039 return Err(SemanticError::NoPaymentSecret);
1040 } else if payment_secret_count > 1 {
1041 return Err(SemanticError::MultiplePaymentSecrets);
1047 /// Check that amount is a whole number of millisatoshis
1048 fn check_amount(&self) -> Result<(), SemanticError> {
1049 if let Some(amount_pico_btc) = self.amount_pico_btc() {
1050 if amount_pico_btc % 10 != 0 {
1051 return Err(SemanticError::ImpreciseAmount);
1057 /// Check that feature bits are set as required
1058 fn check_feature_bits(&self) -> Result<(), SemanticError> {
1059 self.check_payment_secret()?;
1061 // "A writer MUST set an s field if and only if the payment_secret feature is set."
1062 // (this requirement has been since removed, and we now require the payment secret
1063 // feature bit always).
1064 let features = self.tagged_fields().find(|&tf| match *tf {
1065 TaggedField::Features(_) => true,
1069 None => Err(SemanticError::InvalidFeatures),
1070 Some(TaggedField::Features(features)) => {
1071 if features.requires_unknown_bits() {
1072 Err(SemanticError::InvalidFeatures)
1073 } else if !features.supports_payment_secret() {
1074 Err(SemanticError::InvalidFeatures)
1079 Some(_) => unreachable!(),
1083 /// Check that the invoice is signed correctly and that key recovery works
1084 pub fn check_signature(&self) -> Result<(), SemanticError> {
1085 match self.signed_invoice.recover_payee_pub_key() {
1086 Err(secp256k1::Error::InvalidRecoveryId) =>
1087 return Err(SemanticError::InvalidRecoveryId),
1088 Err(secp256k1::Error::InvalidSignature) =>
1089 return Err(SemanticError::InvalidSignature),
1090 Err(e) => panic!("no other error may occur, got {:?}", e),
1094 if !self.signed_invoice.check_signature() {
1095 return Err(SemanticError::InvalidSignature);
1101 /// Constructs an `Invoice` from a `SignedRawInvoice` by checking all its invariants.
1103 /// use lightning_invoice::*;
1105 /// let invoice = "lnbc100p1psj9jhxdqud3jxktt5w46x7unfv9kz6mn0v3jsnp4q0d3p2sfluzdx45tqcs\
1106 /// h2pu5qc7lgq0xs578ngs6s0s68ua4h7cvspp5q6rmq35js88zp5dvwrv9m459tnk2zunwj5jalqtyxqulh0l\
1107 /// 5gflssp5nf55ny5gcrfl30xuhzj3nphgj27rstekmr9fw3ny5989s300gyus9qyysgqcqpcrzjqw2sxwe993\
1108 /// h5pcm4dxzpvttgza8zhkqxpgffcrf5v25nwpr3cmfg7z54kuqq8rgqqqqqqqq2qqqqq9qq9qrzjqd0ylaqcl\
1109 /// j9424x9m8h2vcukcgnm6s56xfgu3j78zyqzhgs4hlpzvznlugqq9vsqqqqqqqlgqqqqqeqq9qrzjqwldmj9d\
1110 /// ha74df76zhx6l9we0vjdquygcdt3kssupehe64g6yyp5yz5rhuqqwccqqyqqqqlgqqqqjcqq9qrzjqf9e58a\
1111 /// guqr0rcun0ajlvmzq3ek63cw2w282gv3z5uupmuwvgjtq2z55qsqqg6qqqyqqqrtnqqqzq3cqygrzjqvphms\
1112 /// ywntrrhqjcraumvc4y6r8v4z5v593trte429v4hredj7ms5z52usqq9ngqqqqqqqlgqqqqqqgq9qrzjq2v0v\
1113 /// p62g49p7569ev48cmulecsxe59lvaw3wlxm7r982zxa9zzj7z5l0cqqxusqqyqqqqlgqqqqqzsqygarl9fh3\
1114 /// 8s0gyuxjjgux34w75dnc6xp2l35j7es3jd4ugt3lu0xzre26yg5m7ke54n2d5sym4xcmxtl8238xxvw5h5h5\
1115 /// j5r6drg6k6zcqj0fcwg";
1117 /// let signed = invoice.parse::<SignedRawInvoice>().unwrap();
1119 /// assert!(Invoice::from_signed(signed).is_ok());
1121 pub fn from_signed(signed_invoice: SignedRawInvoice) -> Result<Self, SemanticError> {
1122 let invoice = Invoice {
1123 signed_invoice: signed_invoice,
1125 invoice.check_field_counts()?;
1126 invoice.check_feature_bits()?;
1127 invoice.check_signature()?;
1128 invoice.check_amount()?;
1133 /// Returns the `Invoice`'s timestamp (should equal it's creation time)
1134 pub fn timestamp(&self) -> &SystemTime {
1135 self.signed_invoice.raw_invoice().data.timestamp.as_time()
1138 /// Returns an iterator over all tagged fields of this Invoice.
1140 /// (C-not exported) As there is not yet a manual mapping for a FilterMap
1141 pub fn tagged_fields(&self)
1142 -> FilterMap<Iter<RawTaggedField>, fn(&RawTaggedField) -> Option<&TaggedField>> {
1143 self.signed_invoice.raw_invoice().known_tagged_fields()
1146 /// Returns the hash to which we will receive the preimage on completion of the payment
1147 pub fn payment_hash(&self) -> &sha256::Hash {
1148 &self.signed_invoice.payment_hash().expect("checked by constructor").0
1151 /// Return the description or a hash of it for longer ones
1153 /// (C-not exported) because we don't yet export InvoiceDescription
1154 pub fn description(&self) -> InvoiceDescription {
1155 if let Some(ref direct) = self.signed_invoice.description() {
1156 return InvoiceDescription::Direct(direct);
1157 } else if let Some(ref hash) = self.signed_invoice.description_hash() {
1158 return InvoiceDescription::Hash(hash);
1160 unreachable!("ensured by constructor");
1163 /// Get the payee's public key if one was included in the invoice
1164 pub fn payee_pub_key(&self) -> Option<&PublicKey> {
1165 self.signed_invoice.payee_pub_key().map(|x| &x.0)
1168 /// Get the payment secret if one was included in the invoice
1169 pub fn payment_secret(&self) -> &PaymentSecret {
1170 self.signed_invoice.payment_secret().expect("was checked by constructor")
1173 /// Get the invoice features if they were included in the invoice
1174 pub fn features(&self) -> Option<&InvoiceFeatures> {
1175 self.signed_invoice.features()
1178 /// Recover the payee's public key (only to be used if none was included in the invoice)
1179 pub fn recover_payee_pub_key(&self) -> PublicKey {
1180 self.signed_invoice.recover_payee_pub_key().expect("was checked by constructor").0
1183 /// Returns the invoice's expiry time, if present, otherwise [`DEFAULT_EXPIRY_TIME`].
1184 pub fn expiry_time(&self) -> Duration {
1185 self.signed_invoice.expiry_time()
1187 .unwrap_or(Duration::from_secs(DEFAULT_EXPIRY_TIME))
1190 /// Returns the invoice's `min_final_cltv_expiry` time, if present, otherwise
1191 /// [`DEFAULT_MIN_FINAL_CLTV_EXPIRY`].
1192 pub fn min_final_cltv_expiry(&self) -> u64 {
1193 self.signed_invoice.min_final_cltv_expiry()
1195 .unwrap_or(DEFAULT_MIN_FINAL_CLTV_EXPIRY)
1198 /// Returns a list of all fallback addresses
1200 /// (C-not exported) as we don't support Vec<&NonOpaqueType>
1201 pub fn fallbacks(&self) -> Vec<&Fallback> {
1202 self.signed_invoice.fallbacks()
1205 /// Returns a list of all routes included in the invoice
1206 pub fn private_routes(&self) -> Vec<&PrivateRoute> {
1207 self.signed_invoice.private_routes()
1210 /// Returns a list of all routes included in the invoice as the underlying hints
1211 pub fn route_hints(&self) -> Vec<&RouteHint> {
1213 self.signed_invoice.known_tagged_fields(), TaggedField::PrivateRoute(ref x), x
1214 ).map(|route| &**route).collect()
1217 /// Returns the currency for which the invoice was issued
1218 pub fn currency(&self) -> Currency {
1219 self.signed_invoice.currency()
1222 /// Returns the amount if specified in the invoice as pico <currency>.
1223 pub fn amount_pico_btc(&self) -> Option<u64> {
1224 self.signed_invoice.amount_pico_btc()
1228 impl From<TaggedField> for RawTaggedField {
1229 fn from(tf: TaggedField) -> Self {
1230 RawTaggedField::KnownSemantics(tf)
1235 /// Numeric representation of the field's tag
1236 pub fn tag(&self) -> u5 {
1237 let tag = match *self {
1238 TaggedField::PaymentHash(_) => constants::TAG_PAYMENT_HASH,
1239 TaggedField::Description(_) => constants::TAG_DESCRIPTION,
1240 TaggedField::PayeePubKey(_) => constants::TAG_PAYEE_PUB_KEY,
1241 TaggedField::DescriptionHash(_) => constants::TAG_DESCRIPTION_HASH,
1242 TaggedField::ExpiryTime(_) => constants::TAG_EXPIRY_TIME,
1243 TaggedField::MinFinalCltvExpiry(_) => constants::TAG_MIN_FINAL_CLTV_EXPIRY,
1244 TaggedField::Fallback(_) => constants::TAG_FALLBACK,
1245 TaggedField::PrivateRoute(_) => constants::TAG_PRIVATE_ROUTE,
1246 TaggedField::PaymentSecret(_) => constants::TAG_PAYMENT_SECRET,
1247 TaggedField::Features(_) => constants::TAG_FEATURES,
1250 u5::try_from_u8(tag).expect("all tags defined are <32")
1256 /// Creates a new `Description` if `description` is at most 1023 __bytes__ long,
1257 /// returns `CreationError::DescriptionTooLong` otherwise
1259 /// Please note that single characters may use more than one byte due to UTF8 encoding.
1260 pub fn new(description: String) -> Result<Description, CreationError> {
1261 if description.len() > 639 {
1262 Err(CreationError::DescriptionTooLong)
1264 Ok(Description(description))
1268 /// Returns the underlying description `String`
1269 pub fn into_inner(self) -> String {
1274 impl Into<String> for Description {
1275 fn into(self) -> String {
1280 impl Deref for Description {
1283 fn deref(&self) -> &str {
1288 impl From<PublicKey> for PayeePubKey {
1289 fn from(pk: PublicKey) -> Self {
1294 impl Deref for PayeePubKey {
1295 type Target = PublicKey;
1297 fn deref(&self) -> &PublicKey {
1303 /// Construct an `ExpiryTime` from seconds. If there exists a `PositiveTimestamp` which would
1304 /// overflow on adding the `EpiryTime` to it then this function will return a
1305 /// `CreationError::ExpiryTimeOutOfBounds`.
1306 pub fn from_seconds(seconds: u64) -> Result<ExpiryTime, CreationError> {
1307 if seconds <= MAX_EXPIRY_TIME {
1308 Ok(ExpiryTime(Duration::from_secs(seconds)))
1310 Err(CreationError::ExpiryTimeOutOfBounds)
1314 /// Construct an `ExpiryTime` from a `Duration`. If there exists a `PositiveTimestamp` which
1315 /// would overflow on adding the `EpiryTime` to it then this function will return a
1316 /// `CreationError::ExpiryTimeOutOfBounds`.
1317 pub fn from_duration(duration: Duration) -> Result<ExpiryTime, CreationError> {
1318 if duration.as_secs() <= MAX_EXPIRY_TIME {
1319 Ok(ExpiryTime(duration))
1321 Err(CreationError::ExpiryTimeOutOfBounds)
1325 /// Returns the expiry time in seconds
1326 pub fn as_seconds(&self) -> u64 {
1330 /// Returns a reference to the underlying `Duration` (=expiry time)
1331 pub fn as_duration(&self) -> &Duration {
1337 /// Creates a new (partial) route from a list of hops
1338 pub fn new(hops: RouteHint) -> Result<PrivateRoute, CreationError> {
1339 if hops.0.len() <= 12 {
1340 Ok(PrivateRoute(hops))
1342 Err(CreationError::RouteTooLong)
1346 /// Returns the underlying list of hops
1347 pub fn into_inner(self) -> RouteHint {
1352 impl Into<RouteHint> for PrivateRoute {
1353 fn into(self) -> RouteHint {
1358 impl Deref for PrivateRoute {
1359 type Target = RouteHint;
1361 fn deref(&self) -> &RouteHint {
1366 impl Deref for InvoiceSignature {
1367 type Target = RecoverableSignature;
1369 fn deref(&self) -> &RecoverableSignature {
1374 impl Deref for SignedRawInvoice {
1375 type Target = RawInvoice;
1377 fn deref(&self) -> &RawInvoice {
1382 /// Errors that may occur when constructing a new `RawInvoice` or `Invoice`
1383 #[derive(Eq, PartialEq, Debug, Clone)]
1384 pub enum CreationError {
1385 /// The supplied description string was longer than 639 __bytes__ (see [`Description::new(…)`](./struct.Description.html#method.new))
1388 /// The specified route has too many hops and can't be encoded
1391 /// The unix timestamp of the supplied date is <0 or can't be represented as `SystemTime`
1392 TimestampOutOfBounds,
1394 /// The supplied expiry time could cause an overflow if added to a `PositiveTimestamp`
1395 ExpiryTimeOutOfBounds,
1398 impl Display for CreationError {
1399 fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
1401 CreationError::DescriptionTooLong => f.write_str("The supplied description string was longer than 639 bytes"),
1402 CreationError::RouteTooLong => f.write_str("The specified route has too many hops and can't be encoded"),
1403 CreationError::TimestampOutOfBounds => f.write_str("The unix timestamp of the supplied date is <0 or can't be represented as `SystemTime`"),
1404 CreationError::ExpiryTimeOutOfBounds => f.write_str("The supplied expiry time could cause an overflow if added to a `PositiveTimestamp`"),
1409 impl std::error::Error for CreationError { }
1411 /// Errors that may occur when converting a `RawInvoice` to an `Invoice`. They relate to the
1412 /// requirements sections in BOLT #11
1413 #[derive(Eq, PartialEq, Debug, Clone)]
1414 pub enum SemanticError {
1415 /// The invoice is missing the mandatory payment hash
1418 /// The invoice has multiple payment hashes which isn't allowed
1419 MultiplePaymentHashes,
1421 /// No description or description hash are part of the invoice
1424 /// The invoice contains multiple descriptions and/or description hashes which isn't allowed
1425 MultipleDescriptions,
1427 /// The invoice is missing the mandatory payment secret, which all modern lightning nodes
1431 /// The invoice contains multiple payment secrets
1432 MultiplePaymentSecrets,
1434 /// The invoice's features are invalid
1437 /// The recovery id doesn't fit the signature/pub key
1440 /// The invoice's signature is invalid
1443 /// The invoice's amount was not a whole number of millisatoshis
1447 impl Display for SemanticError {
1448 fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
1450 SemanticError::NoPaymentHash => f.write_str("The invoice is missing the mandatory payment hash"),
1451 SemanticError::MultiplePaymentHashes => f.write_str("The invoice has multiple payment hashes which isn't allowed"),
1452 SemanticError::NoDescription => f.write_str("No description or description hash are part of the invoice"),
1453 SemanticError::MultipleDescriptions => f.write_str("The invoice contains multiple descriptions and/or description hashes which isn't allowed"),
1454 SemanticError::NoPaymentSecret => f.write_str("The invoice is missing the mandatory payment secret"),
1455 SemanticError::MultiplePaymentSecrets => f.write_str("The invoice contains multiple payment secrets"),
1456 SemanticError::InvalidFeatures => f.write_str("The invoice's features are invalid"),
1457 SemanticError::InvalidRecoveryId => f.write_str("The recovery id doesn't fit the signature/pub key"),
1458 SemanticError::InvalidSignature => f.write_str("The invoice's signature is invalid"),
1459 SemanticError::ImpreciseAmount => f.write_str("The invoice's amount was not a whole number of millisatoshis"),
1464 impl std::error::Error for SemanticError { }
1466 /// When signing using a fallible method either an user-supplied `SignError` or a `CreationError`
1468 #[derive(Eq, PartialEq, Debug, Clone)]
1469 pub enum SignOrCreationError<S = ()> {
1470 /// An error occurred during signing
1473 /// An error occurred while building the transaction
1474 CreationError(CreationError),
1477 impl<S> Display for SignOrCreationError<S> {
1478 fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
1480 SignOrCreationError::SignError(_) => f.write_str("An error occurred during signing"),
1481 SignOrCreationError::CreationError(err) => err.fmt(f),
1488 use bitcoin_hashes::hex::FromHex;
1489 use bitcoin_hashes::sha256;
1492 fn test_system_time_bounds_assumptions() {
1496 ::PositiveTimestamp::from_unix_timestamp(::SYSTEM_TIME_MAX_UNIX_TIMESTAMP + 1),
1497 Err(::CreationError::TimestampOutOfBounds)
1501 ::ExpiryTime::from_seconds(::MAX_EXPIRY_TIME + 1),
1502 Err(::CreationError::ExpiryTimeOutOfBounds)
1507 fn test_calc_invoice_hash() {
1508 use ::{RawInvoice, RawHrp, RawDataPart, Currency, PositiveTimestamp};
1509 use ::TaggedField::*;
1511 let invoice = RawInvoice {
1513 currency: Currency::Bitcoin,
1518 timestamp: PositiveTimestamp::from_unix_timestamp(1496314658).unwrap(),
1519 tagged_fields: vec![
1520 PaymentHash(::Sha256(sha256::Hash::from_hex(
1521 "0001020304050607080900010203040506070809000102030405060708090102"
1522 ).unwrap())).into(),
1523 Description(::Description::new(
1524 "Please consider supporting this project".to_owned()
1530 let expected_hash = [
1531 0xc3, 0xd4, 0xe8, 0x3f, 0x64, 0x6f, 0xa7, 0x9a, 0x39, 0x3d, 0x75, 0x27, 0x7b, 0x1d,
1532 0x85, 0x8d, 0xb1, 0xd1, 0xf7, 0xab, 0x71, 0x37, 0xdc, 0xb7, 0x83, 0x5d, 0xb2, 0xec,
1533 0xd5, 0x18, 0xe1, 0xc9
1536 assert_eq!(invoice.hash(), expected_hash)
1540 fn test_check_signature() {
1542 use secp256k1::Secp256k1;
1543 use secp256k1::recovery::{RecoveryId, RecoverableSignature};
1544 use secp256k1::key::{SecretKey, PublicKey};
1545 use {SignedRawInvoice, InvoiceSignature, RawInvoice, RawHrp, RawDataPart, Currency, Sha256,
1548 let invoice = SignedRawInvoice {
1549 raw_invoice: RawInvoice {
1551 currency: Currency::Bitcoin,
1556 timestamp: PositiveTimestamp::from_unix_timestamp(1496314658).unwrap(),
1557 tagged_fields: vec ! [
1558 PaymentHash(Sha256(sha256::Hash::from_hex(
1559 "0001020304050607080900010203040506070809000102030405060708090102"
1560 ).unwrap())).into(),
1563 "Please consider supporting this project".to_owned()
1570 0xc3, 0xd4, 0xe8, 0x3f, 0x64, 0x6f, 0xa7, 0x9a, 0x39, 0x3d, 0x75, 0x27,
1571 0x7b, 0x1d, 0x85, 0x8d, 0xb1, 0xd1, 0xf7, 0xab, 0x71, 0x37, 0xdc, 0xb7,
1572 0x83, 0x5d, 0xb2, 0xec, 0xd5, 0x18, 0xe1, 0xc9
1574 signature: InvoiceSignature(RecoverableSignature::from_compact(
1576 0x38u8, 0xec, 0x68, 0x91, 0x34, 0x5e, 0x20, 0x41, 0x45, 0xbe, 0x8a,
1577 0x3a, 0x99, 0xde, 0x38, 0xe9, 0x8a, 0x39, 0xd6, 0xa5, 0x69, 0x43,
1578 0x4e, 0x18, 0x45, 0xc8, 0xaf, 0x72, 0x05, 0xaf, 0xcf, 0xcc, 0x7f,
1579 0x42, 0x5f, 0xcd, 0x14, 0x63, 0xe9, 0x3c, 0x32, 0x88, 0x1e, 0xad,
1580 0x0d, 0x6e, 0x35, 0x6d, 0x46, 0x7e, 0xc8, 0xc0, 0x25, 0x53, 0xf9,
1581 0xaa, 0xb1, 0x5e, 0x57, 0x38, 0xb1, 0x1f, 0x12, 0x7f
1583 RecoveryId::from_i32(0).unwrap()
1587 assert!(invoice.check_signature());
1589 let private_key = SecretKey::from_slice(
1591 0xe1, 0x26, 0xf6, 0x8f, 0x7e, 0xaf, 0xcc, 0x8b, 0x74, 0xf5, 0x4d, 0x26, 0x9f, 0xe2,
1592 0x06, 0xbe, 0x71, 0x50, 0x00, 0xf9, 0x4d, 0xac, 0x06, 0x7d, 0x1c, 0x04, 0xa8, 0xca,
1593 0x3b, 0x2d, 0xb7, 0x34
1596 let public_key = PublicKey::from_secret_key(&Secp256k1::new(), &private_key);
1598 assert_eq!(invoice.recover_payee_pub_key(), Ok(::PayeePubKey(public_key)));
1600 let (raw_invoice, _, _) = invoice.into_parts();
1601 let new_signed = raw_invoice.sign::<_, ()>(|hash| {
1602 Ok(Secp256k1::new().sign_recoverable(hash, &private_key))
1605 assert!(new_signed.check_signature());
1609 fn test_check_feature_bits() {
1611 use lightning::ln::features::InvoiceFeatures;
1612 use secp256k1::Secp256k1;
1613 use secp256k1::key::SecretKey;
1614 use {RawInvoice, RawHrp, RawDataPart, Currency, Sha256, PositiveTimestamp, Invoice,
1617 let private_key = SecretKey::from_slice(&[42; 32]).unwrap();
1618 let payment_secret = lightning::ln::PaymentSecret([21; 32]);
1619 let invoice_template = RawInvoice {
1621 currency: Currency::Bitcoin,
1626 timestamp: PositiveTimestamp::from_unix_timestamp(1496314658).unwrap(),
1627 tagged_fields: vec ! [
1628 PaymentHash(Sha256(sha256::Hash::from_hex(
1629 "0001020304050607080900010203040506070809000102030405060708090102"
1630 ).unwrap())).into(),
1633 "Please consider supporting this project".to_owned()
1642 let mut invoice = invoice_template.clone();
1643 invoice.data.tagged_fields.push(PaymentSecret(payment_secret).into());
1644 invoice.sign::<_, ()>(|hash| Ok(Secp256k1::new().sign_recoverable(hash, &private_key)))
1646 assert_eq!(Invoice::from_signed(invoice), Err(SemanticError::InvalidFeatures));
1648 // Missing feature bits
1650 let mut invoice = invoice_template.clone();
1651 invoice.data.tagged_fields.push(PaymentSecret(payment_secret).into());
1652 invoice.data.tagged_fields.push(Features(InvoiceFeatures::empty()).into());
1653 invoice.sign::<_, ()>(|hash| Ok(Secp256k1::new().sign_recoverable(hash, &private_key)))
1655 assert_eq!(Invoice::from_signed(invoice), Err(SemanticError::InvalidFeatures));
1657 // Including payment secret and feature bits
1659 let mut invoice = invoice_template.clone();
1660 invoice.data.tagged_fields.push(PaymentSecret(payment_secret).into());
1661 invoice.data.tagged_fields.push(Features(InvoiceFeatures::known()).into());
1662 invoice.sign::<_, ()>(|hash| Ok(Secp256k1::new().sign_recoverable(hash, &private_key)))
1664 assert!(Invoice::from_signed(invoice).is_ok());
1666 // No payment secret or features
1668 let invoice = invoice_template.clone();
1669 invoice.sign::<_, ()>(|hash| Ok(Secp256k1::new().sign_recoverable(hash, &private_key)))
1671 assert_eq!(Invoice::from_signed(invoice), Err(SemanticError::NoPaymentSecret));
1673 // No payment secret or feature bits
1675 let mut invoice = invoice_template.clone();
1676 invoice.data.tagged_fields.push(Features(InvoiceFeatures::empty()).into());
1677 invoice.sign::<_, ()>(|hash| Ok(Secp256k1::new().sign_recoverable(hash, &private_key)))
1679 assert_eq!(Invoice::from_signed(invoice), Err(SemanticError::NoPaymentSecret));
1681 // Missing payment secret
1683 let mut invoice = invoice_template.clone();
1684 invoice.data.tagged_fields.push(Features(InvoiceFeatures::known()).into());
1685 invoice.sign::<_, ()>(|hash| Ok(Secp256k1::new().sign_recoverable(hash, &private_key)))
1687 assert_eq!(Invoice::from_signed(invoice), Err(SemanticError::NoPaymentSecret));
1689 // Multiple payment secrets
1691 let mut invoice = invoice_template.clone();
1692 invoice.data.tagged_fields.push(PaymentSecret(payment_secret).into());
1693 invoice.data.tagged_fields.push(PaymentSecret(payment_secret).into());
1694 invoice.sign::<_, ()>(|hash| Ok(Secp256k1::new().sign_recoverable(hash, &private_key)))
1696 assert_eq!(Invoice::from_signed(invoice), Err(SemanticError::MultiplePaymentSecrets));
1700 fn test_builder_amount() {
1703 let builder = InvoiceBuilder::new(Currency::Bitcoin)
1704 .description("Test".into())
1705 .payment_hash(sha256::Hash::from_slice(&[0;32][..]).unwrap())
1706 .current_timestamp();
1708 let invoice = builder.clone()
1709 .amount_milli_satoshis(1500)
1713 assert_eq!(invoice.hrp.si_prefix, Some(SiPrefix::Nano));
1714 assert_eq!(invoice.hrp.raw_amount, Some(15));
1717 let invoice = builder.clone()
1718 .amount_milli_satoshis(150)
1722 assert_eq!(invoice.hrp.si_prefix, Some(SiPrefix::Pico));
1723 assert_eq!(invoice.hrp.raw_amount, Some(1500));
1727 fn test_builder_fail() {
1729 use lightning::routing::router::RouteHintHop;
1730 use std::iter::FromIterator;
1731 use secp256k1::key::PublicKey;
1733 let builder = InvoiceBuilder::new(Currency::Bitcoin)
1734 .payment_hash(sha256::Hash::from_slice(&[0;32][..]).unwrap())
1735 .current_timestamp()
1736 .min_final_cltv_expiry(144);
1738 let too_long_string = String::from_iter(
1739 (0..1024).map(|_| '?')
1742 let long_desc_res = builder.clone()
1743 .description(too_long_string)
1745 assert_eq!(long_desc_res, Err(CreationError::DescriptionTooLong));
1747 let route_hop = RouteHintHop {
1748 src_node_id: PublicKey::from_slice(
1750 0x03, 0x9e, 0x03, 0xa9, 0x01, 0xb8, 0x55, 0x34, 0xff, 0x1e, 0x92, 0xc4,
1751 0x3c, 0x74, 0x43, 0x1f, 0x7c, 0xe7, 0x20, 0x46, 0x06, 0x0f, 0xcf, 0x7a,
1752 0x95, 0xc3, 0x7e, 0x14, 0x8f, 0x78, 0xc7, 0x72, 0x55
1755 short_channel_id: 0,
1758 proportional_millionths: 0,
1760 cltv_expiry_delta: 0,
1761 htlc_minimum_msat: None,
1762 htlc_maximum_msat: None,
1764 let too_long_route = RouteHint(vec![route_hop; 13]);
1765 let long_route_res = builder.clone()
1766 .description("Test".into())
1767 .private_route(too_long_route)
1769 assert_eq!(long_route_res, Err(CreationError::RouteTooLong));
1771 let sign_error_res = builder.clone()
1772 .description("Test".into())
1773 .payment_secret(PaymentSecret([0; 32]))
1774 .try_build_signed(|_| {
1775 Err("ImaginaryError")
1777 assert_eq!(sign_error_res, Err(SignOrCreationError::SignError("ImaginaryError")));
1781 fn test_builder_ok() {
1783 use lightning::routing::router::RouteHintHop;
1784 use secp256k1::Secp256k1;
1785 use secp256k1::key::{SecretKey, PublicKey};
1786 use std::time::{UNIX_EPOCH, Duration};
1788 let secp_ctx = Secp256k1::new();
1790 let private_key = SecretKey::from_slice(
1792 0xe1, 0x26, 0xf6, 0x8f, 0x7e, 0xaf, 0xcc, 0x8b, 0x74, 0xf5, 0x4d, 0x26, 0x9f, 0xe2,
1793 0x06, 0xbe, 0x71, 0x50, 0x00, 0xf9, 0x4d, 0xac, 0x06, 0x7d, 0x1c, 0x04, 0xa8, 0xca,
1794 0x3b, 0x2d, 0xb7, 0x34
1797 let public_key = PublicKey::from_secret_key(&secp_ctx, &private_key);
1799 let route_1 = RouteHint(vec![
1801 src_node_id: public_key.clone(),
1802 short_channel_id: de::parse_int_be(&[123; 8], 256).expect("short chan ID slice too big?"),
1805 proportional_millionths: 1,
1807 cltv_expiry_delta: 145,
1808 htlc_minimum_msat: None,
1809 htlc_maximum_msat: None,
1812 src_node_id: public_key.clone(),
1813 short_channel_id: de::parse_int_be(&[42; 8], 256).expect("short chan ID slice too big?"),
1816 proportional_millionths: 2,
1818 cltv_expiry_delta: 146,
1819 htlc_minimum_msat: None,
1820 htlc_maximum_msat: None,
1824 let route_2 = RouteHint(vec![
1826 src_node_id: public_key.clone(),
1827 short_channel_id: 0,
1830 proportional_millionths: 3,
1832 cltv_expiry_delta: 147,
1833 htlc_minimum_msat: None,
1834 htlc_maximum_msat: None,
1837 src_node_id: public_key.clone(),
1838 short_channel_id: de::parse_int_be(&[1; 8], 256).expect("short chan ID slice too big?"),
1841 proportional_millionths: 4,
1843 cltv_expiry_delta: 148,
1844 htlc_minimum_msat: None,
1845 htlc_maximum_msat: None,
1849 let builder = InvoiceBuilder::new(Currency::BitcoinTestnet)
1850 .amount_milli_satoshis(123)
1851 .timestamp(UNIX_EPOCH + Duration::from_secs(1234567))
1852 .payee_pub_key(public_key.clone())
1853 .expiry_time(Duration::from_secs(54321))
1854 .min_final_cltv_expiry(144)
1855 .fallback(Fallback::PubKeyHash([0;20]))
1856 .private_route(route_1.clone())
1857 .private_route(route_2.clone())
1858 .description_hash(sha256::Hash::from_slice(&[3;32][..]).unwrap())
1859 .payment_hash(sha256::Hash::from_slice(&[21;32][..]).unwrap())
1860 .payment_secret(PaymentSecret([42; 32]))
1863 let invoice = builder.clone().build_signed(|hash| {
1864 secp_ctx.sign_recoverable(hash, &private_key)
1867 assert!(invoice.check_signature().is_ok());
1868 assert_eq!(invoice.tagged_fields().count(), 10);
1870 assert_eq!(invoice.amount_pico_btc(), Some(1230));
1871 assert_eq!(invoice.currency(), Currency::BitcoinTestnet);
1873 invoice.timestamp().duration_since(UNIX_EPOCH).unwrap().as_secs(),
1876 assert_eq!(invoice.payee_pub_key(), Some(&public_key));
1877 assert_eq!(invoice.expiry_time(), Duration::from_secs(54321));
1878 assert_eq!(invoice.min_final_cltv_expiry(), 144);
1879 assert_eq!(invoice.fallbacks(), vec![&Fallback::PubKeyHash([0;20])]);
1880 assert_eq!(invoice.private_routes(), vec![&PrivateRoute(route_1), &PrivateRoute(route_2)]);
1882 invoice.description(),
1883 InvoiceDescription::Hash(&Sha256(sha256::Hash::from_slice(&[3;32][..]).unwrap()))
1885 assert_eq!(invoice.payment_hash(), &sha256::Hash::from_slice(&[21;32][..]).unwrap());
1886 assert_eq!(invoice.payment_secret(), &PaymentSecret([42; 32]));
1887 assert_eq!(invoice.features(), Some(&InvoiceFeatures::known()));
1889 let raw_invoice = builder.build_raw().unwrap();
1890 assert_eq!(raw_invoice, *invoice.into_signed_raw().raw_invoice())
1894 fn test_default_values() {
1896 use secp256k1::Secp256k1;
1897 use secp256k1::key::SecretKey;
1899 let signed_invoice = InvoiceBuilder::new(Currency::Bitcoin)
1900 .description("Test".into())
1901 .payment_hash(sha256::Hash::from_slice(&[0;32][..]).unwrap())
1902 .payment_secret(PaymentSecret([0; 32]))
1903 .current_timestamp()
1906 .sign::<_, ()>(|hash| {
1907 let privkey = SecretKey::from_slice(&[41; 32]).unwrap();
1908 let secp_ctx = Secp256k1::new();
1909 Ok(secp_ctx.sign_recoverable(hash, &privkey))
1912 let invoice = Invoice::from_signed(signed_invoice).unwrap();
1914 assert_eq!(invoice.min_final_cltv_expiry(), DEFAULT_MIN_FINAL_CLTV_EXPIRY);
1915 assert_eq!(invoice.expiry_time(), Duration::from_secs(DEFAULT_EXPIRY_TIME));