Class Api<SecurityDataType>

Title

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

Properties

instance

instance: AxiosInstance

Methods

queryChannel

queryChannel(channelId: string, portId: string, params?: RequestParams): Promise<AxiosResponse<V1QueryChannelResponse>>
No description

Tags
Query

Name
QueryChannel

Summary
Channel queries an IBC Channel.

Request
GET:/ibc/core/channel/v1/channels/{channel_id}/ports/{port_id}
Parameters
- channelId: string
- portId: string
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1QueryChannelResponse>>
- Defined in ibc.core.channel.v1/rest.ts:1137

queryChannelClientState

queryChannelClientState(channelId: string, portId: string, params?: RequestParams): Promise<AxiosResponse<V1QueryChannelClientStateResponse>>
No description

Tags
Query

Name
QueryChannelClientState

Summary
ChannelClientState queries for the client state for the channel associated with the provided channel identifiers.

Request
GET:/ibc/core/channel/v1/channels/{channel_id}/ports/{port_id}/client_state
Parameters
- channelId: string
- portId: string
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1QueryChannelClientStateResponse>>
- Defined in ibc.core.channel.v1/rest.ts:1154

queryChannelConsensusState

queryChannelConsensusState(channelId: string, portId: string, revisionNumber: string, revisionHeight: string, params?: RequestParams): Promise<AxiosResponse<V1QueryChannelConsensusStateResponse>>
No description

Tags
Query

Name
QueryChannelConsensusState

Summary
ChannelConsensusState queries for the consensus state for the channel associated with the provided channel identifiers.

Request
GET:/ibc/core/channel/v1/channels/{channel_id}/ports/{port_id}/consensus_state/revision/{revision_number}/height/{revision_height}
Parameters
- channelId: string
- portId: string
- revisionNumber: string
- revisionHeight: string
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1QueryChannelConsensusStateResponse>>
- Defined in ibc.core.channel.v1/rest.ts:1171

queryChannels

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

Tags
Query

Name
QueryChannels

Summary
Channels queries all the IBC channels of a chain.

Request
GET:/ibc/core/channel/v1/channels
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<V1QueryChannelsResponse>>
- Defined in ibc.core.channel.v1/rest.ts:1111

queryConnectionChannels

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

Tags
Query

Name
QueryConnectionChannels

Summary
ConnectionChannels queries all the channels associated with a connection end.

Request
GET:/ibc/core/channel/v1/connections/{connection}/channels
Parameters
- connection: 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<V1QueryConnectionChannelsResponse>>
- Defined in ibc.core.channel.v1/rest.ts:1357

queryNextSequenceReceive

queryNextSequenceReceive(channelId: string, portId: string, params?: RequestParams): Promise<AxiosResponse<V1QueryNextSequenceReceiveResponse>>
No description

Tags
Query

Name
QueryNextSequenceReceive

Summary
NextSequenceReceive returns the next receive sequence for a given channel.

Request
GET:/ibc/core/channel/v1/channels/{channel_id}/ports/{port_id}/next_sequence
Parameters
- channelId: string
- portId: string
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1QueryNextSequenceReceiveResponse>>
- Defined in ibc.core.channel.v1/rest.ts:1193

queryPacketAcknowledgement

queryPacketAcknowledgement(channelId: string, portId: string, sequence: string, params?: RequestParams): Promise<AxiosResponse<V1QueryPacketAcknowledgementResponse>>
No description

Tags
Query

Name
QueryPacketAcknowledgement

Summary
PacketAcknowledgement queries a stored packet acknowledgement hash.

Request
GET:/ibc/core/channel/v1/channels/{channel_id}/ports/{port_id}/packet_acks/{sequence}
Parameters
- channelId: string
- portId: string
- sequence: string
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1QueryPacketAcknowledgementResponse>>
- Defined in ibc.core.channel.v1/rest.ts:1239

queryPacketAcknowledgements

queryPacketAcknowledgements(channelId: string, portId: string, query?: {
    packet_commitment_sequences?: string[];
    pagination.count_total?: boolean;
    pagination.key?: string;
    pagination.limit?: string;
    pagination.offset?: string;
    pagination.reverse?: boolean;
}, params?: RequestParams): Promise<AxiosResponse<V1QueryPacketAcknowledgementsResponse>>
No description

Tags
Query

Name
QueryPacketAcknowledgements

Summary
PacketAcknowledgements returns all the packet acknowledgements associated with a channel.

Request
GET:/ibc/core/channel/v1/channels/{channel_id}/ports/{port_id}/packet_acknowledgements
Parameters
- channelId: string
- portId: string
- Optional query: {
      packet_commitment_sequences?: string[];
      pagination.count_total?: boolean;
      pagination.key?: string;
      pagination.limit?: string;
      pagination.offset?: string;
      pagination.reverse?: boolean;
  }
  - Optional packet_commitment_sequences?: string[]
  - 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<V1QueryPacketAcknowledgementsResponse>>
- Defined in ibc.core.channel.v1/rest.ts:1210

queryPacketCommitment

queryPacketCommitment(channelId: string, portId: string, sequence: string, params?: RequestParams): Promise<AxiosResponse<V1QueryPacketCommitmentResponse>>
No description

Tags
Query

Name
QueryPacketCommitment

Summary
PacketCommitment queries a stored packet commitment hash.

Request
GET:/ibc/core/channel/v1/channels/{channel_id}/ports/{port_id}/packet_commitments/{sequence}
Parameters
- channelId: string
- portId: string
- sequence: string
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1QueryPacketCommitmentResponse>>
- Defined in ibc.core.channel.v1/rest.ts:1323

queryPacketCommitments

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

Tags
Query

Name
QueryPacketCommitments

Summary
PacketCommitments returns all the packet commitments hashes associated with a channel.

Request
GET:/ibc/core/channel/v1/channels/{channel_id}/ports/{port_id}/packet_commitments
Parameters
- channelId: string
- portId: 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<V1QueryPacketCommitmentsResponse>>
- Defined in ibc.core.channel.v1/rest.ts:1256

queryPacketReceipt

queryPacketReceipt(channelId: string, portId: string, sequence: string, params?: RequestParams): Promise<AxiosResponse<V1QueryPacketReceiptResponse>>
No description

Tags
Query

Name
QueryPacketReceipt

Summary
PacketReceipt queries if a given packet sequence has been received on the queried chain

Request
GET:/ibc/core/channel/v1/channels/{channel_id}/ports/{port_id}/packet_receipts/{sequence}
Parameters
- channelId: string
- portId: string
- sequence: string
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1QueryPacketReceiptResponse>>
- Defined in ibc.core.channel.v1/rest.ts:1340

queryUnreceivedAcks

queryUnreceivedAcks(channelId: string, portId: string, packetAckSequences: string[], params?: RequestParams): Promise<AxiosResponse<V1QueryUnreceivedAcksResponse>>
No description

Tags
Query

Name
QueryUnreceivedAcks

Summary
UnreceivedAcks returns all the unreceived IBC acknowledgements associated with a channel and sequences.

Request
GET:/ibc/core/channel/v1/channels/{channel_id}/ports/{port_id}/packet_commitments/{packet_ack_sequences}/unreceived_acks
Parameters
- channelId: string
- portId: string
- packetAckSequences: string[]
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1QueryUnreceivedAcksResponse>>
- Defined in ibc.core.channel.v1/rest.ts:1285

queryUnreceivedPackets

queryUnreceivedPackets(channelId: string, portId: string, packetCommitmentSequences: string[], params?: RequestParams): Promise<AxiosResponse<V1QueryUnreceivedPacketsResponse>>
No description

Tags
Query

Name
QueryUnreceivedPackets

Summary
UnreceivedPackets returns all the unreceived IBC packets associated with a channel and sequences.

Request
GET:/ibc/core/channel/v1/channels/{channel_id}/ports/{port_id}/packet_commitments/{packet_commitment_sequences}/unreceived_packets
Parameters
- channelId: string
- portId: string
- packetCommitmentSequences: string[]
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1QueryUnreceivedPacketsResponse>>
- Defined in ibc.core.channel.v1/rest.ts:1302

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.channel.v1/rest.ts:1059

setSecurityData

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

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

queryChannel

Tags

Name

Summary

Request

Parameters

channelId: string

portId: string

params: RequestParams = {}

Returns Promise<AxiosResponse<V1QueryChannelResponse>>

queryChannelClientState

Tags

Name

Summary

Request

Parameters

channelId: string

portId: string

params: RequestParams = {}

Returns Promise<AxiosResponse<V1QueryChannelClientStateResponse>>

queryChannelConsensusState

Tags

Name

Summary

Request

Parameters

channelId: string

portId: string

revisionNumber: string

revisionHeight: string

params: RequestParams = {}

Returns Promise<AxiosResponse<V1QueryChannelConsensusStateResponse>>

queryChannels

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

queryConnectionChannels

Tags

Name

Summary

Request

Parameters

connection: 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 = {}

`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

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

`Optional` packet_commitment_sequences?: string[]

`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