LN-Invoice/app.cash.lninvoice/PaymentRequest

PaymentRequest

data class PaymentRequest(val network: Network, val timestamp: Instant, val amount: Option<BitcoinAmount> = None, val paymentHash: String, val taggedFields: List<TaggedField> = emptyList(), val signature: ByteString, val hash: ByteString)(source)

A request for payment, as per BOLT-11

Constructors

constructor(network: Network, timestamp: Instant, amount: Option<BitcoinAmount> = None, paymentHash: String, taggedFields: List<TaggedField> = emptyList(), signature: ByteString, hash: ByteString)

Types

object Companion

Properties

val amount: Option<BitcoinAmount>

The optional amount that this request is asking for

val description: Option<String>

Short description of purpose of payment (UTF-8), e.g. '1 cup of coffee' or 'ナンセンス 1杯'

descriptionHash

val descriptionHash: Option<String>

SHA2 256-bit hash of the original description. Usually set when the description is too long to store in the invoice itself.

val expiry: Duration

Expiry time as defined in tagged fields. Default is 1 hour if no duration tag is present

val hash: ByteString

Checksum for this request

val network: Network

In which Bitcoin network this request is valid

payeeNodePublicKey

val payeeNodePublicKey: ByteString

Recovers the payee node public key from the signature

val paymentHash: String

Hash of the request pre-image

val signature: ByteString

Signature provided by the requesting node

val taggedFields: List<TaggedField>

List of all the raw tagged fields in the request

val timestamp: Instant

When the request was created