Struct VerifiedInvoiceRequest

pub struct VerifiedInvoiceRequest {
    pub offer_id: OfferId,
    pub keys: Option<Keypair>,
    /* private fields */
}

An InvoiceRequest that has been verified by InvoiceRequest::verify_using_metadata or InvoiceRequest::verify_using_recipient_data and exposes different ways to respond depending on whether the signing keys were derived.

Fields

offer_id: OfferId

The identifier of the Offer for which the InvoiceRequest was made.

keys: Option<Keypair>

Keys used for signing a Bolt12Invoice if they can be derived.

If Some, must call respond_using_derived_keys when responding. Otherwise, call respond_with.

Implementations

impl VerifiedInvoiceRequest

pub fn chains(&self) -> Vec<ChainHash>

The chains that may be used when paying a requested invoice (e.g., bitcoin mainnet). Payments must be denominated in units of the minimal lightning-payable unit (e.g., msats) for the selected chain.

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

Opaque bytes set by the originator. Useful for authentication and validating fields since it is reflected in invoice_request messages along with all the other fields from the offer.

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

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

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

A complete description of the purpose of the payment. Intended to be displayed to the user but with the caveat that it has not been verified in any way.

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

Features pertaining to the offer.

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

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

If None, the offer does not expire.

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

The issuer of the offer, possibly beginning with user@domain or domain. Intended to be displayed to the user but with the caveat that it has not been verified in any way.

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

Paths to the recipient originating from publicly reachable nodes. Blinded paths provide recipient privacy by obfuscating its node id.

pub fn supported_quantity(&self) -> Quantity

The quantity of items supported.

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

The public key used by the recipient to sign invoices.

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

An unpredictable series of bytes, typically containing information about the derivation of payer_id.

pub fn chain(&self) -> ChainHash

A chain from Offer::chains that the offer is valid for.

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

The amount to pay in msats (i.e., the minimum lightning-payable unit for chain), which must be greater than or equal to Offer::amount, converted if necessary.

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

Features pertaining to requesting an invoice.

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

The quantity of the offer’s item conforming to Offer::is_valid_quantity.

pub fn payer_id(&self) -> PublicKey

A possibly transient pubkey used to sign the invoice request.

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

A payer-provided note which will be seen by the recipient and reflected back in the invoice response.

pub fn respond_with( &self, payment_paths: Vec<BlindedPaymentPath>, payment_hash: PaymentHash, ) -> Result<InvoiceBuilder<'_, ExplicitSigningPubkey>, Bolt12SemanticError>

Creates an InvoiceBuilder for the request with the given required fields and using the Duration since std::time::SystemTime::UNIX_EPOCH as the creation time.

See InvoiceRequest::respond_with_no_std for further details where the aforementioned creation time is used for the created_at parameter.

pub fn respond_with_no_std( &self, payment_paths: Vec<BlindedPaymentPath>, payment_hash: PaymentHash, created_at: Duration, ) -> Result<InvoiceBuilder<'_, ExplicitSigningPubkey>, Bolt12SemanticError>

Creates an InvoiceBuilder for the request with the given required fields.

Unless InvoiceBuilder::relative_expiry is set, the invoice will expire two hours after created_at, which is used to set Bolt12Invoice::created_at. Useful for no-std builds where std::time::SystemTime is not available.

The caller is expected to remember the preimage of payment_hash in order to claim a payment for the invoice.

The payment_paths parameter is useful for maintaining the payment recipient’s privacy. It must contain one or more elements ordered from most-preferred to least-preferred, if there’s a preference. Note, however, that any privacy is lost if a public node id was used for Offer::signing_pubkey.

Errors if the request contains unknown required features.

Note

If the originating Offer was created using OfferBuilder::deriving_signing_pubkey, then first use InvoiceRequest::verify_using_metadata or InvoiceRequest::verify_using_recipient_data and then VerifiedInvoiceRequest methods instead.

pub fn respond_using_derived_keys( &self, payment_paths: Vec<BlindedPaymentPath>, payment_hash: PaymentHash, ) -> Result<InvoiceBuilder<'_, DerivedSigningPubkey>, Bolt12SemanticError>

Creates an InvoiceBuilder for the request using the given required fields and that uses derived signing keys from the originating Offer to sign the Bolt12Invoice. Must use the same ExpandedKey as the one used to create the offer.

See InvoiceRequest::respond_with for further details.

pub fn respond_using_derived_keys_no_std( &self, payment_paths: Vec<BlindedPaymentPath>, payment_hash: PaymentHash, created_at: Duration, ) -> Result<InvoiceBuilder<'_, DerivedSigningPubkey>, Bolt12SemanticError>

Creates an InvoiceBuilder for the request using the given required fields and that uses derived signing keys from the originating Offer to sign the Bolt12Invoice. Must use the same ExpandedKey as the one used to create the offer.

See InvoiceRequest::respond_with_no_std for further details.

Trait Implementations

impl Clone for VerifiedInvoiceRequest

fn clone(&self) -> VerifiedInvoiceRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VerifiedInvoiceRequest

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

Formats the value using the given formatter.