Documentation
¶
Overview ¶
Package features 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.
Code generated by hack/gen-logs.sh; DO NOT EDIT. This file is created and regenerated automatically. Anything added here might get removed.
Index ¶
- Variables
- func ActiveFlags(flags []cli.Flag) []cli.Flag
- func BlacklistedBlock(r [32]byte) bool
- func ConfigureBeaconChain(ctx *cli.Context) error
- func ConfigureValidator(ctx *cli.Context) error
- func Init(c *Flags)
- func InitWithReset(c *Flags) func()
- func ValidateNetworkFlags(ctx *cli.Context) error
- type Flags
Constants ¶
This section is empty.
Variables ¶
var ( // SepoliaTestnet flag for the multiclient Ethereum consensus testnet. SepoliaTestnet = &cli.BoolFlag{ Name: "sepolia", Usage: "Runs Prysm configured for the Sepolia test network.", } // HoleskyTestnet flag for the multiclient Ethereum consensus testnet. HoleskyTestnet = &cli.BoolFlag{ Name: "holesky", Usage: "Runs Prysm configured for the Holesky test network.", } // HoodiTestnet flag for ethereum testnet. HoodiTestnet = &cli.BoolFlag{ Name: "hoodi", Usage: "Runs Prysm configured for the Hoodi test network.", } // Mainnet flag for easier tooling, no-op Mainnet = &cli.BoolFlag{ Value: true, Name: "mainnet", Usage: "Runs on Ethereum main network. This is the default and can be omitted.", } EnableMinimalSlashingProtection = &cli.BoolFlag{ Name: "enable-minimal-slashing-protection", Usage: "(Experimental): Enables the minimal slashing protection. See EIP-3076 for more details.", } SaveFullExecutionPayloads = &cli.BoolFlag{ Name: "save-full-execution-payloads", Usage: "Saves beacon blocks with full execution payloads instead of execution payload headers in the database.", } EnableBeaconRESTApi = &cli.BoolFlag{ Name: "enable-beacon-rest-api", Usage: "(Experimental): Enables of the beacon REST API when querying a beacon node.", } EnableLightClient = &cli.BoolFlag{ Name: "enable-light-client", Usage: "Enables the light client support in the beacon node", } // DisableRegistrationCache a flag for disabling the validator registration cache and use db instead. DisableRegistrationCache = &cli.BoolFlag{ Name: "disable-registration-cache", Usage: "Temporary flag for disabling the validator registration cache instead of using the DB. Note: registrations do not clear on restart while using the DB.", } // BlobSaveFsync enforces durable filesystem writes for use cases where blob availability is critical. BlobSaveFsync = &cli.BoolFlag{ Name: "blob-save-fsync", Usage: "Forces new blob files to be fysnc'd before continuing, ensuring durable blob writes.", } // DisableQUIC disables connecting to peers using the QUIC protocol. DisableQUIC = &cli.BoolFlag{ Name: "disable-quic", Usage: "Disables connecting using the QUIC protocol with peers.", } EnableDiscoveryReboot = &cli.BoolFlag{ Name: "enable-discovery-reboot", Usage: "Experimental: Enables the discovery listener to rebooted in the event of connectivity issues.", } EnableStateDiff = &cli.BoolFlag{ Name: "enable-state-diff", Usage: "Enables the experimental state diff feature.", } // DisableDutiesV2 sets the validator client to use the get duties grpc endpoint DisableDutiesV2 = &cli.BoolFlag{ Name: "disable-duties-v2", Usage: "Forces use of get duties endpoint instead of v2.", } // EnableWebFlag enables controlling the validator client via the Prysm web ui. This is a work in progress. EnableWebFlag = &cli.BoolFlag{ Name: "web", Usage: "(Work in progress): Enables the web portal for the validator client.", Value: false, } )
var BeaconChainFlags = combinedFlags([]cli.Flag{ devModeFlag, writeSSZStateTransitionsFlag, saveInvalidBlockTempFlag, saveInvalidBlobTempFlag, disableGRPCConnectionLogging, HoleskyTestnet, SepoliaTestnet, HoodiTestnet, Mainnet, disablePeerScorer, disableBroadcastSlashingFlag, disableStakinContractCheck, SaveFullExecutionPayloads, enableStartupOptimistic, ignoreUnviableAttestations, enableFullSSZDataLogging, disableVerboseSigVerification, enableProposerPreprocessing, prepareAllPayloads, aggregateFirstInterval, aggregateSecondInterval, aggregateThirdInterval, disableResourceManager, DisableRegistrationCache, EnableLightClient, BlobSaveFsync, DisableQUIC, EnableDiscoveryReboot, enableExperimentalAttestationPool, EnableStateDiff, forceHeadFlag, blacklistRoots, enableHashtree, }, deprecatedBeaconFlags, deprecatedFlags, upcomingDeprecation)
BeaconChainFlags contains a list of all the feature flags that apply to the beacon-chain client.
var E2EBeaconChainFlags = []string{
"--dev",
}
E2EBeaconChainFlags contains a list of the beacon chain feature flags to be tested in E2E.
var E2EValidatorFlags = []string{
"--enable-doppelganger",
}
E2EValidatorFlags contains a list of the validator feature flags to be tested in E2E.
var NetworkFlags = []cli.Flag{ Mainnet, SepoliaTestnet, HoleskyTestnet, HoodiTestnet, }
NetworkFlags contains a list of network flags.
var ValidatorFlags = append(deprecatedFlags, []cli.Flag{ writeWalletPasswordOnWebOnboarding, HoleskyTestnet, SepoliaTestnet, HoodiTestnet, Mainnet, dynamicKeyReloadDebounceInterval, disableAttestTimely, enableSlashingProtectionPruning, EnableMinimalSlashingProtection, enableDoppelGangerProtection, EnableBeaconRESTApi, DisableDutiesV2, EnableWebFlag, }...)
ValidatorFlags contains a list of all the feature flags that apply to the validator client.
Functions ¶
func ActiveFlags ¶
ActiveFlags returns all of the flags that are not Hidden.
func BlacklistedBlock ¶
BlacklistedBlock returns weather the given block root belongs to the list of blacklisted roots.
func ConfigureBeaconChain ¶
ConfigureBeaconChain sets the global config based on what flags are enabled for the beacon-chain 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.
func ValidateNetworkFlags ¶
ValidateNetworkFlags validates provided flags and prevents beacon node or validator to start if more than one network flag is provided
Types ¶
type Flags ¶
type Flags struct {
// Feature related flags.
WriteSSZStateTransitions bool // WriteSSZStateTransitions to tmp directory.
EnablePeerScorer bool // EnablePeerScorer enables experimental peer scoring in p2p.
EnableLightClient bool // EnableLightClient enables light client APIs.
EnableQUIC bool // EnableQUIC specifies whether to enable QUIC transport for libp2p.
WriteWalletPasswordOnWebOnboarding bool // WriteWalletPasswordOnWebOnboarding writes the password to disk after Prysm web signup.
EnableDoppelGanger bool // EnableDoppelGanger enables doppelganger protection on startup for the validator.
EnableHistoricalSpaceRepresentation bool // EnableHistoricalSpaceRepresentation enables the saving of registry validators in separate buckets to save space
EnableBeaconRESTApi bool // EnableBeaconRESTApi enables experimental usage of the beacon REST API by the validator when querying a beacon node
EnableExperimentalAttestationPool bool // EnableExperimentalAttestationPool enables an experimental attestation pool design.
DisableDutiesV2 bool // DisableDutiesV2 sets validator client to use the get Duties endpoint
EnableWeb bool // EnableWeb enables the webui on the validator client
EnableStateDiff bool // EnableStateDiff enables the experimental state diff feature for the beacon node.
// Logging related toggles.
DisableGRPCConnectionLogs bool // Disables logging when a new grpc client has connected.
EnableFullSSZDataLogging bool // Enables logging for full ssz data on rejected gossip messages
// Slasher toggles.
DisableBroadcastSlashings bool // DisableBroadcastSlashings disables p2p broadcasting of proposer and attester slashings.
// Bug fixes related flags.
AttestTimely bool // AttestTimely fixes #8185. It is gated behind a flag to ensure beacon node's fix can safely roll out first. We'll invert this in v1.1.0.
EnableSlashingProtectionPruning bool // Enable slashing protection pruning for the validator client.
EnableMinimalSlashingProtection bool // Enable minimal slashing protection database for the validator client.
SaveFullExecutionPayloads bool // Save full beacon blocks with execution payloads in the database.
EnableStartOptimistic bool // EnableStartOptimistic treats every block as optimistic at startup.
DisableResourceManager bool // Disables running the node with libp2p's resource manager.
DisableStakinContractCheck bool // Disables check for deposit contract when proposing blocks
IgnoreUnviableAttestations bool // Ignore attestations whose target state is not viable (avoids lagging-node DoS).
EnableHashtree bool // Enables usage of the hashtree library for hashing
EnableVerboseSigVerification bool // EnableVerboseSigVerification specifies whether to verify individual signature if batch verification fails
EnableProposerPreprocessing bool // EnableProposerPreprocessing enables proposer pre-processing of blocks before proposing.
PrepareAllPayloads bool // PrepareAllPayloads informs the engine to prepare a block on every slot.
// BlobSaveFsync requires blob saving to block on fsync to ensure blobs are durably persisted before passing DA.
BlobSaveFsync bool
SaveInvalidBlock bool // SaveInvalidBlock saves invalid block to temp.
SaveInvalidBlob bool // SaveInvalidBlob saves invalid blob to temp.
EnableDiscoveryReboot bool // EnableDiscoveryReboot allows the node to have its local listener to be rebooted in the event of discovery issues.
// KeystoreImportDebounceInterval specifies the time duration the validator waits to reload new keys if they have
// changed on disk. This feature is for advanced use cases only.
KeystoreImportDebounceInterval time.Duration
// AggregateIntervals specifies the time durations at which we aggregate attestations preparing for forkchoice.
AggregateIntervals [3]time.Duration
// Feature related flags (alignment forced in the end)
ForceHead string // ForceHead forces the head block to be a specific block root, the last head block, or the last finalized block.
BlacklistedRoots map[[32]byte]struct{} // BlacklistedRoots is a list of roots that are blacklisted from processing.
}
Flags is a struct to represent which features the client will perform on runtime.