fix: proposal MsgChangeRewardDenoms

[bermuell]

Description

Fix for changing reward denoms via governance

• Message for changing reward denoms MsgChangeRewardDenoms was missing in the service definition
• fixed related test:
  • trigger correct action when run locally
  • content of proposal

Testing:
e2e tests democracy-reward democracy PASSED

---

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

• Included the correct type prefix in the PR title
• Added ! to the type prefix if the change is state-machine breaking
• Confirmed this PR does not introduce changes requiring state migrations, OR migration code has been added to consumer and/or provider modules
• 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
• 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 a new RPC method, ChangeRewardDenoms, allowing modification of reward denominations to enhance incentive management.

• Improvements

  • Updated the proposal submission process to handle multiple reward denominations as lists, ensuring consistency in data structure.
  • Enhanced version checking in the proposal submission logic to validate semantic versions, improving error prevention.

[coderabbitai]

Walkthrough

Walkthrough

The changes introduce a new RPC method, ChangeRewardDenoms, in the interchain security provider's service, allowing for modifications to reward denominations. Additionally, adjustments are made to the proposal submission process in the e2e tests, including changes to the JSON structure and variable handling. The version validation logic in the runAction method is also enhanced to ensure only valid semantic versions are processed.

Changes

Files	Change Summary
proto/interchain_security/.../tx.proto, tests/e2e/actions.go	Addition of ChangeRewardDenoms RPC method and modifications to the submitChangeRewardDenomsProposal function, including changes to JSON message structure and variable assignments.
tests/e2e/test_driver.go	Update to runAction method to enhance version validation for proposal submissions, ensuring only valid semantic versions are processed.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Provider
    participant ProposalHandler

    Client->>Provider: Call ChangeRewardDenoms
    Provider->>ProposalHandler: Process ChangeRewardDenoms proposal
    ProposalHandler->>Provider: Validate and submit proposal
    Provider->>Client: Return response

Loading

---

Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between bb3985a and 67d5c89.

Files ignored due to path filters (1)

• x/ccv/provider/types/tx.pb.go is excluded by !**/*.pb.go

Files selected for processing (3)

• proto/interchain_security/ccv/provider/v1/tx.proto (1 hunks)
• tests/e2e/actions.go (2 hunks)
• tests/e2e/test_driver.go (1 hunks)

Additional context used

Path-based instructions (2)

tests/e2e/test_driver.go (2)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations. Only report issues that you have a high degree of confidence in.

---

Pattern tests/e2e/*: "Assess the e2e test code assessing sufficient code coverage for the changes associated in the pull request. Only report issues that you have a high degree of confidence in."

tests/e2e/actions.go (2)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations. Only report issues that you have a high degree of confidence in.

---

Pattern tests/e2e/*: "Assess the e2e test code assessing sufficient code coverage for the changes associated in the pull request. Only report issues that you have a high degree of confidence in."

Additional comments not posted (5)

tests/e2e/test_driver.go (1)

224-227: LGTM! Verify semantic versioning logic.

The changes enhance the robustness of version checks by ensuring only valid semantic versions are considered.

Ensure that the semantic versioning logic is correctly integrated and tested.

Run the following script to verify the semantic versioning logic:

Verification successful

---

Semantic Versioning Logic Verified

The semantic versioning logic is correctly integrated and consistently used across the codebase. The checks ensure that only valid semantic versions are considered, and the comparison logic aligns with the intended functionality. No issues were found with the implementation.

• The logic checks if a version is valid using semver.IsValid.
• It compares the major version using semver.Compare.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify semantic versioning logic for `SubmitChangeRewardDenomsProposalAction`.

# Test: Search for semantic version checks. Expect: Correct usage of `semver.IsValid` and `semver.Compare`.
rg --type go -A 5 $'semver.IsValid' | rg 'semver.Compare'

Length of output: 765

proto/interchain_security/ccv/provider/v1/tx.proto (1)

33-33: Addition of ChangeRewardDenoms RPC method looks good.

The new RPC method enhances the service's functionality for managing reward denominations.

Ensure that corresponding server-side implementations and tests are in place.

tests/e2e/actions.go (3)

2230-2231: JSON structure update for denoms_to_add and denoms_to_remove is correct.

The change aligns the structure with expected formats for handling multiple denominations.

Ensure that the updated JSON structure is compatible with the receiving system.

---

2242-2243: Variable handling for denomsToAdd and denomsToRemove is simplified.

The change reflects a shift in how these values are intended to be used.

Verify that the simplified variable handling aligns with the overall logic.

---

2250-2250: Proposal file name change to /change-reward.proposal is appropriate.

The renaming reflects the broader context change in the proposal's purpose.

Ensure that the new file name is consistently used throughout the codebase.

---

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
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • 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 Configuration 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 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 for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.