Struct UnsignedInvoiceRequest 

pub struct UnsignedInvoiceRequest { /* private fields */ }

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

impl UnsignedInvoiceRequest

pub fn tagged_hash(&self) -> &TaggedHash

Returns the TaggedHash of the invoice to sign.

impl UnsignedInvoiceRequest

pub fn sign<F: SignInvoiceRequestFn>( self, sign: F, ) -> Result<InvoiceRequest, SignError>

Available on non-c_bindings only.

Signs the TaggedHash of the invoice request using the given function.

Note: The hash computation may have included unknown, odd TLV records.

impl UnsignedInvoiceRequest

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) -> &OfferFeatures

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 issuer_signing_pubkey(&self) -> Option<PublicKey>

The public key corresponding to the key used by the recipient to sign invoices.

• If Offer::paths is empty, MUST be Some and contain the recipient’s node id for sending an InvoiceRequest.
• If Offer::paths is not empty, MAY be Some and contain a transient id.
• If None, the signing pubkey will be the final blinded node id from the BlindedMessagePath in Offer::paths used to send the InvoiceRequest.

See also Bolt12Invoice::signing_pubkey.

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

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

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 has_amount_msats(&self) -> bool

Returns whether an amount was set in the request; otherwise, if amount_msats is Some then it was inferred from the Offer::amount and quantity.

pub fn invoice_request_features(&self) -> &InvoiceRequestFeatures

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_signing_pubkey(&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 offer_from_hrn(&self) -> &Option<HumanReadableName>

If the Offer was sourced from a BIP 353 Human Readable Name, this should be set by the builder to indicate the original HumanReadableName which was resolved.

Trait Implementations

impl AsRef<TaggedHash> for UnsignedInvoiceRequest

fn as_ref(&self) -> &TaggedHash

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

impl Clone for UnsignedInvoiceRequest

fn clone(&self) -> UnsignedInvoiceRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl TryFrom<Vec<u8>> for UnsignedInvoiceRequest

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 UnsignedInvoiceRequest

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.