Enum AsyncPaymentsMessage

pub enum AsyncPaymentsMessage {
    OfferPathsRequest(OfferPathsRequest),
    OfferPaths(OfferPaths),
    ServeStaticInvoice(ServeStaticInvoice),
    StaticInvoicePersisted(StaticInvoicePersisted),
    HeldHtlcAvailable(HeldHtlcAvailable),
    ReleaseHeldHtlc(ReleaseHeldHtlc),
}

Possible async payment messages sent and received via an OnionMessage.

Variants

OfferPathsRequest(OfferPathsRequest)

A request from an async recipient for BlindedMessagePaths, sent to a static invoice server.

OfferPaths(OfferPaths)

BlindedMessagePaths to be included in an async recipient’s Offer::paths, sent by a static invoice server in response to an OfferPathsRequest.

ServeStaticInvoice(ServeStaticInvoice)

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

StaticInvoicePersisted(StaticInvoicePersisted)

Confirmation from a static invoice server that a StaticInvoice was persisted and the corresponding Offer is ready to be used to receive async payments. Sent to an async recipient in response to a ServeStaticInvoice message.

HeldHtlcAvailable(HeldHtlcAvailable)

An HTLC is being held upstream for the often-offline recipient, to be released via ReleaseHeldHtlc.

ReleaseHeldHtlc(ReleaseHeldHtlc)

Releases the HTLC corresponding to an inbound HeldHtlcAvailable message.

Implementations

impl AsyncPaymentsMessage

pub fn is_known_type(tlv_type: u64) -> bool

Returns whether tlv_type corresponds to a TLV record for async payment messages.

Trait Implementations

impl Clone for AsyncPaymentsMessage

fn clone(&self) -> AsyncPaymentsMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AsyncPaymentsMessage

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

Formats the value using the given formatter.

impl OnionMessageContents for AsyncPaymentsMessage

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 ReadableArgs<u64> for AsyncPaymentsMessage

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

Reads a Self in from the given Read.

impl Writeable for AsyncPaymentsMessage

fn write<W: Writer>(&self, w: &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.