Class Api<SecurityDataType>

Title

ibc/core/client/v1/client.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 ibc.core.client.v1/rest.ts:817

Properties

instance

instance: AxiosInstance

Methods

queryClientParams

queryClientParams(params?: RequestParams): Promise<AxiosResponse<V1QueryClientParamsResponse>>
No description

Tags
Query

Name
QueryClientParams

Summary
ClientParams queries all parameters of the ibc client.

Request
GET:/ibc/client/v1/params
Parameters
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1QueryClientParamsResponse>>
- Defined in ibc.core.client.v1/rest.ts:908

queryClientState

queryClientState(clientId: string, params?: RequestParams): Promise<AxiosResponse<V1QueryClientStateResponse>>
No description

Tags
Query

Name
QueryClientState

Summary
ClientState queries an IBC light client.

Request
GET:/ibc/core/client/v1/client_states/{client_id}
Parameters
- clientId: string
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1QueryClientStateResponse>>
- Defined in ibc.core.client.v1/rest.ts:950

queryClientStates

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

Tags
Query

Name
QueryClientStates

Summary
ClientStates queries all the IBC light clients of a chain.

Request
GET:/ibc/core/client/v1/client_states
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<V1QueryClientStatesResponse>>
- Defined in ibc.core.client.v1/rest.ts:924

queryClientStatus

queryClientStatus(clientId: string, params?: RequestParams): Promise<AxiosResponse<V1QueryClientStatusResponse>>
No description

Tags
Query

Name
QueryClientStatus

Summary
Status queries the status of an IBC client.

Request
GET:/ibc/core/client/v1/client_status/{client_id}
Parameters
- clientId: string
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1QueryClientStatusResponse>>
- Defined in ibc.core.client.v1/rest.ts:966

queryConsensusState

queryConsensusState(clientId: string, revisionNumber: string, revisionHeight: string, query?: {
latest_height?: boolean;
}, params?: RequestParams): Promise<AxiosResponse<V1QueryConsensusStateResponse>>
No description

Tags
Query

Name
QueryConsensusState

Summary
ConsensusState queries a consensus state associated with a client state at a given height.

Request
GET:/ibc/core/client/v1/consensus_states/{client_id}/revision/{revision_number}/height/{revision_height}
Parameters
- clientId: string
- revisionNumber: string
- revisionHeight: string
- Optional query: {
  latest_height?: boolean;
  }
  - Optional latest_height?: boolean
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1QueryConsensusStateResponse>>
- Defined in ibc.core.client.v1/rest.ts:1038

queryConsensusStateHeights

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

Tags
Query

Name
QueryConsensusStateHeights

Summary
ConsensusStateHeights queries the height of every consensus states associated with a given client.

Request
GET:/ibc/core/client/v1/consensus_states/{client_id}/heights
Parameters
- clientId: 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<V1QueryConsensusStateHeightsResponse>>
- Defined in ibc.core.client.v1/rest.ts:1010

queryConsensusStates

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

Tags
Query

Name
QueryConsensusStates

Summary
ConsensusStates queries all the consensus state associated with a given client.

Request
GET:/ibc/core/client/v1/consensus_states/{client_id}
Parameters
- clientId: 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<V1QueryConsensusStatesResponse>>
- Defined in ibc.core.client.v1/rest.ts:983

queryUpgradedClientState

queryUpgradedClientState(params?: RequestParams): Promise<AxiosResponse<V1QueryUpgradedClientStateResponse>>
No description

Tags
Query

Name
QueryUpgradedClientState

Summary
UpgradedClientState queries an Upgraded IBC light client.

Request
GET:/ibc/core/client/v1/upgraded_client_states
Parameters
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1QueryUpgradedClientStateResponse>>
- Defined in ibc.core.client.v1/rest.ts:1061

queryUpgradedConsensusState

queryUpgradedConsensusState(params?: RequestParams): Promise<AxiosResponse<V1QueryUpgradedConsensusStateResponse>>
No description

Tags
Query

Name
QueryUpgradedConsensusState

Summary
UpgradedConsensusState queries an Upgraded IBC consensus state.

Request
GET:/ibc/core/client/v1/upgraded_consensus_states
Parameters
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1QueryUpgradedConsensusStateResponse>>
- Defined in ibc.core.client.v1/rest.ts:1077

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 ibc.core.client.v1/rest.ts:856

setSecurityData

setSecurityData(data: null | SecurityDataType): void
Parameters
- data: null | SecurityDataType
Returns void
Inherited from HttpClient.setSecurityData
- Defined in ibc.core.client.v1/rest.ts:824

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

queryClientParams

Tags

Name

Summary

Request

Parameters

params: RequestParams = {}

Returns Promise<AxiosResponse<V1QueryClientParamsResponse>>

queryClientState

Tags

Name

Summary

Request

Parameters

clientId: string

params: RequestParams = {}

Returns Promise<AxiosResponse<V1QueryClientStateResponse>>

queryClientStates

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<V1QueryClientStatesResponse>>

queryClientStatus

Tags

Name

Summary

Request

Parameters

clientId: string

params: RequestParams = {}

Returns Promise<AxiosResponse<V1QueryClientStatusResponse>>

queryConsensusState

Tags

Name

Summary

Request

Parameters

clientId: string

revisionNumber: string

revisionHeight: string

Optional query: { latest_height?: boolean; }

Optional latest_height?: boolean

params: RequestParams = {}

Returns Promise<AxiosResponse<V1QueryConsensusStateResponse>>

queryConsensusStateHeights

Tags

Name

Summary

Request

Parameters

clientId: 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

`Optional` query: {
latest_height?: boolean;
}

`Optional` latest_height?: 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