flags

package

v1.14.3 Latest Latest Go to latest Published: Oct 23, 2025 License: MIT Imports: 11 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/ethereum-optimism/optimism

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func CheckRequired(ctx *cli.Context) error
func FullDynamicFlags(chains []uint64) []cli.Flag
func ParseChains(args []string) ([]uint64, error)
type VirtualCLI
- func NewVirtualCLI(base *cli.Context, chainID uint64) *VirtualCLI

Constants ¶

View Source

const EnvVarPrefix = "OP_SUPERNODE"

View Source

const VNFlagGlobalPrefix = "vn.all."

View Source

const VNFlagNamePrefix = "vn."

VN flag prefixes for dynamically cloned flags

Variables ¶

View Source

var (
	ChainsFlag = &cli.Uint64SliceFlag{
		Name:    "chains",
		Usage:   "List of chain IDs to run (repeatable or comma-separated)",
		EnvVars: prefixEnvVars("CHAINS"),
		Value:   cli.NewUint64Slice(),
	}
	DataDirFlag = &cli.StringFlag{
		Name:     "data-dir",
		Usage:    "Data directory for op-supernode",
		EnvVars:  prefixEnvVars("DATA_DIR"),
		Value:    "./datadir",
		Required: false,
	}
	L1NodeAddr = &cli.StringFlag{
		Name:     "l1",
		Usage:    "Address of L1 User JSON-RPC endpoint to use (eth namespace required)",
		EnvVars:  prefixEnvVars("L1_ETH_RPC"),
		Required: true,
	}
	L1BeaconAddr = &cli.StringFlag{
		Name:     "l1.beacon",
		Usage:    "Address of L1 Beacon-node HTTP endpoint to use",
		EnvVars:  prefixEnvVars("L1_BEACON"),
		Required: false,
	}
)

View Source

var Flags []cli.Flag

Functions ¶

func CheckRequired ¶

func CheckRequired(ctx *cli.Context) error

func FullDynamicFlags ¶

func FullDynamicFlags(chains []uint64) []cli.Flag

FullDynamicFlags returns the base supernode flags plus dynamically-generated vn.* flags cloned from op-node flags for all-chains and per-chain IDs.

func ParseChains ¶

func ParseChains(args []string) ([]uint64, error)

ParseChains finds the chains flag in the given args and returns the chains. This is used to construct the dynamic flags for the supernode at runtime.

Types ¶

type VirtualCLI ¶

type VirtualCLI struct {
	// contains filtered or unexported fields
}

VirtualCLI wraps a base CLI context and returns namespaced values for flags and supports overriding values for specific flags

func NewVirtualCLI ¶

func NewVirtualCLI(base *cli.Context, chainID uint64) *VirtualCLI

func (*VirtualCLI) Bool ¶

func (v *VirtualCLI) Bool(name string) bool

func (*VirtualCLI) Duration ¶

func (v *VirtualCLI) Duration(name string) time.Duration

func (*VirtualCLI) Float64 ¶

func (v *VirtualCLI) Float64(name string) float64

func (*VirtualCLI) Generic ¶

func (v *VirtualCLI) Generic(name string) any

func (*VirtualCLI) Int ¶

func (v *VirtualCLI) Int(name string) int

func (*VirtualCLI) IsSet ¶

func (v *VirtualCLI) IsSet(name string) bool

IsSet satisfies the cliiface.Context interface if an override is set, or if any namespaced version is set, return true otherwise defer to the inner context

func (*VirtualCLI) Path ¶

func (v *VirtualCLI) Path(name string) string

func (*VirtualCLI) String ¶

func (v *VirtualCLI) String(name string) string

func (*VirtualCLI) StringSlice ¶

func (v *VirtualCLI) StringSlice(name string) []string

func (*VirtualCLI) Uint ¶

func (v *VirtualCLI) Uint(name string) uint

func (*VirtualCLI) Uint64 ¶

func (v *VirtualCLI) Uint64(name string) uint64

func (*VirtualCLI) WithBoolOverride ¶

func (v *VirtualCLI) WithBoolOverride(name string, value bool) *VirtualCLI

WithBoolOverride sets a bool override for the given base flag name

func (*VirtualCLI) WithStringOverride ¶

func (v *VirtualCLI) WithStringOverride(name, value string) *VirtualCLI

WithStringOverride sets a string override for the given base flag name

Source Files ¶

View all Source files

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