config

Documentation

Index

• func AssertConfigCompatibleWithRuntime(conf *viper.Viper) error
• func GetConfigurationFileBytes(chainId, moniker, seeds string, chainImageName string, useDataContainer bool, ...) ([]byte, error)
• func GetExampleConfigFileBytes() ([]byte, error)
• func ReadViperConfig(configBytes []byte) (*viper.Viper, error)
• func ViperSubConfig(conf *viper.Viper, configSubtreePath string) (subConfig *viper.Viper, err error)
• type ConfigChainGeneral
• type ConfigChainModule
• type ConfigServiceGeneral
• type ConfigTendermint
• type ModuleConfig

Functions

func AssertConfigCompatibleWithRuntime

func AssertConfigCompatibleWithRuntime(conf *viper.Viper) error

func GetConfigurationFileBytes

func GetConfigurationFileBytes(chainId, moniker, seeds string, chainImageName string,
	useDataContainer bool, exportedPortsString, containerEntrypoint string) ([]byte, error)

NOTE: [ben] for 0.12.0-rc3 we only have a single configuration path with Tendermint in-process as the consensus engine and BurrowMint in-process as the application manager, so we hard-code the few parameters that are already templated. Let's learn to walk before we can run.

func GetExampleConfigFileBytes

func GetExampleConfigFileBytes() ([]byte, error)

func ReadViperConfig

func ReadViperConfig(configBytes []byte) (*viper.Viper, error)

Read in TOML Viper config from bytes

func ViperSubConfig

func ViperSubConfig(conf *viper.Viper, configSubtreePath string) (subConfig *viper.Viper, err error)

Safely get the subtree from a viper config, returning an error if it could not be obtained for any reason.

Types

type ConfigChainGeneral

type ConfigChainGeneral struct {
	AssertChainId       string
	BurrowMajorVersion  uint8
	BurrowMinorVersion  uint8
	GenesisRelativePath string
}

TODO: [ben] increase the configurability upon need

type ConfigChainModule

type ConfigChainModule struct {
	Name               string
	ModuleRelativeRoot string
}

type ConfigServiceGeneral

type ConfigServiceGeneral struct {
	ChainImageName      string
	UseDataContainer    bool
	ExportedPorts       string
	ContainerEntrypoint string
}

type ConfigTendermint

type ConfigTendermint struct {
	Moniker  string
	Seeds    string
	FastSync bool
}

type ModuleConfig

type ModuleConfig struct {
	Module      string
	Name        string
	WorkDir     string
	DataDir     string
	RootDir     string
	ChainId     string
	GenesisFile string
	Config      *viper.Viper
}