config

Documentation

Overview

Package config handles config data decoded from config.yaml for the explorer service.

Index

• Constants
• Variables
• type ChainConfig
  • func (c ChainConfig) IsValid() (ok bool, err error)
• type ChainConfigs
  • func (c ChainConfigs) IsValid() (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)
• type ContractConfig
  • func (c ContractConfig) IsValid() (ok bool, err error)
• type ContractConfigs
  • func (c ContractConfigs) IsValid() (ok bool, err error)

Constants

const (
	// BridgeContractType is the type of a bridge contract.
	BridgeContractType = "bridge"
	// SwapContractType is the type of the swap contract.
	SwapContractType = "swap"
	// MessageBusContractType is the type of a message bus contract.
	MessageBusContractType = "messagebus"
	// MetaSwapContractType is the type of a meta swap contract.
	MetaSwapContractType = "metaswap"
	// CCTPContractType is the type of a CCTP contract.
	CCTPContractType = "cctp"
)

TODO: these should be put into the contracts themselves and implement a custom type.

Variables

var ErrAddressLength = errors.New("invalid address length")

ErrAddressLength indicates that an invalid address length is found.

var ErrRequiredField = errors.New("field is required")

ErrRequiredField indicates that a required field is missing.

Types

type ChainConfig

type ChainConfig struct {
	// ChainID is the ID of the chain.
	ChainID uint32 `yaml:"chain_id"`
	// RPCURL is the RPC of the chain.
	RPCURL string `yaml:"rpc_url"`
	// FetchBlockIncrement is the number of blocks to fetch at a time.
	FetchBlockIncrement uint64 `yaml:"fetch_block_increment"`
	// MaxGoroutines is the maximum number of goroutines that can be spawned.
	MaxGoroutines int `yaml:"max_goroutines"`
	// Contracts are the contracts.
	Contracts ContractConfigs `yaml:"contracts"`
}

ChainConfig is the configuration for a chain.

func (ChainConfig) IsValid

func (c ChainConfig) IsValid() (ok bool, err error)

IsValid validates the chain config.

type ChainConfigs

type ChainConfigs []ChainConfig

ChainConfigs contains an array fo ChainConfigs.

func (ChainConfigs) IsValid

func (c ChainConfigs) IsValid() (ok bool, err error)

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

type Config

type Config struct {
	// RefreshRate is the rate at which the explorer will refresh the last block height in seconds.
	RefreshRate int `yaml:"refresh_rate"`
	// ScribeURL is the URL of the Scribe server.
	ScribeURL string `yaml:"scribe_url"`
	// RPCURL is the URL of the RPC server.
	RPCURL string `yaml:"rpc_url"`
	// BridgeConfigAddress is the address of BridgeConfig contract.
	BridgeConfigAddress string `yaml:"bridge_config_address"`
	// BridgeConfigChainID is the ChainID of BridgeConfig contract.
	BridgeConfigChainID uint32 `yaml:"bridge_config_chain_id"`
	// Chains stores the chain configurations.
	Chains ChainConfigs `yaml:"chains"`
}

Config is used to configure the explorer's data consumption.

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.

type ContractConfig

type ContractConfig struct {
	// ContractType is the type of contract.
	ContractType string `yaml:"contract_type"`
	// Addresses are the addresses of the contracts
	Address string `yaml:"address"`
	// StartBlock is where to start backfilling this address from.
	StartBlock int64 `yaml:"start_block"`
}

ContractConfig is the configuration for a contract.

func (ContractConfig) IsValid

func (c ContractConfig) IsValid() (ok bool, err error)

IsValid validates the chain config.

type ContractConfigs

type ContractConfigs []ContractConfig

ContractConfigs contains an array fo ChainConfigs.

func (ContractConfigs) IsValid

func (c ContractConfigs) IsValid() (ok bool, err error)

IsValid validates the contract config by asserting no two contracts appear twice.