cosmos / interchain-security

Interchain Security is an open sourced IBC application which allows cosmos blockchains to lease their proof-of-stake security to one another.
https://cosmos.github.io/interchain-security/
Other
154 stars 115 forks source link

feat!: allow consumer chains to change their PSS parameters #1932

Closed insumity closed 4 months ago

insumity commented 4 months ago

Description

This PR introduces the ConsumerModificationProposal that allows consumer chains to change PSS parameters (e.g., topN, validatorSetCap, etc.) while a consumer chain is running.

Note that a validator that was automatically opted in on a Top N consumer chain would remain opted in even after moving to an Opt In chain.


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and please add links to any relevant follow up issues.

I have...

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add your handle next to the items reviewed if you only reviewed selected items.

I have...

Summary by CodeRabbit

coderabbitai[bot] commented 4 months ago

[!NOTE] Currently processing new changes in this PR. This may take a few minutes, please wait...

Commits Files that changed from the base of the PR and between e0775d92395fa88915edeaeaf634484bf8af7fa3 and 1c62d65d50b2d1ae9a87b35870d0113d8f0169ac.
Files selected for processing (2) * x/ccv/provider/types/proposal.go (4 hunks) * x/ccv/provider/types/proposal_test.go (2 hunks)
 ____________________________________________________________________________________________________________________________________
< Put abstractions in code, details in metadata. Program for the general case, and put the specifics outside the compiled code base. >
 ------------------------------------------------------------------------------------------------------------------------------------
  \
   \   (\__/)
       (•ㅅ•)
       /   づ

Walkthrough

The recent changes introduce a new proposal type, ConsumerModificationProposal, to the interchain security provider module. This proposal allows for governance-based modifications of parameters for running consumer chains, including validator settings and allow/deny lists. The changes span multiple files, adding new message types, handlers, validation functions, and test cases to support this functionality.

Changes

Files Change Summaries
proto/.../provider/v1/provider.proto Added ConsumerModificationProposal message with fields for modifying consumer chain parameters.
x/ccv/provider/client/proposal_handler.go Introduced handler, command, and JSON parsing for ConsumerModificationProposal.
x/ccv/provider/keeper/proposal.go Added HandleConsumerModificationProposal function to manage proposal processing.
x/ccv/provider/keeper/proposal_test.go Added tests for HandleConsumerModificationProposal function.
x/ccv/provider/proposal_handler.go Updated NewProviderProposalHandler to include ConsumerModificationProposal.
x/ccv/provider/types/codec.go Registered ConsumerModificationProposal with the InterfaceRegistry.
x/ccv/provider/types/errors.go Added ErrInvalidConsumerModificationProposal error.
x/ccv/provider/types/proposal.go Added ConsumerModificationProposal type, functions, and validations.
x/ccv/provider/types/proposal_test.go Added test cases for ConsumerModificationProposal validation functions.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant Governance
    participant ProposalHandler
    participant Keeper
    participant ConsumerChain

    Governance->>ProposalHandler: Submit ConsumerModificationProposal
    ProposalHandler->>Keeper: HandleConsumerModificationProposal
    Keeper->>ConsumerChain: Update Parameters (top_N, validators_power_cap, etc.)
    ConsumerChain->>Keeper: Confirmation of Updates
    Keeper->>ProposalHandler: Proposal Processed
    ProposalHandler->>Governance: Proposal Result

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 .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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 as 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration 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](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
sainoe commented 4 months ago

LGTM! Just one nit.