feat: adding proto files for fee payment middleware

docs/ibc/proto-docs.md

@@ -43,6 +43,7 @@
     - [Counterparty](#ibc.core.channel.v1.Counterparty)
     - [IdentifiedChannel](#ibc.core.channel.v1.IdentifiedChannel)
     - [Packet](#ibc.core.channel.v1.Packet)
+    - [PacketId](#ibc.core.channel.v1.PacketId)
     - [PacketState](#ibc.core.channel.v1.PacketState)
 
     - [Order](#ibc.core.channel.v1.Order)
@@ -785,6 +786,23 @@ Packet defines a type that carries data across different chains through IBC
 
 
 
+<a name="ibc.core.channel.v1.PacketId"></a>
+
+### PacketId
+PacketId is an identifer for a unique Packet
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| `port_id` | [string](#string) |  | channel port identifier. |
+| `channel_id` | [string](#string) |  | channel unique identifier. |
+| `sequence` | [uint64](#uint64) |  | packet sequence. |
+
+
+
+
+
+
 <a name="ibc.core.channel.v1.PacketState"></a>
 
 ### PacketState

proto/ibc/applications/middleware/fee/v1/fee.proto

@@ -0,0 +1,13 @@
+syntax = "proto3";
+
+package ibc.applications.middleware.fee.v1;
+
+// Fee interface
+// See Fee Payment Middleware spec:
+// https://github.com/cosmos/ibc/tree/master/spec/app/ics-029-fee-payment#fee-middleware-contract
+message Fee {
+  // the token denomination the fee will be paid in
+  string denom = 1;
+  // the token amount to be transferred
+  uint64 amount = 2;
+}

proto/ibc/applications/middleware/fee/v1/genesis.proto

@@ -0,0 +1,8 @@
+syntax = "proto3";
+
+package ibc.applications.middleware.fee.v1;
+
+import "gogoproto/gogo.proto";
+
+// GenesisState defines the fee middleware genesis state
+message GenesisState {}

proto/ibc/applications/middleware/fee/v1/query.proto

@@ -0,0 +1,77 @@
+syntax = "proto3";
+
+package ibc.applications.middleware.fee.v1;
+
+import "gogoproto/gogo.proto";
+import "cosmos/base/query/v1beta1/pagination.proto";
+import "ibc/applications/middleware/fee/v1/fee.proto";
+import "google/api/annotations.proto";
+
+// Query provides defines the gRPC querier service.
+service Query {
+  // Gets the fee expected for submitting ReceivePacket msg for the given packet
+  rpc ReceiveFee(QueryReceiveFeeRequest) returns (QueryReceiveFeeResponse) {
+    option (google.api.http).get = "/ibc/apps/middleware/fee/v1/receive_fee";
+  }
+
+  // Gets the fee expected for submitting AcknowledgePacket msg for the given packet
+  rpc AckFee(QueryAckFeeRequest) returns (QueryAckFeeResponse) {
+    option (google.api.http).get = "/ibc/apps/middleware/fee/v1/ack_fee";
+  }
+
+  // Gets the fee expected for submitting TimeoutPacket msg for the given packet
+  rpc TimeoutFee(QueryTimeoutFeeRequest) returns (QueryTimeoutFeeResponse) {
+    option (google.api.http).get = "/ibc/apps/middleware/fee/v1/timeout_fee";
+  }
+}
+
+// QueryReceiveRequestFee is the request type for quering the receive fee
+message QueryReceiveFeeRequest {
+  // Source Port ID
+  string port_id = 1 [(gogoproto.moretags) = "yaml:\"port_id\""];
+  // Source Channel ID
+  string channel_id = 2 [(gogoproto.moretags) = "yaml:\"channel_id\""];
+  // Packet sequence
+  string sequence = 3 [(gogoproto.moretags) = "yaml:\"sequence\""];
+  // Caller should provide the intended relayer address in case the fee is dependent on specific relayer(s).
+  string relayer_address = 4 [(gogoproto.moretags) = "yaml:\"relayer_address\""];
+}
+
+// QueryRequestFeeResponse is the response type for the ReceiveFee RPC
+message QueryReceiveFeeResponse {
+  ibc.applications.middleware.fee.v1.Fee fee = 1 [(gogoproto.moretags) = "yaml:\"fee\""];
+}
+
+// QueryAckRequestFee is the request type for quering the acknowledgement fee
+message QueryAckFeeRequest {
+  // Source Port ID
+  string port_id = 1 [(gogoproto.moretags) = "yaml:\"port_id\""];
+  // Source Channel ID
+  string channel_id = 2 [(gogoproto.moretags) = "yaml:\"channel_id\""];
+  // Packet sequence
+  string sequence = 3 [(gogoproto.moretags) = "yaml:\"sequence\""];
+  // Caller should provide the intended relayer address in case the fee is dependent on specific relayer(s).
+  string relayer_address = 4 [(gogoproto.moretags) = "yaml:\"relayer_address\""];
+}
+
+// QueryAckFeeResponse is the response type for the AckFee RPC
+message QueryAckFeeResponse {
+  ibc.applications.middleware.fee.v1.Fee fee = 1 [(gogoproto.moretags) = "yaml:\"fee\""];
+}
+
+// QueryTimeoutFee is the request type for quering the timeout fee
+message QueryTimeoutFeeRequest {
+  // Source Port ID
+  string port_id = 1 [(gogoproto.moretags) = "yaml:\"port_id\""];
+  // Source Channel ID
+  string channel_id = 2 [(gogoproto.moretags) = "yaml:\"channel_id\""];
+  // Packet sequence
+  string sequence = 3 [(gogoproto.moretags) = "yaml:\"sequence\""];
+  // Caller should provide the intended relayer address in case the fee is dependent on specific relayer(s).
+  string relayer_address = 4 [(gogoproto.moretags) = "yaml:\"relayer_address\""];
+}
+
+// QueryTimeoutFeeResponse is the response type for the timeout RPC
+message QueryTimeoutFeeResponse {
+  ibc.applications.middleware.fee.v1.Fee fee = 1 [(gogoproto.moretags) = "yaml:\"fee\""];
+}

proto/ibc/applications/middleware/fee/v1/tx.proto

@@ -0,0 +1,70 @@
+syntax = "proto3";
+
+package ibc.applications.middleware.fee.v1;
+
+import "gogoproto/gogo.proto";
+import "ibc/applications/middleware/fee/v1/fee.proto";
+import "ibc/core/channel/v1/channel.proto";
+
+// Msg defines the ibc/fee Msg service.
+service Msg {
+  // RegisterCounterPartyAddress defines a rpc handler method for MsgRegisterCounterPartyAddress
+  // RegisterCounterpartyAddress is called by the relayer on each channelEnd and allows them to specify their
+  // counterparty address before relaying This ensures they will be properly compensated for forward relaying since
+  // destination chain must send back relayer's source address (counterparty address) in acknowledgement This function
+  // may be called more than once by a relayer, in which case, latest counterparty address is always used.
+  rpc RegisterCounterPartyAddress(MsgRegisterCounterPartyAddress) returns (MsgRegisterCounterPartyAddressResponse);
+  // EscrowPacketFee defines a rpc handler method for MsgEscrowPacketFee
+  // EscrowPacketFee is an open callback that may be called by any module/user that wishes to escrow funds in order to
+  // incentivize the relaying of the given packet.
+  rpc EscrowPacketFee(MsgEscrowPacketFee) returns (MsgEscrowPacketFeeResponse);
+  // PayFee defines a rpc handler method for MsgPayFee
+  // PayFee is a callback implemented by fee module called by the ICS-4 AcknowledgePacket handler.
+  rpc PayFee(MsgPayFee) returns (MsgPayFeeResponse);
+  // PayTimeoutFee defines a rpc handler method for MsgPayTimeoutFee
+  // PayFee is a callback implemented by fee module called by the ICS-4 TimeoutPacket handler.
+  rpc PayTimeoutFee(MsgPayTimeoutFee) returns (MsgPayTimeoutFeeResponse);
+}
+
+// MsgRegisterCounterPartyAddress is the request type for registering the counter party address
+message MsgRegisterCounterPartyAddress {
+  option (gogoproto.equal)           = false;
+  option (gogoproto.goproto_getters) = false;
+
+  string address              = 1 [(gogoproto.moretags) = "yaml:\"address\""];
+  string counterparty_address = 2 [(gogoproto.moretags) = "yaml:\"address\""];
+}
+
+// MsgRegisterCounterPartyAddressResponse defines the Msg/RegisterCounteryPartyAddress response type
+message MsgRegisterCounterPartyAddressResponse {}
+
+// MsgEscrowPacketFee defines the request type EscrowPacketFee RPC
+message MsgEscrowPacketFee {
+  ibc.core.channel.v1.PacketId           packet_id   = 1 [(gogoproto.moretags) = "yaml:\"packet_id\""];
+  ibc.applications.middleware.fee.v1.Fee receive_fee = 2 [(gogoproto.moretags) = "yaml:\"receive_fee\""];
+  ibc.applications.middleware.fee.v1.Fee ack_fee     = 3 [(gogoproto.moretags) = "yaml:\"ack_fee\""];
+  ibc.applications.middleware.fee.v1.Fee timeout_fee = 4 [(gogoproto.moretags) = "yaml:\"timeout_fee\""];
+  repeated string                        relayers    = 5 [(gogoproto.moretags) = "yaml:\"relayers\""];
+}
+
+// MsgEscrowPacketFeeResponse defines the response type for Msg/EscrowPacketFee
+message MsgEscrowPacketFeeResponse {}
+
+// MsgPayFee defines the request type for PayFee the RPC
+message MsgPayFee {
+  ibc.core.channel.v1.PacketId packet_id       = 1 [(gogoproto.moretags) = "yaml:\"packet_id\""];
+  string                       forward_relayer = 2 [(gogoproto.moretags) = "yaml:\"forward_relayer\""];
+  string                       reverse_relayer = 3 [(gogoproto.moretags) = "yaml:\"reverse_relayer\""];
+}
+
+// MsgPayFeeResponse defines the response type for Msg/PayFee
+message MsgPayFeeResponse {}
+
+// MsgPayTimmeout defines the request type for the PayTimeoutFee RPC
+message MsgPayTimeoutFee {
+  ibc.core.channel.v1.PacketId packet_id       = 1 [(gogoproto.moretags) = "yaml:\"packet_id\""];
+  string                       timeout_relayer = 2 [(gogoproto.moretags) = "yaml:\"timeout_relayer\""];
+}
+
+// MsgPayTimeoutFeeResponse defines the response type for Msg/PayTimeoutFee
+message MsgPayTimeoutFeeResponse {}

proto/ibc/core/channel/v1/channel.proto

@@ -132,6 +132,18 @@ message PacketState {
   bytes data = 4;
 }
 
+// PacketId is an identifer for a unique Packet
+message PacketId {
+  option (gogoproto.goproto_getters) = false;
+
+  // channel port identifier.
+  string port_id = 1 [(gogoproto.moretags) = "yaml:\"port_id\""];
+  // channel unique identifier.
+  string channel_id = 2 [(gogoproto.moretags) = "yaml:\"channel_id\""];
+  // packet sequence.
+  uint64 sequence = 3;
+}
+
 // 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