refactor!: Keyring migration #9695
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
cyberbono3
commented
Sep 13, 2021
cyberbono3
commented
Sep 13, 2021
…berbono3/keyring-migration
robert-zaremba
approved these changes
Sep 16, 2021
| cmd.PrintErrln("Migration complete.") | ||
|
|
||
| return err | ||
| cmd.Println("Keys migration has been successfully executed") |
There was a problem hiding this comment.
This one you can leave. But you should remove most of other printlns.
| } | ||
|
|
||
| return priv, nil | ||
| // case legacyLedgerInfo, legacyOfflineInfo, LegacyMultiInfo: |
There was a problem hiding this comment.
Error is better than panic.
crypto/keyring/legacy_info.go
Outdated
| return priv, nil | ||
| // case legacyLedgerInfo, legacyOfflineInfo, LegacyMultiInfo: | ||
| default: | ||
| return nil, errors.New("only works on local private keys") |
There was a problem hiding this comment.
In the error message, please add the legacyLocalInfo, eg:
fmt.Errorf("only works on local private keys, provided %s", linfo)
There was a problem hiding this comment.
See Comment what other printlns do you mean, @robert-zaremba ?
|
See Comment What other printlns do you mean, @robert-zaremba ? |
cyberbono3
commented
Sep 18, 2021
| require.Equal(t, newKey.GetType(), oldKey.GetType()) | ||
| } | ||
| func requireEqualRenamedKey(t *testing.T, key *Record, mnemonic *Record, nameMatch bool) { | ||
| if nameMatch { |
There was a problem hiding this comment.
I added 'nameMatch' argument to requireEqualRenamedKey as in some cases i dont need name check ( e.g. at L1319). If it is set to true, it checks if key.Name and mnemonic.Name match as you can see below. I hope it sounds good to you, @robert-zaremba
cyberbono3
force-pushed
the
cyberbono3/keyring-migration
branch
from
a9aa77c
to
1b7b8af
Compare
…berbono3/keyring-migration
cyberbono3
added
the
A:automerge
|
Thanks a lot @cyberbono3 for your work on this PR! |
|
I hope this work was completed putting legacy clients first and ensuring that Cosmos Hub users would not stumble on any disruption whatsoever. Else, you will hear people shouting very, very loud and from all directions with the next release. As a word of advice, I'd test this thoroughly before releasing it. |
This was referenced Sep 23, 2021
19 tasks
This was referenced Aug 24, 2022
larry0x
pushed a commit
to larry0x/cosmos-sdk
that referenced
this pull request
May 22, 2023
<!-- The default pull request template is for types feat, fix, or refactor. For other templates, add one of the following parameters to the url: - template=docs.md - template=other.md --> ## Description The draft PR cosmos#9222 Closes: cosmos#7108 <!-- Add a description of the changes that this PR introduces and the files that are the most critical to review. --> - implement proto definition for `Record` - rename `Info.go` to `legacyInfo.go` within `keyring` package - implement CLI `migrate` command that migrates all keys from legacyInfo to proto according to @robert-zaremba migration [algorithm](cosmos#9222) - remove legacy keybase entirely. - add `Migrate` and `MigrateAll` functions in `keyring.go` for single key and all keys migration - add tests - fix tests --- ### 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](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] added `!` to the type prefix if API or client breaking change - [ ] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting)) - [ ] provided a link to the relevant issue or specification - [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules) - [x] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing) - [ ] added a changelog entry to `CHANGELOG.md` - [ ] included comments for [documenting Go code](https://blog.golang.org/godoc) - [ ] updated the relevant documentation or specification - [x] 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](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) 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)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
The draft PR #9222
Closes: #7108
RecordInfo.gotolegacyInfo.gowithinkeyringpackagemigratecommand that migrates all keys from legacyInfo to proto according to @robert-zaremba migration algorithmMigrateandMigrateAllfunctions inkeyring.gofor single key and all keys migrationAuthor 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...
!to the type prefix if API or client breaking changeCHANGELOG.mdReviewers 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...
!in the type prefix if API or client breaking change