config

Documentation

Index

• Constants
• Variables
• func GetDeveloperContractAddressKey(contractName string) string
• type BitcoinConfig
• type Category
• type Config
  • func (c *Config) ReadConfig(configFilePath string, flagSet *pflag.FlagSet, categories ...Category) error

Constants

const (
	// #nosec G101 (look for hardcoded credentials)
	// This line doesn't contain any credentials.
	// It's just the name of the environment variable.
	EthereumPasswordEnvVariable = "KEEP_ETHEREUM_PASSWORD"

	// LogLevelEnvVariable can be used to define logging configuration.
	LogLevelEnvVariable = "LOG_LEVEL"
)

Variables

var AllCategories = []Category{
	General,
	Ethereum,
	BitcoinElectrum,
	Network,
	Storage,
	ClientInfo,
	Tbtc,
	Maintainer,
	Developer,
}

AllCategories are all available categories.

var MaintainerCategories = []Category{
	Ethereum,
	BitcoinElectrum,
	Maintainer,
}

MaintainerCategories are categories needed for the maintainer command.

var StartCmdCategories = []Category{
	General,
	Ethereum,
	BitcoinElectrum,
	Network,
	Storage,
	ClientInfo,
	Tbtc,
	Developer,
}

StartCmdCategories are categories needed for the start command.

Functions

func GetDeveloperContractAddressKey

func GetDeveloperContractAddressKey(contractName string) string

GetDeveloperContractAddressKey returns a key for developer contract address configuration.

Types

type BitcoinConfig

type BitcoinConfig struct {
	bitcoin.Network
	// Electrum defines the configuration for the Electrum client.
	Electrum electrum.Config
}

BitcoinConfig defines the configuration for Bitcoin.

type Category

type Category int

const (
	General Category = iota
	Ethereum
	BitcoinElectrum
	Network
	Storage
	ClientInfo
	Tbtc
	Maintainer
	Developer
)

type Config

type Config struct {
	Ethereum   commonEthereum.Config
	Bitcoin    BitcoinConfig
	LibP2P     libp2p.Config `mapstructure:"network"`
	Storage    storage.Config
	ClientInfo clientinfo.Config
	Maintainer maintainer.Config
	Tbtc       tbtc.Config
}

Config is the top level config structure.

func (*Config) ReadConfig

func (c *Config) ReadConfig(configFilePath string, flagSet *pflag.FlagSet, categories ...Category) error

ReadConfig reads in the configuration file at `configFilePath` and flags defined in the `flagSet`.