Struct PayerProof 

pub struct PayerProof { /* private fields */ }

A cryptographic proof that a BOLT 12 invoice was paid.

Contains the payment preimage, selective disclosure of invoice fields, the invoice signature, and a payer signature proving who paid.

Implementations

impl PayerProof

pub fn payment_preimage(&self) -> PaymentPreimage

The payment preimage proving the invoice was paid.

pub fn payer_signing_pubkey(&self) -> PublicKey

The payer’s public key (who paid).

pub fn issuer_signing_pubkey(&self) -> PublicKey

The issuer’s signing public key (the key that signed the invoice).

pub fn payment_hash(&self) -> PaymentHash

The payment hash.

pub fn invoice_signature(&self) -> Signature

The invoice signature over the merkle root.

pub fn proof_signature(&self) -> Signature

The payer’s schnorr signature proving who authorized the payment.

pub fn offer_description(&self) -> Option<PrintableString<'_>>

The disclosed offer description, if included in the proof.

pub fn offer_issuer(&self) -> Option<PrintableString<'_>>

The disclosed offer issuer, if included in the proof.

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

The disclosed invoice amount, if included in the proof.

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

The disclosed invoice creation time, if included in the proof.

pub fn proof_note(&self) -> Option<PrintableString<'_>>

A note the payer attached to this proof, if any.

This is distinct from InvoiceRequest::payer_note: the invoice-request note is sent to the payee at payment time, while this note is scoped to the proof and is committed to by the proof_signature alongside the invoice’s merkle root.

pub fn merkle_root(&self) -> Hash

The merkle root of the original invoice.

pub fn bytes(&self) -> &[u8]

The raw bytes of the payer proof.

Trait Implementations

impl AsRef<[u8]> for PayerProof

fn as_ref(&self) -> &[u8]

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

impl Clone for PayerProof

fn clone(&self) -> PayerProof

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PayerProof

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

Formats the value using the given formatter.

impl Display for PayerProof

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

Formats the value using the given formatter.

impl FromStr for PayerProof

type Err = Bolt12ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, <Self as FromStr>::Err>

Parses a string s to return a value of this type.

impl TryFrom<Vec<u8>> for PayerProof

type Error = Bolt12ParseError

The type returned in the event of a conversion error.

fn try_from(bytes: Vec<u8>) -> Result<Self, Self::Error>

Performs the conversion.

impl Writeable for PayerProof

fn write<W: Writer>(&self, writer: &mut W) -> Result<(), Error>

Writes self out to the given Writer.

fn encode(&self) -> Vec<u8>

Writes self out to a Vec<u8>.

fn serialized_length(&self) -> usize

Gets the length of this object after it has been serialized. This can be overridden to optimize cases where we prepend an object with its length.