Class ChronikClient

Client to access a Chronik instance.Plain object, without any connections.

Hierarchy

ChronikClient

Index

Constructors

constructor

Methods

Constructors

constructor

new ChronikClient(url: string): ChronikClient

- Defined in index.ts:22
Create a new client. This just creates an object, without any connections.

Parameters
- url: string
  
  Url of a Chronik instance, with schema and without trailing slash. E.g. https://chronik.be.cash/xec.
Returns ChronikClient

Methods

block

block(hashOrHeight: string | number): Promise<Block>

- Defined in index.ts:86
Fetch the block given hash or height.

Parameters
- hashOrHeight: string | number
Returns Promise<Block>

blockchainInfo

blockchainInfo(): Promise<BlockchainInfo>

- Defined in index.ts:79
Fetch current info of the blockchain, such as tip hash and height.

Returns Promise<BlockchainInfo>

blocks

blocks(startHeight: number, endHeight: number): Promise<BlockInfo[]>

- Defined in index.ts:94
Fetch block info of a range of blocks. startHeight and endHeight are inclusive ranges.

Parameters
- startHeight: number
- endHeight: number
Returns Promise<BlockInfo[]>

broadcastTx

broadcastTx(rawTx: string | Uint8Array, skipSlpCheck?: boolean): Promise<{ txid: string }>

- Defined in index.ts:42
Broadcasts the rawTx on the network. If skipSlpCheck is false, it will be checked that the tx doesn't burn any SLP tokens before broadcasting.

Parameters
- rawTx: string | Uint8Array
- skipSlpCheck: boolean = false
Returns Promise<{ txid: string }>

broadcastTxs

broadcastTxs(rawTxs: (string | Uint8Array)[], skipSlpCheck?: boolean): Promise<{ txids: string[] }>

- Defined in index.ts:61
Broadcasts the rawTxs on the network, only if all of them are valid. If skipSlpCheck is false, it will be checked that the txs don't burn any SLP tokens before broadcasting.

Parameters
- rawTxs: (string | Uint8Array)[]
- skipSlpCheck: boolean = false
Returns Promise<{ txids: string[] }>

script

script(scriptType: ScriptType, scriptPayload: string): ScriptEndpoint

- Defined in index.ts:136
Create object that allows fetching script history or UTXOs.

Parameters
- scriptType: ScriptType
- scriptPayload: string
Returns ScriptEndpoint

token

token(tokenId: string): Promise<Token>

- Defined in index.ts:111
Fetch token info and stats given the tokenId.

Parameters
- tokenId: string
Returns Promise<Token>

tx

tx(txid: string): Promise<Tx>

- Defined in index.ts:104
Fetch tx details given the txid.

Parameters
- txid: string
Returns Promise<Tx>

validateUtxos

validateUtxos(outpoints: OutPoint[]): Promise<UtxoState[]>

- Defined in index.ts:119
Validate the given outpoints: whether they are unspent, spent or never existed.

Parameters
- outpoints: OutPoint[]
Returns Promise<UtxoState[]>

ws

ws(config: WsConfig): WsEndpoint

- Defined in index.ts:141
Open a WebSocket connection to listen for updates.

Parameters
- config: WsConfig
Returns WsEndpoint

Generated using TypeDoc