DID BTCR2 JS

Appearance

Class: EsploraProtocol ​

Defined in: packages/bitcoin/src/client/rest/protocol.ts:30

Sans-I/O Esplora REST API protocol.

Every method returns an HttpRequest descriptor — a plain object describing what to request — without performing any I/O. The caller is responsible for executing the request with an HTTP client of their choice and deserializing the response.

This mirrors the pattern used by the Rust esploda crate where Esplora methods return http::Request<()> objects.

Example ​

ts
const protocol = new EsploraProtocol({ host: 'https://mempool.space/api' });

// Build a request descriptor (no I/O)
const req = protocol.getTx('abc123...');

// Execute with any HTTP client
const res = await fetch(req.url, req);
const tx: RawTransactionRest = await res.json();

Constructors ​

Constructor ​

new EsploraProtocol(config): EsploraProtocol

Defined in: packages/bitcoin/src/client/rest/protocol.ts:34

Parameters ​

config ​

RestConfig

Returns ​

EsploraProtocol

Methods ​

getAddressInfo() ​

getAddressInfo(address): HttpRequest

Defined in: packages/bitcoin/src/client/rest/protocol.ts:143

GET /address/:address

Parameters ​

address ​

string

Returns ​

HttpRequest

getAddressTxs() ​

getAddressTxs(address): HttpRequest

Defined in: packages/bitcoin/src/client/rest/protocol.ts:121

GET /address/:address/txs

Parameters ​

address ​

string

Returns ​

HttpRequest

getAddressTxsChain() ​

getAddressTxsChain(address, lastSeenTxId?): HttpRequest

Defined in: packages/bitcoin/src/client/rest/protocol.ts:133

GET /address/:address/txs/chain[/:last_seen_txid]

Parameters ​

address ​

string

lastSeenTxId? ​

string

Returns ​

HttpRequest

getAddressTxsMempool() ​

getAddressTxsMempool(address): HttpRequest

Defined in: packages/bitcoin/src/client/rest/protocol.ts:127

GET /address/:address/txs/mempool

Parameters ​

address ​

string

Returns ​

HttpRequest

getAddressUtxos() ​

getAddressUtxos(address): HttpRequest

Defined in: packages/bitcoin/src/client/rest/protocol.ts:149

GET /address/:address/utxo

Parameters ​

address ​

string

Returns ​

HttpRequest

getBlock() ​

getBlock(blockhash): HttpRequest

Defined in: packages/bitcoin/src/client/rest/protocol.ts:108

GET /block/:blockhash

Parameters ​

blockhash ​

string

Returns ​

HttpRequest

getBlockHeight() ​

getBlockHeight(height): HttpRequest

Defined in: packages/bitcoin/src/client/rest/protocol.ts:114

GET /block-height/:height

Parameters ​

height ​

number

Returns ​

HttpRequest

getBlockTipHeight() ​

getBlockTipHeight(): HttpRequest

Defined in: packages/bitcoin/src/client/rest/protocol.ts:103

GET /blocks/tip/height

Returns ​

HttpRequest

getTx() ​

getTx(txid): HttpRequest

Defined in: packages/bitcoin/src/client/rest/protocol.ts:78

GET /tx/:txid

Parameters ​

txid ​

string

Returns ​

HttpRequest

getTxHex() ​

getTxHex(txid): HttpRequest

Defined in: packages/bitcoin/src/client/rest/protocol.ts:84

GET /tx/:txid/hex

Parameters ​

txid ​

string

Returns ​

HttpRequest

getTxRaw() ​

getTxRaw(txid): HttpRequest

Defined in: packages/bitcoin/src/client/rest/protocol.ts:90

GET /tx/:txid/raw

Parameters ​

txid ​

string

Returns ​

HttpRequest

postTx() ​

postTx(hex): HttpRequest

Defined in: packages/bitcoin/src/client/rest/protocol.ts:96

POST /tx

Parameters ​

hex ​

string

Returns ​

HttpRequest