config

package
v1.5.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 23, 2020 License: MIT Imports: 8 Imported by: 0

Documentation

Index

Constants

View Source 
const PasswordEnvVariable = "KEEP_ETHEREUM_PASSWORD"

PasswordEnvVariable environment variable name for ethereum key password. #nosec G101 (look for hardcoded credentials) This line doesn't contain any credentials. It's just the name of the environment variable.

Variables

This section is empty.

Functions

func ReadEthereumConfig 

func ReadEthereumConfig(filePath string) (ethereum.Config, error)

ReadEthereumConfig reads in the configuration file at `filePath` and returns its contained Ethereum config, or an error if something fails while reading the file.

This is the same as invoking ReadConfig and reading the Ethereum property from the returned config, but is available for external functions that expect to interact solely with Ethereum and are therefore independent of the rest of the config structure.

Types

type Config 

type Config struct {
	Ethereum               ethereum.Config
	SanctionedApplications SanctionedApplications
	Storage                Storage
	LibP2P                 libp2p.Config
	Client                 client.Config
	TSS                    tss.Config
	Metrics                Metrics
	Diagnostics            Diagnostics
	Extensions             Extensions
}

Config is the top level config structure.

func ReadConfig 

func ReadConfig(filePath string) (*Config, error)

ReadConfig reads in the configuration file in .toml format. Ethereum key file password is expected to be provided as environment variable.

type Diagnostics added in v1.2.0 

type Diagnostics struct {
	Port int
}

Diagnostics stores diagnostics-related configuration.

type Extensions added in v1.5.0 

type Extensions struct {
	TBTC TBTC
}

Extensions stores app-specific extensions configuration.

type Metrics added in v1.2.0 

type Metrics struct {
	Port                int
	NetworkMetricsTick  int
	EthereumMetricsTick int
}

Metrics stores meta-info about metrics.

type SanctionedApplications 

type SanctionedApplications struct {
	AddressesStrings []string `toml:"Addresses"`
}

SanctionedApplications contains addresses of applications approved by the operator.

func (*SanctionedApplications) Addresses 

func (sa *SanctionedApplications) Addresses() ([]common.Address, error)

Addresses returns list of sanctioned applications as a slice of ethereum addresses.

type Storage 

type Storage struct {
	DataDir string
}

Storage stores meta-info about keeping data on disk

type TBTC added in v1.5.0 

type TBTC struct {
	TBTCSystem string
}

TBTC stores configuration of application extension responsible for executing signer actions specific for TBTC application.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.