config

Documentation

Index

• Constants
• func DefaultConfig() (conf *viper.Viper)
• func GetConfig(root string) (conf *viper.Viper)
• func InitConfig(root, chainID string, setConf *viper.Viper) (conf *viper.Viper)
• func InitRuntime(root string, chainId string, setConf *viper.Viper) error
• func RuntimeDir(root string) string
• func SetDefaults(runtime string, conf *viper.Viper) *viper.Viper

Constants

const (
	// RUNTIME_ENV defines the name of the environment variable for runtime path
	RUNTIME_ENV = "ANGINE_RUNTIME"
	// DEFAULT_RUNTIME defines the default path for runtime path relative to $HOME
	DEFAULT_RUNTIME = ".angine"
	// DATADIR is the data dir in the runtime, basically you don't change this never
	DATADIR    = "data"
	ARCHIVEDIR = "data/archive"
	// CONFIGFILE is the name of the configuration file name in the runtime path for angine
	CONFIGFILE = "config.toml"
)

Functions

func DefaultConfig

func DefaultConfig() (conf *viper.Viper)

func GetConfig

func GetConfig(root string) (conf *viper.Viper)

GetConfig returns a ready-to-go config instance with all defaults filled in

func InitConfig

func InitConfig(root, chainID string, setConf *viper.Viper) (conf *viper.Viper)

func InitRuntime

func InitRuntime(root string, chainId string, setConf *viper.Viper) error

InitRuntime makes all the necessary directorys for angine's runtime and generate the config template for you if it is not there already

func RuntimeDir

func RuntimeDir(root string) string

func SetDefaults

func SetDefaults(runtime string, conf *viper.Viper) *viper.Viper

SetDefaults sets all the default configs for angine