Class EsploraProvider

Implementation of the onchain provider interface for esplora REST API.

See

Example

const provider = new EsploraProvider("https://mempool.space/api");
const utxos = await provider.getCoins("bcrt1q679zsd45msawvr7782r0twvmukns3drlstjt77");

Implements

OnchainProvider

Index

Constructors

constructor

Methods

broadcastTransaction getChainTip getCoins getFeeRate getTransactions getTxOutspends getTxStatus watchAddresses

Constructors

constructor

new EsploraProvider(baseUrl: string): EsploraProvider
Parameters
- baseUrl: string
Returns EsploraProvider
- Defined in src/providers/onchain.ts:60

Methods

broadcastTransaction

broadcastTransaction(...txs: string[]): Promise<string>
Parameters
- ...txs: string[]
Returns Promise<string>
Implementation of OnchainProvider.broadcastTransaction
- Defined in src/providers/onchain.ts:79

getChainTip

getChainTip(): Promise<{ hash: string; height: number; time: number }>
Returns Promise<{ hash: string; height: number; time: number }>
Implementation of OnchainProvider.getChainTip
- Defined in src/providers/onchain.ts:264

getCoins

getCoins(address: string): Promise<Coin[]>
Parameters
- address: string
Returns Promise<Coin[]>
Implementation of OnchainProvider.getCoins
- Defined in src/providers/onchain.ts:62

getFeeRate

getFeeRate(): Promise<undefined | number>
Returns Promise<undefined | number>
Implementation of OnchainProvider.getFeeRate
- Defined in src/providers/onchain.ts:70

getTransactions

getTransactions(address: string): Promise<ExplorerTransaction[]>
Parameters
- address: string
Returns Promise<ExplorerTransaction[]>
Implementation of OnchainProvider.getTransactions
- Defined in src/providers/onchain.ts:102

getTxOutspends

getTxOutspends(txid: string): Promise<{ spent: boolean; txid: string }[]>
Parameters
- txid: string
Returns Promise<{ spent: boolean; txid: string }[]>
Implementation of OnchainProvider.getTxOutspends
- Defined in src/providers/onchain.ts:90

getTxStatus

getTxStatus(
    txid: string,
): Promise<
    | { confirmed: false }
    | { blockHeight: number; blockTime: number; confirmed: true },
>
Parameters
- txid: string
Returns Promise<
| { confirmed: false }
| { blockHeight: number; blockTime: number; confirmed: true },
>
Implementation of OnchainProvider.getTxStatus
- Defined in src/providers/onchain.ts:112

watchAddresses

watchAddresses(
addresses: string[],
callback: (txs: ExplorerTransaction[]) => void,
): Promise<() => void>
Parameters
- addresses: string[]
- callback: (txs: ExplorerTransaction[]) => void
Returns Promise<() => void>
Implementation of OnchainProvider.watchAddresses
- Defined in src/providers/onchain.ts:152

Class EsploraProvider

See

Example

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns EsploraProvider

Methods

broadcastTransaction

Parameters

Returns Promise<string>

getChainTip

Returns Promise<{ hash: string; height: number; time: number }>

getCoins

Parameters

Returns Promise<Coin[]>

getFeeRate

Returns Promise<undefined | number>

getTransactions

Parameters

Returns Promise<ExplorerTransaction[]>

getTxOutspends

Parameters

Returns Promise<{ spent: boolean; txid: string }[]>

getTxStatus

Parameters

Returns Promise<
| { confirmed: false }
| { blockHeight: number; blockTime: number; confirmed: true },
>

watchAddresses

Parameters

Returns Promise<() => void>

Settings

On This Page

Class EsploraProvider

See

Example

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns EsploraProvider

Methods

broadcastTransaction

Parameters

Returns Promise<string>

getChainTip

Returns Promise<{ hash: string; height: number; time: number }>

getCoins

Parameters

Returns Promise<Coin[]>

getFeeRate

Returns Promise<undefined | number>

getTransactions

Parameters

Returns Promise<ExplorerTransaction[]>

getTxOutspends

Parameters

Returns Promise<{ spent: boolean; txid: string }[]>

getTxStatus

Parameters

Returns Promise< | { confirmed: false } | { blockHeight: number; blockTime: number; confirmed: true },>

watchAddresses

Parameters

Returns Promise<() => void>

Settings

On This Page

Returns Promise<
| { confirmed: false }
| { blockHeight: number; blockTime: number; confirmed: true },
>