1.2.0

bdk-jvm/org.bitcoindevkit/EsploraClient

EsploraClient

open class EsploraClient : Disposable, AutoCloseable, EsploraClientInterface(source)

Wrapper around an esplora_client::BlockingClient which includes an internal in-memory transaction cache to avoid re-fetching already downloaded transactions.

Constructors

constructor(pointer: Pointer)

constructor(noPointer: NoPointer)

This constructor can be used to instantiate a fake object. Only used for tests. Any attempt to actually use an object constructed this way will fail as there is no connected Rust object.

constructor(url: String, proxy: String? = null)

Creates a new bdk client from an esplora_client::BlockingClient. Optional: Set the proxy of the builder.

Types

object Companion

Functions

open override fun broadcast(transaction: Transaction)

Broadcast a `Transaction` to Esplora.

open override fun close()

open override fun destroy()

open override fun fullScan(request: FullScanRequest, stopGap: ULong, parallelRequests: ULong): Update

Scan keychain scripts for transactions against Esplora, returning an update that can be applied to the receiving structures.

open override fun getBlockHash(blockHeight: UInt): String

Get the `BlockHash` of a specific block height.

getFeeEstimates

open override fun getFeeEstimates(): Map<UShort, Double>

Get a map where the key is the confirmation target (in number of blocks) and the value is the estimated feerate (in sat/vB).

open override fun getHeight(): UInt

Get the height of the current blockchain tip.

open override fun getTx(txid: String): Transaction?

Get a `Transaction` option given its `Txid`.

open override fun getTxInfo(txid: String): Tx?

Get transaction info given its `Txid`.

open override fun getTxStatus(txid: String): TxStatus

Get the status of a `Transaction` given its `Txid`.

open override fun sync(request: SyncRequest, parallelRequests: ULong): Update

Sync a set of scripts, txids, and/or outpoints against Esplora.

uniffiClonePointer

fun uniffiClonePointer(): Pointer