feat(x/gov): add MaxVoteOptionsLen

[marcello33]

Description

Closes: #20074

As per the the aforementioned issue, this PR adds the MaxVoteOptionsLen to allow developers to choose a configurable number of vote options. Defaulting to 0, respects the clause defined here by @julienrbrt

---

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
• confirmed ! in the type prefix if API or client breaking change
• targeted the correct branch (see PR Targeting)
• provided a link to the relevant issue or specification
• reviewed "Files changed" and left comments if necessary
• included the necessary unit and integration tests
• added a changelog entry to CHANGELOG.md
• updated the relevant documentation or specification, including comments for documenting Go code
• confirmed all CI checks have passed

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 all author checklist items have been addressed
• reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

• New Features
  • Introduced a new configurable parameter MaxVoteOptionsLen to limit the maximum number of vote options per proposal, enhancing governance control and efficiency.
• Documentation
  • Updated documentation to include information about the new MaxVoteOptionsLen parameter and its impact on voting processes.
• Bug Fixes
  • Added validation to prevent exceeding the set maximum number of vote options, ensuring system integrity and compliance.

[coderabbitai]

Walkthrough

This update introduces a new configurable parameter, MaxOptionsLen, in the government module to limit the number of vote options a proposal can have. It includes changes to the config structure, addition of validation functions, and updates to the voting logic to enforce this new limit. The changes are aimed at providing flexibility in governance setups, particularly useful in scenarios where limiting proposal options is desired.

Changes

Files	Change Summary
x/gov/CHANGELOG.md, x/gov/README.md	Documentation updated to include MaxVoteOptionsLen.
x/gov/keeper/config.go, x/gov/proto/cosmos/gov/module/v1/module.proto	Added MaxVoteOptionsLen field to the Config struct and Module message.
x/gov/keeper/keeper.go, x/gov/keeper/vote.go	Added logic to set and assert MaxVoteOptionsLen. Validation added in AddVote.
x/gov/types/errors.go	New error ErrTooManyVoteOptions added for exceeding vote options limit.
x/gov/keeper/common_test.go, x/gov/keeper/vote_test.go	Test functions added to validate behavior with custom MaxVoteOptionsLen.

Assessment against linked issues

Objective	Addressed	Explanation
Add MaxOptionsLen to gov configs to define maximum options per proposal (#20074)	✅
Ensure default configuration enforces MaxOptionsLen when not set explicitly (#20074)	✅
Implement validation to enforce MaxOptionsLen during vote tallying or addition (#20074)	✅
Update documentation to reflect changes in gov configs (#20074)	✅
Error handling for exceeding the MaxOptionsLen (#20074)	✅

These updates comprehensively address the objectives outlined in the linked issue, enhancing the governance module's flexibility and usability in scenarios requiring restricted proposal options.

---

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.

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 a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @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 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.

[julienrbrt]

Thank you for this!
Can you add an unit test?
Left a few comment as well.

[marcello33]

Thank you for this! Can you add an unit test? Left a few comment as well.

Added a unit test, it worked.

I decided to add a new function called setupGovKeeperWithMaxVoteOptionsLen to setup the govKeeper with a custom number for MaxVoteOptionsLen in common_test.go, instead of disrupting setupGovKeeper which is largely used in other tests.
LMK if this is ok @julienrbrt or you prefer a different approach.
Thanks!

[julienrbrt]

utACK. Thank you!

One nit is that we can simplify setupGovKeeperWithMaxVoteOptionsLen with the strict minimum necessary and include it directly in TestVotes_CustomMaxVoteOptionsLen. But feel free to ignore.

[sontrinh16]

i think you need to run go mod tidy for x/gov, test is failing

[marcello33]

i think you need to run go mod tidy for x/gov, test is failing

Done.

[marcello33]

You should revert all those go.mod changes

Done