Struct Invoice 

pub struct Invoice(pub Bolt11Invoice);

A BOLT 11 Lightning invoice. Serialized as a bech32-encoded string (e.g. "lnbc1...").

Tuple Fields

0: Bolt11Invoice

Implementations

impl Invoice

pub fn payment_hash(&self) -> PaymentHash

The invoice payment hash. The payer will receive the preimage to this hash upon successful payment, as proof-of-payment.

pub fn payment_secret(&self) -> PaymentSecret

The invoice payment secret, used to authenticate the payer to the payee and tie MPP HTLCs together.

pub fn payment_id(&self) -> PaymentId

Lexe’s main identifier for this payment, which for BOLT11 invoice payments is just the Invoice::payment_hash.

pub fn network(&self) -> Network

pub fn supports_network(&self, network: Network) -> bool

pub fn description_str(&self) -> Option<&str>

If the invoice contains a non-empty, inline description, then return that as a string. Otherwise return None.

pub fn description_hash(&self) -> Option<&[u8; 32]>

If the invoice uses a description hash, return that. Otherwise return None.

pub fn amount(&self) -> Option<Amount>

Return the invoice’s requested amount, if present. An invoice may leave the final amount up to the payer, in which case this field will be None.

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

The invoice amount in satoshis, if included.

pub fn created_at(&self) -> Result<TimestampMs, Error>

Get the invoice creation timestamp. Returns an error if the timestamp is several hundred million years in the future.

pub fn saturating_created_at(&self) -> TimestampMs

Get the invoice creation timestamp unconditionally.

pub fn is_expired(&self) -> bool

Returns true if the invoice has expired.

pub fn is_expired_at(&self, ts: TimestampMs) -> bool

Returns true if the invoice expires before the given timestamp.

pub fn expires_at(&self) -> Result<TimestampMs, Error>

Get the invoice expiration timestamp. Returns an error if the timestamp is several hundred million years in the future.

pub fn saturating_expires_at(&self) -> TimestampMs

Get the invoice expiration timestamp unconditionally.

pub fn payee_node_pk(&self) -> NodePk

Get the invoice payee’s NodePk.

If the pubkey is not included directly in the invoice, we have to ecrecover the pubkey, which is somewhat more expensive (~20-40 us).

pub fn min_final_cltv_expiry_delta_u32(&self) -> Result<u32, Error>

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

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

BOLT11 Invoices can attach optional onchain addresses for a payee to use if the lightning payment is not feasible. This fn returns those addresses.

pub fn matches_hrp_prefix(s: &str) -> bool

Returns true if the input string starts with a valid bech32 hrp prefix for a BOLT11 invoice.

Trait Implementations

impl Clone for Invoice

fn clone(&self) -> Invoice

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Invoice

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Invoice

where Invoice: FromStr, <Invoice as FromStr>::Err: Display,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Invoice

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

Formats the value using the given formatter.

impl FromStr for Invoice

type Err = ParseError

The associated error which can be returned from parsing.

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

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

impl PartialEq for Invoice

fn eq(&self, other: &Invoice) -> 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 Serialize for Invoice

where Invoice: Display,

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 Invoice

impl StructuralPartialEq for Invoice