LN-Invoice/app.cash.lninvoice

Package-level declarations

Types

data class Bech32Data(val encoding: Bech32Data.Companion.Encoding, val hrp: String, val payload: ByteString)

Represents bech32 encoded data.

data class BitcoinAmount(val satoshi: Long, val picoRemainder: Int = 0)

A quantity of Bitcoin, internally denominated in satoshi, with a pico-btc remainder

class BitReader(data: ByteString)

enum FieldTags : Enum<FieldTags>

InvalidChecksum

data class InvalidChecksum(val sum: Int) : Exception

data class InvalidInvoice(val message: String, val cause: Throwable? = null) : Throwable

enum Network : Enum<Network>

Represents allowed bitcoin networks as defined by SLIP-0173.

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)

A request for payment, as per BOLT-11

data class TaggedField(val tag: Int, val size: Int, val data: ByteString)

UnknownNetworkException

class UnknownNetworkException(network: String) : Throwable

Functions

MilliSatBitcoinAmount

fun MilliSatBitcoinAmount(milliSats: Long): BitcoinAmount

A BitcoinAmount representing the given millisat value (100,000,000,000 msat per btc)

PicoBitcoinAmount

fun PicoBitcoinAmount(picoBtc: Long): BitcoinAmount

A BitcoinAmount representing the given pico btc value (1,000,000,000,000 pico per btc)

fun String.toBech32Data(): ErrorOr<Bech32Data>

toBitcoinAmount

fun BigDecimal.toBitcoinAmount(): BitcoinAmount

Create a BitcoinAmount from the amount in BTC. Amounts below pico are truncated, not rounded.