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(x/consensus): apply ConsensusParam update rules according to CometBFT spec #20314

Conversation

sergio-mena
Copy link
Contributor

@sergio-mena sergio-mena commented May 8, 2024

Description

Contributes to: #20313

This PR modifies consensusParamsKeeper.UpdateParams(...) so that its checks:

  • are stateful
  • follow the CometBFT spec on updating ConsensusParams

It also extends the unit tests logic to test the stateful functionality: the new unit tests fail without the changes in consensusParamsKeeper.UpdateParams(...)


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

Copy link
Member

@tac0turtle tac0turtle left a comment

Choose a reason for hiding this comment

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

looks good, ill take over further cleanup being that we dont need some of the functions in this module any longer

x/consensus/keeper/keeper.go Outdated Show resolved Hide resolved
x/consensus/keeper/keeper.go Outdated Show resolved Hide resolved
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.

Could this PR target main please?

@tac0turtle
Copy link
Member

ah yea, this should target main, missed that. im not sure this is safe to backport

Co-authored-by: Marko <marko@baricevic.me>
@sergio-mena
Copy link
Contributor Author

Could this PR target main please?

I'll adapt this to main (probably on Fri) and post a companion PR, is that OK?

I didn't target main initially because we have refactored ConsensusParams there and I wanted to check if the problem exists in released code.

But, 100% agree that PRs should first tackle main 👍

return nil, err
}

if err := params.ValidateUpdate(&consensusParams, k.HeaderService.HeaderInfo(ctx).Height); err != nil {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

k.HeaderService doesn't seem to work on release/v0.50.x. Consider reverting it

@tac0turtle
Copy link
Member

superseded by #20381

@tac0turtle tac0turtle closed this May 14, 2024
@sergio-mena sergio-mena deleted the sergio/fix-consensus-params branch July 19, 2024 19:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants