_ Git - rust-lightning/blob - lightning-invoice/src/lib.rs

   1 // Prefix these with `rustdoc::` when we update our MSRV to be >= 1.52 to remove warnings.
   2 #![deny(broken_intra_doc_links)]
   3 #![deny(private_intra_doc_links)]
   4
   5 #![deny(missing_docs)]
   6 #![deny(non_upper_case_globals)]
   7 #![deny(non_camel_case_types)]
   8 #![deny(non_snake_case)]
   9 #![deny(unused_mut)]
  10
  11 #![cfg_attr(docsrs, feature(doc_auto_cfg))]
  12
  13 #![cfg_attr(feature = "strict", deny(warnings))]
  14 #![cfg_attr(all(not(feature = "std"), not(test)), no_std)]
  15
  16 //! This crate provides data structures to represent
  17 //! [lightning BOLT11](https://github.com/lightning/bolts/blob/master/11-payment-encoding.md)
  18 //! invoices and functions to create, encode and decode these. If you just want to use the standard
  19 //! en-/decoding functionality this should get you started:
  20 //!
  21 //!   * For parsing use `str::parse::<Invoice>(&self)` (see the docs of `impl FromStr for Invoice`)
  22 //!   * For constructing invoices use the `InvoiceBuilder`
  23 //!   * For serializing invoices use the `Display`/`ToString` traits
  24
  25 #[cfg(not(any(feature = "std", feature = "no-std")))]
  26 compile_error!("at least one of the `std` or `no-std` features must be enabled");
  27
  28 pub mod payment;
  29 pub mod utils;
  30
  31 pub(crate) mod time_utils;
  32
  33 extern crate bech32;
  34 extern crate bitcoin_hashes;
  35 #[macro_use] extern crate lightning;
  36 extern crate num_traits;
  37 extern crate secp256k1;
  38 extern crate alloc;
  39 #[cfg(any(test, feature = "std"))]
  40 extern crate core;
  41 #[cfg(feature = "serde")]
  42 extern crate serde;
  43
  44 #[cfg(feature = "std")]
  45 use std::time::SystemTime;
  46
  47 use bech32::u5;
  48 use bitcoin_hashes::Hash;
  49 use bitcoin_hashes::sha256;
  50 use lightning::ln::PaymentSecret;
  51 use lightning::ln::features::InvoiceFeatures;
  52 #[cfg(any(doc, test))]
  53 use lightning::routing::gossip::RoutingFees;
  54 use lightning::routing::router::RouteHint;
  55 use lightning::util::invoice::construct_invoice_preimage;
  56
  57 use secp256k1::PublicKey;
  58 use secp256k1::{Message, Secp256k1};
  59 use secp256k1::ecdsa::RecoverableSignature;
  60
  61 use core::fmt::{Display, Formatter, self};
  62 use core::iter::FilterMap;
  63 use core::num::ParseIntError;
  64 use core::ops::Deref;
  65 use core::slice::Iter;
  66 use core::time::Duration;
  67 use core::str;
  68
  69 #[cfg(feature = "serde")]
  70 use serde::{Deserialize, Deserializer,Serialize, Serializer, de::Error};
  71
  72 mod de;
  73 mod ser;
  74 mod tb;
  75
  76 mod prelude {
  77         #[cfg(feature = "hashbrown")]
  78         extern crate hashbrown;
  79
  80         pub use alloc::{vec, vec::Vec, string::String, collections::VecDeque, boxed::Box};
  81         #[cfg(not(feature = "hashbrown"))]
  82         pub use std::collections::{HashMap, HashSet, hash_map};
  83         #[cfg(feature = "hashbrown")]
  84         pub use self::hashbrown::{HashMap, HashSet, hash_map};
  85
  86         pub use alloc::string::ToString;
  87 }
  88
  89 use crate::prelude::*;
  90
  91 /// Sync compat for std/no_std
  92 #[cfg(feature = "std")]
  93 mod sync {
  94         pub use ::std::sync::{Mutex, MutexGuard};
  95 }
  96
  97 /// Sync compat for std/no_std
  98 #[cfg(not(feature = "std"))]
  99 mod sync;
 100
 101 /// Errors that indicate what is wrong with the invoice. They have some granularity for debug
 102 /// reasons, but should generally result in an "invalid BOLT11 invoice" message for the user.
 103 #[allow(missing_docs)]
 104 #[derive(PartialEq, Eq, Debug, Clone)]
 105 pub enum ParseError {
 106         Bech32Error(bech32::Error),
 107         ParseAmountError(ParseIntError),
 108         MalformedSignature(secp256k1::Error),
 109         BadPrefix,
 110         UnknownCurrency,
 111         UnknownSiPrefix,
 112         MalformedHRP,
 113         TooShortDataPart,
 114         UnexpectedEndOfTaggedFields,
 115         DescriptionDecodeError(str::Utf8Error),
 116         PaddingError,
 117         IntegerOverflowError,
 118         InvalidSegWitProgramLength,
 119         InvalidPubKeyHashLength,
 120         InvalidScriptHashLength,
 121         InvalidRecoveryId,
 122         InvalidSliceLength(String),
 123
 124         /// Not an error, but used internally to signal that a part of the invoice should be ignored
 125         /// according to BOLT11
 126         Skip,
 127 }
 128
 129 /// Indicates that something went wrong while parsing or validating the invoice. Parsing errors
 130 /// should be mostly seen as opaque and are only there for debugging reasons. Semantic errors
 131 /// like wrong signatures, missing fields etc. could mean that someone tampered with the invoice.
 132 #[derive(PartialEq, Eq, Debug, Clone)]
 133 pub enum ParseOrSemanticError {
 134         /// The invoice couldn't be decoded
 135         ParseError(ParseError),
 136
 137         /// The invoice could be decoded but violates the BOLT11 standard
 138         SemanticError(crate::SemanticError),
 139 }
 140
 141 /// The number of bits used to represent timestamps as defined in BOLT 11.
 142 const TIMESTAMP_BITS: usize = 35;
 143
 144 /// The maximum timestamp as [`Duration::as_secs`] since the Unix epoch allowed by [`BOLT 11`].
 145 ///
 146 /// [BOLT 11]: https://github.com/lightning/bolts/blob/master/11-payment-encoding.md
 147 pub const MAX_TIMESTAMP: u64 = (1 << TIMESTAMP_BITS) - 1;
 148
 149 /// Default expiry time as defined by [BOLT 11].
 150 ///
 151 /// [BOLT 11]: https://github.com/lightning/bolts/blob/master/11-payment-encoding.md
 152 pub const DEFAULT_EXPIRY_TIME: u64 = 3600;
 153
 154 /// Default minimum final CLTV expiry as defined by [BOLT 11].
 155 ///
 156 /// Note that this is *not* the same value as rust-lightning's minimum CLTV expiry, which is
 157 /// provided in [`MIN_FINAL_CLTV_EXPIRY`].
 158 ///
 159 /// [BOLT 11]: https://github.com/lightning/bolts/blob/master/11-payment-encoding.md
 160 /// [`MIN_FINAL_CLTV_EXPIRY`]: lightning::ln::channelmanager::MIN_FINAL_CLTV_EXPIRY
 161 pub const DEFAULT_MIN_FINAL_CLTV_EXPIRY: u64 = 18;
 162
 163 /// Builder for `Invoice`s. It's the most convenient and advised way to use this library. It ensures
 164 /// that only a semantically and syntactically correct Invoice can be built using it.
 165 ///
 166 /// ```
 167 /// extern crate secp256k1;
 168 /// extern crate lightning;
 169 /// extern crate lightning_invoice;
 170 /// extern crate bitcoin_hashes;
 171 ///
 172 /// use bitcoin_hashes::Hash;
 173 /// use bitcoin_hashes::sha256;
 174 ///
 175 /// use secp256k1::Secp256k1;
 176 /// use secp256k1::SecretKey;
 177 ///
 178 /// use lightning::ln::PaymentSecret;
 179 ///
 180 /// use lightning_invoice::{Currency, InvoiceBuilder};
 181 ///
 182 /// # #[cfg(not(feature = "std"))]
 183 /// # fn main() {}
 184 /// # #[cfg(feature = "std")]
 185 /// # fn main() {
 186 /// let private_key = SecretKey::from_slice(
 187 ///             &[
 188 ///                     0xe1, 0x26, 0xf6, 0x8f, 0x7e, 0xaf, 0xcc, 0x8b, 0x74, 0xf5, 0x4d, 0x26, 0x9f,
 189 ///                     0xe2, 0x06, 0xbe, 0x71, 0x50, 0x00, 0xf9, 0x4d, 0xac, 0x06, 0x7d, 0x1c, 0x04,
 190 ///             0xa8, 0xca, 0x3b, 0x2d, 0xb7, 0x34
 191 ///     ][..]
 192 ///     ).unwrap();
 193 ///
 194 /// let payment_hash = sha256::Hash::from_slice(&[0; 32][..]).unwrap();
 195 /// let payment_secret = PaymentSecret([42u8; 32]);
 196 ///
 197 /// let invoice = InvoiceBuilder::new(Currency::Bitcoin)
 198 ///     .description("Coins pls!".into())
 199 ///     .payment_hash(payment_hash)
 200 ///     .payment_secret(payment_secret)
 201 ///     .current_timestamp()
 202 ///     .min_final_cltv_expiry(144)
 203 ///     .build_signed(|hash| {
 204 ///             Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key)
 205 ///     })
 206 ///     .unwrap();
 207 ///
 208 /// assert!(invoice.to_string().starts_with("lnbc1"));
 209 /// # }
 210 /// ```
 211 ///
 212 /// # Type parameters
 213 /// The two parameters `D` and `H` signal if the builder already contains the correct amount of the
 214 /// given field:
 215 ///  * `D`: exactly one `Description` or `DescriptionHash`
 216 ///  * `H`: exactly one `PaymentHash`
 217 ///  * `T`: the timestamp is set
 218 ///
 219 /// (C-not exported) as we likely need to manually select one set of boolean type parameters.
 220 #[derive(Eq, PartialEq, Debug, Clone)]
 221 pub struct InvoiceBuilder<D: tb::Bool, H: tb::Bool, T: tb::Bool, C: tb::Bool, S: tb::Bool> {
 222         currency: Currency,
 223         amount: Option<u64>,
 224         si_prefix: Option<SiPrefix>,
 225         timestamp: Option<PositiveTimestamp>,
 226         tagged_fields: Vec<TaggedField>,
 227         error: Option<CreationError>,
 228
 229         phantom_d: core::marker::PhantomData<D>,
 230         phantom_h: core::marker::PhantomData<H>,
 231         phantom_t: core::marker::PhantomData<T>,
 232         phantom_c: core::marker::PhantomData<C>,
 233         phantom_s: core::marker::PhantomData<S>,
 234 }
 235
 236 /// Represents a syntactically and semantically correct lightning BOLT11 invoice.
 237 ///
 238 /// There are three ways to construct an `Invoice`:
 239 ///  1. using `InvoiceBuilder`
 240 ///  2. using `Invoice::from_signed(SignedRawInvoice)`
 241 ///  3. using `str::parse::<Invoice>(&str)`
 242 #[derive(Eq, PartialEq, Debug, Clone, Hash)]
 243 pub struct Invoice {
 244         signed_invoice: SignedRawInvoice,
 245 }
 246
 247 /// Represents the description of an invoice which has to be either a directly included string or
 248 /// a hash of a description provided out of band.
 249 ///
 250 /// (C-not exported) As we don't have a good way to map the reference lifetimes making this
 251 /// practically impossible to use safely in languages like C.
 252 #[derive(Eq, PartialEq, Debug, Clone)]
 253 pub enum InvoiceDescription<'f> {
 254         /// Reference to the directly supplied description in the invoice
 255         Direct(&'f Description),
 256
 257         /// Reference to the description's hash included in the invoice
 258         Hash(&'f Sha256),
 259 }
 260
 261 /// Represents a signed `RawInvoice` with cached hash. The signature is not checked and may be
 262 /// invalid.
 263 ///
 264 /// # Invariants
 265 /// The hash has to be either from the deserialized invoice or from the serialized `raw_invoice`.
 266 #[derive(Eq, PartialEq, Debug, Clone, Hash)]
 267 pub struct SignedRawInvoice {
 268         /// The rawInvoice that the signature belongs to
 269         raw_invoice: RawInvoice,
 270
 271         /// Hash of the `RawInvoice` that will be used to check the signature.
 272         ///
 273         /// * if the `SignedRawInvoice` was deserialized the hash is of from the original encoded form,
 274         /// since it's not guaranteed that encoding it again will lead to the same result since integers
 275         /// could have been encoded with leading zeroes etc.
 276         /// * if the `SignedRawInvoice` was constructed manually the hash will be the calculated hash
 277         /// from the `RawInvoice`
 278         hash: [u8; 32],
 279
 280         /// signature of the payment request
 281         signature: InvoiceSignature,
 282 }
 283
 284 /// Represents an syntactically correct Invoice for a payment on the lightning network,
 285 /// but without the signature information.
 286 /// De- and encoding should not lead to information loss but may lead to different hashes.
 287 ///
 288 /// For methods without docs see the corresponding methods in `Invoice`.
 289 #[derive(Eq, PartialEq, Debug, Clone, Hash)]
 290 pub struct RawInvoice {
 291         /// human readable part
 292         pub hrp: RawHrp,
 293
 294         /// data part
 295         pub data: RawDataPart,
 296 }
 297
 298 /// Data of the `RawInvoice` that is encoded in the human readable part
 299 ///
 300 /// (C-not exported) As we don't yet support `Option<Enum>`
 301 #[derive(Eq, PartialEq, Debug, Clone, Hash)]
 302 pub struct RawHrp {
 303         /// The currency deferred from the 3rd and 4th character of the bech32 transaction
 304         pub currency: Currency,
 305
 306         /// The amount that, multiplied by the SI prefix, has to be payed
 307         pub raw_amount: Option<u64>,
 308
 309         /// SI prefix that gets multiplied with the `raw_amount`
 310         pub si_prefix: Option<SiPrefix>,
 311 }
 312
 313 /// Data of the `RawInvoice` that is encoded in the data part
 314 #[derive(Eq, PartialEq, Debug, Clone, Hash)]
 315 pub struct RawDataPart {
 316         /// generation time of the invoice
 317         pub timestamp: PositiveTimestamp,
 318
 319         /// tagged fields of the payment request
 320         pub tagged_fields: Vec<RawTaggedField>,
 321 }
 322
 323 /// A timestamp that refers to a date after 1 January 1970.
 324 ///
 325 /// # Invariants
 326 ///
 327 /// The Unix timestamp representing the stored time has to be positive and no greater than
 328 /// [`MAX_TIMESTAMP`].
 329 #[derive(Eq, PartialEq, Debug, Clone, Hash)]
 330 pub struct PositiveTimestamp(Duration);
 331
 332 /// SI prefixes for the human readable part
 333 #[derive(Eq, PartialEq, Debug, Clone, Copy, Hash)]
 334 pub enum SiPrefix {
 335         /// 10^-3
 336         Milli,
 337         /// 10^-6
 338         Micro,
 339         /// 10^-9
 340         Nano,
 341         /// 10^-12
 342         Pico,
 343 }
 344
 345 impl SiPrefix {
 346         /// Returns the multiplier to go from a BTC value to picoBTC implied by this SiPrefix.
 347         /// This is effectively 10^12 * the prefix multiplier
 348         pub fn multiplier(&self) -> u64 {
 349                 match *self {
 350                         SiPrefix::Milli => 1_000_000_000,
 351                         SiPrefix::Micro => 1_000_000,
 352                         SiPrefix::Nano => 1_000,
 353                         SiPrefix::Pico => 1,
 354                 }
 355         }
 356
 357         /// Returns all enum variants of `SiPrefix` sorted in descending order of their associated
 358         /// multiplier.
 359         ///
 360         /// (C-not exported) As we don't yet support a slice of enums, and also because this function
 361         /// isn't the most critical to expose.
 362         pub fn values_desc() -> &'static [SiPrefix] {
 363                 use crate::SiPrefix::*;
 364                 static VALUES: [SiPrefix; 4] = [Milli, Micro, Nano, Pico];
 365                 &VALUES
 366         }
 367 }
 368
 369 /// Enum representing the crypto currencies (or networks) supported by this library
 370 #[derive(Clone, Debug, Hash, Eq, PartialEq)]
 371 pub enum Currency {
 372         /// Bitcoin mainnet
 373         Bitcoin,
 374
 375         /// Bitcoin testnet
 376         BitcoinTestnet,
 377
 378         /// Bitcoin regtest
 379         Regtest,
 380
 381         /// Bitcoin simnet
 382         Simnet,
 383
 384         /// Bitcoin signet
 385         Signet,
 386 }
 387
 388 /// Tagged field which may have an unknown tag
 389 ///
 390 /// (C-not exported) as we don't currently support TaggedField
 391 #[derive(Clone, Debug, Hash, Eq, PartialEq)]
 392 pub enum RawTaggedField {
 393         /// Parsed tagged field with known tag
 394         KnownSemantics(TaggedField),
 395         /// tagged field which was not parsed due to an unknown tag or undefined field semantics
 396         UnknownSemantics(Vec<u5>),
 397 }
 398
 399 /// Tagged field with known tag
 400 ///
 401 /// For descriptions of the enum values please refer to the enclosed type's docs.
 402 ///
 403 /// (C-not exported) As we don't yet support enum variants with the same name the struct contained
 404 /// in the variant.
 405 #[allow(missing_docs)]
 406 #[derive(Clone, Debug, Hash, Eq, PartialEq)]
 407 pub enum TaggedField {
 408         PaymentHash(Sha256),
 409         Description(Description),
 410         PayeePubKey(PayeePubKey),
 411         DescriptionHash(Sha256),
 412         ExpiryTime(ExpiryTime),
 413         MinFinalCltvExpiry(MinFinalCltvExpiry),
 414         Fallback(Fallback),
 415         PrivateRoute(PrivateRoute),
 416         PaymentSecret(PaymentSecret),
 417         Features(InvoiceFeatures),
 418 }
 419
 420 /// SHA-256 hash
 421 #[derive(Clone, Debug, Hash, Eq, PartialEq)]
 422 pub struct Sha256(/// (C-not exported) as the native hash types are not currently mapped
 423         pub sha256::Hash);
 424
 425 /// Description string
 426 ///
 427 /// # Invariants
 428 /// The description can be at most 639 __bytes__ long
 429 #[derive(Clone, Debug, Hash, Eq, PartialEq)]
 430 pub struct Description(String);
 431
 432 /// Payee public key
 433 #[derive(Clone, Debug, Hash, Eq, PartialEq)]
 434 pub struct PayeePubKey(pub PublicKey);
 435
 436 /// Positive duration that defines when (relatively to the timestamp) in the future the invoice
 437 /// expires
 438 #[derive(Clone, Debug, Hash, Eq, PartialEq)]
 439 pub struct ExpiryTime(Duration);
 440
 441 /// `min_final_cltv_expiry` to use for the last HTLC in the route
 442 #[derive(Clone, Debug, Hash, Eq, PartialEq)]
 443 pub struct MinFinalCltvExpiry(pub u64);
 444
 445 // TODO: better types instead onf byte arrays
 446 /// Fallback address in case no LN payment is possible
 447 #[allow(missing_docs)]
 448 #[derive(Clone, Debug, Hash, Eq, PartialEq)]
 449 pub enum Fallback {
 450         SegWitProgram {
 451                 version: u5,
 452                 program: Vec<u8>,
 453         },
 454         PubKeyHash([u8; 20]),
 455         ScriptHash([u8; 20]),
 456 }
 457
 458 /// Recoverable signature
 459 #[derive(Clone, Debug, Hash, Eq, PartialEq)]
 460 pub struct InvoiceSignature(pub RecoverableSignature);
 461
 462 /// Private routing information
 463 ///
 464 /// # Invariants
 465 /// The encoded route has to be <1024 5bit characters long (<=639 bytes or <=12 hops)
 466 ///
 467 #[derive(Clone, Debug, Hash, Eq, PartialEq)]
 468 pub struct PrivateRoute(RouteHint);
 469
 470 /// Tag constants as specified in BOLT11
 471 #[allow(missing_docs)]
 472 pub mod constants {
 473         pub const TAG_PAYMENT_HASH: u8 = 1;
 474         pub const TAG_DESCRIPTION: u8 = 13;
 475         pub const TAG_PAYEE_PUB_KEY: u8 = 19;
 476         pub const TAG_DESCRIPTION_HASH: u8 = 23;
 477         pub const TAG_EXPIRY_TIME: u8 = 6;
 478         pub const TAG_MIN_FINAL_CLTV_EXPIRY: u8 = 24;
 479         pub const TAG_FALLBACK: u8 = 9;
 480         pub const TAG_PRIVATE_ROUTE: u8 = 3;
 481         pub const TAG_PAYMENT_SECRET: u8 = 16;
 482         pub const TAG_FEATURES: u8 = 5;
 483 }
 484
 485 impl InvoiceBuilder<tb::False, tb::False, tb::False, tb::False, tb::False> {
 486         /// Construct new, empty `InvoiceBuilder`. All necessary fields have to be filled first before
 487         /// `InvoiceBuilder::build(self)` becomes available.
 488         pub fn new(currrency: Currency) -> Self {
 489                 InvoiceBuilder {
 490                         currency: currrency,
 491                         amount: None,
 492                         si_prefix: None,
 493                         timestamp: None,
 494                         tagged_fields: Vec::new(),
 495                         error: None,
 496
 497                         phantom_d: core::marker::PhantomData,
 498                         phantom_h: core::marker::PhantomData,
 499                         phantom_t: core::marker::PhantomData,
 500                         phantom_c: core::marker::PhantomData,
 501                         phantom_s: core::marker::PhantomData,
 502                 }
 503         }
 504 }
 505
 506 impl<D: tb::Bool, H: tb::Bool, T: tb::Bool, C: tb::Bool, S: tb::Bool> InvoiceBuilder<D, H, T, C, S> {
 507         /// Helper function to set the completeness flags.
 508         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> {
 509                 InvoiceBuilder::<DN, HN, TN, CN, SN> {
 510                         currency: self.currency,
 511                         amount: self.amount,
 512                         si_prefix: self.si_prefix,
 513                         timestamp: self.timestamp,
 514                         tagged_fields: self.tagged_fields,
 515                         error: self.error,
 516
 517                         phantom_d: core::marker::PhantomData,
 518                         phantom_h: core::marker::PhantomData,
 519                         phantom_t: core::marker::PhantomData,
 520                         phantom_c: core::marker::PhantomData,
 521                         phantom_s: core::marker::PhantomData,
 522                 }
 523         }
 524
 525         /// Sets the amount in millisatoshis. The optimal SI prefix is chosen automatically.
 526         pub fn amount_milli_satoshis(mut self, amount_msat: u64) -> Self {
 527                 let amount = amount_msat * 10; // Invoices are denominated in "pico BTC"
 528                 let biggest_possible_si_prefix = SiPrefix::values_desc()
 529                         .iter()
 530                         .find(|prefix| amount % prefix.multiplier() == 0)
 531                         .expect("Pico should always match");
 532                 self.amount = Some(amount / biggest_possible_si_prefix.multiplier());
 533                 self.si_prefix = Some(*biggest_possible_si_prefix);
 534                 self
 535         }
 536
 537         /// Sets the payee's public key.
 538         pub fn payee_pub_key(mut self, pub_key: PublicKey) -> Self {
 539                 self.tagged_fields.push(TaggedField::PayeePubKey(PayeePubKey(pub_key)));
 540                 self
 541         }
 542
 543         /// Sets the expiry time, dropping the subsecond part (which is not representable in BOLT 11
 544         /// invoices).
 545         pub fn expiry_time(mut self, expiry_time: Duration) -> Self {
 546                 self.tagged_fields.push(TaggedField::ExpiryTime(ExpiryTime::from_duration(expiry_time)));
 547                 self
 548         }
 549
 550         /// Adds a fallback address.
 551         pub fn fallback(mut self, fallback: Fallback) -> Self {
 552                 self.tagged_fields.push(TaggedField::Fallback(fallback));
 553                 self
 554         }
 555
 556         /// Adds a private route.
 557         pub fn private_route(mut self, hint: RouteHint) -> Self {
 558                 match PrivateRoute::new(hint) {
 559                         Ok(r) => self.tagged_fields.push(TaggedField::PrivateRoute(r)),
 560                         Err(e) => self.error = Some(e),
 561                 }
 562                 self
 563         }
 564 }
 565
 566 impl<D: tb::Bool, H: tb::Bool, C: tb::Bool, S: tb::Bool> InvoiceBuilder<D, H, tb::True, C, S> {
 567         /// Builds a `RawInvoice` if no `CreationError` occurred while construction any of the fields.
 568         pub fn build_raw(self) -> Result<RawInvoice, CreationError> {
 569
 570                 // If an error occurred at any time before, return it now
 571                 if let Some(e) = self.error {
 572                         return Err(e);
 573                 }
 574
 575                 let hrp = RawHrp {
 576                         currency: self.currency,
 577                         raw_amount: self.amount,
 578                         si_prefix: self.si_prefix,
 579                 };
 580
 581                 let timestamp = self.timestamp.expect("ensured to be Some(t) by type T");
 582
 583                 let tagged_fields = self.tagged_fields.into_iter().map(|tf| {
 584                         RawTaggedField::KnownSemantics(tf)
 585                 }).collect::<Vec<_>>();
 586
 587                 let data = RawDataPart {
 588                         timestamp: timestamp,
 589                         tagged_fields: tagged_fields,
 590                 };
 591
 592                 Ok(RawInvoice {
 593                         hrp: hrp,
 594                         data: data,
 595                 })
 596         }
 597 }
 598
 599 impl<H: tb::Bool, T: tb::Bool, C: tb::Bool, S: tb::Bool> InvoiceBuilder<tb::False, H, T, C, S> {
 600         /// Set the description. This function is only available if no description (hash) was set.
 601         pub fn description(mut self, description: String) -> InvoiceBuilder<tb::True, H, T, C, S> {
 602                 match Description::new(description) {
 603                         Ok(d) => self.tagged_fields.push(TaggedField::Description(d)),
 604                         Err(e) => self.error = Some(e),
 605                 }
 606                 self.set_flags()
 607         }
 608
 609         /// Set the description hash. This function is only available if no description (hash) was set.
 610         pub fn description_hash(mut self, description_hash: sha256::Hash) -> InvoiceBuilder<tb::True, H, T, C, S> {
 611                 self.tagged_fields.push(TaggedField::DescriptionHash(Sha256(description_hash)));
 612                 self.set_flags()
 613         }
 614 }
 615
 616 impl<D: tb::Bool, T: tb::Bool, C: tb::Bool, S: tb::Bool> InvoiceBuilder<D, tb::False, T, C, S> {
 617         /// Set the payment hash. This function is only available if no payment hash was set.
 618         pub fn payment_hash(mut self, hash: sha256::Hash) -> InvoiceBuilder<D, tb::True, T, C, S> {
 619                 self.tagged_fields.push(TaggedField::PaymentHash(Sha256(hash)));
 620                 self.set_flags()
 621         }
 622 }
 623
 624 impl<D: tb::Bool, H: tb::Bool, C: tb::Bool, S: tb::Bool> InvoiceBuilder<D, H, tb::False, C, S> {
 625         /// Sets the timestamp to a specific [`SystemTime`].
 626         #[cfg(feature = "std")]
 627         pub fn timestamp(mut self, time: SystemTime) -> InvoiceBuilder<D, H, tb::True, C, S> {
 628                 match PositiveTimestamp::from_system_time(time) {
 629                         Ok(t) => self.timestamp = Some(t),
 630                         Err(e) => self.error = Some(e),
 631                 }
 632
 633                 self.set_flags()
 634         }
 635
 636         /// Sets the timestamp to a duration since the Unix epoch, dropping the subsecond part (which
 637         /// is not representable in BOLT 11 invoices).
 638         pub fn duration_since_epoch(mut self, time: Duration) -> InvoiceBuilder<D, H, tb::True, C, S> {
 639                 match PositiveTimestamp::from_duration_since_epoch(time) {
 640                         Ok(t) => self.timestamp = Some(t),
 641                         Err(e) => self.error = Some(e),
 642                 }
 643
 644                 self.set_flags()
 645         }
 646
 647         /// Sets the timestamp to the current system time.
 648         #[cfg(feature = "std")]
 649         pub fn current_timestamp(mut self) -> InvoiceBuilder<D, H, tb::True, C, S> {
 650                 let now = PositiveTimestamp::from_system_time(SystemTime::now());
 651                 self.timestamp = Some(now.expect("for the foreseeable future this shouldn't happen"));
 652                 self.set_flags()
 653         }
 654 }
 655
 656 impl<D: tb::Bool, H: tb::Bool, T: tb::Bool, S: tb::Bool> InvoiceBuilder<D, H, T, tb::False, S> {
 657         /// Sets `min_final_cltv_expiry`.
 658         pub fn min_final_cltv_expiry(mut self, min_final_cltv_expiry: u64) -> InvoiceBuilder<D, H, T, tb::True, S> {
 659                 self.tagged_fields.push(TaggedField::MinFinalCltvExpiry(MinFinalCltvExpiry(min_final_cltv_expiry)));
 660                 self.set_flags()
 661         }
 662 }
 663
 664 impl<D: tb::Bool, H: tb::Bool, T: tb::Bool, C: tb::Bool> InvoiceBuilder<D, H, T, C, tb::False> {
 665         /// Sets the payment secret and relevant features.
 666         pub fn payment_secret(mut self, payment_secret: PaymentSecret) -> InvoiceBuilder<D, H, T, C, tb::True> {
 667                 let mut features = InvoiceFeatures::empty();
 668                 features.set_variable_length_onion_required();
 669                 features.set_payment_secret_required();
 670                 self.tagged_fields.push(TaggedField::PaymentSecret(payment_secret));
 671                 self.tagged_fields.push(TaggedField::Features(features));
 672                 self.set_flags()
 673         }
 674 }
 675
 676 impl<D: tb::Bool, H: tb::Bool, T: tb::Bool, C: tb::Bool> InvoiceBuilder<D, H, T, C, tb::True> {
 677         /// Sets the `basic_mpp` feature as optional.
 678         pub fn basic_mpp(mut self) -> Self {
 679                 for field in self.tagged_fields.iter_mut() {
 680                         if let TaggedField::Features(f) = field {
 681                                 f.set_basic_mpp_optional();
 682                         }
 683                 }
 684                 self
 685         }
 686 }
 687
 688 impl InvoiceBuilder<tb::True, tb::True, tb::True, tb::True, tb::True> {
 689         /// Builds and signs an invoice using the supplied `sign_function`. This function MAY NOT fail
 690         /// and MUST produce a recoverable signature valid for the given hash and if applicable also for
 691         /// the included payee public key.
 692         pub fn build_signed<F>(self, sign_function: F) -> Result<Invoice, CreationError>
 693                 where F: FnOnce(&Message) -> RecoverableSignature
 694         {
 695                 let invoice = self.try_build_signed::<_, ()>(|hash| {
 696                         Ok(sign_function(hash))
 697                 });
 698
 699                 match invoice {
 700                         Ok(i) => Ok(i),
 701                         Err(SignOrCreationError::CreationError(e)) => Err(e),
 702                         Err(SignOrCreationError::SignError(())) => unreachable!(),
 703                 }
 704         }
 705
 706         /// Builds and signs an invoice using the supplied `sign_function`. This function MAY fail with
 707         /// an error of type `E` and MUST produce a recoverable signature valid for the given hash and
 708         /// if applicable also for the included payee public key.
 709         pub fn try_build_signed<F, E>(self, sign_function: F) -> Result<Invoice, SignOrCreationError<E>>
 710                 where F: FnOnce(&Message) -> Result<RecoverableSignature, E>
 711         {
 712                 let raw = match self.build_raw() {
 713                         Ok(r) => r,
 714                         Err(e) => return Err(SignOrCreationError::CreationError(e)),
 715                 };
 716
 717                 let signed = match raw.sign(sign_function) {
 718                         Ok(s) => s,
 719                         Err(e) => return Err(SignOrCreationError::SignError(e)),
 720                 };
 721
 722                 let invoice = Invoice {
 723                         signed_invoice: signed,
 724                 };
 725
 726                 invoice.check_field_counts().expect("should be ensured by type signature of builder");
 727                 invoice.check_feature_bits().expect("should be ensured by type signature of builder");
 728                 invoice.check_amount().expect("should be ensured by type signature of builder");
 729
 730                 Ok(invoice)
 731         }
 732 }
 733
 734
 735 impl SignedRawInvoice {
 736         /// Disassembles the `SignedRawInvoice` into its three parts:
 737         ///  1. raw invoice
 738         ///  2. hash of the raw invoice
 739         ///  3. signature
 740         pub fn into_parts(self) -> (RawInvoice, [u8; 32], InvoiceSignature) {
 741                 (self.raw_invoice, self.hash, self.signature)
 742         }
 743
 744         /// The `RawInvoice` which was signed.
 745         pub fn raw_invoice(&self) -> &RawInvoice {
 746                 &self.raw_invoice
 747         }
 748
 749         /// The hash of the `RawInvoice` that was signed.
 750         pub fn signable_hash(&self) -> &[u8; 32] {
 751                 &self.hash
 752         }
 753
 754         /// InvoiceSignature for the invoice.
 755         pub fn signature(&self) -> &InvoiceSignature {
 756                 &self.signature
 757         }
 758
 759         /// Recovers the public key used for signing the invoice from the recoverable signature.
 760         pub fn recover_payee_pub_key(&self) -> Result<PayeePubKey, secp256k1::Error> {
 761                 let hash = Message::from_slice(&self.hash[..])
 762                         .expect("Hash is 32 bytes long, same as MESSAGE_SIZE");
 763
 764                 Ok(PayeePubKey(Secp256k1::new().recover_ecdsa(
 765                         &hash,
 766                         &self.signature
 767                 )?))
 768         }
 769
 770         /// Checks if the signature is valid for the included payee public key or if none exists if it's
 771         /// valid for the recovered signature (which should always be true?).
 772         pub fn check_signature(&self) -> bool {
 773                 let included_pub_key = self.raw_invoice.payee_pub_key();
 774
 775                 let mut recovered_pub_key = Option::None;
 776                 if recovered_pub_key.is_none() {
 777                         let recovered = match self.recover_payee_pub_key() {
 778                                 Ok(pk) => pk,
 779                                 Err(_) => return false,
 780                         };
 781                         recovered_pub_key = Some(recovered);
 782                 }
 783
 784                 let pub_key = included_pub_key.or_else(|| recovered_pub_key.as_ref())
 785                         .expect("One is always present");
 786
 787                 let hash = Message::from_slice(&self.hash[..])
 788                         .expect("Hash is 32 bytes long, same as MESSAGE_SIZE");
 789
 790                 let secp_context = Secp256k1::new();
 791                 let verification_result = secp_context.verify_ecdsa(
 792                         &hash,
 793                         &self.signature.to_standard(),
 794                         pub_key
 795                 );
 796
 797                 match verification_result {
 798                         Ok(()) => true,
 799                         Err(_) => false,
 800                 }
 801         }
 802 }
 803
 804 /// Finds the first element of an enum stream of a given variant and extracts one member of the
 805 /// variant. If no element was found `None` gets returned.
 806 ///
 807 /// The following example would extract the first B.
 808 ///
 809 /// enum Enum {
 810 ///     A(u8),
 811 ///     B(u16)
 812 /// }
 813 ///
 814 /// let elements = vec![Enum::A(1), Enum::A(2), Enum::B(3), Enum::A(4)];
 815 ///
 816 /// assert_eq!(find_extract!(elements.iter(), Enum::B(x), x), Some(3u16));
 817 macro_rules! find_extract {
 818         ($iter:expr, $enm:pat, $enm_var:ident) => {
 819                 find_all_extract!($iter, $enm, $enm_var).next()
 820         };
 821 }
 822
 823 /// Finds the all elements of an enum stream of a given variant and extracts one member of the
 824 /// variant through an iterator.
 825 ///
 826 /// The following example would extract all A.
 827 ///
 828 /// enum Enum {
 829 ///     A(u8),
 830 ///     B(u16)
 831 /// }
 832 ///
 833 /// let elements = vec![Enum::A(1), Enum::A(2), Enum::B(3), Enum::A(4)];
 834 ///
 835 /// assert_eq!(
 836 ///     find_all_extract!(elements.iter(), Enum::A(x), x).collect::<Vec<u8>>(),
 837 ///     vec![1u8, 2u8, 4u8]
 838 /// );
 839 macro_rules! find_all_extract {
 840         ($iter:expr, $enm:pat, $enm_var:ident) => {
 841                 $iter.filter_map(|tf| match *tf {
 842                         $enm => Some($enm_var),
 843                         _ => None,
 844                 })
 845         };
 846 }
 847
 848 #[allow(missing_docs)]
 849 impl RawInvoice {
 850         /// Hash the HRP as bytes and signatureless data part.
 851         fn hash_from_parts(hrp_bytes: &[u8], data_without_signature: &[u5]) -> [u8; 32] {
 852                 let preimage = construct_invoice_preimage(hrp_bytes, data_without_signature);
 853                 let mut hash: [u8; 32] = Default::default();
 854                 hash.copy_from_slice(&sha256::Hash::hash(&preimage)[..]);
 855                 hash
 856         }
 857
 858         /// Calculate the hash of the encoded `RawInvoice` which should be signed.
 859         pub fn signable_hash(&self) -> [u8; 32] {
 860                 use bech32::ToBase32;
 861
 862                 RawInvoice::hash_from_parts(
 863                         self.hrp.to_string().as_bytes(),
 864                         &self.data.to_base32()
 865                 )
 866         }
 867
 868         /// Signs the invoice using the supplied `sign_function`. This function MAY fail with an error
 869         /// of type `E`. Since the signature of a `SignedRawInvoice` is not required to be valid there
 870         /// are no constraints regarding the validity of the produced signature.
 871         ///
 872         /// (C-not exported) As we don't currently support passing function pointers into methods
 873         /// explicitly.
 874         pub fn sign<F, E>(self, sign_method: F) -> Result<SignedRawInvoice, E>
 875                 where F: FnOnce(&Message) -> Result<RecoverableSignature, E>
 876         {
 877                 let raw_hash = self.signable_hash();
 878                 let hash = Message::from_slice(&raw_hash[..])
 879                         .expect("Hash is 32 bytes long, same as MESSAGE_SIZE");
 880                 let signature = sign_method(&hash)?;
 881
 882                 Ok(SignedRawInvoice {
 883                         raw_invoice: self,
 884                         hash: raw_hash,
 885                         signature: InvoiceSignature(signature),
 886                 })
 887         }
 888
 889         /// Returns an iterator over all tagged fields with known semantics.
 890         ///
 891         /// (C-not exported) As there is not yet a manual mapping for a FilterMap
 892         pub fn known_tagged_fields(&self)
 893                 -> FilterMap<Iter<RawTaggedField>, fn(&RawTaggedField) -> Option<&TaggedField>>
 894         {
 895                 // For 1.14.0 compatibility: closures' types can't be written an fn()->() in the
 896                 // function's type signature.
 897                 // TODO: refactor once impl Trait is available
 898                 fn match_raw(raw: &RawTaggedField) -> Option<&TaggedField> {
 899                         match *raw {
 900                                 RawTaggedField::KnownSemantics(ref tf) => Some(tf),
 901                                 _ => None,
 902                         }
 903                 }
 904
 905                 self.data.tagged_fields.iter().filter_map(match_raw )
 906         }
 907
 908         pub fn payment_hash(&self) -> Option<&Sha256> {
 909                 find_extract!(self.known_tagged_fields(), TaggedField::PaymentHash(ref x), x)
 910         }
 911
 912         pub fn description(&self) -> Option<&Description> {
 913                 find_extract!(self.known_tagged_fields(), TaggedField::Description(ref x), x)
 914         }
 915
 916         pub fn payee_pub_key(&self) -> Option<&PayeePubKey> {
 917                 find_extract!(self.known_tagged_fields(), TaggedField::PayeePubKey(ref x), x)
 918         }
 919
 920         pub fn description_hash(&self) -> Option<&Sha256> {
 921                 find_extract!(self.known_tagged_fields(), TaggedField::DescriptionHash(ref x), x)
 922         }
 923
 924         pub fn expiry_time(&self) -> Option<&ExpiryTime> {
 925                 find_extract!(self.known_tagged_fields(), TaggedField::ExpiryTime(ref x), x)
 926         }
 927
 928         pub fn min_final_cltv_expiry(&self) -> Option<&MinFinalCltvExpiry> {
 929                 find_extract!(self.known_tagged_fields(), TaggedField::MinFinalCltvExpiry(ref x), x)
 930         }
 931
 932         pub fn payment_secret(&self) -> Option<&PaymentSecret> {
 933                 find_extract!(self.known_tagged_fields(), TaggedField::PaymentSecret(ref x), x)
 934         }
 935
 936         pub fn features(&self) -> Option<&InvoiceFeatures> {
 937                 find_extract!(self.known_tagged_fields(), TaggedField::Features(ref x), x)
 938         }
 939
 940         /// (C-not exported) as we don't support Vec<&NonOpaqueType>
 941         pub fn fallbacks(&self) -> Vec<&Fallback> {
 942                 find_all_extract!(self.known_tagged_fields(), TaggedField::Fallback(ref x), x).collect()
 943         }
 944
 945         pub fn private_routes(&self) -> Vec<&PrivateRoute> {
 946                 find_all_extract!(self.known_tagged_fields(), TaggedField::PrivateRoute(ref x), x).collect()
 947         }
 948
 949         pub fn amount_pico_btc(&self) -> Option<u64> {
 950                 self.hrp.raw_amount.map(|v| {
 951                         v * self.hrp.si_prefix.as_ref().map_or(1_000_000_000_000, |si| { si.multiplier() })
 952                 })
 953         }
 954
 955         pub fn currency(&self) -> Currency {
 956                 self.hrp.currency.clone()
 957         }
 958 }
 959
 960 impl PositiveTimestamp {
 961         /// Creates a `PositiveTimestamp` from a Unix timestamp in the range `0..=MAX_TIMESTAMP`.
 962         ///
 963         /// Otherwise, returns a [`CreationError::TimestampOutOfBounds`].
 964         pub fn from_unix_timestamp(unix_seconds: u64) -> Result<Self, CreationError> {
 965                 if unix_seconds <= MAX_TIMESTAMP {
 966                         Ok(Self(Duration::from_secs(unix_seconds)))
 967                 } else {
 968                         Err(CreationError::TimestampOutOfBounds)
 969                 }
 970         }
 971
 972         /// Creates a `PositiveTimestamp` from a [`SystemTime`] with a corresponding Unix timestamp in
 973         /// the range `0..=MAX_TIMESTAMP`.
 974         ///
 975         /// Note that the subsecond part is dropped as it is not representable in BOLT 11 invoices.
 976         ///
 977         /// Otherwise, returns a [`CreationError::TimestampOutOfBounds`].
 978         #[cfg(feature = "std")]
 979         pub fn from_system_time(time: SystemTime) -> Result<Self, CreationError> {
 980                 time.duration_since(SystemTime::UNIX_EPOCH)
 981                         .map(Self::from_duration_since_epoch)
 982                         .unwrap_or(Err(CreationError::TimestampOutOfBounds))
 983         }
 984
 985         /// Creates a `PositiveTimestamp` from a [`Duration`] since the Unix epoch in the range
 986         /// `0..=MAX_TIMESTAMP`.
 987         ///
 988         /// Note that the subsecond part is dropped as it is not representable in BOLT 11 invoices.
 989         ///
 990         /// Otherwise, returns a [`CreationError::TimestampOutOfBounds`].
 991         pub fn from_duration_since_epoch(duration: Duration) -> Result<Self, CreationError> {
 992                 Self::from_unix_timestamp(duration.as_secs())
 993         }
 994
 995         /// Returns the Unix timestamp representing the stored time
 996         pub fn as_unix_timestamp(&self) -> u64 {
 997                 self.0.as_secs()
 998         }
 999
1000         /// Returns the duration of the stored time since the Unix epoch
1001         pub fn as_duration_since_epoch(&self) -> Duration {
1002                 self.0
1003         }
1004
1005         /// Returns the [`SystemTime`] representing the stored time
1006         #[cfg(feature = "std")]
1007         pub fn as_time(&self) -> SystemTime {
1008                 SystemTime::UNIX_EPOCH + self.0
1009         }
1010 }
1011
1012 #[cfg(feature = "std")]
1013 impl Into<SystemTime> for PositiveTimestamp {
1014         fn into(self) -> SystemTime {
1015                 SystemTime::UNIX_EPOCH + self.0
1016         }
1017 }
1018
1019 impl Invoice {
1020         /// Transform the `Invoice` into it's unchecked version
1021         pub fn into_signed_raw(self) -> SignedRawInvoice {
1022                 self.signed_invoice
1023         }
1024
1025         /// Check that all mandatory fields are present
1026         fn check_field_counts(&self) -> Result<(), SemanticError> {
1027                 // "A writer MUST include exactly one p field […]."
1028                 let payment_hash_cnt = self.tagged_fields().filter(|&tf| match *tf {
1029                         TaggedField::PaymentHash(_) => true,
1030                         _ => false,
1031                 }).count();
1032                 if payment_hash_cnt < 1 {
1033                         return Err(SemanticError::NoPaymentHash);
1034                 } else if payment_hash_cnt > 1 {
1035                         return Err(SemanticError::MultiplePaymentHashes);
1036                 }
1037
1038                 // "A writer MUST include either exactly one d or exactly one h field."
1039                 let description_cnt = self.tagged_fields().filter(|&tf| match *tf {
1040                         TaggedField::Description(_) | TaggedField::DescriptionHash(_) => true,
1041                         _ => false,
1042                 }).count();
1043                 if  description_cnt < 1 {
1044                         return Err(SemanticError::NoDescription);
1045                 } else if description_cnt > 1 {
1046                         return  Err(SemanticError::MultipleDescriptions);
1047                 }
1048
1049                 self.check_payment_secret()?;
1050
1051                 Ok(())
1052         }
1053
1054         /// Checks that there is exactly one payment secret field
1055         fn check_payment_secret(&self) -> Result<(), SemanticError> {
1056                 // "A writer MUST include exactly one `s` field."
1057                 let payment_secret_count = self.tagged_fields().filter(|&tf| match *tf {
1058                         TaggedField::PaymentSecret(_) => true,
1059                         _ => false,
1060                 }).count();
1061                 if payment_secret_count < 1 {
1062                         return Err(SemanticError::NoPaymentSecret);
1063                 } else if payment_secret_count > 1 {
1064                         return Err(SemanticError::MultiplePaymentSecrets);
1065                 }
1066
1067                 Ok(())
1068         }
1069
1070         /// Check that amount is a whole number of millisatoshis
1071         fn check_amount(&self) -> Result<(), SemanticError> {
1072                 if let Some(amount_pico_btc) = self.amount_pico_btc() {
1073                         if amount_pico_btc % 10 != 0 {
1074                                 return Err(SemanticError::ImpreciseAmount);
1075                         }
1076                 }
1077                 Ok(())
1078         }
1079
1080         /// Check that feature bits are set as required
1081         fn check_feature_bits(&self) -> Result<(), SemanticError> {
1082                 self.check_payment_secret()?;
1083
1084                 // "A writer MUST set an s field if and only if the payment_secret feature is set."
1085                 // (this requirement has been since removed, and we now require the payment secret
1086                 // feature bit always).
1087                 let features = self.tagged_fields().find(|&tf| match *tf {
1088                         TaggedField::Features(_) => true,
1089                         _ => false,
1090                 });
1091                 match features {
1092                         None => Err(SemanticError::InvalidFeatures),
1093                         Some(TaggedField::Features(features)) => {
1094                                 if features.requires_unknown_bits() {
1095                                         Err(SemanticError::InvalidFeatures)
1096                                 } else if !features.supports_payment_secret() {
1097                                         Err(SemanticError::InvalidFeatures)
1098                                 } else {
1099                                         Ok(())
1100                                 }
1101                         },
1102                         Some(_) => unreachable!(),
1103                 }
1104         }
1105
1106         /// Check that the invoice is signed correctly and that key recovery works
1107         pub fn check_signature(&self) -> Result<(), SemanticError> {
1108                 match self.signed_invoice.recover_payee_pub_key() {
1109                         Err(secp256k1::Error::InvalidRecoveryId) =>
1110                                 return Err(SemanticError::InvalidRecoveryId),
1111                         Err(secp256k1::Error::InvalidSignature) =>
1112                                 return Err(SemanticError::InvalidSignature),
1113                         Err(e) => panic!("no other error may occur, got {:?}", e),
1114                         Ok(_) => {},
1115                 }
1116
1117                 if !self.signed_invoice.check_signature() {
1118                         return Err(SemanticError::InvalidSignature);
1119                 }
1120
1121                 Ok(())
1122         }
1123
1124         /// Constructs an `Invoice` from a `SignedRawInvoice` by checking all its invariants.
1125         /// ```
1126         /// use lightning_invoice::*;
1127         ///
1128         /// let invoice = "lnbc100p1psj9jhxdqud3jxktt5w46x7unfv9kz6mn0v3jsnp4q0d3p2sfluzdx45tqcs\
1129         /// h2pu5qc7lgq0xs578ngs6s0s68ua4h7cvspp5q6rmq35js88zp5dvwrv9m459tnk2zunwj5jalqtyxqulh0l\
1130         /// 5gflssp5nf55ny5gcrfl30xuhzj3nphgj27rstekmr9fw3ny5989s300gyus9qyysgqcqpcrzjqw2sxwe993\
1131         /// h5pcm4dxzpvttgza8zhkqxpgffcrf5v25nwpr3cmfg7z54kuqq8rgqqqqqqqq2qqqqq9qq9qrzjqd0ylaqcl\
1132         /// j9424x9m8h2vcukcgnm6s56xfgu3j78zyqzhgs4hlpzvznlugqq9vsqqqqqqqlgqqqqqeqq9qrzjqwldmj9d\
1133         /// ha74df76zhx6l9we0vjdquygcdt3kssupehe64g6yyp5yz5rhuqqwccqqyqqqqlgqqqqjcqq9qrzjqf9e58a\
1134         /// guqr0rcun0ajlvmzq3ek63cw2w282gv3z5uupmuwvgjtq2z55qsqqg6qqqyqqqrtnqqqzq3cqygrzjqvphms\
1135         /// ywntrrhqjcraumvc4y6r8v4z5v593trte429v4hredj7ms5z52usqq9ngqqqqqqqlgqqqqqqgq9qrzjq2v0v\
1136         /// p62g49p7569ev48cmulecsxe59lvaw3wlxm7r982zxa9zzj7z5l0cqqxusqqyqqqqlgqqqqqzsqygarl9fh3\
1137         /// 8s0gyuxjjgux34w75dnc6xp2l35j7es3jd4ugt3lu0xzre26yg5m7ke54n2d5sym4xcmxtl8238xxvw5h5h5\
1138         /// j5r6drg6k6zcqj0fcwg";
1139         ///
1140         /// let signed = invoice.parse::<SignedRawInvoice>().unwrap();
1141         ///
1142         /// assert!(Invoice::from_signed(signed).is_ok());
1143         /// ```
1144         pub fn from_signed(signed_invoice: SignedRawInvoice) -> Result<Self, SemanticError> {
1145                 let invoice = Invoice {
1146                         signed_invoice: signed_invoice,
1147                 };
1148                 invoice.check_field_counts()?;
1149                 invoice.check_feature_bits()?;
1150                 invoice.check_signature()?;
1151                 invoice.check_amount()?;
1152
1153                 Ok(invoice)
1154         }
1155
1156         /// Returns the `Invoice`'s timestamp (should equal its creation time)
1157         #[cfg(feature = "std")]
1158         pub fn timestamp(&self) -> SystemTime {
1159                 self.signed_invoice.raw_invoice().data.timestamp.as_time()
1160         }
1161
1162         /// Returns the `Invoice`'s timestamp as a duration since the Unix epoch
1163         pub fn duration_since_epoch(&self) -> Duration {
1164                 self.signed_invoice.raw_invoice().data.timestamp.0
1165         }
1166
1167         /// Returns an iterator over all tagged fields of this Invoice.
1168         ///
1169         /// (C-not exported) As there is not yet a manual mapping for a FilterMap
1170         pub fn tagged_fields(&self)
1171                 -> FilterMap<Iter<RawTaggedField>, fn(&RawTaggedField) -> Option<&TaggedField>> {
1172                 self.signed_invoice.raw_invoice().known_tagged_fields()
1173         }
1174
1175         /// Returns the hash to which we will receive the preimage on completion of the payment
1176         pub fn payment_hash(&self) -> &sha256::Hash {
1177                 &self.signed_invoice.payment_hash().expect("checked by constructor").0
1178         }
1179
1180         /// Return the description or a hash of it for longer ones
1181         ///
1182         /// (C-not exported) because we don't yet export InvoiceDescription
1183         pub fn description(&self) -> InvoiceDescription {
1184                 if let Some(ref direct) = self.signed_invoice.description() {
1185                         return InvoiceDescription::Direct(direct);
1186                 } else if let Some(ref hash) = self.signed_invoice.description_hash() {
1187                         return InvoiceDescription::Hash(hash);
1188                 }
1189                 unreachable!("ensured by constructor");
1190         }
1191
1192         /// Get the payee's public key if one was included in the invoice
1193         pub fn payee_pub_key(&self) -> Option<&PublicKey> {
1194                 self.signed_invoice.payee_pub_key().map(|x| &x.0)
1195         }
1196
1197         /// Get the payment secret if one was included in the invoice
1198         pub fn payment_secret(&self) -> &PaymentSecret {
1199                 self.signed_invoice.payment_secret().expect("was checked by constructor")
1200         }
1201
1202         /// Get the invoice features if they were included in the invoice
1203         pub fn features(&self) -> Option<&InvoiceFeatures> {
1204                 self.signed_invoice.features()
1205         }
1206
1207         /// Recover the payee's public key (only to be used if none was included in the invoice)
1208         pub fn recover_payee_pub_key(&self) -> PublicKey {
1209                 self.signed_invoice.recover_payee_pub_key().expect("was checked by constructor").0
1210         }
1211
1212         /// Returns the invoice's expiry time, if present, otherwise [`DEFAULT_EXPIRY_TIME`].
1213         pub fn expiry_time(&self) -> Duration {
1214                 self.signed_invoice.expiry_time()
1215                         .map(|x| x.0)
1216                         .unwrap_or(Duration::from_secs(DEFAULT_EXPIRY_TIME))
1217         }
1218
1219         /// Returns whether the invoice has expired.
1220         #[cfg(feature = "std")]
1221         pub fn is_expired(&self) -> bool {
1222                 Self::is_expired_from_epoch(&self.timestamp(), self.expiry_time())
1223         }
1224
1225         /// Returns whether the expiry time from the given epoch has passed.
1226         #[cfg(feature = "std")]
1227         pub(crate) fn is_expired_from_epoch(epoch: &SystemTime, expiry_time: Duration) -> bool {
1228                 match epoch.elapsed() {
1229                         Ok(elapsed) => elapsed > expiry_time,
1230                         Err(_) => false,
1231                 }
1232         }
1233
1234         /// Returns whether the expiry time would pass at the given point in time.
1235         /// `at_time` is the timestamp as a duration since the Unix epoch.
1236         pub fn would_expire(&self, at_time: Duration) -> bool {
1237                 self.duration_since_epoch()
1238                         .checked_add(self.expiry_time())
1239                         .unwrap_or_else(|| Duration::new(u64::max_value(), 1_000_000_000 - 1)) < at_time
1240         }
1241
1242         /// Returns the invoice's `min_final_cltv_expiry` time, if present, otherwise
1243         /// [`DEFAULT_MIN_FINAL_CLTV_EXPIRY`].
1244         pub fn min_final_cltv_expiry(&self) -> u64 {
1245                 self.signed_invoice.min_final_cltv_expiry()
1246                         .map(|x| x.0)
1247                         .unwrap_or(DEFAULT_MIN_FINAL_CLTV_EXPIRY)
1248         }
1249
1250         /// Returns a list of all fallback addresses
1251         ///
1252         /// (C-not exported) as we don't support Vec<&NonOpaqueType>
1253         pub fn fallbacks(&self) -> Vec<&Fallback> {
1254                 self.signed_invoice.fallbacks()
1255         }
1256
1257         /// Returns a list of all routes included in the invoice
1258         pub fn private_routes(&self) -> Vec<&PrivateRoute> {
1259                 self.signed_invoice.private_routes()
1260         }
1261
1262         /// Returns a list of all routes included in the invoice as the underlying hints
1263         pub fn route_hints(&self) -> Vec<RouteHint> {
1264                 find_all_extract!(
1265                         self.signed_invoice.known_tagged_fields(), TaggedField::PrivateRoute(ref x), x
1266                 ).map(|route| (**route).clone()).collect()
1267         }
1268
1269         /// Returns the currency for which the invoice was issued
1270         pub fn currency(&self) -> Currency {
1271                 self.signed_invoice.currency()
1272         }
1273
1274         /// Returns the amount if specified in the invoice as millisatoshis.
1275         pub fn amount_milli_satoshis(&self) -> Option<u64> {
1276                 self.signed_invoice.amount_pico_btc().map(|v| v / 10)
1277         }
1278
1279         /// Returns the amount if specified in the invoice as pico <currency>.
1280         fn amount_pico_btc(&self) -> Option<u64> {
1281                 self.signed_invoice.amount_pico_btc()
1282         }
1283 }
1284
1285 impl From<TaggedField> for RawTaggedField {
1286         fn from(tf: TaggedField) -> Self {
1287                 RawTaggedField::KnownSemantics(tf)
1288         }
1289 }
1290
1291 impl TaggedField {
1292         /// Numeric representation of the field's tag
1293         pub fn tag(&self) -> u5 {
1294                 let tag = match *self {
1295                         TaggedField::PaymentHash(_) => constants::TAG_PAYMENT_HASH,
1296                         TaggedField::Description(_) => constants::TAG_DESCRIPTION,
1297                         TaggedField::PayeePubKey(_) => constants::TAG_PAYEE_PUB_KEY,
1298                         TaggedField::DescriptionHash(_) => constants::TAG_DESCRIPTION_HASH,
1299                         TaggedField::ExpiryTime(_) => constants::TAG_EXPIRY_TIME,
1300                         TaggedField::MinFinalCltvExpiry(_) => constants::TAG_MIN_FINAL_CLTV_EXPIRY,
1301                         TaggedField::Fallback(_) => constants::TAG_FALLBACK,
1302                         TaggedField::PrivateRoute(_) => constants::TAG_PRIVATE_ROUTE,
1303                         TaggedField::PaymentSecret(_) => constants::TAG_PAYMENT_SECRET,
1304                         TaggedField::Features(_) => constants::TAG_FEATURES,
1305                 };
1306
1307                 u5::try_from_u8(tag).expect("all tags defined are <32")
1308         }
1309 }
1310
1311 impl Description {
1312
1313         /// Creates a new `Description` if `description` is at most 1023 __bytes__ long,
1314         /// returns `CreationError::DescriptionTooLong` otherwise
1315         ///
1316         /// Please note that single characters may use more than one byte due to UTF8 encoding.
1317         pub fn new(description: String) -> Result<Description, CreationError> {
1318                 if description.len() > 639 {
1319                         Err(CreationError::DescriptionTooLong)
1320                 } else {
1321                         Ok(Description(description))
1322                 }
1323         }
1324
1325         /// Returns the underlying description `String`
1326         pub fn into_inner(self) -> String {
1327                 self.0
1328         }
1329 }
1330
1331 impl Into<String> for Description {
1332         fn into(self) -> String {
1333                 self.into_inner()
1334         }
1335 }
1336
1337 impl Deref for Description {
1338         type Target = str;
1339
1340         fn deref(&self) -> &str {
1341                 &self.0
1342         }
1343 }
1344
1345 impl From<PublicKey> for PayeePubKey {
1346         fn from(pk: PublicKey) -> Self {
1347                 PayeePubKey(pk)
1348         }
1349 }
1350
1351 impl Deref for PayeePubKey {
1352         type Target = PublicKey;
1353
1354         fn deref(&self) -> &PublicKey {
1355                 &self.0
1356         }
1357 }
1358
1359 impl ExpiryTime {
1360         /// Construct an `ExpiryTime` from seconds.
1361         pub fn from_seconds(seconds: u64) -> ExpiryTime {
1362                 ExpiryTime(Duration::from_secs(seconds))
1363         }
1364
1365         /// Construct an `ExpiryTime` from a `Duration`, dropping the sub-second part.
1366         pub fn from_duration(duration: Duration) -> ExpiryTime {
1367                 Self::from_seconds(duration.as_secs())
1368         }
1369
1370         /// Returns the expiry time in seconds
1371         pub fn as_seconds(&self) -> u64 {
1372                 self.0.as_secs()
1373         }
1374
1375         /// Returns a reference to the underlying `Duration` (=expiry time)
1376         pub fn as_duration(&self) -> &Duration {
1377                 &self.0
1378         }
1379 }
1380
1381 impl PrivateRoute {
1382         /// Creates a new (partial) route from a list of hops
1383         pub fn new(hops: RouteHint) -> Result<PrivateRoute, CreationError> {
1384                 if hops.0.len() <= 12 {
1385                         Ok(PrivateRoute(hops))
1386                 } else {
1387                         Err(CreationError::RouteTooLong)
1388                 }
1389         }
1390
1391         /// Returns the underlying list of hops
1392         pub fn into_inner(self) -> RouteHint {
1393                 self.0
1394         }
1395 }
1396
1397 impl Into<RouteHint> for PrivateRoute {
1398         fn into(self) -> RouteHint {
1399                 self.into_inner()
1400         }
1401 }
1402
1403 impl Deref for PrivateRoute {
1404         type Target = RouteHint;
1405
1406         fn deref(&self) -> &RouteHint {
1407                 &self.0
1408         }
1409 }
1410
1411 impl Deref for InvoiceSignature {
1412         type Target = RecoverableSignature;
1413
1414         fn deref(&self) -> &RecoverableSignature {
1415                 &self.0
1416         }
1417 }
1418
1419 impl Deref for SignedRawInvoice {
1420         type Target = RawInvoice;
1421
1422         fn deref(&self) -> &RawInvoice {
1423                 &self.raw_invoice
1424         }
1425 }
1426
1427 /// Errors that may occur when constructing a new `RawInvoice` or `Invoice`
1428 #[derive(Eq, PartialEq, Debug, Clone)]
1429 pub enum CreationError {
1430         /// The supplied description string was longer than 639 __bytes__ (see [`Description::new(…)`](./struct.Description.html#method.new))
1431         DescriptionTooLong,
1432
1433         /// The specified route has too many hops and can't be encoded
1434         RouteTooLong,
1435
1436         /// The Unix timestamp of the supplied date is less than zero or greater than 35-bits
1437         TimestampOutOfBounds,
1438
1439         /// The supplied millisatoshi amount was greater than the total bitcoin supply.
1440         InvalidAmount,
1441
1442         /// Route hints were required for this invoice and were missing. Applies to
1443         /// [phantom invoices].
1444         ///
1445         /// [phantom invoices]: crate::utils::create_phantom_invoice
1446         MissingRouteHints,
1447 }
1448
1449 impl Display for CreationError {
1450         fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
1451                 match self {
1452                         CreationError::DescriptionTooLong => f.write_str("The supplied description string was longer than 639 bytes"),
1453                         CreationError::RouteTooLong => f.write_str("The specified route has too many hops and can't be encoded"),
1454                         CreationError::TimestampOutOfBounds => f.write_str("The Unix timestamp of the supplied date is less than zero or greater than 35-bits"),
1455                         CreationError::InvalidAmount => f.write_str("The supplied millisatoshi amount was greater than the total bitcoin supply"),
1456                         CreationError::MissingRouteHints => f.write_str("The invoice required route hints and they weren't provided"),
1457                 }
1458         }
1459 }
1460
1461 #[cfg(feature = "std")]
1462 impl std::error::Error for CreationError { }
1463
1464 /// Errors that may occur when converting a `RawInvoice` to an `Invoice`. They relate to the
1465 /// requirements sections in BOLT #11
1466 #[derive(Eq, PartialEq, Debug, Clone)]
1467 pub enum SemanticError {
1468         /// The invoice is missing the mandatory payment hash
1469         NoPaymentHash,
1470
1471         /// The invoice has multiple payment hashes which isn't allowed
1472         MultiplePaymentHashes,
1473
1474         /// No description or description hash are part of the invoice
1475         NoDescription,
1476
1477         /// The invoice contains multiple descriptions and/or description hashes which isn't allowed
1478         MultipleDescriptions,
1479
1480         /// The invoice is missing the mandatory payment secret, which all modern lightning nodes
1481         /// should provide.
1482         NoPaymentSecret,
1483
1484         /// The invoice contains multiple payment secrets
1485         MultiplePaymentSecrets,
1486
1487         /// The invoice's features are invalid
1488         InvalidFeatures,
1489
1490         /// The recovery id doesn't fit the signature/pub key
1491         InvalidRecoveryId,
1492
1493         /// The invoice's signature is invalid
1494         InvalidSignature,
1495
1496         /// The invoice's amount was not a whole number of millisatoshis
1497         ImpreciseAmount,
1498 }
1499
1500 impl Display for SemanticError {
1501         fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
1502                 match self {
1503                         SemanticError::NoPaymentHash => f.write_str("The invoice is missing the mandatory payment hash"),
1504                         SemanticError::MultiplePaymentHashes => f.write_str("The invoice has multiple payment hashes which isn't allowed"),
1505                         SemanticError::NoDescription => f.write_str("No description or description hash are part of the invoice"),
1506                         SemanticError::MultipleDescriptions => f.write_str("The invoice contains multiple descriptions and/or description hashes which isn't allowed"),
1507                         SemanticError::NoPaymentSecret => f.write_str("The invoice is missing the mandatory payment secret"),
1508                         SemanticError::MultiplePaymentSecrets => f.write_str("The invoice contains multiple payment secrets"),
1509                         SemanticError::InvalidFeatures => f.write_str("The invoice's features are invalid"),
1510                         SemanticError::InvalidRecoveryId => f.write_str("The recovery id doesn't fit the signature/pub key"),
1511                         SemanticError::InvalidSignature => f.write_str("The invoice's signature is invalid"),
1512                         SemanticError::ImpreciseAmount => f.write_str("The invoice's amount was not a whole number of millisatoshis"),
1513                 }
1514         }
1515 }
1516
1517 #[cfg(feature = "std")]
1518 impl std::error::Error for SemanticError { }
1519
1520 /// When signing using a fallible method either an user-supplied `SignError` or a `CreationError`
1521 /// may occur.
1522 #[derive(Eq, PartialEq, Debug, Clone)]
1523 pub enum SignOrCreationError<S = ()> {
1524         /// An error occurred during signing
1525         SignError(S),
1526
1527         /// An error occurred while building the transaction
1528         CreationError(CreationError),
1529 }
1530
1531 impl<S> Display for SignOrCreationError<S> {
1532         fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
1533                 match self {
1534                         SignOrCreationError::SignError(_) => f.write_str("An error occurred during signing"),
1535                         SignOrCreationError::CreationError(err) => err.fmt(f),
1536                 }
1537         }
1538 }
1539
1540 #[cfg(feature = "serde")]
1541 impl Serialize for Invoice {
1542         fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where S: Serializer {
1543                 serializer.serialize_str(self.to_string().as_str())
1544         }
1545 }
1546 #[cfg(feature = "serde")]
1547 impl<'de> Deserialize<'de> for Invoice {
1548         fn deserialize<D>(deserializer: D) -> Result<Invoice, D::Error> where D: Deserializer<'de> {
1549                 let bolt11 = String::deserialize(deserializer)?
1550                         .parse::<Invoice>()
1551                         .map_err(|e| D::Error::custom(format!("{:?}", e)))?;
1552
1553                 Ok(bolt11)
1554         }
1555 }
1556
1557 #[cfg(test)]
1558 mod test {
1559         use bitcoin_hashes::hex::FromHex;
1560         use bitcoin_hashes::sha256;
1561
1562         #[test]
1563         fn test_system_time_bounds_assumptions() {
1564                 assert_eq!(
1565                         crate::PositiveTimestamp::from_unix_timestamp(crate::MAX_TIMESTAMP + 1),
1566                         Err(crate::CreationError::TimestampOutOfBounds)
1567                 );
1568         }
1569
1570         #[test]
1571         fn test_calc_invoice_hash() {
1572                 use crate::{RawInvoice, RawHrp, RawDataPart, Currency, PositiveTimestamp};
1573                 use crate::TaggedField::*;
1574
1575                 let invoice = RawInvoice {
1576                         hrp: RawHrp {
1577                                 currency: Currency::Bitcoin,
1578                                 raw_amount: None,
1579                                 si_prefix: None,
1580                         },
1581                         data: RawDataPart {
1582                                 timestamp: PositiveTimestamp::from_unix_timestamp(1496314658).unwrap(),
1583                                 tagged_fields: vec![
1584                                         PaymentHash(crate::Sha256(sha256::Hash::from_hex(
1585                                                 "0001020304050607080900010203040506070809000102030405060708090102"
1586                                         ).unwrap())).into(),
1587                                         Description(crate::Description::new(
1588                                                 "Please consider supporting this project".to_owned()
1589                                         ).unwrap()).into(),
1590                                 ],
1591                         },
1592                 };
1593
1594                 let expected_hash = [
1595                         0xc3, 0xd4, 0xe8, 0x3f, 0x64, 0x6f, 0xa7, 0x9a, 0x39, 0x3d, 0x75, 0x27, 0x7b, 0x1d,
1596                         0x85, 0x8d, 0xb1, 0xd1, 0xf7, 0xab, 0x71, 0x37, 0xdc, 0xb7, 0x83, 0x5d, 0xb2, 0xec,
1597                         0xd5, 0x18, 0xe1, 0xc9
1598                 ];
1599
1600                 assert_eq!(invoice.signable_hash(), expected_hash)
1601         }
1602
1603         #[test]
1604         fn test_check_signature() {
1605                 use crate::TaggedField::*;
1606                 use secp256k1::Secp256k1;
1607                 use secp256k1::ecdsa::{RecoveryId, RecoverableSignature};
1608                 use secp256k1::{SecretKey, PublicKey};
1609                 use crate::{SignedRawInvoice, InvoiceSignature, RawInvoice, RawHrp, RawDataPart, Currency, Sha256,
1610                          PositiveTimestamp};
1611
1612                 let invoice = SignedRawInvoice {
1613                         raw_invoice: RawInvoice {
1614                                 hrp: RawHrp {
1615                                         currency: Currency::Bitcoin,
1616                                         raw_amount: None,
1617                                         si_prefix: None,
1618                                 },
1619                                 data: RawDataPart {
1620                                         timestamp: PositiveTimestamp::from_unix_timestamp(1496314658).unwrap(),
1621                                         tagged_fields: vec ! [
1622                                                 PaymentHash(Sha256(sha256::Hash::from_hex(
1623                                                         "0001020304050607080900010203040506070809000102030405060708090102"
1624                                                 ).unwrap())).into(),
1625                                                 Description(
1626                                                         crate::Description::new(
1627                                                                 "Please consider supporting this project".to_owned()
1628                                                         ).unwrap()
1629                                                 ).into(),
1630                                         ],
1631                                 },
1632                         },
1633                         hash: [
1634                                 0xc3, 0xd4, 0xe8, 0x3f, 0x64, 0x6f, 0xa7, 0x9a, 0x39, 0x3d, 0x75, 0x27,
1635                                 0x7b, 0x1d, 0x85, 0x8d, 0xb1, 0xd1, 0xf7, 0xab, 0x71, 0x37, 0xdc, 0xb7,
1636                                 0x83, 0x5d, 0xb2, 0xec, 0xd5, 0x18, 0xe1, 0xc9
1637                         ],
1638                         signature: InvoiceSignature(RecoverableSignature::from_compact(
1639                                 & [
1640                                         0x38u8, 0xec, 0x68, 0x91, 0x34, 0x5e, 0x20, 0x41, 0x45, 0xbe, 0x8a,
1641                                         0x3a, 0x99, 0xde, 0x38, 0xe9, 0x8a, 0x39, 0xd6, 0xa5, 0x69, 0x43,
1642                                         0x4e, 0x18, 0x45, 0xc8, 0xaf, 0x72, 0x05, 0xaf, 0xcf, 0xcc, 0x7f,
1643                                         0x42, 0x5f, 0xcd, 0x14, 0x63, 0xe9, 0x3c, 0x32, 0x88, 0x1e, 0xad,
1644                                         0x0d, 0x6e, 0x35, 0x6d, 0x46, 0x7e, 0xc8, 0xc0, 0x25, 0x53, 0xf9,
1645                                         0xaa, 0xb1, 0x5e, 0x57, 0x38, 0xb1, 0x1f, 0x12, 0x7f
1646                                 ],
1647                                 RecoveryId::from_i32(0).unwrap()
1648                         ).unwrap()),
1649                 };
1650
1651                 assert!(invoice.check_signature());
1652
1653                 let private_key = SecretKey::from_slice(
1654                         &[
1655                                 0xe1, 0x26, 0xf6, 0x8f, 0x7e, 0xaf, 0xcc, 0x8b, 0x74, 0xf5, 0x4d, 0x26, 0x9f, 0xe2,
1656                                 0x06, 0xbe, 0x71, 0x50, 0x00, 0xf9, 0x4d, 0xac, 0x06, 0x7d, 0x1c, 0x04, 0xa8, 0xca,
1657                                 0x3b, 0x2d, 0xb7, 0x34
1658                         ][..]
1659                 ).unwrap();
1660                 let public_key = PublicKey::from_secret_key(&Secp256k1::new(), &private_key);
1661
1662                 assert_eq!(invoice.recover_payee_pub_key(), Ok(crate::PayeePubKey(public_key)));
1663
1664                 let (raw_invoice, _, _) = invoice.into_parts();
1665                 let new_signed = raw_invoice.sign::<_, ()>(|hash| {
1666                         Ok(Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key))
1667                 }).unwrap();
1668
1669                 assert!(new_signed.check_signature());
1670         }
1671
1672         #[test]
1673         fn test_check_feature_bits() {
1674                 use crate::TaggedField::*;
1675                 use lightning::ln::features::InvoiceFeatures;
1676                 use secp256k1::Secp256k1;
1677                 use secp256k1::SecretKey;
1678                 use crate::{RawInvoice, RawHrp, RawDataPart, Currency, Sha256, PositiveTimestamp, Invoice,
1679                          SemanticError};
1680
1681                 let private_key = SecretKey::from_slice(&[42; 32]).unwrap();
1682                 let payment_secret = lightning::ln::PaymentSecret([21; 32]);
1683                 let invoice_template = RawInvoice {
1684                         hrp: RawHrp {
1685                                 currency: Currency::Bitcoin,
1686                                 raw_amount: None,
1687                                 si_prefix: None,
1688                         },
1689                         data: RawDataPart {
1690                                 timestamp: PositiveTimestamp::from_unix_timestamp(1496314658).unwrap(),
1691                                 tagged_fields: vec ! [
1692                                         PaymentHash(Sha256(sha256::Hash::from_hex(
1693                                                 "0001020304050607080900010203040506070809000102030405060708090102"
1694                                         ).unwrap())).into(),
1695                                         Description(
1696                                                 crate::Description::new(
1697                                                         "Please consider supporting this project".to_owned()
1698                                                 ).unwrap()
1699                                         ).into(),
1700                                 ],
1701                         },
1702                 };
1703
1704                 // Missing features
1705                 let invoice = {
1706                         let mut invoice = invoice_template.clone();
1707                         invoice.data.tagged_fields.push(PaymentSecret(payment_secret).into());
1708                         invoice.sign::<_, ()>(|hash| Ok(Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key)))
1709                 }.unwrap();
1710                 assert_eq!(Invoice::from_signed(invoice), Err(SemanticError::InvalidFeatures));
1711
1712                 // Missing feature bits
1713                 let invoice = {
1714                         let mut invoice = invoice_template.clone();
1715                         invoice.data.tagged_fields.push(PaymentSecret(payment_secret).into());
1716                         invoice.data.tagged_fields.push(Features(InvoiceFeatures::empty()).into());
1717                         invoice.sign::<_, ()>(|hash| Ok(Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key)))
1718                 }.unwrap();
1719                 assert_eq!(Invoice::from_signed(invoice), Err(SemanticError::InvalidFeatures));
1720
1721                 let mut payment_secret_features = InvoiceFeatures::empty();
1722                 payment_secret_features.set_payment_secret_required();
1723
1724                 // Including payment secret and feature bits
1725                 let invoice = {
1726                         let mut invoice = invoice_template.clone();
1727                         invoice.data.tagged_fields.push(PaymentSecret(payment_secret).into());
1728                         invoice.data.tagged_fields.push(Features(payment_secret_features.clone()).into());
1729                         invoice.sign::<_, ()>(|hash| Ok(Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key)))
1730                 }.unwrap();
1731                 assert!(Invoice::from_signed(invoice).is_ok());
1732
1733                 // No payment secret or features
1734                 let invoice = {
1735                         let invoice = invoice_template.clone();
1736                         invoice.sign::<_, ()>(|hash| Ok(Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key)))
1737                 }.unwrap();
1738                 assert_eq!(Invoice::from_signed(invoice), Err(SemanticError::NoPaymentSecret));
1739
1740                 // No payment secret or feature bits
1741                 let invoice = {
1742                         let mut invoice = invoice_template.clone();
1743                         invoice.data.tagged_fields.push(Features(InvoiceFeatures::empty()).into());
1744                         invoice.sign::<_, ()>(|hash| Ok(Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key)))
1745                 }.unwrap();
1746                 assert_eq!(Invoice::from_signed(invoice), Err(SemanticError::NoPaymentSecret));
1747
1748                 // Missing payment secret
1749                 let invoice = {
1750                         let mut invoice = invoice_template.clone();
1751                         invoice.data.tagged_fields.push(Features(payment_secret_features).into());
1752                         invoice.sign::<_, ()>(|hash| Ok(Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key)))
1753                 }.unwrap();
1754                 assert_eq!(Invoice::from_signed(invoice), Err(SemanticError::NoPaymentSecret));
1755
1756                 // Multiple payment secrets
1757                 let invoice = {
1758                         let mut invoice = invoice_template.clone();
1759                         invoice.data.tagged_fields.push(PaymentSecret(payment_secret).into());
1760                         invoice.data.tagged_fields.push(PaymentSecret(payment_secret).into());
1761                         invoice.sign::<_, ()>(|hash| Ok(Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key)))
1762                 }.unwrap();
1763                 assert_eq!(Invoice::from_signed(invoice), Err(SemanticError::MultiplePaymentSecrets));
1764         }
1765
1766         #[test]
1767         fn test_builder_amount() {
1768                 use crate::*;
1769
1770                 let builder = InvoiceBuilder::new(Currency::Bitcoin)
1771                         .description("Test".into())
1772                         .payment_hash(sha256::Hash::from_slice(&[0;32][..]).unwrap())
1773                         .duration_since_epoch(Duration::from_secs(1234567));
1774
1775                 let invoice = builder.clone()
1776                         .amount_milli_satoshis(1500)
1777                         .build_raw()
1778                         .unwrap();
1779
1780                 assert_eq!(invoice.hrp.si_prefix, Some(SiPrefix::Nano));
1781                 assert_eq!(invoice.hrp.raw_amount, Some(15));
1782
1783
1784                 let invoice = builder.clone()
1785                         .amount_milli_satoshis(150)
1786                         .build_raw()
1787                         .unwrap();
1788
1789                 assert_eq!(invoice.hrp.si_prefix, Some(SiPrefix::Pico));
1790                 assert_eq!(invoice.hrp.raw_amount, Some(1500));
1791         }
1792
1793         #[test]
1794         fn test_builder_fail() {
1795                 use crate::*;
1796                 use lightning::routing::router::RouteHintHop;
1797                 use std::iter::FromIterator;
1798                 use secp256k1::PublicKey;
1799
1800                 let builder = InvoiceBuilder::new(Currency::Bitcoin)
1801                         .payment_hash(sha256::Hash::from_slice(&[0;32][..]).unwrap())
1802                         .duration_since_epoch(Duration::from_secs(1234567))
1803                         .min_final_cltv_expiry(144);
1804
1805                 let too_long_string = String::from_iter(
1806                         (0..1024).map(|_| '?')
1807                 );
1808
1809                 let long_desc_res = builder.clone()
1810                         .description(too_long_string)
1811                         .build_raw();
1812                 assert_eq!(long_desc_res, Err(CreationError::DescriptionTooLong));
1813
1814                 let route_hop = RouteHintHop {
1815                         src_node_id: PublicKey::from_slice(
1816                                         &[
1817                                                 0x03, 0x9e, 0x03, 0xa9, 0x01, 0xb8, 0x55, 0x34, 0xff, 0x1e, 0x92, 0xc4,
1818                                                 0x3c, 0x74, 0x43, 0x1f, 0x7c, 0xe7, 0x20, 0x46, 0x06, 0x0f, 0xcf, 0x7a,
1819                                                 0x95, 0xc3, 0x7e, 0x14, 0x8f, 0x78, 0xc7, 0x72, 0x55
1820                                         ][..]
1821                                 ).unwrap(),
1822                         short_channel_id: 0,
1823                         fees: RoutingFees {
1824                                 base_msat: 0,
1825                                 proportional_millionths: 0,
1826                         },
1827                         cltv_expiry_delta: 0,
1828                         htlc_minimum_msat: None,
1829                         htlc_maximum_msat: None,
1830                 };
1831                 let too_long_route = RouteHint(vec![route_hop; 13]);
1832                 let long_route_res = builder.clone()
1833                         .description("Test".into())
1834                         .private_route(too_long_route)
1835                         .build_raw();
1836                 assert_eq!(long_route_res, Err(CreationError::RouteTooLong));
1837
1838                 let sign_error_res = builder.clone()
1839                         .description("Test".into())
1840                         .payment_secret(PaymentSecret([0; 32]))
1841                         .try_build_signed(|_| {
1842                                 Err("ImaginaryError")
1843                         });
1844                 assert_eq!(sign_error_res, Err(SignOrCreationError::SignError("ImaginaryError")));
1845         }
1846
1847         #[test]
1848         fn test_builder_ok() {
1849                 use crate::*;
1850                 use lightning::routing::router::RouteHintHop;
1851                 use secp256k1::Secp256k1;
1852                 use secp256k1::{SecretKey, PublicKey};
1853                 use std::time::{UNIX_EPOCH, Duration};
1854
1855                 let secp_ctx = Secp256k1::new();
1856
1857                 let private_key = SecretKey::from_slice(
1858                         &[
1859                                 0xe1, 0x26, 0xf6, 0x8f, 0x7e, 0xaf, 0xcc, 0x8b, 0x74, 0xf5, 0x4d, 0x26, 0x9f, 0xe2,
1860                                 0x06, 0xbe, 0x71, 0x50, 0x00, 0xf9, 0x4d, 0xac, 0x06, 0x7d, 0x1c, 0x04, 0xa8, 0xca,
1861                                 0x3b, 0x2d, 0xb7, 0x34
1862                         ][..]
1863                 ).unwrap();
1864                 let public_key = PublicKey::from_secret_key(&secp_ctx, &private_key);
1865
1866                 let route_1 = RouteHint(vec![
1867                         RouteHintHop {
1868                                 src_node_id: public_key.clone(),
1869                                 short_channel_id: de::parse_int_be(&[123; 8], 256).expect("short chan ID slice too big?"),
1870                                 fees: RoutingFees {
1871                                         base_msat: 2,
1872                                         proportional_millionths: 1,
1873                                 },
1874                                 cltv_expiry_delta: 145,
1875                                 htlc_minimum_msat: None,
1876                                 htlc_maximum_msat: None,
1877                         },
1878                         RouteHintHop {
1879                                 src_node_id: public_key.clone(),
1880                                 short_channel_id: de::parse_int_be(&[42; 8], 256).expect("short chan ID slice too big?"),
1881                                 fees: RoutingFees {
1882                                         base_msat: 3,
1883                                         proportional_millionths: 2,
1884                                 },
1885                                 cltv_expiry_delta: 146,
1886                                 htlc_minimum_msat: None,
1887                                 htlc_maximum_msat: None,
1888                         }
1889                 ]);
1890
1891                 let route_2 = RouteHint(vec![
1892                         RouteHintHop {
1893                                 src_node_id: public_key.clone(),
1894                                 short_channel_id: 0,
1895                                 fees: RoutingFees {
1896                                         base_msat: 4,
1897                                         proportional_millionths: 3,
1898                                 },
1899                                 cltv_expiry_delta: 147,
1900                                 htlc_minimum_msat: None,
1901                                 htlc_maximum_msat: None,
1902                         },
1903                         RouteHintHop {
1904                                 src_node_id: public_key.clone(),
1905                                 short_channel_id: de::parse_int_be(&[1; 8], 256).expect("short chan ID slice too big?"),
1906                                 fees: RoutingFees {
1907                                         base_msat: 5,
1908                                         proportional_millionths: 4,
1909                                 },
1910                                 cltv_expiry_delta: 148,
1911                                 htlc_minimum_msat: None,
1912                                 htlc_maximum_msat: None,
1913                         }
1914                 ]);
1915
1916                 let builder = InvoiceBuilder::new(Currency::BitcoinTestnet)
1917                         .amount_milli_satoshis(123)
1918                         .duration_since_epoch(Duration::from_secs(1234567))
1919                         .payee_pub_key(public_key.clone())
1920                         .expiry_time(Duration::from_secs(54321))
1921                         .min_final_cltv_expiry(144)
1922                         .fallback(Fallback::PubKeyHash([0;20]))
1923                         .private_route(route_1.clone())
1924                         .private_route(route_2.clone())
1925                         .description_hash(sha256::Hash::from_slice(&[3;32][..]).unwrap())
1926                         .payment_hash(sha256::Hash::from_slice(&[21;32][..]).unwrap())
1927                         .payment_secret(PaymentSecret([42; 32]))
1928                         .basic_mpp();
1929
1930                 let invoice = builder.clone().build_signed(|hash| {
1931                         secp_ctx.sign_ecdsa_recoverable(hash, &private_key)
1932                 }).unwrap();
1933
1934                 assert!(invoice.check_signature().is_ok());
1935                 assert_eq!(invoice.tagged_fields().count(), 10);
1936
1937                 assert_eq!(invoice.amount_milli_satoshis(), Some(123));
1938                 assert_eq!(invoice.amount_pico_btc(), Some(1230));
1939                 assert_eq!(invoice.currency(), Currency::BitcoinTestnet);
1940                 #[cfg(feature = "std")]
1941                 assert_eq!(
1942                         invoice.timestamp().duration_since(UNIX_EPOCH).unwrap().as_secs(),
1943                         1234567
1944                 );
1945                 assert_eq!(invoice.payee_pub_key(), Some(&public_key));
1946                 assert_eq!(invoice.expiry_time(), Duration::from_secs(54321));
1947                 assert_eq!(invoice.min_final_cltv_expiry(), 144);
1948                 assert_eq!(invoice.fallbacks(), vec![&Fallback::PubKeyHash([0;20])]);
1949                 assert_eq!(invoice.private_routes(), vec![&PrivateRoute(route_1), &PrivateRoute(route_2)]);
1950                 assert_eq!(
1951                         invoice.description(),
1952                         InvoiceDescription::Hash(&Sha256(sha256::Hash::from_slice(&[3;32][..]).unwrap()))
1953                 );
1954                 assert_eq!(invoice.payment_hash(), &sha256::Hash::from_slice(&[21;32][..]).unwrap());
1955                 assert_eq!(invoice.payment_secret(), &PaymentSecret([42; 32]));
1956
1957                 let mut expected_features = InvoiceFeatures::empty();
1958                 expected_features.set_variable_length_onion_required();
1959                 expected_features.set_payment_secret_required();
1960                 expected_features.set_basic_mpp_optional();
1961                 assert_eq!(invoice.features(), Some(&expected_features));
1962
1963                 let raw_invoice = builder.build_raw().unwrap();
1964                 assert_eq!(raw_invoice, *invoice.into_signed_raw().raw_invoice())
1965         }
1966
1967         #[test]
1968         fn test_default_values() {
1969                 use crate::*;
1970                 use secp256k1::Secp256k1;
1971                 use secp256k1::SecretKey;
1972
1973                 let signed_invoice = InvoiceBuilder::new(Currency::Bitcoin)
1974                         .description("Test".into())
1975                         .payment_hash(sha256::Hash::from_slice(&[0;32][..]).unwrap())
1976                         .payment_secret(PaymentSecret([0; 32]))
1977                         .duration_since_epoch(Duration::from_secs(1234567))
1978                         .build_raw()
1979                         .unwrap()
1980                         .sign::<_, ()>(|hash| {
1981                                 let privkey = SecretKey::from_slice(&[41; 32]).unwrap();
1982                                 let secp_ctx = Secp256k1::new();
1983                                 Ok(secp_ctx.sign_ecdsa_recoverable(hash, &privkey))
1984                         })
1985                         .unwrap();
1986                 let invoice = Invoice::from_signed(signed_invoice).unwrap();
1987
1988                 assert_eq!(invoice.min_final_cltv_expiry(), DEFAULT_MIN_FINAL_CLTV_EXPIRY);
1989                 assert_eq!(invoice.expiry_time(), Duration::from_secs(DEFAULT_EXPIRY_TIME));
1990                 assert!(!invoice.would_expire(Duration::from_secs(1234568)));
1991         }
1992
1993         #[test]
1994         fn test_expiration() {
1995                 use crate::*;
1996                 use secp256k1::Secp256k1;
1997                 use secp256k1::SecretKey;
1998
1999                 let signed_invoice = InvoiceBuilder::new(Currency::Bitcoin)
2000                         .description("Test".into())
2001                         .payment_hash(sha256::Hash::from_slice(&[0;32][..]).unwrap())
2002                         .payment_secret(PaymentSecret([0; 32]))
2003                         .duration_since_epoch(Duration::from_secs(1234567))
2004                         .build_raw()
2005                         .unwrap()
2006                         .sign::<_, ()>(|hash| {
2007                                 let privkey = SecretKey::from_slice(&[41; 32]).unwrap();
2008                                 let secp_ctx = Secp256k1::new();
2009                                 Ok(secp_ctx.sign_ecdsa_recoverable(hash, &privkey))
2010                         })
2011                         .unwrap();
2012                 let invoice = Invoice::from_signed(signed_invoice).unwrap();
2013
2014                 assert!(invoice.would_expire(Duration::from_secs(1234567 + DEFAULT_EXPIRY_TIME + 1)));
2015         }
2016
2017         #[cfg(feature = "serde")]
2018         #[test]
2019         fn test_serde() {
2020                 let invoice_str = "lnbc100p1psj9jhxdqud3jxktt5w46x7unfv9kz6mn0v3jsnp4q0d3p2sfluzdx45tqcs\
2021                         h2pu5qc7lgq0xs578ngs6s0s68ua4h7cvspp5q6rmq35js88zp5dvwrv9m459tnk2zunwj5jalqtyxqulh0l\
2022                         5gflssp5nf55ny5gcrfl30xuhzj3nphgj27rstekmr9fw3ny5989s300gyus9qyysgqcqpcrzjqw2sxwe993\
2023                         h5pcm4dxzpvttgza8zhkqxpgffcrf5v25nwpr3cmfg7z54kuqq8rgqqqqqqqq2qqqqq9qq9qrzjqd0ylaqcl\
2024                         j9424x9m8h2vcukcgnm6s56xfgu3j78zyqzhgs4hlpzvznlugqq9vsqqqqqqqlgqqqqqeqq9qrzjqwldmj9d\
2025                         ha74df76zhx6l9we0vjdquygcdt3kssupehe64g6yyp5yz5rhuqqwccqqyqqqqlgqqqqjcqq9qrzjqf9e58a\
2026                         guqr0rcun0ajlvmzq3ek63cw2w282gv3z5uupmuwvgjtq2z55qsqqg6qqqyqqqrtnqqqzq3cqygrzjqvphms\
2027                         ywntrrhqjcraumvc4y6r8v4z5v593trte429v4hredj7ms5z52usqq9ngqqqqqqqlgqqqqqqgq9qrzjq2v0v\
2028                         p62g49p7569ev48cmulecsxe59lvaw3wlxm7r982zxa9zzj7z5l0cqqxusqqyqqqqlgqqqqqzsqygarl9fh3\
2029                         8s0gyuxjjgux34w75dnc6xp2l35j7es3jd4ugt3lu0xzre26yg5m7ke54n2d5sym4xcmxtl8238xxvw5h5h5\
2030                         j5r6drg6k6zcqj0fcwg";
2031                 let invoice = invoice_str.parse::<super::Invoice>().unwrap();
2032                 let serialized_invoice = serde_json::to_string(&invoice).unwrap();
2033                 let deserialized_invoice: super::Invoice = serde_json::from_str(serialized_invoice.as_str()).unwrap();
2034                 assert_eq!(invoice, deserialized_invoice);
2035                 assert_eq!(invoice_str, deserialized_invoice.to_string().as_str());
2036                 assert_eq!(invoice_str, serialized_invoice.as_str().trim_matches('\"'));
2037         }
2038 }