cosmos / interchain-security

Replicated security (aka interchain security V1) 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
152 stars 108 forks source link

feat!: Wire the provider module to return ValidatorUpdates, instead of the staking module #1993

Open p-offtermatt opened 1 week ago

p-offtermatt commented 1 week ago

Description

Closes: Part of #1913

Main changes:


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 days ago

Walkthrough

The recent changes primarily involve refactoring nomenclature, enhancing test configurations, updating import paths, adjusting function signatures, and correcting minor errors. Key updates include renaming and generalizing the ConsumerValidator to ConsensusValidator, refining staking operations for validators, adding testing configurations, and correcting typos in error messages. Additionally, there are modifications to return types and error handling within high-level functions.

Changes

File Path Change Summary
app/consumer-democracy/proposals_whitelisting.go Corrected a typo in a comment related to legacy parameters.
app/provider/app.go Updated imports and modified AppModuleBasic declaration for staking.
app/sovereign/export.go Removed a line converting a validator address to bytes in prepForZeroHeightGenesis affecting commission withdrawal logic.
proto/.../v1/genesis.proto & provider.proto Added new field last_provider_consensus_validators. Renamed ConsumerValidator to ConsensusValidator. Updated related comments and field names.
tests/e2e/... Introduced new TestConfigType, implemented InactiveProviderValsTestConfig(), added stepChoices map entry, and enhanced GetReward and GetProposal.
tests/integration/slashing.go Replaced providertypes.ConsumerValidator with providertypes.ConsensusValidator in TestOnRecvSlashPacketErrors.
testutil/keeper/mocks.go Added GetBondedValidatorsByPower method to MockStakingKeeper.
x/ccv/consumer/types/codec.go Removed an empty line in RegisterInterfaces function.
x/ccv/democracy/governance/module.go Removed a line in the EndBlock function within AppModule.
x/ccv/.../genutil/doc.go & module.go Introduced a wrapper around the native staking module, overriding the EndBlock function to return no validator set updates.
x/ccv/.../genutil/doc.go & module.go Introduced a wrapper around the native staking module, overriding the EndBlock function to return no validator set updates.
x/ccv/.../staking/module.go Defined new types and functions for module initialization and block processing within the staking package to handle validator updates differently.
x/ccv/provider/... Updated function signatures and imported types to align with the shift from ConsumerValidator to ConsensusValidator. Modified function returns and added related comments.
x/ccv/provider/.../genesis_test.go Added staking functionalities, including validation creation, manipulation, and staking operations within test scenarios.
x/ccv/provider/.../relay.go Modified EndBlockVSU to return []abci.ValidatorUpdate and added ProviderValidatorUpdates function.
x/ccv/provider/.../grpc_query_test.go Replaced ConsumerValidator with ConsensusValidator in test functions.

Sequence Diagrams

sequenceDiagram
    participant App
    participant ValidatorSet
    participant StakingModule

    Note right of App: Renamed ConsumerValidator to ConsensusValidator

    App ->> ValidatorSet: Request validator list
    ValidatorSet ->> StakingModule: Forward request
    StakingModule -->> ValidatorSet: Return validator list
    ValidatorSet -->> App: Return generalized validator list (ConsensusValidator)
    App ->> App: Use ConsensusValidator list for further processing

    Note left of App: Modified return types for EndBlock functions

    StakingModule ->> App: EndBlock process
    App ->> App: Return []abci.ValidatorUpdate and error

    Note over App, StakingModule: Adjusted naming and function returns to enhance clarity and functionality.

This diagram illustrates the control flow changes related to the renaming from ConsumerValidator to ConsensusValidator and the updates in the EndBlock function to return []abci.ValidatorUpdate and error.


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.