Class ElectrumExplorer

Implements

Explorer

Index

Constructors

Methods

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

Constructors

constructor

new ElectrumExplorer(
    __namedParameters?: {
        host?: string;
        port?: number;
        protocol?: "tcp" | "ssl";
        network?: Network;
        irrevConfThresh?: number;
        maxTxPerScriptPubKey?: number;
        timeout?: number;
    },
): ElectrumExplorer
Parameters
- __namedParameters: {
      host?: string;
      port?: number;
      protocol?: "tcp" | "ssl";
      network?: Network;
      irrevConfThresh?: number;
      maxTxPerScriptPubKey?: number;
      timeout?: number;
  } = {}
Returns ElectrumExplorer
- Defined in electrum.ts:95

Methods

connect

connect(): Promise<void>
Implements Explorer#connect.

Returns Promise<void>
Implementation of Explorer.connect
- Defined in electrum.ts:145

fetchBlockStatus

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

isConnected

isConnected(): Promise<boolean>
Implements Explorer#isConnected. Checks server connectivity by sending a ping. Returns true if the ping is successful, otherwise false.

Returns Promise<boolean>
Implementation of Explorer.isConnected
- Defined in electrum.ts:257

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 electrum.ts:267

close

close(): void
Implements Explorer#close.

Returns void
Implementation of Explorer.close
- Defined in electrum.ts:274

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 electrum.ts:327

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 electrum.ts:340

fetchFeeEstimates

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

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

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 electrum.ts:417

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 electrum.ts:432

fetchTx

fetchTx(txId: string): Promise<string>
Fetches raw transaction data for a given transaction ID from an Electrum 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 electrum.ts:489

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 electrum.ts:506

Class ElectrumExplorer

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns ElectrumExplorer

Methods

connect

Returns Promise<void>

fetchBlockStatus

Parameters

Returns Promise<BlockStatus | undefined>

isConnected

Returns Promise<boolean>

isClosed

Returns boolean

close

Returns void

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

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

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