osmosis-labs / osmosis

The AMM Laboratory
https://app.osmosis.zone
Apache License 2.0
892 stars 593 forks source link

fix: state export for gov module constitution #8777

Closed PaddyMc closed 1 month ago

PaddyMc commented 1 month ago

What is the purpose of the change

Currently the export of Osmosis to genesis state isn't working as expected because of the export of gov is missing a gov collection key.

see: https://github.com/cosmos/cosmos-sdk/issues/21887

Testing and Verifying

Unit test:

in-place-testnet:

Query: osmosisd q gov constitution

BUG:

panic: collections: not found: key 'no_key' of type string

goroutine 4433 [running]:
github.com/cosmos/cosmos-sdk/x/gov.AppModule.ExportGenesis({{{0x6283970, 0xc000fae690}, {0x0, 0x0, 0x0}, {0x6200fc8, 0xc00217ee40}}, 0xc0043a8408, {0x6241700, 0xc000356500}, ...}, ...)
    github.com/cosmos/cosmos-sdk@v0.50.9/x/gov/module.go:310 +0xbf
github.com/cosmos/cosmos-sdk/types/module.(*Manager).ExportGenesisForModules.func2({0x789e1f0e1468, 0xc0043ccfc0}, 0xc063aa9260)
    github.com/cosmos/cosmos-sdk@v0.50.9/types/module/module.go:578 +0x12d
created by github.com/cosmos/cosmos-sdk/types/module.(*Manager).ExportGenesisForModules in goroutine 1
    github.com/cosmos/cosmos-sdk@v0.50.9/types/module/module.go:576 +0x770

Documentation and Release Note

Where is the change documented?

coderabbitai[bot] commented 1 month ago

Walkthrough

The pull request introduces updates to the CHANGELOG.md file, enhancing its structure and adding entries for various releases of the Osmosis project, including a bug fix for the governance module. Additionally, it modifies the app/upgrades/v27/upgrades.go file to improve the upgrade handler functionality by adding a new function for initializing a constitution collection. A new test suite is also introduced in upgrades_test.go to validate the upgrade logic and governance module behavior for version 27.

Changes

File Change Summary
CHANGELOG.md Updated format and added entries under "Unreleased" for state breaking, config, and bug fixes.
Updated entries for versions v26.0.1 and v26.0.0 detailing features, improvements, and bug fixes.
app/upgrades/v27/upgrades.go Added import for govkeeper, updated CreateUpgradeHandler to initialize constitution collection, and defined InitializeConstitutionCollection function.
app/upgrades/v27/upgrades_test.go Introduced a test suite with methods to validate upgrade logic and governance module behavior.

Possibly related PRs

Suggested reviewers


📜 Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
📥 Commits Files that changed from the base of the PR and between 113687107c8a5c4771945bcd9c0953ee4b30a7c7 and 460563b3af8bc3a375d688888cedf7faa3d65ed8.
📒 Files selected for processing (3) * CHANGELOG.md (1 hunks) * app/upgrades/v27/upgrades.go (2 hunks) * app/upgrades/v27/upgrades_test.go (4 hunks)
🚧 Files skipped from review as they are similar to previous changes (3) * CHANGELOG.md * app/upgrades/v27/upgrades.go * app/upgrades/v27/upgrades_test.go
--- Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?
❤️ Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.