package ibc.applications.fee.v1

Get desktop application:
View/edit binary Protocol Buffers messages

Msg defines the ICS29 Msg service.

• rpc RegisterPayee (MsgRegisterPayee, MsgRegisterPayeeResponse)

  tx.proto:18

  RegisterPayee defines a rpc handler method for MsgRegisterPayee RegisterPayee is called by the relayer on each channelEnd and allows them to set an optional payee to which reverse and timeout relayer packet fees will be paid out. The payee should be registered on the source chain from which packets originate as this is where fee distribution takes place. This function may be called more than once by a relayer, in which case, the latest payee is always used.

  message MsgRegisterPayee

  tx.proto:41

  MsgRegisterPayee defines the request type for the RegisterPayee rpc

  • string port_id = 1

    unique port identifier

  • string channel_id = 2

    unique channel identifier

  • string relayer = 3

    the relayer address

  • string payee = 4

    the payee address

  message MsgRegisterPayeeResponse

  tx.proto:56

  MsgRegisterPayeeResponse defines the response type for the RegisterPayee rpc

  (message has no fields)

• rpc RegisterCounterpartyPayee (MsgRegisterCounterpartyPayee, MsgRegisterCounterpartyPayeeResponse)

  tx.proto:25

  RegisterCounterpartyPayee defines a rpc handler method for MsgRegisterCounterpartyPayee RegisterCounterpartyPayee is called by the relayer on each channelEnd and allows them to specify the counterparty payee address before relaying. This ensures they will be properly compensated for forward relaying since the destination chain must include the registered counterparty payee address in the acknowledgement. This function may be called more than once by a relayer, in which case, the latest counterparty payee address is always used.

  message MsgRegisterCounterpartyPayee

  tx.proto:59

  MsgRegisterCounterpartyPayee defines the request type for the RegisterCounterpartyPayee rpc

  • string port_id = 1

    unique port identifier

  • string channel_id = 2

    unique channel identifier

  • string relayer = 3

    the relayer address

  • string counterparty_payee = 4

    the counterparty payee address

  message MsgRegisterCounterpartyPayeeResponse

  tx.proto:74

  MsgRegisterCounterpartyPayeeResponse defines the response type for the RegisterCounterpartyPayee rpc

  (message has no fields)

• rpc PayPacketFee (MsgPayPacketFee, MsgPayPacketFeeResponse)

  tx.proto:32

  PayPacketFee defines a rpc handler method for MsgPayPacketFee PayPacketFee 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 packet at the next sequence NOTE: This method is intended to be used within a multi msg transaction, where the subsequent msg that follows initiates the lifecycle of the incentivized packet

  message MsgPayPacketFee

  tx.proto:79

  MsgPayPacketFee defines the request type for the PayPacketFee rpc This Msg can be used to pay for a packet at the next sequence send & should be combined with the Msg that will be paid for

  • optional Fee fee = 1

    fee encapsulates the recv, ack and timeout fees associated with an IBC packet

  • string source_port_id = 2

    the source port unique identifier

  • string source_channel_id = 3

    the source channel unique identifer

  • string signer = 4

    account address to refund fee if necessary

  • repeated string relayers = 5

    optional list of relayers permitted to the receive packet fees

  message MsgPayPacketFeeResponse

  tx.proto:96

  MsgPayPacketFeeResponse defines the response type for the PayPacketFee rpc

  (message has no fields)

• rpc PayPacketFeeAsync (MsgPayPacketFeeAsync, MsgPayPacketFeeAsyncResponse)

  tx.proto:37

  PayPacketFeeAsync defines a rpc handler method for MsgPayPacketFeeAsync PayPacketFeeAsync is an open callback that may be called by any module/user that wishes to escrow funds in order to incentivize the relaying of a known packet (i.e. at a particular sequence)

  message MsgPayPacketFeeAsync

  tx.proto:100

  MsgPayPacketFeeAsync defines the request type for the PayPacketFeeAsync rpc This Msg can be used to pay for a packet at a specified sequence (instead of the next sequence send)

  • optional core.channel.v1.PacketId packet_id = 1

    unique packet identifier comprised of the channel ID, port ID and sequence

  • optional PacketFee packet_fee = 2

    the packet fee associated with a particular IBC packet

  message MsgPayPacketFeeAsyncResponse

  tx.proto:112

  MsgPayPacketFeeAsyncResponse defines the response type for the PayPacketFeeAsync rpc

  (message has no fields)

Query defines the ICS29 gRPC querier service.

• rpc IncentivizedPackets (QueryIncentivizedPacketsRequest, QueryIncentivizedPacketsResponse)

  query.proto:18

  IncentivizedPackets returns all incentivized packets and their associated fees

  message QueryIncentivizedPacketsRequest

  query.proto:75

  QueryIncentivizedPacketsRequest defines the request type for the IncentivizedPackets rpc

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

    pagination defines an optional pagination for the request.

  • uint64 query_height = 2

    block height at which to query

  message QueryIncentivizedPacketsResponse

  query.proto:83

  QueryIncentivizedPacketsResponse defines the response type for the IncentivizedPackets rpc

  • repeated IdentifiedPacketFees incentivized_packets = 1

    list of identified fees for incentivized packets

• rpc IncentivizedPacket (QueryIncentivizedPacketRequest, QueryIncentivizedPacketResponse)

  query.proto:23

  IncentivizedPacket returns all packet fees for a packet given its identifier

  message QueryIncentivizedPacketRequest

  query.proto:89

  QueryIncentivizedPacketRequest defines the request type for the IncentivizedPacket rpc

  • optional core.channel.v1.PacketId packet_id = 1

    unique packet identifier comprised of channel ID, port ID and sequence

  • uint64 query_height = 2

    block height at which to query

  message QueryIncentivizedPacketResponse

  query.proto:97

  QueryIncentivizedPacketsResponse defines the response type for the IncentivizedPacket rpc

  • optional IdentifiedPacketFees incentivized_packet = 1

    the identified fees for the incentivized packet

• rpc IncentivizedPacketsForChannel (QueryIncentivizedPacketsForChannelRequest, QueryIncentivizedPacketsForChannelResponse)

  query.proto:30

  Gets all incentivized packets for a specific channel

  message QueryIncentivizedPacketsForChannelRequest

  query.proto:104

  QueryIncentivizedPacketsForChannelRequest defines the request type for querying for all incentivized packets for a specific channel

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

    pagination defines an optional pagination for the request.

  • string port_id = 2

  • string channel_id = 3

  • uint64 query_height = 4

    Height to query at

  message QueryIncentivizedPacketsForChannelResponse

  query.proto:114

  QueryIncentivizedPacketsResponse defines the response type for the incentivized packets RPC

  • repeated IdentifiedPacketFees incentivized_packets = 1

    Map of all incentivized_packets

• rpc TotalRecvFees (QueryTotalRecvFeesRequest, QueryTotalRecvFeesResponse)

  query.proto:36

  TotalRecvFees returns the total receive fees for a packet given its identifier

  message QueryTotalRecvFeesRequest

  query.proto:120

  QueryTotalRecvFeesRequest defines the request type for the TotalRecvFees rpc

  • optional core.channel.v1.PacketId packet_id = 1

    the packet identifier for the associated fees

  message QueryTotalRecvFeesResponse

  query.proto:126

  QueryTotalRecvFeesResponse defines the response type for the TotalRecvFees rpc

  • repeated cosmos.base.v1beta1.Coin recv_fees = 1

    the total packet receive fees

• rpc TotalAckFees (QueryTotalAckFeesRequest, QueryTotalAckFeesResponse)

  query.proto:42

  TotalAckFees returns the total acknowledgement fees for a packet given its identifier

  message QueryTotalAckFeesRequest

  query.proto:136

  QueryTotalAckFeesRequest defines the request type for the TotalAckFees rpc

  • optional core.channel.v1.PacketId packet_id = 1

    the packet identifier for the associated fees

  message QueryTotalAckFeesResponse

  query.proto:142

  QueryTotalAckFeesResponse defines the response type for the TotalAckFees rpc

  • repeated cosmos.base.v1beta1.Coin ack_fees = 1

    the total packet acknowledgement fees

• rpc TotalTimeoutFees (QueryTotalTimeoutFeesRequest, QueryTotalTimeoutFeesResponse)

  query.proto:48

  TotalTimeoutFees returns the total timeout fees for a packet given its identifier

  message QueryTotalTimeoutFeesRequest

  query.proto:152

  QueryTotalTimeoutFeesRequest defines the request type for the TotalTimeoutFees rpc

  • optional core.channel.v1.PacketId packet_id = 1

    the packet identifier for the associated fees

  message QueryTotalTimeoutFeesResponse

  query.proto:158

  QueryTotalTimeoutFeesResponse defines the response type for the TotalTimeoutFees rpc

  • repeated cosmos.base.v1beta1.Coin timeout_fees = 1

    the total packet timeout fees

• rpc Payee (QueryPayeeRequest, QueryPayeeResponse)

  query.proto:54

  Payee returns the registered payee address for a specific channel given the relayer address

  message QueryPayeeRequest

  query.proto:168

  QueryPayeeRequest defines the request type for the Payee rpc

  • string channel_id = 1

    unique channel identifier

  • string relayer = 2

    the relayer address to which the distribution address is registered

  message QueryPayeeResponse

  query.proto:176

  QueryPayeeResponse defines the response type for the Payee rpc

  • string payee_address = 1

    the payee address to which packet fees are paid out

• rpc CounterpartyPayee (QueryCounterpartyPayeeRequest, QueryCounterpartyPayeeResponse)

  query.proto:59

  CounterpartyPayee returns the registered counterparty payee for forward relaying

  message QueryCounterpartyPayeeRequest

  query.proto:182

  QueryCounterpartyPayeeRequest defines the request type for the CounterpartyPayee rpc

  • string channel_id = 1

    unique channel identifier

  • string relayer = 2

    the relayer address to which the counterparty is registered

  message QueryCounterpartyPayeeResponse

  query.proto:190

  QueryCounterpartyPayeeResponse defines the response type for the CounterpartyPayee rpc

  • string counterparty_payee = 1

    the counterparty payee address used to compensate forward relaying

• rpc FeeEnabledChannels (QueryFeeEnabledChannelsRequest, QueryFeeEnabledChannelsResponse)

  query.proto:64

  FeeEnabledChannels returns a list of all fee enabled channels

  message QueryFeeEnabledChannelsRequest

  query.proto:196

  QueryFeeEnabledChannelsRequest defines the request type for the FeeEnabledChannels rpc

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

    pagination defines an optional pagination for the request.

  • uint64 query_height = 2

    block height at which to query

  message QueryFeeEnabledChannelsResponse

  query.proto:204

  QueryFeeEnabledChannelsResponse defines the response type for the FeeEnabledChannels rpc

  • repeated FeeEnabledChannel fee_enabled_channels = 1

    list of fee enabled channels

• rpc FeeEnabledChannel (QueryFeeEnabledChannelRequest, QueryFeeEnabledChannelResponse)

  query.proto:69

  FeeEnabledChannel returns true if the provided port and channel identifiers belong to a fee enabled channel

  message QueryFeeEnabledChannelRequest

  query.proto:211

  QueryFeeEnabledChannelRequest defines the request type for the FeeEnabledChannel rpc

  • string port_id = 1

    unique port identifier

  • string channel_id = 2

    unique channel identifier

  message QueryFeeEnabledChannelResponse

  query.proto:219

  QueryFeeEnabledChannelResponse defines the response type for the FeeEnabledChannel rpc

  • bool fee_enabled = 1

    boolean flag representing the fee enabled channel status

Fee defines the ICS29 receive, acknowledgement and timeout fees

Used in: MsgPayPacketFee, PacketFee

• repeated cosmos.base.v1beta1.Coin recv_fee = 1

  the packet receive fee

• repeated cosmos.base.v1beta1.Coin ack_fee = 2

  the packet acknowledgement fee

• repeated cosmos.base.v1beta1.Coin timeout_fee = 3

  the packet timeout fee

FeeEnabledChannel contains the PortID & ChannelID for a fee enabled channel

Used in: GenesisState, QueryFeeEnabledChannelsResponse

• string port_id = 1

  unique port identifier

• string channel_id = 2

  unique channel identifier

ForwardRelayerAddress contains the forward relayer address and PacketId used for async acknowledgements

Used in: GenesisState

• string address = 1

  the forward relayer address

• optional core.channel.v1.PacketId packet_id = 2

  unique packet identifer comprised of the channel ID, port ID and sequence

GenesisState defines the ICS29 fee middleware genesis state

• repeated IdentifiedPacketFees identified_fees = 1

  list of identified packet fees

• repeated FeeEnabledChannel fee_enabled_channels = 2

  list of fee enabled channels

• repeated RegisteredPayee registered_payees = 3

  list of registered payees

• repeated RegisteredCounterpartyPayee registered_counterparty_payees = 4

  list of registered counterparty payees

• repeated ForwardRelayerAddress forward_relayers = 5

  list of forward relayer addresses

IdentifiedPacketFees contains a list of type PacketFee and associated PacketId

Used in: GenesisState, QueryIncentivizedPacketResponse, QueryIncentivizedPacketsForChannelResponse, QueryIncentivizedPacketsResponse

• optional core.channel.v1.PacketId packet_id = 1

  unique packet identifier comprised of the channel ID, port ID and sequence

• repeated PacketFee packet_fees = 2

  list of packet fees

IncentivizedAcknowledgement is the acknowledgement format to be used by applications wrapped in the fee middleware

• bytes app_acknowledgement = 1

  the underlying app acknowledgement bytes

• string forward_relayer_address = 2

  the relayer address which submits the recv packet message

• bool underlying_app_success = 3

  success flag of the base application callback

Metadata defines the ICS29 channel specific metadata encoded into the channel version bytestring See ICS004: https://github.com/cosmos/ibc/tree/master/spec/core/ics-004-channel-and-packet-semantics#Versioning

• string fee_version = 1

  fee_version defines the ICS29 fee version

• string app_version = 2

  app_version defines the underlying application version, which may or may not be a JSON encoded bytestring

PacketFee contains ICS29 relayer fees, refund address and optional list of permitted relayers

Used in: IdentifiedPacketFees, MsgPayPacketFeeAsync, PacketFees

• optional Fee fee = 1

  fee encapsulates the recv, ack and timeout fees associated with an IBC packet

• string refund_address = 2

  the refund address for unspent fees

• repeated string relayers = 3

  optional list of relayers permitted to receive fees

PacketFees contains a list of type PacketFee

• repeated PacketFee packet_fees = 1

  list of packet fees

RegisteredCounterpartyPayee contains the relayer address and counterparty payee address for a specific channel (used for recv fee distribution)

Used in: GenesisState

• string channel_id = 1

  unique channel identifier

• string relayer = 2

  the relayer address

• string counterparty_payee = 3

  the counterparty payee address

RegisteredPayee contains the relayer address and payee address for a specific channel

Used in: GenesisState

• string channel_id = 1

  unique channel identifier

• string relayer = 2

  the relayer address

• string payee = 3

  the payee address