Class TendermintAPI

Hierarchy

BaseAPI
- TendermintAPI

Index

Constructors

constructor

Methods

Constructors

constructor

new TendermintAPI(c: APIRequester): TendermintAPI

Inherited from BaseAPI.constructor
- Defined in client/lcd/api/BaseAPI.ts:4
Parameters
- c: APIRequester
Returns TendermintAPI

Methods

blockInfo

blockInfo(height?: number, params?: APIParams): Promise<BlockInfo>

- Defined in client/lcd/api/TendermintAPI.ts:50
Gets the block information at the specified height. If no height is given, the latest block is returned.

Parameters
- Optional height: number
  
  block height.
- params: APIParams = {}
Returns Promise<BlockInfo>

nodeInfo

nodeInfo(params?: APIParams): Promise<object>

- Defined in client/lcd/api/TendermintAPI.ts:9
Gets the node's information.

Parameters
- params: APIParams = {}
Returns Promise<object>

syncing

syncing(params?: APIParams): Promise<boolean>

- Defined in client/lcd/api/TendermintAPI.ts:16
Gets whether the node is currently in syncing mode to catch up with blocks.

Parameters
- params: APIParams = {}
Returns Promise<boolean>

validatorSet

validatorSet(height?: number, params?: APIParams): Promise<[DelegateValidator[], Pagination]>

- Defined in client/lcd/api/TendermintAPI.ts:29
Gets the validator (delegates) set at the specific height. If no height is given, the current set is returned.

Parameters
- Optional height: number
  
  block height
- params: APIParams = {}
Returns Promise<[DelegateValidator[], Pagination]>