search

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!: deprecate soft opt-out (backporting #1964) #1995

Open insumity opened 1 week ago

insumity commented 1 week ago

Description

Backporting https://github.com/cosmos/interchain-security/pull/1964/

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
Walkthrough ## Walkthrough The recent changes primarily focus on deprecating the "Soft Opt-Out" feature in favor of the new "Partial Set Security" (PSS). This includes removing related comments, parameters, and logic from the codebase, updating documentation, and adjusting existing tests to reflect the new functionality. The changes span across various modules, including consumer, sovereign, protocols, and test frameworks to ensure a comprehensive removal of the deprecated feature. ## Changes | File(s) | Change Summary | | --- | --- | | `.changelog/unreleased/api-breaking/1964-deprecate-soft-opt-out.md` | Documented the deprecation of the soft opt-out feature. | | `app/consumer-democracy/app.go`, `app/consumer/app.go` | Removed outdated comments regarding module initialization and soft opt-out requirements. | | `app/consumer/genesis.go` | Deprecated the `SoftOptOutThreshold` parameter, setting it to "0". | | `app/consumer/genesis_test.go` | Updated test cases to handle the deprecated `SoftOptOutThreshold` parameter by setting it to zero. | | `app/sovereign/app.go` | Removed an unused import related to `cosmossdk.io/x/upgrade`. | | `docs/docs/adrs/adr-009-soft-opt-out.md`, `docs/docs/adrs/intro.md` | Changed ADR-009 "Soft Opt-Out" status from "Accepted" to "Deprecated" and updated ADR lists. | | `docs/docs/features/proposals.md` | Discouraged the use of the "soft opt-out mechanism" in favor of the new `topN` parameter. | | `proto/interchain_security/.../consumer.proto`, `shared_consumer.proto` | Marked `opted_out` and `soft_opt_out_threshold` fields as deprecated. | | `tests/e2e/*` | Adjusted test scenarios, redelegation amounts, validators' power, and removed obsolete functions: `stepsRedelegateForOptOut`, `stepsRedelegateShort`. | | `testutil/integration/interfaces.go` | Reordered import statements for better readability. | | `x/ccv/consumer/types/validator.go` | Simplified the `CrossChainValidator` struct initialization by removing the `OptedOut` field assignment. | | `tests/e2e/json_marshal_test.go` | Changed `Type` field values within JSON objects affecting proposal unmarshalling tests. | ## Sequence Diagrams *Silently ignored generating this section as the changes don't involve introducing new features or modifying control flows.*
Recent review details **Configuration used: .coderabbit.yml** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between f8f67147a27fda7d520c2b10eea85f7041f19923 and 371cf97ca529661b2b63da9e2455b4e4a6523aab.
Files selected for processing (1) * tests/e2e/json_marshal_test.go (3 hunks)
Additional context used
Path-based instructions (1)
tests/e2e/json_marshal_test.go (3) Pattern `**/*.go`: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations. --- Pattern `tests/e2e/*`: "Assess the e2e test code assessing sufficient code coverage for the changes associated in the pull request" --- Pattern `**/*_test.go`: "Assess the unit test code assessing sufficient code coverage for the changes associated in the pull request"
Additional comments not posted (1)
tests/e2e/json_marshal_test.go (1)
`77-77`: **Ensure JSON consistency with struct.** The JSON string and the `chainState` struct must be consistent. Verify that the `Type` and `Status` fields match the expected values.
--- > [!TIP] >
> Early access features: enabled > > We are currently testing the following features in early access: > > - **OpenAI `gpt-4o` model for code reviews and chat**: OpenAI claims that this model is better at understanding and generating code than the previous models. We seek your feedback over the next few weeks before making it generally available. > > Note: > - You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file. > - Please join our [Discord Community](https://discord.com/invite/GsXnASn26c) to provide feedback and report issues. > - OSS projects are currently opted into early access features by default. > >

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.