docs: adding events to fee middleware docs

docs/.vuepress/config.js

@@ -238,6 +238,16 @@ module.exports = {
                   directory: false,
                   path: "/middleware/ics29-fee/integration.html"
                 },
+                {
+                  title: "Fee Distribution",
+                  directory: false,
+                  path: "/middleware/ics29-fee/fee-distribution.html"
+                },
+                {
+                  title: "Events",
+                  directory: false,
+                  path: "/middleware/ics29-fee/events.html"
+                },
               ]
             },
           ]

docs/middleware/ics29-fee/events.md

@@ -0,0 +1,35 @@
+<!--
+order: 5
+-->
+
+# Events
+
+## `MsgPayPacketFee`, `MsgPayPacketFeeAsync`
+
+| Type                    | Attribute Key   | Attribute Value |
+|-------------------------|-----------------|-----------------|
+| incentivized_ibc_packet | port_id         | {portID}        |
+| incentivized_ibc_packet | channel_id      | {channelID}     |
+| incentivized_ibc_packet | packet_sequence | {sequence}      |
+| incentivized_ibc_packet | recv_fee        | {recvFee}       |
+| incentivized_ibc_packet | ack_fee         | {ackFee}        |
+| incentivized_ibc_packet | timeout_fee     | {timeoutFee}    |
+| message                 | module          | fee-ibc         |
+
+## `RegisterPayee`
+
+| Type           | Attribute Key | Attribute Value |
+|----------------|------------|--------------------|
+| register_payee | relayer    | {relayer}          |
+| register_payee | payee      | {payee}            |
+| register_payee | channel_id | {channelID}        |
+| message        | module     | fee-ibc            |
+
+## `RegisterCounterpartyPayee`
+
+| Type                        | Attribute Key      | Attribute Value     |
+|-----------------------------|--------------------|---------------------|
+| register_counterparty_payee | relayer            | {relayer}           |
+| register_counterparty_payee | counterparty_payee | {counterpartyPayee} |
+| register_counterparty_payee | channel_id         | {channelID}         |
+| message                     | module             | fee-ibc             |

docs/middleware/ics29-fee/fee-distribution.md

@@ -0,0 +1,90 @@
+<!--
+order: 4
+-->
+
+# Fee Distribution
+
+Learn about payee registration for distribution of packet fees. The following document is intended for relayer operators {synopsis}
+
+## Pre-requisite Readings
+
+* [Fee Middleware](overview.md) {prereq}
+
+Packet fees are divided into 3 distinct amounts in order to compensate relayer operators for packet relaying on fee enabled IBC channels.
+
+- `RecvFee`: The sum of all packet receive fees distributed to a payee for successful execution of `MsgRecvPacket`.
+- `AckFee`: The sum of all packet acknowledgement fees distributed to a payee for successful execution of `MsgAcknowledgement`.
+- `TimeoutFee`: The sum of all packet timeout fees distributed to a payee for successful execution of `MsgTimeout`.
+
+## Register a payee address for forward relaying
+
+As mentioned previously in [ICS29 Concepts](../ics29-fee/overview.md#concepts), the forward relayer describes the actor who performs the submission of `MsgRecvPacket` on the destination chain. 
+Fee distribution for incentivized packet relays takes place on the packet source chain. 
+Relayer operators are expected to register a counterparty payee address, in order to be compensated accordingly with `RecvFees` upon completion of a packet lifecycle. 
+The counterparty payee address registered on the destination chain is encoded into the packet acknowledgement and communicated as such to the source chain for fee distribution.
+If a counterparty payee is not registered for the forward relayer on the destination chain, the escrowed fees will be refunded upon fee distribution.
+
+A transaction must be submitted to the desintation chain including a `CounterpartyPayee` address of an account on the source chain.
+The transaction must be signed by the `Relayer`.
+
+```go
+type MsgRegisterCounterpartyPayee struct {
+	// unique port identifier
+	PortId string
+	// unique channel identifier
+	ChannelId string
+	// the relayer address
+	Relayer string
+	// the counterparty payee address
+	CounterpartyPayee string
+}
+```
+
+This message is expected to fail if:
+
+- `PortId` is invalid (see [24-host naming requirements](https://github.com/cosmos/ibc/blob/master/spec/core/ics-024-host-requirements/README.md#paths-identifiers-separators).
+- `ChannelId` is invalid (see [24-host naming requirements](https://github.com/cosmos/ibc/blob/master/spec/core/ics-024-host-requirements/README.md#paths-identifiers-separators)).
+- `Relayer` is an invalid address (see [Cosmos SDK Addresses](https://github.com/cosmos/cosmos-sdk/blob/main/docs/basics/accounts.md#Addresses)).
+- `CounterpartyPayee` is empty.
+
+See below for an example CLI command:
+
+```
+simd tx ibc-fee register-counterparty-payee transfer channel-0 cosmos1rsp837a4kvtgp2m4uqzdge0zzu6efqgucm0qdh osmo1v5y0tz01llxzf4c2afml8s3awue0ymju22wxx2 --from cosmos1rsp837a4kvtgp2m4uqzdge0zzu6efqgucm0qdh
+```
+
+## Register a payee address for reverse and timeout relaying
+
+As mentioned previously in [ICS29 Concepts](../ics29-fee/overview.md#concepts), the reverse relayer describes the actor who performs the submission of `MsgAcknowledgement` on the source chain. 
+Similarly the timeout relayer describes the actor who performs the submission of `MsgTimeout` on the source chain.
+Relayer operators may choose to register an optional payee address, in order to be compensated accordingly with `AckFees` and `TimeoutFees` upon completion of a packet life cycle.
+If a payee is not registered for the reverse or timeout relayer on the source chain, then fee distribution assumes the default behaviour, where fees are paid out to the relayer account which delivers `MsgAcknowledgement` or `MsgTimeout`.
+
+A transaction must be submitted to the source chain including a `Payee` address of an account on the source chain.
+The transaction must be signed by the `Relayer`.
+
+```go
+type MsgRegisterPayee struct {
+	// unique port identifier
+	PortId string
+	// unique channel identifier
+	ChannelId string
+	// the relayer address
+	Relayer string
+	// the payee address
+	Payee string
+}
+```
+
+This message is expected to fail if:
+
+- `PortId` is invalid (see [24-host naming requirements](https://github.com/cosmos/ibc/blob/master/spec/core/ics-024-host-requirements/README.md#paths-identifiers-separators).
+- `ChannelId` is invalid (see [24-host naming requirements](https://github.com/cosmos/ibc/blob/master/spec/core/ics-024-host-requirements/README.md#paths-identifiers-separators)).
+- `Relayer` is an invalid address (see [Cosmos SDK Addresses](https://github.com/cosmos/cosmos-sdk/blob/main/docs/basics/accounts.md#Addresses)).
+- `Payee` is an invalid address (see [Cosmos SDK Addresses](https://github.com/cosmos/cosmos-sdk/blob/main/docs/basics/accounts.md#Addresses)).
+
+See below for an example CLI command:
+
+```
+simd tx ibc-fee register-payee transfer channel-0 cosmos1rsp837a4kvtgp2m4uqzdge0zzu6efqgucm0qdh cosmos153lf4zntqt33a4v0sm5cytrxyqn78q7kz8j8x5 --from cosmos1rsp837a4kvtgp2m4uqzdge0zzu6efqgucm0qdh
+```