Class ScriptEndpoint

Allows fetching script history and UTXOs.

Hierarchy

ScriptEndpoint

Index

Constructors

constructor

Methods

Constructors

constructor

new ScriptEndpoint(url: string, scriptType: string, scriptPayload: string): ScriptEndpoint

- Defined in index.ts:152
Parameters
- url: string
- scriptType: string
- scriptPayload: string
Returns ScriptEndpoint

Methods

history

history(page?: number, pageSize?: number): Promise<TxHistoryPage>

- Defined in index.ts:164
Fetches the tx history of this script, in anti-chronological order. This means it's ordered by first-seen first. If the tx hasn't been seen by the indexer before, it's ordered by the block timestamp.

Parameters
- Optional page: number
  
  Page index of the tx history.
- Optional pageSize: number
  
  Number of txs per page.
Returns Promise<TxHistoryPage>

utxos

utxos(): Promise<ScriptUtxos[]>

- Defined in index.ts:190
Fetches the current UTXO set for this script. It is grouped by output script, in case a script type can match multiple different output scripts (e.g. Taproot on Lotus).

Returns Promise<ScriptUtxos[]>

Generated using TypeDoc