Struct StaticInvoice

pub struct StaticInvoice { /* private fields */ }

A StaticInvoice is a reusable payment request corresponding to an Offer.

A static invoice may be sent in response to an InvoiceRequest and includes all the information needed to pay the recipient. However, unlike Bolt12Invoices, static invoices do not provide proof-of-payment. Therefore, Bolt12Invoices should be preferred when the recipient is online to provide one.

Implementations

impl StaticInvoice

pub fn payment_paths(&self) -> &[BlindedPaymentPath]

Paths to the recipient originating from publicly reachable nodes, including information needed for routing payments across them.

Blinded paths provide recipient privacy by obfuscating its node id. Note, however, that this privacy is lost if a public node id is used for StaticInvoice::signing_pubkey.

pub fn created_at(&self) -> Duration

Duration since the Unix epoch when the invoice was created.

pub fn relative_expiry(&self) -> Duration

Duration since StaticInvoice::created_at when the invoice has expired and therefore should no longer be paid.

pub fn is_expired(&self) -> bool

Whether the invoice has expired.

pub fn is_expired_no_std(&self, duration_since_epoch: Duration) -> bool

Whether the invoice has expired given the current time as duration since the Unix epoch.

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

Fallback addresses for paying the invoice on-chain, in order of most-preferred to least-preferred.

pub fn invoice_features(&self) -> &Bolt12InvoiceFeatures

Features pertaining to paying an invoice.

pub fn signing_pubkey(&self) -> PublicKey

The public key corresponding to the key used to sign the invoice.

This will be:

• Offer::issuer_signing_pubkey if it’s Some, otherwise
• the final blinded node id from a BlindedMessagePath in Offer::paths if None.

pub fn chain(&self) -> ChainHash

The chain that must be used when paying the invoice. StaticInvoices currently can only be created from offers that support a single chain.

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

Opaque bytes set by the originating Offer::metadata.

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

The minimum amount required for a successful payment of a single item.

From Offer::amount.

pub fn offer_features(&self) -> &OfferFeatures

Features pertaining to the originating Offer, from Offer::offer_features.

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

A complete description of the purpose of the originating offer, from Offer::description.

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

Duration since the Unix epoch when an invoice should no longer be requested, from Offer::absolute_expiry.

pub fn issuer(&self) -> Option<PrintableString<'_>>

The issuer of the offer, from Offer::issuer.

pub fn offer_message_paths(&self) -> &[BlindedMessagePath]

Paths to the node that may supply the invoice on the recipient’s behalf, originating from publicly reachable nodes. Taken from Offer::paths.

pub fn message_paths(&self) -> &[BlindedMessagePath]

Paths to the recipient for indicating that a held HTLC is available to claim when they next come online.

pub fn supported_quantity(&self) -> Quantity

The quantity of items supported, from Offer::supported_quantity.

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

The public key used by the recipient to sign invoices, from Offer::issuer_signing_pubkey.

pub fn signature(&self) -> Signature

Signature of the invoice verified using StaticInvoice::signing_pubkey.

pub fn is_offer_expired(&self) -> bool

Whether the Offer that this invoice is based on is expired.

pub fn is_offer_expired_no_std(&self, duration_since_epoch: Duration) -> bool

Whether the Offer that this invoice is based on is expired, given the current time as duration since the Unix epoch.

pub fn offer_id(&self) -> OfferId

Returns the OfferId corresponding to the originating Offer.

Trait Implementations

impl Clone for StaticInvoice

fn clone(&self) -> StaticInvoice

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StaticInvoice

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

Formats the value using the given formatter.

impl Hash for StaticInvoice

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

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 LengthReadable for StaticInvoice

fn read_from_fixed_length_buffer<R: LengthLimitedRead>( r: &mut R, ) -> Result<Self, DecodeError>

Reads a Self in from the given LengthLimitedRead.

impl PartialEq for StaticInvoice

fn eq(&self, other: &Self) -> 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 TryFrom<Vec<u8>> for StaticInvoice

type Error = Bolt12ParseError

The type returned in the event of a conversion error.

fn try_from(bytes: Vec<u8>) -> Result<Self, Self::Error>

Performs the conversion.

impl Writeable for StaticInvoice

fn write<W: Writer>(&self, writer: &mut W) -> Result<(), Error>

Writes self out to the given Writer.

fn encode(&self) -> Vec<u8>

Writes self out to a Vec<u8>.

fn serialized_length(&self) -> usize

Gets the length of this object after it has been serialized. This can be overridden to optimize cases where we prepend an object with its length.

impl Eq for StaticInvoice