Struct Bolt11Invoice 

pub struct Bolt11Invoice { /* private fields */ }

Available on crate feature lightning only.

Represents a syntactically and semantically correct lightning BOLT11 invoice.

Implementations

impl Bolt11Invoice

pub fn new(s: &str) -> Result<Arc<Self>, LwkError>

Construct a Bolt11Invoice from a string

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

Returns the amount in millisatoshis if present, None if it’s an “any amount” invoice

pub fn payment_hash(&self) -> String

Returns the payment hash as a hex string

pub fn invoice_description(&self) -> String

Returns the invoice description as a string

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

Returns the payee’s public key if present as a hex string

pub fn timestamp(&self) -> u64

Returns the invoice timestamp as seconds since Unix epoch

pub fn expiry_time(&self) -> u64

Returns the expiry time in seconds (default is 3600 seconds / 1 hour if not specified)

pub fn min_final_cltv_expiry_delta(&self) -> u64

Returns the minimum CLTV expiry delta

pub fn network(&self) -> String

Returns the network (bitcoin, testnet, signet, regtest)

pub fn payment_secret(&self) -> String

Returns the payment secret as a debug string

Trait Implementations

impl AsRef<Bolt11Invoice> for Bolt11Invoice

fn as_ref(&self) -> &Bolt11Invoice

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

impl Clone for Bolt11Invoice

fn clone(&self) -> Bolt11Invoice

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Bolt11Invoice

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

Formats the value using the given formatter.

impl Display for Bolt11Invoice

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

Formats the value using the given formatter.

impl From<&Bolt11Invoice> for Bolt11Invoice

fn from(invoice: &Bolt11Invoice) -> Self

Converts to this type from the input type.

impl From<Bolt11Invoice> for Bolt11Invoice

fn from(inner: Bolt11Invoice) -> Self

Converts to this type from the input type.

impl From<Bolt11Invoice> for Bolt11Invoice

fn from(invoice: Bolt11Invoice) -> Self

Converts to this type from the input type.

impl<UT> LiftRef<UT> for Bolt11Invoice

type LiftType = Arc<Bolt11Invoice>

impl<UT> LowerError<UT> for Bolt11Invoice

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for Bolt11Invoice

type ReturnType = <Arc<Bolt11Invoice> as LowerReturn<UniFfiTag>>::ReturnType

The type that should be returned by scaffolding functions for this type.

fn lower_return(obj: Self) -> Result<Self::ReturnType, RustCallError>

Lower the return value from an scaffolding call

fn handle_failed_lift( error: LiftArgsError, ) -> Result<Self::ReturnType, RustCallError>

Lower the return value for failed argument lifts

impl PartialEq for Bolt11Invoice

fn eq(&self, other: &Bolt11Invoice) -> 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<UT> TypeId<UT> for Bolt11Invoice

const TYPE_ID_META: MetadataBuffer

impl Eq for Bolt11Invoice

impl StructuralPartialEq for Bolt11Invoice