docs: adding events to fee middleware docs (cosmos#1578)

* adding fee distribution docs for relayer operators * adding validation information and basic cli examples * removing unnecessary whitespace * updating definitions * adding ics29 fee middleware events docs * cleanup Co-authored-by: Sean King <[email protected]>
polymerdao · Jun 27, 2022 · 36a3382 · 36a3382
1 parent 3b5db68
commit 36a3382
Show file tree

Hide file tree

Showing 2 changed files with 40 additions and 0 deletions.
diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
@@ -248,6 +248,11 @@ module.exports = {
                   directory: false,
                   path: "/middleware/ics29-fee/fee-distribution.html"
                 },
+                {
+                  title: "Events",
+                  directory: false,
+                  path: "/middleware/ics29-fee/events.html"
+                },
               ]
             },
           ]

diff --git a/docs/middleware/ics29-fee/events.md b/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             |