PaymentMetadata

data class PaymentMetadata(data: ByteVector) : OnionPaymentPayloadTlv

When payment metadata is included in a Bolt 9 invoice, we should send it as-is to the recipient. This lets recipients generate invoices without having to store anything on their side until the invoice is paid.

Constructors

PaymentMetadata
Link copied to clipboard
common
fun PaymentMetadata(data: ByteVector)

Types

Companion
Link copied to clipboard
common

Functions

write
Link copied to clipboard
common
open fun write(): ByteArray
open override fun write(out: Output)

Properties

data
Link copied to clipboard
common
val data: ByteVector
tag
Link copied to clipboard
common
open override val tag: Long

TLV fields start with a tag that uniquely identifies the type of field within a specific namespace (usually a lightning message). See https://github.com/lightningnetwork/lightning-rfc/blob/master/01-messaging.md#type-length-value-format.