Struct Bolt12Invoice 

pub struct Bolt12Invoice { /* private fields */ }

A Bolt12Invoice is a payment request, typically corresponding to an Offer or a Refund.

An invoice may be sent in response to an InvoiceRequest in the case of an offer or sent directly after scanning a refund. It includes all the information needed to pay a recipient.

Implementations

impl Bolt12Invoice

pub fn payment_paths(&self) -> &[BlindedPaymentPath]

Paths to the recipient originating from publicly reachable nodes, including information needed for routing payments across them.

Blinded paths provide recipient privacy by obfuscating its node id. Note, however, that this privacy is lost if a public node id is used for Bolt12Invoice::signing_pubkey.

pub fn created_at(&self) -> Duration

Duration since the Unix epoch when the invoice was created.

pub fn relative_expiry(&self) -> Duration

Duration since Bolt12Invoice::created_at when the invoice has expired and therefore should no longer be paid.

pub fn is_expired(&self) -> bool

Whether the invoice has expired.

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

Fallback addresses for paying the invoice on-chain, in order of most-preferred to least-preferred.

pub fn invoice_features(&self) -> &Features<Bolt12InvoiceContext>

Features pertaining to paying an invoice.

pub fn signing_pubkey(&self) -> PublicKey

A typically transient public key corresponding to the key used to sign the invoice.

If the invoices was created in response to an Offer, then this will be:

• Offer::issuer_signing_pubkey if it’s Some, otherwise
• the final blinded node id from a BlindedMessagePath in Offer::paths if None.

If the invoice was created in response to a Refund, then it is a valid pubkey chosen by the recipient.

pub fn offer_chains(&self) -> Option<Vec<ChainHash>>

The chains that may be used when paying a requested invoice.

From Offer::chains; None if the invoice was created in response to a Refund.

pub fn chain(&self) -> ChainHash

The chain that must be used when paying the invoice; selected from offer_chains if the invoice originated from an offer.

From InvoiceRequest::chain or Refund::chain.

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

Opaque bytes set by the originating Offer.

From Offer::metadata; None if the invoice was created in response to a Refund or if the Offer did not set it.

pub fn amount(&self) -> Option<Amount>

The minimum amount required for a successful payment of a single item.

From Offer::amount; None if the invoice was created in response to a Refund or if the Offer did not set it.

pub fn offer_features(&self) -> Option<&Features<OfferContext>>

Features pertaining to the originating Offer.

From Offer::offer_features; None if the invoice was created in response to a Refund.

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

A complete description of the purpose of the originating offer or refund.

From Offer::description or Refund::description.

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

Duration since the Unix epoch when an invoice should no longer be requested.

From Offer::absolute_expiry or Refund::absolute_expiry.

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

The issuer of the offer or refund.

From Offer::issuer or Refund::issuer.

pub fn message_paths(&self) -> &[BlindedMessagePath]

Paths to the recipient originating from publicly reachable nodes.

From Offer::paths or Refund::paths.

pub fn supported_quantity(&self) -> Option<Quantity>

The quantity of items supported.

From Offer::supported_quantity; None if the invoice was created in response to a Refund.

pub fn issuer_signing_pubkey(&self) -> Option<PublicKey>

The public key used by the recipient to sign invoices.

From Offer::issuer_signing_pubkey and may be None; also None if the invoice was created in response to a Refund.

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

An unpredictable series of bytes from the payer.

From InvoiceRequest::payer_metadata or Refund::payer_metadata.

pub fn invoice_request_features(&self) -> &Features<InvoiceRequestContext>

Features pertaining to requesting an invoice.

From InvoiceRequest::invoice_request_features or Refund::features.

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

The quantity of items requested or refunded for.

From InvoiceRequest::quantity or Refund::quantity.

pub fn payer_signing_pubkey(&self) -> PublicKey

A possibly transient pubkey used to sign the invoice request or to send an invoice for a refund in case there are no message_paths.

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

A payer-provided note reflected back in the invoice.

From InvoiceRequest::payer_note or Refund::payer_note.

pub fn payment_hash(&self) -> PaymentHash

SHA256 hash of the payment preimage that will be given in return for paying the invoice.

pub fn amount_msats(&self) -> u64

The minimum amount required for a successful payment of the invoice.

pub fn signature(&self) -> Signature

Signature of the invoice verified using Bolt12Invoice::signing_pubkey.

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

Hash that was used for signing the invoice.

pub fn verify_using_metadata<T>( &self, key: &ExpandedKey, secp_ctx: &Secp256k1<T>, ) -> Result<PaymentId, ()>

where T: Signing,

Verifies that the invoice was for a request or refund created using the given key by checking the payer metadata from the invoice request.

Returns the associated PaymentId to use when sending the payment.

pub fn verify_using_payer_data<T>( &self, payment_id: PaymentId, nonce: Nonce, key: &ExpandedKey, secp_ctx: &Secp256k1<T>, ) -> Result<PaymentId, ()>

where T: Signing,

Verifies that the invoice was for a request or refund created using the given key by checking a payment id and nonce included with the BlindedMessagePath for which the invoice was sent through.

Trait Implementations

impl Clone for Bolt12Invoice

fn clone(&self) -> Bolt12Invoice

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Bolt12Invoice

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

Formats the value using the given formatter.

impl Hash for Bolt12Invoice

fn hash<H>(&self, state: &mut H)

where H: Hasher,

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 for Bolt12Invoice

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

fn read<R>(reader: &mut R) -> Result<Bolt12Invoice, DecodeError>

where R: Read,

Reads a Self in from the given Read.

impl TryFrom<ParsedMessage<(PayerTlvStream, OfferTlvStream, InvoiceRequestTlvStream, InvoiceTlvStream, SignatureTlvStream, ExperimentalOfferTlvStream, ExperimentalInvoiceRequestTlvStream, ExperimentalInvoiceTlvStream)>> for Bolt12Invoice

type Error = Bolt12ParseError

The type returned in the event of a conversion error.

fn try_from( invoice: ParsedMessage<(PayerTlvStream, OfferTlvStream, InvoiceRequestTlvStream, InvoiceTlvStream, SignatureTlvStream, ExperimentalOfferTlvStream, ExperimentalInvoiceRequestTlvStream, ExperimentalInvoiceTlvStream)>, ) -> Result<Bolt12Invoice, <Bolt12Invoice as TryFrom<ParsedMessage<(PayerTlvStream, OfferTlvStream, InvoiceRequestTlvStream, InvoiceTlvStream, SignatureTlvStream, ExperimentalOfferTlvStream, ExperimentalInvoiceRequestTlvStream, ExperimentalInvoiceTlvStream)>>>::Error>

Performs the conversion.

impl TryFrom<Vec<u8>> for Bolt12Invoice

type Error = Bolt12ParseError

The type returned in the event of a conversion error.

fn try_from( bytes: Vec<u8>, ) -> Result<Bolt12Invoice, <Bolt12Invoice as TryFrom<Vec<u8>>>::Error>

Performs the conversion.

impl Writeable for Bolt12Invoice

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

where W: Writer,

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.

impl Eq for Bolt12Invoice