refactor: add burnable params to governance #15151

tac0turtle · 2023-02-24T13:59:35Z

Description

add configurable params for burning coins in governance

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

confirmed the correct type prefix in the PR title
confirmed ! in the type prefix if API or client breaking change
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
manually tested (if applicable)

x/gov/abci.go

-		keeper.RefundAndDeleteDeposits(ctx, proposal.Id) // refund deposit if proposal got removed without getting 100% of the proposal
+
+		if !keeper.GetParams(ctx).BurnProposalDeposit {
+			keeper.RefundAndDeleteDeposits(ctx, proposal.Id) // refund deposit if proposal got removed without getting 100% of the proposal


x/gov/abci.go

+		if !keeper.GetParams(ctx).BurnProposalDeposit {
+			keeper.RefundAndDeleteDeposits(ctx, proposal.Id) // refund deposit if proposal got removed without getting 100% of the proposal
+		} else {
+			keeper.DeleteAndBurnDeposits(ctx, proposal.Id) // burn the deposit if proposal got removed without getting 100% of the proposal


atheeshp

mostly lgtm, but a few doubts.

proto/cosmos/gov/v1/gov.proto

atheeshp · 2023-02-24T17:56:37Z

x/gov/types/v1/params.go

@@ -27,6 +27,9 @@ var (
 	DefaultMinInitialDepositRatio    = sdk.ZeroDec()
 	DefaultProposalCancelRatio       = sdk.MustNewDecFromStr("0.5")
 	DefaultProposalCancelDestAddress = ""
+	DefaultBurnProposal              = false // set to false to replicate behavior of when this change was made (0.47)
+	DefaultBurnVoteQuorom            = false // set to false to  replicate behavior of when this change was made (0.47)
+	DefaultBurnVoteVeto              = true  // set to true to replicate behavior of when this change was made (0.47)


There won't be any difference between No and NoWithVeto if this param set to false?

Agreeing with this, maybe instead of not burning, the condition should send it to the community pool?

This is the existing behavior. Don't want to chains and allow chains to decide.

Yea, I meant instead of disabling the burn, possibly change that setting to allow sending the deposit to the community pool.
Disabling the burn, as Atheesh mentioned effectively transform a no with veto in a no with a lower fail threshold.

Although I agree this will make the settings a bit more confusing if the last one does something different. So nvm 😬

we can add another param to decide if its burn or send to community pool? but its up to the chain what they would want to set here. Would rather leave it to chains then we decide for them

Okay, but I'm personally thinking this param is not needed, community in any chain may want to punish the proposal depositors if it is not appropriate. Sorry if I'm missing context.

atheeshp · 2023-02-24T18:03:54Z

proto/cosmos/gov/v1/gov.proto

+  // burn deposits if a proposal does not meet qourum
+  bool burn_vote_quorum = 13;
+  // burn deposits if the proposal does not get enough deposits
+  bool burn_proposal_deposit = 14;


This param name might mislead the dev, as they might get it as burning the proposal deposits in any case. wdyt?

updated the comment. do you have a suggestion for the name?

appended prevote, do you think that is better?

do you think that is better?

much better than the previous :)

atheeshp · 2023-02-24T18:06:41Z

x/gov/types/v1/params.go

@@ -56,7 +59,7 @@ func NewVotingParams(votingPeriod *time.Duration) VotingParams {
 // NewParams creates a new Params instance with given values.
 func NewParams(
 	minDeposit, expeditedminDeposit sdk.Coins, maxDepositPeriod, votingPeriod, expeditedVotingPeriod time.Duration,
-	quorum, threshold, expeditedThreshold, vetoThreshold, minInitialDepositRatio, proposalCancelRatio, proposalCancelDest string,
+	quorum, threshold, expeditedThreshold, vetoThreshold, minInitialDepositRatio, proposalCancelRatio, proposalCancelDest string, burnProposalDeposit, burnVoteQuorum, burnVoteVeto bool,


Changelog entry for this? And one more entry for introduction of new params?

julienrbrt

lgtm, but agreeing with the comments of @atheeshp above.
Documentation should be updated as well.

x/gov/simulation/genesis.go

proto/cosmos/gov/v1/gov.proto

x/gov/abci.go

atheeshp

lgtm, pending specs.

CHANGELOG.md

x/gov/types/v1/params.go

likhita-809

need to address @atheeshp 's comments, otherwise lgtm

julienrbrt

e2e tests and integration tests still need to be updated, other than that looks good!
I will play with simapp tomorrow and give a tACK when I've tested it locally.

julienrbrt

tACK. (one e2e needs to be fixed still, however)

(cherry picked from commit 44495e7) # Conflicts: # CHANGELOG.md # api/cosmos/gov/v1/gov.pulsar.go # api/cosmos/tx/v1beta1/service.pulsar.go # proto/cosmos/gov/v1/gov.proto # tests/e2e/gov/query.go # types/tx/service.pb.go # x/gov/README.md # x/gov/abci.go # x/gov/migrations/v4/json.go # x/gov/migrations/v4/json_test.go # x/gov/migrations/v4/store.go # x/gov/migrations/v5/store.go # x/gov/simulation/genesis.go # x/gov/types/v1/gov.pb.go # x/gov/types/v1/params.go

Co-authored-by: Marko <[email protected]> Co-authored-by: Julien Robert <[email protected]>

burnable params for gov

3e7b598

github-actions bot added C:Simulations C:x/gov labels Feb 24, 2023

Merge branch 'main' into marko/configurable-govBurn

8039135

github-advanced-security bot found potential problems Feb 24, 2023

View reviewed changes

fix test

e6e4f25

tac0turtle force-pushed the marko/configurable-govBurn branch from 7e179a6 to e6e4f25 Compare February 24, 2023 15:14

tac0turtle added 2 commits February 24, 2023 16:15

fix test

2145b00

Merge branch 'main' into marko/configurable-govBurn

21697b6

tac0turtle marked this pull request as ready for review February 24, 2023 17:23

tac0turtle requested a review from a team as a code owner February 24, 2023 17:23

atheeshp reviewed Feb 24, 2023

View reviewed changes

julienrbrt added the backport/v0.47.x PR scheduled for inclusion in the v0.47's next stable release label Feb 24, 2023

julienrbrt reviewed Feb 24, 2023

View reviewed changes

x/gov/simulation/genesis.go Outdated Show resolved Hide resolved

likhita-809 reviewed Feb 25, 2023

View reviewed changes

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

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

x/gov/abci.go Show resolved Hide resolved

add since

fb014d8

tac0turtle force-pushed the marko/configurable-govBurn branch from 3ef753f to fb014d8 Compare February 25, 2023 21:07

more comments

ea2ecfd

tac0turtle force-pushed the marko/configurable-govBurn branch from 4511dc4 to ea2ecfd Compare February 25, 2023 21:13

tac0turtle added 3 commits February 25, 2023 22:13

Merge branch 'main' into marko/configurable-govBurn

85e0303

add changelog

0763b92

update param to say prevote

79a6c6c

atheeshp approved these changes Feb 27, 2023

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

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

likhita-809 approved these changes Feb 27, 2023

View reviewed changes

address comments

faf6661

tac0turtle force-pushed the marko/configurable-govBurn branch from dfb65ce to faf6661 Compare February 27, 2023 18:24

tac0turtle added 2 commits February 27, 2023 19:24

Merge branch 'main' into marko/configurable-govBurn

8c662a1

Merge branch 'main' into marko/configurable-govBurn

1b31520

julienrbrt reviewed Feb 27, 2023

View reviewed changes

fix integration tests

ae82413

tac0turtle added 3 commits February 28, 2023 10:45

fix e2e tests

167cefd

Merge branch 'main' into marko/configurable-govBurn

5a1ceb8

fix e2e tests

e31d54c

julienrbrt approved these changes Feb 28, 2023

View reviewed changes

tac0turtle added 2 commits February 28, 2023 17:36

fix it

d3f17c5

Merge branch 'main' into marko/configurable-govBurn

3c5fb1e

tac0turtle enabled auto-merge (squash) February 28, 2023 18:09

Merge branch 'main' into marko/configurable-govBurn

e02988d

julienrbrt added the A:automerge Automatically merge PR once all prerequisites pass. label Feb 28, 2023

tac0turtle merged commit 44495e7 into main Feb 28, 2023

tac0turtle deleted the marko/configurable-govBurn branch February 28, 2023 20:44

mergify bot mentioned this pull request Feb 28, 2023

refactor: add burnable params to governance (backport #15151) #15218

Merged

julienrbrt added a commit that referenced this pull request Feb 28, 2023

chore: clean-up of #15151

652c7b9

julienrbrt mentioned this pull request Feb 28, 2023

chore: clean-up of #15151 #15219

Merged

19 tasks

julienrbrt added a commit that referenced this pull request Mar 1, 2023

chore: clean-up of #15151 (#15219)

2f4654e

julienrbrt added a commit that referenced this pull request Mar 1, 2023

refactor: add burnable params to governance (backport #15151) (#15218)

ffedca8

Co-authored-by: Marko <[email protected]> Co-authored-by: Julien Robert <[email protected]>

faddat mentioned this pull request Mar 28, 2023

update linter to 1521 ChihuahuaChain/cosmos-sdk#6

Closed

19 tasks

0xstepit mentioned this pull request Jul 1, 2024

chore(cachemulti): add Copy method evmos/cosmos-sdk#52

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: add burnable params to governance #15151

refactor: add burnable params to governance #15151

tac0turtle commented Feb 24, 2023 •

edited

Loading

atheeshp left a comment •

edited

Loading

atheeshp Feb 24, 2023

julienrbrt Feb 24, 2023

tac0turtle Feb 24, 2023

julienrbrt Feb 24, 2023 •

edited

Loading

tac0turtle Feb 25, 2023

atheeshp Feb 27, 2023 •

edited

Loading

atheeshp Feb 24, 2023 •

edited

Loading

tac0turtle Feb 25, 2023

tac0turtle Feb 25, 2023

atheeshp Feb 27, 2023 •

edited

Loading

atheeshp Feb 24, 2023

julienrbrt left a comment •

edited

Loading

atheeshp left a comment •

edited

Loading

likhita-809 left a comment

julienrbrt left a comment

julienrbrt left a comment

refactor: add burnable params to governance #15151

refactor: add burnable params to governance #15151

Conversation

tac0turtle commented Feb 24, 2023 • edited Loading

Description

Author Checklist

Reviewers Checklist

atheeshp left a comment • edited Loading

Choose a reason for hiding this comment

atheeshp Feb 24, 2023

Choose a reason for hiding this comment

julienrbrt Feb 24, 2023

Choose a reason for hiding this comment

tac0turtle Feb 24, 2023

Choose a reason for hiding this comment

julienrbrt Feb 24, 2023 • edited Loading

Choose a reason for hiding this comment

tac0turtle Feb 25, 2023

Choose a reason for hiding this comment

atheeshp Feb 27, 2023 • edited Loading

Choose a reason for hiding this comment

atheeshp Feb 24, 2023 • edited Loading

Choose a reason for hiding this comment

tac0turtle Feb 25, 2023

Choose a reason for hiding this comment

tac0turtle Feb 25, 2023

Choose a reason for hiding this comment

atheeshp Feb 27, 2023 • edited Loading

Choose a reason for hiding this comment

atheeshp Feb 24, 2023

Choose a reason for hiding this comment

julienrbrt left a comment • edited Loading

Choose a reason for hiding this comment

atheeshp left a comment • edited Loading

Choose a reason for hiding this comment

likhita-809 left a comment

Choose a reason for hiding this comment

julienrbrt left a comment

Choose a reason for hiding this comment

julienrbrt left a comment

Choose a reason for hiding this comment

tac0turtle commented Feb 24, 2023 •

edited

Loading

atheeshp left a comment •

edited

Loading

julienrbrt Feb 24, 2023 •

edited

Loading

atheeshp Feb 27, 2023 •

edited

Loading

atheeshp Feb 24, 2023 •

edited

Loading

atheeshp Feb 27, 2023 •

edited

Loading

julienrbrt left a comment •

edited

Loading

atheeshp left a comment •

edited

Loading