Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: adding End Users section to ics29 docs #1579

Merged
merged 13 commits into from
Jun 27, 2022
Merged
5 changes: 5 additions & 0 deletions docs/.vuepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -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"
},
]
},
]
Expand Down
31 changes: 31 additions & 0 deletions docs/middleware/ics29-fee/end-users.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
<!--
order: 6
-->

# For End Users
seantking marked this conversation as resolved.
Show resolved Hide resolved

Learn how to incentivize IBC packets using the ICS29-Fee module. {synopsis}
seantking marked this conversation as resolved.
Show resolved Hide resolved

## Pre-requisite Readings
seantking marked this conversation as resolved.
Show resolved Hide resolved

* [Fee Middleware](overview.md) {prereq}

## Summary

Different types of end users:

- CLI Users who want to manually incentivize IBC packets
seantking marked this conversation as resolved.
Show resolved Hide resolved
- Client Developers
seantking marked this conversation as resolved.
Show resolved Hide resolved


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.
seantking marked this conversation as resolved.
Show resolved Hide resolved

## CLI Users

For an in depth guide on how to use the ICS29 Fee 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.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can keep this section simple as there's no point in re-creating the wheel. Most people won't use the CLI anyway.

seantking marked this conversation as resolved.
Show resolved Hide resolved

## Client Developers
seantking marked this conversation as resolved.
Show resolved Hide resolved

Client developers can read more about the relevant ICS29 message types in the [Escrowing and paying out fees section]().
Copy link
Contributor Author

@seantking seantking Jun 24, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm thinking we can link to @charleenfei work on message types once this is merged in.


[CosmJS](https://github.com/cosmos/cosmjs) is a useful client tool for signing and broadcasting cosmos SDK messages.
seantking marked this conversation as resolved.
Show resolved Hide resolved