flags

package
v1.14.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 7, 2025 License: MIT Imports: 12 Imported by: 0

Documentation

Index

Constants

View Source
const EnvVarPrefix = "OP_SUPERVISOR"

Variables

View Source
var (
	ErrRequiredFlagMissing = fmt.Errorf("required flag is missing")
	ErrConflictingFlags    = fmt.Errorf("conflicting flags")
)
View Source
var (
	L1RPCFlag = &cli.StringFlag{
		Name:    "l1-rpc",
		Usage:   "L1 RPC source.",
		EnvVars: prefixEnvVars("L1_RPC"),
	}
	L2ConsensusNodesFlag = &cli.StringSliceFlag{
		Name:    "l2-consensus.nodes",
		Usage:   "L2 Consensus rollup node RPC addresses (with auth).",
		EnvVars: prefixEnvVars("L2_CONSENSUS_NODES"),
	}
	L2ConsensusJWTSecret = &cli.StringSliceFlag{
		Name: "l2-consensus.jwt-secret",
		Usage: "Path to JWT secret key. Keys are 32 bytes, hex encoded in a file. " +
			"If multiple paths are specified, secrets are assumed to match l2-consensus-nodes order.",
		EnvVars:   prefixEnvVars("L2_CONSENSUS_JWT_SECRET"),
		Value:     cli.NewStringSlice(),
		TakesFile: true,
	}
	DataDirFlag = &cli.PathFlag{
		Name:    "datadir",
		Usage:   "Directory to store data generated as part of responding to games",
		EnvVars: prefixEnvVars("DATADIR"),
	}
	DataDirSyncEndpointFlag = &cli.PathFlag{
		Name:    "datadir.sync-endpoint",
		Usage:   "op-supervisor endpoint to sync databases from",
		EnvVars: prefixEnvVars("DATADIR_SYNC_ENDPOINT"),
	}
	NetworkFlag = &cli.StringSliceFlag{
		Name:    "networks",
		Aliases: []string{"network"},
		Usage:   fmt.Sprintf("Predefined network selection. Available networks: %s", strings.Join(chaincfg.AvailableNetworks(), ", ")),
		EnvVars: append(prefixEnvVars("NETWORKS"), prefixEnvVars("NETWORK")...),
	}
	DependencySetFlag = &cli.PathFlag{
		Name:      "dependency-set",
		Usage:     "Dependency-set configuration, point at JSON file.",
		EnvVars:   prefixEnvVars("DEPENDENCY_SET"),
		TakesFile: true,
	}
	RollupConfigPathsFlag = &cli.StringFlag{
		Name: "rollup-config-paths",
		Usage: "Path pattern to op-node rollup.json configs to load as a rollup config set. " +
			"The pattern should use the Go filepath glob sytax, e.g. '/configs/rollup-*.json' " +
			"When using this flag, the L1 timestamps are loaded from the provided L1 RPC",
		EnvVars: prefixEnvVars("ROLLUP_CONFIG_PATHS"),
	}
	RollupConfigSetFlag = &cli.PathFlag{
		Name: "rollup-config-set",
		Usage: "Rollup config set configuration, point at JSON file. " +
			"This is an alternative to rollup-config-paths to provide the supervisor rollup config set directly.",
		EnvVars:   prefixEnvVars("ROLLUP_CONFIG_SET"),
		TakesFile: true,
	}
	MockRunFlag = &cli.BoolFlag{
		Name:    "mock-run",
		Usage:   "Mock run, no actual backend used, just presenting the service",
		EnvVars: prefixEnvVars("MOCK_RUN"),
		Hidden:  true,
	}
	RPCVerificationWarningsFlag = &cli.BoolFlag{
		Name:    "rpc-verification-warnings",
		Usage:   "Enable asynchronous RPC verification of DB checkAccess call in the CheckAccessList endpoint, indicating warnings as a metric",
		EnvVars: prefixEnvVars("RPC_VERIFICATION_WARNINGS"),
		Value:   false,
	}
	FailsafeEnabledFlag = &cli.BoolFlag{
		Name: "failsafe-enabled",
		Usage: "Start the supervisor with failsafe enabled. In failsafe mode, the supervisor will reject all CheckAccessList requests. " +
			"All other Indexing and Cross Validation actions will continue to operate normally.",
		EnvVars: prefixEnvVars("FAILSAFE_ENABLED"),
		Value:   false,
	}
	FailsafeOnInvalidationFlag = &cli.BoolFlag{
		Name: "failsafe-on-invalidation",
		Usage: "Enable automatic failsafe activation when a block is invalidated. When enabled, the supervisor will automatically " +
			"enter failsafe mode when a Safe Block is determined to be Invalid on any chain, causing all future CheckAccessList requests to be rejected.",
		EnvVars: prefixEnvVars("FAILSAFE_ON_INVALIDATION"),
		Value:   true,
	}
)
View Source
var Flags []cli.Flag

Flags contains the list of configuration options available to the binary.

Functions

func ConfigFromCLI

func ConfigFromCLI(ctx *cli.Context, version string) (*config.Config, error)

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL