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)
90 lines
2.6 KiB
Go
90 lines
2.6 KiB
Go
package keyring
|
|
|
|
import (
|
|
"github.com/cosmos/cosmos-sdk/codec"
|
|
codectypes "github.com/cosmos/cosmos-sdk/codec/types"
|
|
cryptotypes "github.com/cosmos/cosmos-sdk/crypto/types"
|
|
sdk "github.com/cosmos/cosmos-sdk/types"
|
|
)
|
|
|
|
// TODO: Move this file to client/keys
|
|
// Use protobuf interface marshaler rather then generic JSON
|
|
|
|
// KeyOutput defines a structure wrapping around an Info object used for output
|
|
// functionality.
|
|
type KeyOutput struct {
|
|
Name string `json:"name" yaml:"name"`
|
|
Type string `json:"type" yaml:"type"`
|
|
Address string `json:"address" yaml:"address"`
|
|
PubKey string `json:"pubkey" yaml:"pubkey"`
|
|
Mnemonic string `json:"mnemonic,omitempty" yaml:"mnemonic"`
|
|
}
|
|
|
|
// NewKeyOutput creates a default KeyOutput instance without Mnemonic, Threshold and PubKeys
|
|
func NewKeyOutput(name string, keyType KeyType, a sdk.Address, pk cryptotypes.PubKey) (KeyOutput, error) { // nolint:interfacer
|
|
apk, err := codectypes.NewAnyWithValue(pk)
|
|
if err != nil {
|
|
return KeyOutput{}, err
|
|
}
|
|
bz, err := codec.ProtoMarshalJSON(apk, nil)
|
|
if err != nil {
|
|
return KeyOutput{}, err
|
|
}
|
|
return KeyOutput{
|
|
Name: name,
|
|
Type: keyType.String(),
|
|
Address: a.String(),
|
|
PubKey: string(bz),
|
|
}, nil
|
|
}
|
|
|
|
// MkConsKeyOutput create a KeyOutput in with "cons" Bech32 prefixes.
|
|
func MkConsKeyOutput(k *Record) (KeyOutput, error) {
|
|
pk, err := k.GetPubKey()
|
|
if err != nil {
|
|
return KeyOutput{}, err
|
|
}
|
|
addr := sdk.ConsAddress(pk.Address())
|
|
return NewKeyOutput(k.Name, k.GetType(), addr, pk)
|
|
}
|
|
|
|
// MkValKeyOutput create a KeyOutput in with "val" Bech32 prefixes.
|
|
func MkValKeyOutput(k *Record) (KeyOutput, error) {
|
|
pk, err := k.GetPubKey()
|
|
if err != nil {
|
|
return KeyOutput{}, err
|
|
}
|
|
|
|
addr := sdk.ValAddress(pk.Address())
|
|
|
|
return NewKeyOutput(k.Name, k.GetType(), addr, pk)
|
|
}
|
|
|
|
// MkAccKeyOutput create a KeyOutput in with "acc" Bech32 prefixes. If the
|
|
// public key is a multisig public key, then the threshold and constituent
|
|
// public keys will be added.
|
|
func MkAccKeyOutput(k *Record) (KeyOutput, error) {
|
|
pk, err := k.GetPubKey()
|
|
if err != nil {
|
|
return KeyOutput{}, err
|
|
}
|
|
addr := sdk.AccAddress(pk.Address())
|
|
return NewKeyOutput(k.Name, k.GetType(), addr, pk)
|
|
}
|
|
|
|
// MkAccKeysOutput returns a slice of KeyOutput objects, each with the "acc"
|
|
// Bech32 prefixes, given a slice of Record objects. It returns an error if any
|
|
// call to MkKeyOutput fails.
|
|
func MkAccKeysOutput(records []*Record) ([]KeyOutput, error) {
|
|
kos := make([]KeyOutput, len(records))
|
|
var err error
|
|
for i, r := range records {
|
|
kos[i], err = MkAccKeyOutput(r)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
}
|
|
|
|
return kos, nil
|
|
}
|