config

Documentation

Overview

Package config contains all the config functions that is used by the bsp-agent node

Index

• func LookupEnvOrInt(key string, defaultVal int) int
• func LookupEnvOrInt64(key string, defaultVal int64) int64
• func LookupEnvOrString(key string, defaultVal string) string
• type AgentConfig
  • func NewAgentConfig() *AgentConfig
  • func (ac *AgentConfig) LoadConfig()
  • func (ac *AgentConfig) SegmentLength() int
• type ChainConfig
• type CodecConfig
• type EnvConfig
• type EthEnvConfig
• type IpfsEnvConfig
• type MetricsConfig
• type ProofchainConfig
• type RedisConfig
• type RedisEnvConfig
• type StorageConfig

Functions

func LookupEnvOrInt

func LookupEnvOrInt(key string, defaultVal int) int

LookupEnvOrInt looks up a flag env that is an integer and returns its value. If the environment variable is not set, it returns the default value.

func LookupEnvOrInt64

func LookupEnvOrInt64(key string, defaultVal int64) int64

LookupEnvOrInt64 looks up a flag env that is an integer and returns its value as int64. If the environment variable is not set, it returns the default value.

func LookupEnvOrString

func LookupEnvOrString(key string, defaultVal string) string

LookupEnvOrString looks up a flag env that is a string

Types

type AgentConfig

type AgentConfig struct {
	RedisConfig      RedisConfig
	CodecConfig      CodecConfig
	StorageConfig    StorageConfig
	ProofchainConfig ProofchainConfig
	ChainConfig      ChainConfig
	MetricsConfig    MetricsConfig

	LogFolder string
}

AgentConfig composes all configs into a single full (env and flags) config for the bsp-agent node

func NewAgentConfig

func NewAgentConfig() *AgentConfig

NewAgentConfig creates a new empty config

func (*AgentConfig) LoadConfig

func (ac *AgentConfig) LoadConfig()

LoadConfig gets the config from env flags and cli arguments

func (*AgentConfig) SegmentLength

func (ac *AgentConfig) SegmentLength() int

SegmentLength get number of block-specimens encoded within a block-replica

type ChainConfig

type ChainConfig struct {
	RPCURL       string
	PrivateKey   string
	KeystorePath string
	KeyStorePwd  string
}

ChainConfig contains config for all supported blockchains

type CodecConfig

type CodecConfig struct {
	AvroCodecPath string
}

CodecConfig contains all AVRO codec related config

type EnvConfig

type EnvConfig struct {
	IpfsConfig  IpfsEnvConfig
	RedisConfig RedisEnvConfig
	EthConfig   EthEnvConfig
}

EnvConfig composes all configs into a single env config for the bsp-agent node

type EthEnvConfig

type EthEnvConfig struct {
	RPCURL       string `envconfig:"MB_RPC_URL"`
	PrivateKey   string `envconfig:"MB_PRIVATE_KEY"`
	KeystorePath string `envconfig:"MB_KEYSTORE_PATH"`
	KeyStorePwd  string `envconfig:"MB_KEYSTORE_PWD"`
}

EthEnvConfig contains all config for ethereum / ethereum like (EVM) networks

type IpfsEnvConfig

type IpfsEnvConfig struct {
	IpfsPinnerServer string `envconfig:"IFPS_PINNER_SERVER" default:"http://127.0.0.1:3000"`
}

IpfsEnvConfig contains all config for IPFS pinning services

type MetricsConfig

type MetricsConfig struct {
	Enabled        bool
	HTTPServerAddr string
	HTTPServerPort string
}

MetricsConfig contains config for collecting performance metrics

type ProofchainConfig

type ProofchainConfig struct {
	ProofChainAddr string
}

ProofchainConfig contains all proof-chain configs

type RedisConfig

type RedisConfig struct {
	RedisURL               string
	Password               string
	BlockDivisor           int // can be set to any divisor (decrease specimen production throughput)
	ConsumerPendingTimeout int // defaults to 1 min
}

RedisConfig contains all redis related config

type RedisEnvConfig

type RedisEnvConfig struct {
	Password string `envconfig:"REDIS_PWD" default:""`
}

RedisEnvConfig contains all config for redis

type StorageConfig

type StorageConfig struct {
	// local
	BinaryFilePath string

	// ipfs
	IpfsPinnerServer string
}

StorageConfig contains all configs needed by different stores