chore: move server.GenerateCoinKey and server.GenerateSaveCoinKey to … (#10957)
Cleaning it and moving the breaking "test" code to testutils Related to: https://github.com/cosmos/cosmos-sdk/pull/10956 --- ### 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) - [ ] 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 - [ ] 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)
This commit is contained in:
@@ -0,0 +1,79 @@
|
||||
package testutil
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
"github.com/cosmos/cosmos-sdk/codec"
|
||||
"github.com/cosmos/cosmos-sdk/crypto/keyring"
|
||||
sdk "github.com/cosmos/cosmos-sdk/types"
|
||||
)
|
||||
|
||||
// GenerateCoinKey generates a new key mnemonic along with its addrress.
|
||||
func GenerateCoinKey(algo keyring.SignatureAlgo, cdc codec.Codec) (sdk.AccAddress, string, error) {
|
||||
// generate a private key, with mnemonic
|
||||
info, secret, err := keyring.NewInMemory(cdc).NewMnemonic(
|
||||
"name",
|
||||
keyring.English,
|
||||
sdk.GetConfig().GetFullBIP44Path(),
|
||||
keyring.DefaultBIP39Passphrase,
|
||||
algo,
|
||||
)
|
||||
if err != nil {
|
||||
return sdk.AccAddress{}, "", err
|
||||
}
|
||||
addr, err := info.GetAddress()
|
||||
if err != nil {
|
||||
return sdk.AccAddress{}, "", err
|
||||
}
|
||||
return addr, secret, nil
|
||||
}
|
||||
|
||||
// GenerateSaveCoinKey generates a new key mnemonic with its addrress.
|
||||
// If mnemonic is provided then it's used for key generation.
|
||||
// The key is saved in the keyring. The function returns error if overwrite=true and the key
|
||||
// already exists.
|
||||
func GenerateSaveCoinKey(
|
||||
keybase keyring.Keyring,
|
||||
keyName, mnemonic string,
|
||||
overwrite bool,
|
||||
algo keyring.SignatureAlgo,
|
||||
) (sdk.AccAddress, string, error) {
|
||||
exists := false
|
||||
_, err := keybase.Key(keyName)
|
||||
if err == nil {
|
||||
exists = true
|
||||
}
|
||||
|
||||
// ensure no overwrite
|
||||
if !overwrite && exists {
|
||||
return sdk.AccAddress{}, "", fmt.Errorf("key already exists, overwrite is disabled")
|
||||
}
|
||||
|
||||
if exists {
|
||||
if err := keybase.Delete(keyName); err != nil {
|
||||
return sdk.AccAddress{}, "", fmt.Errorf("failed to overwrite key")
|
||||
}
|
||||
}
|
||||
|
||||
var (
|
||||
record *keyring.Record
|
||||
secret string
|
||||
)
|
||||
|
||||
// generate or recover a new account
|
||||
if mnemonic != "" {
|
||||
secret = mnemonic
|
||||
record, err = keybase.NewAccount(keyName, mnemonic, keyring.DefaultBIP39Passphrase, sdk.GetConfig().GetFullBIP44Path(), algo)
|
||||
} else {
|
||||
record, secret, err = keybase.NewMnemonic(keyName, keyring.English, sdk.GetConfig().GetFullBIP44Path(), keyring.DefaultBIP39Passphrase, algo)
|
||||
}
|
||||
if err != nil {
|
||||
return sdk.AccAddress{}, "", err
|
||||
}
|
||||
|
||||
addr, err := record.GetAddress()
|
||||
if err != nil {
|
||||
return nil, "", err
|
||||
}
|
||||
return addr, secret, nil
|
||||
}
|
||||
@@ -0,0 +1,73 @@
|
||||
package testutil
|
||||
|
||||
import (
|
||||
"testing"
|
||||
|
||||
"github.com/stretchr/testify/require"
|
||||
|
||||
"github.com/cosmos/cosmos-sdk/crypto/hd"
|
||||
"github.com/cosmos/cosmos-sdk/crypto/keyring"
|
||||
"github.com/cosmos/cosmos-sdk/simapp"
|
||||
"github.com/cosmos/cosmos-sdk/types"
|
||||
)
|
||||
|
||||
func TestGenerateCoinKey(t *testing.T) {
|
||||
t.Parallel()
|
||||
cdc := simapp.MakeTestEncodingConfig().Codec
|
||||
addr, mnemonic, err := GenerateCoinKey(hd.Secp256k1, cdc)
|
||||
require.NoError(t, err)
|
||||
|
||||
// Test creation
|
||||
k, err := keyring.NewInMemory(cdc).NewAccount("xxx", mnemonic, "", hd.NewFundraiserParams(0, types.GetConfig().GetCoinType(), 0).String(), hd.Secp256k1)
|
||||
require.NoError(t, err)
|
||||
addr1, err := k.GetAddress()
|
||||
require.NoError(t, err)
|
||||
require.Equal(t, addr, addr1)
|
||||
}
|
||||
|
||||
func TestGenerateSaveCoinKey(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
encCfg := simapp.MakeTestEncodingConfig()
|
||||
kb, err := keyring.New(t.Name(), "test", t.TempDir(), nil, encCfg.Codec)
|
||||
require.NoError(t, err)
|
||||
|
||||
addr, mnemonic, err := GenerateSaveCoinKey(kb, "keyname", "", false, hd.Secp256k1)
|
||||
require.NoError(t, err)
|
||||
|
||||
// Test key was actually saved
|
||||
k, err := kb.Key("keyname")
|
||||
require.NoError(t, err)
|
||||
addr1, err := k.GetAddress()
|
||||
require.NoError(t, err)
|
||||
require.Equal(t, addr, addr1)
|
||||
|
||||
// Test in-memory recovery
|
||||
k, err = keyring.NewInMemory(encCfg.Codec).NewAccount("xxx", mnemonic, "", hd.NewFundraiserParams(0, types.GetConfig().GetCoinType(), 0).String(), hd.Secp256k1)
|
||||
require.NoError(t, err)
|
||||
addr1, err = k.GetAddress()
|
||||
require.NoError(t, err)
|
||||
require.Equal(t, addr, addr1)
|
||||
}
|
||||
|
||||
func TestGenerateSaveCoinKeyOverwriteFlag(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
encCfg := simapp.MakeTestEncodingConfig()
|
||||
kb, err := keyring.New(t.Name(), "test", t.TempDir(), nil, encCfg.Codec)
|
||||
require.NoError(t, err)
|
||||
|
||||
keyname := "justakey"
|
||||
addr1, _, err := GenerateSaveCoinKey(kb, keyname, "", false, hd.Secp256k1)
|
||||
require.NoError(t, err)
|
||||
|
||||
// Test overwrite with overwrite=false
|
||||
_, _, err = GenerateSaveCoinKey(kb, keyname, "", false, hd.Secp256k1)
|
||||
require.Error(t, err)
|
||||
|
||||
// Test overwrite with overwrite=true
|
||||
addr2, _, err := GenerateSaveCoinKey(kb, keyname, "", true, hd.Secp256k1)
|
||||
require.NoError(t, err)
|
||||
|
||||
require.NotEqual(t, addr1, addr2)
|
||||
}
|
||||
@@ -39,6 +39,7 @@ import (
|
||||
"github.com/cosmos/cosmos-sdk/simapp"
|
||||
"github.com/cosmos/cosmos-sdk/simapp/params"
|
||||
storetypes "github.com/cosmos/cosmos-sdk/store/types"
|
||||
"github.com/cosmos/cosmos-sdk/testutil"
|
||||
sdk "github.com/cosmos/cosmos-sdk/types"
|
||||
authtypes "github.com/cosmos/cosmos-sdk/x/auth/types"
|
||||
banktypes "github.com/cosmos/cosmos-sdk/x/bank/types"
|
||||
@@ -357,7 +358,7 @@ func New(l Logger, baseDir string, cfg Config) (*Network, error) {
|
||||
mnemonic = cfg.Mnemonics[i]
|
||||
}
|
||||
|
||||
addr, secret, err := server.GenerateSaveCoinKey(kb, nodeDirName, mnemonic, true, algo)
|
||||
addr, secret, err := testutil.GenerateSaveCoinKey(kb, nodeDirName, mnemonic, true, algo)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
package testutil
|
||||
package testdata
|
||||
|
||||
const (
|
||||
// Tests expect a ledger device initialized to the following mnemonic
|
||||
Reference in New Issue
Block a user