config

Documentation

Index

• type AddressConfig
• type BloomFilterConfig
• type CacheConfig
• type Config
• type ConfigEconomics
• type ConfigPreferences
• type DBConfig
• type EconomicsAddresses
• type ElasticSearchConfig
• type EpochStartConfig
• type EvictionWaitingListConfig
• type ExplorerConfig
• type FacadeConfig
• type FeeSettings
• type GeneralSettingsConfig
• type HeadersPoolConfig
• type HeartbeatConfig
• type KadDhtPeerDiscoveryConfig
• type MarshalizerConfig
• type NTPConfig
• type NodeConfig
• type P2PConfig
• type PreferencesConfig
• type RatingSettings
• type RatingValue
• type ResourceStatsConfig
• type RewardsSettings
• type ServersConfig
• type StateTrieConfig
• type StorageConfig
• type StoragePruningConfig
• type TypeConfig
• type ValidatorSettings

Types

type AddressConfig

type AddressConfig struct {
	Length int    `json:"length"`
	Prefix string `json:"prefix"`
}

AddressConfig will map the json address configuration

type BloomFilterConfig

type BloomFilterConfig struct {
	Size     uint     `json:"size"`
	HashFunc []string `json:"hashFunc"`
}

BloomFilterConfig will map the json bloom filter configuration

type CacheConfig

type CacheConfig struct {
	Type        string `json:"type"`
	Size        uint32 `json:"size"`
	SizeInBytes uint32 `json:"sizeInBytes"`
	Shards      uint32 `json:"shards"`
}

CacheConfig will map the json cache configuration

type Config

type Config struct {
	MiniBlocksStorage          StorageConfig
	MiniBlockHeadersStorage    StorageConfig
	PeerBlockBodyStorage       StorageConfig
	BlockHeaderStorage         StorageConfig
	TxStorage                  StorageConfig
	UnsignedTransactionStorage StorageConfig
	RewardTxStorage            StorageConfig
	ShardHdrNonceHashStorage   StorageConfig
	MetaHdrNonceHashStorage    StorageConfig
	StatusMetricsStorage       StorageConfig

	BootstrapStorage StorageConfig
	MetaBlockStorage StorageConfig

	AccountsTrieStorage     StorageConfig
	PeerAccountsTrieStorage StorageConfig
	TrieSnapshotDB          DBConfig
	EvictionWaitingList     EvictionWaitingListConfig
	StateTrieConfig         StateTrieConfig
	BadBlocksCache          CacheConfig

	TxBlockBodyDataPool         CacheConfig
	PeerBlockBodyDataPool       CacheConfig
	TxDataPool                  CacheConfig
	UnsignedTransactionDataPool CacheConfig
	RewardTransactionDataPool   CacheConfig
	TrieNodesDataPool           CacheConfig
	EpochStartConfig            EpochStartConfig
	Address                     AddressConfig
	BLSPublicKey                AddressConfig
	Hasher                      TypeConfig
	MultisigHasher              TypeConfig
	Marshalizer                 MarshalizerConfig

	ResourceStats   ResourceStatsConfig
	Heartbeat       HeartbeatConfig
	GeneralSettings GeneralSettingsConfig
	Consensus       TypeConfig
	Explorer        ExplorerConfig
	StoragePruning  StoragePruningConfig

	NTPConfig         NTPConfig
	HeadersPoolConfig HeadersPoolConfig
}

Config will hold the entire application configuration parameters

type ConfigEconomics

type ConfigEconomics struct {
	EconomicsAddresses EconomicsAddresses
	RewardsSettings    RewardsSettings
	FeeSettings        FeeSettings
	ValidatorSettings  ValidatorSettings
	RatingSettings     RatingSettings
}

ConfigEconomics will hold economics config

type ConfigPreferences

type ConfigPreferences struct {
	Preferences PreferencesConfig
}

ConfigPreferences will hold the configuration related to node's preferences

type DBConfig

type DBConfig struct {
	FilePath          string `json:"file"`
	Type              string `json:"type"`
	BatchDelaySeconds int    `json:"batchDelaySeconds"`
	MaxBatchSize      int    `json:"maxBatchSize"`
	MaxOpenFiles      int    `json:"maxOpenFiles"`
}

DBConfig will map the json db configuration

type EconomicsAddresses

type EconomicsAddresses struct {
	CommunityAddress string
	BurnAddress      string
}

EconomicsAddresses will hold economics addresses

type ElasticSearchConfig

type ElasticSearchConfig struct {
	Username string
	Password string
}

ElasticSearchConfig will hold the configuration for the elastic search

type EpochStartConfig

type EpochStartConfig struct {
	MinRoundsBetweenEpochs int64
	RoundsPerEpoch         int64
}

EpochStartConfig will hold the configuration of EpochStart settings

type EvictionWaitingListConfig

type EvictionWaitingListConfig struct {
	Size uint     `json:"size"`
	DB   DBConfig `json:"db"`
}

EvictionWaitingListConfig will hold the configuration for the EvictionWaitingList

type ExplorerConfig

type ExplorerConfig struct {
	Enabled    bool
	IndexerURL string
}

ExplorerConfig will hold the configuration for the explorer indexer

type FacadeConfig

type FacadeConfig struct {
	RestApiInterface string
	PprofEnabled     bool
}

FacadeConfig will hold different configuration option that will be passed to the main ElrondFacade

type FeeSettings

type FeeSettings struct {
	MaxGasLimitPerBlock  string
	GasPerDataByte       string
	DataLimitForBaseCalc string
	MinGasPrice          string
	MinGasLimit          string
}

FeeSettings will hold economics fee settings

type GeneralSettingsConfig

type GeneralSettingsConfig struct {
	DestinationShardAsObserver string
	StatusPollingIntervalSec   int
	MaxComputableRounds        uint64
}

GeneralSettingsConfig will hold the general settings for a node

type HeadersPoolConfig

type HeadersPoolConfig struct {
	MaxHeadersPerShard            int
	NumElementsToRemoveOnEviction int
}

HeadersPoolConfig will map the headers cache configuration

type HeartbeatConfig

type HeartbeatConfig struct {
	Enabled                             bool
	MinTimeToWaitBetweenBroadcastsInSec int
	MaxTimeToWaitBetweenBroadcastsInSec int
	DurationInSecToConsiderUnresponsive int
	HeartbeatStorage                    StorageConfig
}

HeartbeatConfig will hold all heartbeat settings

type KadDhtPeerDiscoveryConfig

type KadDhtPeerDiscoveryConfig struct {
	Enabled                          bool
	RefreshIntervalInSec             uint32
	RandezVous                       string
	InitialPeerList                  []string
	BucketSize                       uint32
	RoutingTableRefreshIntervalInSec uint32
}

KadDhtPeerDiscoveryConfig will hold the kad-dht discovery config settings

type MarshalizerConfig

type MarshalizerConfig struct {
	Type           string `json:"type"`
	SizeCheckDelta uint32 `json:"sizeCheckDelta"`
}

MarshalizerConfig holds the marshalizer related configuration

type NTPConfig

type NTPConfig struct {
	Hosts               []string
	Port                int
	TimeoutMilliseconds int
	Version             int
}

NTPConfig will hold the configuration for NTP queries

type NodeConfig

type NodeConfig struct {
	Port            int
	Seed            string
	TargetPeerCount int
}

NodeConfig will hold basic p2p settings

type P2PConfig

type P2PConfig struct {
	Node                NodeConfig
	KadDhtPeerDiscovery KadDhtPeerDiscoveryConfig
}

P2PConfig will hold all the P2P settings

type PreferencesConfig

type PreferencesConfig struct {
	NodeDisplayName string
}

PreferencesConfig will hold the fields which are node specific such as the display name

type RatingSettings

type RatingSettings struct {
	StartRating                 uint32
	MaxRating                   uint32
	MinRating                   uint32
	ProposerIncreaseRatingStep  uint32
	ProposerDecreaseRatingStep  uint32
	ValidatorIncreaseRatingStep uint32
	ValidatorDecreaseRatingStep uint32
}

RatingSettings will hold rating settings

type RatingValue

type RatingValue struct {
	Name  string
	Value int32
}

RatingValue will hold different rating options with increase and decresea steps

type ResourceStatsConfig

type ResourceStatsConfig struct {
	Enabled              bool
	RefreshIntervalInSec int
}

ResourceStatsConfig will hold all resource stats settings

type RewardsSettings

type RewardsSettings struct {
	RewardsValue                   string
	CommunityPercentage            float64
	LeaderPercentage               float64
	BurnPercentage                 float64
	DenominationCoefficientForView string
}

RewardsSettings will hold economics rewards settings

type ServersConfig

type ServersConfig struct {
	ElasticSearch ElasticSearchConfig
}

ServersConfig will hold all the confidential settings for servers

type StateTrieConfig

type StateTrieConfig struct {
	RoundsModulus  uint
	PruningEnabled bool
}

StateTrieConfig will hold information about state trie

type StorageConfig

type StorageConfig struct {
	Cache CacheConfig       `json:"cache"`
	DB    DBConfig          `json:"db"`
	Bloom BloomFilterConfig `json:"bloom"`
}

StorageConfig will map the json storage unit configuration

type StoragePruningConfig

type StoragePruningConfig struct {
	Enabled             bool
	FullArchive         bool
	NumEpochsToKeep     uint64
	NumActivePersisters uint64
}

StoragePruningConfig will hold settings relates to storage pruning

type TypeConfig

type TypeConfig struct {
	Type string `json:"type"`
}

TypeConfig will map the json string type configuration

type ValidatorSettings

type ValidatorSettings struct {
	StakeValue    string
	UnBoundPeriod string
}

ValidatorSettings will hold the validator settings