Class Api<SecurityDataType>

Title

cosmos/base/tendermint/v1beta1/query.proto

Version

version not set

Type Parameters

SecurityDataType extends unknown

Hierarchy

HttpClient<SecurityDataType>
- Api

Index

Constructors

constructor

new Api<SecurityDataType>(__namedParameters?: ApiConfig<SecurityDataType>): Api<SecurityDataType>
Type Parameters
- SecurityDataType extends unknown
Parameters
- __namedParameters: ApiConfig<SecurityDataType> = {}
Returns Api<SecurityDataType>
Inherited from HttpClient.constructor
- Defined in cosmos.base.tendermint.v1beta1/rest.ts:926

Properties

instance

instance: AxiosInstance

Methods

request

request<T, _E>(__namedParameters: FullRequestParams): Promise<AxiosResponse<T>>
Type Parameters
- T = any
- _E = any
Parameters
- __namedParameters: FullRequestParams
Returns Promise<AxiosResponse<T>>
Inherited from HttpClient.request
- Defined in cosmos.base.tendermint.v1beta1/rest.ts:965

serviceABCIQuery

serviceABCIQuery(query?: {
    data?: string;
    height?: string;
    path?: string;
    prove?: boolean;
}, params?: RequestParams): Promise<AxiosResponse<V1Beta1ABCIQueryResponse>>
Description
Since: cosmos-sdk 0.46

Tags
Service

Name
ServiceAbciQuery

Summary
ABCIQuery defines a query handler that supports ABCI queries directly to the application, bypassing Tendermint completely. The ABCI query must contain a valid and supported path, including app, custom, p2p, and store.

Request
GET:/cosmos/base/tendermint/v1beta1/abci_query
Parameters
- Optional query: {
      data?: string;
      height?: string;
      path?: string;
      prove?: boolean;
  }
  - Optional data?: string
  - Optional height?: string
  - Optional path?: string
  - Optional prove?: boolean
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1Beta1ABCIQueryResponse>>
- Defined in cosmos.base.tendermint.v1beta1/rest.ts:1019

serviceGetBlockByHeight

serviceGetBlockByHeight(height: string, params?: RequestParams): Promise<AxiosResponse<V1Beta1GetBlockByHeightResponse>>
No description

Tags
Service

Name
ServiceGetBlockByHeight

Summary
GetBlockByHeight queries block for given height.

Request
GET:/cosmos/base/tendermint/v1beta1/blocks/{height}
Parameters
- height: string
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1Beta1GetBlockByHeightResponse>>
- Defined in cosmos.base.tendermint.v1beta1/rest.ts:1055

serviceGetLatestBlock

serviceGetLatestBlock(params?: RequestParams): Promise<AxiosResponse<V1Beta1GetLatestBlockResponse>>
No description

Tags
Service

Name
ServiceGetLatestBlock

Summary
GetLatestBlock returns the latest block.

Request
GET:/cosmos/base/tendermint/v1beta1/blocks/latest
Parameters
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1Beta1GetLatestBlockResponse>>
- Defined in cosmos.base.tendermint.v1beta1/rest.ts:1039

serviceGetLatestValidatorSet

serviceGetLatestValidatorSet(query?: {
    pagination.count_total?: boolean;
    pagination.key?: string;
    pagination.limit?: string;
    pagination.offset?: string;
    pagination.reverse?: boolean;
}, params?: RequestParams): Promise<AxiosResponse<V1Beta1GetLatestValidatorSetResponse>>
No description

Tags
Service

Name
ServiceGetLatestValidatorSet

Summary
GetLatestValidatorSet queries latest validator-set.

Request
GET:/cosmos/base/tendermint/v1beta1/validatorsets/latest
Parameters
- Optional query: {
      pagination.count_total?: boolean;
      pagination.key?: string;
      pagination.limit?: string;
      pagination.offset?: string;
      pagination.reverse?: boolean;
  }
  - Optional pagination.count_total?: boolean
  - Optional pagination.key?: string
  - Optional pagination.limit?: string
  - Optional pagination.offset?: string
  - Optional pagination.reverse?: boolean
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1Beta1GetLatestValidatorSetResponse>>
- Defined in cosmos.base.tendermint.v1beta1/rest.ts:1103

serviceGetNodeInfo

serviceGetNodeInfo(params?: RequestParams): Promise<AxiosResponse<V1Beta1GetNodeInfoResponse>>
No description

Tags
Service

Name
ServiceGetNodeInfo

Summary
GetNodeInfo queries the current node info.

Request
GET:/cosmos/base/tendermint/v1beta1/node_info
Parameters
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1Beta1GetNodeInfoResponse>>
- Defined in cosmos.base.tendermint.v1beta1/rest.ts:1071

serviceGetSyncing

serviceGetSyncing(params?: RequestParams): Promise<AxiosResponse<V1Beta1GetSyncingResponse>>
No description

Tags
Service

Name
ServiceGetSyncing

Summary
GetSyncing queries node syncing.

Request
GET:/cosmos/base/tendermint/v1beta1/syncing
Parameters
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1Beta1GetSyncingResponse>>
- Defined in cosmos.base.tendermint.v1beta1/rest.ts:1087

serviceGetValidatorSetByHeight

serviceGetValidatorSetByHeight(height: string, query?: {
    pagination.count_total?: boolean;
    pagination.key?: string;
    pagination.limit?: string;
    pagination.offset?: string;
    pagination.reverse?: boolean;
}, params?: RequestParams): Promise<AxiosResponse<V1Beta1GetValidatorSetByHeightResponse>>
No description

Tags
Service

Name
ServiceGetValidatorSetByHeight

Summary
GetValidatorSetByHeight queries validator-set at a given height.

Request
GET:/cosmos/base/tendermint/v1beta1/validatorsets/{height}
Parameters
- height: string
- Optional query: {
      pagination.count_total?: boolean;
      pagination.key?: string;
      pagination.limit?: string;
      pagination.offset?: string;
      pagination.reverse?: boolean;
  }
  - Optional pagination.count_total?: boolean
  - Optional pagination.key?: string
  - Optional pagination.limit?: string
  - Optional pagination.offset?: string
  - Optional pagination.reverse?: boolean
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1Beta1GetValidatorSetByHeightResponse>>
- Defined in cosmos.base.tendermint.v1beta1/rest.ts:1129

setSecurityData

setSecurityData(data: null | SecurityDataType): void
Parameters
- data: null | SecurityDataType
Returns void
Inherited from HttpClient.setSecurityData
- Defined in cosmos.base.tendermint.v1beta1/rest.ts:933

Class Api<SecurityDataType>

Title

Version

Type Parameters

SecurityDataType extends unknown

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

SecurityDataType extends unknown

Parameters

__namedParameters: ApiConfig<SecurityDataType> = {}

Returns Api<SecurityDataType>

Properties

instance

Methods

request

Type Parameters

T = any

_E = any

Parameters

__namedParameters: FullRequestParams

Returns Promise<AxiosResponse<T>>

serviceABCIQuery

Description

Tags

Name

Summary

Request

Parameters

Optional query: { data?: string; height?: string; path?: string; prove?: boolean; }

Optional data?: string

Optional height?: string

Optional path?: string

Optional prove?: boolean

params: RequestParams = {}

Returns Promise<AxiosResponse<V1Beta1ABCIQueryResponse>>

serviceGetBlockByHeight

Tags

Name

Summary

Request

Parameters

height: string

params: RequestParams = {}

Returns Promise<AxiosResponse<V1Beta1GetBlockByHeightResponse>>

serviceGetLatestBlock

Tags

Name

Summary

Request

Parameters

params: RequestParams = {}

Returns Promise<AxiosResponse<V1Beta1GetLatestBlockResponse>>

serviceGetLatestValidatorSet

Tags

Name

Summary

Request

Parameters

Optional query: { pagination.count_total?: boolean; pagination.key?: string; pagination.limit?: string; pagination.offset?: string; pagination.reverse?: boolean; }

Optional pagination.count_total?: boolean

Optional pagination.key?: string

Optional pagination.limit?: string

Optional pagination.offset?: string

Optional pagination.reverse?: boolean

params: RequestParams = {}

Returns Promise<AxiosResponse<V1Beta1GetLatestValidatorSetResponse>>

serviceGetNodeInfo

Tags

Name

Summary

Request

Parameters

params: RequestParams = {}

Returns Promise<AxiosResponse<V1Beta1GetNodeInfoResponse>>

`Optional` query: {
data?: string;
height?: string;
path?: string;
prove?: boolean;
}

`Optional` data?: string

`Optional` height?: string

`Optional` path?: string

`Optional` prove?: boolean

`Optional` query: {
pagination.count_total?: boolean;
pagination.key?: string;
pagination.limit?: string;
pagination.offset?: string;
pagination.reverse?: boolean;
}

`Optional` pagination.count_total?: boolean

`Optional` pagination.key?: string

`Optional` pagination.limit?: string

`Optional` pagination.offset?: string

`Optional` pagination.reverse?: boolean

`Optional` query: {
pagination.count_total?: boolean;
pagination.key?: string;
pagination.limit?: string;
pagination.offset?: string;
pagination.reverse?: boolean;
}

`Optional` pagination.count_total?: boolean

`Optional` pagination.key?: string

`Optional` pagination.limit?: string

`Optional` pagination.offset?: string

`Optional` pagination.reverse?: boolean