libnexakotlin/org.nexa.libnexakotlin/ElectrumClient

ElectrumClient

class ElectrumClient(val chainSelector: ChainSelector, name: String, port: Int = DEFAULT_NEXA_SSL_ELECTRUM_PORT, logName: String = name + ":" + port, autostart: Boolean = true, useSSL: Boolean = true, connectTimeoutMs: Long = JsonRpc.CONNECT_TIMEOUT, accessTimeoutMs: Long = JsonRpc.ACCESS_TIMEOUT) : JsonRpc

Open a JSON-RPC over TCP connection to an Electrum X server

Constructors

ElectrumClient

constructor(chainSelector: ChainSelector, name: String, port: Int = DEFAULT_NEXA_SSL_ELECTRUM_PORT, logName: String = name + ":" + port, autostart: Boolean = true, useSSL: Boolean = true, connectTimeoutMs: Long = JsonRpc.CONNECT_TIMEOUT, accessTimeoutMs: Long = JsonRpc.ACCESS_TIMEOUT)

Types

AddressNotification

@Serializable

data class AddressNotification(val params: Array<String>)

AddressReply

@Serializable

data class AddressReply(val result: String?)

BalanceReply

@Serializable

data class BalanceReply(val result: ElectrumClient.BalanceResult)

BalanceResult

@Serializable

data class BalanceResult(val confirmed: Int = 0, val unconfirmed: Int = 0)

ErrorCodeMessage

@Serializable

data class ErrorCodeMessage(val code: Int, val message: String)

ErrorCodeReply

@Serializable

data class ErrorCodeReply(val error: ElectrumClient.ErrorCodeMessage, val id: Int, val jsonrpc: String)

ErrorReply

@Serializable

data class ErrorReply(val error: String)

FeaturesReply

@Serializable

data class FeaturesReply(val result: ElectrumClient.FeaturesResult)

FeaturesResult

@Serializable

data class FeaturesResult(val genesis_hash: String, val hash_function: String, val server_version: String, val protocol_max: String, val protocol_min: String, val pruning: Int? = null)

FirstUseReply

@Serializable

data class FirstUseReply(val result: ElectrumClient.FirstUseResult)

FirstUseResult

@Serializable

data class FirstUseResult(val block_hash: String? = null, val block_height: Int? = null, val tx_hash: String? = null)

GetHistoryReply

@Serializable

data class GetHistoryReply(val result: List<ElectrumClient.GetHistoryResult>)

GetHistoryResult

@Serializable

data class GetHistoryResult(val height: Int, val tx_hash: String)

GetTokenHistoryReply

@Serializable

data class GetTokenHistoryReply(val result: ElectrumClient.TokenHistoryWithCursor)

GetUtxoReply

@Serializable

data class GetUtxoReply(val result: ElectrumClient.GetUtxoResult)

GetUtxoResult

@Serializable

data class GetUtxoResult(val amount: Long, val height: Int, val scripthash: String, val status: String, val spent: ElectrumClient.GetUtxoSpentInfo, val group: String? = null, val group_quantity: Long? = null)

GetUtxoSpentInfo

@Serializable

data class GetUtxoSpentInfo(val height: Int?, val tx_hash: String?, val tx_pos: Int?)

HeaderNotification

@Serializable

data class HeaderNotification(val params: Array<ElectrumClient.HeaderResult>)

HeaderReply

@Serializable

data class HeaderReply(val result: ElectrumClient.HeaderResult)

HeaderResult

@Serializable

data class HeaderResult(val height: Long, val hex: String)

HeadersReply

@Serializable

data class HeadersReply(val result: ElectrumClient.HeadersResult)

HeadersResult

@Serializable

data class HeadersResult(val count: Int, val hex: String, val max: Int)

ListUnspentReply

@Serializable

data class ListUnspentReply(val result: Array<ElectrumClient.ListUnspentResult>)

ListUnspentResult

@Serializable

data class ListUnspentResult(val has_token: Boolean = false, val height: Int, val tx_pos: Int, val tx_hash: String, val outpoint_hash: String? = null, val value: Long)

StringReply

@Serializable

data class StringReply(val result: String)

TokenGenesisInfoReply

@Serializable

data class TokenGenesisInfoReply(val result: TokenGenesisInfo)

TokenGetBalanceReply

@Serializable

data class TokenGetBalanceReply(val result: ElectrumClient.TokenGetBalanceResult)

TokenGetBalanceResult

@Serializable

data class TokenGetBalanceResult(val confirmed: Map<String, Long>, val unconfirmed: Map<String, Long>, val cursor: String?)

TokenHistoryWithCursor

@Serializable

data class TokenHistoryWithCursor(val cursor: String?, val history: Array<ElectrumClient.GetHistoryResult>)

TokenListUnspentReply

@Serializable

data class TokenListUnspentReply(val result: ElectrumClient.TokenListUnspentResult)

TokenListUnspentResult

@Serializable

data class TokenListUnspentResult(val unspent: Array<ElectrumClient.UnspentInfo>, val cursor: String?)

UnspentInfo

@Serializable

data class UnspentInfo(val group: String, val height: Long, val outpoint_hash: String, val token_amount: Long, val token_id_hex: String, val tx_pos: Long, val value: Long, val tx_hash: String)

VersionReply

@Serializable

data class VersionReply(val result: List<String>)

Properties

accessTimeoutMs

val accessTimeoutMs: Long

bytesReceived

var bytesReceived: AtomicLong

chainSelector

val chainSelector: ChainSelector

json

val json: Json

logName

val logName: String

MY_VERSION

val MY_VERSION: List<String>

The version this electrum client supports

name

val name: String

nextAbortCheck

var nextAbortCheck: Long

notifications

val notifications: MutableMap<String, (String?) -> Unit>

open

var open: Boolean

outstanding

val outstanding: MutableMap<Int, JsonRpc.OutstandingReq>

port

val port: Int

reqId

var reqId: Int

requestTimeout

var requestTimeout: Int

how long to wait before giving up on a request

sock

var sock: iTcpSocket

useSSL

val useSSL: Boolean

Functions

abortAllOutstandingRequests

fun abortAllOutstandingRequests()

abortTimedOutRequests

fun abortTimedOutRequests()

call

fun call(method: String, params: List<Any?>?, timeoutInMs: Int): String?

fun call(method: String, params: List<Any?>?, timeoutInMs: Int = accessTimeoutMs.toInt(), response: (String?) -> Unit): Int

fun close(reason: String)

features

fun features(timeoutInMs: Int = requestTimeout): ElectrumClient.FeaturesResult

getBalance

fun getBalance(address: PayAddress, timeoutInMs: Int = requestTimeout): ElectrumClient.BalanceResult

getBchUtxo

fun getBchUtxo(hexTxHash: String, outIdx: Int, timeoutInMs: Int = requestTimeout): ElectrumClient.GetUtxoResult

getFirstUse

fun getFirstUse(scriptHash: String, timeoutInMs: Int = requestTimeout): ElectrumClient.FirstUseResult

fun getFirstUse(script: SatoshiScript, timeoutInMs: Int = requestTimeout): ElectrumClient.FirstUseResult

fun getFirstUse(scriptHash: Hash256, timeoutInMs: Int = requestTimeout): ElectrumClient.FirstUseResult

Get confirmed and unconfirmed activity in a script

getHeader

fun getHeader(height: Int, timeoutInMs: Int = requestTimeout): ByteArray

Get the serialized header for the block at the supplied height

getHeadersFor

fun getHeadersFor(cs: ChainSelector, height: Int, count: Int, timeoutInMs: Int = requestTimeout): List<iBlockHeader>

Return serialized headers for the blocks beginning at the supplied height

getHistory

fun getHistory(scriptHash: String, timeoutInMs: Int = requestTimeout): Array<Pair<Int, Hash256>>

fun getHistory(scriptHash: Hash256, timeoutInMs: Int = requestTimeout): Array<Pair<Int, Hash256>>

fun getHistory(script: SatoshiScript, timeoutInMs: Int = requestTimeout): Array<Pair<Int, Hash256>>

Get confirmed and unconfirmed activity in a script

fun getHistory(scriptHash: String, timeoutInMs: Int, cb: (Array<Pair<Int, Hash256>>?, ElectrumClient.ErrorCodeReply?) -> Unit): Int

Async callback gethistory function

getTip

fun getTip(timeoutInMs: Int = requestTimeout): Pair<iBlockHeader, Long>

Get the current blockchain tip

getTipBytes

fun getTipBytes(timeoutInMs: Int = requestTimeout): Pair<ByteArray, Long>

Get the current blockchain tip

getTokenBalance

fun getTokenBalance(address: String, timeoutInMs: Int = requestTimeout): ElectrumClient.TokenGetBalanceResult

fun getTokenBalance(address: PayAddress, timeoutInMs: Int = requestTimeout): ElectrumClient.TokenGetBalanceResult

getTokenGenesisInfo

fun getTokenGenesisInfo(tokenType: String, timeoutInMs: Int = requestTimeout*2): TokenGenesisInfo

fun getTokenGenesisInfo(tokenType: GroupId, timeoutInMs: Int = requestTimeout): TokenGenesisInfo

getTokenHistory

fun getTokenHistory(tokenId: String, cursor: String? = null, timeoutInMs: Int = requestTimeout): Array<Pair<Int, Hash256>>

fun getTokenHistory(tokenId: GroupId, cursor: String? = null, timeoutInMs: Int = requestTimeout): Array<Pair<Int, Hash256>>

Get confirmed and unconfirmed activity in a script

getTokenUnspent

fun getTokenUnspent(address: String, tokenId: String? = null, cursor: String? = null, timeoutInMs: Int = requestTimeout): ElectrumClient.TokenListUnspentResult

getTx

fun getTx(txHash: String, timeoutInMs: Int = requestTimeout): iTransaction

fun getTx(txHash: Hash256, timeoutInMs: Int = requestTimeout): iTransaction

Get a transaction by hash

fun getTx(txHash: String, timeoutInMs: Int = requestTimeout, cb: (iTransaction?, ElectrumClient.ErrorCodeReply?) -> Unit): Int

Async callback get transaction function. DO NOT BLOCK IN THE CALLBACK!

getTxAt

fun getTxAt(height: Int, idx: Int, blockMerkleRoot: Hash256? = null, timeoutInMs: Int = requestTimeout): iTransaction

Get the transaction at the specified block height and offset. Requires multiple server calls.

getTxDetails

fun getTxDetails(txHash: String, timeoutInMs: Int = requestTimeout): JsonElement

getTxHashAt

fun getTxHashAt(height: Int, idx: Int, blockMerkleRoot: Hash256? = null, timeoutInMs: Int = requestTimeout): Hash256

Get the transaction hash at the specified block height and offset.

getTxOld

fun ~~getTxOld~~(txHash: String, timeoutInMs: Int = requestTimeout): iTransaction

getUtxo

fun getUtxo(outpointHex: String, timeoutInMs: Int = requestTimeout): ElectrumClient.GetUtxoResult

fun getUtxo(inp: NexaTxInput, timeoutInMs: Int = requestTimeout): ElectrumClient.GetUtxoResult

fun getUtxo(inp: iTxOutpoint, timeoutInMs: Int = requestTimeout): ElectrumClient.GetUtxoResult

listUnspent

fun listUnspent(address: PayAddress, timeoutInMs: Int = requestTimeout): List<Spendable>

Get outputs for a pay destination you don't own.

fun listUnspent(destination: PayDestination, timeoutInMs: Int = requestTimeout): List<Spendable>

Get spendable output for a pay destination you own.

nextId

fun nextId(): Int

parse

fun <T> parse(method: String, params: List<String>?, serializer: KSerializer<T>, response: (T?) -> Unit)

ping

fun ping(timeoutInMs: Int = requestTimeout)

run

fun run()

sendTx

fun sendTx(serializedTx: ByteArray, timeoutInMs: Int = requestTimeout): String

Send out a transaction

start

fun start()

stop

fun stop()

fun subscribe(method: String, params: List<Any?>? = null, response: (String?) -> Unit)

subscribeAddressStatus

@ExperimentalUnsignedTypes

fun subscribeAddressStatus(address: String, callback: (String?) -> Unit)

As this is a subscription, the client will receive a notification when the status of the address changes. Its signature is blockchain.address.subscribe(address, status)

subscribeHeaders

fun subscribeHeaders(callback: (iBlockHeader) -> Unit)

Subscribe to blockchain headers. Issues a callback with the blockchain tip when a new block is found.

unsubscribeAddress

fun unsubscribeAddress(address: String)

Unsubscribes from blockchain headers.

unsubscribeHeaders

fun unsubscribeHeaders()

Unsubscribes from blockchain headers.

version

fun version(timeoutInMs: Int = requestTimeout): Pair<String, String>

Get the server version