docs: adding End Users section to ics29 docs (cosmos#1579)

* docs: adding End Users section to ics29 docs * Update docs/middleware/ics29-fee/end-users.md Co-authored-by: Carlos Rodriguez <[email protected]> * Update docs/middleware/ics29-fee/end-users.md Co-authored-by: Carlos Rodriguez <[email protected]> * Update docs/middleware/ics29-fee/end-users.md Co-authored-by: Carlos Rodriguez <[email protected]> * Update docs/middleware/ics29-fee/end-users.md Co-authored-by: Carlos Rodriguez <[email protected]> * Update docs/middleware/ics29-fee/end-users.md Co-authored-by: Carlos Rodriguez <[email protected]> * Update docs/middleware/ics29-fee/end-users.md Co-authored-by: Carlos Rodriguez <[email protected]> * Update docs/middleware/ics29-fee/end-users.md Co-authored-by: Carlos Rodriguez <[email protected]> * Update docs/middleware/ics29-fee/end-users.md Co-authored-by: Carlos Rodriguez <[email protected]> * Update docs/middleware/ics29-fee/end-users.md Co-authored-by: Damian Nolan <[email protected]> * chore: add link Co-authored-by: Carlos Rodriguez <[email protected]> Co-authored-by: Damian Nolan <[email protected]>
polymerdao · Jun 27, 2022 · 83ca736 · 83ca736
1 parent 36a3382
commit 83ca736
Show file tree

Hide file tree

Showing 2 changed files with 36 additions and 0 deletions.
diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
@@ -238,6 +238,11 @@ module.exports = {
                   directory: false,
                   path: "/middleware/ics29-fee/integration.html"
                 },
+                {
+                  title: "End Users",
+                  directory: false,
+                  path: "/middleware/ics29-fee/end-users.html"
+                },
                 {
                   title: "Fee Messages",
                   directory: false,

diff --git a/docs/middleware/ics29-fee/end-users.md b/docs/middleware/ics29-fee/end-users.md
@@ -0,0 +1,31 @@
+<!--
+order: 6
+-->
+
+# For end users
+
+Learn how to incentivize IBC packets using the ICS29 Fee Middleware module. {synopsis}
+
+## Pre-requisite readings
+
+* [Fee Middleware](overview.md) {prereq}
+
+## Summary
+
+Different types of end users:
+
+- CLI users who want to manually incentivize IBC packets
+- Client developers
+
+
+The Fee Middleware module allows end users to add a 'tip' to each IBC packet which will incentivize relayer operators to relay packets between chains. gRPC endpoints are exposed for client developers as well as a simple CLI for manually incentivizing IBC packets.
+
+## CLI Users
+
+For an in depth guide on how to use the ICS29 Fee Middleware module using the CLI please take a look at the [wiki](https://github.com/cosmos/ibc-go/wiki/Fee-enabled-fungible-token-transfers#asynchronous-incentivization-of-a-fungible-token-transfer) on the `ibc-go` repo.
+
+## Client developers
+
+Client developers can read more about the relevant ICS29 message types in the [Escrowing and paying out fees section](../ics29-fee/msgs.md).
+
+[CosmJS](https://github.com/cosmos/cosmjs) is a useful client library for signing and broadcasting Cosmos SDK messages.