Class Api<SecurityDataType>

Title

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

Properties

instance

instance: AxiosInstance

Methods

queryClientConnections

queryClientConnections(clientId: string, params?: RequestParams): Promise<AxiosResponse<V1QueryClientConnectionsResponse>>
No description

Tags
Query

Name
QueryClientConnections

Summary
ClientConnections queries the connection paths associated with a client state.

Request
GET:/ibc/core/connection/v1/client_connections/{client_id}
Parameters
- clientId: string
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1QueryClientConnectionsResponse>>
- Defined in ibc.core.connection.v1/rest.ts:764

queryConnection

queryConnection(connectionId: string, params?: RequestParams): Promise<AxiosResponse<V1QueryConnectionResponse>>
No description

Tags
Query

Name
QueryConnection

Summary
Connection queries an IBC connection end.

Request
GET:/ibc/core/connection/v1/connections/{connection_id}
Parameters
- connectionId: string
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1QueryConnectionResponse>>
- Defined in ibc.core.connection.v1/rest.ts:806

queryConnectionClientState

queryConnectionClientState(connectionId: string, params?: RequestParams): Promise<AxiosResponse<V1QueryConnectionClientStateResponse>>
No description

Tags
Query

Name
QueryConnectionClientState

Summary
ConnectionClientState queries the client state associated with the connection.

Request
GET:/ibc/core/connection/v1/connections/{connection_id}/client_state
Parameters
- connectionId: string
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1QueryConnectionClientStateResponse>>
- Defined in ibc.core.connection.v1/rest.ts:823

queryConnectionConsensusState

queryConnectionConsensusState(connectionId: string, revisionNumber: string, revisionHeight: string, params?: RequestParams): Promise<AxiosResponse<V1QueryConnectionConsensusStateResponse>>
No description

Tags
Query

Name
QueryConnectionConsensusState

Summary
ConnectionConsensusState queries the consensus state associated with the connection.

Request
GET:/ibc/core/connection/v1/connections/{connection_id}/consensus_state/revision/{revision_number}/height/{revision_height}
Parameters
- connectionId: string
- revisionNumber: string
- revisionHeight: string
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1QueryConnectionConsensusStateResponse>>
- Defined in ibc.core.connection.v1/rest.ts:840

queryConnections

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

Tags
Query

Name
QueryConnections

Summary
Connections queries all the IBC connections of a chain.

Request
GET:/ibc/core/connection/v1/connections
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<V1QueryConnectionsResponse>>
- Defined in ibc.core.connection.v1/rest.ts:780

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.connection.v1/rest.ts:711

setSecurityData

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

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

queryClientConnections

Tags

Name

Summary

Request

Parameters

clientId: string

params: RequestParams = {}

Returns Promise<AxiosResponse<V1QueryClientConnectionsResponse>>

queryConnection

Tags

Name

Summary

Request

Parameters

connectionId: string

params: RequestParams = {}

Returns Promise<AxiosResponse<V1QueryConnectionResponse>>

queryConnectionClientState

Tags

Name

Summary

Request

Parameters

connectionId: string

params: RequestParams = {}

Returns Promise<AxiosResponse<V1QueryConnectionClientStateResponse>>

queryConnectionConsensusState

Tags

Name

Summary

Request

Parameters

connectionId: string

revisionNumber: string

revisionHeight: string

params: RequestParams = {}

Returns Promise<AxiosResponse<V1QueryConnectionConsensusStateResponse>>

queryConnections

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

request

Type Parameters

T = any

_E = any

Parameters

__namedParameters: FullRequestParams

Returns Promise<AxiosResponse<T>>

setSecurityData

`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