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!: remove ZeroCustomFields from ClientState interface #5830

Merged
merged 7 commits into from
Feb 14, 2024

Conversation

colin-axner
Copy link
Contributor

Description

closes: #XXXX

Commit Message / Changelog Entry

type: commit message

see the guidelines for commit messages. (view raw markdown for examples)


Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

  • Targeted PR against the correct branch (see CONTRIBUTING.md).
  • Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
  • Code follows the module structure standards and Go style guide.
  • Wrote unit and integration tests.
  • Updated relevant documentation (docs/) or specification (x/<module>/spec/).
  • Added relevant godoc comments.
  • Provide a commit message to be used for the changelog entry in the PR description for review.
  • Re-reviewed Files changed in the Github PR explorer.
  • Review Codecov Report in the comment section below once CI passes.

Comment on lines -124 to -127
if !reflect.DeepEqual(clientState, clientState.ZeroCustomFields()) {
return errorsmod.Wrap(ErrInvalidUpgradeProposal, "upgraded client state is not zeroed out")
}

Copy link
Contributor Author

Choose a reason for hiding this comment

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

not necessary, we set the zero custom fields client state regardless

Copy link
Member

@damiannolan damiannolan left a comment

Choose a reason for hiding this comment

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

Clean as a whistle! Love it, happy to see this interface func removed :)
And nice docs changes too, much appreciated 🙏🏻

modules/light-clients/07-tendermint/client_state.go Outdated Show resolved Hide resolved
@colin-axner colin-axner added the priority PRs that need prompt reviews label Feb 13, 2024
Copy link
Contributor

@crodriguezvega crodriguezvega left a comment

Choose a reason for hiding this comment

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

Nice one!

modules/core/02-client/keeper/keeper.go Outdated Show resolved Hide resolved
Copy link
Contributor

@chatton chatton left a comment

Choose a reason for hiding this comment

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

LGTM

@colin-axner colin-axner enabled auto-merge (squash) February 14, 2024 14:55
@colin-axner colin-axner merged commit 824b823 into main Feb 14, 2024
79 of 81 checks passed
@colin-axner colin-axner deleted the colin/remove-zero-custom-fields branch February 14, 2024 15:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority PRs that need prompt reviews
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants