Struct RawBolt11Invoice

pub struct RawBolt11Invoice {
    pub hrp: RawHrp,
    pub data: RawDataPart,
}

Represents an syntactically correct Bolt11Invoice for a payment on the lightning network, but without the signature information. Decoding and encoding should not lead to information loss but may lead to different hashes.

For methods without docs see the corresponding methods in Bolt11Invoice.

Fields

hrp: RawHrp

human readable part

data: RawDataPart

data part

Implementations

impl RawBolt11Invoice

pub fn signable_hash(&self) -> [u8; 32]

Calculate the hash of the encoded RawBolt11Invoice which should be signed.

pub fn sign<F, E>(self, sign_method: F) -> Result<SignedRawBolt11Invoice, E>

where F: FnOnce(&Message) -> Result<RecoverableSignature, E>,

Signs the invoice using the supplied sign_method. This function MAY fail with an error of type E. Since the signature of a SignedRawBolt11Invoice is not required to be valid there are no constraints regarding the validity of the produced signature.

This is not exported to bindings users as we don’t currently support passing function pointers into methods explicitly.

pub fn known_tagged_fields( &self, ) -> FilterMap<Iter<'_, RawTaggedField>, fn(_: &RawTaggedField) -> Option<&TaggedField>>

Returns an iterator over all tagged fields with known semantics.

This is not exported to bindings users as there is not yet a manual mapping for a FilterMap

pub fn payment_hash(&self) -> Option<&Sha256>

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

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

pub fn description_hash(&self) -> Option<&Sha256>

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

pub fn min_final_cltv_expiry_delta(&self) -> Option<&MinFinalCltvExpiryDelta>

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

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

pub fn features(&self) -> Option<&Bolt11InvoiceFeatures>

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

This is not exported to bindings users as we don’t support Vec<&NonOpaqueType>

pub fn private_routes(&self) -> Vec<&PrivateRoute>

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

Returns None if no amount is set or on overflow.

pub fn currency(&self) -> Currency

pub fn to_raw(&self) -> (String, Vec<Fe32>)

Convert to HRP prefix and Fe32 encoded data part. Can be used to transmit unsigned invoices for remote signing.

pub fn from_raw(hrp: &str, data: &[Fe32]) -> Result<Self, Bolt11ParseError>

Convert from HRP prefix and Fe32 encoded data part. Can be used to receive unsigned invoices for remote signing.

Trait Implementations

impl Clone for RawBolt11Invoice

fn clone(&self) -> RawBolt11Invoice

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RawBolt11Invoice

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

Formats the value using the given formatter.

impl Hash for RawBolt11Invoice

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 Ord for RawBolt11Invoice

fn cmp(&self, other: &RawBolt11Invoice) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for RawBolt11Invoice

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

fn partial_cmp(&self, other: &RawBolt11Invoice) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for RawBolt11Invoice

impl StructuralPartialEq for RawBolt11Invoice