flags.go

package cli

import "github.com/urfave/cli/v3"

const (
	LoggingCategory = "LOGGING AND DEBUGGING"
	GenesisCategory = "GENESIS"
	RelayCategory   = "RELAYS"
	GeneralCategory = "GENERAL"
	Metrics         = "METRICS"
)

var flags = []cli.Flag{
	// general
	addrFlag,
	versionFlag,
	// logging
	jsonFlag,
	colorFlag,
	debugFlag,
	logLevelFlag,
	logServiceFlag,
	logNoVersionFlag,
	// genesis
	customGenesisForkFlag,
	customGenesisTimeFlag,
	mainnetFlag,
	sepoliaFlag,
	holeskyFlag,
	hoodiFlag,
	// relay
	relaysFlag,
	relayConfigFlag,
	watchConfigFlag,
	deprecatedRelayMonitorFlag,
	minBidFlag,
	relayCheckFlag,
	timeoutGetHeaderFlag,
	timeoutGetPayloadFlag,
	timeoutRegValFlag,
	maxRetriesFlag,
	// metrics
	metricsFlag,
	metricsAddrFlag,
}

var (
	// General
	addrFlag = &cli.StringFlag{
		Name:     "addr",
		Sources:  cli.EnvVars("BOOST_LISTEN_ADDR"),
		Value:    "localhost:18550",
		Usage:    "listen-address for mev-boost server",
		Category: GeneralCategory,
	}
	versionFlag = &cli.BoolFlag{
		Name:     "version",
		Usage:    "print version",
		Category: GeneralCategory,
	}
	// Logging and debugging
	jsonFlag = &cli.BoolFlag{
		Name:     "json",
		Sources:  cli.EnvVars("LOG_JSON"),
		Usage:    "log in JSON format instead of text",
		Category: LoggingCategory,
	}
	colorFlag = &cli.BoolFlag{
		Name:     "color",
		Sources:  cli.EnvVars("LOG_COLOR"),
		Usage:    "enable colored output for text log format",
		Category: LoggingCategory,
	}
	debugFlag = &cli.BoolFlag{
		Name:     "debug",
		Sources:  cli.EnvVars("DEBUG"),
		Usage:    "shorthand for '--loglevel debug'",
		Category: LoggingCategory,
	}
	logLevelFlag = &cli.StringFlag{
		Name:     "loglevel",
		Sources:  cli.EnvVars("LOG_LEVEL"),
		Value:    "info",
		Usage:    "minimum loglevel: trace, debug, info, warn/warning, error, fatal, panic",
		Category: LoggingCategory,
	}
	logServiceFlag = &cli.StringFlag{
		Name:     "log-service",
		Sources:  cli.EnvVars("LOG_SERVICE_TAG"),
		Value:    "",
		Usage:    "add a 'service=...' tag to all log messages",
		Category: LoggingCategory,
	}
	logNoVersionFlag = &cli.BoolFlag{
		Name:     "log-no-version",
		Sources:  cli.EnvVars("DISABLE_LOG_VERSION"),
		Usage:    "disables adding the version to every log entry",
		Category: LoggingCategory,
	}
	// Genesis Flags
	customGenesisForkFlag = &cli.StringFlag{
		Name:     "genesis-fork-version",
		Sources:  cli.EnvVars("GENESIS_FORK_VERSION"),
		Usage:    "use a custom genesis fork version",
		Category: GenesisCategory,
	}
	customGenesisTimeFlag = &cli.UintFlag{
		Name:     "genesis-timestamp",
		Sources:  cli.EnvVars("GENESIS_TIMESTAMP"),
		Usage:    "use a custom genesis timestamp (unix seconds)",
		Category: GenesisCategory,
	}
	mainnetFlag = &cli.BoolFlag{
		Name:     "mainnet",
		Sources:  cli.EnvVars("MAINNET"),
		Usage:    "use Mainnet",
		Value:    true,
		Category: GenesisCategory,
	}
	sepoliaFlag = &cli.BoolFlag{
		Name:     "sepolia",
		Sources:  cli.EnvVars("SEPOLIA"),
		Usage:    "use Sepolia",
		Category: GenesisCategory,
	}
	holeskyFlag = &cli.BoolFlag{
		Name:     "holesky",
		Sources:  cli.EnvVars("HOLESKY"),
		Usage:    "use Holesky",
		Category: GenesisCategory,
	}
	hoodiFlag = &cli.BoolFlag{
		Name:     "hoodi",
		Sources:  cli.EnvVars("HOODI"),
		Usage:    "use Hoodi",
		Category: GenesisCategory,
	}
	// Relay
	relaysFlag = &cli.StringSliceFlag{
		Name:     "relay",
		Aliases:  []string{"relays"},
		Sources:  cli.EnvVars("RELAYS"),
		Usage:    "relay urls - single entry or comma-separated list (scheme://pubkey@host)",
		Category: RelayCategory,
	}
	relayConfigFlag = &cli.StringFlag{
		Name:     "config",
		Sources:  cli.EnvVars("CONFIG_FILE"),
		Usage:    "path to YAML configuration file",
		Category: RelayCategory,
	}
	watchConfigFlag = &cli.BoolFlag{
		Name:     "watch-config",
		Sources:  cli.EnvVars("WATCH_CONFIG"),
		Usage:    "enable hot reloading of config file (requires --config)",
		Category: RelayCategory,
	}
	deprecatedRelayMonitorFlag = &cli.StringSliceFlag{
		Name:     "relay-monitors",
		Aliases:  []string{"relay-monitor"},
		Usage:    "[deprecated]",
		Category: RelayCategory,
		Hidden:   true,
	}
	minBidFlag = &cli.FloatFlag{
		Name:     "min-bid",
		Sources:  cli.EnvVars("MIN_BID_ETH"),
		Usage:    "minimum bid to accept from a relay [eth]",
		Category: RelayCategory,
	}
	relayCheckFlag = &cli.BoolFlag{
		Name:     "relay-check",
		Sources:  cli.EnvVars("RELAY_STARTUP_CHECK"),
		Usage:    "check relay status on startup and on the status API call",
		Category: RelayCategory,
	}
	// mev-boost relay request timeouts (see also https://github.com/flashbots/mev-boost/issues/287)
	timeoutGetHeaderFlag = &cli.IntFlag{
		Name:     "request-timeout-getheader",
		Sources:  cli.EnvVars("RELAY_TIMEOUT_MS_GETHEADER"),
		Usage:    "timeout for getHeader requests to the relay [ms]",
		Value:    950,
		Category: RelayCategory,
	}
	timeoutGetPayloadFlag = &cli.IntFlag{
		Name:     "request-timeout-getpayload",
		Sources:  cli.EnvVars("RELAY_TIMEOUT_MS_GETPAYLOAD"),
		Usage:    "timeout for getPayload requests to the relay [ms]",
		Value:    4000,
		Category: RelayCategory,
	}
	timeoutRegValFlag = &cli.IntFlag{
		Name:     "request-timeout-regval",
		Sources:  cli.EnvVars("RELAY_TIMEOUT_MS_REGVAL"),
		Usage:    "timeout for registerValidator requests [ms]",
		Value:    3000,
		Category: RelayCategory,
	}
	maxRetriesFlag = &cli.IntFlag{
		Name:     "request-max-retries",
		Sources:  cli.EnvVars("REQUEST_MAX_RETRIES"),
		Usage:    "maximum number of retries for a relay get payload request",
		Value:    5,
		Category: RelayCategory,
	}
	// metrics
	metricsFlag = &cli.BoolFlag{
		Name:     "metrics",
		Sources:  cli.EnvVars("METRICS_ENABLED"),
		Usage:    "enables a metrics server",
		Category: Metrics,
	}
	metricsAddrFlag = &cli.StringFlag{
		Name:     "metrics-addr",
		Sources:  cli.EnvVars("METRICS_ADDR"),
		Value:    "localhost:18551",
		Usage:    "listening address for the metrics server",
		Category: Metrics,
	}
)