config

Documentation

Overview

Package config enables .yaml files to be passed and parsed to specify indexer behavior

Index

• 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 Config

type Config struct {
	// SynapseBridgeAddress is the address of the SynapseBridge.sol contract
	SynapseBridgeAddress string `yaml:"synapse_bridge_address"`
	// BridgeConfigV3Address is the address of the BridgeConfigV3.sol contract
	BridgeConfigV3Address string `yaml:"bridge_config_v3_address"`
	// SwapFlashLoanAddress is the address of the SwapFlashLoan.sol contract
	SwapFlashLoanAddress string `yaml:"swap_flash_loan_address"`
}

Config holds the config for the explorer.

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.toml 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. TODO: add more checks.