Struct Bolt11Invoice

pub struct Bolt11Invoice { /* private fields */ }

Represents a syntactically and semantically correct lightning BOLT11 invoice.

There are three ways to construct a Bolt11Invoice:

1. using InvoiceBuilder
2. using Bolt11Invoice::from_signed
3. using str::parse::<Bolt11Invoice>(&str) (see Bolt11Invoice::from_str)

Implementations

impl Bolt11Invoice

pub fn signable_hash(&self) -> [u8; 32]

The hash of the RawBolt11Invoice that was signed.

pub fn into_signed_raw(self) -> SignedRawBolt11Invoice

Transform the Bolt11Invoice into its unchecked version.

pub fn check_signature(&self) -> Result<(), Bolt11SemanticError>

Check that the invoice is signed correctly

pub fn from_signed( signed_invoice: SignedRawBolt11Invoice, ) -> Result<Bolt11Invoice, Bolt11SemanticError>

Constructs a Bolt11Invoice from a SignedRawBolt11Invoice by checking all its invariants.

use lightning_invoice::*;

let invoice = "lnbc100p1psj9jhxdqud3jxktt5w46x7unfv9kz6mn0v3jsnp4q0d3p2sfluzdx45tqcs\
h2pu5qc7lgq0xs578ngs6s0s68ua4h7cvspp5q6rmq35js88zp5dvwrv9m459tnk2zunwj5jalqtyxqulh0l\
5gflssp5nf55ny5gcrfl30xuhzj3nphgj27rstekmr9fw3ny5989s300gyus9qyysgqcqpcrzjqw2sxwe993\
h5pcm4dxzpvttgza8zhkqxpgffcrf5v25nwpr3cmfg7z54kuqq8rgqqqqqqqq2qqqqq9qq9qrzjqd0ylaqcl\
j9424x9m8h2vcukcgnm6s56xfgu3j78zyqzhgs4hlpzvznlugqq9vsqqqqqqqlgqqqqqeqq9qrzjqwldmj9d\
ha74df76zhx6l9we0vjdquygcdt3kssupehe64g6yyp5yz5rhuqqwccqqyqqqqlgqqqqjcqq9qrzjqf9e58a\
guqr0rcun0ajlvmzq3ek63cw2w282gv3z5uupmuwvgjtq2z55qsqqg6qqqyqqqrtnqqqzq3cqygrzjqvphms\
ywntrrhqjcraumvc4y6r8v4z5v593trte429v4hredj7ms5z52usqq9ngqqqqqqqlgqqqqqqgq9qrzjq2v0v\
p62g49p7569ev48cmulecsxe59lvaw3wlxm7r982zxa9zzj7z5l0cqqxusqqyqqqqlgqqqqqzsqygarl9fh3\
8s0gyuxjjgux34w75dnc6xp2l35j7es3jd4ugt3lu0xzre26yg5m7ke54n2d5sym4xcmxtl8238xxvw5h5h5\
j5r6drg6k6zcqj0fcwg";

let signed = invoice.parse::<SignedRawBolt11Invoice>().unwrap();

assert!(Bolt11Invoice::from_signed(signed).is_ok());

pub fn timestamp(&self) -> SystemTime

Returns the Bolt11Invoice’s timestamp (should equal its creation time)

pub fn duration_since_epoch(&self) -> Duration

Returns the Bolt11Invoice’s timestamp as a duration since the Unix epoch

pub fn tagged_fields( &self, ) -> FilterMap<Iter<'_, RawTaggedField>, fn(&RawTaggedField) -> Option<&TaggedField>>

Returns an iterator over all tagged fields of this Bolt11Invoice.

This is not exported to bindings users as there is not yet a manual mapping for a FilterMap

pub fn payment_hash(&self) -> &Hash

Returns the hash to which we will receive the preimage on completion of the payment

pub fn description(&self) -> Bolt11InvoiceDescriptionRef<'_>

Return the description or a hash of it for longer ones

This is not exported to bindings users because we don’t yet export Bolt11InvoiceDescription

pub fn payee_pub_key(&self) -> Option<&PublicKey>

Get the payee’s public key if one was included in the invoice

pub fn payment_secret(&self) -> &PaymentSecret

Get the payment secret if one was included in the invoice

pub fn payment_metadata(&self) -> Option<&Vec<u8>>

Get the payment metadata blob if one was included in the invoice

pub fn features(&self) -> Option<&Features<Bolt11InvoiceContext>>

Get the invoice features if they were included in the invoice

pub fn recover_payee_pub_key(&self) -> PublicKey

Recover the payee’s public key (only to be used if none was included in the invoice)

pub fn get_payee_pub_key(&self) -> PublicKey

Recover the payee’s public key if one was included in the invoice, otherwise return the recovered public key from the signature

pub fn expires_at(&self) -> Option<Duration>

Returns the Duration since the Unix epoch at which the invoice expires. Returning None if overflow occurred.

pub fn expiry_time(&self) -> Duration

Returns the invoice’s expiry time, if present, otherwise DEFAULT_EXPIRY_TIME.

pub fn is_expired(&self) -> bool

Returns whether the invoice has expired.

pub fn duration_until_expiry(&self) -> Duration

Returns the Duration remaining until the invoice expires.

pub fn expiration_remaining_from_epoch(&self, time: Duration) -> Duration

Returns the Duration remaining until the invoice expires given the current time. time is the timestamp as a duration since the Unix epoch.

pub fn would_expire(&self, at_time: Duration) -> bool

Returns whether the expiry time would pass at the given point in time. at_time is the timestamp as a duration since the Unix epoch.

pub fn min_final_cltv_expiry_delta(&self) -> u64

Returns the invoice’s min_final_cltv_expiry_delta time, if present, otherwise DEFAULT_MIN_FINAL_CLTV_EXPIRY_DELTA.

pub fn fallbacks(&self) -> Vec<&Fallback>

Returns a list of all fallback addresses

This is not exported to bindings users as we don’t support Vec<&NonOpaqueType>

pub fn fallback_addresses(&self) -> Vec<Address>

Returns a list of all fallback addresses as Addresses

pub fn private_routes(&self) -> Vec<&PrivateRoute>

Returns a list of all routes included in the invoice

pub fn route_hints(&self) -> Vec<RouteHint>

Returns a list of all routes included in the invoice as the underlying hints

pub fn currency(&self) -> Currency

Returns the currency for which the invoice was issued

pub fn network(&self) -> Network

Returns the network for which the invoice was issued

This is not exported to bindings users, see Self::currency instead.

pub fn amount_milli_satoshis(&self) -> Option<u64>

Returns the amount if specified in the invoice as millisatoshis.

Trait Implementations

impl Bolt11InvoiceExt for Bolt11Invoice

fn get_final_amount( &self, user_amount: Option<Amount>, ) -> Result<Amount, CheckAmountError>

Get the amount to be paid. It checks both user and invoice equality if both are provided, else it tries to return one of them, or returns an error if neither are provided.

impl Clone for Bolt11Invoice

fn clone(&self) -> Bolt11Invoice

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Bolt11Invoice

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Bolt11Invoice

fn deserialize<D>( deserializer: D, ) -> Result<Bolt11Invoice, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Bolt11Invoice

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'a> From<&'a Bolt11Invoice> for PaymentHash

fn from(i: &'a Bolt11Invoice) -> Self

Converts to this type from the input type.

impl From<Bolt11Invoice> for Invoice

fn from(invoice: Bolt11Invoice) -> Self

Converts to this type from the input type.

impl From<Bolt11Invoice> for PaymentHash

fn from(i: Bolt11Invoice) -> Self

Converts to this type from the input type.

impl FromStr for Bolt11Invoice

use lightning_invoice::Bolt11Invoice;


let invoice = "lnbc100p1psj9jhxdqud3jxktt5w46x7unfv9kz6mn0v3jsnp4q0d3p2sfluzdx45tqcs\
h2pu5qc7lgq0xs578ngs6s0s68ua4h7cvspp5q6rmq35js88zp5dvwrv9m459tnk2zunwj5jalqtyxqulh0l\
5gflssp5nf55ny5gcrfl30xuhzj3nphgj27rstekmr9fw3ny5989s300gyus9qyysgqcqpcrzjqw2sxwe993\
h5pcm4dxzpvttgza8zhkqxpgffcrf5v25nwpr3cmfg7z54kuqq8rgqqqqqqqq2qqqqq9qq9qrzjqd0ylaqcl\
j9424x9m8h2vcukcgnm6s56xfgu3j78zyqzhgs4hlpzvznlugqq9vsqqqqqqqlgqqqqqeqq9qrzjqwldmj9d\
ha74df76zhx6l9we0vjdquygcdt3kssupehe64g6yyp5yz5rhuqqwccqqyqqqqlgqqqqjcqq9qrzjqf9e58a\
guqr0rcun0ajlvmzq3ek63cw2w282gv3z5uupmuwvgjtq2z55qsqqg6qqqyqqqrtnqqqzq3cqygrzjqvphms\
ywntrrhqjcraumvc4y6r8v4z5v593trte429v4hredj7ms5z52usqq9ngqqqqqqqlgqqqqqqgq9qrzjq2v0v\
p62g49p7569ev48cmulecsxe59lvaw3wlxm7r982zxa9zzj7z5l0cqqxusqqyqqqqlgqqqqqzsqygarl9fh3\
8s0gyuxjjgux34w75dnc6xp2l35j7es3jd4ugt3lu0xzre26yg5m7ke54n2d5sym4xcmxtl8238xxvw5h5h5\
j5r6drg6k6zcqj0fcwg";

assert!(invoice.parse::<Bolt11Invoice>().is_ok());

type Err = ParseOrSemanticError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Bolt11Invoice, <Bolt11Invoice as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for Bolt11Invoice

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Bolt11Invoice

fn cmp(&self, other: &Bolt11Invoice) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Bolt11Invoice

fn eq(&self, other: &Bolt11Invoice) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Bolt11Invoice

fn partial_cmp(&self, other: &Bolt11Invoice) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Bolt11Invoice

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Bolt11Invoice

impl StructuralPartialEq for Bolt11Invoice