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 BeaconChainFlags = append(deprecatedFlags, []cli.Flag{
devModeFlag,
customGenesisDelayFlag,
minimalConfigFlag,
e2eConfigFlag,
writeSSZStateTransitionsFlag,
disableForkChoiceUnsafeFlag,
disableDynamicCommitteeSubnets,
disableSSZCache,
initSyncVerifyEverythingFlag,
skipBLSVerifyFlag,
kafkaBootstrapServersFlag,
enableBackupWebhookFlag,
enableSlasherFlag,
cacheFilteredBlockTreeFlag,
disableStrictAttestationPubsubVerificationFlag,
disableUpdateHeadPerAttestation,
enableStateGenSigVerify,
checkHeadState,
enableNoiseHandshake,
dontPruneStateStartUp,
disableBroadcastSlashingFlag,
enableNewStateMgmt,
disableInitSyncBatchSaveBlocks,
waitForSyncedFlag,
skipRegenHistoricalStates,
enableInitSyncWeightedRoundRobin,
disableFieldTrie,
disableStateRefCopy,
reduceAttesterStateCopy,
}...)
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",
"--enable-new-state-mgmt",
"--enable-init-sync-wrr",
"--reduce-attester-state-copy",
}
E2EBeaconChainFlags contains a list of the beacon chain feature flags to be tested in E2E.
var E2EValidatorFlags = []string{
"--wait-for-synced",
"--enable-protect-attester",
"--enable-protect-proposer",
}
E2EValidatorFlags contains a list of the validator feature flags to be tested in E2E.
var SlasherFlags = append(deprecatedFlags, []cli.Flag{
e2eConfigFlag,
enableHistoricalDetectionFlag,
disableLookbackFlag,
}...)
SlasherFlags contains a list of all the feature flags that apply to the slasher client.
var ValidatorFlags = append(deprecatedFlags, []cli.Flag{
minimalConfigFlag,
e2eConfigFlag,
enableProtectAttesterFlag,
enableProtectProposerFlag,
enableExternalSlasherProtectionFlag,
disableDomainDataCacheFlag,
waitForSyncedFlag,
}...)
ValidatorFlags contains a list of all the feature flags that apply to the validator client.
Functions ¶
func ActiveFlags ¶ added in v0.3.7
ActiveFlags returns all of the flags that are not Hidden.
func ConfigureBeaconChain ¶
ConfigureBeaconChain sets the global config based on what flags are enabled for the beacon-chain client.
func ConfigureSlasher ¶
ConfigureSlasher sets the global config based on what flags are enabled for the slasher client.
func ConfigureValidator ¶
ConfigureValidator sets the global config based on what flags are enabled for the validator client.
func InitWithReset ¶
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 {
// Configuration related flags.
MinimalConfig bool // MinimalConfig as defined in the spec.
E2EConfig bool //E2EConfig made specifically for testing, do not use except in E2E.
// 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.
ProtectProposer bool // ProtectProposer prevents the validator client from signing any proposals that would be considered a slashable offense.
ProtectAttester bool // ProtectAttester prevents the validator client from signing any attestations that would be considered a slashable offense.
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.
EnableFieldTrie bool // EnableFieldTrie enables the state from using field specific tries when computing the root.
NoInitSyncBatchSaveBlocks bool // NoInitSyncBatchSaveBlocks disables batch save blocks mode during initial syncing.
EnableStateRefCopy bool // EnableStateRefCopy copies the references to objects instead of the objects themselves when copying state fields.
WaitForSynced bool // WaitForSynced uses WaitForSynced in validator startup to ensure it can communicate with the beacon node as soon as possible.
SkipRegenHistoricalStates bool // SkipRegenHistoricalState skips regenerating historical states from genesis to last finalized. This enables a quick switch over to using new-state-mgmt.
EnableInitSyncWeightedRoundRobin bool // EnableInitSyncWeightedRoundRobin enables weighted round robin fetching optimization in initial syncing.
ReduceAttesterStateCopy bool // ReduceAttesterStateCopy reduces head state copies for attester rpc.
// 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
// 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.
KafkaBootstrapServers string // KafkaBootstrapServers to find kafka servers to stream blocks, attestations, etc.
CustomGenesisDelay uint64 // CustomGenesisDelay signals how long of a delay to set to start the chain.
}
Flags is a struct to represent which features the client will perform on runtime.