Skip to content

Commit

Permalink
feat: support custom mnemonics in in-process testing network (backport
Browse files Browse the repository at this point in the history
  • Loading branch information
mergify[bot] authored and Eengineer1 committed Aug 26, 2022
1 parent 318728d commit 54ecb79
Show file tree
Hide file tree
Showing 4 changed files with 280 additions and 552 deletions.
55 changes: 43 additions & 12 deletions server/init.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,28 @@ import (
// phrase to recover the private key.
func GenerateCoinKey(algo keyring.SignatureAlgo) (sdk.AccAddress, string, error) {
// generate a private key, with recovery phrase
info, secret, err := keyring.NewInMemory().NewMnemonic("name", keyring.English, sdk.GetConfig().GetFullBIP44Path(), keyring.DefaultBIP39Passphrase, algo)
info, secret, err := keyring.NewInMemory().NewMnemonic(
"name",
keyring.English,
sdk.GetConfig().GetFullBIP44Path(),
keyring.DefaultBIP39Passphrase,
algo,
)
if err != nil {
return sdk.AccAddress([]byte{}), "", err
return sdk.AccAddress{}, "", err
}

return sdk.AccAddress(info.GetPubKey().Address()), secret, nil
}

// GenerateSaveCoinKey returns the address of a public key, along with the secret
// phrase to recover the private key.
func GenerateSaveCoinKey(keybase keyring.Keyring, keyName string, overwrite bool, algo keyring.SignatureAlgo) (sdk.AccAddress, string, error) {
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 {
Expand All @@ -30,22 +42,41 @@ func GenerateSaveCoinKey(keybase keyring.Keyring, keyName string, overwrite bool

// ensure no overwrite
if !overwrite && exists {
return sdk.AccAddress([]byte{}), "", fmt.Errorf(
"key already exists, overwrite is disabled")
return sdk.AccAddress{}, "", fmt.Errorf("key already exists, overwrite is disabled")
}

// generate a private key, with recovery phrase
// remove the old key by name if it exists
if exists {
err = keybase.Delete(keyName)
if err != nil {
return sdk.AccAddress([]byte{}), "", fmt.Errorf(
"failed to overwrite key")
if err := keybase.Delete(keyName); err != nil {
return sdk.AccAddress{}, "", fmt.Errorf("failed to overwrite key")
}
}

info, secret, err := keybase.NewMnemonic(keyName, keyring.English, sdk.GetConfig().GetFullBIP44Path(), keyring.DefaultBIP39Passphrase, algo)
var (
info keyring.Info
secret string
)

if mnemonic != "" {
secret = mnemonic
info, err = keybase.NewAccount(
keyName,
mnemonic,
keyring.DefaultBIP39Passphrase,
sdk.GetConfig().GetFullBIP44Path(),
algo,
)
} else {
info, secret, err = keybase.NewMnemonic(
keyName,
keyring.English,
sdk.GetConfig().GetFullBIP44Path(),
keyring.DefaultBIP39Passphrase,
algo,
)
}
if err != nil {
return sdk.AccAddress([]byte{}), "", err
return sdk.AccAddress{}, "", err
}

return sdk.AccAddress(info.GetPubKey().Address()), secret, nil
Expand Down
64 changes: 64 additions & 0 deletions server/init_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
package server_test

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/server"
"github.com/cosmos/cosmos-sdk/types"
)

func TestGenerateCoinKey(t *testing.T) {
t.Parallel()
addr, mnemonic, err := server.GenerateCoinKey(hd.Secp256k1)
require.NoError(t, err)

// Test creation
info, err := keyring.NewInMemory().NewAccount("xxx", mnemonic, "", hd.NewFundraiserParams(0, types.GetConfig().GetCoinType(), 0).String(), hd.Secp256k1)
require.NoError(t, err)
require.Equal(t, addr, info.GetAddress())
}

func TestGenerateSaveCoinKey(t *testing.T) {
t.Parallel()

kb, err := keyring.New(t.Name(), "test", t.TempDir(), nil)
require.NoError(t, err)

addr, mnemonic, err := server.GenerateSaveCoinKey(kb, "keyname", "", false, hd.Secp256k1)
require.NoError(t, err)

// Test key was actually saved
info, err := kb.Key("keyname")
require.NoError(t, err)
require.Equal(t, addr, info.GetAddress())

// Test in-memory recovery
info, err = keyring.NewInMemory().NewAccount("xxx", mnemonic, "", hd.NewFundraiserParams(0, types.GetConfig().GetCoinType(), 0).String(), hd.Secp256k1)
require.NoError(t, err)
require.Equal(t, addr, info.GetAddress())
}

func TestGenerateSaveCoinKeyOverwriteFlag(t *testing.T) {
t.Parallel()

kb, err := keyring.New(t.Name(), "test", t.TempDir(), nil)
require.NoError(t, err)

keyname := "justakey"
addr1, _, err := server.GenerateSaveCoinKey(kb, keyname, "", false, hd.Secp256k1)
require.NoError(t, err)

// Test overwrite with overwrite=false
_, _, err = server.GenerateSaveCoinKey(kb, keyname, "", false, hd.Secp256k1)
require.Error(t, err)

// Test overwrite with overwrite=true
addr2, _, err := server.GenerateSaveCoinKey(kb, keyname, "", true, hd.Secp256k1)
require.NoError(t, err)

require.NotEqual(t, addr1, addr2)
}
Loading

0 comments on commit 54ecb79

Please sign in to comment.