chainconfig

Documentation

Index

• Variables
• func CheckVersion(configFile io.Reader) error
• func CreateConfigDir() error
• func FaucetHost(cfg *Config) string
• func LocateDefault(root string) (path string, err error)
• func MigrateLatest(current io.Reader, latest io.Writer) error
• func ReadConfigVersion(configFile io.Reader) (config.Version, error)
• func TSClientPath(conf *Config) string
• type Config
  • func ConvertLatest(c config.Converter) (_ *Config, err error)
  • func DefaultConfig() *Config
  • func Parse(configFile io.Reader) (*Config, error)
  • func ParseFile(path string) (*Config, error)
• type UnsupportedVersionError
  • func (e UnsupportedVersionError) Error() string
• type ValidationError
  • func (e ValidationError) Error() string
• type VersionError
  • func (e VersionError) Error() string

Variables

var (
	// ConfigDirPath returns the path of configuration directory of Ignite.
	ConfigDirPath = xfilepath.JoinFromHome(xfilepath.Path(".ignite"))

	// ConfigFileNames is a list of recognized names as for Ignite's config file.
	ConfigFileNames = []string{"config.yml", "config.yaml"}

	// DefaultTSClientPath defines the default relative path to use when generating the TS client.
	// The path is relative to the app's directory.
	DefaultTSClientPath = "ts-client"

	// LatestVersion defines the latest version of the config.
	LatestVersion config.Version = 1

	// Versions holds config types for the supported versions.
	Versions = map[config.Version]config.Converter{
		0: &v0.Config{},
		1: &v1.Config{},
	}
)

var ErrConfigNotFound = errors.New("could not locate a config.yml in your chain")

ErrConfigNotFound indicates that the config.yml can't be found.

Functions

func CheckVersion

func CheckVersion(configFile io.Reader) error

CheckVersion checks that the config version is the latest and if not a VersionError is returned.

func CreateConfigDir

func CreateConfigDir() error

CreateConfigDir creates config directory if it is not created yet.

func FaucetHost

func FaucetHost(cfg *Config) string

FaucetHost returns the faucet host to use.

func LocateDefault

func LocateDefault(root string) (path string, err error)

LocateDefault locates the default path for the config file. Returns ErrConfigNotFound when no config file found.

func MigrateLatest

func MigrateLatest(current io.Reader, latest io.Writer) error

MigrateLatest migrates a config file to the latest version.

func ReadConfigVersion

func ReadConfigVersion(configFile io.Reader) (config.Version, error)

ReadConfigVersion reads the config version.

func TSClientPath

func TSClientPath(conf *Config) string

TSClientPath returns the relative path to the Typescript client directory. Path is relative to the app's directory.

Types

type Config

type Config = v1.Config

Config defines the latest config.

func ConvertLatest

func ConvertLatest(c config.Converter) (_ *Config, err error)

ConvertLatest converts a config to the latest version.

func DefaultConfig

func DefaultConfig() *Config

DefaultConfig returns a config for the latest version initialized with default values.

func Parse

func Parse(configFile io.Reader) (*Config, error)

Parse reads a config file. When the version of the file beign read is not the latest it is automatically migrated to the latest version.

func ParseFile

func ParseFile(path string) (*Config, error)

ParseFile parses a config from a file path.

type UnsupportedVersionError

type UnsupportedVersionError struct {
	Version config.Version
}

UnsupportedVersionError is returned when the version of the config is not supported.

func (UnsupportedVersionError) Error

func (e UnsupportedVersionError) Error() string

type ValidationError

type ValidationError struct {
	Message string
}

ValidationError is returned when a configuration is invalid.

func (ValidationError) Error

func (e ValidationError) Error() string

type VersionError

type VersionError struct {
	Version config.Version
}

VersionError is returned when config version is not the latest.

func (VersionError) Error

func (e VersionError) Error() string