web3signer_cmds_ai_generated

Documentation

Index

• Variables
• type AWSCfg
  • func (c *AWSCfg) SetArgs() []string
• type AzureConfig
  • func (config *AzureConfig) SetArgs() []string
• type Config
  • func (c *Config) SetArgs() ([]string, error)
  • func (c *Config) VerifyLogLevel() error
• type KeyManagerConfig
  • func (kmc *KeyManagerConfig) SetArgs() []string
• type SlashingConfig
  • func (sc *SlashingConfig) SetArgs() []string
• type TLSOpts
  • func (opts *TLSOpts) SetArgs() []string
• type Web3SignerCmdArgs
  • func (w *Web3SignerCmdArgs) CreateFieldsForCLI(platformSubcommand string) ([]string, error)

Variables

var Web3SignerAPICmd = Web3SignerCmdArgs{
	Config: Config{
		ConfigFile:     "",
		DataPath:       "",
		KeyStorePath:   "",
		LoggingLevel:   "",
		HTTPCors:       "",
		HTTPListen:     "0.0.0.0",
		HTTPListenPort: 0,
		HTTPAllowlist:  "*",
		MetricsEnabled: false,
		MetricsPort:    0,
		MetricsPrefix:  "",
	},
	TLSOpts: TLSOpts{
		TLSKeyStoreFile:     "",
		TLSPasswordFile:     "",
		TLSAllowCAClients:   false,
		TLSAllowAnyClient:   true,
		TLSKnownClientsFile: "",
	},
	AWSCfg:      AWSCfg{},
	AzureConfig: AzureConfig{},
	SlashingConfig: SlashingConfig{
		ProtectionDbPassword:           "",
		ProtectionDbUrl:                "",
		ProtectionDbUsername:           "",
		ProtectionEnabled:              false,
		ProtectionDisabled:             true,
		ProtectionPruningEnabled:       false,
		ProtectionPruningEpochsToKeep:  0,
		ProtectionPruningInterval:      0,
		ProtectionPruningSlotsPerEpoch: 0,
	},
	KeyManagerConfig: KeyManagerConfig{
		KeyManagerAPIEenabled:  true,
		KeystoresPasswordFile:  "",
		KeystoresPasswordsPath: "",
		KeystoresPath:          "",
		Network:                "minimal",
	},
}

var Web3SignerStd = Web3SignerCmdArgs{
	Config: Config{
		ConfigFile:     "",
		DataPath:       "",
		KeyStorePath:   "",
		LoggingLevel:   "",
		HTTPCors:       "",
		HTTPListen:     "0.0.0.0",
		HTTPListenPort: 0,
		HTTPAllowlist:  "*",
		MetricsEnabled: false,
		MetricsPort:    0,
		MetricsPrefix:  "",
	},
	TLSOpts: TLSOpts{
		TLSKeyStoreFile:     "",
		TLSPasswordFile:     "",
		TLSAllowCAClients:   false,
		TLSAllowAnyClient:   true,
		TLSKnownClientsFile: "",
	},
	AWSCfg:      AWSCfg{},
	AzureConfig: AzureConfig{},
	SlashingConfig: SlashingConfig{
		ProtectionDbPassword:           "${WEB3SIGNER_SLASHING_PROTECTION_DB_PASSWORD}",
		ProtectionDbUrl:                "${WEB3SIGNER_SLASHING_PROTECTION_DB_URL}",
		ProtectionDbUsername:           "${WEB3SIGNER_SLASHING_PROTECTION_DB_USERNAME}",
		ProtectionEnabled:              true,
		ProtectionPruningEnabled:       false,
		ProtectionPruningEpochsToKeep:  0,
		ProtectionPruningInterval:      0,
		ProtectionPruningSlotsPerEpoch: 0,
	},
	KeyManagerConfig: KeyManagerConfig{
		KeyManagerAPIEenabled:  true,
		KeystoresPasswordFile:  "",
		KeystoresPasswordsPath: "",
		KeystoresPath:          "",
		Network:                "${WEB3SIGNER_NETWORK}",
	},
}

Types

type AWSCfg

type AWSCfg struct {
	SecretsEnabled      bool
	ConnectionCacheSize int64
	AuthMode            string
	AccessKeyID         string
	SecretAccessKey     string
	Region              string
	PrefixesFilter      []string
	TagNamesFilter      []string
	TagValuesFilter     []string
}

func (*AWSCfg) SetArgs

func (c *AWSCfg) SetArgs() []string

type AzureConfig

type AzureConfig struct {
	VaultEnabled  bool
	ClientId      string
	ClientSecret  string
	TenantId      string
	VaultAuthMode string
	VaultName     string
}

func (*AzureConfig) SetArgs

func (config *AzureConfig) SetArgs() []string

type Config

type Config struct {
	ConfigFile     string
	DataPath       string
	KeyStorePath   string
	LoggingLevel   string
	HTTPCors       string
	HTTPListen     string
	HTTPListenPort int
	HTTPAllowlist  string
	MetricsEnabled bool
	MetricsPort    int
	MetricsPrefix  string
}

func (*Config) SetArgs

func (c *Config) SetArgs() ([]string, error)

func (*Config) VerifyLogLevel

func (c *Config) VerifyLogLevel() error

VerifyLogLevel Log Level Verification Function

type KeyManagerConfig

type KeyManagerConfig struct {
	KeyManagerAPIEenabled  bool
	KeystoresPasswordFile  string
	KeystoresPasswordsPath string
	KeystoresPath          string
	Network                string
}

func (*KeyManagerConfig) SetArgs

func (kmc *KeyManagerConfig) SetArgs() []string

type SlashingConfig

type SlashingConfig struct {
	ProtectionDbPassword           string
	ProtectionDbUrl                string
	ProtectionDbUsername           string
	ProtectionDisabled             bool
	ProtectionEnabled              bool
	ProtectionPruningEnabled       bool
	ProtectionPruningEpochsToKeep  int
	ProtectionPruningInterval      int
	ProtectionPruningSlotsPerEpoch int
}

func (*SlashingConfig) SetArgs

func (sc *SlashingConfig) SetArgs() []string

type TLSOpts

type TLSOpts struct {
	TLSKeyStoreFile     string
	TLSPasswordFile     string
	TLSAllowCAClients   bool
	TLSAllowAnyClient   bool
	TLSKnownClientsFile string
}

func (*TLSOpts) SetArgs

func (opts *TLSOpts) SetArgs() []string

type Web3SignerCmdArgs

type Web3SignerCmdArgs struct {
	Config
	TLSOpts
	AWSCfg
	AzureConfig

	// subcommand configs
	SlashingConfig
	KeyManagerConfig
}

func (*Web3SignerCmdArgs) CreateFieldsForCLI

func (w *Web3SignerCmdArgs) CreateFieldsForCLI(platformSubcommand string) ([]string, error)

CreateFieldsForCLI platformSubcommand should be eth1, eth2, or filecoin