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

fix(ve): Ensure that sdk side ve math matches cometbft #19200

Merged
merged 8 commits into from
Jan 25, 2024

Conversation

itsdevbear
Copy link
Contributor

Description

Closes: #XXXX


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

@itsdevbear itsdevbear requested a review from a team as a code owner January 23, 2024 19:19
Copy link
Contributor

coderabbitai bot commented Jan 23, 2024

Walkthrough

The recent update has simplified the vote validation process by eliminating the global VoteExtensionThreshold variable and its complex logic. The new mechanism now relies on a straightforward check of the cumulative voting power, ensuring it meets a predefined criterion, streamlining the validation step in the consensus process. Additionally, the abci module has been adjusted to ensure alignment with CometBFT in SDK side verification math.

Changes

File(s) Summary of Changes
baseapp/abci_utils.go Removed VoteExtensionThreshold and its validation logic; introduced a new condition that validates based on the total voting power.
baseapp/abci_test.go Modified TestBaseApp_VoteExtensions to include creation and usage of extVotes array, and setting Power field of abci.Validator instances to 666.
CHANGELOG.md Modified abci module to align SDK side verification math with CometBFT.

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

There are 3 ways to chat with CodeRabbit:

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.

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

@calbera
Copy link
Contributor

calbera commented Jan 23, 2024

baseapp/abci_utils.go Outdated Show resolved Hide resolved
baseapp/abci_utils.go Outdated Show resolved Hide resolved
Copy link
Contributor

@nivasan1 nivasan1 left a comment

Choose a reason for hiding this comment

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

lgtm

return fmt.Errorf("insufficient cumulative voting power received to verify vote extensions; got: %s, expected: >=%s", percentSubmitted, VoteExtensionThreshold)
}
// If the sum of the voting power has not reached (2/3 + 1) we need to error.
if sumVP < (totalVP*2/3)+1 {
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: we could check that totalVP > 0

baseapp/abci_utils.go Outdated Show resolved Hide resolved
Copy link
Contributor

@alexanderbez alexanderbez left a comment

Choose a reason for hiding this comment

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

Approving with a slight bit of hesitation 😆

@itsdevbear
Copy link
Contributor Author

@alexanderbez fixed a couple nits, also can we backport into 50?

@tac0turtle tac0turtle added the backport/v0.50.x PR scheduled for inclusion in the v0.50's next stable release label Jan 24, 2024
@tac0turtle tac0turtle enabled auto-merge January 24, 2024 17:02
auto-merge was automatically disabled January 25, 2024 16:20

Head branch was pushed to by a user without write access

@alexanderbez
Copy link
Contributor

@alexanderbez fixed a couple nits, also can we backport into 50?

Yes, absolutely.

@alexanderbez
Copy link
Contributor

@itsdevbear there's one failing test -- TestBaseApp_VoteExtensions

auto-merge was automatically disabled January 25, 2024 16:53

Head branch was pushed to by a user without write access

@alexanderbez alexanderbez added this pull request to the merge queue Jan 25, 2024
Merged via the queue into cosmos:main with commit 8120a86 Jan 25, 2024
54 of 56 checks passed
mergify bot pushed a commit that referenced this pull request Jan 25, 2024
(cherry picked from commit 8120a86)

# Conflicts:
#	CHANGELOG.md
@faddat faddat mentioned this pull request Nov 8, 2024
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/v0.50.x PR scheduled for inclusion in the v0.50's next stable release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants