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

chore: update fee middleware docs to be more explicit about reasoning for removing invariant checks #1705

Merged
merged 26 commits into from
Aug 12, 2022
Merged
Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
96f3c49
fix broken link
charleenfei Jun 10, 2022
250e45f
Merge branch 'main' of github.com:cosmos/ibc-go
charleenfei Jun 14, 2022
bf3b96b
Merge branch 'main' of github.com:cosmos/ibc-go
charleenfei Jun 16, 2022
ed4a153
fix: rm AllowUpdateAfter... check (#1118)
charleenfei Jun 14, 2022
8018627
Merge branch 'main' of github.com:cosmos/ibc-go
charleenfei Jun 16, 2022
08e71e7
Merge branch 'main' of github.com:cosmos/ibc-go
charleenfei Jun 20, 2022
05f50c4
Merge branch 'main' of github.com:cosmos/ibc-go
charleenfei Jun 23, 2022
169ead2
Merge branch 'main' of github.com:cosmos/ibc-go
charleenfei Jun 24, 2022
7c46b84
Merge branch 'main' of github.com:cosmos/ibc-go
charleenfei Jul 5, 2022
27998dd
erge branch 'main' of github.com:cosmos/ibc-go
charleenfei Jul 6, 2022
952b114
Merge branch 'main' of github.com:cosmos/ibc-go
charleenfei Jul 8, 2022
f673132
Merge branch 'main' of github.com:cosmos/ibc-go
charleenfei Jul 12, 2022
78d4616
Merge branch 'main' of github.com:cosmos/ibc-go
charleenfei Jul 14, 2022
ac4034d
updated fee middleware docs wrt invariants
charleenfei Jul 14, 2022
261bf77
second review
charleenfei Jul 15, 2022
822b415
Merge branch 'main' into charly/update_docs_invariants
charleenfei Jul 19, 2022
16e24e1
Merge branch 'main' into charly/update_docs_invariants
charleenfei Jul 19, 2022
ce863d1
Merge branch 'main' into charly/update_docs_invariants
charleenfei Jul 19, 2022
076dcaf
Merge branch 'main' into charly/update_docs_invariants
charleenfei Jul 19, 2022
fd5b39a
Merge branch 'main' into charly/update_docs_invariants
charleenfei Jul 19, 2022
dc88634
Merge branch 'main' into charly/update_docs_invariants
charleenfei Jul 21, 2022
a80b633
update docs to remove language about removing invariants
charleenfei Aug 8, 2022
415921a
update docs/middleware/ics29-fee/fee-distribution.md
charleenfei Aug 11, 2022
a0cbad5
Merge branch 'main' into charly/update_docs_invariants
charleenfei Aug 11, 2022
ab103c9
Merge branch 'main' into charly/update_docs_invariants
charleenfei Aug 11, 2022
c006389
Merge branch 'main' into charly/update_docs_invariants
crodriguezvega Aug 12, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/middleware/ics29-fee/fee-distribution.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ The counterparty payee address registered on the destination chain is encoded in
A transaction must be submitted **to the destination chain** including a `CounterpartyPayee` address of an account on the source chain.
The transaction must be signed by the `Relayer`.

Note: If a module account address is used as the `CounterpartyPayee` it is recommended to [turn off invariant checks](https://github.com/cosmos/ibc-go/blob/71d7480c923f4227453e8a80f51be01ae7ee845e/testing/simapp/app.go#L659) for that module.
Note: If a module account address is used as the `CounterpartyPayee` but the module has been set as a blocked address in the `BankKeeper`, the refunding to the module account will fail. This is because many modules use invariants to compare internal tracking of module account balances against the actual balance of the account stored in the `BankKeeper`. If a token transfer to the module account occurs without going through this module and updating the account balance of the module on the `BankKeeper`, then invariants may break and unknown behaviour could occur depending on the module implementation. Therefore, if it is desirable to use a module account that is currently blocked, the module developers should be consulted to gauge to possibility of removing the module account from the blocked list.

```go
type MsgRegisterCounterpartyPayee struct {
Expand Down