Skip to content

Commit

Permalink
Rename Accounts-V2 to Accounts (#7545)
Browse files Browse the repository at this point in the history 
* rename accounts v2

* rename keymanager and fix imports

* rename accounts-v2 instances

* imports

* build

* build fix

* deepsource

* fix up broken aliases

* imports

* gaz

* Update validator/accounts/accounts_import_test.go

Co-authored-by: Ivan Martinez <ivanthegreatdev@gmail.com>

* fmt

Co-authored-by: Ivan Martinez <ivanthegreatdev@gmail.com>
  • Loading branch information
@rauljordan @0xKiwi
rauljordan and 0xKiwi committed Oct 15, 2020
1 parent 7aaefd1 commit a81c863
Show file tree
Hide file tree
Showing 86 changed files with 532 additions and 546 deletions.
4 changes: 2 additions & 2 deletions tools/keystores/BUILD.bazel
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ go_library(
"//shared/fileutil:go_default_library",
"//shared/params:go_default_library",
"//shared/promptutil:go_default_library",
"//validator/keymanager/v2:go_default_library",
"//validator/keymanager:go_default_library",
"@com_github_google_uuid//:go_default_library",
"@com_github_logrusorgru_aurora//:go_default_library",
"@com_github_pkg_errors//:go_default_library",
Expand All @@ -36,7 +36,7 @@ go_test(
"//shared/testutil:go_default_library",
"//shared/testutil/assert:go_default_library",
"//shared/testutil/require:go_default_library",
"//validator/keymanager/v2:go_default_library",
"//validator/keymanager:go_default_library",
"@com_github_google_uuid//:go_default_library",
"@com_github_urfave_cli_v2//:go_default_library",
"@com_github_wealdtech_go_eth2_wallet_encryptor_keystorev4//:go_default_library",
Expand Down
6 changes: 3 additions & 3 deletions tools/keystores/main.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import (
"github.com/prysmaticlabs/prysm/shared/fileutil"
"github.com/prysmaticlabs/prysm/shared/params"
"github.com/prysmaticlabs/prysm/shared/promptutil"
v2keymanager "github.com/prysmaticlabs/prysm/validator/keymanager/v2"
"github.com/prysmaticlabs/prysm/validator/keymanager"
"github.com/urfave/cli/v2"
keystorev4 "github.com/wealdtech/go-eth2-wallet-encryptor-keystorev4"
)
Expand Down Expand Up @@ -198,7 +198,7 @@ func encrypt(cliCtx *cli.Context) error {
if err != nil {
return errors.Wrap(err, "could not encrypt into new keystore")
}
item := &v2keymanager.Keystore{
item := &keymanager.Keystore{
Crypto: cryptoFields,
ID: id.String(),
Version: encryptor.Version(),
Expand Down Expand Up @@ -230,7 +230,7 @@ func readAndDecryptKeystore(fullPath, password string) error {
return errors.Wrapf(err, "could not read file at path: %s", fullPath)
}
decryptor := keystorev4.New()
keystoreFile := &v2keymanager.Keystore{}
keystoreFile := &keymanager.Keystore{}

if err := json.Unmarshal(file, keystoreFile); err != nil {
return errors.Wrap(err, "could not JSON unmarshal keystore file")
Expand Down
6 changes: 3 additions & 3 deletions tools/keystores/main_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import (
"github.com/prysmaticlabs/prysm/shared/testutil"
"github.com/prysmaticlabs/prysm/shared/testutil/assert"
"github.com/prysmaticlabs/prysm/shared/testutil/require"
v2keymanager "github.com/prysmaticlabs/prysm/validator/keymanager/v2"
"github.com/prysmaticlabs/prysm/validator/keymanager"
"github.com/urfave/cli/v2"
keystorev4 "github.com/wealdtech/go-eth2-wallet-encryptor-keystorev4"
)
Expand Down Expand Up @@ -47,15 +47,15 @@ func setupCliContext(
return cli.NewContext(&app, set, nil)
}

func createRandomKeystore(t testing.TB, password string) (*v2keymanager.Keystore, bls.SecretKey) {
func createRandomKeystore(t testing.TB, password string) (*keymanager.Keystore, bls.SecretKey) {
encryptor := keystorev4.New()
id, err := uuid.NewRandom()
require.NoError(t, err)
validatingKey := bls.RandKey()
pubKey := validatingKey.PublicKey().Marshal()
cryptoFields, err := encryptor.Encrypt(validatingKey.Marshal(), password)
require.NoError(t, err)
return &v2keymanager.Keystore{
return &keymanager.Keystore{
Crypto: cryptoFields,
Pubkey: fmt.Sprintf("%x", pubKey),
ID: id.String(),
Expand Down
4 changes: 2 additions & 2 deletions validator/BUILD.bazel
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ go_library(
"//shared/maxprocs:go_default_library",
"//shared/tos:go_default_library",
"//shared/version:go_default_library",
"//validator/accounts/v2:go_default_library",
"//validator/accounts:go_default_library",
"//validator/flags:go_default_library",
"//validator/node:go_default_library",
"@com_github_joonix_log//:go_default_library",
Expand Down Expand Up @@ -60,7 +60,7 @@ go_image(
"//shared/logutil:go_default_library",
"//shared/params:go_default_library",
"//shared/version:go_default_library",
"//validator/accounts/v2:go_default_library",
"//validator/accounts:go_default_library",
"//validator/client:go_default_library",
"//validator/flags:go_default_library",
"//validator/node:go_default_library",
Expand Down
24 changes: 12 additions & 12 deletions validator/accounts/v2/BUILD.bazel → validator/accounts/BUILD.bazel
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ go_library(
"wallet_edit.go",
"wallet_recover.go",
],
importpath = "github.com/prysmaticlabs/prysm/validator/accounts/v2",
importpath = "github.com/prysmaticlabs/prysm/validator/accounts",
visibility = [
"//validator:__pkg__",
"//validator:__subpackages__",
Expand All @@ -33,14 +33,14 @@ go_library(
"//shared/params:go_default_library",
"//shared/petnames:go_default_library",
"//shared/promptutil:go_default_library",
"//validator/accounts/v2/prompt:go_default_library",
"//validator/accounts/v2/wallet:go_default_library",
"//validator/accounts/prompt:go_default_library",
"//validator/accounts/wallet:go_default_library",
"//validator/client:go_default_library",
"//validator/flags:go_default_library",
"//validator/keymanager/v2:go_default_library",
"//validator/keymanager/v2/derived:go_default_library",
"//validator/keymanager/v2/direct:go_default_library",
"//validator/keymanager/v2/remote:go_default_library",
"//validator/keymanager:go_default_library",
"//validator/keymanager/derived:go_default_library",
"//validator/keymanager/direct:go_default_library",
"//validator/keymanager/remote:go_default_library",
"@com_github_google_uuid//:go_default_library",
"@com_github_logrusorgru_aurora//:go_default_library",
"@com_github_manifoldco_promptui//:go_default_library",
Expand Down Expand Up @@ -82,12 +82,12 @@ go_test(
"//shared/testutil/assert:go_default_library",
"//shared/testutil/require:go_default_library",
"//shared/timeutils:go_default_library",
"//validator/accounts/v2/wallet:go_default_library",
"//validator/accounts/wallet:go_default_library",
"//validator/flags:go_default_library",
"//validator/keymanager/v2:go_default_library",
"//validator/keymanager/v2/derived:go_default_library",
"//validator/keymanager/v2/direct:go_default_library",
"//validator/keymanager/v2/remote:go_default_library",
"//validator/keymanager:go_default_library",
"//validator/keymanager/derived:go_default_library",
"//validator/keymanager/direct:go_default_library",
"//validator/keymanager/remote:go_default_library",
"@com_github_gogo_protobuf//types:go_default_library",
"@com_github_golang_mock//gomock:go_default_library",
"@com_github_google_uuid//:go_default_library",
Expand Down
34 changes: 17 additions & 17 deletions validator/accounts/v2/accounts_backup.go → validator/accounts/accounts_backup.go
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package v2
package accounts

import (
"archive/zip"
Expand All @@ -17,12 +17,12 @@ import (
"github.com/prysmaticlabs/prysm/shared/fileutil"
"github.com/prysmaticlabs/prysm/shared/petnames"
"github.com/prysmaticlabs/prysm/shared/promptutil"
"github.com/prysmaticlabs/prysm/validator/accounts/v2/prompt"
"github.com/prysmaticlabs/prysm/validator/accounts/v2/wallet"
"github.com/prysmaticlabs/prysm/validator/accounts/prompt"
"github.com/prysmaticlabs/prysm/validator/accounts/wallet"
"github.com/prysmaticlabs/prysm/validator/flags"
v2keymanager "github.com/prysmaticlabs/prysm/validator/keymanager/v2"
"github.com/prysmaticlabs/prysm/validator/keymanager/v2/derived"
"github.com/prysmaticlabs/prysm/validator/keymanager/v2/direct"
"github.com/prysmaticlabs/prysm/validator/keymanager"
"github.com/prysmaticlabs/prysm/validator/keymanager/derived"
"github.com/prysmaticlabs/prysm/validator/keymanager/direct"
"github.com/urfave/cli/v2"
)

Expand All @@ -42,22 +42,22 @@ const (
func BackupAccountsCli(cliCtx *cli.Context) error {
w, err := wallet.OpenWalletOrElseCli(cliCtx, func(cliCtx *cli.Context) (*wallet.Wallet, error) {
return nil, errors.New(
"no wallet found, nothing to backup. Create a new wallet by running wallet-v2 create",
"no wallet found, nothing to backup. Create a new wallet by running wallet create",
)
})
if err != nil {
return errors.Wrap(err, "could not initialize wallet")
}
if w.KeymanagerKind() == v2keymanager.Remote {
if w.KeymanagerKind() == keymanager.Remote {
return errors.New(
"remote wallets cannot backup accounts",
)
}
keymanager, err := w.InitializeKeymanager(cliCtx.Context, true /* skip mnemonic confirm */)
km, err := w.InitializeKeymanager(cliCtx.Context, true /* skip mnemonic confirm */)
if err != nil {
return errors.Wrap(err, "could not initialize keymanager")
}
pubKeys, err := keymanager.FetchValidatingPublicKeys(cliCtx.Context)
pubKeys, err := km.FetchValidatingPublicKeys(cliCtx.Context)
if err != nil {
return errors.Wrap(err, "could not fetch validating public keys")
}
Expand Down Expand Up @@ -93,27 +93,27 @@ func BackupAccountsCli(cliCtx *cli.Context) error {
return errors.Wrap(err, "could not determine password for backed up accounts")
}

var keystoresToBackup []*v2keymanager.Keystore
var keystoresToBackup []*keymanager.Keystore
switch w.KeymanagerKind() {
case v2keymanager.Direct:
km, ok := keymanager.(*direct.Keymanager)
case keymanager.Direct:
km, ok := km.(*direct.Keymanager)
if !ok {
return errors.New("could not assert keymanager interface to concrete type")
}
keystoresToBackup, err = km.ExtractKeystores(cliCtx.Context, filteredPubKeys, backupsPassword)
if err != nil {
return errors.Wrap(err, "could not backup accounts for direct keymanager")
}
case v2keymanager.Derived:
km, ok := keymanager.(*derived.Keymanager)
case keymanager.Derived:
km, ok := km.(*derived.Keymanager)
if !ok {
return errors.New("could not assert keymanager interface to concrete type")
}
keystoresToBackup, err = km.ExtractKeystores(cliCtx.Context, filteredPubKeys, backupsPassword)
if err != nil {
return errors.Wrap(err, "could not backup accounts for derived keymanager")
}
case v2keymanager.Remote:
case keymanager.Remote:
return errors.New("backing up keys is not supported for a remote keymanager")
default:
return errors.New("keymanager kind not supported")
Expand Down Expand Up @@ -199,7 +199,7 @@ func selectAccounts(selectionPrompt string, pubKeys [][48]byte) ([]bls.PublicKey

// Zips a list of keystore into respective EIP-2335 keystore.json files and
// writes their zipped format into the specified output directory.
func zipKeystoresToOutputDir(keystoresToBackup []*v2keymanager.Keystore, outputDir string) error {
func zipKeystoresToOutputDir(keystoresToBackup []*keymanager.Keystore, outputDir string) error {
if len(keystoresToBackup) == 0 {
return errors.New("nothing to backup")
}
Expand Down
24 changes: 12 additions & 12 deletions ...dator/accounts/v2/accounts_backup_test.go → validator/accounts/accounts_backup_test.go
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package v2
package accounts

import (
"archive/zip"
Expand All @@ -20,8 +20,8 @@ import (
"github.com/prysmaticlabs/prysm/shared/testutil"
"github.com/prysmaticlabs/prysm/shared/testutil/assert"
"github.com/prysmaticlabs/prysm/shared/testutil/require"
"github.com/prysmaticlabs/prysm/validator/accounts/v2/wallet"
v2keymanager "github.com/prysmaticlabs/prysm/validator/keymanager/v2"
"github.com/prysmaticlabs/prysm/validator/accounts/wallet"
"github.com/prysmaticlabs/prysm/validator/keymanager"
)

func TestBackupAccounts_Noninteractive_Derived(t *testing.T) {
Expand Down Expand Up @@ -52,7 +52,7 @@ func TestBackupAccounts_Noninteractive_Derived(t *testing.T) {
cliCtx := setupWalletCtx(t, &testWalletConfig{
// Wallet configuration flags.
walletDir: walletDir,
keymanagerKind: v2keymanager.Derived,
keymanagerKind: keymanager.Derived,
walletPasswordFile: passwordFilePath,
// Flags required for BackupAccounts to work.
backupPasswordFile: backupPasswordFile,
Expand All @@ -61,7 +61,7 @@ func TestBackupAccounts_Noninteractive_Derived(t *testing.T) {
w, err := CreateWalletWithKeymanager(cliCtx.Context, &CreateWalletConfig{
WalletCfg: &wallet.Config{
WalletDir: walletDir,
KeymanagerKind: v2keymanager.Derived,
KeymanagerKind: keymanager.Derived,
WalletPassword: password,
},
})
Expand All @@ -74,14 +74,14 @@ func TestBackupAccounts_Noninteractive_Derived(t *testing.T) {
})
require.NoError(t, err)

keymanager, err := w.InitializeKeymanager(
km, err := w.InitializeKeymanager(
cliCtx.Context,
true, /* skip mnemonic confirm */
)
require.NoError(t, err)

// Obtain the public keys of the accounts we created
pubkeys, err := keymanager.FetchValidatingPublicKeys(cliCtx.Context)
pubkeys, err := km.FetchValidatingPublicKeys(cliCtx.Context)
require.NoError(t, err)
var generatedPubKeys []string
for _, pubkey := range pubkeys {
Expand All @@ -95,7 +95,7 @@ func TestBackupAccounts_Noninteractive_Derived(t *testing.T) {
cliCtx = setupWalletCtx(t, &testWalletConfig{
// Wallet configuration flags.
walletDir: walletDir,
keymanagerKind: v2keymanager.Derived,
keymanagerKind: keymanager.Derived,
walletPasswordFile: passwordFilePath,
// Flags required for BackupAccounts to work.
backupPublicKeys: backupPublicKeys,
Expand Down Expand Up @@ -129,7 +129,7 @@ func TestBackupAccounts_Noninteractive_Derived(t *testing.T) {
require.NoError(t, err)
encodedBytes, err := ioutil.ReadAll(ff)
require.NoError(t, err)
keystoreFile := &v2keymanager.Keystore{}
keystoreFile := &keymanager.Keystore{}
require.NoError(t, json.Unmarshal(encodedBytes, keystoreFile))
require.NoError(t, ff.Close())
unzippedPublicKeys[i] = keystoreFile.Pubkey
Expand Down Expand Up @@ -176,7 +176,7 @@ func TestBackupAccounts_Noninteractive_Direct(t *testing.T) {
cliCtx := setupWalletCtx(t, &testWalletConfig{
// Wallet configuration flags.
walletDir: walletDir,
keymanagerKind: v2keymanager.Direct,
keymanagerKind: keymanager.Direct,
walletPasswordFile: passwordFilePath,
accountPasswordFile: passwordFilePath,
// Flags required for ImportAccounts to work.
Expand All @@ -189,7 +189,7 @@ func TestBackupAccounts_Noninteractive_Direct(t *testing.T) {
w, err := CreateWalletWithKeymanager(cliCtx.Context, &CreateWalletConfig{
WalletCfg: &wallet.Config{
WalletDir: walletDir,
KeymanagerKind: v2keymanager.Direct,
KeymanagerKind: keymanager.Direct,
WalletPassword: password,
},
})
Expand Down Expand Up @@ -226,7 +226,7 @@ func TestBackupAccounts_Noninteractive_Direct(t *testing.T) {
require.NoError(t, err)
encodedBytes, err := ioutil.ReadAll(ff)
require.NoError(t, err)
keystoreFile := &v2keymanager.Keystore{}
keystoreFile := &keymanager.Keystore{}
require.NoError(t, json.Unmarshal(encodedBytes, keystoreFile))
require.NoError(t, ff.Close())
unzippedPublicKeys[i] = keystoreFile.Pubkey
Expand Down
26 changes: 13 additions & 13 deletions validator/accounts/v2/accounts_create.go → validator/accounts/accounts_create.go
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package v2
package accounts

import (
"context"
Expand All @@ -9,16 +9,16 @@ import (
ethpb "github.com/prysmaticlabs/ethereumapis/eth/v1alpha1"
pb "github.com/prysmaticlabs/prysm/proto/validator/accounts/v2"
"github.com/prysmaticlabs/prysm/shared/params"
"github.com/prysmaticlabs/prysm/validator/accounts/v2/wallet"
"github.com/prysmaticlabs/prysm/validator/accounts/wallet"
"github.com/prysmaticlabs/prysm/validator/flags"
v2keymanager "github.com/prysmaticlabs/prysm/validator/keymanager/v2"
"github.com/prysmaticlabs/prysm/validator/keymanager/v2/derived"
"github.com/prysmaticlabs/prysm/validator/keymanager/v2/direct"
"github.com/prysmaticlabs/prysm/validator/keymanager"
"github.com/prysmaticlabs/prysm/validator/keymanager/derived"
"github.com/prysmaticlabs/prysm/validator/keymanager/direct"
"github.com/sirupsen/logrus"
"github.com/urfave/cli/v2"
)

var log = logrus.WithField("prefix", "accounts-v2")
var log = logrus.WithField("prefix", "accounts")

// CreateAccountConfig to run the create account function.
type CreateAccountConfig struct {
Expand All @@ -45,27 +45,27 @@ func CreateAccountCli(cliCtx *cli.Context) error {
// CreateAccount creates a new validator account from user input by opening
// a wallet from the user's specified path.
func CreateAccount(ctx context.Context, cfg *CreateAccountConfig) error {
keymanager, err := cfg.Wallet.InitializeKeymanager(ctx, false /* skip mnemonic confirm */)
km, err := cfg.Wallet.InitializeKeymanager(ctx, false /* skip mnemonic confirm */)
if err != nil && strings.Contains(err.Error(), "invalid checksum") {
return errors.New("wrong wallet password entered")
}
if err != nil {
return errors.Wrap(err, "could not initialize keymanager")
}
switch cfg.Wallet.KeymanagerKind() {
case v2keymanager.Remote:
case keymanager.Remote:
return errors.New("cannot create a new account for a remote keymanager")
case v2keymanager.Direct:
km, ok := keymanager.(*direct.Keymanager)
case keymanager.Direct:
km, ok := km.(*direct.Keymanager)
if !ok {
return errors.New("not a direct keymanager")
}
// Create a new validator account using the specified keymanager.
if _, _, err := km.CreateAccount(ctx); err != nil {
return errors.Wrap(err, "could not create account in wallet")
}
case v2keymanager.Derived:
km, ok := keymanager.(*derived.Keymanager)
case keymanager.Derived:
km, ok := km.(*derived.Keymanager)
if !ok {
return errors.New("not a derived keymanager")
}
Expand All @@ -81,7 +81,7 @@ func CreateAccount(ctx context.Context, cfg *CreateAccountConfig) error {
}
}
log.Infof(
"Successfully created %d accounts. Please use accounts-v2 list to view details for accounts %d through %d",
"Successfully created %d accounts. Please use accounts list to view details for accounts %d through %d",
cfg.NumAccounts,
startNum,
startNum+uint64(cfg.NumAccounts)-1,
Expand Down

0 comments on commit a81c863

Please sign in to comment.