Struct lightning_invoice::Invoice

pub struct Invoice { /* fields omitted */ }

Represents a syntactically and semantically correct lightning BOLT11 invoice.

There are three ways to construct an Invoice:

1. using InvoiceBuilder
2. using Invoice::from_signed(SignedRawInvoice)
3. using str::parse::<Invoice>(&str)

Methods

impl Invoice

pub fn into_signed_raw(self) -> SignedRawInvoice

Transform the Invoice into it's unchecked version

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

Check that the invoice is signed correctly and that key recovery works

pub fn from_signed(     signed_invoice: SignedRawInvoice ) -> Result<Self, SemanticError>

Constructs an Invoice from a SignedInvoice by checking all its invariants.

use lightning_invoice::*;

let invoice = "lnbc1pvjluezpp5qqqsyqcyq5rqwzqfqqqsyqcyq5rqwzqfqqqsyqcyq5rqwzqfqypqdp\
    l2pkx2ctnv5sxxmmwwd5kgetjypeh2ursdae8g6twvus8g6rfwvs8qun0dfjkxaq8rkx3yf5tcsyz3d7\
    3gafnh3cax9rn449d9p5uxz9ezhhypd0elx87sjle52x86fux2ypatgddc6k63n7erqz25le42c4u4ec\
    ky03ylcqca784w";

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

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

pub fn timestamp(&self) -> &SystemTime

Returns the Invoice's timestamp (should equal it's creation time)

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

Returns an iterator over all tagged fields of this Invoice.

pub fn payment_hash(&self) -> &Sha256

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

pub fn description(&self) -> InvoiceDescription

Return the description or a hash of it for longer ones

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

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

pub fn recover_payee_pub_key(&self) -> PayeePubKey

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

pub fn expiry_time(&self) -> Option<&ExpiryTime>

Returns the invoice's expiry time if present

pub fn min_final_cltv_expiry(&self) -> Option<&MinFinalCltvExpiry>

Returns the invoice's min_cltv_expiry time if present

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

Returns a list of all fallback addresses

pub fn routes(&self) -> Vec<&Route>

Returns a list of all routes included in the invoice

pub fn currency(&self) -> Currency

Returns the currency for which the invoice was issued

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

Returns the amount if specified in the invoice as pico .

Trait Implementations

impl Clone for Invoice

fn clone(&self) -> Invoice

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for Invoice

impl PartialEq<Invoice> for Invoice

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Display for Invoice

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

Formats the value using the given formatter.

impl Debug for Invoice

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl FromStr for Invoice

use lightning_invoice::Invoice;

let invoice = "lnbc1pvjluezpp5qqqsyqcyq5rqwzqfqqqsyqcyq5rqwzqfqqqsyqcyq5rqwzqfqypqdp\
    l2pkx2ctnv5sxxmmwwd5kgetjypeh2ursdae8g6twvus8g6rfwvs8qun0dfjkxaq8rkx3yf5tcsyz3d7\
    3gafnh3cax9rn449d9p5uxz9ezhhypd0elx87sjle52x86fux2ypatgddc6k63n7erqz25le42c4u4ec\
    ky03ylcqca784w";

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

type Err = ParseOrSemanticError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

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