Package fr.acinq.lightning.blockchain.electrum

Types

AddressStatus

common

data class AddressStatus(address: String, status: String?) : ElectrumResponse

AskForHeaderSubscriptionUpdate

common

object AskForHeaderSubscriptionUpdate : ElectrumSubscription

BroadcastTransaction

common

data class BroadcastTransaction(tx: Transaction) : ElectrumRequest

BroadcastTransactionResponse

common

data class BroadcastTransactionResponse(tx: Transaction, error: JsonRPCError?) : ElectrumResponse

ClientStateUpdate

common

class ClientStateUpdate(connection: Connection) : WatcherEvent

ElectrumClient

common

class ElectrumClient(socketBuilder: TcpSocket.Builder?, scope: CoroutineScope) : CoroutineScope

ElectrumMessage

common

sealed class ElectrumMessage

Common communication objects between ElectrumClient and external ressources (e.g. ElectrumWatcher) See the documentation for the ElectrumX protocol there: https://github.com/spesmilo/electrumx/

ElectrumRequest

common

sealed class ElectrumRequest

ElectrumClient requests / responses

ElectrumResponse

common

sealed class ElectrumResponse : ElectrumMessage

ElectrumResponseDeserializer

common

object ElectrumResponseDeserializer : KSerializer<Either<ElectrumResponse, JsonRPCResponse>>

ElectrumResponse deserializer

ElectrumSubscription

common

sealed class ElectrumSubscription : ElectrumMessage

ElectrumWatcher

common

class ElectrumWatcher(client: ElectrumClient, scope: CoroutineScope) : CoroutineScope

EstimateFeeResponse

common

data class EstimateFeeResponse(confirmations: Int, feerate: FeeratePerKw?) : ElectrumResponse

EstimateFees

common

data class EstimateFees(confirmations: Int) : ElectrumRequest

GetHeader

common

data class GetHeader(height: Int) : ElectrumRequest

GetHeaderResponse

common

data class GetHeaderResponse(height: Int, header: BlockHeader) : ElectrumResponse

GetHeaders

common

data class GetHeaders(start_height: Int, count: Int, cp_height: Int) : ElectrumRequest

GetHeadersResponse

common

data class GetHeadersResponse(start_height: Int, headers: List<BlockHeader>, max: Int) : ElectrumResponse

GetMerkle

common

data class GetMerkle(txid: ByteVector32, height: Int, contextOpt: Transaction?) : ElectrumRequest

GetMerkleResponse

common

data class GetMerkleResponse(txid: ByteVector32, merkle: List<ByteVector32>, block_height: Int, pos: Int, contextOpt: Transaction?) : ElectrumResponse

GetScriptHashHistory

common

data class GetScriptHashHistory(scriptHash: ByteVector32) : ElectrumRequest

GetScriptHashHistoryResponse

common

data class GetScriptHashHistoryResponse(scriptHash: ByteVector32, history: List<TransactionHistoryItem>) : ElectrumResponse

GetTransaction

common

data class GetTransaction(txid: ByteVector32, contextOpt: Any?) : ElectrumRequest

GetTransactionIdFromPosition

common

data class GetTransactionIdFromPosition(height: Int, tx_pos: Int, merkle: Boolean) : ElectrumRequest

GetTransactionIdFromPositionResponse

common

data class GetTransactionIdFromPositionResponse(txid: ByteVector32, height: Int, tx_pos: Int, merkle: List<ByteVector32>) : ElectrumResponse

GetTransactionResponse

common

data class GetTransactionResponse(tx: Transaction, contextOpt: Any?) : ElectrumResponse

GetTxWithMetaEvent

common

data class GetTxWithMetaEvent(request: GetTxWithMeta) : WatcherEvent

HeaderSubscription

common

object HeaderSubscription : ElectrumRequest

HeaderSubscriptionResponse

common

data class HeaderSubscriptionResponse(height: Int, header: BlockHeader) : ElectrumResponse

JsonRPCResponseDeserializer

common

class JsonRPCResponseDeserializer(json: Json) : KSerializer<JsonRPCResponse>

NotifyEvent

common

sealed class NotifyEvent

NotifyTxEvent

common

class NotifyTxEvent(channelId: ByteVector32, txWithMeta: GetTxWithMetaResponse) : NotifyEvent

NotifyUpToDateEvent

common

class NotifyUpToDateEvent(millis: Long) : NotifyEvent

NotifyWatchEvent

common

class NotifyWatchEvent(watchEvent: WatchEvent) : NotifyEvent

Ping

common

object Ping : ElectrumRequest

PingResponse

common

object PingResponse : ElectrumResponse

PublishAsapEvent

common

class PublishAsapEvent(tx: Transaction) : WatcherEvent

ReceivedMessage

common

class ReceivedMessage(message: ElectrumMessage) : WatcherEvent

ReceiveWatch

common

class ReceiveWatch(watch: Watch) : WatcherEvent

ReceiveWatchEvent

common

class ReceiveWatchEvent(watchEvent: WatchEvent) : WatcherEvent

RequestResponseTimestamp

common

data class RequestResponseTimestamp(id: Int, request: ElectrumRequest, lastResponseTimestamp: Long?)

ScriptHashListUnspent

common

data class ScriptHashListUnspent(scriptHash: ByteVector32) : ElectrumRequest

ScriptHashListUnspentResponse

common

data class ScriptHashListUnspentResponse(scriptHash: ByteVector32, unspents: List<UnspentItem>) : ElectrumResponse

ScriptHashSubscription

common

data class ScriptHashSubscription(scriptHash: ByteVector32) : ElectrumRequest

ScriptHashSubscriptionResponse

common

data class ScriptHashSubscriptionResponse(scriptHash: ByteVector32, status: String) : ElectrumResponse

SendElectrumRequest

common

data class SendElectrumRequest(electrumRequest: ElectrumRequest) : ElectrumMessage

ServerError

common

data class ServerError(request: ElectrumRequest, error: JsonRPCError) : ElectrumResponse

ServerVersion

common

data class ServerVersion(clientName: String, protocolVersion: String) : ElectrumRequest

ServerVersionResponse

common

data class ServerVersionResponse(clientName: String, protocolVersion: String) : ElectrumResponse

TransactionHistory

common

data class TransactionHistory(history: List<TransactionHistoryItem>) : ElectrumResponse

Other Electrum responses

TransactionHistoryItem

common

data class TransactionHistoryItem(height: Int, tx_hash: ByteVector32)

UnspentItem

common

data class UnspentItem(tx_hash: ByteVector32, tx_pos: Int, value: Long, height: Long)

WatcherEvent

common

sealed class WatcherEvent