Class Tendermint34Client

Hierarchy

Tendermint34Client

Methods

abciInfo

abciInfo(): Promise<AbciInfoResponse>

- Defined in tendermint34/tendermint34client.ts:78
Returns Promise<AbciInfoResponse>

abciQuery

abciQuery(params: AbciQueryParams): Promise<AbciQueryResponse>

- Defined in tendermint34/tendermint34client.ts:83
Parameters
- params: AbciQueryParams
Returns Promise<AbciQueryResponse>

block

block(height?: number): Promise<BlockResponse>

- Defined in tendermint34/tendermint34client.ts:88
Parameters
- Optional height: number
Returns Promise<BlockResponse>

blockResults

blockResults(height?: number): Promise<BlockResultsResponse>

- Defined in tendermint34/tendermint34client.ts:93
Parameters
- Optional height: number
Returns Promise<BlockResultsResponse>

blockSearch

blockSearch(params: BlockSearchParams): Promise<BlockSearchResponse>

- Defined in tendermint34/tendermint34client.ts:109
Search for events that are in a block.

NOTE This method will error on any node that is running a Tendermint version lower than 0.34.9.

see
https://docs.tendermint.com/master/rpc/#/Info/block_search

Parameters
- params: BlockSearchParams
Returns Promise<BlockSearchResponse>

blockSearchAll

blockSearchAll(params: BlockSearchParams): Promise<BlockSearchResponse>

- Defined in tendermint34/tendermint34client.ts:124
Parameters
- params: BlockSearchParams
Returns Promise<BlockSearchResponse>

blockchain

blockchain(minHeight?: number, maxHeight?: number): Promise<BlockchainResponse>

- Defined in tendermint34/tendermint34client.ts:154
Queries block headers filtered by minHeight <= height <= maxHeight.

Parameters
- Optional minHeight: number
  
  The minimum height to be included in the result. Defaults to 0.
- Optional maxHeight: number
  
  The maximum height to be included in the result. Defaults to infinity.
Returns Promise<BlockchainResponse>

broadcastTxAsync

broadcastTxAsync(params: BroadcastTxParams): Promise<BroadcastTxAsyncResponse>

- Defined in tendermint34/tendermint34client.ts:182
Broadcast transaction to mempool and do not wait for result

see
https://docs.tendermint.com/master/rpc/#/Tx/broadcast_tx_async

Parameters
- params: BroadcastTxParams
Returns Promise<BroadcastTxAsyncResponse>

broadcastTxCommit

broadcastTxCommit(params: BroadcastTxParams): Promise<BroadcastTxCommitResponse>

- Defined in tendermint34/tendermint34client.ts:194
Broadcast transaction to mempool and wait for block

see
https://docs.tendermint.com/master/rpc/#/Tx/broadcast_tx_commit

Parameters
- params: BroadcastTxParams
Returns Promise<BroadcastTxCommitResponse>

broadcastTxSync

broadcastTxSync(params: BroadcastTxParams): Promise<BroadcastTxSyncResponse>

- Defined in tendermint34/tendermint34client.ts:170
Broadcast transaction to mempool and wait for response

see
https://docs.tendermint.com/master/rpc/#/Tx/broadcast_tx_sync

Parameters
- params: BroadcastTxParams
Returns Promise<BroadcastTxSyncResponse>

commit

commit(height?: number): Promise<CommitResponse>

- Defined in tendermint34/tendermint34client.ts:201
Parameters
- Optional height: number
Returns Promise<CommitResponse>

disconnect

disconnect(): void

- Defined in tendermint34/tendermint34client.ts:74
Returns void

genesis

genesis(): Promise<GenesisResponse>

- Defined in tendermint34/tendermint34client.ts:206
Returns Promise<GenesisResponse>

health

health(): Promise<null>

- Defined in tendermint34/tendermint34client.ts:211
Returns Promise<null>

numUnconfirmedTxs

numUnconfirmedTxs(): Promise<NumUnconfirmedTxsResponse>

- Defined in tendermint34/tendermint34client.ts:216
Returns Promise<NumUnconfirmedTxsResponse>

status

status(): Promise<StatusResponse>

- Defined in tendermint34/tendermint34client.ts:221
Returns Promise<StatusResponse>

subscribeNewBlock

subscribeNewBlock(): Stream<NewBlockEvent>

- Defined in tendermint34/tendermint34client.ts:226
Returns Stream<NewBlockEvent>

subscribeNewBlockHeader

subscribeNewBlockHeader(): Stream<NewBlockHeaderEvent>

- Defined in tendermint34/tendermint34client.ts:234
Returns Stream<NewBlockHeaderEvent>

subscribeTx

subscribeTx(query?: string): Stream<TxEvent>

- Defined in tendermint34/tendermint34client.ts:242
Parameters
- Optional query: string
Returns Stream<TxEvent>

tx

tx(params: TxParams): Promise<TxResponse>

- Defined in tendermint34/tendermint34client.ts:258
Get a single transaction by hash

see
https://docs.tendermint.com/master/rpc/#/Info/tx

Parameters
- params: TxParams
Returns Promise<TxResponse>

txSearch

txSearch(params: TxSearchParams): Promise<TxSearchResponse>

- Defined in tendermint34/tendermint34client.ts:268
Search for transactions that are in a block

see
https://docs.tendermint.com/master/rpc/#/Info/tx_search

Parameters
- params: TxSearchParams
Returns Promise<TxSearchResponse>

txSearchAll

txSearchAll(params: TxSearchParams): Promise<TxSearchResponse>

- Defined in tendermint34/tendermint34client.ts:275
Parameters
- params: TxSearchParams
Returns Promise<TxSearchResponse>

validators

validators(params: ValidatorsParams): Promise<ValidatorsResponse>

- Defined in tendermint34/tendermint34client.ts:296
Parameters
- params: ValidatorsParams
Returns Promise<ValidatorsResponse>

validatorsAll

validatorsAll(height?: number): Promise<ValidatorsResponse>

- Defined in tendermint34/tendermint34client.ts:304
Parameters
- Optional height: number
Returns Promise<ValidatorsResponse>

Static connect

connect(endpoint: string | HttpEndpoint): Promise<Tendermint34Client>

- Defined in tendermint34/tendermint34client.ts:23
Creates a new Tendermint client for the given endpoint.

Uses HTTP when the URL schema is http or https. Uses WebSockets otherwise.

Parameters
- endpoint: string | HttpEndpoint
Returns Promise<Tendermint34Client>

Static create

create(rpcClient: RpcClient): Promise<Tendermint34Client>

- Defined in tendermint34/tendermint34client.ts:36
Creates a new Tendermint client given an RPC client.

Parameters
- rpcClient: RpcClient
Returns Promise<Tendermint34Client>

Generated using TypeDoc