Struct CkbInvoice

Source

pub struct CkbInvoice {
    pub currency: Currency,
    pub amount: Option<u128>,
    pub signature: Option<InvoiceSignature>,
    pub data: InvoiceData,
}

Expand description

Represents a syntactically and semantically correct Fiber invoice.

There are three ways to construct a CkbInvoice:

using CkbInvoiceBuilder
using str::parse::<CkbInvoice>(&str) (see CkbInvoice::from_str)

Fields§

§currency: Currency

The currency of the invoice.

§amount: Option<u128>

The amount of the invoice.

§signature: Option<InvoiceSignature>

The signature of the invoice.

§data: InvoiceData

The invoice data, including the payment hash, timestamp and other attributes.

Implementations§

Source §

impl CkbInvoice

Source

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

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

Source

pub fn recover_payee_pub_key(&self) -> Result<PublicKey, Error>

Recovers the public key used for signing the invoice from the recoverable signature.

Source

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

Returns the payee public key if set in the invoice attributes.

Source

pub fn is_signed(&self) -> bool

Returns whether the invoice has a signature.

Source

pub fn payment_hash(&self) -> &Hash256

Returns the payment hash of the invoice.

Source

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

Returns the amount of the invoice.

Source

pub fn udt_type_script(&self) -> Option<&PackedScript>

Returns the UDT type script if set in the invoice attributes.

Source

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

Returns the expiry time if set in the invoice attributes.

Source

pub fn description(&self) -> Option<&String>

Returns the description if set in the invoice attributes.

Source

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

Returns the final TLC minimum expiry delta if set in the invoice attributes.

Source

pub fn final_tlc_minimum_expiry_delta_or_default(&self) -> u64

Returns the effective final TLC minimum expiry delta.

Uses DEFAULT_FINAL_TLC_EXPIRY_DELTA when the invoice omits the corresponding attribute.

Source

pub fn fallback_address(&self) -> Option<&String>

Returns the fallback address if set in the invoice attributes.

Source

pub fn hash_algorithm(&self) -> Option<&HashAlgorithm>

Returns the hash algorithm if set in the invoice attributes.

Source

pub fn payment_secret(&self) -> Option<&Hash256>

Returns the payment secret if set in the invoice attributes.

Source

pub fn allow_mpp(&self) -> bool

Returns whether the invoice allows MPP (multi-part payments).

Source

pub fn allow_trampoline_routing(&self) -> bool

Returns whether the invoice allows trampoline routing.

Source

pub fn is_expired(&self) -> bool

Returns whether the invoice has expired based on the current time.

Source

pub fn is_tlc_expire_too_soon(&self, tlc_expiry: u64) -> bool

Returns whether the TLC expiry is too soon for the given invoice.

Source

pub fn update_signature<F>( &mut self, sign_function: F, ) -> Result<(), InvoiceError>
where F: FnOnce(&Message) -> RecoverableSignature,

Updates the invoice signature using the provided signing function.

Source §

impl CkbInvoice

Source

pub fn from_str_allowing_unsigned(s: &str) -> Result<Self, InvoiceError>

Parses an invoice from its bech32m string representation, accepting both signed and unsigned invoices.

Most callers should use FromStr::from_str, which additionally requires the invoice to be signed. Only use this method in contexts where an unsigned invoice is legitimately expected (for example, decoding an invoice purely for inspection).