Struct CkbInvoice 

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

Represents a syntactically and semantically correct Fiber invoice.

There are three ways to construct a CkbInvoice:

1. using CkbInvoiceBuilder
2. 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

impl CkbInvoice

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

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

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

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

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

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

pub fn is_signed(&self) -> bool

Returns whether the invoice has a signature.

pub fn payment_hash(&self) -> &Hash256

Returns the payment hash of the invoice.

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

Returns the amount of the invoice.

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

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

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

Returns the expiry time if set in the invoice attributes.

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

Returns the description if set in the invoice attributes.

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

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

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

Returns the fallback address if set in the invoice attributes.

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

Returns the hash algorithm if set in the invoice attributes.

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

Returns the payment secret if set in the invoice attributes.

pub fn allow_mpp(&self) -> bool

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

pub fn allow_trampoline_routing(&self) -> bool

Returns whether the invoice allows trampoline routing.

pub fn is_expired(&self) -> bool

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

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

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

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.

Trait Implementations

impl Clone for CkbInvoice

fn clone(&self) -> CkbInvoice

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CkbInvoice

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CkbInvoice

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for CkbInvoice

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

Formats the value using the given formatter.

impl From<CkbInvoice> for RawCkbInvoice

fn from(invoice: CkbInvoice) -> Self

Converts to this type from the input type.

impl FromStr for CkbInvoice

type Err = InvoiceError

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.

impl PartialEq for CkbInvoice

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<RawCkbInvoice> for CkbInvoice

type Error = InvoiceError

The type returned in the event of a conversion error.

fn try_from(invoice: RawCkbInvoice) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for CkbInvoice

impl StructuralPartialEq for CkbInvoice