Enum OffersContext

pub enum OffersContext {
    InvoiceRequest {
        nonce: Nonce,
    },
    StaticInvoiceRequested {
        recipient_id: Vec<u8>,
        invoice_slot: u16,
        path_absolute_expiry: Duration,
    },
    OutboundPayment {
        payment_id: PaymentId,
        nonce: Nonce,
    },
    InboundPayment {
        payment_hash: PaymentHash,
    },
}

Contains data specific to an OffersMessage.

Variants

InvoiceRequest

Context used by a BlindedMessagePath within an Offer.

This variant is intended to be received when handling an InvoiceRequest.

Fields

nonce: Nonce

A nonce used for authenticating that an InvoiceRequest is for a valid Offer and for deriving the offer’s signing keys.

StaticInvoiceRequested

Context used by a BlindedMessagePath within the Offer of an async recipient.

This variant is received by the static invoice server when handling an InvoiceRequest on behalf of said async recipient.

Fields

recipient_id: Vec<u8>

An identifier for the async recipient for whom we as a static invoice server are serving StaticInvoices. Used paired with the OffersContext::StaticInvoiceRequested::invoice_slot when looking up a corresponding StaticInvoice to return to the payer if the recipient is offline. This id was previously provided via AsyncPaymentsContext::ServeStaticInvoice::recipient_id.

Also useful for rate limiting the number of InvoiceRequests we will respond to on recipient’s behalf.

invoice_slot: u16

The slot number for a specific StaticInvoice that the recipient previously requested be served on their behalf. Useful when paired with the OffersContext::StaticInvoiceRequested::recipient_id to pull that specific invoice from the database when payers send an InvoiceRequest. This id was previously provided via AsyncPaymentsContext::ServeStaticInvoice::invoice_slot.

path_absolute_expiry: Duration

The time as duration since the Unix epoch at which this path expires and messages sent over it should be ignored.

Useful to timeout async recipients that are no longer supported as clients.

OutboundPayment

Context used by a BlindedMessagePath within a Refund or as a reply path for an InvoiceRequest.

This variant is intended to be received when handling a Bolt12Invoice or an InvoiceError.

Fields

payment_id: PaymentId

Payment ID used when creating a Refund or InvoiceRequest.

nonce: Nonce

A nonce used for authenticating that a Bolt12Invoice is for a valid Refund or InvoiceRequest and for deriving their signing keys.

InboundPayment

Context used by a BlindedMessagePath as a reply path for a Bolt12Invoice.

This variant is intended to be received when handling an InvoiceError.

Fields

payment_hash: PaymentHash

The same payment hash as Bolt12Invoice::payment_hash.

Trait Implementations

impl Clone for OffersContext

fn clone(&self) -> OffersContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OffersContext

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

Formats the value using the given formatter.

impl PartialEq for OffersContext

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

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

Reads a Self in from the given Read.

impl Writeable for OffersContext

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.

impl Eq for OffersContext

impl StructuralPartialEq for OffersContext