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: use IterateClientStates in migration code #2857

Closed
wants to merge 11 commits into from

Conversation

colin-axner
Copy link
Contributor

@colin-axner colin-axner commented Nov 30, 2022

Description

Going to skip a changelog since this modifies unreleased code

closes: #2845

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

modules/core/02-client/migrations/v7/expected_keepers.go Outdated Show resolved Hide resolved
}

return clients, nil
func collectClients(ctx sdk.Context, keeper ClientKeeper, clientType string) (clients []string, err error) {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

left this function as I think it is a cleaner API than IterateClientStates


// collect all clients to avoid performing store state changes during iteration
defer iterator.Close()
for ; iterator.Valid(); iterator.Next() {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

:)

return false
})

return clientIDs, nil
}

// removeAllClientConsensusStates removes all client consensus states from the associated
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This function can be improved if we add a prefix to the IterateConsensusStates function

@@ -0,0 +1,16 @@
package tendermint
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This file is only for migrations.go. I wonder if this warrants making a subdirectory migrations? And moving, expected_keepers.go, migrations.go and migrations_test.go

@colin-axner
Copy link
Contributor Author

Going to split this pr up

@colin-axner colin-axner closed this Dec 1, 2022
@colin-axner colin-axner deleted the colin/2845-use-iterateclientstates branch March 13, 2023 17:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Modify optional tendermint migration to take in 02-client keeper instead of store key
1 participant