github.com/okex/exchain@v1.8.0/libs/ibc-go/proto/ibc/core/client/v1/query.proto (about)

     1  syntax = "proto3";
     2  
     3  package ibc.core.client.v1;
     4  
     5  option go_package = "github.com/cosmos/ibc-go/v2/modules/core/02-client/types";
     6  
     7  import "cosmos/base/query/v1beta1/pagination.proto";
     8  import "ibc/core/client/v1/client.proto";
     9  import "google/protobuf/any.proto";
    10  import "google/api/annotations.proto";
    11  import "gogoproto/gogo.proto";
    12  
    13  // Query provides defines the gRPC querier service
    14  service Query {
    15    // ClientState queries an IBC light client.
    16    rpc ClientState(QueryClientStateRequest) returns (QueryClientStateResponse) {
    17      option (google.api.http).get = "/ibc/core/client/v1/client_states/{client_id}";
    18    }
    19  
    20    // ClientStates queries all the IBC light clients of a chain.
    21    rpc ClientStates(QueryClientStatesRequest) returns (QueryClientStatesResponse) {
    22      option (google.api.http).get = "/ibc/core/client/v1/client_states";
    23    }
    24  
    25    // ConsensusState queries a consensus state associated with a client state at
    26    // a given height.
    27    rpc ConsensusState(QueryConsensusStateRequest) returns (QueryConsensusStateResponse) {
    28      option (google.api.http).get = "/ibc/core/client/v1/consensus_states/"
    29                                     "{client_id}/revision/{revision_number}/"
    30                                     "height/{revision_height}";
    31    }
    32  
    33    // ConsensusStates queries all the consensus state associated with a given
    34    // client.
    35    rpc ConsensusStates(QueryConsensusStatesRequest) returns (QueryConsensusStatesResponse) {
    36      option (google.api.http).get = "/ibc/core/client/v1/consensus_states/{client_id}";
    37    }
    38  
    39    // Status queries the status of an IBC client.
    40    rpc ClientStatus(QueryClientStatusRequest) returns (QueryClientStatusResponse) {
    41      option (google.api.http).get = "/ibc/core/client/v1/client_status/{client_id}";
    42    }
    43  
    44    // ClientParams queries all parameters of the ibc client.
    45    rpc ClientParams(QueryClientParamsRequest) returns (QueryClientParamsResponse) {
    46      option (google.api.http).get = "/ibc/client/v1/params";
    47    }
    48  
    49    // UpgradedClientState queries an Upgraded IBC light client.
    50    rpc UpgradedClientState(QueryUpgradedClientStateRequest) returns (QueryUpgradedClientStateResponse) {
    51      option (google.api.http).get = "/ibc/core/client/v1/upgraded_client_states";
    52    }
    53  
    54    // UpgradedConsensusState queries an Upgraded IBC consensus state.
    55    rpc UpgradedConsensusState(QueryUpgradedConsensusStateRequest) returns (QueryUpgradedConsensusStateResponse) {
    56      option (google.api.http).get = "/ibc/core/client/v1/upgraded_consensus_states";
    57    }
    58  }
    59  
    60  // QueryClientStateRequest is the request type for the Query/ClientState RPC
    61  // method
    62  message QueryClientStateRequest {
    63    // client state unique identifier
    64    string client_id = 1;
    65  }
    66  
    67  // QueryClientStateResponse is the response type for the Query/ClientState RPC
    68  // method. Besides the client state, it includes a proof and the height from
    69  // which the proof was retrieved.
    70  message QueryClientStateResponse {
    71    // client state associated with the request identifier
    72    google.protobuf.Any client_state = 1;
    73    // merkle proof of existence
    74    bytes proof = 2;
    75    // height at which the proof was retrieved
    76    ibc.core.client.v1.Height proof_height = 3 [(gogoproto.nullable) = false];
    77  }
    78  
    79  // QueryClientStatesRequest is the request type for the Query/ClientStates RPC
    80  // method
    81  message QueryClientStatesRequest {
    82    // pagination request
    83    cosmos.base.query.v1beta1.PageRequest pagination = 1;
    84  }
    85  
    86  // QueryClientStatesResponse is the response type for the Query/ClientStates RPC
    87  // method.
    88  message QueryClientStatesResponse {
    89    // list of stored ClientStates of the chain.
    90    repeated IdentifiedClientState client_states = 1
    91        [(gogoproto.nullable) = false, (gogoproto.castrepeated) = "IdentifiedClientStates"];
    92    // pagination response
    93    cosmos.base.query.v1beta1.PageResponse pagination = 2;
    94  }
    95  
    96  // QueryConsensusStateRequest is the request type for the Query/ConsensusState
    97  // RPC method. Besides the consensus state, it includes a proof and the height
    98  // from which the proof was retrieved.
    99  message QueryConsensusStateRequest {
   100    // client identifier
   101    string client_id = 1;
   102    // consensus state revision number
   103    uint64 revision_number = 2;
   104    // consensus state revision height
   105    uint64 revision_height = 3;
   106    // latest_height overrrides the height field and queries the latest stored
   107    // ConsensusState
   108    bool latest_height = 4;
   109  }
   110  
   111  // QueryConsensusStateResponse is the response type for the Query/ConsensusState
   112  // RPC method
   113  message QueryConsensusStateResponse {
   114    // consensus state associated with the client identifier at the given height
   115    google.protobuf.Any consensus_state = 1;
   116    // merkle proof of existence
   117    bytes proof = 2;
   118    // height at which the proof was retrieved
   119    ibc.core.client.v1.Height proof_height = 3 [(gogoproto.nullable) = false];
   120  }
   121  
   122  // QueryConsensusStatesRequest is the request type for the Query/ConsensusStates
   123  // RPC method.
   124  message QueryConsensusStatesRequest {
   125    // client identifier
   126    string client_id = 1;
   127    // pagination request
   128    cosmos.base.query.v1beta1.PageRequest pagination = 2;
   129  }
   130  
   131  // QueryConsensusStatesResponse is the response type for the
   132  // Query/ConsensusStates RPC method
   133  message QueryConsensusStatesResponse {
   134    // consensus states associated with the identifier
   135    repeated ConsensusStateWithHeight consensus_states = 1 [(gogoproto.nullable) = false];
   136    // pagination response
   137    cosmos.base.query.v1beta1.PageResponse pagination = 2;
   138  }
   139  
   140  // QueryClientStatusRequest is the request type for the Query/ClientStatus RPC
   141  // method
   142  message QueryClientStatusRequest {
   143    // client unique identifier
   144    string client_id = 1;
   145  }
   146  
   147  // QueryClientStatusResponse is the response type for the Query/ClientStatus RPC
   148  // method. It returns the current status of the IBC client.
   149  message QueryClientStatusResponse {
   150    string status = 1;
   151  }
   152  
   153  // QueryClientParamsRequest is the request type for the Query/ClientParams RPC
   154  // method.
   155  message QueryClientParamsRequest {}
   156  
   157  // QueryClientParamsResponse is the response type for the Query/ClientParams RPC
   158  // method.
   159  message QueryClientParamsResponse {
   160    // params defines the parameters of the module.
   161    Params params = 1;
   162  }
   163  
   164  // QueryUpgradedClientStateRequest is the request type for the
   165  // Query/UpgradedClientState RPC method
   166  message QueryUpgradedClientStateRequest {}
   167  
   168  // QueryUpgradedClientStateResponse is the response type for the
   169  // Query/UpgradedClientState RPC method.
   170  message QueryUpgradedClientStateResponse {
   171    // client state associated with the request identifier
   172    google.protobuf.Any upgraded_client_state = 1;
   173  }
   174  
   175  // QueryUpgradedConsensusStateRequest is the request type for the
   176  // Query/UpgradedConsensusState RPC method
   177  message QueryUpgradedConsensusStateRequest {}
   178  
   179  // QueryUpgradedConsensusStateResponse is the response type for the
   180  // Query/UpgradedConsensusState RPC method.
   181  message QueryUpgradedConsensusStateResponse {
   182    // Consensus state associated with the request identifier
   183    google.protobuf.Any upgraded_consensus_state = 1;
   184  }