Struct lightning_invoice::SignedRawInvoice

pub struct SignedRawInvoice { /* private fields */ }

Represents a signed RawInvoice 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 RawInvoice.

Implementations

impl SignedRawInvoice

pub fn into_parts(self) -> (RawInvoice, [u8; 32], InvoiceSignature)

Disassembles the SignedRawInvoice into its three parts:

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

pub fn raw_invoice(&self) -> &RawInvoice

The RawInvoice which was signed.

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

The hash of the RawInvoice that was signed.

pub fn signature(&self) -> &InvoiceSignature

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 = RawInvoice>

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

Calculate the hash of the encoded RawInvoice 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<&InvoiceFeatures>

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>

pub fn currency(&self) -> Currency

Trait Implementations

impl Clone for SignedRawInvoice

fn clone(&self) -> SignedRawInvoice

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SignedRawInvoice

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

Formats the value using the given formatter.

impl Deref for SignedRawInvoice

type Target = RawInvoice

The resulting type after dereferencing.

fn deref(&self) -> &RawInvoice

Dereferences the value.

impl Display for SignedRawInvoice

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

Formats the value using the given formatter.

impl FromStr for SignedRawInvoice

use lightning_invoice::*;

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

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

let parsed_2 = match invoice.parse::<SignedRawInvoice>() {
	Ok(signed) => match Invoice::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 = ParseError

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 SignedRawInvoice

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 PartialEq<SignedRawInvoice> for SignedRawInvoice

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

impl StructuralEq for SignedRawInvoice

impl StructuralPartialEq for SignedRawInvoice