mirror of
https://gitlab.com/pulsechaincom/prysm-pulse.git
synced 2024-12-25 12:57:18 +00:00
9d08ba49de
* change default wallet dir path to not be hidden * gaz + pass wallet dir * gaz + move const to flags * move to flags * move to flags * use filepath join in order to create a valid dir name * add wallet dir * return err no wallet found issues * fix up edit remote * all tests passing * fix test * create or open wallet * ivan feedback * enter password for account with pubkey * Update validator/accounts/v2/accounts_create.go Co-authored-by: Ivan Martinez <ivanthegreatdev@gmail.com> * works * preston feedback * nothing to export * fmt * test for create or open * gaz Co-authored-by: shayzluf <thezluf@gmail.com> Co-authored-by: prylabs-bulldozer[bot] <58059840+prylabs-bulldozer[bot]@users.noreply.github.com> Co-authored-by: Ivan Martinez <ivanthegreatdev@gmail.com>
253 lines
9.9 KiB
Go
253 lines
9.9 KiB
Go
// Package flags contains all configuration runtime flags for
|
|
// the validator service.
|
|
package flags
|
|
|
|
import (
|
|
"os"
|
|
"os/user"
|
|
"path/filepath"
|
|
"runtime"
|
|
"time"
|
|
|
|
"github.com/urfave/cli/v2"
|
|
)
|
|
|
|
const (
|
|
// WalletDefaultDirName for accounts-v2.
|
|
WalletDefaultDirName = "prysm-wallet-v2"
|
|
// PasswordsDefaultDirName where account-v2 passwords are stored.
|
|
PasswordsDefaultDirName = "prysm-wallet-v2-passwords"
|
|
)
|
|
|
|
var (
|
|
// DisableAccountMetricsFlag defines the graffiti value included in proposed blocks, default false.
|
|
DisableAccountMetricsFlag = &cli.BoolFlag{
|
|
Name: "disable-account-metrics",
|
|
Usage: "Disable prometheus metrics for validator accounts. Operators with high volumes " +
|
|
"of validating keys may wish to disable granular prometheus metrics as it increases " +
|
|
"the data cardinality.",
|
|
}
|
|
// BeaconRPCProviderFlag defines a beacon node RPC endpoint.
|
|
BeaconRPCProviderFlag = &cli.StringFlag{
|
|
Name: "beacon-rpc-provider",
|
|
Usage: "Beacon node RPC provider endpoint",
|
|
Value: "127.0.0.1:4000",
|
|
}
|
|
// CertFlag defines a flag for the node's TLS certificate.
|
|
CertFlag = &cli.StringFlag{
|
|
Name: "tls-cert",
|
|
Usage: "Certificate for secure gRPC. Pass this and the tls-key flag in order to use gRPC securely.",
|
|
}
|
|
// SlasherRPCProviderFlag defines a slasher node RPC endpoint.
|
|
SlasherRPCProviderFlag = &cli.StringFlag{
|
|
Name: "slasher-rpc-provider",
|
|
Usage: "Slasher node RPC provider endpoint",
|
|
Value: "127.0.0.1:4002",
|
|
}
|
|
// SlasherCertFlag defines a flag for the slasher node's TLS certificate.
|
|
SlasherCertFlag = &cli.StringFlag{
|
|
Name: "slasher-tls-cert",
|
|
Usage: "Certificate for secure slasher gRPC. Pass this and the tls-key flag in order to use gRPC securely.",
|
|
}
|
|
// DisablePenaltyRewardLogFlag defines the ability to not log reward/penalty information during deployment
|
|
DisablePenaltyRewardLogFlag = &cli.BoolFlag{
|
|
Name: "disable-rewards-penalties-logging",
|
|
Usage: "Disable reward/penalty logging during cluster deployment",
|
|
}
|
|
// GraffitiFlag defines the graffiti value included in proposed blocks
|
|
GraffitiFlag = &cli.StringFlag{
|
|
Name: "graffiti",
|
|
Usage: "String to include in proposed blocks",
|
|
}
|
|
// GrpcRetriesFlag defines the number of times to retry a failed gRPC request.
|
|
GrpcRetriesFlag = &cli.UintFlag{
|
|
Name: "grpc-retries",
|
|
Usage: "Number of attempts to retry gRPC requests",
|
|
Value: 5,
|
|
}
|
|
// GrpcRetryDelayFlag defines the interval to retry a failed gRPC request.
|
|
GrpcRetryDelayFlag = &cli.DurationFlag{
|
|
Name: "grpc-retry-delay",
|
|
Usage: "The amount of time between gRPC retry requests.",
|
|
Value: 1 * time.Second,
|
|
}
|
|
// GrpcHeadersFlag defines a list of headers to send with all gRPC requests.
|
|
GrpcHeadersFlag = &cli.StringFlag{
|
|
Name: "grpc-headers",
|
|
Usage: "A comma separated list of key value pairs to pass as gRPC headers for all gRPC " +
|
|
"calls. Example: --grpc-headers=key=value",
|
|
}
|
|
// KeyManager specifies the key manager to use.
|
|
KeyManager = &cli.StringFlag{
|
|
Name: "keymanager",
|
|
Usage: "The keymanger to use (unencrypted, interop, keystore, wallet)",
|
|
Value: "",
|
|
}
|
|
// KeyManagerOpts specifies the key manager options.
|
|
KeyManagerOpts = &cli.StringFlag{
|
|
Name: "keymanageropts",
|
|
Usage: "The options for the keymanger, either a JSON string or path to same",
|
|
Value: "",
|
|
}
|
|
// KeystorePathFlag defines the location of the keystore directory for a validator's account.
|
|
KeystorePathFlag = &cli.StringFlag{
|
|
Name: "keystore-path",
|
|
Usage: "Path to the desired keystore directory",
|
|
}
|
|
// MonitoringPortFlag defines the http port used to serve prometheus metrics.
|
|
MonitoringPortFlag = &cli.IntFlag{
|
|
Name: "monitoring-port",
|
|
Usage: "Port used to listening and respond metrics for prometheus.",
|
|
Value: 8081,
|
|
}
|
|
// PasswordFlag defines the password value for storing and retrieving validator private keys from the keystore.
|
|
PasswordFlag = &cli.StringFlag{
|
|
Name: "password",
|
|
Usage: "String value of the password for your validator private keys",
|
|
}
|
|
// SourceDirectories defines the locations of the source validator databases while managing validators.
|
|
SourceDirectories = &cli.StringFlag{
|
|
Name: "source-dirs",
|
|
Usage: "The directory of source validator databases",
|
|
}
|
|
// SourceDirectory defines the location of the source validator database while managing validators.
|
|
SourceDirectory = &cli.StringFlag{
|
|
Name: "source-dir",
|
|
Usage: "The directory of the source validator database",
|
|
}
|
|
// TargetDirectory defines the location of the target validator database while managing validators.
|
|
TargetDirectory = &cli.StringFlag{
|
|
Name: "target-dir",
|
|
Usage: "The directory of the target validator database",
|
|
}
|
|
// UnencryptedKeysFlag specifies a file path of a JSON file of unencrypted validator keys as an
|
|
// alternative from launching the validator client from decrypting a keystore directory.
|
|
UnencryptedKeysFlag = &cli.StringFlag{
|
|
Name: "unencrypted-keys",
|
|
Usage: "Filepath to a JSON file of unencrypted validator keys for easier launching of the validator client",
|
|
Value: "",
|
|
}
|
|
// WalletDirFlag defines the path to a wallet directory for Prysm accounts-v2.
|
|
WalletDirFlag = &cli.StringFlag{
|
|
Name: "wallet-dir",
|
|
Usage: "Path to a wallet directory on-disk for Prysm validator accounts",
|
|
Value: filepath.Join(DefaultValidatorDir(), WalletDefaultDirName),
|
|
}
|
|
// WalletPasswordsDirFlag defines the path for a passwords directory for
|
|
// Prysm accounts-v2.
|
|
WalletPasswordsDirFlag = &cli.StringFlag{
|
|
Name: "passwords-dir",
|
|
Usage: "Path to a directory on-disk where account passwords are stored",
|
|
Value: filepath.Join(DefaultValidatorDir(), PasswordsDefaultDirName),
|
|
}
|
|
// AccountPasswordFileFlag is path to a file containing a password for a new validator account.
|
|
AccountPasswordFileFlag = &cli.StringFlag{
|
|
Name: "account-password-file",
|
|
Usage: "Path to a plain-text, .txt file containing a password for a new validator account",
|
|
}
|
|
// WalletPasswordFileFlag is the path to a file containing your wallet password.
|
|
WalletPasswordFileFlag = &cli.StringFlag{
|
|
Name: "wallet-password-file",
|
|
Usage: "Path to a plain-text, .txt file containing your wallet password",
|
|
}
|
|
// MnemonicFileFlag is used to enter a file to mnemonic phrase for new wallet creation, non-interactively.
|
|
MnemonicFileFlag = &cli.StringFlag{
|
|
Name: "mnemonic-file",
|
|
Usage: "File to retrieve mnemonic for non-interactively passing a mnemonic phrase into wallet recover.",
|
|
}
|
|
// SkipMnemonicConfirmFlag is used to skip the withdrawal key mnemonic phrase prompt confirmation.
|
|
SkipMnemonicConfirmFlag = &cli.BoolFlag{
|
|
Name: "skip-mnemonic-confirm",
|
|
Usage: "Skip the withdrawal key mnemonic phrase prompt confirmation",
|
|
}
|
|
// ShowDepositDataFlag for accounts-v2.
|
|
ShowDepositDataFlag = &cli.BoolFlag{
|
|
Name: "show-deposit-data",
|
|
Usage: "Display raw eth1 tx deposit data for validator accounts-v2",
|
|
Value: false,
|
|
}
|
|
// AccountsFlag for non-interactive usage of accounts exporting, sets a list of account names or all to be exported.
|
|
AccountsFlag = &cli.StringSliceFlag{
|
|
Name: "accounts",
|
|
Usage: "List of account names to export, or \"all\" to backup all accounts",
|
|
}
|
|
// NumAccountsFlag defines the amount of accounts to generate for derived wallets.
|
|
NumAccountsFlag = &cli.Int64Flag{
|
|
Name: "num-accounts",
|
|
Usage: "Number of accounts to generate for derived wallets",
|
|
Value: 1,
|
|
}
|
|
// BackupDirFlag defines the path for the zip backup of the wallet will be created.
|
|
BackupDirFlag = &cli.StringFlag{
|
|
Name: "backup-dir",
|
|
Usage: "Path to a directory where accounts will be exported into a zip file",
|
|
Value: DefaultValidatorDir(),
|
|
}
|
|
// KeysDirFlag defines the path for a directory where keystores to be imported at stored.
|
|
KeysDirFlag = &cli.StringFlag{
|
|
Name: "keys-dir",
|
|
Usage: "Path to a directory where keystores to be imported are stored",
|
|
}
|
|
// GrpcRemoteAddressFlag defines the host:port address for a remote keymanager to connect to.
|
|
GrpcRemoteAddressFlag = &cli.StringFlag{
|
|
Name: "grpc-remote-address",
|
|
Usage: "Host:port of a gRPC server for a remote keymanager",
|
|
Value: "",
|
|
}
|
|
// RemoteSignerCertPathFlag defines the path to a client.crt file for a wallet to connect to
|
|
// a secure signer via TLS and gRPC.
|
|
RemoteSignerCertPathFlag = &cli.StringFlag{
|
|
Name: "remote-signer-crt-path",
|
|
Usage: "/path/to/client.crt for establishing a secure, TLS gRPC connection to a remote signer server",
|
|
Value: "",
|
|
}
|
|
// RemoteSignerKeyPathFlag defines the path to a client.key file for a wallet to connect to
|
|
// a secure signer via TLS and gRPC.
|
|
RemoteSignerKeyPathFlag = &cli.StringFlag{
|
|
Name: "remote-signer-key-path",
|
|
Usage: "/path/to/client.key for establishing a secure, TLS gRPC connection to a remote signer server",
|
|
Value: "",
|
|
}
|
|
// RemoteSignerCACertPathFlag defines the path to a ca.crt file for a wallet to connect to
|
|
// a secure signer via TLS and gRPC.
|
|
RemoteSignerCACertPathFlag = &cli.StringFlag{
|
|
Name: "remote-signer-ca-crt-path",
|
|
Usage: "/path/to/ca.crt for establishing a secure, TLS gRPC connection to a remote signer server",
|
|
Value: "",
|
|
}
|
|
// KeymanagerKindFlag defines the kind of keymanager desired by a user during wallet creation.
|
|
KeymanagerKindFlag = &cli.StringFlag{
|
|
Name: "keymanager-kind",
|
|
Usage: "Kind of keymanager, either direct, derived, or remote, specified during wallet creation",
|
|
Value: "",
|
|
}
|
|
)
|
|
|
|
// DefaultValidatorDir returns OS-specific default validator directory.
|
|
func DefaultValidatorDir() string {
|
|
// Try to place the data folder in the user's home dir
|
|
home := homeDir()
|
|
if home != "" {
|
|
if runtime.GOOS == "darwin" {
|
|
return filepath.Join(home, "Library", "Eth2Validators")
|
|
} else if runtime.GOOS == "windows" {
|
|
return filepath.Join(home, "AppData", "Roaming", "Eth2Validators")
|
|
} else {
|
|
return filepath.Join(home, ".eth2validators")
|
|
}
|
|
}
|
|
// As we cannot guess a stable location, return empty and handle later
|
|
return ""
|
|
}
|
|
|
|
// homeDir returns home directory path.
|
|
func homeDir() string {
|
|
if home := os.Getenv("HOME"); home != "" {
|
|
return home
|
|
}
|
|
if usr, err := user.Current(); err == nil {
|
|
return usr.HomeDir
|
|
}
|
|
return ""
|
|
}
|