From 5adc8302620821c43216b95715f093c70a515397 Mon Sep 17 00:00:00 2001
From: "mergify[bot]" <37929162+mergify[bot]@users.noreply.github.com>
Date: Tue, 27 Sep 2022 13:34:10 +0200
Subject: [PATCH] docs: add ics29 integration for sdk module (#2394) (#2409)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

## Description

closes: #2354

---

Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

- [ ] Targeted PR against correct branch (see [CONTRIBUTING.md](https://github.com/cosmos/ibc-go/blob/master/CONTRIBUTING.md#pr-targeting))
- [ ] Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
- [ ] Code follows the [module structure standards](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules/structure.md).
- [ ] Wrote unit and integration [tests](https://github.com/cosmos/ibc-go/blob/master/CONTRIBUTING.md#testing)
- [ ] Updated relevant documentation (`docs/`) or specification (`x/<module>/spec/`)
- [ ] Added relevant `godoc` [comments](https://blog.golang.org/godoc-documenting-go-code).
- [ ] Added a relevant changelog entry to the `Unreleased` section in `CHANGELOG.md`
- [ ] Re-reviewed `Files changed` in the Github PR explorer
- [ ] Review `Codecov Report` in the comment section below once CI passes

(cherry picked from commit e470057e69612f1f138b894146850f40d5c0b2ba)

Co-authored-by: colin axnér <25233464+colin-axner@users.noreply.github.com>
---
 docs/middleware/ics29-fee/integration.md | 86 +++++++++++++++++++++++-
 1 file changed, 85 insertions(+), 1 deletion(-)

diff --git a/docs/middleware/ics29-fee/integration.md b/docs/middleware/ics29-fee/integration.md
index f1d0158e702..8f11998c456 100644
--- a/docs/middleware/ics29-fee/integration.md
+++ b/docs/middleware/ics29-fee/integration.md
@@ -14,6 +14,90 @@ Learn how to configure the Fee Middleware module with IBC applications. The foll
 The Fee Middleware module, as the name suggests, plays the role of an IBC middleware and as such must be configured by chain developers to route and handle IBC messages correctly.
 For Cosmos SDK chains this setup is done via the `app/app.go` file, where modules are constructed and configured in order to bootstrap the blockchain application.
 
+## Example integration of the Fee Middleware module
+
+```
+// app.go
+
+// Register the AppModule for the fee middleware module
+ModuleBasics = module.NewBasicManager(
+    ...
+    ibcfee.AppModuleBasic{},
+    ...
+)
+
+... 
+
+// Add module account permissions for the fee middleware module
+maccPerms = map[string][]string{
+    ...
+    ibcfeetypes.ModuleName:            nil,
+}
+
+...
+
+// Add fee middleware Keeper
+type App struct {
+    ...
+
+    IBCFeeKeeper ibcfeekeeper.Keeper
+
+    ...
+}
+
+...
+
+// Create store keys 
+keys := sdk.NewKVStoreKeys(
+    ...
+    ibcfeetypes.StoreKey,
+    ...
+)
+
+... 
+
+app.IBCFeeKeeper = ibcfeekeeper.NewKeeper(
+	appCodec, keys[ibcfeetypes.StoreKey],
+	app.IBCKeeper.ChannelKeeper, // may be replaced with IBC middleware
+	app.IBCKeeper.ChannelKeeper,
+	&app.IBCKeeper.PortKeeper, app.AccountKeeper, app.BankKeeper,
+)
+
+
+// See the section below for configuring an application stack with the fee middleware module
+
+...
+
+// Register fee middleware AppModule
+app.moduleManager = module.NewManager(
+    ...
+    ibcfee.NewAppModule(app.IBCFeeKeeper),
+)
+
+...
+
+// Add fee middleware to begin blocker logic
+app.mm.SetOrderBeginBlockers(
+    ...
+    ibcfeetypes.ModuleName,
+    ...
+)
+
+// Add fee middleware to end blocker logic
+app.mm.SetOrderEndBlockers(
+    ...
+    ibcfeetypes.ModuleName,
+    ...
+)
+
+// Add fee middleware to init genesis logic
+app.mm.SetOrderInitGenesis(
+    ...
+    ibcfeetypes.ModuleName,
+    ...
+)
+```
+
 ## Configuring an application stack with Fee Middleware
 
 As mentioned in [IBC middleware development](../../ibc/middleware/develop.md) an application stack may be composed of many or no middlewares that nest a base application. 
@@ -82,4 +166,4 @@ ibcRouter.
     AddRoute(ibcmock.ModuleName+icacontrollertypes.SubModuleName, icaControllerStack) // ica with mock auth module stack route to ica (top level of middleware stack)
     AddRoute(icacontrollertypes.SubModuleName, icaControllerStack).
     AddRoute(icahosttypes.SubModuleName, icaHostStack).
-```
\ No newline at end of file
+```