Class EsploraExplorer

Implements an Explorer Interface for an Esplora server.

Hierarchy

EsploraExplorer

Implements

Explorer

Constructors

constructor

new EsploraExplorer(params?): EsploraExplorer
Parameters
- params: {
      url?: string;
      irrevConfThresh?: number;
      maxTxPerScriptPubKey?: number;
  } = {}
  - Optional url?: string
    Esplora's API url. Defaults to blockstream.info if service = ESPLORA.
  - Optional irrevConfThresh?: number
  - Optional maxTxPerScriptPubKey?: number
Returns EsploraExplorer
- Defined in esplora.ts:74

Properties

`Private` #irrevConfThresh

#irrevConfThresh: number

`Private` #BLOCK_HEIGHT_CACHE_TIME

#BLOCK_HEIGHT_CACHE_TIME: number = 3

`Private` #cachedTipBlockHeight

#cachedTipBlockHeight: number = 0

`Private` #tipBlockHeightCacheTime

#tipBlockHeightCacheTime: number = 0

`Private` #url

#url: string

`Private` #maxTxPerScriptPubKey

#maxTxPerScriptPubKey: number

`Private` #blockStatusMap

#blockStatusMap: Map<number, BlockStatus> = ...

Methods

connect

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

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

close

close(): Promise<void>
Close the connection.

Returns Promise<void>
Async
Implementation of Explorer.close
- Defined in esplora.ts:96

fetchBlockStatus

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

fetchAddressOrScriptHash

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

fetchAddress

fetchAddress(address): 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:192

fetchScriptHash

fetchScriptHash(scriptHash): 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:204

fetchFeeEstimates

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

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

fetchBlockHeight

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

Returns Promise<number>
A number representing the current height.

Async
Implementation of Explorer.fetchBlockHeight
- Defined in esplora.ts:228

`Private` #getTipBlockHeight

#getTipBlockHeight(blockHeight?): Promise<number>
Returns the height of the last block. It does not fetch it, unless either: fetched before more than #BLOCK_HEIGHT_CACHE_TIME ago the #cachedTipBlockHeight is behind the blockHeight passed as a param
Parameters
- Optional blockHeight: number
Returns Promise<number>
- Defined in esplora.ts:243

fetchTxHistory

fetchTxHistory(__namedParameters): 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;
  }
  - Optional address?: string
  - Optional scriptHash?: string
Returns Promise<{
    txId: string;
    blockHeight: number;
    irreversible: boolean;
}[]>
Implementation of Explorer.fetchTxHistory
- Defined in esplora.ts:257

fetchTx

fetchTx(txId): 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:335

push

push(txHex): 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.

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

Class EsploraExplorer

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

params: { url?: string; irrevConfThresh?: number; maxTxPerScriptPubKey?: number; } = {}

Optional url?: string

Optional irrevConfThresh?: number

Optional maxTxPerScriptPubKey?: number

Returns EsploraExplorer

Properties

Private #irrevConfThresh

Private #BLOCK_HEIGHT_CACHE_TIME

Private #cachedTipBlockHeight

Private #tipBlockHeightCacheTime

Private #url

Private #maxTxPerScriptPubKey

Private #blockStatusMap

Methods

connect

Returns Promise<void>

Async

close

Returns Promise<void>

Async

fetchBlockStatus

Parameters

blockHeight: number

Returns Promise<undefined | BlockStatus>

fetchAddressOrScriptHash

Parameters

__namedParameters: { address?: string; scriptHash?: string; }

Optional address?: string

Optional scriptHash?: string

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

fetchAddress

Parameters

address: string

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

fetchScriptHash

Parameters

scriptHash: string

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

fetchFeeEstimates

Returns Promise<Record<string, number>>

fetchBlockHeight

Returns Promise<number>

Async

Private #getTipBlockHeight

Parameters

Optional blockHeight: number

Returns Promise<number>

fetchTxHistory

Parameters

__namedParameters: { address?: string; scriptHash?: string; }

Optional address?: string

Optional scriptHash?: string

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

fetchTx

Parameters

txId: string

Returns Promise<string>

push

Parameters

txHex: string

Returns Promise<string>

Async

Throws

Settings

Member Visibility

Theme

On This Page

params: {
url?: string;
irrevConfThresh?: number;
maxTxPerScriptPubKey?: number;
} = {}

`Optional` url?: string

`Optional` irrevConfThresh?: number

`Optional` maxTxPerScriptPubKey?: number

`Private` #irrevConfThresh

`Private` #BLOCK_HEIGHT_CACHE_TIME

`Private` #cachedTipBlockHeight

`Private` #tipBlockHeightCacheTime

`Private` #url

`Private` #maxTxPerScriptPubKey

`Private` #blockStatusMap

__namedParameters: {
address?: string;
scriptHash?: string;
}

`Optional` address?: string

`Optional` scriptHash?: string

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;
}>

`Private` #getTipBlockHeight

`Optional` blockHeight: number

__namedParameters: {
address?: string;
scriptHash?: string;
}

`Optional` address?: string

`Optional` scriptHash?: string

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