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

Add section about wiring up fee middleware and executing gov proposal #5504

Conversation

chatton
Copy link
Contributor

@chatton chatton commented Jan 2, 2024

Description

closes: #5273


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 the correct branch (see CONTRIBUTING.md).
  • Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
  • Code follows the module structure standards and Go style guide.
  • Wrote unit and integration tests.
  • Updated relevant documentation (docs/) or specification (x/<module>/spec/).
  • Added relevant godoc comments.
  • Provide a commit message to be used for the changelog entry in the PR description for review.
  • Re-reviewed Files changed in the Github PR explorer.
  • Review Codecov Report in the comment section below once CI passes.

@chatton chatton added docs Improvements or additions to documentation channel-upgradability Channel upgradability feature labels Jan 2, 2024
Copy link
Member

@damiannolan damiannolan left a comment

Choose a reason for hiding this comment

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

Awesome, left some minor wording suggestions. LGTM


### Submit a governance proposal to execute a MsgChanUpgradeInit message

Only an authority is able to initiate a channel upgrade by submitting a `MsgChanUpgradeInit` message.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Only an authority is able to initiate a channel upgrade by submitting a `MsgChanUpgradeInit` message.
Only the configured authority for the ibc module is able to initiate a channel upgrade by submitting a `MsgChannelUpgradeInit` message.

ibcRouter.AddRoute(ibctransfertypes.ModuleName, transferStack)
```

### Submit a governance proposal to execute a MsgChanUpgradeInit message
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
### Submit a governance proposal to execute a MsgChanUpgradeInit message
### Submit a governance proposal to execute a MsgChannelUpgradeInit message

@@ -164,3 +164,94 @@ IBC application callbacks should be primarily used to validate data fields and d
> IBC applications should not attempt to process any packet data under the new conditions until after `OnChanUpgradeOpen`
> has been executed, as up until this point it is still possible for the upgrade handshake to fail and for the channel
> to remain in the pre-upgraded state.

## Upgrade existing transfer stack to be fee enabled
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
## Upgrade existing transfer stack to be fee enabled
## Upgrade an existing transfer application stack to use 29-fee middleware

"fields": {
"ordering": "ORDER_UNORDERED",
"connection_hops": ["connection-0"],
"version": "{\"fee_version\":\"ics29-1\",\"app_version\":\"ics20-1\"}"
Copy link
Member

Choose a reason for hiding this comment

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

Should we add a note saying that changing the version is the important part?

@chatton chatton mentioned this pull request Jan 9, 2024
9 tasks
@chatton chatton enabled auto-merge (squash) January 10, 2024 09:52
@chatton chatton merged commit e096fc6 into main Jan 10, 2024
18 of 19 checks passed
@chatton chatton deleted the cian/issue#5273-add-tutorial-for-upgrading-existing-transfer-channel branch January 10, 2024 09:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
channel-upgradability Channel upgradability feature docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Tutorial for upgrading an existing transfer channel to wire up fee middleware.
5 participants