config

package
v0.5.0-rc1 Latest Latest
Warning

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

 Go to latest Published: Feb 26, 2019 License: Apache-2.0 Imports: 13 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"
	// IndexTransfer is table identifier for transfer index in indexer
	IndexTransfer = "transfer"
	// IndexVote is table identifier for vote index in indexer
	IndexVote = "vote"
	// IndexExecution is table identifier for execution index in indexer
	IndexExecution = "execution"
	// IndexAction is table identifier for action index in indexer
	IndexAction = "action"
	// IndexReceipt is table identifier for receipt index in indexer
	IndexReceipt = "receipt"
)

Variables

View Source 
var (
	// Default is the default config
	Default = Config{
		Network: Network{
			Host:           "0.0.0.0",
			Port:           4689,
			ExternalHost:   "",
			ExternalPort:   4689,
			BootstrapNodes: make([]string, 0),
			MasterKey:      "",
		},
		Chain: Chain{
			ChainDBPath:                  "/tmp/chain.db",
			TrieDBPath:                   "/tmp/trie.db",
			ID:                           1,
			Address:                      "",
			ProducerPubKey:               keypair.EncodePublicKey(&PrivateKey.PublicKey),
			ProducerPrivKey:              keypair.EncodePrivateKey(PrivateKey),
			GenesisActionsPath:           "",
			EmptyGenesis:                 false,
			NumCandidates:                101,
			BeaconChainAPI:               "",
			BeaconChainDB:                DB{DbPath: "/tmp/poll.db", NumRetries: 10},
			EnableFallBackToFreshDB:      false,
			EnableSubChainStartInGenesis: false,
			EnableTrielessStateDB:        true,
			EnableIndex:                  false,
			EnableAsyncIndexWrite:        false,
			AllowedBlockGasResidue:       10000,
		},
		ActPool: ActPool{
			MaxNumActsPerPool: 32000,
			MaxNumActsPerAcct: 2000,
			MaxNumActsToPick:  0,
			ActionExpiry:      10 * time.Minute,
		},
		Consensus: Consensus{
			Scheme: StandaloneScheme,
			RollDPoS: RollDPoS{
				FSM: consensusfsm.Config{
					UnmatchedEventTTL:            3 * time.Second,
					UnmatchedEventInterval:       100 * time.Millisecond,
					AcceptBlockTTL:               4 * time.Second,
					AcceptProposalEndorsementTTL: 2 * time.Second,
					AcceptLockEndorsementTTL:     2 * time.Second,
					EventChanSize:                10000,
				},
				ToleratedOvertime: 2 * time.Second,
				Delay:             5 * time.Second,
			},
		},
		BlockSync: BlockSync{
			Interval:   10 * time.Second,
			BufferSize: 16,
		},
		Dispatcher: Dispatcher{
			EventChanSize: 10000,
		},
		Explorer: Explorer{
			Enabled:    false,
			UseIndexer: false,
			Port:       14004,
			TpsWindow:  10,
			GasStation: GasStation{
				SuggestBlockWindow: 20,
				DefaultGas:         1,
				Percentile:         60,
			},
			MaxTransferPayloadBytes: 1024,
		},
		API: API{
			Enabled:   false,
			UseRDS:    false,
			Port:      14014,
			TpsWindow: 10,
			GasStation: GasStation{
				SuggestBlockWindow: 20,
				DefaultGas:         1,
				Percentile:         60,
			},
			MaxTransferPayloadBytes: 1024,
		},
		Indexer: Indexer{
			Enabled:           false,
			NodeAddr:          "",
			WhetherLocalStore: true,
			BlockByIndexList:  []string{IndexTransfer, IndexVote, IndexExecution, IndexAction, IndexReceipt},
			IndexHistoryList:  []string{IndexTransfer, IndexVote, IndexExecution, IndexAction},
		},
		System: System{
			HeartbeatInterval:     10 * time.Second,
			HTTPProfilingPort:     0,
			HTTPMetricsPort:       8080,
			HTTPProbePort:         7788,
			StartSubChainInterval: 10 * time.Second,
		},
		DB: DB{
			UseBadgerDB: false,
			NumRetries:  3,
			SQLITE3: SQLITE3{
				SQLite3File: "./explorer.db",
			},
		},
		Genesis: genesis.Default,
	}

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

	// Validates is the collection config validation functions
	Validates = []Validate{
		ValidateKeyPair,
		ValidateRollDPoS,
		ValidateDispatcher,
		ValidateExplorer,
		ValidateAPI,
		ValidateActPool,
		ValidateChain,
	}

	// PrivateKey is a randomly generated producer's key for testing purpose
	PrivateKey, _ = crypto.GenerateKey()
)

Functions

func DoNotValidate added in v0.3.0 

func DoNotValidate(cfg Config) error

DoNotValidate validates the given config

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 ValidateChain added in v0.3.0 

func ValidateChain(cfg Config) error

ValidateChain validates the chain configure

func ValidateDispatcher added in v0.3.0 

func ValidateDispatcher(cfg Config) error

ValidateDispatcher validates the dispatcher configs

func ValidateExplorer added in v0.3.0 

func ValidateExplorer(cfg Config) error

ValidateExplorer validates the explorer configs

func ValidateKeyPair added in v0.4.0 

func ValidateKeyPair(cfg Config) error

ValidateKeyPair validates the block producer address

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 {
	Enabled    bool       `yaml:"enabled"`
	IsTest     bool       `yaml:"isTest"`
	UseRDS     bool       `yaml:"useRDS"`
	Port       int        `yaml:"port"`
	TpsWindow  int        `yaml:"tpsWindow"`
	GasStation GasStation `yaml:"gasStation"`
	// MaxTransferPayloadBytes limits how many bytes a playload can contain at most
	MaxTransferPayloadBytes uint64 `yaml:"maxTransferPayloadBytes"`
}

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"`
	// MaxNumActsPerAcct indicates maximum number of actions an account queue can hold
	MaxNumActsPerAcct uint64 `yaml:"maxNumActsPerAcct"`
	// MaxNumActsToPick indicates maximum number of actions to pick to mint a block. Default is 0, which means no
	// limit on the number of actions to pick.
	MaxNumActsToPick uint64 `yaml:"maxNumActsToPick"`
	// ActionExpiry defines how long an action will be kept in action pool.
	ActionExpiry time.Duration `yaml:"actionExpiry"`
}

ActPool is the actpool config

type BlockSync added in v0.2.0 

type BlockSync struct {
	Interval   time.Duration `yaml:"interval"` // update duration
	BufferSize uint64        `yaml:"bufferSize"`
}

BlockSync is the config struct for the BlockSync

type Chain 

type Chain struct {
	ChainDBPath                  string `yaml:"chainDBPath"`
	TrieDBPath                   string `yaml:"trieDBPath"`
	ID                           uint32 `yaml:"id"`
	Address                      string `yaml:"address"`
	ProducerPubKey               string `yaml:"producerPubKey"`
	ProducerPrivKey              string `yaml:"producerPrivKey"`
	GenesisActionsPath           string `yaml:"genesisActionsPath"`
	EmptyGenesis                 bool   `yaml:"emptyGenesis"`
	NumCandidates                uint   `yaml:"numCandidates"`
	BeaconChainAPI               string `yaml:"beaconChainAPI"`
	BeaconChainDB                DB     `yaml:"beaconChainDB"`
	EnableFallBackToFreshDB      bool   `yaml:"enableFallbackToFreshDb"`
	EnableSubChainStartInGenesis bool   `yaml:"enableSubChainStartInGenesis"`
	EnableTrielessStateDB        bool   `yaml:"enableTrielessStateDB"`
	// enable index the block actions and receipts
	EnableIndex bool `yaml:"enableIndex"`
	// enable writing the block actions' and receipts' index asynchronously
	EnableAsyncIndexWrite bool `yaml:"enableAsyncIndexWrite"`
	// AllowedBlockGasResidue is the amount of gas remained when block producer could stop processing more actions
	AllowedBlockGasResidue uint64 `yaml:"allowedBlockGasResidue"`
}

Chain is the config struct for blockchain package

type Config 

type Config struct {
	Network    Network          `yaml:"network"`
	Chain      Chain            `yaml:"chain"`
	ActPool    ActPool          `yaml:"actPool"`
	Consensus  Consensus        `yaml:"consensus"`
	BlockSync  BlockSync        `yaml:"blockSync"`
	Dispatcher Dispatcher       `yaml:"dispatcher"`
	Explorer   Explorer         `yaml:"explorer"`
	API        API              `yaml:"api"`
	Indexer    Indexer          `yaml:"indexer"`
	System     System           `yaml:"system"`
	DB         DB               `yaml:"db"`
	Log        log.GlobalConfig `yaml:"log"`
	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(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(validates ...Validate) (Config, error)

NewSub create config for sub chain.

func (Config) BlockchainAddress added in v0.4.0 

func (cfg Config) BlockchainAddress() (address.Address, error)

BlockchainAddress returns the address derived from the configured chain ID and public key

func (Config) KeyPair added in v0.4.0 

func (cfg Config) KeyPair() (keypair.PublicKey, keypair.PrivateKey, error)

KeyPair returns the decoded public and private key pair

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 DB added in v0.4.0 

type DB struct {
	DbPath string `yaml:"dbPath"`
	// Use BadgerDB, otherwise use BoltDB
	UseBadgerDB bool `yaml:"useBadgerDB"`
	// NumRetries is the number of retries
	NumRetries uint8 `yaml:"numRetries"`

	// RDS is the config for rds
	RDS RDS `yaml:"RDS"`

	// SQLite3 is the config for SQLITE3
	SQLITE3 SQLITE3 `yaml:"SQLITE3"`
}

DB is the config for database

type Dispatcher added in v0.2.0 

type Dispatcher struct {
	EventChanSize uint `yaml:"eventChanSize"`
}

Dispatcher is the dispatcher config

type Explorer added in v0.2.0 

type Explorer struct {
	Enabled    bool       `yaml:"enabled"`
	IsTest     bool       `yaml:"isTest"`
	UseIndexer bool       `yaml:"useIndexer"`
	Port       int        `yaml:"port"`
	TpsWindow  int        `yaml:"tpsWindow"`
	GasStation GasStation `yaml:"gasStation"`
	// MaxTransferPayloadBytes limits how many bytes a playload can contain at most
	MaxTransferPayloadBytes uint64 `yaml:"maxTransferPayloadBytes"`
}

Explorer is the explorer service config

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 {
	Enabled           bool   `yaml:"enabled"`
	NodeAddr          string `yaml:"nodeAddr"`
	WhetherLocalStore bool   `yaml:"whetherLocalStore"`
	// BlockByIndexList store list of BlockByIndex tables
	BlockByIndexList []string `yaml:"blockByIndexList"`
	// IndexHistoryList store list of IndexHistory tables
	IndexHistoryList []string `yaml:"indexHistoryList"`
}

Indexer is the index service config

type Network 

type Network struct {
	Host           string   `yaml:"host"`
	Port           int      `yaml:"port"`
	ExternalHost   string   `yaml:"externalHost"`
	ExternalPort   int      `yaml:"externalPort"`
	BootstrapNodes []string `yaml:"bootstrapNodes"`
	MasterKey      string   `yaml:"masterKey"` // master key will be PrivateKey if not set.
}

Network is the config struct for network package

type RDS added in v0.4.0 

type RDS struct {
	// AwsRDSEndpoint is the endpoint of aws rds
	AwsRDSEndpoint string `yaml:"awsRDSEndpoint"`
	// AwsRDSPort is the port of aws rds
	AwsRDSPort uint64 `yaml:"awsRDSPort"`
	// AwsRDSUser is the user to access aws rds
	AwsRDSUser string `yaml:"awsRDSUser"`
	// AwsPass is the pass to access aws rds
	AwsPass string `yaml:"awsPass"`
	// AwsDBName is the db name of aws rds
	AwsDBName string `yaml:"awsDBName"`
}

RDS is the cloud rds config

type RollDPoS added in v0.2.0 

type RollDPoS struct {
	FSM               consensusfsm.Config `yaml:"fsm"`
	ToleratedOvertime time.Duration       `yaml:"toleratedOvertime"`
	Delay             time.Duration       `yaml:"delay"`
}

RollDPoS is the config struct for RollDPoS consensus package

type SQLITE3 added in v0.4.4 

type SQLITE3 struct {
	// SQLite3File is the sqlite3 db file
	SQLite3File string `yaml:"sqlite3File"`
}

SQLITE3 is the local sqlite3 config

type System added in v0.2.0 

type System struct {
	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
	HTTPProfilingPort     int           `yaml:"httpProfilingPort"`
	HTTPMetricsPort       int           `yaml:"httpMetricsPort"`
	HTTPProbePort         int           `yaml:"httpProbePort"`
	StartSubChainInterval time.Duration `yaml:"startSubChainInterval"`
}

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.