Struct lightning_invoice::SignedRawBolt11Invoice

pub struct SignedRawBolt11Invoice { /* private fields */ }

Represents a signed RawBolt11Invoice with cached hash. The signature is not checked and may be invalid.

Invariants

The hash has to be either from the deserialized invoice or from the serialized RawBolt11Invoice.

Implementations

impl SignedRawBolt11Invoice

pub fn into_parts(self) -> (RawBolt11Invoice, [u8; 32], Bolt11InvoiceSignature)

Disassembles the SignedRawBolt11Invoice into its three parts:

1. raw invoice
2. hash of the raw invoice
3. signature

pub fn raw_invoice(&self) -> &RawBolt11Invoice

The RawBolt11Invoice which was signed.

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

The hash of the RawBolt11Invoice that was signed.

pub fn signature(&self) -> &Bolt11InvoiceSignature

Signature for the invoice.

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

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

pub fn check_signature(&self) -> bool

Checks if the signature is valid for the included payee public key or if none exists if it’s valid for the recovered signature (which should always be true?).

Methods from Deref<Target = RawBolt11Invoice>

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

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

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

Trait Implementations

impl Clone for SignedRawBolt11Invoice

fn clone(&self) -> SignedRawBolt11Invoice

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SignedRawBolt11Invoice

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

Formats the value using the given formatter.

impl Deref for SignedRawBolt11Invoice

type Target = RawBolt11Invoice

The resulting type after dereferencing.

fn deref(&self) -> &RawBolt11Invoice

Dereferences the value.

impl Display for SignedRawBolt11Invoice

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

Formats the value using the given formatter.

impl FromStr for SignedRawBolt11Invoice

use lightning_invoice::*;

let invoice = "lnbc100p1psj9jhxdqud3jxktt5w46x7unfv9kz6mn0v3jsnp4q0d3p2sfluzdx45tqcs\
h2pu5qc7lgq0xs578ngs6s0s68ua4h7cvspp5q6rmq35js88zp5dvwrv9m459tnk2zunwj5jalqtyxqulh0l\
5gflssp5nf55ny5gcrfl30xuhzj3nphgj27rstekmr9fw3ny5989s300gyus9qyysgqcqpcrzjqw2sxwe993\
h5pcm4dxzpvttgza8zhkqxpgffcrf5v25nwpr3cmfg7z54kuqq8rgqqqqqqqq2qqqqq9qq9qrzjqd0ylaqcl\
j9424x9m8h2vcukcgnm6s56xfgu3j78zyqzhgs4hlpzvznlugqq9vsqqqqqqqlgqqqqqeqq9qrzjqwldmj9d\
ha74df76zhx6l9we0vjdquygcdt3kssupehe64g6yyp5yz5rhuqqwccqqyqqqqlgqqqqjcqq9qrzjqf9e58a\
guqr0rcun0ajlvmzq3ek63cw2w282gv3z5uupmuwvgjtq2z55qsqqg6qqqyqqqrtnqqqzq3cqygrzjqvphms\
ywntrrhqjcraumvc4y6r8v4z5v593trte429v4hredj7ms5z52usqq9ngqqqqqqqlgqqqqqqgq9qrzjq2v0v\
p62g49p7569ev48cmulecsxe59lvaw3wlxm7r982zxa9zzj7z5l0cqqxusqqyqqqqlgqqqqqzsqygarl9fh3\
8s0gyuxjjgux34w75dnc6xp2l35j7es3jd4ugt3lu0xzre26yg5m7ke54n2d5sym4xcmxtl8238xxvw5h5h5\
j5r6drg6k6zcqj0fcwg";

let parsed_1 = invoice.parse::<Bolt11Invoice>();

let parsed_2 = match invoice.parse::<SignedRawBolt11Invoice>() {
	Ok(signed) => match Bolt11Invoice::from_signed(signed) {
		Ok(invoice) => Ok(invoice),
		Err(e) => Err(ParseOrSemanticError::SemanticError(e)),
	},
	Err(e) => Err(ParseOrSemanticError::ParseError(e)),
};

assert!(parsed_1.is_ok());
assert_eq!(parsed_1, parsed_2);

type Err = Bolt11ParseError

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 Hash for SignedRawBolt11Invoice

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 SignedRawBolt11Invoice

fn cmp(&self, other: &SignedRawBolt11Invoice) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for SignedRawBolt11Invoice

fn eq(&self, other: &SignedRawBolt11Invoice) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for SignedRawBolt11Invoice

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Eq for SignedRawBolt11Invoice

impl StructuralPartialEq for SignedRawBolt11Invoice