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

feat: use CacheContext() in AssertInvariants() #14588

Merged
merged 7 commits into from
Jan 16, 2023

Conversation

0Tech
Copy link
Contributor

@0Tech 0Tech commented Jan 12, 2023

Description

Closes: #14587


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)

Copy link
Contributor Author

@0Tech 0Tech left a comment

Choose a reason for hiding this comment

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

I provide supplementary comments.

@@ -84,6 +84,8 @@ func (k *Keeper) AssertInvariants(ctx sdk.Context) {
n := len(invarRoutes)
for i, ir := range invarRoutes {
logger.Info("asserting crisis invariants", "inv", fmt.Sprint(i+1, "/", n), "name", ir.FullRoute())

ctx, _ := ctx.CacheContext()
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Add CacheContext() inside the loop, otherwise, an invariant may affect the other's precondition.

@0Tech 0Tech marked this pull request as ready for review January 13, 2023 01:16
@0Tech 0Tech requested a review from a team as a code owner January 13, 2023 01:16
Copy link
Contributor

@likhita-809 likhita-809 left a comment

Choose a reason for hiding this comment

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

seems reasonable to me

x/crisis/keeper/keeper.go Outdated Show resolved Hide resolved
x/crisis/keeper/keeper.go Outdated Show resolved Hide resolved
@facundomedica
Copy link
Member

lgtm, add Bez's nits and we are good to merge

0Tech and others added 2 commits January 14, 2023 13:55
Rename the variable for clarity.

Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com>
@0Tech 0Tech requested review from alexanderbez and removed request for kocubinski and facundomedica January 14, 2023 04:59
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.

Prevent invariants from changing the state
4 participants