feat(group): Prune expired proposals and votes #11315

amaury1093 · 2022-03-03T11:49:25Z

Description

Closes: #11245

1. Pruning proposal.

Proposals are pruned:

after a successful MsgExec (or try_exec)
on voting_period_end + max_execution_period

whichever happens first.

2. Pruning votes.

Votes are pruned:

on MsgExec (or try_exec) if tally is final
on voting_period_end

whichever happens first.

3. Various group fixes

See #11404 for details

TODO:

Add vote pruning after Tally, once refactor: x/group proposal tally at the end of voting period #11310 is merged
Add tests

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)

…/11245-prune-group

codecov · 2022-03-09T07:45:55Z

Codecov Report

Merging #11315 (fee7d95) into master (cc0b9df) will increase coverage by 0.06%.
The diff coverage is 60.30%.

❗ Current head fee7d95 differs from pull request most recent head 364ddfb. Consider uploading reports for the commit 364ddfb to get more accurate results

@@            Coverage Diff             @@
##           master   #11315      +/-   ##
==========================================
+ Coverage   65.88%   65.94%   +0.06%     
==========================================
  Files         675      675              
  Lines       69830    69773      -57     
==========================================
+ Hits        46006    46012       +6     
+ Misses      21123    21067      -56     
+ Partials     2701     2694       -7

Impacted Files	Coverage Δ
x/group/simulation/operations.go	`68.13% <ø> (+0.72%)`	⬆️
x/group/keeper/invariants.go	`43.49% <48.38%> (-0.26%)`	⬇️
x/group/keeper/keeper.go	`54.10% <58.62%> (+1.78%)`	⬆️
x/group/module/abci.go	`50.00% <60.00%> (+16.66%)`	⬆️
x/group/keeper/msg_server.go	`68.92% <66.66%> (-0.88%)`	⬇️
x/group/keeper/tally.go	`62.50% <100.00%> (-7.50%)`	⬇️
x/group/simulation/genesis.go	`95.71% <100.00%> (ø)`
crypto/keys/internal/ecdsa/privkey.go	`82.45% <0.00%> (-1.76%)`	⬇️
... and 5 more

…/11245-prune-group

x/group/keeper/keeper_test.go

x/group/module/abci.go

…/11245-prune-group

x/group/keeper/keeper_test.go

…/11245-prune-group

…rune-group

atheeshp · 2022-03-11T06:13:12Z

x/group/keeper/keeper_test.go

+			expErrMsg:         "load proposal: not found",
+			expExecutorResult: group.PROPOSAL_EXECUTOR_RESULT_SUCCESS,
+		},
+	}


do we also need few tests with the try_exec set on Voting and Submitting proposal.

cc: @AmauryM @blushi

Yes! There might be some duplicated tests with TestVote and TestSubmitProposal, but I guess that's okay.

* Rm TallyVotesInvariant * Update TallyVotesSumInvariant to check for proposal voting period end * Do not check for updated group and group policy on Vote * Do not check for updated group and group policy on Exec * Test invariants * Update TallyVotesSumInvariant to check proposal status * Add back invariants * Nit * Fix invariant * Fix it.Close() * Update docs * Fix genesis sim * Test genesis * Test UpdateTallyOfVPEndProposals * Do proposals update after index iterator closed in UpdateTallyOfVPEndProposals * fix: Try fix group sims issue (#11458) * Fix sims? * Remove useless index * Add comment * Fix iterateProposalsByVPEnd * Fix some other places * Fix build * Add unit test * Use iterateProposalsByVPEnd again Co-authored-by: Amaury <[email protected]>

stake

x/group/keeper/keeper.go

amaury1093

Approving ✅

(a lot of people contributed to this PR, thanks!)

x/group/keeper/keeper.go

blushi

Pre-approving, pending some more docs

x/group/spec/01_concepts.md

x/group/keeper/keeper.go

blushi · 2022-03-25T11:57:57Z

Still related to the docs but not directly to this PR (but to previous ones), we forgot to add some client docs for TallyResult query.
IMO that shouldn't block this PR, let's just make sure to tackle this as part of the audit, I'll add a note about that in #10968.

amaury1093 · 2022-03-25T12:48:52Z

Added docs about tallying, pruning, and state. I didn't add docs on client.md in this PR.

…-sdk into am/11245-prune-group

x/group/spec/01_concepts.md

Co-authored-by: Marie Gauthier <[email protected]>

fea(group)t: Prune expired proposals and votes

0599220

amaury1093 changed the title ~~fea(group)t: Prune expired proposals and votes~~ feat(group): Prune expired proposals and votes Mar 3, 2022

amaury1093 and others added 4 commits March 3, 2022 13:48

Prune votes on Tally

9b07e1c

fix failing tests

5a259e8

Merge branch 'master' of https://github.com/cosmos/cosmos-sdk into am…

9f11299

…/11245-prune-group

fix failing keeper tests

127b118

likhita-809 added 2 commits March 9, 2022 16:04

add keeper tests for testing exec pruned proposals

0e86494

Merge branch 'master' of https://github.com/cosmos/cosmos-sdk into am…

3eb3419

…/11245-prune-group

amaury1093 commented Mar 9, 2022

View reviewed changes

likhita-809 added 7 commits March 9, 2022 22:35

address review comments on keeper test

d2dc104

Merge branch 'master' of https://github.com/cosmos/cosmos-sdk into am…

685dcdc

…/11245-prune-group

add abci tests

42887f2

fix abci tests

a23c51e

Merge branch 'master' of https://github.com/cosmos/cosmos-sdk into am…

2dfc206

…/11245-prune-group

nit

20d5a8e

Merge branch 'master' of https://github.com/cosmos/cosmos-sdk into am…

274e2d4

…/11245-prune-group

amaury1093 commented Mar 10, 2022

View reviewed changes

x/group/keeper/keeper_test.go Show resolved Hide resolved

likhita-809 marked this pull request as ready for review March 10, 2022 14:59

likhita-809 requested review from aaronc and alexanderbez as code owners March 10, 2022 14:59

likhita-809 requested review from aleem1314, anilcse, atheeshp and blushi March 10, 2022 15:56

amaury1093 assigned atheeshp and blushi Mar 10, 2022

likhita-809 and others added 2 commits March 11, 2022 10:30

Merge branch 'master' of https://github.com/cosmos/cosmos-sdk into am…

d957c64

…/11245-prune-group

Merge branch 'master' of github.com:cosmos/cosmos-sdk into am/11245-p…

1ac5470

…rune-group

atheeshp reviewed Mar 11, 2022

View reviewed changes

blushi and others added 2 commits March 25, 2022 12:06

Merge branch 'master' into am/11245-prune-group

a793581

github-actions bot added the C:Simulations label Mar 25, 2022

amaury1093 commented Mar 25, 2022

View reviewed changes

x/group/keeper/keeper.go Outdated Show resolved Hide resolved

x/group/keeper/keeper.go Outdated Show resolved Hide resolved

amaury1093 added 2 commits March 25, 2022 12:12

Update x/group/keeper/keeper.go

41f6c40

Update x/group/keeper/keeper.go

58999ce

amaury1093 commented Mar 25, 2022

View reviewed changes

atheeshp approved these changes Mar 25, 2022

View reviewed changes

blushi reviewed Mar 25, 2022

View reviewed changes

x/group/keeper/keeper.go Outdated Show resolved Hide resolved

Fix 2 more places

082e83e

blushi approved these changes Mar 25, 2022

View reviewed changes

x/group/spec/01_concepts.md Show resolved Hide resolved

blushi reviewed Mar 25, 2022

View reviewed changes

x/group/keeper/keeper.go Show resolved Hide resolved

blushi mentioned this pull request Mar 25, 2022

Group Module - Module Readiness Checklist #10968

Closed

32 tasks

Update docs

13d119f

amaury1093 added the A:automerge Automatically merge PR once all prerequisites pass. label Mar 25, 2022

Merge branch 'master' into am/11245-prune-group

245b956

likhita-809 approved these changes Mar 25, 2022

View reviewed changes

amaury1093 added 2 commits March 25, 2022 13:53

Improve docs

d38da5d

Merge branch 'am/11245-prune-group' of ssh://github.com/cosmos/cosmos…

c6ac683

…-sdk into am/11245-prune-group

blushi reviewed Mar 25, 2022

View reviewed changes

x/group/spec/01_concepts.md Outdated Show resolved Hide resolved

x/group/spec/01_concepts.md Outdated Show resolved Hide resolved

amaury1093 and others added 4 commits March 25, 2022 17:36

Update x/group/spec/01_concepts.md

9be41cd

Co-authored-by: Marie Gauthier <[email protected]>

Update x/group/spec/01_concepts.md

fee7d95

Co-authored-by: Marie Gauthier <[email protected]>

Merge branch 'master' into am/11245-prune-group

f4922fe

Merge branch 'master' into am/11245-prune-group

364ddfb

mergify bot merged commit 5491be2 into master Mar 28, 2022

mergify bot deleted the am/11245-prune-group branch March 28, 2022 04:44

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(group): Prune expired proposals and votes #11315

feat(group): Prune expired proposals and votes #11315

amaury1093 commented Mar 3, 2022 •

edited

Loading

codecov bot commented Mar 9, 2022 •

edited

Loading

atheeshp Mar 11, 2022

amaury1093 Mar 11, 2022

amaury1093 left a comment

blushi left a comment

blushi commented Mar 25, 2022 •

edited

Loading

amaury1093 commented Mar 25, 2022

feat(group): Prune expired proposals and votes #11315

feat(group): Prune expired proposals and votes #11315

Conversation

amaury1093 commented Mar 3, 2022 • edited Loading

Description

1. Pruning proposal.

2. Pruning votes.

3. Various group fixes

Author Checklist

Reviewers Checklist

codecov bot commented Mar 9, 2022 • edited Loading

Codecov Report

atheeshp Mar 11, 2022

Choose a reason for hiding this comment

amaury1093 Mar 11, 2022

Choose a reason for hiding this comment

amaury1093 left a comment

Choose a reason for hiding this comment

blushi left a comment

Choose a reason for hiding this comment

blushi commented Mar 25, 2022 • edited Loading

amaury1093 commented Mar 25, 2022

amaury1093 commented Mar 3, 2022 •

edited

Loading

codecov bot commented Mar 9, 2022 •

edited

Loading

blushi commented Mar 25, 2022 •

edited

Loading