data class CurrencyAmount(val originalValue: Long, val originalUnit: CurrencyUnit, val preferredCurrencyUnit: CurrencyUnit, val preferredCurrencyValueRounded: Long, val preferredCurrencyValueApprox: Float)

Represents the value and unit for an amount of currency.

CurrencyUnit

@Serializable(with = CurrencyUnitSerializer::class)

enum CurrencyUnit : Enum<CurrencyUnit>

CurrencyUnitSerializer

object CurrencyUnitSerializer : EnumSerializer<CurrencyUnit>

DeployWalletOutput

@Serializable

data class DeployWalletOutput(val wallet: Wallet)

Deposit

@Serializable

data class Deposit(val id: String, val createdAt: Instant, val updatedAt: Instant, val status: TransactionStatus, val amount: CurrencyAmount, val blockHeight: Int, val destinationAddresses: List<String>, val resolvedAt: Instant? = null, val transactionHash: String? = null, val fees: CurrencyAmount? = null, val blockHash: String? = null, val numConfirmations: Int? = null) : OnChainTransaction, Transaction, Entity

The transaction on Bitcoin blockchain to fund the Lightspark node's wallet.

Entity

interface Entity

This interface is used by all the entities in the Lightspark systems. It defines a few core fields that are available everywhere. Any object that implements this interface can be queried using the entity query and its ID.

EntityId

@Serializable

data class EntityId(val id: String)

FeeEstimate

@Serializable

data class FeeEstimate(val feeFast: CurrencyAmount, val feeMin: CurrencyAmount)

IncomingPayment

@Serializable

data class IncomingPayment(val id: String, val createdAt: Instant, val updatedAt: Instant, val status: TransactionStatus, val amount: CurrencyAmount, val resolvedAt: Instant? = null, val transactionHash: String? = null, val paymentRequestId: EntityId? = null) : LightningTransaction, Transaction, Entity

A transaction that was sent to a Lightspark node on the Lightning Network.

InitializeWalletInput

@Serializable

data class InitializeWalletInput(val signingPublicKey: KeyInput)

InitializeWalletOutput

@Serializable

data class InitializeWalletOutput(val wallet: Wallet)

Invoice

@Serializable

data class Invoice(val id: String, val createdAt: Instant, val updatedAt: Instant, val data: InvoiceData, val status: PaymentRequestStatus, val amountPaid: CurrencyAmount? = null) : PaymentRequest, Entity

This object represents a BOLT #11 invoice (https://github.com/lightning/bolts/blob/master/11-payment-encoding.md) initiated by a Lightspark Node.

InvoiceData

@Serializable

data class InvoiceData(val encodedPaymentRequest: String, val bitcoinNetwork: BitcoinNetwork, val paymentHash: String, val amount: CurrencyAmount, val createdAt: Instant, val expiresAt: Instant, val memo: String? = null) : PaymentRequestData

This object represents the BOLT #11 invoice protocol for Lightning Payments. See https://github.com/lightning/bolts/blob/master/11-payment-encoding.md.

InvoiceType

@Serializable(with = InvoiceTypeSerializer::class)

enum InvoiceType : Enum<InvoiceType>

InvoiceTypeSerializer

object InvoiceTypeSerializer : EnumSerializer<InvoiceType>

KeyInput

@Serializable

data class KeyInput(val publicKey: String)

KeyType

@Serializable(with = KeyTypeSerializer::class)

enum KeyType : Enum<KeyType>

KeyTypeSerializer

object KeyTypeSerializer : EnumSerializer<KeyType>

LightningFeeEstimateForInvoiceInput

@Serializable

data class LightningFeeEstimateForInvoiceInput(val encodedPaymentRequest: String, val amountMsats: Long? = null)

LightningFeeEstimateForNodeInput

@Serializable

data class LightningFeeEstimateForNodeInput(val destinationNodePublicKey: String, val amountMsats: Long)

LightningFeeEstimateOutput

@Serializable

data class LightningFeeEstimateOutput(val feeEstimate: CurrencyAmount)

LightningTransaction

interface LightningTransaction : Transaction, Entity

LoginWithJWTInput

@Serializable

data class LoginWithJWTInput(val accountId: String, val jwt: String)

LoginWithJWTOutput

@Serializable

data class LoginWithJWTOutput(val accessToken: String, val wallet: Wallet, val validUntil: Instant)

OnChainTransaction

interface OnChainTransaction : Transaction, Entity

Transaction happened on Bitcoin blockchain.

OutgoingPayment

@Serializable

data class OutgoingPayment(val id: String, val createdAt: Instant, val updatedAt: Instant, val status: TransactionStatus, val amount: CurrencyAmount, val resolvedAt: Instant? = null, val transactionHash: String? = null, val fees: CurrencyAmount? = null, val paymentRequestData: PaymentRequestData? = null, val failureReason: PaymentFailureReason? = null, val failureMessage: RichText? = null) : LightningTransaction, Transaction, Entity

A transaction that was sent from a Lightspark node on the Lightning Network.

PageInfo

@Serializable

data class PageInfo(val hasNextPage: Boolean? = null, val hasPreviousPage: Boolean? = null, val startCursor: String? = null, val endCursor: String? = null)

PayInvoiceInput

@Serializable

data class PayInvoiceInput(val encodedInvoice: String, val timeoutSecs: Int, val maximumFeesMsats: Long, val amountMsats: Long? = null)

PayInvoiceOutput

@Serializable

data class PayInvoiceOutput(val paymentId: EntityId)

PaymentFailureReason

@Serializable(with = PaymentFailureReasonSerializer::class)

enum PaymentFailureReason : Enum<PaymentFailureReason>

PaymentFailureReasonSerializer

object PaymentFailureReasonSerializer : EnumSerializer<PaymentFailureReason>

PaymentRequest

interface PaymentRequest : Entity

PaymentRequestData

interface PaymentRequestData

The interface of a payment request on the Lightning Network (a.k.a. Lightning Invoice).

PaymentRequestStatus

@Serializable(with = PaymentRequestStatusSerializer::class)

enum PaymentRequestStatus : Enum<PaymentRequestStatus>

PaymentRequestStatusSerializer

object PaymentRequestStatusSerializer : EnumSerializer<PaymentRequestStatus>

RequestWithdrawalInput

@Serializable

data class RequestWithdrawalInput(val bitcoinAddress: String, val amountSats: Long)

RequestWithdrawalOutput

@Serializable

data class RequestWithdrawalOutput(val requestId: EntityId)

RichText

@Serializable

data class RichText(val text: String)

SendPaymentInput

@Serializable

data class SendPaymentInput(val destinationPublicKey: String, val timeoutSecs: Int, val amountMsats: Long, val maximumFeesMsats: Long)

SendPaymentOutput

@Serializable

data class SendPaymentOutput(val paymentId: EntityId)

TerminateWalletOutput

@Serializable

data class TerminateWalletOutput(val wallet: Wallet)

Transaction

interface Transaction : Entity

TransactionStatus

@Serializable(with = TransactionStatusSerializer::class)

enum TransactionStatus : Enum<TransactionStatus>

TransactionStatusSerializer

object TransactionStatusSerializer : EnumSerializer<TransactionStatus>

TransactionType

@Serializable(with = TransactionTypeSerializer::class)

enum TransactionType : Enum<TransactionType>

TransactionTypeSerializer

object TransactionTypeSerializer : EnumSerializer<TransactionType>

Wallet

@Serializable

data class Wallet(val id: String, val createdAt: Instant, val updatedAt: Instant, val status: WalletStatus, val balances: Balances? = null) : Entity

WalletStatus

@Serializable(with = WalletStatusSerializer::class)

enum WalletStatus : Enum<WalletStatus>

WalletStatusSerializer

object WalletStatusSerializer : EnumSerializer<WalletStatus>

WalletToPaymentRequestsConnection

@Serializable

data class WalletToPaymentRequestsConnection(val pageInfo: PageInfo, val count: Int, val entities: List<PaymentRequest>)

WalletToTransactionsConnection

@Serializable

data class WalletToTransactionsConnection(val pageInfo: PageInfo, val count: Int, val entities: List<Transaction>)

Withdrawal

@Serializable

data class Withdrawal(val id: String, val createdAt: Instant, val updatedAt: Instant, val status: TransactionStatus, val amount: CurrencyAmount, val blockHeight: Int, val destinationAddresses: List<String>, val resolvedAt: Instant? = null, val transactionHash: String? = null, val fees: CurrencyAmount? = null, val blockHash: String? = null, val numConfirmations: Int? = null) : OnChainTransaction, Transaction, Entity

The transaction on the Bitcoin blockchain to withdraw funds from the Lightspark node to a Bitcoin wallet.

WithdrawalRequest

@Serializable

data class WithdrawalRequest(val id: String, val createdAt: Instant, val updatedAt: Instant, val amount: CurrencyAmount, val bitcoinAddress: String, val status: WithdrawalRequestStatus, val estimatedAmount: CurrencyAmount? = null, val completedAt: Instant? = null, val withdrawalId: EntityId? = null) : Entity

WithdrawalRequestStatus

@Serializable(with = WithdrawalRequestStatusSerializer::class)

enum WithdrawalRequestStatus : Enum<WithdrawalRequestStatus>

WithdrawalRequestStatusSerializer

object WithdrawalRequestStatusSerializer : EnumSerializer<WithdrawalRequestStatus>