config

package
v1.7.1-rc0 Latest Latest
Warning

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

 Go to latest Published: Mar 22, 2022 License: Apache-2.0 Imports: 20 Imported by: 44

Documentation

Index

Constants

View Source 
const (
	// RollDPoSScheme means randomized delegated proof of stake
	RollDPoSScheme = "ROLLDPOS"
	// StandaloneScheme means that the node creates a block periodically regardless of others (if there is any)
	StandaloneScheme = "STANDALONE"
	// NOOPScheme means that the node does not create only block
	NOOPScheme = "NOOP"
)
View Source 
const (
	SigP256k1  = "secp256k1"
	SigP256sm2 = "p256sm2"
)

Dardanelles consensus config

View Source 
const (
	// GatewayPlugin is the plugin of accepting user API requests and serving blockchain data to users
	GatewayPlugin = iota
)

Variables

View Source 
var (
	// Default is the default config
	Default = Config{
		Plugins: make(map[int]interface{}),
		SubLogs: make(map[string]log.GlobalConfig),
		Network: p2p.DefaultConfig,
		Chain: Chain{
			ChainDBPath:            "/var/data/chain.db",
			TrieDBPatchFile:        "/var/data/trie.db.patch",
			TrieDBPath:             "/var/data/trie.db",
			IndexDBPath:            "/var/data/index.db",
			BloomfilterIndexDBPath: "/var/data/bloomfilter.index.db",
			CandidateIndexDBPath:   "/var/data/candidate.index.db",
			StakingIndexDBPath:     "/var/data/staking.index.db",
			ID:                     1,
			EVMNetworkID:           4689,
			Address:                "",
			ProducerPrivKey:        generateRandomKey(SigP256k1),
			SignatureScheme:        []string{SigP256k1},
			EmptyGenesis:           false,
			GravityChainDB:         db.Config{DbPath: "/var/data/poll.db", NumRetries: 10},
			Committee: committee.Config{
				GravityChainAPIs: []string{},
			},
			EnableTrielessStateDB:         true,
			EnableStateDBCaching:          false,
			EnableArchiveMode:             false,
			EnableAsyncIndexWrite:         true,
			EnableSystemLogIndexer:        false,
			EnableStakingProtocol:         true,
			EnableStakingIndexer:          false,
			CompressBlock:                 false,
			AllowedBlockGasResidue:        10000,
			MaxCacheSize:                  0,
			PollInitialCandidatesInterval: 10 * time.Second,
			StateDBCacheSize:              1000,
			WorkingSetCacheSize:           20,
		},
		ActPool: ActPool{
			MaxNumActsPerPool:  32000,
			MaxGasLimitPerPool: 320000000,
			MaxNumActsPerAcct:  2000,
			ActionExpiry:       10 * time.Minute,
			MinGasPriceStr:     big.NewInt(unit.Qev).String(),
			BlackList:          []string{},
		},
		Consensus: Consensus{
			Scheme: StandaloneScheme,
			RollDPoS: RollDPoS{
				FSM: ConsensusTiming{
					UnmatchedEventTTL:            3 * time.Second,
					UnmatchedEventInterval:       100 * time.Millisecond,
					AcceptBlockTTL:               4 * time.Second,
					AcceptProposalEndorsementTTL: 2 * time.Second,
					AcceptLockEndorsementTTL:     2 * time.Second,
					CommitTTL:                    2 * time.Second,
					EventChanSize:                10000,
				},
				ToleratedOvertime: 2 * time.Second,
				Delay:             5 * time.Second,
				ConsensusDBPath:   "/var/data/consensus.db",
			},
		},
		DardanellesUpgrade: DardanellesUpgrade{
			UnmatchedEventTTL:            2 * time.Second,
			UnmatchedEventInterval:       100 * time.Millisecond,
			AcceptBlockTTL:               2 * time.Second,
			AcceptProposalEndorsementTTL: time.Second,
			AcceptLockEndorsementTTL:     time.Second,
			CommitTTL:                    time.Second,
			BlockInterval:                5 * time.Second,
			Delay:                        2 * time.Second,
		},
		BlockSync: BlockSync{
			Interval:              30 * time.Second,
			ProcessSyncRequestTTL: 10 * time.Second,
			BufferSize:            200,
			IntervalSize:          20,
			MaxRepeat:             3,
			RepeatDecayStep:       1,
		},
		Dispatcher: dispatcher.DefaultConfig,
		API: API{
			UseRDS:    false,
			Port:      14014,
			Web3Port:  15014,
			TpsWindow: 10,
			GasStation: GasStation{
				SuggestBlockWindow: 20,
				DefaultGas:         uint64(unit.Qev),
				Percentile:         60,
			},
			RangeQueryLimit: 1000,
		},
		System: System{
			Active:                true,
			HeartbeatInterval:     10 * time.Second,
			HTTPStatsPort:         8080,
			HTTPAdminPort:         9009,
			StartSubChainInterval: 10 * time.Second,
			SystemLogDBPath:       "/var/data/systemlog.db",
		},
		DB: db.Config{
			NumRetries:            3,
			MaxCacheSize:          64,
			BlockStoreBatchSize:   16,
			V2BlocksToSplitDB:     1000000,
			Compressor:            "Snappy",
			CompressLegacy:        false,
			SplitDBSizeMB:         0,
			SplitDBHeight:         900000,
			HistoryStateRetention: 2000,
		},
		Indexer: Indexer{
			RangeBloomFilterNumElements: 100000,
			RangeBloomFilterSize:        1200000,
			RangeBloomFilterNumHash:     8,
		},
		Genesis: genesis.Default,
	}

	// ErrInvalidCfg indicates the invalid config value
	ErrInvalidCfg = errors.New("invalid config value")

	// Validates is the collection config validation functions
	Validates = []Validate{
		ValidateRollDPoS,
		ValidateArchiveMode,
		ValidateDispatcher,
		ValidateAPI,
		ValidateActPool,
		ValidateForkHeights,
	}
)

Functions

func DoNotValidate added in v0.3.0 

func DoNotValidate(cfg Config) error

DoNotValidate validates the given config

func EVMNetworkID added in v1.2.0 

func EVMNetworkID() uint32

EVMNetworkID returns the extern chain ID

func SetEVMNetworkID added in v1.2.0 

func SetEVMNetworkID(id uint32)

SetEVMNetworkID sets the extern chain ID

func ValidateAPI added in v0.5.0 

func ValidateAPI(cfg Config) error

ValidateAPI validates the api configs

func ValidateActPool added in v0.3.0 

func ValidateActPool(cfg Config) error

ValidateActPool validates the given config

func ValidateArchiveMode added in v0.11.0 

func ValidateArchiveMode(cfg Config) error

ValidateArchiveMode validates the state factory setting

func ValidateDispatcher added in v0.3.0 

func ValidateDispatcher(cfg Config) error

ValidateDispatcher validates the dispatcher configs

func ValidateForkHeights added in v1.1.0 

func ValidateForkHeights(cfg Config) error

ValidateForkHeights validates the forked heights

func ValidateRollDPoS added in v0.3.0 

func ValidateRollDPoS(cfg Config) error

ValidateRollDPoS validates the roll-DPoS configs

Types

type API added in v0.5.0 

type API struct {
	UseRDS          bool          `yaml:"useRDS"`
	Port            int           `yaml:"port"`
	Web3Port        int           `yaml:"web3port"`
	RedisCacheURL   string        `yaml:"redisCacheURL"`
	TpsWindow       int           `yaml:"tpsWindow"`
	GasStation      GasStation    `yaml:"gasStation"`
	RangeQueryLimit uint64        `yaml:"rangeQueryLimit"`
	Tracer          tracer.Config `yaml:"tracer"`
}

API is the api service config

type ActPool added in v0.3.0 

type ActPool struct {
	// MaxNumActsPerPool indicates maximum number of actions the whole actpool can hold
	MaxNumActsPerPool uint64 `yaml:"maxNumActsPerPool"`
	// MaxGasLimitPerPool indicates maximum gas limit the whole actpool can hold
	MaxGasLimitPerPool uint64 `yaml:"maxGasLimitPerPool"`
	// MaxNumActsPerAcct indicates maximum number of actions an account queue can hold
	MaxNumActsPerAcct uint64 `yaml:"maxNumActsPerAcct"`
	// ActionExpiry defines how long an action will be kept in action pool.
	ActionExpiry time.Duration `yaml:"actionExpiry"`
	// MinGasPriceStr defines the minimal gas price the delegate will accept for an action
	MinGasPriceStr string `yaml:"minGasPrice"`
	// BlackList lists the account address that are banned from initiating actions
	BlackList []string `yaml:"blackList"`
}

ActPool is the actpool config

func (ActPool) MinGasPrice added in v0.5.0 

func (ap ActPool) MinGasPrice() *big.Int

MinGasPrice returns the minimal gas price threshold

type BlockSync added in v0.2.0 

type BlockSync struct {
	Interval              time.Duration `yaml:"interval"` // update duration
	ProcessSyncRequestTTL time.Duration `yaml:"processSyncRequestTTL"`
	BufferSize            uint64        `yaml:"bufferSize"`
	IntervalSize          uint64        `yaml:"intervalSize"`
	// MaxRepeat is the maximal number of repeat of a block sync request
	MaxRepeat int `yaml:"maxRepeat"`
	// RepeatDecayStep is the step for repeat number decreasing by 1
	RepeatDecayStep int `yaml:"repeatDecayStep"`
}

BlockSync is the config struct for the BlockSync

type Chain 

type Chain struct {
	ChainDBPath            string           `yaml:"chainDBPath"`
	TrieDBPatchFile        string           `yaml:"trieDBPatchFile"`
	TrieDBPath             string           `yaml:"trieDBPath"`
	IndexDBPath            string           `yaml:"indexDBPath"`
	BloomfilterIndexDBPath string           `yaml:"bloomfilterIndexDBPath"`
	CandidateIndexDBPath   string           `yaml:"candidateIndexDBPath"`
	StakingIndexDBPath     string           `yaml:"stakingIndexDBPath"`
	ID                     uint32           `yaml:"id"`
	EVMNetworkID           uint32           `yaml:"evmNetworkID"`
	Address                string           `yaml:"address"`
	ProducerPrivKey        string           `yaml:"producerPrivKey"`
	SignatureScheme        []string         `yaml:"signatureScheme"`
	EmptyGenesis           bool             `yaml:"emptyGenesis"`
	GravityChainDB         db.Config        `yaml:"gravityChainDB"`
	Committee              committee.Config `yaml:"committee"`

	EnableTrielessStateDB bool `yaml:"enableTrielessStateDB"`
	// EnableStateDBCaching enables cachedStateDBOption
	EnableStateDBCaching bool `yaml:"enableStateDBCaching"`
	// EnableArchiveMode is only meaningful when EnableTrielessStateDB is false
	EnableArchiveMode bool `yaml:"enableArchiveMode"`
	// EnableAsyncIndexWrite enables writing the block actions' and receipts' index asynchronously
	EnableAsyncIndexWrite bool `yaml:"enableAsyncIndexWrite"`
	// deprecated
	EnableSystemLogIndexer bool `yaml:"enableSystemLog"`
	// EnableStakingProtocol enables staking protocol
	EnableStakingProtocol bool `yaml:"enableStakingProtocol"`
	// EnableStakingIndexer enables staking indexer
	EnableStakingIndexer bool `yaml:"enableStakingIndexer"`
	// deprecated by DB.CompressBlock
	CompressBlock bool `yaml:"compressBlock"`
	// AllowedBlockGasResidue is the amount of gas remained when block producer could stop processing more actions
	AllowedBlockGasResidue uint64 `yaml:"allowedBlockGasResidue"`
	// MaxCacheSize is the max number of blocks that will be put into an LRU cache. 0 means disabled
	MaxCacheSize int `yaml:"maxCacheSize"`
	// PollInitialCandidatesInterval is the config for committee init db
	PollInitialCandidatesInterval time.Duration `yaml:"pollInitialCandidatesInterval"`
	// StateDBCacheSize is the max size of statedb LRU cache
	StateDBCacheSize int `yaml:"stateDBCacheSize"`
	// WorkingSetCacheSize is the max size of workingset cache in state factory
	WorkingSetCacheSize uint64 `yaml:"workingSetCacheSize"`
}

Chain is the config struct for blockchain package

type Config 

type Config struct {
	Plugins            map[int]interface{}         `ymal:"plugins"`
	Network            p2p.Network                 `yaml:"network"`
	Chain              Chain                       `yaml:"chain"`
	ActPool            ActPool                     `yaml:"actPool"`
	Consensus          Consensus                   `yaml:"consensus"`
	DardanellesUpgrade DardanellesUpgrade          `yaml:"dardanellesUpgrade"`
	BlockSync          BlockSync                   `yaml:"blockSync"`
	Dispatcher         dispatcher.Config           `yaml:"dispatcher"`
	API                API                         `yaml:"api"`
	System             System                      `yaml:"system"`
	DB                 db.Config                   `yaml:"db"`
	Indexer            Indexer                     `yaml:"indexer"`
	Log                log.GlobalConfig            `yaml:"log"`
	SubLogs            map[string]log.GlobalConfig `yaml:"subLogs"`
	Genesis            genesis.Genesis             `yaml:"genesis"`
}

Config is the root config struct, each package's config should be put as its sub struct

func New added in v0.3.0 

func New(configPaths []string, _plugins []string, validates ...Validate) (Config, error)

New creates a config instance. It first loads the default configs. If the config path is not empty, it will read from the file and override the default configs. By default, it will apply all validation functions. To bypass validation, use DoNotValidate instead.

func NewSub added in v0.4.0 

func NewSub(configPaths []string, validates ...Validate) (Config, error)

NewSub create config for sub chain.

func (Config) ProducerAddress added in v0.5.0 

func (cfg Config) ProducerAddress() address.Address

ProducerAddress returns the configured producer address derived from key

func (Config) ProducerPrivateKey added in v0.5.0 

func (cfg Config) ProducerPrivateKey() crypto.PrivateKey

ProducerPrivateKey returns the configured private key

type Consensus 

type Consensus struct {
	// There are three schemes that are supported
	Scheme   string   `yaml:"scheme"`
	RollDPoS RollDPoS `yaml:"rollDPoS"`
}

Consensus is the config struct for consensus package

type ConsensusTiming added in v0.10.0 

type ConsensusTiming struct {
	EventChanSize                uint          `yaml:"eventChanSize"`
	UnmatchedEventTTL            time.Duration `yaml:"unmatchedEventTTL"`
	UnmatchedEventInterval       time.Duration `yaml:"unmatchedEventInterval"`
	AcceptBlockTTL               time.Duration `yaml:"acceptBlockTTL"`
	AcceptProposalEndorsementTTL time.Duration `yaml:"acceptProposalEndorsementTTL"`
	AcceptLockEndorsementTTL     time.Duration `yaml:"acceptLockEndorsementTTL"`
	CommitTTL                    time.Duration `yaml:"commitTTL"`
}

ConsensusTiming defines a set of time durations used in fsm and event queue size

type DardanellesUpgrade added in v1.2.1 

type DardanellesUpgrade struct {
	UnmatchedEventTTL            time.Duration `yaml:"unmatchedEventTTL"`
	UnmatchedEventInterval       time.Duration `yaml:"unmatchedEventInterval"`
	AcceptBlockTTL               time.Duration `yaml:"acceptBlockTTL"`
	AcceptProposalEndorsementTTL time.Duration `yaml:"acceptProposalEndorsementTTL"`
	AcceptLockEndorsementTTL     time.Duration `yaml:"acceptLockEndorsementTTL"`
	CommitTTL                    time.Duration `yaml:"commitTTL"`
	BlockInterval                time.Duration `yaml:"blockInterval"`
	Delay                        time.Duration `yaml:"delay"`
}

DardanellesUpgrade is the config for dardanelles upgrade

type GasStation added in v0.4.4 

type GasStation struct {
	SuggestBlockWindow int    `yaml:"suggestBlockWindow"`
	DefaultGas         uint64 `yaml:"defaultGas"`
	Percentile         int    `yaml:"Percentile"`
}

GasStation is the gas station config

type Indexer added in v0.4.0 

type Indexer struct {
	// RangeBloomFilterNumElements is the number of elements each rangeBloomfilter will store in bloomfilterIndexer
	RangeBloomFilterNumElements uint64 `yaml:"rangeBloomFilterNumElements"`
	// RangeBloomFilterSize is the size (in bits) of rangeBloomfilter
	RangeBloomFilterSize uint64 `yaml:"rangeBloomFilterSize"`
	// RangeBloomFilterNumHash is the number of hash functions of rangeBloomfilter
	RangeBloomFilterNumHash uint64 `yaml:"rangeBloomFilterNumHash"`
}

Indexer is the config for indexer

type RollDPoS added in v0.2.0 

type RollDPoS struct {
	FSM               ConsensusTiming `yaml:"fsm"`
	ToleratedOvertime time.Duration   `yaml:"toleratedOvertime"`
	Delay             time.Duration   `yaml:"delay"`
	ConsensusDBPath   string          `yaml:"consensusDBPath"`
}

RollDPoS is the config struct for RollDPoS consensus package

type System added in v0.2.0 

type System struct {
	// Active is the status of the node. True means active and false means stand-by
	Active            bool          `yaml:"active"`
	HeartbeatInterval time.Duration `yaml:"heartbeatInterval"`
	// HTTPProfilingPort is the port number to access golang performance profiling data of a blockchain node. It is
	// 0 by default, meaning performance profiling has been disabled
	HTTPAdminPort         int           `yaml:"httpAdminPort"`
	HTTPStatsPort         int           `yaml:"httpStatsPort"`
	StartSubChainInterval time.Duration `yaml:"startSubChainInterval"`
	SystemLogDBPath       string        `yaml:"systemLogDBPath"`
}

System is the system config

type Validate added in v0.3.0 

type Validate func(Config) error

Validate is the interface of validating the config

Source Files

View all Source files

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.