Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: deprecate Voteinfo in favour of Cometinfo on Context #17670

Merged
merged 19 commits into from
Sep 14, 2023

Conversation

tac0turtle
Copy link
Member

Description

this PR marks voteinfos in context as deprecated. CometInfo provides a efficient way of getting the same data


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 API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • followed the guidelines for building 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
  • run make lint and make test
  • 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 ! 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)

@github-actions github-actions bot added C:x/slashing C:x/distribution distribution module related labels Sep 10, 2023
@tac0turtle tac0turtle changed the title depreacte voteinfo infavour of cometinfo refactor: deprecate Voteinfo in favour of Cometinfo on Context Sep 10, 2023
@tac0turtle tac0turtle marked this pull request as ready for review September 10, 2023 16:59
@tac0turtle tac0turtle requested a review from a team as a code owner September 10, 2023 16:59
x/slashing/abci.go Fixed Show fixed Hide fixed
types/context.go Outdated Show resolved Hide resolved
types/context.go Outdated Show resolved Hide resolved
types/context.go Outdated Show resolved Hide resolved
x/distribution/abci.go Fixed Show fixed Hide fixed
x/slashing/abci.go Fixed Show fixed Hide fixed
Copy link
Member

@julienrbrt julienrbrt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm!

CHANGELOG.md Outdated Show resolved Hide resolved
@@ -19,6 +19,10 @@ func BeginBlocker(ctx context.Context, k keeper.Keeper) error {
// store whether or not they have actually signed it and slash/unbond any
// which have missed too many blocks in a row (downtime slashing)
sdkCtx := sdk.UnwrapSDKContext(ctx)
// in testing cometInfo is nil
if sdkCtx.CometInfo() == nil {
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we change cometinfo to be a struct otherwise we need to do defensive checks

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Another advantage of a struct is that adding new fields is non breaking and everything is optional

@tac0turtle tac0turtle added the S: DO NOT MERGE Status: DO NOT MERGE label Sep 12, 2023
@tac0turtle tac0turtle removed the S: DO NOT MERGE Status: DO NOT MERGE label Sep 13, 2023
@tac0turtle tac0turtle added this pull request to the merge queue Sep 14, 2023
Merged via the queue into main with commit 36a9330 Sep 14, 2023
47 of 48 checks passed
@tac0turtle tac0turtle deleted the marko/migrate_vote_info_cometinfo branch September 14, 2023 09:15
}

// TODO this is Tendermint-dependent
// ref https://github.com/cosmos/cosmos-sdk/issues/3095
if ctx.BlockHeight() > 1 {
if err := k.AllocateTokens(ctx, previousTotalPower, ctx.VoteInfos()); err != nil {
if err := k.AllocateTokens(ctx, previousTotalPower, ctx.CometInfo().LastCommit.Votes); err != nil {

Check warning

Code scanning / CodeQL

Panic in BeginBock or EndBlock consensus methods Warning

path flow from Begin/EndBlock to a panic call
path flow from Begin/EndBlock to a panic call
path flow from Begin/EndBlock to a panic call
path flow from Begin/EndBlock to a panic call
path flow from Begin/EndBlock to a panic call
err := k.HandleValidatorSignature(ctx, voteInfo.Validator.Address, voteInfo.Validator.Power, comet.BlockIDFlag(voteInfo.BlockIdFlag))
for _, vote := range sdkCtx.CometInfo().LastCommit.Votes {

err := k.HandleValidatorSignature(ctx, vote.Validator.Address, vote.Validator.Power, vote.BlockIDFlag)

Check warning

Code scanning / CodeQL

Panic in BeginBock or EndBlock consensus methods Warning

path flow from Begin/EndBlock to a panic call
path flow from Begin/EndBlock to a panic call
path flow from Begin/EndBlock to a panic call
path flow from Begin/EndBlock to a panic call
path flow from Begin/EndBlock to a panic call
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C:x/distribution distribution module related C:x/slashing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants