Documentation ¶
Overview ¶
Package flags contains all configuration runtime flags for the validator service.
Index ¶
Constants ¶
View Source
const (
// WalletDefaultDirName for accounts.
WalletDefaultDirName = "prysm-wallet-v2"
)
Variables ¶
View Source
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", } // BeaconRPCGatewayProviderFlag defines a beacon node JSON-RPC endpoint. BeaconRPCGatewayProviderFlag = &cli.StringFlag{ Name: "beacon-rpc-gateway-provider", Usage: "Beacon node RPC gateway provider endpoint", Value: "127.0.0.1:3500", } // 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.", } // EnableRPCFlag enables controlling the validator client via gRPC (without web UI). EnableRPCFlag = &cli.BoolFlag{ Name: "rpc", Usage: "Enables the RPC server for the validator client (without Web UI)", Value: false, } // RPCHost defines the host on which the RPC server should listen. RPCHost = &cli.StringFlag{ Name: "rpc-host", Usage: "Host on which the RPC server should listen", Value: "127.0.0.1", } // RPCPort defines a validator client RPC port to open. RPCPort = &cli.IntFlag{ Name: "rpc-port", Usage: "RPC port exposed by a validator client", Value: 7000, } // 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", } // GRPCGatewayHost specifies a gRPC gateway host for the validator client. GRPCGatewayHost = &cli.StringFlag{ Name: "grpc-gateway-host", Usage: "The host on which the gateway server runs on", Value: "127.0.0.1", } // GRPCGatewayPort enables a gRPC gateway to be exposed for the validator client. GRPCGatewayPort = &cli.IntFlag{ Name: "grpc-gateway-port", Usage: "Enable gRPC gateway for JSON requests", Value: 7500, } // GPRCGatewayCorsDomain serves preflight requests when serving gRPC JSON gateway. GPRCGatewayCorsDomain = &cli.StringFlag{ Name: "grpc-gateway-corsdomain", Usage: "Comma separated list of domains from which to accept cross origin requests " + "(browser enforced). This flag has no effect if not used with --grpc-gateway-port.", Value: "http://localhost:4242,http://127.0.0.1:4242,http://localhost:4200", } // 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, } // WalletDirFlag defines the path to a wallet directory for Prysm accounts. WalletDirFlag = &cli.StringFlag{ Name: "wallet-dir", Usage: "Path to a wallet directory on-disk for Prysm validator accounts", Value: filepath.Join(DefaultValidatorDir(), WalletDefaultDirName), } // AccountPasswordFileFlag is path to a file containing a password for a validator account. AccountPasswordFileFlag = &cli.StringFlag{ Name: "account-password-file", Usage: "Path to a plain-text, .txt file containing a password for a 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", } // ImportPrivateKeyFileFlag allows for directly importing a private key hex string as an account. ImportPrivateKeyFileFlag = &cli.StringFlag{ Name: "import-private-key-file", Usage: "Path to a plain-text, .txt file containing a hex string representation of a private key to import", } // 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.", } // ShowDepositDataFlag for accounts. ShowDepositDataFlag = &cli.BoolFlag{ Name: "show-deposit-data", Usage: "Display raw eth1 tx deposit data for validator accounts", Value: false, } // ShowPrivateKeysFlag for accounts. ShowPrivateKeysFlag = &cli.BoolFlag{ Name: "show-private-keys", Usage: "Display the private keys for validator accounts", Value: false, } // NumAccountsFlag defines the amount of accounts to generate for derived wallets. NumAccountsFlag = &cli.IntFlag{ Name: "num-accounts", Usage: "Number of accounts to generate for derived wallets", Value: 1, } // DeletePublicKeysFlag defines a comma-separated list of hex string public keys // for accounts which a user desires to delete from their wallet. DeletePublicKeysFlag = &cli.StringFlag{ Name: "delete-public-keys", Usage: "Comma-separated list of public key hex strings to specify which validator accounts to delete", Value: "", } // BackupPublicKeysFlag defines a comma-separated list of hex string public keys // for accounts which a user desires to backup from their wallet. BackupPublicKeysFlag = &cli.StringFlag{ Name: "backup-public-keys", Usage: "Comma-separated list of public key hex strings to specify which validator accounts to backup", Value: "", } // VoluntaryExitPublicKeysFlag defines a comma-separated list of hex string public keys // for accounts on which a user wants to perform a voluntary exit. VoluntaryExitPublicKeysFlag = &cli.StringFlag{ Name: "public-keys", Usage: "Comma-separated list of public key hex strings to specify on which validator accounts to perform " + "a voluntary exit", Value: "", } // BackupPasswordFile for encrypting accounts a user wishes to back up. BackupPasswordFile = &cli.StringFlag{ Name: "backup-password-file", Usage: "Path to a plain-text, .txt file containing the desired password for your backed up accounts", Value: "", } // 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 backed up 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 imported, derived, or remote, specified during wallet creation", Value: "", } // SkipDepositConfirmationFlag skips the y/n confirmation prompt for sending a deposit to the deposit contract. SkipDepositConfirmationFlag = &cli.BoolFlag{ Name: "skip-deposit-confirmation", Usage: "Skips the y/n confirmation prompt for sending a deposit to the deposit contract", Value: false, } // EnableWebFlag enables controlling the validator client via the Prysm web ui. This is a work in progress. EnableWebFlag = &cli.BoolFlag{ Name: "web", Usage: "Enables the web portal for the validator client (work in progress)", Value: false, } )
View Source
var ( InteropStartIndex = &cli.Uint64Flag{ Name: "interop-start-index", Usage: "The start index to deterministically generate validator keys when used in combination with " + "--interop-num-validators. Example: --interop-start-index=5 --interop-num-validators=3 would generate " + "keys from index 5 to 7.", } InteropNumValidators = &cli.Uint64Flag{ Name: "interop-num-validators", Usage: "The number of validators to deterministically generate. " + "Example: --interop-start-index=5 --interop-num-validators=3 would generate " + "keys from index 5 to 7.", } )
Flags defined for interoperability testing.
Functions ¶
func DefaultValidatorDir ¶ added in v1.0.0
func DefaultValidatorDir() string
DefaultValidatorDir returns OS-specific default validator directory.
Types ¶
This section is empty.
Click to show internal directories.
Click to hide internal directories.