package ibc.core.client.v1

Get desktop application:
View/edit binary Protocol Buffers messages

Msg defines the ibc/client Msg service.

• rpc CreateClient (MsgCreateClient, MsgCreateClientResponse)

  tx.proto:13

  CreateClient defines a rpc handler method for MsgCreateClient.

  message MsgCreateClient

  tx.proto:26

  MsgCreateClient defines a message to create an IBC client

  • optional google.protobuf.Any client_state = 1

    light client state

  • optional google.protobuf.Any consensus_state = 2

    consensus state associated with the client that corresponds to a given height.

  • string signer = 3

    signer address

  message MsgCreateClientResponse

  tx.proto:40

  MsgCreateClientResponse defines the Msg/CreateClient response type.

  (message has no fields)

• rpc UpdateClient (MsgUpdateClient, MsgUpdateClientResponse)

  tx.proto:16

  UpdateClient defines a rpc handler method for MsgUpdateClient.

  message MsgUpdateClient

  tx.proto:44

  MsgUpdateClient defines an sdk.Msg to update a IBC client state using the given client message.

  • string client_id = 1

    client unique identifier

  • optional google.protobuf.Any client_message = 2

    client message to update the light client

  • string signer = 3

    signer address

  message MsgUpdateClientResponse

  tx.proto:57

  MsgUpdateClientResponse defines the Msg/UpdateClient response type.

  (message has no fields)

• rpc UpgradeClient (MsgUpgradeClient, MsgUpgradeClientResponse)

  tx.proto:19

  UpgradeClient defines a rpc handler method for MsgUpgradeClient.

  message MsgUpgradeClient

  tx.proto:61

  MsgUpgradeClient defines an sdk.Msg to upgrade an IBC client to a new client state

  • string client_id = 1

    client unique identifier

  • optional google.protobuf.Any client_state = 2

    upgraded client state

  • optional google.protobuf.Any consensus_state = 3

    upgraded consensus state, only contains enough information to serve as a basis of trust in update logic

  • bytes proof_upgrade_client = 4

    proof that old chain committed to new client

  • bytes proof_upgrade_consensus_state = 5

    proof that old chain committed to new consensus state

  • string signer = 6

    signer address

  message MsgUpgradeClientResponse

  tx.proto:81

  MsgUpgradeClientResponse defines the Msg/UpgradeClient response type.

  (message has no fields)

• rpc SubmitMisbehaviour (MsgSubmitMisbehaviour, MsgSubmitMisbehaviourResponse)

  tx.proto:22

  SubmitMisbehaviour defines a rpc handler method for MsgSubmitMisbehaviour.

  message MsgSubmitMisbehaviour

  tx.proto:86

  MsgSubmitMisbehaviour defines an sdk.Msg type that submits Evidence for light client misbehaviour. Warning: DEPRECATED

  • string client_id = 1

    client unique identifier

  • optional google.protobuf.Any misbehaviour = 2

    misbehaviour used for freezing the light client

  • string signer = 3

    signer address

  message MsgSubmitMisbehaviourResponse

  tx.proto:100

  MsgSubmitMisbehaviourResponse defines the Msg/SubmitMisbehaviour response type.

  (message has no fields)

Query provides defines the gRPC querier service

• rpc ClientState (QueryClientStateRequest, QueryClientStateResponse)

  query.proto:16

  ClientState queries an IBC light client.

  message QueryClientStateRequest

  query.proto:67

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

  • string client_id = 1

    client state unique identifier

  message QueryClientStateResponse

  query.proto:75

  QueryClientStateResponse is the response type for the Query/ClientState RPC method. Besides the client state, it includes a proof and the height from which the proof was retrieved.

  • optional google.protobuf.Any client_state = 1

    client state associated with the request identifier

  • bytes proof = 2

    merkle proof of existence

  • optional Height proof_height = 3

    height at which the proof was retrieved

• rpc ClientStates (QueryClientStatesRequest, QueryClientStatesResponse)

  query.proto:21

  ClientStates queries all the IBC light clients of a chain.

  message QueryClientStatesRequest

  query.proto:86

  QueryClientStatesRequest is the request type for the Query/ClientStates RPC method

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

    pagination request

  message QueryClientStatesResponse

  query.proto:93

  QueryClientStatesResponse is the response type for the Query/ClientStates RPC method.

  • repeated IdentifiedClientState client_states = 1

    list of stored ClientStates of the chain.

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

    pagination response

• rpc ConsensusState (QueryConsensusStateRequest, QueryConsensusStateResponse)

  query.proto:27

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

  message QueryConsensusStateRequest

  query.proto:104

  QueryConsensusStateRequest is the request type for the Query/ConsensusState RPC method. Besides the consensus state, it includes a proof and the height from which the proof was retrieved.

  • string client_id = 1

    client identifier

  • uint64 revision_number = 2

    consensus state revision number

  • uint64 revision_height = 3

    consensus state revision height

  • bool latest_height = 4

    latest_height overrrides the height field and queries the latest stored ConsensusState

  message QueryConsensusStateResponse

  query.proto:118

  QueryConsensusStateResponse is the response type for the Query/ConsensusState RPC method

  • optional google.protobuf.Any consensus_state = 1

    consensus state associated with the client identifier at the given height

  • bytes proof = 2

    merkle proof of existence

  • optional Height proof_height = 3

    height at which the proof was retrieved

• rpc ConsensusStates (QueryConsensusStatesRequest, QueryConsensusStatesResponse)

  query.proto:35

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

  message QueryConsensusStatesRequest

  query.proto:129

  QueryConsensusStatesRequest is the request type for the Query/ConsensusStates RPC method.

  • string client_id = 1

    client identifier

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

    pagination request

  message QueryConsensusStatesResponse

  query.proto:138

  QueryConsensusStatesResponse is the response type for the Query/ConsensusStates RPC method

  • repeated ConsensusStateWithHeight consensus_states = 1

    consensus states associated with the identifier

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

    pagination response

• rpc ConsensusStateHeights (QueryConsensusStateHeightsRequest, QueryConsensusStateHeightsResponse)

  query.proto:40

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

  message QueryConsensusStateHeightsRequest

  query.proto:147

  QueryConsensusStateHeightsRequest is the request type for Query/ConsensusStateHeights RPC method.

  • string client_id = 1

    client identifier

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

    pagination request

  message QueryConsensusStateHeightsResponse

  query.proto:156

  QueryConsensusStateHeightsResponse is the response type for the Query/ConsensusStateHeights RPC method

  • repeated Height consensus_state_heights = 1

    consensus state heights

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

    pagination response

• rpc ClientStatus (QueryClientStatusRequest, QueryClientStatusResponse)

  query.proto:45

  Status queries the status of an IBC client.

  message QueryClientStatusRequest

  query.proto:165

  QueryClientStatusRequest is the request type for the Query/ClientStatus RPC method

  • string client_id = 1

    client unique identifier

  message QueryClientStatusResponse

  query.proto:172

  QueryClientStatusResponse is the response type for the Query/ClientStatus RPC method. It returns the current status of the IBC client.

  • string status = 1

• rpc ClientParams (QueryClientParamsRequest, QueryClientParamsResponse)

  query.proto:50

  ClientParams queries all parameters of the ibc client submodule.

  message QueryClientParamsRequest

  query.proto:178

  QueryClientParamsRequest is the request type for the Query/ClientParams RPC method.

  (message has no fields)

  message QueryClientParamsResponse

  query.proto:182

  QueryClientParamsResponse is the response type for the Query/ClientParams RPC method.

  • optional Params params = 1

    params defines the parameters of the module.

• rpc UpgradedClientState (QueryUpgradedClientStateRequest, QueryUpgradedClientStateResponse)

  query.proto:55

  UpgradedClientState queries an Upgraded IBC light client.

  message QueryUpgradedClientStateRequest

  query.proto:189

  QueryUpgradedClientStateRequest is the request type for the Query/UpgradedClientState RPC method

  (message has no fields)

  message QueryUpgradedClientStateResponse

  query.proto:193

  QueryUpgradedClientStateResponse is the response type for the Query/UpgradedClientState RPC method.

  • optional google.protobuf.Any upgraded_client_state = 1

    client state associated with the request identifier

• rpc UpgradedConsensusState (QueryUpgradedConsensusStateRequest, QueryUpgradedConsensusStateResponse)

  query.proto:60

  UpgradedConsensusState queries an Upgraded IBC consensus state.

  message QueryUpgradedConsensusStateRequest

  query.proto:200

  QueryUpgradedConsensusStateRequest is the request type for the Query/UpgradedConsensusState RPC method

  (message has no fields)

  message QueryUpgradedConsensusStateResponse

  query.proto:204

  QueryUpgradedConsensusStateResponse is the response type for the Query/UpgradedConsensusState RPC method.

  • optional google.protobuf.Any upgraded_consensus_state = 1

    Consensus state associated with the request identifier

ClientConsensusStates defines all the stored consensus states for a given client.

Used in: GenesisState

• string client_id = 1

  client identifier

• repeated ConsensusStateWithHeight consensus_states = 2

  consensus states and their heights associated with the client

ClientUpdateProposal is a governance proposal. If it passes, the substitute client's latest consensus state is copied over to the subject client. The proposal handler may fail if the subject and the substitute do not match in client and chain parameters (with exception to latest height, frozen height, and chain-id).

• string title = 1

  the title of the update proposal

• string description = 2

  the description of the proposal

• string subject_client_id = 3

  the client identifier for the client to be updated if the proposal passes

• string substitute_client_id = 4

  the substitute client identifier for the client standing in for the subject client

ConsensusStateWithHeight defines a consensus state with an additional height field.

Used in: ClientConsensusStates, QueryConsensusStatesResponse

• optional Height height = 1

  consensus state height

• optional google.protobuf.Any consensus_state = 2

  consensus state

GenesisMetadata defines the genesis type for metadata that clients may return with ExportMetadata

Used in: IdentifiedGenesisMetadata

• bytes key = 1

  store key of metadata without clientID-prefix

• bytes value = 2

  metadata value

GenesisState defines the ibc client submodule's genesis state.

Used in: types.v1.GenesisState

• repeated IdentifiedClientState clients = 1

  client states with their corresponding identifiers

• repeated ClientConsensusStates clients_consensus = 2

  consensus states from each client

• repeated IdentifiedGenesisMetadata clients_metadata = 3

  metadata from each client

• optional Params params = 4

• bool create_localhost = 5

  create localhost on initialization

• uint64 next_client_sequence = 6

  the sequence for the next generated client identifier

Height is a monotonically increasing data type that can be compared against another Height for the purposes of updating and freezing clients Normally the RevisionHeight is incremented at each height while keeping RevisionNumber the same. However some consensus algorithms may choose to reset the height in certain conditions e.g. hard forks, state-machine breaking changes In these cases, the RevisionNumber is incremented so that height continues to be monitonically increasing even as the RevisionHeight gets reset

Used in: applications.transfer.v1.MsgTransfer, channel.v1.MsgAcknowledgement, channel.v1.MsgChannelCloseConfirm, channel.v1.MsgChannelOpenAck, channel.v1.MsgChannelOpenConfirm, channel.v1.MsgChannelOpenTry, channel.v1.MsgRecvPacket, channel.v1.MsgTimeout, channel.v1.MsgTimeoutOnClose, channel.v1.Packet, channel.v1.QueryChannelClientStateResponse, channel.v1.QueryChannelConsensusStateResponse, channel.v1.QueryChannelResponse, channel.v1.QueryChannelsResponse, channel.v1.QueryConnectionChannelsResponse, channel.v1.QueryNextSequenceReceiveResponse, channel.v1.QueryPacketAcknowledgementResponse, channel.v1.QueryPacketAcknowledgementsResponse, channel.v1.QueryPacketCommitmentResponse, channel.v1.QueryPacketCommitmentsResponse, channel.v1.QueryPacketReceiptResponse, channel.v1.QueryUnreceivedAcksResponse, channel.v1.QueryUnreceivedPacketsResponse, ConsensusStateWithHeight, QueryClientStateResponse, QueryConsensusStateHeightsResponse, QueryConsensusStateResponse, connection.v1.MsgConnectionOpenAck, connection.v1.MsgConnectionOpenConfirm, connection.v1.MsgConnectionOpenTry, connection.v1.QueryClientConnectionsResponse, connection.v1.QueryConnectionClientStateResponse, connection.v1.QueryConnectionConsensusStateResponse, connection.v1.QueryConnectionResponse, connection.v1.QueryConnectionsResponse, lightclients.localhost.v1.ClientState, lightclients.localhost.v2.ClientState, lightclients.tendermint.v1.ClientState, lightclients.tendermint.v1.Header

• uint64 revision_number = 1

  the revision that the client is currently on

• uint64 revision_height = 2

  the height within the given revision

IdentifiedClientState defines a client state with an additional client identifier field.

Used in: channel.v1.QueryChannelClientStateResponse, GenesisState, QueryClientStatesResponse, connection.v1.QueryConnectionClientStateResponse

• string client_id = 1

  client identifier

• optional google.protobuf.Any client_state = 2

  client state

IdentifiedGenesisMetadata has the client metadata with the corresponding client id.

Used in: GenesisState

• string client_id = 1

• repeated GenesisMetadata client_metadata = 2

Params defines the set of IBC light client parameters.

Used in: GenesisState, QueryClientParamsResponse

• repeated string allowed_clients = 1

  allowed_clients defines the list of allowed client state types which can be created and interacted with. If a client type is removed from the allowed clients list, usage of this client will be disabled until it is added again to the list.

UpgradeProposal is a gov Content type for initiating an IBC breaking upgrade.

• string title = 1

• string description = 2

• optional cosmos.upgrade.v1beta1.Plan plan = 3

• optional google.protobuf.Any upgraded_client_state = 4

  An UpgradedClientState must be provided to perform an IBC breaking upgrade. This will make the chain commit to the correct upgraded (self) client state before the upgrade occurs, so that connecting chains can verify that the new upgraded client is valid by verifying a proof on the previous version of the chain. This will allow IBC connections to persist smoothly across planned chain upgrades