PaymentData

data class PaymentData(secret: ByteVector32, totalAmount: MilliSatoshi) : OnionPaymentPayloadTlv
Content copied to clipboard

Bolt 11 payment details (only included for the last node).

Parameters

secret

payment secret specified in the Bolt 11 invoice.

totalAmount

total amount in multi-part payments. When missing, assumed to be equal to AmountToForward.

Constructors

PaymentData
Link copied to clipboard
common
fun PaymentData(secret: ByteVector32, totalAmount: MilliSatoshi)
Content copied to clipboard

Types

Companion
Link copied to clipboard
common
object Companion : TlvValueReader<OnionPaymentPayloadTlv.PaymentData>
Content copied to clipboard

Functions

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

Properties

secret
Link copied to clipboard
common
val secret: ByteVector32
Content copied to clipboard
tag
Link copied to clipboard
common
open override val tag: Long
Content copied to clipboard

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.

totalAmount
Link copied to clipboard
common
val totalAmount: MilliSatoshi
Content copied to clipboard