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

doc: adding migration doc info for nil legacy subspace #4816

Merged
merged 5 commits into from
Oct 5, 2023
Merged
Changes from 1 commit
Commits
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
18 changes: 14 additions & 4 deletions docs/docs/05-migrations/11-v7-to-v8.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,18 @@
There are four sections based on the four potential user groups of this document:

- [Migrating from v7 to v8](#migrating-from-v7-to-v8)
- [Chains](#chains)
- [IBC Apps](#ibc-apps)
- [Relayers](#relayers)
- [IBC Light Clients](#ibc-light-clients)
- [Chains](#chains)

Check failure on line 15 in docs/docs/05-migrations/11-v7-to-v8.md

View workflow job for this annotation

GitHub Actions / lint

Unordered list indentation

docs/docs/05-migrations/11-v7-to-v8.md:15:1 MD007/ul-indent Unordered list indentation [Expected: 4; Actual: 2] https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md007.md
damiannolan marked this conversation as resolved.
Show resolved Hide resolved
- [Cosmos SDK v0.50 upgrade](#cosmos-sdk-v050-upgrade)

Check failure on line 16 in docs/docs/05-migrations/11-v7-to-v8.md

View workflow job for this annotation

GitHub Actions / lint

Unordered list indentation

docs/docs/05-migrations/11-v7-to-v8.md:16:1 MD007/ul-indent Unordered list indentation [Expected: 8; Actual: 4] https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md007.md
- [Authority](#authority)

Check failure on line 17 in docs/docs/05-migrations/11-v7-to-v8.md

View workflow job for this annotation

GitHub Actions / lint

Unordered list indentation

docs/docs/05-migrations/11-v7-to-v8.md:17:1 MD007/ul-indent Unordered list indentation [Expected: 8; Actual: 4] https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md007.md
- [Testing package](#testing-package)

Check failure on line 18 in docs/docs/05-migrations/11-v7-to-v8.md

View workflow job for this annotation

GitHub Actions / lint

Unordered list indentation

docs/docs/05-migrations/11-v7-to-v8.md:18:1 MD007/ul-indent Unordered list indentation [Expected: 8; Actual: 4] https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md007.md
- [Params migration](#params-migration)

Check failure on line 19 in docs/docs/05-migrations/11-v7-to-v8.md

View workflow job for this annotation

GitHub Actions / lint

Unordered list indentation

docs/docs/05-migrations/11-v7-to-v8.md:19:1 MD007/ul-indent Unordered list indentation [Expected: 8; Actual: 4] https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md007.md
- [Governance V1 migration](#governance-v1-migration)

Check failure on line 20 in docs/docs/05-migrations/11-v7-to-v8.md

View workflow job for this annotation

GitHub Actions / lint

Unordered list indentation

docs/docs/05-migrations/11-v7-to-v8.md:20:1 MD007/ul-indent Unordered list indentation [Expected: 8; Actual: 4] https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md007.md
- [Transfer migration](#transfer-migration)

Check failure on line 21 in docs/docs/05-migrations/11-v7-to-v8.md

View workflow job for this annotation

GitHub Actions / lint

Unordered list indentation

docs/docs/05-migrations/11-v7-to-v8.md:21:1 MD007/ul-indent Unordered list indentation [Expected: 8; Actual: 4] https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md007.md
- [IBC Apps](#ibc-apps)

Check failure on line 22 in docs/docs/05-migrations/11-v7-to-v8.md

View workflow job for this annotation

GitHub Actions / lint

Unordered list indentation

docs/docs/05-migrations/11-v7-to-v8.md:22:1 MD007/ul-indent Unordered list indentation [Expected: 4; Actual: 2] https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md007.md
- [ICS20 - Transfer](#ics20---transfer)

Check failure on line 23 in docs/docs/05-migrations/11-v7-to-v8.md

View workflow job for this annotation

GitHub Actions / lint

Unordered list indentation

docs/docs/05-migrations/11-v7-to-v8.md:23:1 MD007/ul-indent Unordered list indentation [Expected: 8; Actual: 4] https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md007.md
- [ICS27 - Interchain Accounts](#ics27---interchain-accounts)

Check failure on line 24 in docs/docs/05-migrations/11-v7-to-v8.md

View workflow job for this annotation

GitHub Actions / lint

Unordered list indentation

docs/docs/05-migrations/11-v7-to-v8.md:24:1 MD007/ul-indent Unordered list indentation [Expected: 8; Actual: 4] https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md007.md
- [Relayers](#relayers)
- [IBC Light Clients](#ibc-light-clients)

**Note:** ibc-go supports golang semantic versioning and therefore all imports must be updated on major version releases.

Expand Down Expand Up @@ -138,6 +146,8 @@

Legacy params subspaces must still be initialised in app.go in order to successfully migrate from x/params to the new self-contained approach. See reference: <https://github.com/cosmos/ibc-go/blob/main/testing/simapp/app.go#L1001-L1006>

For new chains which do not rely on migration of parameters from `x/params`, an expected interface has been added for each module. This allows chain developers to provide `nil` as the `legacySubspace` argument to `NewKeeper` functions.

### Governance V1 migration

Proposals have been migrated to [gov v1 messages](https://docs.cosmos.network/v0.50/modules/gov#messages) ref: [#4620](https://github.com/cosmos/ibc-go/pull/4620). The proposal `ClientUpdateProposal` has been deprecated and [`MsgRecoverClient`](https://github.com/cosmos/ibc-go/blob/v8.0.0-beta.0/proto/ibc/core/client/v1/tx.proto#L121-L134) should be used instead. Likewise, the proposal `UpgradeProposal` has been deprecated and [`MsgIBCSoftwareUpgrade`](https://github.com/cosmos/ibc-go/blob/v8.0.0-beta.0/proto/ibc/core/client/v1/tx.proto#L139-L154) should be used instead. Both proposals will be removed in the next major release.
Expand Down
Loading