Documentation ¶
Overview ¶
Package featureconfig defines which features are enabled for runtime in order to selectively enable certain features to maintain a stable runtime.
The process for implementing new features using this package is as follows:
- Add a new CMD flag in flags.go, and place it in the proper list(s) var for its client.
- Add a condition for the flag in the proper Configure function(s) below.
- Place any "new" behavior in the `if flagEnabled` statement.
- Place any "previous" behavior in the `else` statement.
- Ensure any tests using the new feature fail if the flag isn't enabled. 5a. Use the following to enable your flag for tests: cfg := &featureconfig.Flags{ VerifyAttestationSigs: true, } resetCfg := featureconfig.InitWithReset(cfg) defer resetCfg()
- Add the string for the flags that should be running within E2E to E2EValidatorFlags and E2EBeaconChainFlags.
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( // ToledoTestnet flag for the multiclient eth2 testnet. ToledoTestnet = &cli.BoolFlag{ Name: "toledo", Usage: "This defines the flag through which we can run on the Toledo Multiclient Testnet", } // PyrmontTestnet flag for the multiclient eth2 testnet. PyrmontTestnet = &cli.BoolFlag{ Name: "pyrmont", Usage: "This defines the flag through which we can run on the Pyrmont Multiclient Testnet", } // Mainnet flag for easier tooling, no-op Mainnet = &cli.BoolFlag{ Value: true, Name: "mainnet", Usage: "Run on Ethereum 2.0 Main Net. This is the default and can be omitted.", } )
var BeaconChainFlags = append(deprecatedFlags, []cli.Flag{ devModeFlag, writeSSZStateTransitionsFlag, kafkaBootstrapServersFlag, waitForSyncedFlag, disableGRPCConnectionLogging, attestationAggregationStrategy, ToledoTestnet, PyrmontTestnet, Mainnet, disableBlst, disableEth1DataMajorityVote, enablePeerScorer, checkPtInfoCache, disablePruningDepositProofs, enableSyncBacktracking, }...)
BeaconChainFlags contains a list of all the feature flags that apply to the beacon-chain client.
var E2EBeaconChainFlags = []string{
"--attestation-aggregation-strategy=max_cover",
"--dev",
"--use-check-point-cache",
}
E2EBeaconChainFlags contains a list of the beacon chain feature flags to be tested in E2E.
var E2EValidatorFlags = []string{
"--wait-for-synced",
}
E2EValidatorFlags contains a list of the validator feature flags to be tested in E2E.
var SlasherFlags = append(deprecatedFlags, []cli.Flag{ disableLookbackFlag, ToledoTestnet, PyrmontTestnet, Mainnet, }...)
SlasherFlags contains a list of all the feature flags that apply to the slasher client.
var ValidatorFlags = append(deprecatedFlags, []cli.Flag{ enableExternalSlasherProtectionFlag, waitForSyncedFlag, ToledoTestnet, PyrmontTestnet, Mainnet, disableAccountsV2, disableBlst, }...)
ValidatorFlags contains a list of all the feature flags that apply to the validator client.
Functions ¶
func ActiveFlags ¶ added in v0.3.7
func ActiveFlags(flags []cli.Flag) []cli.Flag
ActiveFlags returns all of the flags that are not Hidden.
func ConfigureBeaconChain ¶
func ConfigureBeaconChain(ctx *cli.Context)
ConfigureBeaconChain sets the global config based on what flags are enabled for the beacon-chain client.
func ConfigureSlasher ¶ added in v1.0.0
func ConfigureSlasher(ctx *cli.Context)
ConfigureSlasher sets the global config based on what flags are enabled for the slasher client.
func ConfigureValidator ¶
func ConfigureValidator(ctx *cli.Context)
ConfigureValidator sets the global config based on what flags are enabled for the validator client.
func InitWithReset ¶ added in v1.0.0
func InitWithReset(c *Flags) func()
InitWithReset sets the global config and returns function that is used to reset configuration.
Types ¶
type Flags ¶ added in v0.2.5
type Flags struct { // Testnet Flags. ToledoTestnet bool // ToledoTestnet defines the flag through which we can enable the node to run on the Toledo testnet. PyrmontTestnet bool // PyrmontTestnet defines the flag through which we can enable the node to run on the Pyrmont testnet. // Feature related flags. WriteSSZStateTransitions bool // WriteSSZStateTransitions to tmp directory. SkipBLSVerify bool // Skips BLS verification across the runtime. EnableBlst bool // Enables new BLS library from supranational. PruneEpochBoundaryStates bool // PruneEpochBoundaryStates prunes the epoch boundary state before last finalized check point. EnableSnappyDBCompression bool // EnableSnappyDBCompression in the database. SlasherProtection bool // SlasherProtection protects validator fron sending over a slashable offense over the network using external slasher. EnableNoise bool // EnableNoise enables the beacon node to use NOISE instead of SECIO when performing a handshake with another peer. WaitForSynced bool // WaitForSynced uses WaitForSynced in validator startup to ensure it can communicate with the beacon node as soon as possible. EnableEth1DataMajorityVote bool // EnableEth1DataMajorityVote uses the Voting With The Majority algorithm to vote for eth1data. EnablePeerScorer bool // EnablePeerScorer enables experimental peer scoring in p2p. EnablePruningDepositProofs bool // EnablePruningDepositProofs enables pruning deposit proofs which significantly reduces the size of a deposit EnableSyncBacktracking bool // EnableSyncBacktracking enables backtracking algorithm when searching for alternative forks during initial sync. // Logging related toggles. DisableGRPCConnectionLogs bool // Disables logging when a new grpc client has connected. // Slasher toggles. EnableHistoricalDetection bool // EnableHistoricalDetection disables historical attestation detection and performs detection on the chain head immediately. DisableLookback bool // DisableLookback updates slasher to not use the lookback and update validator histories until epoch 0. // Cache toggles. EnableSSZCache bool // EnableSSZCache see https://github.com/prysmaticlabs/prysm/pull/4558. EnableEth1DataVoteCache bool // EnableEth1DataVoteCache; see https://github.com/prysmaticlabs/prysm/issues/3106. EnableSlasherConnection bool // EnableSlasher enable retrieval of slashing events from a slasher instance. UseCheckPointInfoCache bool // UseCheckPointInfoCache uses check point info cache to efficiently verify attestation signatures. KafkaBootstrapServers string // KafkaBootstrapServers to find kafka servers to stream blocks, attestations, etc. AttestationAggregationStrategy string // AttestationAggregationStrategy defines aggregation strategy to be used when aggregating. }
Flags is a struct to represent which features the client will perform on runtime.