package ibc.core.channel.v1

Get desktop application:
View/edit binary Protocol Buffers messages

Msg defines the ibc/channel Msg service.

• rpc ChannelOpenInit (MsgChannelOpenInit, MsgChannelOpenInitResponse)

  tx.proto:14

  ChannelOpenInit defines a rpc handler method for MsgChannelOpenInit.

  message MsgChannelOpenInit

  tx.proto:59

  MsgChannelOpenInit defines an sdk.Msg to initialize a channel handshake. It is called by a relayer on Chain A.

  • string port_id = 1

  • optional Channel channel = 2

  • string signer = 3

  message MsgChannelOpenInitResponse

  tx.proto:69

  MsgChannelOpenInitResponse defines the Msg/ChannelOpenInit response type.

  • string channel_id = 1

  • string version = 2

• rpc ChannelOpenTry (MsgChannelOpenTry, MsgChannelOpenTryResponse)

  tx.proto:17

  ChannelOpenTry defines a rpc handler method for MsgChannelOpenTry.

  message MsgChannelOpenTry

  tx.proto:77

  MsgChannelOpenInit defines a msg sent by a Relayer to try to open a channel on Chain B. The version field within the Channel field has been deprecated. Its value will be ignored by core IBC.

  • string port_id = 1

  • string previous_channel_id = 2

    Deprecated: this field is unused. Crossing hello's are no longer supported in core IBC.

  • optional Channel channel = 3

    NOTE: the version field within the channel has been deprecated. Its value will be ignored by core IBC.

  • string counterparty_version = 4

  • bytes proof_init = 5

  • optional client.v1.Height proof_height = 6

  • string signer = 7

  message MsgChannelOpenTryResponse

  tx.proto:94

  MsgChannelOpenTryResponse defines the Msg/ChannelOpenTry response type.

  • string version = 1

• rpc ChannelOpenAck (MsgChannelOpenAck, MsgChannelOpenAckResponse)

  tx.proto:20

  ChannelOpenAck defines a rpc handler method for MsgChannelOpenAck.

  message MsgChannelOpenAck

  tx.proto:100

  MsgChannelOpenAck defines a msg sent by a Relayer to Chain A to acknowledge the change of channel state to TRYOPEN on Chain B.

  • string port_id = 1

  • string channel_id = 2

  • string counterparty_channel_id = 3

  • string counterparty_version = 4

  • bytes proof_try = 5

  • optional client.v1.Height proof_height = 6

  • string signer = 7

  message MsgChannelOpenAckResponse

  tx.proto:115

  MsgChannelOpenAckResponse defines the Msg/ChannelOpenAck response type.

  (message has no fields)

• rpc ChannelOpenConfirm (MsgChannelOpenConfirm, MsgChannelOpenConfirmResponse)

  tx.proto:23

  ChannelOpenConfirm defines a rpc handler method for MsgChannelOpenConfirm.

  message MsgChannelOpenConfirm

  tx.proto:119

  MsgChannelOpenConfirm defines a msg sent by a Relayer to Chain B to acknowledge the change of channel state to OPEN on Chain A.

  • string port_id = 1

  • string channel_id = 2

  • bytes proof_ack = 3

  • optional client.v1.Height proof_height = 4

  • string signer = 5

  message MsgChannelOpenConfirmResponse

  tx.proto:133

  MsgChannelOpenConfirmResponse defines the Msg/ChannelOpenConfirm response type.

  (message has no fields)

• rpc ChannelCloseInit (MsgChannelCloseInit, MsgChannelCloseInitResponse)

  tx.proto:26

  ChannelCloseInit defines a rpc handler method for MsgChannelCloseInit.

  message MsgChannelCloseInit

  tx.proto:137

  MsgChannelCloseInit defines a msg sent by a Relayer to Chain A to close a channel with Chain B.

  • string port_id = 1

  • string channel_id = 2

  • string signer = 3

  message MsgChannelCloseInitResponse

  tx.proto:147

  MsgChannelCloseInitResponse defines the Msg/ChannelCloseInit response type.

  (message has no fields)

• rpc ChannelCloseConfirm (MsgChannelCloseConfirm, MsgChannelCloseConfirmResponse)

  tx.proto:30

  ChannelCloseConfirm defines a rpc handler method for MsgChannelCloseConfirm.

  message MsgChannelCloseConfirm

  tx.proto:151

  MsgChannelCloseConfirm defines a msg sent by a Relayer to Chain B to acknowledge the change of channel state to CLOSED on Chain A.

  • string port_id = 1

  • string channel_id = 2

  • bytes proof_init = 3

  • optional client.v1.Height proof_height = 4

  • string signer = 5

  message MsgChannelCloseConfirmResponse

  tx.proto:165

  MsgChannelCloseConfirmResponse defines the Msg/ChannelCloseConfirm response type.

  (message has no fields)

• rpc RecvPacket (MsgRecvPacket, MsgRecvPacketResponse)

  tx.proto:33

  RecvPacket defines a rpc handler method for MsgRecvPacket.

  message MsgRecvPacket

  tx.proto:168

  MsgRecvPacket receives incoming IBC packet

  • optional Packet packet = 1

  • bytes proof_commitment = 2

  • optional client.v1.Height proof_height = 3

  • string signer = 4

  message MsgRecvPacketResponse

  tx.proto:180

  MsgRecvPacketResponse defines the Msg/RecvPacket response type.

  • ResponseResultType result = 1

• rpc Timeout (MsgTimeout, MsgTimeoutResponse)

  tx.proto:36

  Timeout defines a rpc handler method for MsgTimeout.

  message MsgTimeout

  tx.proto:187

  MsgTimeout receives timed-out packet

  • optional Packet packet = 1

  • bytes proof_unreceived = 2

  • optional client.v1.Height proof_height = 3

  • uint64 next_sequence_recv = 4

  • string signer = 5

  message MsgTimeoutResponse

  tx.proto:200

  MsgTimeoutResponse defines the Msg/Timeout response type.

  • ResponseResultType result = 1

• rpc TimeoutOnClose (MsgTimeoutOnClose, MsgTimeoutOnCloseResponse)

  tx.proto:39

  TimeoutOnClose defines a rpc handler method for MsgTimeoutOnClose.

  message MsgTimeoutOnClose

  tx.proto:207

  MsgTimeoutOnClose timed-out packet upon counterparty channel closure.

  • optional Packet packet = 1

  • bytes proof_unreceived = 2

  • bytes proof_close = 3

  • optional client.v1.Height proof_height = 4

  • uint64 next_sequence_recv = 5

  • string signer = 6

  message MsgTimeoutOnCloseResponse

  tx.proto:221

  MsgTimeoutOnCloseResponse defines the Msg/TimeoutOnClose response type.

  • ResponseResultType result = 1

• rpc Acknowledgement (MsgAcknowledgement, MsgAcknowledgementResponse)

  tx.proto:42

  Acknowledgement defines a rpc handler method for MsgAcknowledgement.

  message MsgAcknowledgement

  tx.proto:228

  MsgAcknowledgement receives incoming IBC acknowledgement

  • optional Packet packet = 1

  • bytes acknowledgement = 2

  • bytes proof_acked = 3

  • optional client.v1.Height proof_height = 4

  • string signer = 5

  message MsgAcknowledgementResponse

  tx.proto:241

  MsgAcknowledgementResponse defines the Msg/Acknowledgement response type.

  • ResponseResultType result = 1

Query provides defines the gRPC querier service

• rpc Channel (QueryChannelRequest, QueryChannelResponse)

  query.proto:17

  Channel queries an IBC Channel.

  message QueryChannelRequest

  query.proto:104

  QueryChannelRequest is the request type for the Query/Channel RPC method

  • string port_id = 1

    port unique identifier

  • string channel_id = 2

    channel unique identifier

  message QueryChannelResponse

  query.proto:114

  QueryChannelResponse is the response type for the Query/Channel RPC method. Besides the Channel end, it includes a proof and the height from which the proof was retrieved.

  • optional Channel channel = 1

    channel associated with the request identifiers

  • bytes proof = 2

    merkle proof of existence

  • optional client.v1.Height proof_height = 3

    height at which the proof was retrieved

• rpc Channels (QueryChannelsRequest, QueryChannelsResponse)

  query.proto:22

  Channels queries all the IBC channels of a chain.

  message QueryChannelsRequest

  query.proto:124

  QueryChannelsRequest is the request type for the Query/Channels RPC method

  • optional cosmos.base.query.v1beta1.PageRequest pagination = 1

    pagination request

  message QueryChannelsResponse

  query.proto:130

  QueryChannelsResponse is the response type for the Query/Channels RPC method.

  • repeated IdentifiedChannel channels = 1

    list of stored channels of the chain.

  • optional cosmos.base.query.v1beta1.PageResponse pagination = 2

    pagination response

  • optional client.v1.Height height = 3

    query block height

• rpc ConnectionChannels (QueryConnectionChannelsRequest, QueryConnectionChannelsResponse)

  query.proto:28

  ConnectionChannels queries all the channels associated with a connection end.

  message QueryConnectionChannelsRequest

  query.proto:141

  QueryConnectionChannelsRequest is the request type for the Query/QueryConnectionChannels RPC method

  • string connection = 1

    connection unique identifier

  • optional cosmos.base.query.v1beta1.PageRequest pagination = 2

    pagination request

  message QueryConnectionChannelsResponse

  query.proto:150

  QueryConnectionChannelsResponse is the Response type for the Query/QueryConnectionChannels RPC method

  • repeated IdentifiedChannel channels = 1

    list of channels associated with a connection.

  • optional cosmos.base.query.v1beta1.PageResponse pagination = 2

    pagination response

  • optional client.v1.Height height = 3

    query block height

• rpc ChannelClientState (QueryChannelClientStateRequest, QueryChannelClientStateResponse)

  query.proto:34

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

  message QueryChannelClientStateRequest

  query.proto:161

  QueryChannelClientStateRequest is the request type for the Query/ClientState RPC method

  • string port_id = 1

    port unique identifier

  • string channel_id = 2

    channel unique identifier

  message QueryChannelClientStateResponse

  query.proto:170

  QueryChannelClientStateResponse is the Response type for the Query/QueryChannelClientState RPC method

  • optional client.v1.IdentifiedClientState identified_client_state = 1

    client state associated with the channel

  • bytes proof = 2

    merkle proof of existence

  • optional client.v1.Height proof_height = 3

    height at which the proof was retrieved

• rpc ChannelConsensusState (QueryChannelConsensusStateRequest, QueryChannelConsensusStateResponse)

  query.proto:41

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

  message QueryChannelConsensusStateRequest

  query.proto:181

  QueryChannelConsensusStateRequest is the request type for the Query/ConsensusState RPC method

  • string port_id = 1

    port unique identifier

  • string channel_id = 2

    channel unique identifier

  • uint64 revision_number = 3

    revision number of the consensus state

  • uint64 revision_height = 4

    revision height of the consensus state

  message QueryChannelConsensusStateResponse

  query.proto:194

  QueryChannelClientStateResponse is the Response type for the Query/QueryChannelClientState RPC method

  • optional google.protobuf.Any consensus_state = 1

    consensus state associated with the channel

  • string client_id = 2

    client ID associated with the consensus state

  • bytes proof = 3

    merkle proof of existence

  • optional client.v1.Height proof_height = 4

    height at which the proof was retrieved

• rpc PacketCommitment (QueryPacketCommitmentRequest, QueryPacketCommitmentResponse)

  query.proto:48

  PacketCommitment queries a stored packet commitment hash.

  message QueryPacketCommitmentRequest

  query.proto:207

  QueryPacketCommitmentRequest is the request type for the Query/PacketCommitment RPC method

  • string port_id = 1

    port unique identifier

  • string channel_id = 2

    channel unique identifier

  • uint64 sequence = 3

    packet sequence

  message QueryPacketCommitmentResponse

  query.proto:219

  QueryPacketCommitmentResponse defines the client query response for a packet which also includes a proof and the height from which the proof was retrieved

  • bytes commitment = 1

    packet associated with the request fields

  • bytes proof = 2

    merkle proof of existence

  • optional client.v1.Height proof_height = 3

    height at which the proof was retrieved

• rpc PacketCommitments (QueryPacketCommitmentsRequest, QueryPacketCommitmentsResponse)

  query.proto:55

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

  message QueryPacketCommitmentsRequest

  query.proto:230

  QueryPacketCommitmentsRequest is the request type for the Query/QueryPacketCommitments RPC method

  • string port_id = 1

    port unique identifier

  • string channel_id = 2

    channel unique identifier

  • optional cosmos.base.query.v1beta1.PageRequest pagination = 3

    pagination request

  message QueryPacketCommitmentsResponse

  query.proto:241

  QueryPacketCommitmentsResponse is the request type for the Query/QueryPacketCommitments RPC method

  • repeated PacketState commitments = 1

  • optional cosmos.base.query.v1beta1.PageResponse pagination = 2

    pagination response

  • optional client.v1.Height height = 3

    query block height

• rpc PacketReceipt (QueryPacketReceiptRequest, QueryPacketReceiptResponse)

  query.proto:62

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

  message QueryPacketReceiptRequest

  query.proto:251

  QueryPacketReceiptRequest is the request type for the Query/PacketReceipt RPC method

  • string port_id = 1

    port unique identifier

  • string channel_id = 2

    channel unique identifier

  • uint64 sequence = 3

    packet sequence

  message QueryPacketReceiptResponse

  query.proto:263

  QueryPacketReceiptResponse defines the client query response for a packet receipt which also includes a proof, and the height from which the proof was retrieved

  • bool received = 2

    success flag for if receipt exists

  • bytes proof = 3

    merkle proof of existence

  • optional client.v1.Height proof_height = 4

    height at which the proof was retrieved

• rpc PacketAcknowledgement (QueryPacketAcknowledgementRequest, QueryPacketAcknowledgementResponse)

  query.proto:68

  PacketAcknowledgement queries a stored packet acknowledgement hash.

  message QueryPacketAcknowledgementRequest

  query.proto:274

  QueryPacketAcknowledgementRequest is the request type for the Query/PacketAcknowledgement RPC method

  • string port_id = 1

    port unique identifier

  • string channel_id = 2

    channel unique identifier

  • uint64 sequence = 3

    packet sequence

  message QueryPacketAcknowledgementResponse

  query.proto:286

  QueryPacketAcknowledgementResponse defines the client query response for a packet which also includes a proof and the height from which the proof was retrieved

  • bytes acknowledgement = 1

    packet associated with the request fields

  • bytes proof = 2

    merkle proof of existence

  • optional client.v1.Height proof_height = 3

    height at which the proof was retrieved

• rpc PacketAcknowledgements (QueryPacketAcknowledgementsRequest, QueryPacketAcknowledgementsResponse)

  query.proto:75

  PacketAcknowledgements returns all the packet acknowledgements associated with a channel.

  message QueryPacketAcknowledgementsRequest

  query.proto:297

  QueryPacketAcknowledgementsRequest is the request type for the Query/QueryPacketCommitments RPC method

  • string port_id = 1

    port unique identifier

  • string channel_id = 2

    channel unique identifier

  • optional cosmos.base.query.v1beta1.PageRequest pagination = 3

    pagination request

  • repeated uint64 packet_commitment_sequences = 4

    list of packet sequences

  message QueryPacketAcknowledgementsResponse

  query.proto:310

  QueryPacketAcknowledgemetsResponse is the request type for the Query/QueryPacketAcknowledgements RPC method

  • repeated PacketState acknowledgements = 1

  • optional cosmos.base.query.v1beta1.PageResponse pagination = 2

    pagination response

  • optional client.v1.Height height = 3

    query block height

• rpc UnreceivedPackets (QueryUnreceivedPacketsRequest, QueryUnreceivedPacketsResponse)

  query.proto:82

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

  message QueryUnreceivedPacketsRequest

  query.proto:320

  QueryUnreceivedPacketsRequest is the request type for the Query/UnreceivedPackets RPC method

  • string port_id = 1

    port unique identifier

  • string channel_id = 2

    channel unique identifier

  • repeated uint64 packet_commitment_sequences = 3

    list of packet sequences

  message QueryUnreceivedPacketsResponse

  query.proto:331

  QueryUnreceivedPacketsResponse is the response type for the Query/UnreceivedPacketCommitments RPC method

  • repeated uint64 sequences = 1

    list of unreceived packet sequences

  • optional client.v1.Height height = 2

    query block height

• rpc UnreceivedAcks (QueryUnreceivedAcksRequest, QueryUnreceivedAcksResponse)

  query.proto:90

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

  message QueryUnreceivedAcksRequest

  query.proto:340

  QueryUnreceivedAcks is the request type for the Query/UnreceivedAcks RPC method

  • string port_id = 1

    port unique identifier

  • string channel_id = 2

    channel unique identifier

  • repeated uint64 packet_ack_sequences = 3

    list of acknowledgement sequences

  message QueryUnreceivedAcksResponse

  query.proto:351

  QueryUnreceivedAcksResponse is the response type for the Query/UnreceivedAcks RPC method

  • repeated uint64 sequences = 1

    list of unreceived acknowledgement sequences

  • optional client.v1.Height height = 2

    query block height

• rpc NextSequenceReceive (QueryNextSequenceReceiveRequest, QueryNextSequenceReceiveResponse)

  query.proto:97

  NextSequenceReceive returns the next receive sequence for a given channel.

  message QueryNextSequenceReceiveRequest

  query.proto:360

  QueryNextSequenceReceiveRequest is the request type for the Query/QueryNextSequenceReceiveRequest RPC method

  • string port_id = 1

    port unique identifier

  • string channel_id = 2

    channel unique identifier

  message QueryNextSequenceReceiveResponse

  query.proto:369

  QuerySequenceResponse is the request type for the Query/QueryNextSequenceReceiveResponse RPC method

  • uint64 next_sequence_receive = 1

    next sequence receive number

  • bytes proof = 2

    merkle proof of existence

  • optional client.v1.Height proof_height = 3

    height at which the proof was retrieved

Acknowledgement is the recommended acknowledgement format to be used by app-specific protocols. NOTE: The field numbers 21 and 22 were explicitly chosen to avoid accidental conflicts with other protobuf message formats used for acknowledgements. The first byte of any message with this format will be the non-ASCII values `0xaa` (result) or `0xb2` (error). Implemented as defined by ICS: https://github.com/cosmos/ibc/tree/master/spec/core/ics-004-channel-and-packet-semantics#acknowledgement-envelope

• oneof response

  response contains either a result or an error and must be non-empty

  • bytes result = 21

  • string error = 22

Channel defines pipeline for exactly-once packet delivery between specific modules on separate blockchains, which has at least one end capable of sending packets and one end capable of receiving packets.

Used in: MsgChannelOpenInit, MsgChannelOpenTry, QueryChannelResponse, lightclients.solomachine.v1.ChannelStateData, lightclients.solomachine.v2.ChannelStateData

• State state = 1

  current state of the channel end

• Order ordering = 2

  whether the channel is ordered or unordered

• optional Counterparty counterparty = 3

  counterparty channel end

• repeated string connection_hops = 4

  list of connection identifiers, in order, along which packets sent on this channel will travel

• string version = 5

  opaque channel version, which is agreed upon during the handshake

Counterparty defines a channel end counterparty

Used in: Channel, IdentifiedChannel

• string port_id = 1

  port on the counterparty chain which owns the other end of the channel.

• string channel_id = 2

  channel end on the counterparty chain

GenesisState defines the ibc channel submodule's genesis state.

Used in: types.v1.GenesisState

• repeated IdentifiedChannel channels = 1

• repeated PacketState acknowledgements = 2

• repeated PacketState commitments = 3

• repeated PacketState receipts = 4

• repeated PacketSequence send_sequences = 5

• repeated PacketSequence recv_sequences = 6

• repeated PacketSequence ack_sequences = 7

• uint64 next_channel_sequence = 8

  the sequence for the next generated channel identifier

IdentifiedChannel defines a channel with additional port and channel identifier fields.

Used in: GenesisState, QueryChannelsResponse, QueryConnectionChannelsResponse

• State state = 1

  current state of the channel end

• Order ordering = 2

  whether the channel is ordered or unordered

• optional Counterparty counterparty = 3

  counterparty channel end

• repeated string connection_hops = 4

  list of connection identifiers, in order, along which packets sent on this channel will travel

• string version = 5

  opaque channel version, which is agreed upon during the handshake

• string port_id = 6

  port identifier

• string channel_id = 7

  channel identifier

Order defines if a channel is ORDERED or UNORDERED

Used in: Channel, IdentifiedChannel

• ORDER_NONE_UNSPECIFIED = 0

  zero-value for channel ordering

• ORDER_UNORDERED = 1

  packets can be delivered in any order, which may differ from the order in which they were sent.

• ORDER_ORDERED = 2

  packets are delivered exactly in the order which they were sent

Packet defines a type that carries data across different chains through IBC

Used in: MsgAcknowledgement, MsgRecvPacket, MsgTimeout, MsgTimeoutOnClose

• uint64 sequence = 1

  number corresponds to the order of sends and receives, where a Packet with an earlier sequence number must be sent and received before a Packet with a later sequence number.

• string source_port = 2

  identifies the port on the sending chain.

• string source_channel = 3

  identifies the channel end on the sending chain.

• string destination_port = 4

  identifies the port on the receiving chain.

• string destination_channel = 5

  identifies the channel end on the receiving chain.

• bytes data = 6

  actual opaque bytes transferred directly to the application module

• optional client.v1.Height timeout_height = 7

  block height after which the packet times out

• uint64 timeout_timestamp = 8

  block timestamp (in nanoseconds) after which the packet times out

PacketId is an identifer for a unique Packet Source chains refer to packets by source port/channel Destination chains refer to packets by destination port/channel

• string port_id = 1

  channel port identifier

• string channel_id = 2

  channel unique identifier

• uint64 sequence = 3

  packet sequence

PacketSequence defines the genesis type necessary to retrieve and store next send and receive sequences.

Used in: GenesisState

• string port_id = 1

• string channel_id = 2

• uint64 sequence = 3

PacketState defines the generic type necessary to retrieve and store packet commitments, acknowledgements, and receipts. Caller is responsible for knowing the context necessary to interpret this state as a commitment, acknowledgement, or a receipt.

Used in: GenesisState, QueryPacketAcknowledgementsResponse, QueryPacketCommitmentsResponse

• string port_id = 1

  channel port identifier.

• string channel_id = 2

  channel unique identifier.

• uint64 sequence = 3

  packet sequence.

• bytes data = 4

  embedded data that represents packet state.

ResponseResultType defines the possible outcomes of the execution of a message

Used in: MsgAcknowledgementResponse, MsgRecvPacketResponse, MsgTimeoutOnCloseResponse, MsgTimeoutResponse

• RESPONSE_RESULT_TYPE_UNSPECIFIED = 0

  Default zero value enumeration

• RESPONSE_RESULT_TYPE_NOOP = 1

  The message did not call the IBC application callbacks (because, for example, the packet had already been relayed)

• RESPONSE_RESULT_TYPE_SUCCESS = 2

  The message was executed successfully

State defines if a channel is in one of the following states: CLOSED, INIT, TRYOPEN, OPEN or UNINITIALIZED.

Used in: Channel, IdentifiedChannel

• STATE_UNINITIALIZED_UNSPECIFIED = 0

  Default State

• STATE_INIT = 1

  A channel has just started the opening handshake.

• STATE_TRYOPEN = 2

  A channel has acknowledged the handshake step on the counterparty chain.

• STATE_OPEN = 3

  A channel has completed the handshake. Open channels are ready to send and receive packets.

• STATE_CLOSED = 4

  A channel has been closed and can no longer be used to send or receive packets.