Class Client

Hierarchy

Client

Index

Constructors

constructor

Constructors

constructor

new Client(client: RpcClient, adaptor: Adaptor): Client

- Defined in client.ts:42
Parameters
- client: RpcClient
- adaptor: Adaptor
Returns Client

Methods

abciInfo

abciInfo(): Promise<AbciInfoResponse>

- Defined in client.ts:54
Returns Promise<AbciInfoResponse>

abciQuery

abciQuery(params: AbciQueryParams): Promise<AbciQueryResponse>

- Defined in client.ts:59
Parameters
- params: AbciQueryParams
Returns Promise<AbciQueryResponse>

block

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

- Defined in client.ts:64
Parameters
- Optional height: undefined | number
Returns Promise<BlockResponse>

blockResults

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

- Defined in client.ts:69
Parameters
- Optional height: undefined | number
Returns Promise<BlockResultsResponse>

blockchain

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

- Defined in client.ts:77
Parameters
- Optional minHeight: undefined | number
- Optional maxHeight: undefined | number
Returns Promise<BlockchainResponse>

broadcastTxAsync

broadcastTxAsync(params: BroadcastTxParams): Promise<BroadcastTxAsyncResponse>

- Defined in client.ts:105
Broadcast transaction to mempool and do not wait for result

see

https://tendermint.com/rpc/#broadcasttxasync

Parameters
- params: BroadcastTxParams
Returns Promise<BroadcastTxAsyncResponse>

broadcastTxCommit

broadcastTxCommit(params: BroadcastTxParams): Promise<BroadcastTxCommitResponse>

- Defined in client.ts:117
Broadcast transaction to mempool and wait for block

see

https://tendermint.com/rpc/#broadcasttxcommit

Parameters
- params: BroadcastTxParams
Returns Promise<BroadcastTxCommitResponse>

broadcastTxSync

broadcastTxSync(params: BroadcastTxParams): Promise<BroadcastTxSyncResponse>

- Defined in client.ts:93
Broadcast transaction to mempool and wait for response

see

https://tendermint.com/rpc/#broadcasttxsync

Parameters
- params: BroadcastTxParams
Returns Promise<BroadcastTxSyncResponse>

commit

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

- Defined in client.ts:124
Parameters
- Optional height: undefined | number
Returns Promise<CommitResponse>

disconnect

disconnect(): void

- Defined in client.ts:50
Returns void

genesis

genesis(): Promise<GenesisResponse>

- Defined in client.ts:129
Returns Promise<GenesisResponse>

health

health(): Promise<responses.HealthResponse>

- Defined in client.ts:134
Returns Promise<responses.HealthResponse>

status

status(): Promise<StatusResponse>

- Defined in client.ts:139
Returns Promise<StatusResponse>

subscribeNewBlock

subscribeNewBlock(): Stream<NewBlockEvent>

- Defined in client.ts:144
Returns Stream<NewBlockEvent>

subscribeNewBlockHeader

subscribeNewBlockHeader(): Stream<NewBlockHeaderEvent>

- Defined in client.ts:152
Returns Stream<NewBlockHeaderEvent>

subscribeTx

subscribeTx(query?: requests.QueryString): Stream<TxEvent>

- Defined in client.ts:160
Parameters
- Optional query: requests.QueryString
Returns Stream<TxEvent>

tx

tx(params: TxParams): Promise<TxResponse>

- Defined in client.ts:171
Parameters
- params: TxParams
Returns Promise<TxResponse>

txSearch

txSearch(params: TxSearchParams): Promise<TxSearchResponse>

- Defined in client.ts:181
Search for transactions that are in a block

see

https://tendermint.com/rpc/#txsearch

Parameters
- params: TxSearchParams
Returns Promise<TxSearchResponse>

txSearchAll

txSearchAll(params: TxSearchParams): Promise<TxSearchResponse>

- Defined in client.ts:193
Parameters
- params: TxSearchParams
Returns Promise<TxSearchResponse>

validators

validators(height?: undefined | number): Promise<ValidatorsResponse>

- Defined in client.ts:218
Parameters
- Optional height: undefined | number
Returns Promise<ValidatorsResponse>

Static connect

connect(url: string): Promise<Client>

- Defined in client.ts:17
Parameters
- url: string
Returns Promise<Client>

Static detectVersion

detectVersion(client: RpcClient): Promise<Client>

- Defined in client.ts:23
Parameters
- client: RpcClient
Returns Promise<Client>

Generated using TypeDoc