Class ElectrumExplorer

Hierarchy

ElectrumExplorer

Implements

Explorer

Constructors

constructor

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

Properties

`Private` #irrevConfThresh

#irrevConfThresh: number

`Private` #tipBlockHeight

#tipBlockHeight: number

`Private` #maxTxPerScriptPubKey

#maxTxPerScriptPubKey: number

`Private` #pingInterval

#pingInterval: undefined | Timeout

`Private` #client

#client: undefined | default

`Private` #blockStatusMap

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

`Private` #host

#host: string

`Private` #port

#port: number

`Private` #protocol

#protocol: string

`Private` #network

#network: Network

Methods

connect

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

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

fetchBlockStatus

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

close

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

Returns Promise<void>
Implementation of Explorer.close
- Defined in electrum.ts:225

`Private` #getClient

#getClient(): Promise<default>
Returns Promise<default>
- Defined in electrum.ts:234

`Private` #updateBlockStatusMap

#updateBlockStatusMap(blockHeight, headerHex): BlockStatus
Parameters
- blockHeight: number
- headerHex: string
Returns BlockStatus
- Defined in electrum.ts:245

`Private` #updateBlockTipHeight

#updateBlockTipHeight(header): void
Parameters
- header: {
  height: number;
  hex: string;
  }
  - height: number
  - hex: string
Returns void
- Defined in electrum.ts:263

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

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

fetchFeeEstimates

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

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

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

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

fetchTx

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

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

Class ElectrumExplorer

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

__namedParameters: { host?: string; port?: number; protocol?: "ssl" | "tcp"; network?: Network; irrevConfThresh?: number; maxTxPerScriptPubKey?: number; } = {}

Optional host?: string

Optional port?: number

Optional protocol?: "ssl" | "tcp"

Optional network?: Network

Optional irrevConfThresh?: number

Optional maxTxPerScriptPubKey?: number

Returns ElectrumExplorer

Properties

Private #irrevConfThresh

Private #tipBlockHeight

Private #maxTxPerScriptPubKey

Private #pingInterval

Private #client

Private #blockStatusMap

Private #host

Private #port

Private #protocol

Private #network

Methods

connect

Returns Promise<void>

fetchBlockStatus

Parameters

blockHeight: number

Returns Promise<undefined | BlockStatus>

close

Returns Promise<void>

Private #getClient

Returns Promise<default>

Private #updateBlockStatusMap

Parameters

blockHeight: number

headerHex: string

Returns BlockStatus

Private #updateBlockTipHeight

Parameters

header: { height: number; hex: string; }

height: number

hex: string

Returns void

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

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

__namedParameters: {
host?: string;
port?: number;
protocol?: "ssl" | "tcp";
network?: Network;
irrevConfThresh?: number;
maxTxPerScriptPubKey?: number;
} = {}

`Optional` host?: string

`Optional` port?: number

`Optional` protocol?: "ssl" | "tcp"

`Optional` network?: Network

`Optional` irrevConfThresh?: number

`Optional` maxTxPerScriptPubKey?: number

`Private` #irrevConfThresh

`Private` #tipBlockHeight

`Private` #maxTxPerScriptPubKey

`Private` #pingInterval

`Private` #client

`Private` #blockStatusMap

`Private` #host

`Private` #port

`Private` #protocol

`Private` #network

`Private` #getClient

`Private` #updateBlockStatusMap

`Private` #updateBlockTipHeight

header: {
height: number;
hex: string;
}

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

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

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

`Optional` address?: string

`Optional` scriptHash?: string

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