fix: backport #1949 + fix handler entry

[bermuell]

Description

• backport #1949
• fix: added missing handler entry for 'consumer modification proposal'

---

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...

• [x] Included the correct type prefix in the PR title
• [ ] Added ! to the type prefix if the change is state-machine breaking
• [x] Confirmed this PR does not introduce changes requiring state migrations, OR migration code has been added to consumer and/or provider modules
• [x] Targeted the correct branch (see PR Targeting)
• [ ] Provided a link to the relevant issue or specification
• [ ] Followed the guidelines for building SDK modules
• [ ] Included the necessary unit and integration tests
• [ ] Added a changelog entry to CHANGELOG.md
• [ ] Included comments for documenting Go code
• [ ] Updated the relevant documentation or specification
• [x] Reviewed "Files changed" and left comments if necessary
• [ ] Confirmed all CI checks have passed
• [ ] If this PR is library API breaking, bump the go.mod version string of the repo, and follow through on a new major release

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...

• [ ] confirmed the correct type prefix in the PR title
• [ ] confirmed ! the type prefix if the change is state-machine breaking
• [ ] confirmed this PR does not introduce changes requiring state migrations, OR confirmed migration code has been added to consumer and/or provider modules
• [ ] confirmed all author checklist items have been addressed
• [ ] reviewed state machine logic
• [ ] reviewed API design and naming
• [ ] reviewed documentation is accurate
• [ ] reviewed tests and test coverage

Summary by CodeRabbit

• New Features

  • Introduced ConsumerModificationProposal for dynamically altering power shaping parameters and switching between Top N and Opt-In consumer chains.

• Documentation

  • Added tips for transitioning consumer chains and modifying power shaping parameters.
  • Updated URLs for validator setup and Cosmos SDK documentation.
  • Clarified proposal types in the Interchain security module.

• Bug Fixes

  • Corrected a typo in function comments.

• Tests

  • Added E2E tests for ConsumerModificationProposal and related security parameter modifications.

[coderabbitai[bot]]

Walkthrough

## Walkthrough The update introduces a new job in the `nightly-e2e.yml` workflow for executing E2E tests linked to a security modification proposal for partial sets. Additionally, it integrates a new handler for consumer modification proposals in specific locations within the `app/provider/app.go` file. Several documentation files have been updated, highlighting the use and benefits of `ConsumerModificationProposal`. Moreover, new types, methods, and steps have been implemented in test files to support and test these proposals thoroughly. ## Changes | Files | Change Summaries | |----------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------| | .github/workflows/nightly-e2e.yml | Added a new job `partial-set-security-modification-proposal` to run E2E tests for security modification proposals related to partial sets. | | app/provider/app.go | Integrated `ibcproviderclient.ConsumerModificationProposalHandler` into handler lists in two code sections. | | docs/docs/features/... | Added or updated tips regarding `ConsumerModificationProposal` in several documentation files. | | docs/docs/frequently-asked-questions.md | Introduced capabilities of `ConsumerModificationProposal` related to parameter modification and chain transition. | | docs/docs/validators/... | Updated URLs and tips concerning validator documentation in various files. | | tests/e2e/actions.go | Added a new `SubmitConsumerModificationProposalAction` type and its associated method. | | tests/e2e/main.go | Included `partial-set-security-modification-proposal` in the `stepChoices` map for testing security modifications. | | tests/e2e/state.go | Added `ConsumerModificationProposal` entity and updated related type references. | | tests/e2e/steps_partial_set_security.go | Added steps for modifying security parameters through `ConsumerModificationProposal`s and voting actions. | | tests/e2e/test_driver.go | Added a case to handle `SubmitConsumerModificationProposalAction` in the `runAction` method. | | tests/e2e/testlib/types.go | Added `ConsumerModificationProposal` struct and its associated `isProposal()` method. | | tests/integration/distribution.go | Added a line in the `TestRewardsDistribution` function to check the equality of `feePoolTokens` with its old amount plus 100. | | x/ccv/provider/types/legacy_proposal.go| Corrected a typo in the comment of the `NewConsumerModificationProposal` function. | ## Sequence Diagram(s) ```mermaid sequenceDiagram participant Developer as Developer participant GitHubActions as GitHub Actions participant TestRunner as Test Runner participant GoEnvironment as Go Environment Developer->>GitHubActions: Push code changes GitHubActions->>TestRunner: Trigger nightly-e2e.yml workflow TestRunner->>GoEnvironment: Setup Go environment TestRunner->>TestRunner: Run partial-set-security-modification-proposal job TestRunner->>TestRunner: Execute E2E tests for security modification proposals TestRunner->>GitHubActions: Report test results Note over Developer, GitHubActions: Developer updates docs to reflect new ConsumerModificationProposal capabilities TestRunner->>CodeRepo: Update tests to include new proposal type Note over TestRunner: Include new steps, actions, and entities for ConsumerModificationProposal ```

---

Recent review details

**Configuration used: .coderabbit.yml** **Review profile: CHILL**

Commits

Files that changed from the base of the PR and between 75ba5cfe173a83d89d36b24f4b1a061f20885686 and 4c582940a27d904e14bbe9e38f165d8051085b6a.

Files selected for processing (2)

* .github/workflows/nightly-e2e.yml (2 hunks) * docs/docs/validators/joining-testnet.md (2 hunks)

Files skipped from review as they are similar to previous changes (1)

* .github/workflows/nightly-e2e.yml

Additional context used

Path-based instructions (1)

docs/docs/validators/joining-testnet.md (1)

Pattern `**/*.md`: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness. Please DO NOT report any missing or superfluous newlines, in particular at the end or beginning of files."

LanguageTool

docs/docs/validators/joining-testnet.md

[style] ~21-~21: Did you mean ‘different from’? ‘Different than’ is often considered colloquial style. (DIFFERENT_THAN) Context: ...s cannot have a validator set different than the provider, which means they cannot i... --- [typographical] ~40-~40: It appears that a comma is missing. (DURING_THAT_TIME_COMMA) Context: ...etwork/main/run-node/keyring). In this example we will use the `test` keyring-backend.... --- [uncategorized] ~64-~64: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA) Context: ...e keyring to issue a `create-validator` transaction which will register your validator on c... --- [uncategorized] ~85-~85: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE) Context: ...ter this step, your validator is created and you can start your node and catch up to... --- [grammar] ~129-~129: The word “setup” is a noun. The verb is spelled with a white space. (NOUN_VERB_CONFUSION) Context: ...e.xyz:26656" ``` Additional scripts to setup your nodes are available [here](https:/... --- [typographical] ~143-~143: Consider adding a comma here. (PLEASE_COMMA) Context: ... chain and consumers on the same machine please update the `PORT` numbers for each of t...

Markdownlint

docs/docs/validators/joining-testnet.md

151-151: null (MD032, blanks-around-lists) Lists should be surrounded by blank lines

--- 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.