Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

config

package

Go to main page

Versions in this module

v0

v0.2.5-dev

Feb 14, 2024

v0.2.4

Feb 14, 2024

v0.2.4-dev

Feb 13, 2024

v0.2.4-cc-dev

Feb 19, 2024

v0.2.3

Feb 13, 2024

Changes in this version

+ const BeaconNodeDataVolume

+ const ClientTimeout

+ const ExecutionClientDataVolume

+ const ModulesName

+ const ValidatorsDirectory

+ func ApplyDefaults(cfg IConfigSection, network Network)

+ func ChangeNetwork(cfg IConfigSection, oldNetwork Network, newNetwork Network)

+ func Clone(source IConfigSection, target IConfigSection, network Network)

+ func Deserialize(cfg IConfigSection, serializedParams map[string]any, network Network) error

+ func GetAffectedContainers(section *ChangedSection, containers map[ContainerID]bool)

+ func Serialize(cfg IConfigSection) map[string]any

+ func UpdateDefaults(cfg IConfigSection, newNetwork Network)

+ type BeaconNode string

+ const BeaconNode_Lighthouse

+ const BeaconNode_Lodestar

+ const BeaconNode_Nimbus

+ const BeaconNode_Prysm

+ const BeaconNode_Teku

+ const BeaconNode_Unknown

+ type ChangedSection struct

+ Name string

+ Settings []*ChangedSetting

+ Subsections []*ChangedSection

+ func GetChangedSettings(old IConfigSection, new IConfigSection) (*ChangedSection, int)

+ type ChangedSetting struct

+ AffectedContainers []ContainerID

+ Name string

+ NewValue string

+ OldValue string

+ type ClientMode string

+ const ClientMode_External

+ const ClientMode_Local

+ const ClientMode_Unknown

+ type ContainerID string

+ const ContainerID_BeaconNode

+ const ContainerID_Daemon

+ const ContainerID_ExecutionClient

+ const ContainerID_Exporter

+ const ContainerID_Grafana

+ const ContainerID_MevBoost

+ const ContainerID_Prometheus

+ const ContainerID_Unknown

+ const ContainerID_ValidatorClients

+ type ExecutionClient string

+ const ExecutionClient_Besu

+ const ExecutionClient_Geth

+ const ExecutionClient_Nethermind

+ const ExecutionClient_Unknown

type HyperdriveConfig

+ func (c *HyperdriveConfig) BeaconNodeContainerName() string

+ func (c *HyperdriveConfig) BeaconNodeDataVolume() string

+ func (c *HyperdriveConfig) DaemonContainerName() string

+ func (c *HyperdriveConfig) ExecutionClientContainerName() string

+ func (c *HyperdriveConfig) ExecutionClientDataVolume() string

+ func (c *HyperdriveConfig) ExporterContainerName() string

+ func (c *HyperdriveConfig) GrafanaContainerName() string

+ func (c *HyperdriveConfig) PrometheusContainerName() string

+ func (cfg *HyperdriveConfig) AutoTxGasThresholdInt() uint64

+ func (cfg *HyperdriveConfig) GetSelectedBeaconNode() BeaconNode

+ func (cfg *HyperdriveConfig) GetSelectedExecutionClient() ExecutionClient

+ func (cfg *HyperdriveConfig) GraffitiPrefix() string

+ type IConfigSection interface

+ GetParameters func() []IParameter

+ GetSubconfigs func() map[string]IConfigSection

+ GetTitle func() string

+ type IModuleConfig interface

+ GetContainersToDeploy func() []ContainerID

+ GetModuleName func() string

+ GetValidatorContainerTagInfo func() map[ContainerID]string

+ IsDoppelgangerEnabled func() bool

+ IsEnabled func() bool

+ type IParameter interface

+ ChangeNetwork func(oldNetwork Network, newNetwork Network)

+ Deserialize func(serializedParam string, network Network) error

+ GetCommon func() *ParameterCommon

+ GetDefaultAsAny func(network Network) any

+ GetOptions func() []IParameterOption

+ GetValueAsAny func() any

+ SetToDefault func(network Network)

+ SetValue func(value any)

+ String func() string

+ type IParameterOption interface

+ Common func() *ParameterOptionCommon

+ GetValueAsAny func() any

+ String func() string

+ type Network string

+ const Network_All

+ const Network_Holesky

+ const Network_HoleskyDev

+ const Network_Mainnet

+ const Network_Unknown

+ type Parameter struct

+ Default map[Network]Type

+ Options []*ParameterOption[Type]

+ Value Type

+ func (p *Parameter[Type]) GetDefault(network Network) Type

+ func (p *Parameter[Type]) SetToDefault(network Network)

+ func (p *Parameter[Type]) SetValue(value any)

+ func (p *Parameter[_]) ChangeNetwork(oldNetwork Network, newNetwork Network)

+ func (p *Parameter[_]) Deserialize(serializedParam string, network Network) error

+ func (p *Parameter[_]) GetCommon() *ParameterCommon

+ func (p *Parameter[_]) GetDefaultAsAny(network Network) any

+ func (p *Parameter[_]) GetOptions() []IParameterOption

+ func (p *Parameter[_]) GetValueAsAny() any

+ func (p *Parameter[_]) String() string

+ type ParameterCommon struct

+ Advanced bool

+ AffectsContainers []ContainerID

+ CanBeBlank bool

+ Description string

+ DescriptionsByNetwork map[Network]string

+ EnvironmentVariables []string

+ ID string

+ MaxLength int

+ Name string

+ OverwriteOnUpgrade bool

+ Regex string

+ func (p *ParameterCommon) UpdateDescription(network Network)

+ type ParameterOption struct

+ Value Type

+ func (p *ParameterOption[_]) Common() *ParameterOptionCommon

+ func (p *ParameterOption[_]) GetValueAsAny() any

+ func (p *ParameterOption[_]) String() string

+ type ParameterOptionCommon struct

+ Description string

+ Name string

+ type RpcPortMode string

+ const RpcPortMode_Closed

+ const RpcPortMode_OpenExternal

+ const RpcPortMode_OpenLocalhost

+ func (m RpcPortMode) DockerPortMapping(port uint16) string

+ func (m RpcPortMode) IsOpen() bool

v0.2.3-dev

Feb 7, 2024

v0.2.2-dev

Feb 3, 2024

v0.2.1-dev

Feb 1, 2024

v0.2.0

Jan 31, 2024

Changes in this version

+ const AutoTxGasThresholdID

+ const AutoTxMaxFeeID

+ const BesuJvmHeapSizeID

+ const BesuMaxBackLayersID

+ const BesuMaxPeersID

+ const BitflyEndpointID

+ const BitflyMachineNameID

+ const BitflySecretID

+ const BnCheckpointSyncUrlID

+ const BnHttpUrl

+ const BnStartScript

+ const ClientModeID

+ const ConfigFilename

+ const DebugModeID

+ const DockerApiVersion

+ const EcEnginePortID

+ const EcHttpUrl

+ const EcOpenApiPortsID

+ const EcStartScript

+ const EcWebsocketPortID

+ const EventLogInterval

+ const ExporterEnableRootFsID

+ const GethEnablePbssID

+ const HyperdriveDaemonRoute

+ const HyperdriveSocketFilename

+ const LhQuicPortID

+ const MaxPriorityFeeID

+ const MetricsBnPortID

+ const MetricsDaemonPortID

+ const MetricsEcPortID

+ const MetricsEnableBitflyID

+ const MetricsEnableID

+ const MetricsExporterPortID

+ const NethermindAdditionalModulesID

+ const NethermindAdditionalUrlsID

+ const NethermindCacheSizeID

+ const NethermindPruneMemSizeID

+ const NetworkID

+ const NimbusPruningModeID

+ const ProjectNameID

+ const PrysmOpenRpcPortID

+ const PrysmRpcPortID

+ const PrysmRpcUrlID

+ const TekuArchiveModeID

+ const TekuJvmHeapSizeID

+ const UseFallbackClientsID

+ const UserAddressFilename

+ const UserDataPathID

+ const UserPasswordFilename

+ const UserWalletDataFilename

+ const VcStartScript

+ const WebsocketUrlID

+ type BesuConfig struct

+ AdditionalFlags types.Parameter[string]

+ ContainerTag types.Parameter[string]

+ JvmHeapSize types.Parameter[uint64]

+ MaxBackLayers types.Parameter[uint64]

+ MaxPeers types.Parameter[uint16]

+ func NewBesuConfig(parent *LocalExecutionConfig) *BesuConfig

+ func (cfg *BesuConfig) GetParameters() []types.IParameter

+ func (cfg *BesuConfig) GetSubconfigs() map[string]types.IConfigSection

+ func (cfg *BesuConfig) GetTitle() string

+ type BitflyNodeMetricsConfig struct

+ Endpoint types.Parameter[string]

+ MachineName types.Parameter[string]

+ Secret types.Parameter[string]

+ func NewBitflyNodeMetricsConfig(parent *MetricsConfig) *BitflyNodeMetricsConfig

+ func (cfg *BitflyNodeMetricsConfig) GetParameters() []types.IParameter

+ func (cfg *BitflyNodeMetricsConfig) GetSubconfigs() map[string]types.IConfigSection

+ func (cfg *BitflyNodeMetricsConfig) GetTitle() string

+ type ExporterConfig struct

+ AdditionalFlags types.Parameter[string]

+ ContainerTag types.Parameter[string]

+ RootFs types.Parameter[bool]

+ func NewExporterConfig(parent *MetricsConfig) *ExporterConfig

+ func (cfg *ExporterConfig) GetParameters() []types.IParameter

+ func (cfg *ExporterConfig) GetSubconfigs() map[string]types.IConfigSection

+ func (cfg *ExporterConfig) GetTitle() string

+ type ExternalBeaconConfig struct

+ BeaconNode types.Parameter[types.BeaconNode]

+ HttpUrl types.Parameter[string]

+ PrysmRpcUrl types.Parameter[string]

+ func NewExternalBeaconConfig(parent *HyperdriveConfig) *ExternalBeaconConfig

+ func (cfg *ExternalBeaconConfig) GetParameters() []types.IParameter

+ func (cfg *ExternalBeaconConfig) GetSubconfigs() map[string]types.IConfigSection

+ func (cfg *ExternalBeaconConfig) GetTitle() string

+ type ExternalExecutionConfig struct

+ ExecutionClient types.Parameter[types.ExecutionClient]

+ HttpUrl types.Parameter[string]

+ WebsocketUrl types.Parameter[string]

+ func NewExternalExecutionConfig(parent *HyperdriveConfig) *ExternalExecutionConfig

+ func (cfg *ExternalExecutionConfig) GetParameters() []types.IParameter

+ func (cfg *ExternalExecutionConfig) GetSubconfigs() map[string]types.IConfigSection

+ func (cfg *ExternalExecutionConfig) GetTitle() string

+ type FallbackConfig struct

+ BnHttpUrl types.Parameter[string]

+ EcHttpUrl types.Parameter[string]

+ PrysmRpcUrl types.Parameter[string]

+ UseFallbackClients types.Parameter[bool]

+ func NewFallbackConfig(parent *HyperdriveConfig) *FallbackConfig

+ func (cfg *FallbackConfig) GetParameters() []types.IParameter

+ func (cfg *FallbackConfig) GetSubconfigs() map[string]types.IConfigSection

+ func (cfg *FallbackConfig) GetTitle() string

+ type GethConfig struct

+ AdditionalFlags types.Parameter[string]

+ ContainerTag types.Parameter[string]

+ EnablePbss types.Parameter[bool]

+ MaxPeers types.Parameter[uint16]

+ func NewGethConfig(parent *LocalExecutionConfig) *GethConfig

+ func (cfg *GethConfig) GetParameters() []types.IParameter

+ func (cfg *GethConfig) GetSubconfigs() map[string]types.IConfigSection

+ func (cfg *GethConfig) GetTitle() string

+ type GrafanaConfig struct

+ ContainerTag types.Parameter[string]

+ Port types.Parameter[uint16]

+ func NewGrafanaConfig(parent *MetricsConfig) *GrafanaConfig

+ func (cfg *GrafanaConfig) GetParameters() []types.IParameter

+ func (cfg *GrafanaConfig) GetSubconfigs() map[string]types.IConfigSection

+ func (cfg *GrafanaConfig) GetTitle() string

+ type HyperdriveConfig struct

+ AutoTxGasThreshold types.Parameter[float64]

+ AutoTxMaxFee types.Parameter[float64]

+ ClientMode types.Parameter[types.ClientMode]

+ DebugMode types.Parameter[bool]

+ ExternalBeaconConfig *ExternalBeaconConfig

+ ExternalExecutionConfig *ExternalExecutionConfig

+ Fallback *FallbackConfig

+ HyperdriveUserDirectory string

+ LocalBeaconConfig *LocalBeaconConfig

+ LocalExecutionConfig *LocalExecutionConfig

+ MaxPriorityFee types.Parameter[float64]

+ Metrics *MetricsConfig

+ Modules *modconfig.ModulesConfig

+ Network types.Parameter[types.Network]

+ ProjectName types.Parameter[string]

+ UserDataPath types.Parameter[string]

+ Version string

+ func LoadFromFile(path string) (*HyperdriveConfig, error)

+ func NewHyperdriveConfig(hdDir string) *HyperdriveConfig

+ func (cfg *HyperdriveConfig) AutoTxMaxFeeInt() uint64

+ func (cfg *HyperdriveConfig) BnHttpUrl() (string, error)

+ func (cfg *HyperdriveConfig) BnRpcUrl() (string, error)

+ func (cfg *HyperdriveConfig) ChangeNetwork(newNetwork types.Network)

+ func (cfg *HyperdriveConfig) CreateCopy() *HyperdriveConfig

+ func (cfg *HyperdriveConfig) Deserialize(masterMap map[string]any) error

+ func (cfg *HyperdriveConfig) FallbackBnHttpUrl() string

+ func (cfg *HyperdriveConfig) FallbackBnRpcUrl() string

+ func (cfg *HyperdriveConfig) GetBeaconHostname() (string, error)

+ func (cfg *HyperdriveConfig) GetBnAdditionalFlags() (string, error)

+ func (cfg *HyperdriveConfig) GetBnContainerTag() (string, error)

+ func (cfg *HyperdriveConfig) GetBnHttpEndpoint() string

+ func (cfg *HyperdriveConfig) GetBnHttpEndpointsWithFallback() string

+ func (cfg *HyperdriveConfig) GetBnMaxPeers() (uint16, error)

+ func (cfg *HyperdriveConfig) GetBnOpenPorts() []string

+ func (cfg *HyperdriveConfig) GetBnStartScript() string

+ func (cfg *HyperdriveConfig) GetChanges(oldConfig *HyperdriveConfig) (*types.ChangedSection, map[types.ContainerID]bool, bool)

+ func (cfg *HyperdriveConfig) GetDaemonContainerTag() string

+ func (cfg *HyperdriveConfig) GetDockerArtifactName(entity string) string

+ func (cfg *HyperdriveConfig) GetEcAdditionalFlags() (string, error)

+ func (cfg *HyperdriveConfig) GetEcContainerTag() (string, error)

+ func (cfg *HyperdriveConfig) GetEcHttpEndpoint() string

+ func (cfg *HyperdriveConfig) GetEcHttpEndpointsWithFallback() string

+ func (cfg *HyperdriveConfig) GetEcMaxPeers() (uint16, error)

+ func (cfg *HyperdriveConfig) GetEcOpenApiPorts() string

+ func (cfg *HyperdriveConfig) GetEcStartScript() string

+ func (cfg *HyperdriveConfig) GetEcWsEndpoint() string

+ func (cfg *HyperdriveConfig) GetExecutionHostname() (string, error)

+ func (cfg *HyperdriveConfig) GetExporterAdditionalFlags() []string

+ func (cfg *HyperdriveConfig) GetExternalIP() string

+ func (cfg *HyperdriveConfig) GetParameters() []types.IParameter

+ func (cfg *HyperdriveConfig) GetPrometheusAdditionalFlags() []string

+ func (cfg *HyperdriveConfig) GetPrometheusOpenPorts() string

+ func (cfg *HyperdriveConfig) GetStakewiseVcAdditionalFlags() string

+ func (cfg *HyperdriveConfig) GetStakewiseVcContainerTag() string

+ func (cfg *HyperdriveConfig) GetSubconfigs() map[string]types.IConfigSection

+ func (cfg *HyperdriveConfig) GetTitle() string

+ func (cfg *HyperdriveConfig) GetVcStartScript() string

+ func (cfg *HyperdriveConfig) IsDoppelgangerEnabled() bool

+ func (cfg *HyperdriveConfig) IsLocalMode() bool

+ func (cfg *HyperdriveConfig) Serialize() map[string]any

+ func (cfg *HyperdriveConfig) StakewiseFeeRecipient() string

+ func (cfg *HyperdriveConfig) StakewiseGraffiti() (string, error)

+ func (cfg *HyperdriveConfig) StakewiseVault() string

+ func (cfg *HyperdriveConfig) UpdateDefaults()

+ func (cfg *HyperdriveConfig) Validate() []string

+ type LighthouseBnConfig struct

+ AdditionalFlags types.Parameter[string]

+ ContainerTag types.Parameter[string]

+ MaxPeers types.Parameter[uint16]

+ P2pQuicPort types.Parameter[uint16]

+ func NewLighthouseBnConfig(parent *LocalBeaconConfig) *LighthouseBnConfig

+ func (cfg *LighthouseBnConfig) GetParameters() []types.IParameter

+ func (cfg *LighthouseBnConfig) GetSubconfigs() map[string]types.IConfigSection

+ func (cfg *LighthouseBnConfig) GetTitle() string

+ type LocalBeaconConfig struct

+ BeaconNode types.Parameter[types.BeaconNode]

+ CheckpointSyncProvider types.Parameter[string]

+ HttpPort types.Parameter[uint16]

+ Lighthouse *LighthouseBnConfig

+ Lodestar *LodestarBnConfig

+ Nimbus *NimbusBnConfig

+ OpenHttpPort types.Parameter[types.RpcPortMode]

+ P2pPort types.Parameter[uint16]

+ Prysm *PrysmBnConfig

+ Teku *TekuBnConfig

+ func NewLocalBeaconConfig(parent *HyperdriveConfig) *LocalBeaconConfig

+ func (cfg *LocalBeaconConfig) GetParameters() []types.IParameter

+ func (cfg *LocalBeaconConfig) GetSubconfigs() map[string]types.IConfigSection

+ func (cfg *LocalBeaconConfig) GetTitle() string

+ type LocalExecutionConfig struct

+ Besu *BesuConfig

+ EnginePort types.Parameter[uint16]

+ ExecutionClient types.Parameter[types.ExecutionClient]

+ Geth *GethConfig

+ HttpPort types.Parameter[uint16]

+ Nethermind *NethermindConfig

+ OpenApiPorts types.Parameter[types.RpcPortMode]

+ P2pPort types.Parameter[uint16]

+ WebsocketPort types.Parameter[uint16]

+ func NewExecutionCommonConfig(parent *HyperdriveConfig) *LocalExecutionConfig

+ func (cfg *LocalExecutionConfig) GetParameters() []types.IParameter

+ func (cfg *LocalExecutionConfig) GetSubconfigs() map[string]types.IConfigSection

+ func (cfg *LocalExecutionConfig) GetTitle() string

+ type LodestarBnConfig struct

+ AdditionalFlags types.Parameter[string]

+ ContainerTag types.Parameter[string]

+ MaxPeers types.Parameter[uint16]

+ func NewLodestarBnConfig(parent *LocalBeaconConfig) *LodestarBnConfig

+ func (cfg *LodestarBnConfig) GetParameters() []types.IParameter

+ func (cfg *LodestarBnConfig) GetSubconfigs() map[string]types.IConfigSection

+ func (cfg *LodestarBnConfig) GetTitle() string

+ type MetricsConfig struct

+ BitflyNodeMetrics *BitflyNodeMetricsConfig

+ BnMetricsPort types.Parameter[uint16]

+ DaemonMetricsPort types.Parameter[uint16]

+ EcMetricsPort types.Parameter[uint16]

+ EnableBitflyNodeMetrics types.Parameter[bool]

+ EnableMetrics types.Parameter[bool]

+ Exporter *ExporterConfig

+ ExporterMetricsPort types.Parameter[uint16]

+ Grafana *GrafanaConfig

+ Prometheus *PrometheusConfig

+ func NewMetricsConfig(parent *HyperdriveConfig) *MetricsConfig

+ func (cfg *MetricsConfig) GetParameters() []types.IParameter

+ func (cfg *MetricsConfig) GetSubconfigs() map[string]types.IConfigSection

+ func (cfg *MetricsConfig) GetTitle() string

+ type NethermindConfig struct

+ AdditionalFlags types.Parameter[string]

+ AdditionalModules types.Parameter[string]

+ AdditionalUrls types.Parameter[string]

+ CacheSize types.Parameter[uint64]

+ ContainerTag types.Parameter[string]

+ MaxPeers types.Parameter[uint16]

+ PruneMemSize types.Parameter[uint64]

+ func NewNethermindConfig(parent *LocalExecutionConfig) *NethermindConfig

+ func (cfg *NethermindConfig) GetParameters() []types.IParameter

+ func (cfg *NethermindConfig) GetSubconfigs() map[string]types.IConfigSection

+ func (cfg *NethermindConfig) GetTitle() string

+ type NimbusBnConfig struct

+ AdditionalFlags types.Parameter[string]

+ ContainerTag types.Parameter[string]

+ MaxPeers types.Parameter[uint16]

+ PruningMode types.Parameter[Nimbus_PruningMode]

+ func NewNimbusBnConfig(parent *LocalBeaconConfig) *NimbusBnConfig

+ func (cfg *NimbusBnConfig) GetParameters() []types.IParameter

+ func (cfg *NimbusBnConfig) GetSubconfigs() map[string]types.IConfigSection

+ func (cfg *NimbusBnConfig) GetTitle() string

+ type Nimbus_PruningMode string

+ const Nimbus_PruningMode_Archive

+ const Nimbus_PruningMode_Pruned

+ type PrometheusConfig struct

+ AdditionalFlags types.Parameter[string]

+ ContainerTag types.Parameter[string]

+ OpenPort types.Parameter[types.RpcPortMode]

+ Port types.Parameter[uint16]

+ func NewPrometheusConfig(parent *MetricsConfig) *PrometheusConfig

+ func (cfg *PrometheusConfig) GetParameters() []types.IParameter

+ func (cfg *PrometheusConfig) GetSubconfigs() map[string]types.IConfigSection

+ func (cfg *PrometheusConfig) GetTitle() string

+ type PrysmBnConfig struct

+ AdditionalFlags types.Parameter[string]

+ ContainerTag types.Parameter[string]

+ MaxPeers types.Parameter[uint16]

+ OpenRpcPort types.Parameter[types.RpcPortMode]

+ RpcPort types.Parameter[uint16]

+ func NewPrysmBnConfig(parent *LocalBeaconConfig) *PrysmBnConfig

+ func (cfg *PrysmBnConfig) GetParameters() []types.IParameter

+ func (cfg *PrysmBnConfig) GetSubconfigs() map[string]types.IConfigSection

+ func (cfg *PrysmBnConfig) GetTitle() string

+ type TekuBnConfig struct

+ AdditionalFlags types.Parameter[string]

+ ArchiveMode types.Parameter[bool]

+ ContainerTag types.Parameter[string]

+ JvmHeapSize types.Parameter[uint64]

+ MaxPeers types.Parameter[uint16]

+ func NewTekuBnConfig(parent *LocalBeaconConfig) *TekuBnConfig

+ func (cfg *TekuBnConfig) GetParameters() []types.IParameter

+ func (cfg *TekuBnConfig) GetSubconfigs() map[string]types.IConfigSection

+ func (cfg *TekuBnConfig) GetTitle() string

v0.1.0-a1

Jan 28, 2024

v0.0.2-dev

Dec 18, 2023