Crate lightning_invoice

This crate provides data structures to represent lightning BOLT11 invoices and functions to create, encode and decode these. If you just want to use the standard en-/decoding functionality this should get you started:

• For parsing use str::parse::<Bolt11Invoice>(&self) (see Bolt11Invoice::from_str)
• For constructing invoices use the InvoiceBuilder
• For serializing invoices use the Display/ToString traits

Modules

• constants
  Tag constants as specified in BOLT11
• payment
  Convenient utilities for paying Lightning invoices.
• utils
  Convenient utilities to create an invoice.

Structs

• Bolt11Invoice
  Represents a syntactically and semantically correct lightning BOLT11 invoice.
• Bolt11InvoiceSignature
  Recoverable signature
• Description
  Description string
• ExpiryTime
  Positive duration that defines when (relatively to the timestamp) in the future the invoice expires
• InvoiceBuilder
  Builder for Bolt11Invoices. It’s the most convenient and advised way to use this library. It ensures that only a semantically and syntactically correct invoice can be built using it.
• MinFinalCltvExpiryDelta
  min_final_cltv_expiry_delta to use for the last HTLC in the route
• PayeePubKey
  Payee public key
• PaymentSecret
  payment_secret type, use to authenticate sender to the receiver and tie MPP HTLCs together
• PositiveTimestamp
  A timestamp that refers to a date after 1 January 1970.
• PrivateRoute
  Private routing information
• RawBolt11Invoice
  Represents an syntactically correct Bolt11Invoice for a payment on the lightning network, but without the signature information. Decoding and encoding should not lead to information loss but may lead to different hashes.
• RawDataPart
  Data of the RawBolt11Invoice that is encoded in the data part
• RawHrp
  Data of the RawBolt11Invoice that is encoded in the human readable part.
• RouteHint
  A list of hops along a payment path terminating with a channel to the recipient.
• RouteHintHop
  A channel descriptor for a hop along a payment path.
• RoutingFees
  Fees for routing via a given channel or a node
• Sha256
  SHA-256 hash
• SignedRawBolt11Invoice
  Represents a signed RawBolt11Invoice with cached hash. The signature is not checked and may be invalid.

Enums

• Bolt11InvoiceDescription
  Represents the description of an invoice which has to be either a directly included string or a hash of a description provided out of band.
• Bolt11ParseError
  Errors that indicate what is wrong with the invoice. They have some granularity for debug reasons, but should generally result in an “invalid BOLT11 invoice” message for the user.
• Bolt11SemanticError
  Errors that may occur when converting a RawBolt11Invoice to a Bolt11Invoice. They relate to the requirements sections in BOLT #11
• CreationError
  Errors that may occur when constructing a new RawBolt11Invoice or Bolt11Invoice
• Currency
  Enum representing the crypto currencies (or networks) supported by this library
• Fallback
  Fallback address in case no LN payment is possible
• ParseOrSemanticError
  Indicates that something went wrong while parsing or validating the invoice. Parsing errors should be mostly seen as opaque and are only there for debugging reasons. Semantic errors like wrong signatures, missing fields etc. could mean that someone tampered with the invoice.
• RawTaggedField
  Tagged field which may have an unknown tag
• SiPrefix
  SI prefixes for the human readable part
• SignOrCreationError
  When signing using a fallible method either an user-supplied SignError or a CreationError may occur.
• TaggedField
  Tagged field with known tag

Constants

• DEFAULT_EXPIRY_TIME
  Default expiry time as defined by BOLT 11.
• DEFAULT_MIN_FINAL_CLTV_EXPIRY_DELTA
  Default minimum final CLTV expiry as defined by BOLT 11.
• MAX_TIMESTAMP
  The maximum timestamp as Duration::as_secs since the Unix epoch allowed by [BOLT 11].