config

README

config

Application configuration. Parses json/yaml into a configuration model as so

{
  "app_name": "carbonable-indexer",
  "start_block": 1,
  "contracts": [
    {
      "name": "carbonable-token",
      "address": "0x06a09ccb1caaecf3d9683efe335a667b2169a409a5293e49c23cb8b539c4e48",
      "events": {
        "Transfer": "token:transfer"
      }
    }
  ]
}

• app_name is the name of the application.
• start_block is the block number to start indexing from. must be > 0
• contracts is an array of contracts to index.
  • name is the name of the contract
  • address is the address of the contract
  • events is an object of events to listen to.
    • key is the event name as defined in the contract
    • value is the event name you want to receive from the indexer.

Documentation

Index

• Variables
• type Config
  • func FromJson(data []byte) (*Config, error)
  • func FromYamlFile(file string) (*Config, error)
  • func NewCongig() *Config
  • func (c *Config) ComputeHash() *Config
  • func (c *Config) GetContract(address string) *Contract
• type Contract
• type ContractRepository
• type NatsContractRepository
  • func NewPebbleContractRepository(s storage.Storage) *NatsContractRepository
  • func (r *NatsContractRepository) GetConfig(name string) (*Config, error)
  • func (r *NatsContractRepository) GetConfigs() ([]Config, error)
  • func (r *NatsContractRepository) SaveConfig(c Config) error

Variables

var (
	ErrParseConfig         = errors.New("unable to parse config")
	ErrUnmarshalYamlFailed = errors.New("unable to unmarshal yaml config")
	ErrUnmarshalJsonFailed = errors.New("unable to unmarshal json config")
)

Types

type Config

type Config struct {
	AppName    string `yaml:"app_name" json:"app_name"`
	Hash       string
	Contracts  []Contract `yaml:"contracts" json:"contracts"`
	StartBlock uint64     `yaml:"start_block" json:"start_block"`
}

func FromJson

func FromJson(data []byte) (*Config, error)

Create config from json input

func FromYamlFile

func FromYamlFile(file string) (*Config, error)

Create config from yaml input

func NewCongig

func NewCongig() *Config

func (*Config) ComputeHash

func (c *Config) ComputeHash() *Config

func (*Config) GetContract

func (c *Config) GetContract(address string) *Contract

type Contract

type Contract struct {
	Events  map[string]string `yaml:"events" json:"events"`
	Address string            `yaml:"address" json:"address"`
	Name    string            `yaml:"name" json:"name"`
}

type ContractRepository

type ContractRepository interface {
	SaveConfig(Config) error
	GetConfigs() ([]Config, error)
	GetConfig(string) (*Config, error)
}

type NatsContractRepository

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

func NewPebbleContractRepository

func NewPebbleContractRepository(s storage.Storage) *NatsContractRepository

func (*NatsContractRepository) GetConfig

func (r *NatsContractRepository) GetConfig(name string) (*Config, error)

func (*NatsContractRepository) GetConfigs

func (r *NatsContractRepository) GetConfigs() ([]Config, error)

func (*NatsContractRepository) SaveConfig

func (r *NatsContractRepository) SaveConfig(c Config) error