config

Documentation

Index

• Variables
• type Config
  • func NewConfig(L1EthRpc string, RollupRpc string, L2OOAddress common.Address, ...) *Config
  • func NewConfigFromCLI(ctx *cli.Context) (*Config, error)
  • func (c Config) Check() error

Variables

var (
	ErrMissingL1EthRPC       = errors.New("missing l1 eth rpc url")
	ErrMissingRollupRpc      = errors.New("missing rollup rpc url")
	ErrMissingL2OOAddress    = errors.New("missing l2 output oracle contract address")
	ErrMissingDGFAddress     = errors.New("missing dispute game factory contract address")
	ErrInvalidNetworkTimeout = errors.New("invalid network timeout")
	ErrMissingTxMgrConfig    = errors.New("missing tx manager config")
	ErrMissingRPCConfig      = errors.New("missing rpc config")
	ErrMissingLogConfig      = errors.New("missing log config")
	ErrMissingMetricsConfig  = errors.New("missing metrics config")
	ErrMissingPprofConfig    = errors.New("missing pprof config")
)

Types

type Config

type Config struct {
	// L1EthRpc is the HTTP provider URL for L1.
	L1EthRpc string

	// RollupRpc is the HTTP provider URL for the rollup node.
	RollupRpc string

	// L2OOAddress is the L2OutputOracle contract address.
	L2OOAddress common.Address

	// DGFAddress is the DisputeGameFactory contract address.
	DGFAddress common.Address

	// NetworkTimeout is the timeout for network requests.
	NetworkTimeout time.Duration

	TxMgrConfig *txmgr.CLIConfig

	RPCConfig *oprpc.CLIConfig

	LogConfig *oplog.CLIConfig

	MetricsConfig *opmetrics.CLIConfig

	PprofConfig *oppprof.CLIConfig
}

Config is a well typed config that is parsed from the CLI params. This also contains config options for auxiliary services. It is used to initialize the challenger.

func NewConfig

func NewConfig(
	L1EthRpc string,
	RollupRpc string,
	L2OOAddress common.Address,
	DGFAddress common.Address,
	NetworkTimeout time.Duration,
	TxMgrConfig *txmgr.CLIConfig,
	RPCConfig *oprpc.CLIConfig,
	LogConfig *oplog.CLIConfig,
	MetricsConfig *opmetrics.CLIConfig,
	PprofConfig *oppprof.CLIConfig,
) *Config

NewConfig creates a Config with all optional values set to the CLI default value

func NewConfigFromCLI

func NewConfigFromCLI(ctx *cli.Context) (*Config, error)

NewConfigFromCLI parses the Config from the provided flags or environment variables.

func (Config) Check

func (c Config) Check() error