feat(x/gov): add max cancel voting period param #18856

julienrbrt · 2023-12-21T12:47:04Z

Description

This PR adds maximum cancellation time for cancelling a proposal.
We as well set the SDK default to 1/2 the voting period.

ref: Slack, suggested by dydx.

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

coderabbitai · 2023-12-21T12:52:36Z

Walkthrough

The Cosmos gov.proto and associated governance module files have undergone updates to introduce new parameters and logic for proposal cancellations, including conditions for burning deposits and veto votes. Changes include additional error handling, new test cases, and updated validation logic. The module's parameters have been expanded, notably with a focus on proposal cancellation periods and associated governance thresholds. These modifications enhance the governance mechanism's flexibility and security.

Changes

File(s)	Change Summary
`proto/cosmos/gov/v1/gov.proto`	Added fields for burning votes and deposits, proposal cancellation period, and optimistic governance addresses and thresholds.
`x/gov/CHANGELOG.md`, `x/gov/README.md`	Documented the addition of `ProposalCancelMaxCancelPeriod` and changes to `gov` configuration, updated governance parameters, adding new ones and removing `burn_proposal_deposit_prevote`.
`x/gov/keeper/msg_server_test.go`, `x/gov/keeper/proposal.go`, `x/gov/keeper/proposal_test.go`	Updated error messages, proposal ID retrieval logic in tests, imported new packages, added error handling and logic for proposal cancellation, and updated test cases.
`x/gov/migrations/v6/store.go`, `x/gov/simulation/genesis.go`, `x/gov/types/v1/params.go`	Adjusted store migration, genesis state simulation, and parameter defaults/validation for new `ProposalCancelMaxCancelPeriod`.
`x/gov/types/errors.go`	Introduced `ErrTooLateToCancel` error for late proposal cancellation attempts.
`x/tx/internal/testpb/signers.proto`	Formatting changes with no semantic impact.

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

Tips

Chat with CodeRabbit Bot (`@coderabbitai`)

Note: Auto-reply has been disabled for this repository by the repository owner. The CodeRabbit bot will not respond to your comments unless it is explicitly tagged.

You can tag CodeRabbit on specific lines of code or entire files in the PR by tagging @coderabbitai in a comment. Examples:
- @coderabbitai generate unit tests for this file.
- @coderabbitai modularize this function.
You can tag @coderabbitai in a PR comment and ask questions about the PR and the codebase. Examples:
- @coderabbitai generate interesting stats about this repository from git and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit tests.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid.
- @coderabbitai read the files in the src/scheduler package and generate 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.

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.
The JSON schema for the configuration file is available here.
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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

x/gov/keeper/msg_server_test.go

likhita-809

changes are looking good.
Just some cosmetic changes are needed.
And also could you fix the failing gov genesis test?

proto/cosmos/gov/v1/gov.proto

x/gov/CHANGELOG.md

x/gov/types/v1/params.go

coderabbitai · 2023-12-22T10:50:19Z

api/cosmos/gov/v1/gov.pulsar.go

+func (x *_Params_18_list) Set(i int, value protoreflect.Value) {
 	valueUnwrapped := value.String()
 	concreteValue := valueUnwrapped
 	(*x.list)[i] = concreteValue
 }


The Set method directly assigns a string value to an element in the list without any validation. Consider adding validation to ensure the value being set is appropriate for the list.

coderabbitai · 2023-12-22T10:50:19Z

api/cosmos/gov/v1/gov.pulsar.go

+func (x *_Params_18_list) Truncate(n int) {
 	*x.list = (*x.list)[:n]
 }


The Truncate method modifies the underlying slice to the specified length. Ensure that there is proper handling for cases where n is out of bounds.

coderabbitai · 2023-12-22T10:50:19Z

api/cosmos/gov/v1/gov.pulsar.go

 	v := ""
 	return protoreflect.ValueOfString(v)
 }

-func (x *_Params_17_list) IsValid() bool {
+func (x *_Params_18_list) IsValid() bool {


The IsValid method checks if the list is not nil. This is a good null check, but consider if there are other conditions that should be checked to determine the validity of the list.

facundomedica

LGTM

facundomedica · 2023-12-27T12:50:40Z

x/gov/keeper/proposal.go

+	if proposal.VotingEndTime != nil {
+		currentTime := sdkCtx.HeaderInfo().Time
+
+		maxCancelPeriodRate := sdkmath.LegacyMustNewDecFromStr(params.ProposalCancelMaxPeriod)


nit: what does rate mean in maxCancelPeriodRate? Maybe maxCancelPeriod or maxCancelPeriodDuration and rename maxCancelPeriod to maxCancelTime?

nvm, it's not a duration, my bad

likhita-809

lgtm

atheeshp

lgtm, just a doubt.

proto/cosmos/gov/v1/gov.proto

julienrbrt added 2 commits December 21, 2023 11:15

feat(x/gov): add max cancel voting period param

72e8739

updates

16604d0

github-actions bot added C:x/gov C:Simulations C:x/tx labels Dec 21, 2023

changelog + docs

bd57ad8

julienrbrt marked this pull request as ready for review December 21, 2023 12:52

julienrbrt requested a review from a team as a code owner December 21, 2023 12:52

Merge branch 'main' into julien/gov-cancel-params

53671ae

coderabbitai bot reviewed Dec 21, 2023

View reviewed changes

x/gov/keeper/msg_server_test.go Show resolved Hide resolved

julienrbrt added 2 commits December 21, 2023 13:58

avoid possible float differences

c64fcd9

updates

b98d59b

julienrbrt assigned facundomedica and likhita-809 Dec 21, 2023

julienrbrt requested review from facundomedica and likhita-809 December 21, 2023 15:36

likhita-809 reviewed Dec 22, 2023

View reviewed changes

typo + fix test

2c29080

coderabbitai bot reviewed Dec 22, 2023

View reviewed changes

x/gov/types/v1/params.go Outdated Show resolved Hide resolved

param renaming

18fc56e

julienrbrt requested a review from likhita-809 December 22, 2023 10:46

coderabbitai bot reviewed Dec 22, 2023

View reviewed changes

facundomedica approved these changes Dec 27, 2023

View reviewed changes

Merge branch 'main' into julien/gov-cancel-params

0ae7151

likhita-809 approved these changes Dec 28, 2023

View reviewed changes

atheeshp approved these changes Dec 28, 2023

View reviewed changes

proto/cosmos/gov/v1/gov.proto Show resolved Hide resolved

julienrbrt added this pull request to the merge queue Dec 28, 2023

Merged via the queue into main with commit e1e8c46 Dec 28, 2023
60 of 62 checks passed

julienrbrt deleted the julien/gov-cancel-params branch December 28, 2023 10:38

julienrbrt mentioned this pull request Jan 23, 2024

Add x/gov.proposal_cancel_period parameter #13773

Closed

coderabbitai bot mentioned this pull request Feb 1, 2024

docs(baseapp): fixed typo in baseapp/baseapp.go #19322

Closed

12 tasks

This was referenced Apr 18, 2024

feat(x/gov): add MaxVoteOptionsLen #20087

Merged

chore: sync main changelogs with v0.47.11, v0.50.6, modules and x/tx #20125

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(x/gov): add max cancel voting period param #18856

feat(x/gov): add max cancel voting period param #18856

julienrbrt commented Dec 21, 2023

coderabbitai bot commented Dec 21, 2023 •

edited

Loading

Chat with CodeRabbit Bot (`@coderabbitai`)

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

CodeRabbit Discord Community

likhita-809 left a comment •

edited

Loading

coderabbitai bot Dec 22, 2023

coderabbitai bot Dec 22, 2023

coderabbitai bot Dec 22, 2023

facundomedica left a comment

facundomedica Dec 27, 2023

facundomedica Dec 27, 2023

likhita-809 left a comment

atheeshp left a comment

feat(x/gov): add max cancel voting period param #18856

feat(x/gov): add max cancel voting period param #18856

Conversation

julienrbrt commented Dec 21, 2023

Description

Author Checklist

Reviewers Checklist

coderabbitai bot commented Dec 21, 2023 • edited Loading

Walkthrough

Changes

Chat with CodeRabbit Bot (@coderabbitai)

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

CodeRabbit Discord Community

likhita-809 left a comment • edited Loading

Choose a reason for hiding this comment

coderabbitai bot Dec 22, 2023

Choose a reason for hiding this comment

coderabbitai bot Dec 22, 2023

Choose a reason for hiding this comment

coderabbitai bot Dec 22, 2023

Choose a reason for hiding this comment

facundomedica left a comment

Choose a reason for hiding this comment

facundomedica Dec 27, 2023

Choose a reason for hiding this comment

facundomedica Dec 27, 2023

Choose a reason for hiding this comment

likhita-809 left a comment

Choose a reason for hiding this comment

atheeshp left a comment

Choose a reason for hiding this comment

coderabbitai bot commented Dec 21, 2023 •

edited

Loading

Chat with CodeRabbit Bot (`@coderabbitai`)

CodeRabbit Configration File (`.coderabbit.yaml`)

likhita-809 left a comment •

edited

Loading