Struct UnsignedStaticInvoice

pub struct UnsignedStaticInvoice { /* private fields */ }

A semantically valid StaticInvoice that hasn’t been signed.

Implementations

impl UnsignedStaticInvoice

pub fn sign<F: SignStaticInvoiceFn>( self, sign: F, ) -> Result<StaticInvoice, SignError>

Signs the TaggedHash of the invoice using the given function.

Note: The hash computation may have included unknown, odd TLV records.

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 UnsignedStaticInvoice::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 UnsignedStaticInvoice::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.

Trait Implementations

impl AsRef<TaggedHash> for UnsignedStaticInvoice

fn as_ref(&self) -> &TaggedHash

Converts this type into a shared reference of the (usually inferred) input type.