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 ( // AltonaTestnet flag for the multiclient eth2 testnet configuration. AltonaTestnet = &cli.BoolFlag{ Name: "altona", Usage: "This defines the flag through which we can run on the Altona Multiclient Testnet", } // OnyxTestnet flag for the Prysmatic Labs single-client testnet configuration. OnyxTestnet = &cli.BoolFlag{ Name: "onyx", Usage: "This defines the flag through which we can run on the Onyx Prysm Testnet", } )
var BeaconChainFlags = append(deprecatedFlags, []cli.Flag{ devModeFlag, writeSSZStateTransitionsFlag, disableForkChoiceUnsafeFlag, disableDynamicCommitteeSubnets, disableSSZCache, disableInitSyncVerifyEverythingFlag, skipBLSVerifyFlag, kafkaBootstrapServersFlag, enableBackupWebhookFlag, enableSlasherFlag, cacheFilteredBlockTreeFlag, disableStrictAttestationPubsubVerificationFlag, disableUpdateHeadPerAttestation, enableStateGenSigVerify, checkHeadState, disableNoiseHandshake, dontPruneStateStartUp, disableBroadcastSlashingFlag, waitForSyncedFlag, disableNewStateMgmt, disableReduceAttesterStateCopy, disableGRPCConnectionLogging, attestationAggregationStrategy, disableNewBeaconStateLocks, AltonaTestnet, OnyxTestnet, batchBlockVerify, initSyncVerbose, enableFinalizedDepositsCache, enableEth1DataMajorityVote, enableAttBroadcastDiscoveryAttempts, enablePeerScorer, enableRoughtime, checkPtInfoCache, }...)
BeaconChainFlags contains a list of all the feature flags that apply to the beacon-chain client.
var E2EBeaconChainFlags = []string{
"--cache-filtered-block-tree",
"--enable-state-gen-sig-verify",
"--check-head-state",
"--attestation-aggregation-strategy=max_cover",
"--dev",
"--enable-finalized-deposits-cache",
"--enable-eth1-data-majority-vote",
"--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,
}...)
SlasherFlags contains a list of all the feature flags that apply to the slasher client.
var ValidatorFlags = append(deprecatedFlags, []cli.Flag{ enableLocalProtectionFlag, enableExternalSlasherProtectionFlag, disableDomainDataCacheFlag, waitForSyncedFlag, AltonaTestnet, OnyxTestnet, disableAccountsV2, }...)
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 { // State locks NewBeaconStateLocks bool // NewStateLocks for updated beacon state locking. // Testnet Flags. AltonaTestnet bool // AltonaTestnet defines the flag through which we can enable the node to run on the altona testnet. OnyxTestnet bool // OnyxTestnet defines the flag through which we can enable the node to run on the onyx testnet. // Feature related flags. WriteSSZStateTransitions bool // WriteSSZStateTransitions to tmp directory. InitSyncNoVerify bool // InitSyncNoVerify when initial syncing w/o verifying block's contents. DisableDynamicCommitteeSubnets bool // Disables dynamic attestation committee subnets via p2p. SkipBLSVerify bool // Skips BLS verification across the runtime. EnableBackupWebhook bool // EnableBackupWebhook to allow database backups to trigger from monitoring port /db/backup. PruneEpochBoundaryStates bool // PruneEpochBoundaryStates prunes the epoch boundary state before last finalized check point. EnableSnappyDBCompression bool // EnableSnappyDBCompression in the database. LocalProtection bool // LocalProtection prevents the validator client from signing any messages that would be considered a slashable offense from the validators view. SlasherProtection bool // SlasherProtection protects validator fron sending over a slashable offense over the network using external slasher. DisableStrictAttestationPubsubVerification bool // DisableStrictAttestationPubsubVerification will disabling strict signature verification in pubsub. DisableUpdateHeadPerAttestation bool // DisableUpdateHeadPerAttestation will disabling update head on per attestation basis. EnableDomainDataCache bool // EnableDomainDataCache caches validator calls to DomainData per epoch. EnableStateGenSigVerify bool // EnableStateGenSigVerify verifies proposer and randao signatures during state gen. CheckHeadState bool // CheckHeadState checks the current headstate before retrieving the desired state from the db. EnableNoise bool // EnableNoise enables the beacon node to use NOISE instead of SECIO when performing a handshake with another peer. DontPruneStateStartUp bool // DontPruneStateStartUp disables pruning state upon beacon node start up. NewStateMgmt bool // NewStateMgmt enables the new state mgmt service. WaitForSynced bool // WaitForSynced uses WaitForSynced in validator startup to ensure it can communicate with the beacon node as soon as possible. ReduceAttesterStateCopy bool // ReduceAttesterStateCopy reduces head state copies for attester rpc. EnableAccountsV2 bool // EnableAccountsV2 for Prysm validator clients. BatchBlockVerify bool // BatchBlockVerify performs batched verification of block batches that we receive when syncing. InitSyncVerbose bool // InitSyncVerbose logs every processed block during initial syncing. EnableFinalizedDepositsCache bool // EnableFinalizedDepositsCache enables utilization of cached finalized deposits. EnableEth1DataMajorityVote bool // EnableEth1DataMajorityVote uses the Voting With The Majority algorithm to vote for eth1data. EnableAttBroadcastDiscoveryAttempts bool // EnableAttBroadcastDiscoveryAttempts allows the p2p service to attempt to ensure a subnet peer is present before broadcasting an attestation. EnablePeerScorer bool // EnablePeerScorer enables experimental peer scoring in p2p. EnableRoughtime bool // EnableRoughtime is an opt-in flag for enabling hourly syncing with roughtime. Default is to not sync. // DisableForkChoice disables using LMD-GHOST fork choice to update // the head of the chain based on attestations and instead accepts any valid received block // as the chain head. UNSAFE, use with caution. DisableForkChoice bool // Logging related toggles. DisableGRPCConnectionLogs bool // Disables logging when a new grpc client has connected. // Slasher toggles. DisableBroadcastSlashings bool // DisableBroadcastSlashings disables p2p broadcasting of proposer and attester slashings. 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. EnableBlockTreeCache bool // EnableBlockTreeCache enable fork choice service to maintain latest filtered block tree. 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.