2 #![deny(non_upper_case_globals)]
3 #![deny(non_camel_case_types)]
4 #![deny(non_snake_case)]
7 #![cfg_attr(feature = "strict", deny(warnings))]
9 //! This crate provides data structures to represent
10 //! [lightning BOLT11](https://github.com/lightningnetwork/lightning-rfc/blob/master/11-payment-encoding.md)
11 //! invoices and functions to create, encode and decode these. If you just want to use the standard
12 //! en-/decoding functionality this should get you started:
14 //! * For parsing use `str::parse::<Invoice>(&self)` (see the docs of `impl FromStr for Invoice`)
15 //! * For constructing invoices use the `InvoiceBuilder`
16 //! * For serializing invoices use the `Display`/`ToString` traits
19 extern crate bitcoin_hashes;
20 extern crate lightning;
21 extern crate num_traits;
22 extern crate secp256k1;
25 use bitcoin_hashes::Hash;
26 use bitcoin_hashes::sha256;
27 use lightning::ln::features::InvoiceFeatures;
28 #[cfg(any(doc, test))]
29 use lightning::routing::network_graph::RoutingFees;
30 use lightning::routing::router::RouteHintHop;
32 use secp256k1::key::PublicKey;
33 use secp256k1::{Message, Secp256k1};
34 use secp256k1::recovery::RecoverableSignature;
37 use std::iter::FilterMap;
39 use std::time::{SystemTime, Duration, UNIX_EPOCH};
40 use std::fmt::{Display, Formatter, self};
46 pub use de::{ParseError, ParseOrSemanticError};
48 // TODO: fix before 2037 (see rust PR #55527)
49 /// Defines the maximum UNIX timestamp that can be represented as `SystemTime`. This is checked by
50 /// one of the unit tests, please run them.
51 const SYSTEM_TIME_MAX_UNIX_TIMESTAMP: u64 = std::i32::MAX as u64;
53 /// Allow the expiry time to be up to one year. Since this reduces the range of possible timestamps
54 /// it should be rather low as long as we still have to support 32bit time representations
55 const MAX_EXPIRY_TIME: u64 = 60 * 60 * 24 * 356;
57 /// Default expiry time as defined by [BOLT 11].
59 /// [BOLT 11]: https://github.com/lightningnetwork/lightning-rfc/blob/master/11-payment-encoding.md
60 const DEFAULT_EXPIRY_TIME: u64 = 3600;
62 /// This function is used as a static assert for the size of `SystemTime`. If the crate fails to
63 /// compile due to it this indicates that your system uses unexpected bounds for `SystemTime`. You
64 /// can remove this functions and run the test `test_system_time_bounds_assumptions`. In any case,
65 /// please open an issue. If all tests pass you should be able to use this library safely by just
66 /// removing this function till we patch it accordingly.
67 fn __system_time_size_check() {
68 // Use 2 * sizeof(u64) as expected size since the expected underlying implementation is storing
69 // a `Duration` since `SystemTime::UNIX_EPOCH`.
70 unsafe { std::mem::transmute_copy::<SystemTime, [u8; 16]>(&UNIX_EPOCH); }
74 /// **Call this function on startup to ensure that all assumptions about the platform are valid.**
76 /// Unfortunately we have to make assumptions about the upper bounds of the `SystemTime` type on
77 /// your platform which we can't fully verify at compile time and which isn't part of it's contract.
78 /// To our best knowledge our assumptions hold for all platforms officially supported by rust, but
79 /// since this check is fast we recommend to do it anyway.
81 /// If this function fails this is considered a bug. Please open an issue describing your
82 /// platform and stating your current system time.
85 /// If the check fails this function panics. By calling this function on startup you ensure that
86 /// this wont happen at an arbitrary later point in time.
87 pub fn check_platform() {
88 // The upper and lower bounds of `SystemTime` are not part of its public contract and are
89 // platform specific. That's why we have to test if our assumptions regarding these bounds
90 // hold on the target platform.
92 // If this test fails on your platform, please don't use the library and open an issue
93 // instead so we can resolve the situation. Currently this library is tested on:
95 let fail_date = UNIX_EPOCH + Duration::from_secs(SYSTEM_TIME_MAX_UNIX_TIMESTAMP);
96 let year = Duration::from_secs(60 * 60 * 24 * 365);
98 // Make sure that the library will keep working for another year
99 assert!(fail_date.duration_since(SystemTime::now()).unwrap() > year);
101 let max_ts = PositiveTimestamp::from_unix_timestamp(
102 SYSTEM_TIME_MAX_UNIX_TIMESTAMP - MAX_EXPIRY_TIME
104 let max_exp = ::ExpiryTime::from_seconds(MAX_EXPIRY_TIME).unwrap();
107 (*max_ts.as_time() + *max_exp.as_duration()).duration_since(UNIX_EPOCH).unwrap().as_secs(),
108 SYSTEM_TIME_MAX_UNIX_TIMESTAMP
113 /// Builder for `Invoice`s. It's the most convenient and advised way to use this library. It ensures
114 /// that only a semantically and syntactically correct Invoice can be built using it.
117 /// extern crate secp256k1;
118 /// extern crate lightning_invoice;
119 /// extern crate bitcoin_hashes;
121 /// use bitcoin_hashes::Hash;
122 /// use bitcoin_hashes::sha256;
124 /// use secp256k1::Secp256k1;
125 /// use secp256k1::key::SecretKey;
127 /// use lightning_invoice::{Currency, InvoiceBuilder};
130 /// let private_key = SecretKey::from_slice(
132 /// 0xe1, 0x26, 0xf6, 0x8f, 0x7e, 0xaf, 0xcc, 0x8b, 0x74, 0xf5, 0x4d, 0x26, 0x9f,
133 /// 0xe2, 0x06, 0xbe, 0x71, 0x50, 0x00, 0xf9, 0x4d, 0xac, 0x06, 0x7d, 0x1c, 0x04,
134 /// 0xa8, 0xca, 0x3b, 0x2d, 0xb7, 0x34
138 /// let payment_hash = sha256::Hash::from_slice(&[0; 32][..]).unwrap();
140 /// let invoice = InvoiceBuilder::new(Currency::Bitcoin)
141 /// .description("Coins pls!".into())
142 /// .payment_hash(payment_hash)
143 /// .current_timestamp()
144 /// .build_signed(|hash| {
145 /// Secp256k1::new().sign_recoverable(hash, &private_key)
149 /// assert!(invoice.to_string().starts_with("lnbc1"));
153 /// # Type parameters
154 /// The two parameters `D` and `H` signal if the builder already contains the correct amount of the
156 /// * `D`: exactly one `Description` or `DescriptionHash`
157 /// * `H`: exactly one `PaymentHash`
158 /// * `T`: the timestamp is set
160 /// (C-not exported) as we likely need to manually select one set of boolean type parameters.
161 #[derive(Eq, PartialEq, Debug, Clone)]
162 pub struct InvoiceBuilder<D: tb::Bool, H: tb::Bool, T: tb::Bool> {
165 si_prefix: Option<SiPrefix>,
166 timestamp: Option<PositiveTimestamp>,
167 tagged_fields: Vec<TaggedField>,
168 error: Option<CreationError>,
170 phantom_d: std::marker::PhantomData<D>,
171 phantom_h: std::marker::PhantomData<H>,
172 phantom_t: std::marker::PhantomData<T>,
175 /// Represents a syntactically and semantically correct lightning BOLT11 invoice.
177 /// There are three ways to construct an `Invoice`:
178 /// 1. using `InvoiceBuilder`
179 /// 2. using `Invoice::from_signed(SignedRawInvoice)`
180 /// 3. using `str::parse::<Invoice>(&str)`
181 #[derive(Eq, PartialEq, Debug, Clone)]
183 signed_invoice: SignedRawInvoice,
186 /// Represents the description of an invoice which has to be either a directly included string or
187 /// a hash of a description provided out of band.
189 /// (C-not exported) As we don't have a good way to map the reference lifetimes making this
190 /// practically impossible to use safely in languages like C.
191 #[derive(Eq, PartialEq, Debug, Clone)]
192 pub enum InvoiceDescription<'f> {
193 /// Reference to the directly supplied description in the invoice
194 Direct(&'f Description),
196 /// Reference to the description's hash included in the invoice
200 /// Represents a signed `RawInvoice` with cached hash. The signature is not checked and may be
204 /// The hash has to be either from the deserialized invoice or from the serialized `raw_invoice`.
205 #[derive(Eq, PartialEq, Debug, Clone)]
206 pub struct SignedRawInvoice {
207 /// The rawInvoice that the signature belongs to
208 raw_invoice: RawInvoice,
210 /// Hash of the `RawInvoice` that will be used to check the signature.
212 /// * if the `SignedRawInvoice` was deserialized the hash is of from the original encoded form,
213 /// since it's not guaranteed that encoding it again will lead to the same result since integers
214 /// could have been encoded with leading zeroes etc.
215 /// * if the `SignedRawInvoice` was constructed manually the hash will be the calculated hash
216 /// from the `RawInvoice`
219 /// signature of the payment request
220 signature: InvoiceSignature,
223 /// Represents an syntactically correct Invoice for a payment on the lightning network,
224 /// but without the signature information.
225 /// De- and encoding should not lead to information loss but may lead to different hashes.
227 /// For methods without docs see the corresponding methods in `Invoice`.
228 #[derive(Eq, PartialEq, Debug, Clone)]
229 pub struct RawInvoice {
230 /// human readable part
234 pub data: RawDataPart,
237 /// Data of the `RawInvoice` that is encoded in the human readable part
239 /// (C-not exported) As we don't yet support Option<Enum>
240 #[derive(Eq, PartialEq, Debug, Clone)]
242 /// The currency deferred from the 3rd and 4th character of the bech32 transaction
243 pub currency: Currency,
245 /// The amount that, multiplied by the SI prefix, has to be payed
246 pub raw_amount: Option<u64>,
248 /// SI prefix that gets multiplied with the `raw_amount`
249 pub si_prefix: Option<SiPrefix>,
252 /// Data of the `RawInvoice` that is encoded in the data part
253 #[derive(Eq, PartialEq, Debug, Clone)]
254 pub struct RawDataPart {
255 /// generation time of the invoice
256 pub timestamp: PositiveTimestamp,
258 /// tagged fields of the payment request
259 pub tagged_fields: Vec<RawTaggedField>,
262 /// A timestamp that refers to a date after 1 January 1970 which means its representation as UNIX
263 /// timestamp is positive.
266 /// The UNIX timestamp representing the stored time has to be positive and small enough so that
267 /// a `EpiryTime` can be added to it without an overflow.
268 #[derive(Eq, PartialEq, Debug, Clone)]
269 pub struct PositiveTimestamp(SystemTime);
271 /// SI prefixes for the human readable part
272 #[derive(Eq, PartialEq, Debug, Clone, Copy)]
285 /// Returns the multiplier to go from a BTC value to picoBTC implied by this SiPrefix.
286 /// This is effectively 10^12 * the prefix multiplier
287 pub fn multiplier(&self) -> u64 {
289 SiPrefix::Milli => 1_000_000_000,
290 SiPrefix::Micro => 1_000_000,
291 SiPrefix::Nano => 1_000,
296 /// Returns all enum variants of `SiPrefix` sorted in descending order of their associated
299 /// (C-not exported) As we don't yet support a slice of enums, and also because this function
300 /// isn't the most critical to expose.
301 pub fn values_desc() -> &'static [SiPrefix] {
303 static VALUES: [SiPrefix; 4] = [Milli, Micro, Nano, Pico];
308 /// Enum representing the crypto currencies (or networks) supported by this library
309 #[derive(Eq, PartialEq, Debug, Clone)]
320 /// Bitcoin simnet/signet
324 /// Tagged field which may have an unknown tag
325 #[derive(Eq, PartialEq, Debug, Clone)]
326 pub enum RawTaggedField {
327 /// Parsed tagged field with known tag
328 KnownSemantics(TaggedField),
329 /// tagged field which was not parsed due to an unknown tag or undefined field semantics
330 UnknownSemantics(Vec<u5>),
333 /// Tagged field with known tag
335 /// For descriptions of the enum values please refer to the enclosed type's docs.
336 #[allow(missing_docs)]
337 #[derive(Eq, PartialEq, Debug, Clone)]
338 pub enum TaggedField {
340 Description(Description),
341 PayeePubKey(PayeePubKey),
342 DescriptionHash(Sha256),
343 ExpiryTime(ExpiryTime),
344 MinFinalCltvExpiry(MinFinalCltvExpiry),
347 PaymentSecret(PaymentSecret),
348 Features(InvoiceFeatures),
352 #[derive(Eq, PartialEq, Debug, Clone)]
353 pub struct Sha256(pub sha256::Hash);
355 /// Description string
358 /// The description can be at most 639 __bytes__ long
359 #[derive(Eq, PartialEq, Debug, Clone)]
360 pub struct Description(String);
363 #[derive(Eq, PartialEq, Debug, Clone)]
364 pub struct PayeePubKey(pub PublicKey);
366 /// 256-bit payment secret
367 #[derive(Eq, PartialEq, Debug, Clone)]
368 pub struct PaymentSecret(pub [u8; 32]);
370 /// Positive duration that defines when (relatively to the timestamp) in the future the invoice
374 /// The number of seconds this expiry time represents has to be in the range
375 /// `0...(SYSTEM_TIME_MAX_UNIX_TIMESTAMP - MAX_EXPIRY_TIME)` to avoid overflows when adding it to a
377 #[derive(Eq, PartialEq, Debug, Clone)]
378 pub struct ExpiryTime(Duration);
380 /// `min_final_cltv_expiry` to use for the last HTLC in the route
381 #[derive(Eq, PartialEq, Debug, Clone)]
382 pub struct MinFinalCltvExpiry(pub u64);
384 // TODO: better types instead onf byte arrays
385 /// Fallback address in case no LN payment is possible
386 #[allow(missing_docs)]
387 #[derive(Eq, PartialEq, Debug, Clone)]
393 PubKeyHash([u8; 20]),
394 ScriptHash([u8; 20]),
397 /// Recoverable signature
398 #[derive(Eq, PartialEq, Debug, Clone)]
399 pub struct InvoiceSignature(pub RecoverableSignature);
401 /// Private routing information
404 /// The encoded route has to be <1024 5bit characters long (<=639 bytes or <=12 hops)
406 #[derive(Eq, PartialEq, Debug, Clone)]
407 pub struct RouteHint(Vec<RouteHintHop>);
409 /// Tag constants as specified in BOLT11
410 #[allow(missing_docs)]
412 pub const TAG_PAYMENT_HASH: u8 = 1;
413 pub const TAG_DESCRIPTION: u8 = 13;
414 pub const TAG_PAYEE_PUB_KEY: u8 = 19;
415 pub const TAG_DESCRIPTION_HASH: u8 = 23;
416 pub const TAG_EXPIRY_TIME: u8 = 6;
417 pub const TAG_MIN_FINAL_CLTV_EXPIRY: u8 = 24;
418 pub const TAG_FALLBACK: u8 = 9;
419 pub const TAG_ROUTE: u8 = 3;
420 pub const TAG_PAYMENT_SECRET: u8 = 16;
421 pub const TAG_FEATURES: u8 = 5;
424 impl InvoiceBuilder<tb::False, tb::False, tb::False> {
425 /// Construct new, empty `InvoiceBuilder`. All necessary fields have to be filled first before
426 /// `InvoiceBuilder::build(self)` becomes available.
427 pub fn new(currrency: Currency) -> Self {
433 tagged_fields: Vec::new(),
436 phantom_d: std::marker::PhantomData,
437 phantom_h: std::marker::PhantomData,
438 phantom_t: std::marker::PhantomData,
443 impl<D: tb::Bool, H: tb::Bool, T: tb::Bool> InvoiceBuilder<D, H, T> {
444 /// Helper function to set the completeness flags.
445 fn set_flags<DN: tb::Bool, HN: tb::Bool, TN: tb::Bool>(self) -> InvoiceBuilder<DN, HN, TN> {
446 InvoiceBuilder::<DN, HN, TN> {
447 currency: self.currency,
449 si_prefix: self.si_prefix,
450 timestamp: self.timestamp,
451 tagged_fields: self.tagged_fields,
454 phantom_d: std::marker::PhantomData,
455 phantom_h: std::marker::PhantomData,
456 phantom_t: std::marker::PhantomData,
460 /// Sets the amount in pico BTC. The optimal SI prefix is choosen automatically.
461 pub fn amount_pico_btc(mut self, amount: u64) -> Self {
462 let biggest_possible_si_prefix = SiPrefix::values_desc()
464 .find(|prefix| amount % prefix.multiplier() == 0)
465 .expect("Pico should always match");
466 self.amount = Some(amount / biggest_possible_si_prefix.multiplier());
467 self.si_prefix = Some(*biggest_possible_si_prefix);
471 /// Sets the payee's public key.
472 pub fn payee_pub_key(mut self, pub_key: PublicKey) -> Self {
473 self.tagged_fields.push(TaggedField::PayeePubKey(PayeePubKey(pub_key)));
477 /// Sets the payment secret
478 pub fn payment_secret(mut self, payment_secret: PaymentSecret) -> Self {
479 self.tagged_fields.push(TaggedField::PaymentSecret(payment_secret));
483 /// Sets the expiry time
484 pub fn expiry_time(mut self, expiry_time: Duration) -> Self {
485 match ExpiryTime::from_duration(expiry_time) {
486 Ok(t) => self.tagged_fields.push(TaggedField::ExpiryTime(t)),
487 Err(e) => self.error = Some(e),
492 /// Sets `min_final_cltv_expiry`.
493 pub fn min_final_cltv_expiry(mut self, min_final_cltv_expiry: u64) -> Self {
494 self.tagged_fields.push(TaggedField::MinFinalCltvExpiry(MinFinalCltvExpiry(min_final_cltv_expiry)));
498 /// Adds a fallback address.
499 pub fn fallback(mut self, fallback: Fallback) -> Self {
500 self.tagged_fields.push(TaggedField::Fallback(fallback));
504 /// Adds a private route.
505 pub fn route(mut self, route: Vec<RouteHintHop>) -> Self {
506 match RouteHint::new(route) {
507 Ok(r) => self.tagged_fields.push(TaggedField::Route(r)),
508 Err(e) => self.error = Some(e),
513 /// Adds a features field which indicates the set of supported protocol extensions which the
514 /// origin node supports.
515 pub fn features(mut self, features: InvoiceFeatures) -> Self {
516 self.tagged_fields.push(TaggedField::Features(features));
521 impl<D: tb::Bool, H: tb::Bool> InvoiceBuilder<D, H, tb::True> {
522 /// Builds a `RawInvoice` if no `CreationError` occurred while construction any of the fields.
523 pub fn build_raw(self) -> Result<RawInvoice, CreationError> {
525 // If an error occurred at any time before, return it now
526 if let Some(e) = self.error {
531 currency: self.currency,
532 raw_amount: self.amount,
533 si_prefix: self.si_prefix,
536 let timestamp = self.timestamp.expect("ensured to be Some(t) by type T");
538 let tagged_fields = self.tagged_fields.into_iter().map(|tf| {
539 RawTaggedField::KnownSemantics(tf)
540 }).collect::<Vec<_>>();
542 let data = RawDataPart {
543 timestamp: timestamp,
544 tagged_fields: tagged_fields,
554 impl<H: tb::Bool, T: tb::Bool> InvoiceBuilder<tb::False, H, T> {
555 /// Set the description. This function is only available if no description (hash) was set.
556 pub fn description(mut self, description: String) -> InvoiceBuilder<tb::True, H, T> {
557 match Description::new(description) {
558 Ok(d) => self.tagged_fields.push(TaggedField::Description(d)),
559 Err(e) => self.error = Some(e),
564 /// Set the description hash. This function is only available if no description (hash) was set.
565 pub fn description_hash(mut self, description_hash: sha256::Hash) -> InvoiceBuilder<tb::True, H, T> {
566 self.tagged_fields.push(TaggedField::DescriptionHash(Sha256(description_hash)));
571 impl<D: tb::Bool, T: tb::Bool> InvoiceBuilder<D, tb::False, T> {
572 /// Set the payment hash. This function is only available if no payment hash was set.
573 pub fn payment_hash(mut self, hash: sha256::Hash) -> InvoiceBuilder<D, tb::True, T> {
574 self.tagged_fields.push(TaggedField::PaymentHash(Sha256(hash)));
579 impl<D: tb::Bool, H: tb::Bool> InvoiceBuilder<D, H, tb::False> {
580 /// Sets the timestamp.
581 pub fn timestamp(mut self, time: SystemTime) -> InvoiceBuilder<D, H, tb::True> {
582 match PositiveTimestamp::from_system_time(time) {
583 Ok(t) => self.timestamp = Some(t),
584 Err(e) => self.error = Some(e),
590 /// Sets the timestamp to the current UNIX timestamp.
591 pub fn current_timestamp(mut self) -> InvoiceBuilder<D, H, tb::True> {
592 let now = PositiveTimestamp::from_system_time(SystemTime::now());
593 self.timestamp = Some(now.expect("for the foreseeable future this shouldn't happen"));
598 impl InvoiceBuilder<tb::True, tb::True, tb::True> {
599 /// Builds and signs an invoice using the supplied `sign_function`. This function MAY NOT fail
600 /// and MUST produce a recoverable signature valid for the given hash and if applicable also for
601 /// the included payee public key.
602 pub fn build_signed<F>(self, sign_function: F) -> Result<Invoice, CreationError>
603 where F: FnOnce(&Message) -> RecoverableSignature
605 let invoice = self.try_build_signed::<_, ()>(|hash| {
606 Ok(sign_function(hash))
611 Err(SignOrCreationError::CreationError(e)) => Err(e),
612 Err(SignOrCreationError::SignError(())) => unreachable!(),
616 /// Builds and signs an invoice using the supplied `sign_function`. This function MAY fail with
617 /// an error of type `E` and MUST produce a recoverable signature valid for the given hash and
618 /// if applicable also for the included payee public key.
619 pub fn try_build_signed<F, E>(self, sign_function: F) -> Result<Invoice, SignOrCreationError<E>>
620 where F: FnOnce(&Message) -> Result<RecoverableSignature, E>
622 let raw = match self.build_raw() {
624 Err(e) => return Err(SignOrCreationError::CreationError(e)),
627 let signed = match raw.sign(sign_function) {
629 Err(e) => return Err(SignOrCreationError::SignError(e)),
632 let invoice = Invoice {
633 signed_invoice: signed,
636 invoice.check_field_counts().expect("should be ensured by type signature of builder");
643 impl SignedRawInvoice {
644 /// Disassembles the `SignedRawInvoice` into its three parts:
646 /// 2. hash of the raw invoice
648 pub fn into_parts(self) -> (RawInvoice, [u8; 32], InvoiceSignature) {
649 (self.raw_invoice, self.hash, self.signature)
652 /// The `RawInvoice` which was signed.
653 pub fn raw_invoice(&self) -> &RawInvoice {
657 /// The hash of the `RawInvoice` that was signed.
658 pub fn hash(&self) -> &[u8; 32] {
662 /// InvoiceSignature for the invoice.
663 pub fn signature(&self) -> &InvoiceSignature {
667 /// Recovers the public key used for signing the invoice from the recoverable signature.
668 pub fn recover_payee_pub_key(&self) -> Result<PayeePubKey, secp256k1::Error> {
669 let hash = Message::from_slice(&self.hash[..])
670 .expect("Hash is 32 bytes long, same as MESSAGE_SIZE");
672 Ok(PayeePubKey(Secp256k1::new().recover(
678 /// Checks if the signature is valid for the included payee public key or if none exists if it's
679 /// valid for the recovered signature (which should always be true?).
680 pub fn check_signature(&self) -> bool {
681 let included_pub_key = self.raw_invoice.payee_pub_key();
683 let mut recovered_pub_key = Option::None;
684 if recovered_pub_key.is_none() {
685 let recovered = match self.recover_payee_pub_key() {
687 Err(_) => return false,
689 recovered_pub_key = Some(recovered);
692 let pub_key = included_pub_key.or_else(|| recovered_pub_key.as_ref())
693 .expect("One is always present");
695 let hash = Message::from_slice(&self.hash[..])
696 .expect("Hash is 32 bytes long, same as MESSAGE_SIZE");
698 let secp_context = Secp256k1::new();
699 let verification_result = secp_context.verify(
701 &self.signature.to_standard(),
705 match verification_result {
712 /// Finds the first element of an enum stream of a given variant and extracts one member of the
713 /// variant. If no element was found `None` gets returned.
715 /// The following example would extract the first
724 /// let elements = vec![A(1), A(2), B(3), A(4)]
726 /// assert_eq!(find_extract!(elements.iter(), Enum::B(ref x), x), Some(3u16))
728 macro_rules! find_extract {
729 ($iter:expr, $enm:pat, $enm_var:ident) => {
730 $iter.filter_map(|tf| match *tf {
731 $enm => Some($enm_var),
737 #[allow(missing_docs)]
739 /// Hash the HRP as bytes and signatureless data part.
740 fn hash_from_parts(hrp_bytes: &[u8], data_without_signature: &[u5]) -> [u8; 32] {
741 use bech32::FromBase32;
743 let mut preimage = Vec::<u8>::from(hrp_bytes);
745 let mut data_part = Vec::from(data_without_signature);
746 let overhang = (data_part.len() * 5) % 8;
748 // add padding if data does not end at a byte boundary
749 data_part.push(u5::try_from_u8(0).unwrap());
751 // if overhang is in (1..3) we need to add u5(0) padding two times
753 data_part.push(u5::try_from_u8(0).unwrap());
757 preimage.extend_from_slice(&Vec::<u8>::from_base32(&data_part)
758 .expect("No padding error may occur due to appended zero above."));
760 let mut hash: [u8; 32] = Default::default();
761 hash.copy_from_slice(&sha256::Hash::hash(&preimage)[..]);
765 /// Calculate the hash of the encoded `RawInvoice`
766 pub fn hash(&self) -> [u8; 32] {
767 use bech32::ToBase32;
769 RawInvoice::hash_from_parts(
770 self.hrp.to_string().as_bytes(),
771 &self.data.to_base32()
775 /// Signs the invoice using the supplied `sign_function`. This function MAY fail with an error
776 /// of type `E`. Since the signature of a `SignedRawInvoice` is not required to be valid there
777 /// are no constraints regarding the validity of the produced signature.
779 /// (C-not exported) As we don't currently support passing function pointers into methods
781 pub fn sign<F, E>(self, sign_method: F) -> Result<SignedRawInvoice, E>
782 where F: FnOnce(&Message) -> Result<RecoverableSignature, E>
784 let raw_hash = self.hash();
785 let hash = Message::from_slice(&raw_hash[..])
786 .expect("Hash is 32 bytes long, same as MESSAGE_SIZE");
787 let signature = sign_method(&hash)?;
789 Ok(SignedRawInvoice {
792 signature: InvoiceSignature(signature),
796 /// Returns an iterator over all tagged fields with known semantics.
798 /// (C-not exported) As there is not yet a manual mapping for a FilterMap
799 pub fn known_tagged_fields(&self)
800 -> FilterMap<Iter<RawTaggedField>, fn(&RawTaggedField) -> Option<&TaggedField>>
802 // For 1.14.0 compatibility: closures' types can't be written an fn()->() in the
803 // function's type signature.
804 // TODO: refactor once impl Trait is available
805 fn match_raw(raw: &RawTaggedField) -> Option<&TaggedField> {
807 RawTaggedField::KnownSemantics(ref tf) => Some(tf),
812 self.data.tagged_fields.iter().filter_map(match_raw )
815 pub fn payment_hash(&self) -> Option<&Sha256> {
816 find_extract!(self.known_tagged_fields(), TaggedField::PaymentHash(ref x), x)
819 pub fn description(&self) -> Option<&Description> {
820 find_extract!(self.known_tagged_fields(), TaggedField::Description(ref x), x)
823 pub fn payee_pub_key(&self) -> Option<&PayeePubKey> {
824 find_extract!(self.known_tagged_fields(), TaggedField::PayeePubKey(ref x), x)
827 pub fn description_hash(&self) -> Option<&Sha256> {
828 find_extract!(self.known_tagged_fields(), TaggedField::DescriptionHash(ref x), x)
831 pub fn expiry_time(&self) -> Option<&ExpiryTime> {
832 find_extract!(self.known_tagged_fields(), TaggedField::ExpiryTime(ref x), x)
835 pub fn min_final_cltv_expiry(&self) -> Option<&MinFinalCltvExpiry> {
836 find_extract!(self.known_tagged_fields(), TaggedField::MinFinalCltvExpiry(ref x), x)
839 pub fn payment_secret(&self) -> Option<&PaymentSecret> {
840 find_extract!(self.known_tagged_fields(), TaggedField::PaymentSecret(ref x), x)
843 pub fn features(&self) -> Option<&InvoiceFeatures> {
844 find_extract!(self.known_tagged_fields(), TaggedField::Features(ref x), x)
847 /// (C-not exported) as we don't support Vec<&NonOpaqueType>
848 pub fn fallbacks(&self) -> Vec<&Fallback> {
849 self.known_tagged_fields().filter_map(|tf| match tf {
850 &TaggedField::Fallback(ref f) => Some(f),
852 }).collect::<Vec<&Fallback>>()
855 pub fn routes(&self) -> Vec<&RouteHint> {
856 self.known_tagged_fields().filter_map(|tf| match tf {
857 &TaggedField::Route(ref r) => Some(r),
859 }).collect::<Vec<&RouteHint>>()
862 pub fn amount_pico_btc(&self) -> Option<u64> {
863 self.hrp.raw_amount.map(|v| {
864 v * self.hrp.si_prefix.as_ref().map_or(1_000_000_000_000, |si| { si.multiplier() })
868 pub fn currency(&self) -> Currency {
869 self.hrp.currency.clone()
873 impl PositiveTimestamp {
874 /// Create a new `PositiveTimestamp` from a unix timestamp in the Range
875 /// `0...SYSTEM_TIME_MAX_UNIX_TIMESTAMP - MAX_EXPIRY_TIME`, otherwise return a
876 /// `CreationError::TimestampOutOfBounds`.
877 pub fn from_unix_timestamp(unix_seconds: u64) -> Result<Self, CreationError> {
878 if unix_seconds > SYSTEM_TIME_MAX_UNIX_TIMESTAMP - MAX_EXPIRY_TIME {
879 Err(CreationError::TimestampOutOfBounds)
881 Ok(PositiveTimestamp(UNIX_EPOCH + Duration::from_secs(unix_seconds)))
885 /// Create a new `PositiveTimestamp` from a `SystemTime` with a corresponding unix timestamp in
886 /// the Range `0...SYSTEM_TIME_MAX_UNIX_TIMESTAMP - MAX_EXPIRY_TIME`, otherwise return a
887 /// `CreationError::TimestampOutOfBounds`.
888 pub fn from_system_time(time: SystemTime) -> Result<Self, CreationError> {
890 .duration_since(UNIX_EPOCH)
891 .map(|t| t.as_secs() <= SYSTEM_TIME_MAX_UNIX_TIMESTAMP - MAX_EXPIRY_TIME)
894 Ok(PositiveTimestamp(time))
896 Err(CreationError::TimestampOutOfBounds)
900 /// Returns the UNIX timestamp representing the stored time
901 pub fn as_unix_timestamp(&self) -> u64 {
902 self.0.duration_since(UNIX_EPOCH)
903 .expect("ensured by type contract/constructors")
907 /// Returns a reference to the internal `SystemTime` time representation
908 pub fn as_time(&self) -> &SystemTime {
913 impl Into<SystemTime> for PositiveTimestamp {
914 fn into(self) -> SystemTime {
919 impl Deref for PositiveTimestamp {
920 type Target = SystemTime;
922 fn deref(&self) -> &Self::Target {
928 /// Transform the `Invoice` into it's unchecked version
929 pub fn into_signed_raw(self) -> SignedRawInvoice {
933 /// Check that all mandatory fields are present
934 fn check_field_counts(&self) -> Result<(), SemanticError> {
935 // "A writer MUST include exactly one p field […]."
936 let payment_hash_cnt = self.tagged_fields().filter(|&tf| match *tf {
937 TaggedField::PaymentHash(_) => true,
940 if payment_hash_cnt < 1 {
941 return Err(SemanticError::NoPaymentHash);
942 } else if payment_hash_cnt > 1 {
943 return Err(SemanticError::MultiplePaymentHashes);
946 // "A writer MUST include either exactly one d or exactly one h field."
947 let description_cnt = self.tagged_fields().filter(|&tf| match *tf {
948 TaggedField::Description(_) | TaggedField::DescriptionHash(_) => true,
951 if description_cnt < 1 {
952 return Err(SemanticError::NoDescription);
953 } else if description_cnt > 1 {
954 return Err(SemanticError::MultipleDescriptions);
960 /// Check that the invoice is signed correctly and that key recovery works
961 pub fn check_signature(&self) -> Result<(), SemanticError> {
962 match self.signed_invoice.recover_payee_pub_key() {
963 Err(secp256k1::Error::InvalidRecoveryId) =>
964 return Err(SemanticError::InvalidRecoveryId),
965 Err(_) => panic!("no other error may occur"),
969 if !self.signed_invoice.check_signature() {
970 return Err(SemanticError::InvalidSignature);
976 /// Constructs an `Invoice` from a `SignedInvoice` by checking all its invariants.
978 /// use lightning_invoice::*;
980 /// let invoice = "lnbc1pvjluezpp5qqqsyqcyq5rqwzqfqqqsyqcyq5rqwzqfqqqsyqcyq5rqwzqfqypqdp\
981 /// l2pkx2ctnv5sxxmmwwd5kgetjypeh2ursdae8g6twvus8g6rfwvs8qun0dfjkxaq8rkx3yf5tcsyz3d7\
982 /// 3gafnh3cax9rn449d9p5uxz9ezhhypd0elx87sjle52x86fux2ypatgddc6k63n7erqz25le42c4u4ec\
985 /// let signed = invoice.parse::<SignedRawInvoice>().unwrap();
987 /// assert!(Invoice::from_signed(signed).is_ok());
989 pub fn from_signed(signed_invoice: SignedRawInvoice) -> Result<Self, SemanticError> {
990 let invoice = Invoice {
991 signed_invoice: signed_invoice,
993 invoice.check_field_counts()?;
994 invoice.check_signature()?;
999 /// Returns the `Invoice`'s timestamp (should equal it's creation time)
1000 pub fn timestamp(&self) -> &SystemTime {
1001 self.signed_invoice.raw_invoice().data.timestamp.as_time()
1004 /// Returns an iterator over all tagged fields of this Invoice.
1006 /// (C-not exported) As there is not yet a manual mapping for a FilterMap
1007 pub fn tagged_fields(&self)
1008 -> FilterMap<Iter<RawTaggedField>, fn(&RawTaggedField) -> Option<&TaggedField>> {
1009 self.signed_invoice.raw_invoice().known_tagged_fields()
1012 /// Returns the hash to which we will receive the preimage on completion of the payment
1013 pub fn payment_hash(&self) -> &sha256::Hash {
1014 &self.signed_invoice.payment_hash().expect("checked by constructor").0
1017 /// Return the description or a hash of it for longer ones
1019 /// (C-not exported) because we don't yet export InvoiceDescription
1020 pub fn description(&self) -> InvoiceDescription {
1021 if let Some(ref direct) = self.signed_invoice.description() {
1022 return InvoiceDescription::Direct(direct);
1023 } else if let Some(ref hash) = self.signed_invoice.description_hash() {
1024 return InvoiceDescription::Hash(hash);
1026 unreachable!("ensured by constructor");
1029 /// Get the payee's public key if one was included in the invoice
1030 pub fn payee_pub_key(&self) -> Option<&PublicKey> {
1031 self.signed_invoice.payee_pub_key().map(|x| &x.0)
1034 /// Get the payment secret if one was included in the invoice
1035 pub fn payment_secret(&self) -> Option<&PaymentSecret> {
1036 self.signed_invoice.payment_secret()
1039 /// Get the invoice features if they were included in the invoice
1040 pub fn features(&self) -> Option<&InvoiceFeatures> {
1041 self.signed_invoice.features()
1044 /// Recover the payee's public key (only to be used if none was included in the invoice)
1045 pub fn recover_payee_pub_key(&self) -> PublicKey {
1046 self.signed_invoice.recover_payee_pub_key().expect("was checked by constructor").0
1049 /// Returns the invoice's expiry time, if present, otherwise [`DEFAULT_EXPIRY_TIME`].
1050 pub fn expiry_time(&self) -> Duration {
1051 self.signed_invoice.expiry_time()
1053 .unwrap_or(Duration::from_secs(DEFAULT_EXPIRY_TIME))
1056 /// Returns the invoice's `min_cltv_expiry` time if present
1057 pub fn min_final_cltv_expiry(&self) -> Option<u64> {
1058 self.signed_invoice.min_final_cltv_expiry().map(|x| x.0)
1061 /// Returns a list of all fallback addresses
1063 /// (C-not exported) as we don't support Vec<&NonOpaqueType>
1064 pub fn fallbacks(&self) -> Vec<&Fallback> {
1065 self.signed_invoice.fallbacks()
1068 /// Returns a list of all routes included in the invoice
1069 pub fn routes(&self) -> Vec<&RouteHint> {
1070 self.signed_invoice.routes()
1073 /// Returns the currency for which the invoice was issued
1074 pub fn currency(&self) -> Currency {
1075 self.signed_invoice.currency()
1078 /// Returns the amount if specified in the invoice as pico <currency>.
1079 pub fn amount_pico_btc(&self) -> Option<u64> {
1080 self.signed_invoice.amount_pico_btc()
1084 impl From<TaggedField> for RawTaggedField {
1085 fn from(tf: TaggedField) -> Self {
1086 RawTaggedField::KnownSemantics(tf)
1091 /// Numeric representation of the field's tag
1092 pub fn tag(&self) -> u5 {
1093 let tag = match *self {
1094 TaggedField::PaymentHash(_) => constants::TAG_PAYMENT_HASH,
1095 TaggedField::Description(_) => constants::TAG_DESCRIPTION,
1096 TaggedField::PayeePubKey(_) => constants::TAG_PAYEE_PUB_KEY,
1097 TaggedField::DescriptionHash(_) => constants::TAG_DESCRIPTION_HASH,
1098 TaggedField::ExpiryTime(_) => constants::TAG_EXPIRY_TIME,
1099 TaggedField::MinFinalCltvExpiry(_) => constants::TAG_MIN_FINAL_CLTV_EXPIRY,
1100 TaggedField::Fallback(_) => constants::TAG_FALLBACK,
1101 TaggedField::Route(_) => constants::TAG_ROUTE,
1102 TaggedField::PaymentSecret(_) => constants::TAG_PAYMENT_SECRET,
1103 TaggedField::Features(_) => constants::TAG_FEATURES,
1106 u5::try_from_u8(tag).expect("all tags defined are <32")
1112 /// Creates a new `Description` if `description` is at most 1023 __bytes__ long,
1113 /// returns `CreationError::DescriptionTooLong` otherwise
1115 /// Please note that single characters may use more than one byte due to UTF8 encoding.
1116 pub fn new(description: String) -> Result<Description, CreationError> {
1117 if description.len() > 639 {
1118 Err(CreationError::DescriptionTooLong)
1120 Ok(Description(description))
1124 /// Returns the underlying description `String`
1125 pub fn into_inner(self) -> String {
1130 impl Into<String> for Description {
1131 fn into(self) -> String {
1136 impl Deref for Description {
1139 fn deref(&self) -> &str {
1144 impl From<PublicKey> for PayeePubKey {
1145 fn from(pk: PublicKey) -> Self {
1150 impl Deref for PayeePubKey {
1151 type Target = PublicKey;
1153 fn deref(&self) -> &PublicKey {
1159 /// Construct an `ExpiryTime` from seconds. If there exists a `PositiveTimestamp` which would
1160 /// overflow on adding the `EpiryTime` to it then this function will return a
1161 /// `CreationError::ExpiryTimeOutOfBounds`.
1162 pub fn from_seconds(seconds: u64) -> Result<ExpiryTime, CreationError> {
1163 if seconds <= MAX_EXPIRY_TIME {
1164 Ok(ExpiryTime(Duration::from_secs(seconds)))
1166 Err(CreationError::ExpiryTimeOutOfBounds)
1170 /// Construct an `ExpiryTime` from a `Duration`. If there exists a `PositiveTimestamp` which
1171 /// would overflow on adding the `EpiryTime` to it then this function will return a
1172 /// `CreationError::ExpiryTimeOutOfBounds`.
1173 pub fn from_duration(duration: Duration) -> Result<ExpiryTime, CreationError> {
1174 if duration.as_secs() <= MAX_EXPIRY_TIME {
1175 Ok(ExpiryTime(duration))
1177 Err(CreationError::ExpiryTimeOutOfBounds)
1181 /// Returns the expiry time in seconds
1182 pub fn as_seconds(&self) -> u64 {
1186 /// Returns a reference to the underlying `Duration` (=expiry time)
1187 pub fn as_duration(&self) -> &Duration {
1193 /// Create a new (partial) route from a list of hops
1194 pub fn new(hops: Vec<RouteHintHop>) -> Result<RouteHint, CreationError> {
1195 if hops.len() <= 12 {
1198 Err(CreationError::RouteTooLong)
1202 /// Returrn the underlying vector of hops
1203 pub fn into_inner(self) -> Vec<RouteHintHop> {
1208 impl Into<Vec<RouteHintHop>> for RouteHint {
1209 fn into(self) -> Vec<RouteHintHop> {
1214 impl Deref for RouteHint {
1215 type Target = Vec<RouteHintHop>;
1217 fn deref(&self) -> &Vec<RouteHintHop> {
1222 impl Deref for InvoiceSignature {
1223 type Target = RecoverableSignature;
1225 fn deref(&self) -> &RecoverableSignature {
1230 impl Deref for SignedRawInvoice {
1231 type Target = RawInvoice;
1233 fn deref(&self) -> &RawInvoice {
1238 /// Errors that may occur when constructing a new `RawInvoice` or `Invoice`
1239 #[derive(Eq, PartialEq, Debug, Clone)]
1240 pub enum CreationError {
1241 /// The supplied description string was longer than 639 __bytes__ (see [`Description::new(…)`](./struct.Description.html#method.new))
1244 /// The specified route has too many hops and can't be encoded
1247 /// The unix timestamp of the supplied date is <0 or can't be represented as `SystemTime`
1248 TimestampOutOfBounds,
1250 /// The supplied expiry time could cause an overflow if added to a `PositiveTimestamp`
1251 ExpiryTimeOutOfBounds,
1254 impl Display for CreationError {
1255 fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
1257 CreationError::DescriptionTooLong => f.write_str("The supplied description string was longer than 639 bytes"),
1258 CreationError::RouteTooLong => f.write_str("The specified route has too many hops and can't be encoded"),
1259 CreationError::TimestampOutOfBounds => f.write_str("The unix timestamp of the supplied date is <0 or can't be represented as `SystemTime`"),
1260 CreationError::ExpiryTimeOutOfBounds => f.write_str("The supplied expiry time could cause an overflow if added to a `PositiveTimestamp`"),
1265 impl std::error::Error for CreationError { }
1267 /// Errors that may occur when converting a `RawInvoice` to an `Invoice`. They relate to the
1268 /// requirements sections in BOLT #11
1269 #[derive(Eq, PartialEq, Debug, Clone)]
1270 pub enum SemanticError {
1271 /// The invoice is missing the mandatory payment hash
1274 /// The invoice has multiple payment hashes which isn't allowed
1275 MultiplePaymentHashes,
1277 /// No description or description hash are part of the invoice
1280 /// The invoice contains multiple descriptions and/or description hashes which isn't allowed
1281 MultipleDescriptions,
1283 /// The recovery id doesn't fit the signature/pub key
1286 /// The invoice's signature is invalid
1290 impl Display for SemanticError {
1291 fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
1293 SemanticError::NoPaymentHash => f.write_str("The invoice is missing the mandatory payment hash"),
1294 SemanticError::MultiplePaymentHashes => f.write_str("The invoice has multiple payment hashes which isn't allowed"),
1295 SemanticError::NoDescription => f.write_str("No description or description hash are part of the invoice"),
1296 SemanticError::MultipleDescriptions => f.write_str("The invoice contains multiple descriptions and/or description hashes which isn't allowed"),
1297 SemanticError::InvalidRecoveryId => f.write_str("The recovery id doesn't fit the signature/pub key"),
1298 SemanticError::InvalidSignature => f.write_str("The invoice's signature is invalid"),
1303 impl std::error::Error for SemanticError { }
1305 /// When signing using a fallible method either an user-supplied `SignError` or a `CreationError`
1308 /// (C-not exported) As we don't support unbounded generics
1309 #[derive(Eq, PartialEq, Debug, Clone)]
1310 pub enum SignOrCreationError<S> {
1311 /// An error occurred during signing
1314 /// An error occurred while building the transaction
1315 CreationError(CreationError),
1318 impl<S> Display for SignOrCreationError<S> {
1319 fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
1321 SignOrCreationError::SignError(_) => f.write_str("An error occurred during signing"),
1322 SignOrCreationError::CreationError(err) => err.fmt(f),
1329 use bitcoin_hashes::hex::FromHex;
1330 use bitcoin_hashes::sha256;
1333 fn test_system_time_bounds_assumptions() {
1337 ::PositiveTimestamp::from_unix_timestamp(::SYSTEM_TIME_MAX_UNIX_TIMESTAMP + 1),
1338 Err(::CreationError::TimestampOutOfBounds)
1342 ::ExpiryTime::from_seconds(::MAX_EXPIRY_TIME + 1),
1343 Err(::CreationError::ExpiryTimeOutOfBounds)
1348 fn test_calc_invoice_hash() {
1349 use ::{RawInvoice, RawHrp, RawDataPart, Currency, PositiveTimestamp};
1350 use ::TaggedField::*;
1352 let invoice = RawInvoice {
1354 currency: Currency::Bitcoin,
1359 timestamp: PositiveTimestamp::from_unix_timestamp(1496314658).unwrap(),
1360 tagged_fields: vec![
1361 PaymentHash(::Sha256(sha256::Hash::from_hex(
1362 "0001020304050607080900010203040506070809000102030405060708090102"
1363 ).unwrap())).into(),
1364 Description(::Description::new(
1365 "Please consider supporting this project".to_owned()
1371 let expected_hash = [
1372 0xc3, 0xd4, 0xe8, 0x3f, 0x64, 0x6f, 0xa7, 0x9a, 0x39, 0x3d, 0x75, 0x27, 0x7b, 0x1d,
1373 0x85, 0x8d, 0xb1, 0xd1, 0xf7, 0xab, 0x71, 0x37, 0xdc, 0xb7, 0x83, 0x5d, 0xb2, 0xec,
1374 0xd5, 0x18, 0xe1, 0xc9
1377 assert_eq!(invoice.hash(), expected_hash)
1381 fn test_check_signature() {
1383 use secp256k1::Secp256k1;
1384 use secp256k1::recovery::{RecoveryId, RecoverableSignature};
1385 use secp256k1::key::{SecretKey, PublicKey};
1386 use {SignedRawInvoice, InvoiceSignature, RawInvoice, RawHrp, RawDataPart, Currency, Sha256,
1389 let invoice = SignedRawInvoice {
1390 raw_invoice: RawInvoice {
1392 currency: Currency::Bitcoin,
1397 timestamp: PositiveTimestamp::from_unix_timestamp(1496314658).unwrap(),
1398 tagged_fields: vec ! [
1399 PaymentHash(Sha256(sha256::Hash::from_hex(
1400 "0001020304050607080900010203040506070809000102030405060708090102"
1401 ).unwrap())).into(),
1404 "Please consider supporting this project".to_owned()
1411 0xc3, 0xd4, 0xe8, 0x3f, 0x64, 0x6f, 0xa7, 0x9a, 0x39, 0x3d, 0x75, 0x27,
1412 0x7b, 0x1d, 0x85, 0x8d, 0xb1, 0xd1, 0xf7, 0xab, 0x71, 0x37, 0xdc, 0xb7,
1413 0x83, 0x5d, 0xb2, 0xec, 0xd5, 0x18, 0xe1, 0xc9
1415 signature: InvoiceSignature(RecoverableSignature::from_compact(
1417 0x38u8, 0xec, 0x68, 0x91, 0x34, 0x5e, 0x20, 0x41, 0x45, 0xbe, 0x8a,
1418 0x3a, 0x99, 0xde, 0x38, 0xe9, 0x8a, 0x39, 0xd6, 0xa5, 0x69, 0x43,
1419 0x4e, 0x18, 0x45, 0xc8, 0xaf, 0x72, 0x05, 0xaf, 0xcf, 0xcc, 0x7f,
1420 0x42, 0x5f, 0xcd, 0x14, 0x63, 0xe9, 0x3c, 0x32, 0x88, 0x1e, 0xad,
1421 0x0d, 0x6e, 0x35, 0x6d, 0x46, 0x7e, 0xc8, 0xc0, 0x25, 0x53, 0xf9,
1422 0xaa, 0xb1, 0x5e, 0x57, 0x38, 0xb1, 0x1f, 0x12, 0x7f
1424 RecoveryId::from_i32(0).unwrap()
1428 assert!(invoice.check_signature());
1430 let private_key = SecretKey::from_slice(
1432 0xe1, 0x26, 0xf6, 0x8f, 0x7e, 0xaf, 0xcc, 0x8b, 0x74, 0xf5, 0x4d, 0x26, 0x9f, 0xe2,
1433 0x06, 0xbe, 0x71, 0x50, 0x00, 0xf9, 0x4d, 0xac, 0x06, 0x7d, 0x1c, 0x04, 0xa8, 0xca,
1434 0x3b, 0x2d, 0xb7, 0x34
1437 let public_key = PublicKey::from_secret_key(&Secp256k1::new(), &private_key);
1439 assert_eq!(invoice.recover_payee_pub_key(), Ok(::PayeePubKey(public_key)));
1441 let (raw_invoice, _, _) = invoice.into_parts();
1442 let new_signed = raw_invoice.sign::<_, ()>(|hash| {
1443 Ok(Secp256k1::new().sign_recoverable(hash, &private_key))
1446 assert!(new_signed.check_signature());
1450 fn test_builder_amount() {
1453 let builder = InvoiceBuilder::new(Currency::Bitcoin)
1454 .description("Test".into())
1455 .payment_hash(sha256::Hash::from_slice(&[0;32][..]).unwrap())
1456 .current_timestamp();
1458 let invoice = builder.clone()
1459 .amount_pico_btc(15000)
1463 assert_eq!(invoice.hrp.si_prefix, Some(SiPrefix::Nano));
1464 assert_eq!(invoice.hrp.raw_amount, Some(15));
1467 let invoice = builder.clone()
1468 .amount_pico_btc(1500)
1472 assert_eq!(invoice.hrp.si_prefix, Some(SiPrefix::Pico));
1473 assert_eq!(invoice.hrp.raw_amount, Some(1500));
1477 fn test_builder_fail() {
1479 use std::iter::FromIterator;
1480 use secp256k1::key::PublicKey;
1482 let builder = InvoiceBuilder::new(Currency::Bitcoin)
1483 .payment_hash(sha256::Hash::from_slice(&[0;32][..]).unwrap())
1484 .current_timestamp();
1486 let too_long_string = String::from_iter(
1487 (0..1024).map(|_| '?')
1490 let long_desc_res = builder.clone()
1491 .description(too_long_string)
1493 assert_eq!(long_desc_res, Err(CreationError::DescriptionTooLong));
1495 let route_hop = RouteHintHop {
1496 src_node_id: PublicKey::from_slice(
1498 0x03, 0x9e, 0x03, 0xa9, 0x01, 0xb8, 0x55, 0x34, 0xff, 0x1e, 0x92, 0xc4,
1499 0x3c, 0x74, 0x43, 0x1f, 0x7c, 0xe7, 0x20, 0x46, 0x06, 0x0f, 0xcf, 0x7a,
1500 0x95, 0xc3, 0x7e, 0x14, 0x8f, 0x78, 0xc7, 0x72, 0x55
1503 short_channel_id: 0,
1506 proportional_millionths: 0,
1508 cltv_expiry_delta: 0,
1509 htlc_minimum_msat: None,
1510 htlc_maximum_msat: None,
1512 let too_long_route = vec![route_hop; 13];
1513 let long_route_res = builder.clone()
1514 .description("Test".into())
1515 .route(too_long_route)
1517 assert_eq!(long_route_res, Err(CreationError::RouteTooLong));
1519 let sign_error_res = builder.clone()
1520 .description("Test".into())
1521 .try_build_signed(|_| {
1522 Err("ImaginaryError")
1524 assert_eq!(sign_error_res, Err(SignOrCreationError::SignError("ImaginaryError")));
1528 fn test_builder_ok() {
1530 use secp256k1::Secp256k1;
1531 use secp256k1::key::{SecretKey, PublicKey};
1532 use std::time::{UNIX_EPOCH, Duration};
1534 let secp_ctx = Secp256k1::new();
1536 let private_key = SecretKey::from_slice(
1538 0xe1, 0x26, 0xf6, 0x8f, 0x7e, 0xaf, 0xcc, 0x8b, 0x74, 0xf5, 0x4d, 0x26, 0x9f, 0xe2,
1539 0x06, 0xbe, 0x71, 0x50, 0x00, 0xf9, 0x4d, 0xac, 0x06, 0x7d, 0x1c, 0x04, 0xa8, 0xca,
1540 0x3b, 0x2d, 0xb7, 0x34
1543 let public_key = PublicKey::from_secret_key(&secp_ctx, &private_key);
1547 src_node_id: public_key.clone(),
1548 short_channel_id: de::parse_int_be(&[123; 8], 256).expect("short chan ID slice too big?"),
1551 proportional_millionths: 1,
1553 cltv_expiry_delta: 145,
1554 htlc_minimum_msat: None,
1555 htlc_maximum_msat: None,
1558 src_node_id: public_key.clone(),
1559 short_channel_id: de::parse_int_be(&[42; 8], 256).expect("short chan ID slice too big?"),
1562 proportional_millionths: 2,
1564 cltv_expiry_delta: 146,
1565 htlc_minimum_msat: None,
1566 htlc_maximum_msat: None,
1572 src_node_id: public_key.clone(),
1573 short_channel_id: 0,
1576 proportional_millionths: 3,
1578 cltv_expiry_delta: 147,
1579 htlc_minimum_msat: None,
1580 htlc_maximum_msat: None,
1583 src_node_id: public_key.clone(),
1584 short_channel_id: de::parse_int_be(&[1; 8], 256).expect("short chan ID slice too big?"),
1587 proportional_millionths: 4,
1589 cltv_expiry_delta: 148,
1590 htlc_minimum_msat: None,
1591 htlc_maximum_msat: None,
1595 let builder = InvoiceBuilder::new(Currency::BitcoinTestnet)
1596 .amount_pico_btc(123)
1597 .timestamp(UNIX_EPOCH + Duration::from_secs(1234567))
1598 .payee_pub_key(public_key.clone())
1599 .expiry_time(Duration::from_secs(54321))
1600 .min_final_cltv_expiry(144)
1601 .min_final_cltv_expiry(143)
1602 .fallback(Fallback::PubKeyHash([0;20]))
1603 .route(route_1.clone())
1604 .route(route_2.clone())
1605 .description_hash(sha256::Hash::from_slice(&[3;32][..]).unwrap())
1606 .payment_hash(sha256::Hash::from_slice(&[21;32][..]).unwrap());
1608 let invoice = builder.clone().build_signed(|hash| {
1609 secp_ctx.sign_recoverable(hash, &private_key)
1612 assert!(invoice.check_signature().is_ok());
1613 assert_eq!(invoice.tagged_fields().count(), 9);
1615 assert_eq!(invoice.amount_pico_btc(), Some(123));
1616 assert_eq!(invoice.currency(), Currency::BitcoinTestnet);
1618 invoice.timestamp().duration_since(UNIX_EPOCH).unwrap().as_secs(),
1621 assert_eq!(invoice.payee_pub_key(), Some(&public_key));
1622 assert_eq!(invoice.expiry_time(), Duration::from_secs(54321));
1623 assert_eq!(invoice.min_final_cltv_expiry(), Some(144));
1624 assert_eq!(invoice.fallbacks(), vec![&Fallback::PubKeyHash([0;20])]);
1625 assert_eq!(invoice.routes(), vec![&RouteHint(route_1), &RouteHint(route_2)]);
1627 invoice.description(),
1628 InvoiceDescription::Hash(&Sha256(sha256::Hash::from_slice(&[3;32][..]).unwrap()))
1630 assert_eq!(invoice.payment_hash(), &sha256::Hash::from_slice(&[21;32][..]).unwrap());
1632 let raw_invoice = builder.build_raw().unwrap();
1633 assert_eq!(raw_invoice, *invoice.into_signed_raw().raw_invoice())