config

Documentation

Overview

Package config defines the config for the Executor.

Index

• type ChainConfig
  • func (c ChainConfig) IsValid(ctx context.Context) (ok bool, err error)
• type ChainConfigs
  • func (c ChainConfigs) IsValid(ctx context.Context) (ok bool, err error)
• type Config
  • func DecodeConfig(filePath string) (cfg Config, err error)
  • func (c Config) Encode() ([]byte, error)
  • func (c *Config) IsValid(ctx context.Context) (ok bool, err error)

Types

type ChainConfig

type ChainConfig struct {
	// TempRPC is the temporary RPC endpoint for the chain.
	TempRPC string `yaml:"temp_rpc"`
	// ChainID is the ID of the chain.
	ChainID uint32 `yaml:"chain_id"`
	// OriginAddress is the address of the origin contract.
	OriginAddress string `yaml:"origin_address"`
	// DestinationAddress is the address of the destination contract.
	DestinationAddress string `yaml:"destination_address"`
	// LightInboxAddress is the address of the light inbox contract.
	LightInboxAddress string `yaml:"lightinbox_address"`
}

ChainConfig defines the config for a specific chain.

func (ChainConfig) IsValid

func (c ChainConfig) IsValid(ctx context.Context) (ok bool, err error)

IsValid validates the chain config.

type ChainConfigs

type ChainConfigs []ChainConfig

ChainConfigs contains an array of ChainConfigs.

func (ChainConfigs) IsValid

func (c ChainConfigs) IsValid(ctx context.Context) (ok bool, err error)

IsValid validates the chain config by asserting no two chains appear twice.

type Config

type Config struct {
	// Chains stores all chain information
	Chains ChainConfigs `yaml:"chains"`
	// SummitChainID is the chain ID of the chain that the summit contract is deployed on.
	SummitChainID uint32 `yaml:"summit_chain_id"`
	// SummitAddress is the address of the summit contract.
	SummitAddress string `yaml:"summit_address"`
	// InboxAddress is the address of the inbox contract.
	InboxAddress string `yaml:"inbox_address"`
	// BaseOmnirpcURL is the base url for omnirpc.
	// The format is "https://omnirpc.url/". Notice the lack of "confirmations" on the URL
	// in comparison to what `Scribe` uses.
	BaseOmnirpcURL string `yaml:"base_omnirpc_url"`
	// UnbondedSigner contains the unbonded signer config for agents
	// (this is signer used to submit transactions)
	UnbondedSigner agentsConfig.SignerConfig `yaml:"unbonded_signer"`
	// ExecuteInterval is the interval at which the executor agent will
	// check if messages in the database are ready to be executed.
	ExecuteInterval uint32 `yaml:"execute_interval"`
	// SetMinimumTimeInterval is the interval at which the executor agent will
	// check messages to set their minimum times from attestations.
	SetMinimumTimeInterval uint32 `yaml:"set_minimum_time_interval"`
	// EmbeddedScribeConfig is the config for the embedded scribe. This only needs to be
	// included if an embedded Scribe is being used. If a remote Scribe is being used,
	// this can be left empty.
	EmbeddedScribeConfig scribeConfig.Config `yaml:"embedded_scribe_config"`
	// DBPrefix is the prefix for the tables in the database. This is only to be used with mysql.
	DBPrefix string `yaml:"db_prefix"`
}

Config is used to configure an Executor agent.

func DecodeConfig

func DecodeConfig(filePath string) (cfg Config, err error)

DecodeConfig parses in a config from a file.

func (Config) Encode

func (c Config) Encode() ([]byte, error)

Encode gets the encoded config.yaml file.

func (*Config) IsValid

func (c *Config) IsValid(ctx context.Context) (ok bool, err error)

IsValid makes sure the config is valid. This is done by calling IsValid() on each submodule. If any method returns an error that is returned here and the entirety of IsValid returns false. Any warnings are logged by the submodules respective loggers.