From bc2c447e225d9f066e030f68ae53cc473814a33d Mon Sep 17 00:00:00 2001 From: Sean King Date: Fri, 24 Jun 2022 19:22:04 +0200 Subject: [PATCH 01/11] docs: adding End Users section to ics29 docs --- docs/.vuepress/config.js | 5 +++++ docs/middleware/ics29-fee/end-users.md | 31 ++++++++++++++++++++++++++ 2 files changed, 36 insertions(+) create mode 100644 docs/middleware/ics29-fee/end-users.md diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 5183df990c1..47ae73970ed 100644 --- 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" + }, ] }, ] diff --git a/docs/middleware/ics29-fee/end-users.md b/docs/middleware/ics29-fee/end-users.md new file mode 100644 index 00000000000..975c3289585 --- /dev/null +++ b/docs/middleware/ics29-fee/end-users.md @@ -0,0 +1,31 @@ + + +# For End Users + +Learn how to incentivize IBC packets using the ICS29-Fee 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 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](). + +[CosmJS](https://github.com/cosmos/cosmjs) is a useful client tool for signing and broadcasting cosmos SDK messages. From 98c8f4da36c109f4e23eee22fafcd1bb7f53d908 Mon Sep 17 00:00:00 2001 From: Sean King Date: Sat, 25 Jun 2022 00:20:17 +0200 Subject: [PATCH 02/11] Update docs/middleware/ics29-fee/end-users.md Co-authored-by: Carlos Rodriguez --- docs/middleware/ics29-fee/end-users.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/middleware/ics29-fee/end-users.md b/docs/middleware/ics29-fee/end-users.md index 975c3289585..05d1507f9d7 100644 --- a/docs/middleware/ics29-fee/end-users.md +++ b/docs/middleware/ics29-fee/end-users.md @@ -2,7 +2,7 @@ order: 6 --> -# For End Users +# For end users Learn how to incentivize IBC packets using the ICS29-Fee module. {synopsis} From d499902de24acc971aba0f793b2dc364b2241127 Mon Sep 17 00:00:00 2001 From: Sean King Date: Sat, 25 Jun 2022 00:20:24 +0200 Subject: [PATCH 03/11] Update docs/middleware/ics29-fee/end-users.md Co-authored-by: Carlos Rodriguez --- docs/middleware/ics29-fee/end-users.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/middleware/ics29-fee/end-users.md b/docs/middleware/ics29-fee/end-users.md index 05d1507f9d7..d6773da36ec 100644 --- a/docs/middleware/ics29-fee/end-users.md +++ b/docs/middleware/ics29-fee/end-users.md @@ -6,7 +6,7 @@ order: 6 Learn how to incentivize IBC packets using the ICS29-Fee module. {synopsis} -## Pre-requisite Readings +## Pre-requisite readings * [Fee Middleware](overview.md) {prereq} From f5d6344700c8e9f759a998605724be3f7f3f25d1 Mon Sep 17 00:00:00 2001 From: Sean King Date: Sat, 25 Jun 2022 00:20:32 +0200 Subject: [PATCH 04/11] Update docs/middleware/ics29-fee/end-users.md Co-authored-by: Carlos Rodriguez --- docs/middleware/ics29-fee/end-users.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/middleware/ics29-fee/end-users.md b/docs/middleware/ics29-fee/end-users.md index d6773da36ec..70ad3e93e60 100644 --- a/docs/middleware/ics29-fee/end-users.md +++ b/docs/middleware/ics29-fee/end-users.md @@ -14,7 +14,7 @@ Learn how to incentivize IBC packets using the ICS29-Fee module. {synopsis} Different types of end users: -- CLI Users who want to manually incentivize IBC packets +- CLI users who want to manually incentivize IBC packets - Client Developers From d75068254464cfe860d053b823ae453fab957571 Mon Sep 17 00:00:00 2001 From: Sean King Date: Sat, 25 Jun 2022 00:20:41 +0200 Subject: [PATCH 05/11] Update docs/middleware/ics29-fee/end-users.md Co-authored-by: Carlos Rodriguez --- docs/middleware/ics29-fee/end-users.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/middleware/ics29-fee/end-users.md b/docs/middleware/ics29-fee/end-users.md index 70ad3e93e60..ba6b9913b06 100644 --- a/docs/middleware/ics29-fee/end-users.md +++ b/docs/middleware/ics29-fee/end-users.md @@ -15,7 +15,7 @@ Learn how to incentivize IBC packets using the ICS29-Fee module. {synopsis} Different types of end users: - CLI users who want to manually incentivize IBC packets -- Client Developers +- 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. From c67539651e8f0ae2d2b9c41c4a3df3c894e13e67 Mon Sep 17 00:00:00 2001 From: Sean King Date: Sat, 25 Jun 2022 00:20:46 +0200 Subject: [PATCH 06/11] Update docs/middleware/ics29-fee/end-users.md Co-authored-by: Carlos Rodriguez --- docs/middleware/ics29-fee/end-users.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/middleware/ics29-fee/end-users.md b/docs/middleware/ics29-fee/end-users.md index ba6b9913b06..ddae7bbc028 100644 --- a/docs/middleware/ics29-fee/end-users.md +++ b/docs/middleware/ics29-fee/end-users.md @@ -18,7 +18,7 @@ Different types of end users: - 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. +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 From 7fe567f6ae21588f48cc751c64a965f8b6033cd2 Mon Sep 17 00:00:00 2001 From: Sean King Date: Sat, 25 Jun 2022 00:20:59 +0200 Subject: [PATCH 07/11] Update docs/middleware/ics29-fee/end-users.md Co-authored-by: Carlos Rodriguez --- docs/middleware/ics29-fee/end-users.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/middleware/ics29-fee/end-users.md b/docs/middleware/ics29-fee/end-users.md index ddae7bbc028..0158d06ee1d 100644 --- a/docs/middleware/ics29-fee/end-users.md +++ b/docs/middleware/ics29-fee/end-users.md @@ -22,7 +22,7 @@ The Fee Middleware module allows end users to add a 'tip' to each IBC packet whi ## 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. +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 From 4a3fffbcb346466733a7c98d9522597de5ca6596 Mon Sep 17 00:00:00 2001 From: Sean King Date: Sat, 25 Jun 2022 00:21:05 +0200 Subject: [PATCH 08/11] Update docs/middleware/ics29-fee/end-users.md Co-authored-by: Carlos Rodriguez --- docs/middleware/ics29-fee/end-users.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/middleware/ics29-fee/end-users.md b/docs/middleware/ics29-fee/end-users.md index 0158d06ee1d..fb2382edcf6 100644 --- a/docs/middleware/ics29-fee/end-users.md +++ b/docs/middleware/ics29-fee/end-users.md @@ -24,7 +24,7 @@ The Fee Middleware module allows end users to add a 'tip' to each IBC packet whi 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 Client developers can read more about the relevant ICS29 message types in the [Escrowing and paying out fees section](). From 926d525c44553f91bd64f0e0981bcb474ef088bf Mon Sep 17 00:00:00 2001 From: Sean King Date: Sat, 25 Jun 2022 00:21:12 +0200 Subject: [PATCH 09/11] Update docs/middleware/ics29-fee/end-users.md Co-authored-by: Carlos Rodriguez --- docs/middleware/ics29-fee/end-users.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/middleware/ics29-fee/end-users.md b/docs/middleware/ics29-fee/end-users.md index fb2382edcf6..daf209d5b82 100644 --- a/docs/middleware/ics29-fee/end-users.md +++ b/docs/middleware/ics29-fee/end-users.md @@ -4,7 +4,7 @@ order: 6 # For end users -Learn how to incentivize IBC packets using the ICS29-Fee module. {synopsis} +Learn how to incentivize IBC packets using the ICS29 Fee Middleware module. {synopsis} ## Pre-requisite readings From 5d3660d09c77251ce9bf5d5468b95d45df4dda2c Mon Sep 17 00:00:00 2001 From: Sean King Date: Mon, 27 Jun 2022 17:08:08 +0200 Subject: [PATCH 10/11] Update docs/middleware/ics29-fee/end-users.md Co-authored-by: Damian Nolan --- docs/middleware/ics29-fee/end-users.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/middleware/ics29-fee/end-users.md b/docs/middleware/ics29-fee/end-users.md index daf209d5b82..d16b7f774df 100644 --- a/docs/middleware/ics29-fee/end-users.md +++ b/docs/middleware/ics29-fee/end-users.md @@ -28,4 +28,4 @@ For an in depth guide on how to use the ICS29 Fee Middleware module using the CL Client developers can read more about the relevant ICS29 message types in the [Escrowing and paying out fees section](). -[CosmJS](https://github.com/cosmos/cosmjs) is a useful client tool for signing and broadcasting cosmos SDK messages. +[CosmJS](https://github.com/cosmos/cosmjs) is a useful client library for signing and broadcasting Cosmos SDK messages. From b646637cf95054c963b5cac9f5e191d8887a3245 Mon Sep 17 00:00:00 2001 From: Sean King Date: Mon, 27 Jun 2022 17:11:16 +0200 Subject: [PATCH 11/11] chore: add link --- docs/middleware/ics29-fee/end-users.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/middleware/ics29-fee/end-users.md b/docs/middleware/ics29-fee/end-users.md index d16b7f774df..08857d21a37 100644 --- a/docs/middleware/ics29-fee/end-users.md +++ b/docs/middleware/ics29-fee/end-users.md @@ -26,6 +26,6 @@ For an in depth guide on how to use the ICS29 Fee Middleware module using the CL ## Client developers -Client developers can read more about the relevant ICS29 message types in the [Escrowing and paying out fees section](). +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.