Class EsploraClient

java.lang.Object

com.codename1.crypto.rpc.EsploraClient

public class EsploraClient
extends Object

A Bitcoin client for the Esplora REST API, which Blockstream and mempool.space run in public and anyone can self-host: unspent outputs, balances, fee estimates and broadcasting.

EsploraClient btc = new EsploraClient(new NetworkTransport(), EsploraClient.MEMPOOL_TESTNET);
BitcoinAddress address = BitcoinAddress.parse("tb1qw508d6qejxtdg4y5r3zarvary0c5xw7kxpjzsx",
        BitcoinNetwork.TESTNET);
List<EsploraClient.Utxo> coins = btc.getUtxos(address);
double satPerVbyte = btc.getFeeEstimates().get("6");
BitcoinTransaction signed = new BitcoinTransaction();   // signed through a Psbt
String txid = btc.broadcast(signed);

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	EsploraClient.Utxo	An unspent output.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BLOCKSTREAM_MAINNET	Blockstream, mainnet.
static final String	MEMPOOL_MAINNET	mempool.space, mainnet.
static final String	MEMPOOL_SIGNET	mempool.space, signet.
static final String	MEMPOOL_TESTNET	mempool.space, testnet4.

Constructor Summary

Constructors

Constructor	Description
EsploraClient(RpcTransport transport, String baseUrl)	A client for an Esplora base URL, such as MEMPOOL_MAINNET.

Method Summary

Modifier and Type	Method	Description
String	broadcast(BitcoinTransaction signed)	Broadcasts a signed transaction, answering its txid.
long[]	getBalance(BitcoinAddress address)	The balance of an address in satoshis: {confirmed, unconfirmed}, the second the net effect of mempool transactions and possibly negative.
long	getConfirmationHeight(String txid)	Whether a transaction is confirmed, and at what height: -1 while it is in the mempool.
Map<String,Double>	getFeeEstimates()	Fee estimates in sat/vB keyed by confirmation target in blocks ("1", "3", "6", "144" and the others the server answers).
long	getTipHeight()	The height of the chain tip.
BitcoinTransaction	getTransaction(String txid)	A transaction by id.
List<EsploraClient.Utxo>	getUtxos(BitcoinAddress address)	The unspent outputs paying an address, confirmed and in the mempool.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

MEMPOOL_MAINNET

public static final String MEMPOOL_MAINNET

mempool.space, mainnet.

See Also:

• Constant Field Values

MEMPOOL_TESTNET

public static final String MEMPOOL_TESTNET

mempool.space, testnet4.

See Also:

• Constant Field Values

MEMPOOL_SIGNET

public static final String MEMPOOL_SIGNET

mempool.space, signet.

See Also:

• Constant Field Values

BLOCKSTREAM_MAINNET

public static final String BLOCKSTREAM_MAINNET

Blockstream, mainnet.

See Also:

• Constant Field Values

Constructor Details

EsploraClient

public EsploraClient(RpcTransport transport,
 String baseUrl)

A client for an Esplora base URL, such as MEMPOOL_MAINNET.

Method Details

getUtxos

public List<EsploraClient.Utxo> getUtxos(BitcoinAddress address)
                                  throws IOException

The unspent outputs paying an address, confirmed and in the mempool.

Throws:

IOException

getBalance

public long[] getBalance(BitcoinAddress address)
                  throws IOException

The balance of an address in satoshis: {confirmed, unconfirmed}, the second the net effect of mempool transactions and possibly negative.

Throws:

IOException

getFeeEstimates

public Map<String,Double> getFeeEstimates()
                                   throws IOException

Fee estimates in sat/vB keyed by confirmation target in blocks ("1", "3", "6", "144" and the others the server answers).

Throws:

IOException

getTipHeight

public long getTipHeight()
                  throws IOException

The height of the chain tip.

Throws:

IOException

getTransaction

public BitcoinTransaction getTransaction(String txid)
                                  throws IOException

A transaction by id.

Throws:

IOException

getConfirmationHeight

public long getConfirmationHeight(String txid)
                           throws IOException

Whether a transaction is confirmed, and at what height: -1 while it is in the mempool.

Throws:

IOException

broadcast

public String broadcast(BitcoinTransaction signed)
                 throws IOException

Broadcasts a signed transaction, answering its txid.

Throws:

IOException