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(x/distribution)!: Use KVStoreService, context.Context and return errors instead of panic #15948

Merged
merged 29 commits into from
Apr 27, 2023

Conversation

facundomedica
Copy link
Member

@facundomedica facundomedica commented Apr 25, 2023

Description

Here we:

  • Move from storeKey to KVStoreService
  • Change usages of sdk.Context to context.Context (as many as possible, some are still needed)
  • Return errors instead of panic whenever possible

Notes for reviewers:

  • Not all errors are currently possible to return instead of panicking (for example when iterating through validators), so we'll need follow up PRs
  • We need to make sure we are not ignoring errors. Functions that were previously panicking are now returning errors

TODO for follow up PRs:

  • Convert any panic("hardcoded string") into return types.ErrSomethingSpecific

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
  • 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:Simulations C:x/distribution distribution module related labels Apr 25, 2023
x/distribution/keeper/store.go Fixed Show fixed Hide fixed
x/distribution/keeper/validator.go Fixed Show fixed Hide fixed
x/distribution/keeper/validator.go Fixed Show fixed Hide fixed
x/distribution/keeper/validator.go Fixed Show fixed Hide fixed
x/distribution/keeper/validator.go Fixed Show fixed Hide fixed
x/distribution/keeper/validator.go Fixed Show fixed Hide fixed
x/distribution/keeper/validator.go Fixed Show fixed Hide fixed
x/distribution/keeper/store.go Fixed Show fixed Hide fixed
@facundomedica facundomedica marked this pull request as ready for review April 26, 2023 17:20
@facundomedica facundomedica requested a review from a team as a code owner April 26, 2023 17:20
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!

@julienrbrt julienrbrt changed the title refactor!: (x/distribution) Use KVStoreService, context.Context and return errors instead of panic refactor(x/distribution)!: Use KVStoreService, context.Context and return errors instead of panic Apr 26, 2023
@facundomedica facundomedica added this pull request to the merge queue Apr 27, 2023
Merged via the queue into main with commit 428e19f Apr 27, 2023
@facundomedica facundomedica deleted the facu/distr-kvservice branch April 27, 2023 13:29
larry0x pushed a commit to larry0x/cosmos-sdk that referenced this pull request May 22, 2023
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.

2 participants