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

     1  syntax = "proto3";
     2  
     3  package ibc.applications.fee.v1;
     4  
     5  option go_package = "github.com/cosmos/ibc-go/v4/modules/apps/29-fee/types";
     6  
     7  import "gogoproto/gogo.proto";
     8  import "google/api/annotations.proto";
     9  import "cosmos/base/v1beta1/coin.proto";
    10  import "cosmos/base/query/v1beta1/pagination.proto";
    11  import "ibc/applications/fee/v1/fee.proto";
    12  import "ibc/applications/fee/v1/genesis.proto";
    13  import "ibc/core/channel/v1/channel.proto";
    14  
    15  // Query defines the ICS29 gRPC querier service.
    16  service Query {
    17    // IncentivizedPackets returns all incentivized packets and their associated fees
    18    rpc IncentivizedPackets(QueryIncentivizedPacketsRequest) returns (QueryIncentivizedPacketsResponse) {
    19      option (google.api.http).get = "/ibc/apps/fee/v1/incentivized_packets";
    20    }
    21  
    22    // IncentivizedPacket returns all packet fees for a packet given its identifier
    23    rpc IncentivizedPacket(QueryIncentivizedPacketRequest) returns (QueryIncentivizedPacketResponse) {
    24      option (google.api.http).get =
    25          "/ibc/apps/fee/v1/channels/{packet_id.channel_id}/ports/{packet_id.port_id}/sequences/"
    26          "{packet_id.sequence}/incentivized_packet";
    27    }
    28  
    29    // Gets all incentivized packets for a specific channel
    30    rpc IncentivizedPacketsForChannel(QueryIncentivizedPacketsForChannelRequest)
    31        returns (QueryIncentivizedPacketsForChannelResponse) {
    32      option (google.api.http).get = "/ibc/apps/fee/v1/channels/{channel_id}/ports/{port_id}/incentivized_packets";
    33    }
    34  
    35    // TotalRecvFees returns the total receive fees for a packet given its identifier
    36    rpc TotalRecvFees(QueryTotalRecvFeesRequest) returns (QueryTotalRecvFeesResponse) {
    37      option (google.api.http).get = "/ibc/apps/fee/v1/channels/{packet_id.channel_id}/ports/{packet_id.port_id}/"
    38                                     "sequences/{packet_id.sequence}/total_recv_fees";
    39    }
    40  
    41    // TotalAckFees returns the total acknowledgement fees for a packet given its identifier
    42    rpc TotalAckFees(QueryTotalAckFeesRequest) returns (QueryTotalAckFeesResponse) {
    43      option (google.api.http).get = "/ibc/apps/fee/v1/channels/{packet_id.channel_id}/ports/{packet_id.port_id}/"
    44                                     "sequences/{packet_id.sequence}/total_ack_fees";
    45    }
    46  
    47    // TotalTimeoutFees returns the total timeout fees for a packet given its identifier
    48    rpc TotalTimeoutFees(QueryTotalTimeoutFeesRequest) returns (QueryTotalTimeoutFeesResponse) {
    49      option (google.api.http).get = "/ibc/apps/fee/v1/channels/{packet_id.channel_id}/ports/{packet_id.port_id}/"
    50                                     "sequences/{packet_id.sequence}/total_timeout_fees";
    51    }
    52  
    53    // Payee returns the registered payee address for a specific channel given the relayer address
    54    rpc Payee(QueryPayeeRequest) returns (QueryPayeeResponse) {
    55      option (google.api.http).get = "/ibc/apps/fee/v1/channels/{channel_id}/relayers/{relayer}/payee";
    56    }
    57  
    58    // CounterpartyPayee returns the registered counterparty payee for forward relaying
    59    rpc CounterpartyPayee(QueryCounterpartyPayeeRequest) returns (QueryCounterpartyPayeeResponse) {
    60      option (google.api.http).get = "/ibc/apps/fee/v1/channels/{channel_id}/relayers/{relayer}/counterparty_payee";
    61    }
    62  
    63    // FeeEnabledChannels returns a list of all fee enabled channels
    64    rpc FeeEnabledChannels(QueryFeeEnabledChannelsRequest) returns (QueryFeeEnabledChannelsResponse) {
    65      option (google.api.http).get = "/ibc/apps/fee/v1/fee_enabled";
    66    }
    67  
    68    // FeeEnabledChannel returns true if the provided port and channel identifiers belong to a fee enabled channel
    69    rpc FeeEnabledChannel(QueryFeeEnabledChannelRequest) returns (QueryFeeEnabledChannelResponse) {
    70      option (google.api.http).get = "/ibc/apps/fee/v1/channels/{channel_id}/ports/{port_id}/fee_enabled";
    71    }
    72  }
    73  
    74  // QueryIncentivizedPacketsRequest defines the request type for the IncentivizedPackets rpc
    75  message QueryIncentivizedPacketsRequest {
    76    // pagination defines an optional pagination for the request.
    77    cosmos.base.query.v1beta1.PageRequest pagination = 1;
    78    // block height at which to query
    79    uint64 query_height = 2;
    80  }
    81  
    82  // QueryIncentivizedPacketsResponse defines the response type for the IncentivizedPackets rpc
    83  message QueryIncentivizedPacketsResponse {
    84    // list of identified fees for incentivized packets
    85    repeated ibc.applications.fee.v1.IdentifiedPacketFees incentivized_packets = 1 [(gogoproto.nullable) = false];
    86  }
    87  
    88  // QueryIncentivizedPacketRequest defines the request type for the IncentivizedPacket rpc
    89  message QueryIncentivizedPacketRequest {
    90    // unique packet identifier comprised of channel ID, port ID and sequence
    91    ibc.core.channel.v1.PacketId packet_id = 1 [(gogoproto.nullable) = false];
    92    // block height at which to query
    93    uint64 query_height = 2;
    94  }
    95  
    96  // QueryIncentivizedPacketsResponse defines the response type for the IncentivizedPacket rpc
    97  message QueryIncentivizedPacketResponse {
    98    // the identified fees for the incentivized packet
    99    ibc.applications.fee.v1.IdentifiedPacketFees incentivized_packet = 1 [(gogoproto.nullable) = false];
   100  }
   101  
   102  // QueryIncentivizedPacketsForChannelRequest defines the request type for querying for all incentivized packets
   103  // for a specific channel
   104  message QueryIncentivizedPacketsForChannelRequest {
   105    // pagination defines an optional pagination for the request.
   106    cosmos.base.query.v1beta1.PageRequest pagination = 1;
   107    string                                port_id    = 2;
   108    string                                channel_id = 3;
   109    // Height to query at
   110    uint64 query_height = 4;
   111  }
   112  
   113  // QueryIncentivizedPacketsResponse defines the response type for the incentivized packets RPC
   114  message QueryIncentivizedPacketsForChannelResponse {
   115    // Map of all incentivized_packets
   116    repeated ibc.applications.fee.v1.IdentifiedPacketFees incentivized_packets = 1;
   117  }
   118  
   119  // QueryTotalRecvFeesRequest defines the request type for the TotalRecvFees rpc
   120  message QueryTotalRecvFeesRequest {
   121    // the packet identifier for the associated fees
   122    ibc.core.channel.v1.PacketId packet_id = 1 [(gogoproto.nullable) = false];
   123  }
   124  
   125  // QueryTotalRecvFeesResponse defines the response type for the TotalRecvFees rpc
   126  message QueryTotalRecvFeesResponse {
   127    // the total packet receive fees
   128    repeated cosmos.base.v1beta1.Coin recv_fees = 1 [
   129      (gogoproto.moretags)     = "yaml:\"recv_fees\"",
   130      (gogoproto.nullable)     = false,
   131      (gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.Coins"
   132    ];
   133  }
   134  
   135  // QueryTotalAckFeesRequest defines the request type for the TotalAckFees rpc
   136  message QueryTotalAckFeesRequest {
   137    // the packet identifier for the associated fees
   138    ibc.core.channel.v1.PacketId packet_id = 1 [(gogoproto.nullable) = false];
   139  }
   140  
   141  // QueryTotalAckFeesResponse defines the response type for the TotalAckFees rpc
   142  message QueryTotalAckFeesResponse {
   143    // the total packet acknowledgement fees
   144    repeated cosmos.base.v1beta1.Coin ack_fees = 1 [
   145      (gogoproto.moretags)     = "yaml:\"ack_fees\"",
   146      (gogoproto.nullable)     = false,
   147      (gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.Coins"
   148    ];
   149  }
   150  
   151  // QueryTotalTimeoutFeesRequest defines the request type for the TotalTimeoutFees rpc
   152  message QueryTotalTimeoutFeesRequest {
   153    // the packet identifier for the associated fees
   154    ibc.core.channel.v1.PacketId packet_id = 1 [(gogoproto.nullable) = false];
   155  }
   156  
   157  // QueryTotalTimeoutFeesResponse defines the response type for the TotalTimeoutFees rpc
   158  message QueryTotalTimeoutFeesResponse {
   159    // the total packet timeout fees
   160    repeated cosmos.base.v1beta1.Coin timeout_fees = 1 [
   161      (gogoproto.moretags)     = "yaml:\"timeout_fees\"",
   162      (gogoproto.nullable)     = false,
   163      (gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.Coins"
   164    ];
   165  }
   166  
   167  // QueryPayeeRequest defines the request type for the Payee rpc
   168  message QueryPayeeRequest {
   169    // unique channel identifier
   170    string channel_id = 1 [(gogoproto.moretags) = "yaml:\"channel_id\""];
   171    // the relayer address to which the distribution address is registered
   172    string relayer = 2;
   173  }
   174  
   175  // QueryPayeeResponse defines the response type for the Payee rpc
   176  message QueryPayeeResponse {
   177    // the payee address to which packet fees are paid out
   178    string payee_address = 1 [(gogoproto.moretags) = "yaml:\"payee_address\""];
   179  }
   180  
   181  // QueryCounterpartyPayeeRequest defines the request type for the CounterpartyPayee rpc
   182  message QueryCounterpartyPayeeRequest {
   183    // unique channel identifier
   184    string channel_id = 1 [(gogoproto.moretags) = "yaml:\"channel_id\""];
   185    // the relayer address to which the counterparty is registered
   186    string relayer = 2;
   187  }
   188  
   189  // QueryCounterpartyPayeeResponse defines the response type for the CounterpartyPayee rpc
   190  message QueryCounterpartyPayeeResponse {
   191    // the counterparty payee address used to compensate forward relaying
   192    string counterparty_payee = 1 [(gogoproto.moretags) = "yaml:\"counterparty_payee\""];
   193  }
   194  
   195  // QueryFeeEnabledChannelsRequest defines the request type for the FeeEnabledChannels rpc
   196  message QueryFeeEnabledChannelsRequest {
   197    // pagination defines an optional pagination for the request.
   198    cosmos.base.query.v1beta1.PageRequest pagination = 1;
   199    // block height at which to query
   200    uint64 query_height = 2;
   201  }
   202  
   203  // QueryFeeEnabledChannelsResponse defines the response type for the FeeEnabledChannels rpc
   204  message QueryFeeEnabledChannelsResponse {
   205    // list of fee enabled channels
   206    repeated ibc.applications.fee.v1.FeeEnabledChannel fee_enabled_channels = 1
   207        [(gogoproto.moretags) = "yaml:\"fee_enabled_channels\"", (gogoproto.nullable) = false];
   208  }
   209  
   210  // QueryFeeEnabledChannelRequest defines the request type for the FeeEnabledChannel rpc
   211  message QueryFeeEnabledChannelRequest {
   212    // unique port identifier
   213    string port_id = 1 [(gogoproto.moretags) = "yaml:\"port_id\""];
   214    // unique channel identifier
   215    string channel_id = 2 [(gogoproto.moretags) = "yaml:\"channel_id\""];
   216  }
   217  
   218  // QueryFeeEnabledChannelResponse defines the response type for the FeeEnabledChannel rpc
   219  message QueryFeeEnabledChannelResponse {
   220    // boolean flag representing the fee enabled channel status
   221    bool fee_enabled = 1 [(gogoproto.moretags) = "yaml:\"fee_enabled\""];
   222  }