Drop on-disk keybase in favor of keyring (#5180)

* Switch keys commands to keyring

* Replace NewKeybase with NewKeyring

* Fix delete test

* Purge dead code

* Override COSMOS_SDK_TEST_KEYRING envvar to switch to a test keyring

* s/unningOnServer/unningUnattended/

C'ing @tnachen

* Add deprecated warning, output looks like the following:

```
$ gaiacli keys update --help
Command "update" is deprecated, it takes no effect with the new keyring
based backend and is provided only for backward compatibility with the
legacy LevelDB based backend.
Refer to your operating system's manual to learn how to change your
keyring's password.

Change the password used to protect private key

Usage:
  gaiacli keys update <name> [flags]

Flags:
  -h, --help   help for update

Global Flags:
      --chain-id string   Chain ID of tendermint node
  -e, --encoding string   Binary encoding (hex|b64|btc) (default "hex")
      --home string       directory for config and data (default "/home/alessio/.gaiacli")
  -o, --output string     Output format (text|json) (default "text")
      --trace             print out full stack trace on errors
```

* Update multisign command

* Modify server.GenerateSaveCoinKey()

* GenerateSaveCoinKey more modifications

* Update docs

* Update upgrade module
This commit is contained in:
Alessio Treglia
2019-11-14 15:17:21 +01:00
committed by Federico Kunze
parent 1285782ef6
commit d4c831e63a
34 changed files with 418 additions and 308 deletions
+2 -10
View File
@@ -25,21 +25,13 @@ func GenerateCoinKey() (sdk.AccAddress, string, error) {
// GenerateSaveCoinKey returns the address of a public key, along with the secret
// phrase to recover the private key.
func GenerateSaveCoinKey(clientRoot, keyName, keyPass string,
overwrite bool) (sdk.AccAddress, string, error) {
// get the keystore from the client
keybase, err := clkeys.NewKeyBaseFromDir(clientRoot)
if err != nil {
return sdk.AccAddress([]byte{}), "", err
}
func GenerateSaveCoinKey(keybase keys.Keybase, keyName, keyPass string, overwrite bool) (sdk.AccAddress, string, error) {
// ensure no overwrite
if !overwrite {
_, err := keybase.Get(keyName)
if err == nil {
return sdk.AccAddress([]byte{}), "", fmt.Errorf(
"key already exists, overwrite is disabled (clientRoot: %s)", clientRoot)
"key already exists, overwrite is disabled")
}
}
+14 -20
View File
@@ -1,14 +1,14 @@
package server_test
import (
"io/ioutil"
"os"
"testing"
"github.com/stretchr/testify/require"
"github.com/cosmos/cosmos-sdk/client/keys"
crkeys "github.com/cosmos/cosmos-sdk/crypto/keys"
"github.com/cosmos/cosmos-sdk/server"
"github.com/cosmos/cosmos-sdk/tests"
)
func TestGenerateCoinKey(t *testing.T) {
@@ -24,17 +24,16 @@ func TestGenerateCoinKey(t *testing.T) {
func TestGenerateSaveCoinKey(t *testing.T) {
t.Parallel()
dir, cleanup := tempdir(t)
dir, cleanup := tests.NewTestCaseDir(t)
defer cleanup() // clean after itself
// Remove the dir to that GenerateSaveCoinKey creates it automatically
os.RemoveAll(dir)
addr, mnemonic, err := server.GenerateSaveCoinKey(dir, "keyname", "012345678", false)
kb, err := crkeys.NewTestKeyring(t.Name(), dir)
require.NoError(t, err)
addr, mnemonic, err := server.GenerateSaveCoinKey(kb, "keyname", "012345678", false)
require.NoError(t, err)
// Test key was actually saved
kb, err := keys.NewKeyBaseFromDir(dir)
require.NoError(t, err)
info, err := kb.Get("keyname")
require.NoError(t, err)
require.Equal(t, addr, info.GetAddress())
@@ -47,28 +46,23 @@ func TestGenerateSaveCoinKey(t *testing.T) {
func TestGenerateSaveCoinKeyOverwriteFlag(t *testing.T) {
t.Parallel()
dir, cleanup := tempdir(t)
dir, cleanup := tests.NewTestCaseDir(t)
defer cleanup() // clean after itself
// Remove the dir to that GenerateSaveCoinKey creates it automatically
os.RemoveAll(dir)
kb, err := crkeys.NewTestKeyring(t.Name(), dir)
require.NoError(t, err)
keyname := "justakey"
addr1, _, err := server.GenerateSaveCoinKey(dir, keyname, "012345678", false)
addr1, _, err := server.GenerateSaveCoinKey(kb, keyname, "012345678", false)
require.NoError(t, err)
// Test overwrite with overwrite=false
_, _, err = server.GenerateSaveCoinKey(dir, keyname, "012345678", false)
_, _, err = server.GenerateSaveCoinKey(kb, keyname, "012345678", false)
require.Error(t, err)
// Test overwrite with overwrite=true
addr2, _, err := server.GenerateSaveCoinKey(dir, keyname, "012345678", true)
addr2, _, err := server.GenerateSaveCoinKey(kb, keyname, "012345678", true)
require.NoError(t, err)
require.NotEqual(t, addr1, addr2)
}
func tempdir(t *testing.T) (string, func()) {
dir, err := ioutil.TempDir("", t.Name()+"_")
require.NoError(t, err)
return dir, func() { os.RemoveAll(dir) }
}