6cbbd6da75
<!-- 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 #9222 Closes: #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](https://github.com/cosmos/cosmos-sdk/pull/9222/#discussion_r624683839) - 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)
44 lines
1.4 KiB
Go
44 lines
1.4 KiB
Go
package keys
|
|
|
|
import (
|
|
"github.com/spf13/cobra"
|
|
|
|
"github.com/cosmos/cosmos-sdk/client"
|
|
)
|
|
|
|
// MigrateCommand migrates key information from legacy keybase to OS secret store.
|
|
func MigrateCommand() *cobra.Command {
|
|
cmd := &cobra.Command{
|
|
Use: "migrate",
|
|
Short: "Migrate keys from amino to proto serialization format",
|
|
Long: `Migrate keys from Amino to Protocol Buffers records.
|
|
For each key material entry, the command will check if the key can be deserialized using proto.
|
|
If this is the case, the key is already migrated. Therefore, we skip it and continue with a next one.
|
|
Otherwise, we try to deserialize it using Amino into LegacyInfo. If this attempt is successful, we serialize
|
|
LegacyInfo to Protobuf serialization format and overwrite the keyring entry. If any error occurred, it will be
|
|
outputted in CLI and migration will be continued until all keys in the keyring DB are exhausted.
|
|
See https://github.com/cosmos/cosmos-sdk/pull/9695 for more details.
|
|
|
|
It is recommended to run in 'dry-run' mode first to verify all key migration material.
|
|
`,
|
|
Args: cobra.NoArgs,
|
|
RunE: runMigrateCmd,
|
|
}
|
|
|
|
return cmd
|
|
}
|
|
|
|
func runMigrateCmd(cmd *cobra.Command, _ []string) error {
|
|
clientCtx, err := client.GetClientQueryContext(cmd)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
if _, err = clientCtx.Keyring.MigrateAll(); err != nil {
|
|
return err
|
|
}
|
|
|
|
cmd.Println("Keys migration has been successfully executed")
|
|
return nil
|
|
}
|