BlockbookClient
Defined in: wallet-btc/src/blockbook.ts:60
Blockbook REST transport (Trezor’s indexer; QuickNode’s Blockbook add-on speaks the same API).
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new BlockbookClient(
config,fetchFn?,timeoutMs?):BlockbookClient
Defined in: wallet-btc/src/blockbook.ts:65
Parameters
Section titled “Parameters”config
Section titled “config”string
fetchFn?
Section titled “fetchFn?”{(input, init?): Promise<Response>; (input, init?): Promise<Response>; }
timeoutMs?
Section titled “timeoutMs?”number = DEFAULT_TIMEOUT_MS
Returns
Section titled “Returns”BlockbookClient
Methods
Section titled “Methods”broadcast()
Section titled “broadcast()”broadcast(
rawTx):Promise<string>
Defined in: wallet-btc/src/blockbook.ts:151
Broadcast raw hex; returns the txid.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<string>
Implementation of
Section titled “Implementation of”close()
Section titled “close()”close():
Promise<void>
Defined in: wallet-btc/src/blockbook.ts:72
Returns
Section titled “Returns”Promise<void>
Implementation of
Section titled “Implementation of”connect()
Section titled “connect()”connect():
Promise<void>
Defined in: wallet-btc/src/blockbook.ts:71
Returns
Section titled “Returns”Promise<void>
Implementation of
Section titled “Implementation of”estimateFee()
Section titled “estimateFee()”estimateFee(
blocks):Promise<number>
Defined in: wallet-btc/src/blockbook.ts:159
sat/vB. Blockbook reports BTC/kB (×1e5 → sat/vB); falls back to mempool.space when it has no estimate.
Parameters
Section titled “Parameters”blocks
Section titled “blocks”number
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”getAddressPage()
Section titled “getAddressPage()”getAddressPage(
address,page?,pageSize?):Promise<BlockbookAddressPage>
Defined in: wallet-btc/src/blockbook.ts:113
One page of the address’s transactions, newest first, with inputs / outputs (what the activity history reads).
Parameters
Section titled “Parameters”address
Section titled “address”string
number = 1
pageSize?
Section titled “pageSize?”number = 25
Returns
Section titled “Returns”Promise<BlockbookAddressPage>
getBalance()
Section titled “getBalance()”getBalance(
address):Promise<{confirmed:bigint;unconfirmed:bigint;unconfirmedOutgoing:bigint; }>
Defined in: wallet-btc/src/blockbook.ts:89
Parameters
Section titled “Parameters”address
Section titled “address”string
Returns
Section titled “Returns”Promise<{ confirmed: bigint; unconfirmed: bigint; unconfirmedOutgoing: bigint; }>
Implementation of
Section titled “Implementation of”getBlockHeight()
Section titled “getBlockHeight()”getBlockHeight():
Promise<number>
Defined in: wallet-btc/src/blockbook.ts:173
Current chain tip height (anti-fee-sniping locktime). Optional.
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”getHistory()
Section titled “getHistory()”getHistory(
address):Promise<object[]>
Defined in: wallet-btc/src/blockbook.ts:101
Parameters
Section titled “Parameters”address
Section titled “address”string
Returns
Section titled “Returns”Promise<object[]>
Implementation of
Section titled “Implementation of”getTransaction()
Section titled “getTransaction()”getTransaction(
txid):Promise<string>
Defined in: wallet-btc/src/blockbook.ts:145
Raw transaction hex.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<string>
Implementation of
Section titled “Implementation of”getTransactionDetails()
Section titled “getTransactionDetails()”getTransactionDetails(
txid):Promise<BlockbookTxDetails|undefined>
Defined in: wallet-btc/src/blockbook.ts:122
A transaction with its inputs / outputs; undefined when Blockbook does not know it.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<BlockbookTxDetails | undefined>
getTransactionInfo()
Section titled “getTransactionInfo()”getTransactionInfo(
txid):Promise<BlockbookTx|undefined>
Defined in: wallet-btc/src/blockbook.ts:138
Full tx record (used for receipts).
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<BlockbookTx | undefined>
Implementation of
Section titled “Implementation of”listUnspent()
Section titled “listUnspent()”listUnspent(
address):Promise<Utxo[]>
Defined in: wallet-btc/src/blockbook.ts:95
Parameters
Section titled “Parameters”address
Section titled “address”string
Returns
Section titled “Returns”Promise<Utxo[]>