Struct lightning::offers::invoice_request::UnsignedInvoiceRequest
source · pub struct UnsignedInvoiceRequest { /* private fields */ }
Expand description
A semantically valid InvoiceRequest
that hasn’t been signed.
§Serialization
This is serialized as a TLV stream, which includes TLV records from the originating message. As such, it may include unknown, odd TLV records.
Implementations§
source§impl UnsignedInvoiceRequest
impl UnsignedInvoiceRequest
sourcepub fn tagged_hash(&self) -> &TaggedHash
pub fn tagged_hash(&self) -> &TaggedHash
Returns the TaggedHash
of the invoice to sign.
sourcepub fn sign<F, E>(self, sign: F) -> Result<InvoiceRequest, SignError<E>>
pub fn sign<F, E>(self, sign: F) -> Result<InvoiceRequest, SignError<E>>
Signs the TaggedHash
of the invoice request using the given function.
Note: The hash computation may have included unknown, odd TLV records.
This is not exported to bindings users as functions are not yet mapped.
source§impl UnsignedInvoiceRequest
impl UnsignedInvoiceRequest
sourcepub fn chains(&self) -> Vec<ChainHash>
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.
sourcepub fn metadata(&self) -> Option<&Vec<u8>>
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
.
sourcepub fn amount(&self) -> Option<&Amount>
pub fn amount(&self) -> Option<&Amount>
The minimum amount required for a successful payment of a single item.
sourcepub fn description(&self) -> PrintableString<'_>
pub fn description(&self) -> 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.
sourcepub fn offer_features(&self) -> &OfferFeatures
pub fn offer_features(&self) -> &OfferFeatures
Features pertaining to the offer.
sourcepub fn absolute_expiry(&self) -> Option<Duration>
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.
sourcepub fn issuer(&self) -> Option<PrintableString<'_>>
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.
sourcepub fn paths(&self) -> &[BlindedPath]
pub fn paths(&self) -> &[BlindedPath]
Paths to the recipient originating from publicly reachable nodes. Blinded paths provide recipient privacy by obfuscating its node id.
sourcepub fn supported_quantity(&self) -> Quantity
pub fn supported_quantity(&self) -> Quantity
The quantity of items supported.
sourcepub fn signing_pubkey(&self) -> PublicKey
pub fn signing_pubkey(&self) -> PublicKey
The public key used by the recipient to sign invoices.
sourcepub fn payer_metadata(&self) -> &[u8] ⓘ
pub fn payer_metadata(&self) -> &[u8] ⓘ
An unpredictable series of bytes, typically containing information about the derivation of
payer_id
.
sourcepub fn chain(&self) -> ChainHash
pub fn chain(&self) -> ChainHash
A chain from Offer::chains
that the offer is valid for.
sourcepub fn amount_msats(&self) -> Option<u64>
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.
sourcepub fn invoice_request_features(&self) -> &InvoiceRequestFeatures
pub fn invoice_request_features(&self) -> &InvoiceRequestFeatures
Features pertaining to requesting an invoice.
sourcepub fn quantity(&self) -> Option<u64>
pub fn quantity(&self) -> Option<u64>
The quantity of the offer’s item conforming to Offer::is_valid_quantity
.
sourcepub fn payer_id(&self) -> PublicKey
pub fn payer_id(&self) -> PublicKey
A possibly transient pubkey used to sign the invoice request.
sourcepub fn payer_note(&self) -> Option<PrintableString<'_>>
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.