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

refactor!: Refactor the validator set storage and add provider consensus validator storage #1990

Closed p-offtermatt closed 4 days ago

p-offtermatt commented 1 week ago

Description

Closes: Part of #1913

Refactors the validator set storage. This is done to allow storing a separate validator set under its own individual key, namely the provider consensus validator set, without ever clashing with the storage for consumer chains here.

Changes:

The provider_consensus methods are not used yet, but will be in a future PR. I want to split the functionality and keep this PR small to keep it easy to review


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 1 week ago

[!WARNING]

Rate limit exceeded

@p-offtermatt has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 7 minutes and 31 seconds before requesting another review.

How to resolve this issue? After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.
How do rate limits work? CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://coderabbit.ai/docs/faq) for further information.
Commits Files that changed from the base of the PR and between 5e30dd93fe0ce0a73760e229c34935c9b991b2e0 and 43aa65ad4a893e46d127d76f23a1e871ce96479c.

Walkthrough

The latest updates enhance interchain security by managing and interacting with the provider consensus validator sets. Key changes include methods for setting, resetting, deleting, and retrieving validator sets and their powers. The refactoring also consolidates key retrieval logic, modifies how validators are manipulated, and simplifies validator set retrieval.

Changes

File(s) Change Summary
x/.../keeper/provider_consensus.go Introduces methods to manage last provider consensus validator set: set, reset, delete, retrieve validators, and get total power.
x/.../keeper/validator_set_storage.go Adds functionality for managing validator sets with operations to set, delete, check existence, and calculate total power.
x/.../keeper/validator_set_update.go Refactors consumer validator handling, consolidating key retrieval logic, updating set/delete methods, and simplifying retrieval functions.
x/.../types/keys.go Adds LastProviderConsensusValsPrefix constant and LastProviderConsensusValidatorKey function for managing last validator set keys.
x/.../types/keys_test.go Adds new key prefix LastProviderConsensusValsPrefix to key prefixes' test list.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Keeper
    participant Store
    Client->>Keeper: SetLastProviderConsensusValSet(nextValidators)
    Keeper->>Store: Store Validator Set with LastProviderConsensusValsPrefix

    Client->>Keeper: GetLastProviderConsensusValSet()
    Keeper->>Store: Retrieve Validator Set with LastProviderConsensusValsPrefix
    Store-->>Keeper: Return Validator Set
    Keeper-->>Client: Return Validator Set

    Client->>Keeper: DeleteLastProviderConsensusValSet()
    Keeper->>Store: Delete Validator Set with LastProviderConsensusValsPrefix

    Client->>Keeper: GetLastTotalProviderConsensusPower()
    Keeper->>Store: Retrieve Validator Set with LastProviderConsensusValsPrefix
    Store-->>Keeper: Return Validator Set
    Keeper-->>Client: Calculate and Return Total Power
sequenceDiagram
    participant Client
    participant Keeper
    participant Store
    Client->>Keeper: setValidator(prefix, validator)
    Keeper->>Store: Store Validator with specified prefix

    Client->>Keeper: deleteValidator(prefix, providerConsAddr)
    Keeper->>Store: Delete Validator with specified prefix

    Client->>Keeper: getTotalPower(prefix)
    Keeper->>Store: Retrieve Validators with specified prefix
    Store-->>Keeper: Return Validators
    Keeper-->>Client: Calculate and Return Total Power

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.
p-offtermatt commented 1 week ago

Failing CI checks are unrelated and also happen on the target branch afaict

sainoe commented 5 days ago

LGTM! Just two small nits in the UTs.