Class EsploraExplorer

Implements an Explorer Interface for an Esplora server.

Implements

Explorer

Index

Constructors

Methods

connect isConnected isClosed close fetchBlockStatus fetchAddressOrScriptHash fetchAddress fetchScriptHash fetchFeeEstimates fetchBlockHeight fetchTxHistory fetchTx push

Constructors

constructor

new EsploraExplorer(
    params?: {
        url?: string;
        irrevConfThresh?: number;
        maxTxPerScriptPubKey?: number;
        requestQueueParams?: RequestQueueParams;
        timeout?: number;
    },
): EsploraExplorer
Parameters
- params: {
      url?: string;
      irrevConfThresh?: number;
      maxTxPerScriptPubKey?: number;
      requestQueueParams?: RequestQueueParams;
      timeout?: number;
  } = {}
  - Optionalurl?: string
    Esplora's API url. Defaults to blockstream.info if service = ESPLORA.
  - OptionalirrevConfThresh?: number
  - OptionalmaxTxPerScriptPubKey?: number
  - OptionalrequestQueueParams?: RequestQueueParams
  - Optionaltimeout?: number
Returns EsploraExplorer
- Defined in esplora.ts:45

Methods

connect

connect(): Promise<void>
Connect to the server.

Returns Promise<void>
Implementation of Explorer.connect
- Defined in esplora.ts:128

isConnected

isConnected(): Promise<boolean>
Implements Explorer#isConnected. Checks server connectivity by attempting to fetch the current block height. Returns true if successful, otherwise false.

Returns Promise<boolean>
Implementation of Explorer.isConnected
- Defined in esplora.ts:137

isClosed

isClosed(): boolean
Returns true if connect has never been called or if close() was called after a connect().

Returns boolean
Implementation of Explorer.isClosed
- Defined in esplora.ts:144

close

close(): void
Close the connection.

Returns void
Implementation of Explorer.close
- Defined in esplora.ts:147

fetchBlockStatus

fetchBlockStatus(blockHeight: number): Promise<BlockStatus | undefined>
Implements Explorer#fetchBlockStatus.
Parameters
- blockHeight: number
Returns Promise<BlockStatus | undefined>
Implementation of Explorer.fetchBlockStatus
- Defined in esplora.ts:155

fetchAddressOrScriptHash

fetchAddressOrScriptHash(
    __namedParameters: { address?: string; scriptHash?: string },
): Promise<
    {
        balance: number;
        txCount: number;
        unconfirmedBalance: number;
        unconfirmedTxCount: number;
    },
>
Parameters
- __namedParameters: { address?: string; scriptHash?: string }
Returns Promise<
    {
        balance: number;
        txCount: number;
        unconfirmedBalance: number;
        unconfirmedTxCount: number;
    },
>
- Defined in esplora.ts:183

fetchAddress

fetchAddress(
    address: string,
): Promise<
    {
        balance: number;
        txCount: number;
        unconfirmedBalance: number;
        unconfirmedTxCount: number;
    },
>
Implements Explorer#fetchAddress.
Parameters
- address: string
Returns Promise<
    {
        balance: number;
        txCount: number;
        unconfirmedBalance: number;
        unconfirmedTxCount: number;
    },
>
Implementation of Explorer.fetchAddress
- Defined in esplora.ts:244

fetchScriptHash

fetchScriptHash(
    scriptHash: string,
): Promise<
    {
        balance: number;
        txCount: number;
        unconfirmedBalance: number;
        unconfirmedTxCount: number;
    },
>
Implements Explorer#fetchScriptHash.
Parameters
- scriptHash: string
Returns Promise<
    {
        balance: number;
        txCount: number;
        unconfirmedBalance: number;
        unconfirmedTxCount: number;
    },
>
Implementation of Explorer.fetchScriptHash
- Defined in esplora.ts:256

fetchFeeEstimates

fetchFeeEstimates(): Promise<Record<string, number>>
Implements Explorer#fetchFeeEstimates.

Returns Promise<Record<string, number>>
Implementation of Explorer.fetchFeeEstimates
- Defined in esplora.ts:268

fetchBlockHeight

fetchBlockHeight(): Promise<number>
Implements Explorer#fetchBlockHeight. Get's current block height.

Returns Promise<number>
A number representing the current height.
Implementation of Explorer.fetchBlockHeight
- Defined in esplora.ts:281

fetchTxHistory

fetchTxHistory(
__namedParameters: { address?: string; scriptHash?: string },
): Promise<{ txId: string; blockHeight: number; irreversible: boolean }[]>
Fetches the transaction history for a given address or script hash from an Esplora server. See interface.ts
Parameters
- __namedParameters: { address?: string; scriptHash?: string }
Returns Promise<{ txId: string; blockHeight: number; irreversible: boolean }[]>
Implementation of Explorer.fetchTxHistory
- Defined in esplora.ts:310

fetchTx

fetchTx(txId: string): Promise<string>
Fetches raw transaction data for a given transaction ID from an Esplora server.
Parameters
- txId: string
  The transaction ID to fetch data for.
Returns Promise<string>
A promise that resolves to the raw transaction data as a string.
Implementation of Explorer.fetchTx
- Defined in esplora.ts:388

push

push(txHex: string): Promise<string>
Push a raw Bitcoin transaction to the network.
Parameters
- txHex: string
  A raw Bitcoin transaction in hexadecimal string format.
Returns Promise<string>
The transaction ID (txId) if the transaction was broadcasted successfully.

Throws
If the transaction is invalid or fails to be broadcasted.
Implementation of Explorer.push
- Defined in esplora.ts:398

Class EsploraExplorer

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Optionalurl?: string

OptionalirrevConfThresh?: number

OptionalmaxTxPerScriptPubKey?: number

OptionalrequestQueueParams?: RequestQueueParams

Optionaltimeout?: number

Returns EsploraExplorer

Methods

connect

Returns Promise<void>

isConnected

Returns Promise<boolean>

isClosed

Returns boolean

close

Returns void

fetchBlockStatus

Parameters

Returns Promise<BlockStatus | undefined>

fetchAddressOrScriptHash

Parameters

Returns Promise< { balance: number; txCount: number; unconfirmedBalance: number; unconfirmedTxCount: number; },>

fetchAddress

Parameters

Returns Promise< { balance: number; txCount: number; unconfirmedBalance: number; unconfirmedTxCount: number; },>

fetchScriptHash

Parameters

Returns Promise< { balance: number; txCount: number; unconfirmedBalance: number; unconfirmedTxCount: number; },>

fetchFeeEstimates

Returns Promise<Record<string, number>>

fetchBlockHeight

Returns Promise<number>

fetchTxHistory

Parameters

Returns Promise<{ txId: string; blockHeight: number; irreversible: boolean }[]>

fetchTx

Parameters

Returns Promise<string>

push

Parameters

Returns Promise<string>

Throws

Settings

On This Page

`Optional`url?: string

`Optional`irrevConfThresh?: number

`Optional`maxTxPerScriptPubKey?: number

`Optional`requestQueueParams?: RequestQueueParams

`Optional`timeout?: number

Returns Promise<
{
balance: number;
txCount: number;
unconfirmedBalance: number;
unconfirmedTxCount: number;
},
>

Returns Promise<
{
balance: number;
txCount: number;
unconfirmedBalance: number;
unconfirmedTxCount: number;
},
>

Returns Promise<
{
balance: number;
txCount: number;
unconfirmedBalance: number;
unconfirmedTxCount: number;
},
>