commonMain.com.lightspark.sdk.wallet.model.Deposit.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of wallet-sdk Show documentation
The Lightspark Wallet SDK for Kotlin and Java.
The newest version!
// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
@file:Suppress("ktlint:standard:max-line-length")

package com.lightspark.sdk.wallet.model

import com.lightspark.sdk.core.requester.Query
import com.lightspark.sdk.wallet.util.serializerFormat
import kotlin.jvm.JvmStatic
import kotlinx.datetime.Instant
import kotlinx.serialization.SerialName
import kotlinx.serialization.Serializable
import kotlinx.serialization.json.decodeFromJsonElement

/**
 * This object represents a Deposit made to a Lightspark node wallet. This operation occurs for any L1 funding transaction to the wallet. You can retrieve this object to receive detailed information about the deposit.
 * @param id The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque string.
 * @param createdAt The date and time when this transaction was initiated.
 * @param updatedAt The date and time when the entity was last updated.
 * @param status The current status of this transaction.
 * @param amount The amount of money involved in this transaction.
 * @param blockHeight The height of the block that included this transaction. This will be zero for unconfirmed transactions.
 * @param destinationAddresses The Bitcoin blockchain addresses this transaction was sent to.
 * @param resolvedAt The date and time when this transaction was completed or failed.
 * @param transactionHash The hash of this transaction, so it can be uniquely identified on the Lightning Network.
 * @param fees The fees that were paid by the wallet sending the transaction to commit it to the Bitcoin blockchain.
 * @param blockHash The hash of the block that included this transaction. This will be null for unconfirmed transactions.
 * @param numConfirmations The number of blockchain confirmations for this transaction in real time.
 */
@Serializable
@SerialName("Deposit")
data class Deposit(
    @SerialName("deposit_id")
    override val id: String,
    @SerialName("deposit_created_at")
    override val createdAt: Instant,
    @SerialName("deposit_updated_at")
    override val updatedAt: Instant,
    @SerialName("deposit_status")
    override val status: TransactionStatus,
    @SerialName("deposit_amount")
    override val amount: CurrencyAmount,
    @SerialName("deposit_block_height")
    override val blockHeight: Int,
    @SerialName("deposit_destination_addresses")
    override val destinationAddresses: List,
    @SerialName("deposit_resolved_at")
    override val resolvedAt: Instant? = null,
    @SerialName("deposit_transaction_hash")
    override val transactionHash: String? = null,
    @SerialName("deposit_fees")
    override val fees: CurrencyAmount? = null,
    @SerialName("deposit_block_hash")
    override val blockHash: String? = null,
    @SerialName("deposit_num_confirmations")
    override val numConfirmations: Int? = null,
) : OnChainTransaction, Transaction, Entity {
    companion object {
        @JvmStatic
        fun getDepositQuery(id: String): Query {
            return Query(
                queryPayload = """
query GetDeposit(${'$'}id: ID!) {
    entity(id: ${'$'}id) {
        ... on Deposit {
            ...DepositFragment
        }
    }
}

$FRAGMENT
""",
                variableBuilder = { add("id", id) },
            ) {
                val entity = requireNotNull(it["entity"]) { "Entity not found" }
                serializerFormat.decodeFromJsonElement(entity)
            }
        }

        const val FRAGMENT = """
fragment DepositFragment on Deposit {
    type: __typename
    deposit_id: id
    deposit_created_at: created_at
    deposit_updated_at: updated_at
    deposit_status: status
    deposit_resolved_at: resolved_at
    deposit_amount: amount {
        type: __typename
        currency_amount_original_value: original_value
        currency_amount_original_unit: original_unit
        currency_amount_preferred_currency_unit: preferred_currency_unit
        currency_amount_preferred_currency_value_rounded: preferred_currency_value_rounded
        currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
    }
    deposit_transaction_hash: transaction_hash
    deposit_fees: fees {
        type: __typename
        currency_amount_original_value: original_value
        currency_amount_original_unit: original_unit
        currency_amount_preferred_currency_unit: preferred_currency_unit
        currency_amount_preferred_currency_value_rounded: preferred_currency_value_rounded
        currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
    }
    deposit_block_hash: block_hash
    deposit_block_height: block_height
    deposit_destination_addresses: destination_addresses
    deposit_num_confirmations: num_confirmations
}"""
    }
}