Struct ServeStaticInvoice

pub struct ServeStaticInvoice {
    pub invoice: StaticInvoice,
    pub forward_invoice_request_path: BlindedMessagePath,
}

A request from an async recipient to a static invoice server that a StaticInvoice be provided in response to InvoiceRequests from payers.

Fields

invoice: StaticInvoice

The invoice that should be served by the static invoice server. Once this invoice has been persisted, the Responder accompanying this message should be used to send StaticInvoicePersisted to the recipient to confirm that the offer corresponding to the invoice is ready to receive async payments.

forward_invoice_request_path: BlindedMessagePath

If a static invoice server receives an InvoiceRequest for a StaticInvoice, they should also forward the InvoiceRequest to the async recipient so they can respond with a fresh Bolt12Invoice if the recipient is online at the time. Use this path to forward the InvoiceRequest to the async recipient.

This path’s BlindedMessagePath::introduction_node MUST be set to the static invoice server node or one of its peers. This is because, for DoS protection, invoice requests forwarded over this path are treated by the server node like any other onion message forward and the server will not directly connect to the introduction node if they are not already peers.

Trait Implementations

impl Clone for ServeStaticInvoice

fn clone(&self) -> ServeStaticInvoice

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ServeStaticInvoice

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

Formats the value using the given formatter.

impl OnionMessageContents for ServeStaticInvoice

fn tlv_type(&self) -> u64

Returns the TLV type identifying the message contents. MUST be >= 64.

fn msg_type(&self) -> &'static str

Returns the message type

impl Readable for ServeStaticInvoice

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

Reads a Self in from the given Read.

impl Writeable for ServeStaticInvoice

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

Writes self out to the given Writer.

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.

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

Writes self out to a Vec<u8>.