swconfig

Documentation

Index

• Constants
• type StakewiseConfig
  • func NewStakewiseConfig(hdCfg *config.HyperdriveConfig) *StakewiseConfig
  • func (c *StakewiseConfig) DaemonContainerName() string
  • func (cfg *StakewiseConfig) DaemonTag() string
  • func (c *StakewiseConfig) DepositDataFile() string
  • func (cfg *StakewiseConfig) FeeRecipient() string
  • func (cfg *StakewiseConfig) GetContainersToDeploy() []config.ContainerID
  • func (cfg *StakewiseConfig) GetModuleName() string
  • func (cfg *StakewiseConfig) GetParameters() []config.IParameter
  • func (cfg *StakewiseConfig) GetSubconfigs() map[string]config.IConfigSection
  • func (cfg *StakewiseConfig) GetTitle() string
  • func (cfg *StakewiseConfig) GetValidatorContainerTagInfo() map[config.ContainerID]string
  • func (cfg *StakewiseConfig) GetVcAdditionalFlags() string
  • func (cfg *StakewiseConfig) GetVcContainerTag() string
  • func (cfg *StakewiseConfig) Graffiti() (string, error)
  • func (cfg *StakewiseConfig) IsDoppelgangerEnabled() bool
  • func (cfg *StakewiseConfig) IsEnabled() bool
  • func (c *StakewiseConfig) KeystorePasswordFile() string
  • func (cfg *StakewiseConfig) Network() string
  • func (c *StakewiseConfig) OperatorContainerName() string
  • func (c *StakewiseConfig) PasswordFilename() string
  • func (cfg *StakewiseConfig) Vault() string
  • func (c *StakewiseConfig) VcContainerName() string
  • func (c *StakewiseConfig) WalletFilename() string

Constants

const (
	ModuleName           string = "stakewise"
	SocketFilename       string = ModuleName + ".sock"
	WalletFilename       string = "wallet.json"
	PasswordFilename     string = "password.txt"
	KeystorePasswordFile string = "secret.txt"
	DepositDataFile      string = "deposit-data.json"
)

const (
	// Param IDs
	StakewiseEnableID      string = "enable"
	OperatorContainerTagID string = "operatorContainerTag"
	AdditionalOpFlagsID    string = "additionalOpFlags"
	VerifyDepositRootsID   string = "verifyDepositRoots"
)

const (
	// The stakewise Hyperdrive daemon
	ContainerID_StakewiseDaemon config.ContainerID = "sw_daemon"

	// The stakewise operator container
	ContainerID_StakewiseOperator config.ContainerID = "sw_operator"

	// The stakewise Validator client
	ContainerID_StakewiseValidator config.ContainerID = "sw_vc"
)

Types

type StakewiseConfig

type StakewiseConfig struct {

	// Toggle for enabling access to the root filesystem (for multiple disk usage metrics)
	Enabled config.Parameter[bool]

	// Toggle for verifying deposit data Merkle roots before saving
	VerifyDepositsRoot config.Parameter[bool]

	// The Docker Hub tag for the Stakewise operator
	OperatorContainerTag config.Parameter[string]

	// Custom command line flags
	AdditionalOpFlags config.Parameter[string]

	// Validator client configs
	VcCommon   *validator.ValidatorClientCommonConfig
	Lighthouse *validator.LighthouseVcConfig
	Lodestar   *validator.LodestarVcConfig
	Nimbus     *validator.NimbusVcConfig
	Prysm      *validator.PrysmVcConfig
	Teku       *validator.TekuVcConfig
	// contains filtered or unexported fields
}

Configuration for Stakewise

func NewStakewiseConfig

func NewStakewiseConfig(hdCfg *config.HyperdriveConfig) *StakewiseConfig

Generates a new Stakewise config

func (*StakewiseConfig) DaemonContainerName

func (c *StakewiseConfig) DaemonContainerName() string

func (*StakewiseConfig) DaemonTag

func (cfg *StakewiseConfig) DaemonTag() string

The tag for the daemon container

func (*StakewiseConfig) DepositDataFile

func (c *StakewiseConfig) DepositDataFile() string

func (*StakewiseConfig) FeeRecipient

func (cfg *StakewiseConfig) FeeRecipient() string

func (*StakewiseConfig) GetContainersToDeploy

func (cfg *StakewiseConfig) GetContainersToDeploy() []config.ContainerID

func (*StakewiseConfig) GetModuleName

func (cfg *StakewiseConfig) GetModuleName() string

The module name

func (*StakewiseConfig) GetParameters

func (cfg *StakewiseConfig) GetParameters() []config.IParameter

Get the parameters for this config

func (*StakewiseConfig) GetSubconfigs

func (cfg *StakewiseConfig) GetSubconfigs() map[string]config.IConfigSection

Get the sections underneath this one

func (*StakewiseConfig) GetTitle

func (cfg *StakewiseConfig) GetTitle() string

The title for the config

func (*StakewiseConfig) GetValidatorContainerTagInfo

func (cfg *StakewiseConfig) GetValidatorContainerTagInfo() map[config.ContainerID]string

func (*StakewiseConfig) GetVcAdditionalFlags

func (cfg *StakewiseConfig) GetVcAdditionalFlags() string

Gets the additional flags of the selected VC

func (*StakewiseConfig) GetVcContainerTag

func (cfg *StakewiseConfig) GetVcContainerTag() string

Get the container tag of the selected VC

func (*StakewiseConfig) Graffiti

func (cfg *StakewiseConfig) Graffiti() (string, error)

Used by text/template to format validator.yml

func (*StakewiseConfig) IsDoppelgangerEnabled

func (cfg *StakewiseConfig) IsDoppelgangerEnabled() bool

Check if any of the services have doppelganger detection enabled NOTE: update this with each new service that runs a VC!

func (*StakewiseConfig) IsEnabled

func (cfg *StakewiseConfig) IsEnabled() bool

func (*StakewiseConfig) KeystorePasswordFile

func (c *StakewiseConfig) KeystorePasswordFile() string

func (*StakewiseConfig) Network

func (cfg *StakewiseConfig) Network() string

func (*StakewiseConfig) OperatorContainerName

func (c *StakewiseConfig) OperatorContainerName() string

func (*StakewiseConfig) PasswordFilename

func (c *StakewiseConfig) PasswordFilename() string

func (*StakewiseConfig) Vault

func (cfg *StakewiseConfig) Vault() string

func (*StakewiseConfig) VcContainerName

func (c *StakewiseConfig) VcContainerName() string

func (*StakewiseConfig) WalletFilename

func (c *StakewiseConfig) WalletFilename() string