config

Documentation

Index

• Constants
• Variables
• func SetVersions()
• type ChainConfig
• type CheckPoint
• type ConsensusConfig
• type DataDir
  • func NewDataDir(dirPath, network string) (dd *DataDir, err error)
  • func (d *DataDir) Init() error
  • func (d *DataDir) Load() (*EngineConfig, error)
  • func (d *DataDir) Path() string
• type EngineConfig
  • func LoadDataDir(dataDirPath, network string) (*EngineConfig, error)
  • func (c *EngineConfig) DataDir() string
  • func (c *EngineConfig) SetConfigDir(d string)
• type MinerConfig
• type PeerConfig
• type ProtocolVersions
• type RPCConfig
• type TxPoolConfig
• type VersionInfo

Constants

const (
	// ModeProd refers to production mode
	ModeProd = iota
	// ModeDev refers to development mode
	ModeDev
	// ModeTest refers to test mode
	ModeTest
)

const DefaultNetVersion = "0001"

DefaultNetVersion is the default network version used when no network version is provided.

Variables

var AccountDirName = "accounts"

AccountDirName is the name of the directory for storing accounts

Functions

func SetVersions

func SetVersions()

SetVersions sets the protocol handler version

Types

type ChainConfig

type ChainConfig struct {

	// Checkpoints includes a collection of points on the chain of
	// which blocks are supposed to exists after or before.
	Checkpoints []*CheckPoint `json:"checkpoints"`
}

ChainConfig includes parameters for the chain

type CheckPoint

type CheckPoint struct {
	Number uint64 `json:"number"`
	Hash   string `json:"hash"`
}

CheckPoint describes a point on the chain. We use it to prevent blocks dated far back in the history of the chain from causing a chain reorganization.

type ConsensusConfig

type ConsensusConfig struct {

	// MaxEndorsementPeriodInBlocks is the amount of blocks after ticket maturity an endorser can
	// continue to perform endorsement functions.
	MaxEndorsementPeriodInBlocks uint `json:"maxEndorsementPeriodInBlocks"`

	// NumBlocksForTicketMaturity is the number of blocks before an endorser ticket
	// is considered mature.
	NumBlocksForTicketMaturity uint `json:"numBlocksForTicketMaturity"`
}

ConsensusConfig defines configuration for consensus processes

type DataDir

type DataDir struct {
	// contains filtered or unexported fields
}

DataDir manages the client's data directory

func NewDataDir

func NewDataDir(dirPath, network string) (dd *DataDir, err error)

NewDataDir creates a new DataDir object

func (*DataDir) Init

func (d *DataDir) Init() error

Init creates required files and directories

func (*DataDir) Load

func (d *DataDir) Load() (*EngineConfig, error)

Load reads the content of the ellcrys.json file into Config struct

func (*DataDir) Path

func (d *DataDir) Path() string

Path returns the config path

type EngineConfig

type EngineConfig struct {

	// Node holds the node configurations
	Node *PeerConfig `json:"peer"`

	// TxPool holds transaction pool configurations
	TxPool *TxPoolConfig `json:"txPool"`

	// Consensus holds consensus related configurations
	Consensus *ConsensusConfig `json:"consensus"`

	// Chain holds blockchain related configurations
	Chain *ChainConfig `json:"chain"`

	// Miner holds mining configurations
	Miner *MinerConfig `json:"mining"`

	// RPC holds rpc configurations
	RPC *RPCConfig `json:"rpc"`

	// VersionInfo holds version information
	VersionInfo *VersionInfo `json:"-"`
	// contains filtered or unexported fields
}

EngineConfig represents the client's configuration

func LoadDataDir

func LoadDataDir(dataDirPath, network string) (*EngineConfig, error)

LoadDataDir loads a data directory and returns the engine configuration

func (*EngineConfig) DataDir

func (c *EngineConfig) DataDir() string

DataDir returns the config directory

func (*EngineConfig) SetConfigDir

func (c *EngineConfig) SetConfigDir(d string)

SetConfigDir sets the config directory

type MinerConfig

type MinerConfig struct {

	// Mode describes the mining mode
	Mode uint `json:"-"`
}

MinerConfig defines configuration for mining

type PeerConfig

type PeerConfig struct {

	// BootstrapAddresses sets addresses to connect to
	BootstrapAddresses []string `json:"addresses"`

	// Mode determines the current environment type
	Mode int `json:"mode"`

	// GetAddrInterval is the interval between GetAddr messages
	GetAddrInterval int64 `json:"getAddrInt"`

	// PingInterval is the interval between Ping messages
	PingInterval int64 `json:"pingInt"`

	// SelfAdvInterval is the interval self advertisement messages
	SelfAdvInterval int64 `json:"selfAdvInt"`

	// CleanUpInterval is the interval between address clean ups
	CleanUpInterval int64 `json:"cleanUpInt"`

	// MaxAddrsExpected is the maximum number addresses
	// expected from a remote peer
	MaxAddrsExpected int64 `json:"maxAddrsExpected"`

	// MaxOutboundConnections is the maximum number of outbound
	// connections the node is allowed
	MaxOutboundConnections int64 `json:"maxOutConnections"`

	// MaxOutboundConnections is the maximum number of inbound
	// connections the node is allowed
	MaxInboundConnections int64 `json:"maxInConnections"`

	// ConnEstInterval is the time interval when the node
	ConnEstInterval int64 `json:"conEstInt"`

	// MessageTimeout is the number of seconds to attempt to
	// connect to or read from a peer.
	MessageTimeout int64 `json:"messageTimeout"`
}

PeerConfig represents peer configuration

type ProtocolVersions

type ProtocolVersions struct {

	// Protocol is the network version supported by this client
	Protocol string

	// Handshake is the message version for handling wire.Handshake
	Handshake string

	// Ping is the version for handling wire.Ping messages
	Ping string

	// GetAddr is the message version for handling wire.GetAddr messages
	GetAddr string

	// Addr is the message version for handling wire.Addr messages
	Addr string

	// Intro is the message version for handling wire.Intro messages
	Intro string

	// Tx is the message version for handing wire.Transaction messages
	Tx string

	// BlockBody is the message version for handling wire.BlockBody messages
	BlockBody string

	// GetBlockHashes is the message version for handling wire.BlockHashes messages
	GetBlockHashes string

	// RequestBlock is the message version for handling wire.RequestBlock messages
	RequestBlock string

	// GetBlockBodies is the message version for handling wire.GetBlockBodies messages
	GetBlockBodies string
}

ProtocolVersions hold protocol message handler versions

var (
	// Versions contains protocol handlers versions information
	Versions *ProtocolVersions
)

type RPCConfig

type RPCConfig struct {

	// DisableAuth determines whether to
	// perform authentication for requests
	// attempting to invoke private methods.
	DisableAuth bool `json:"disableAuth"`

	// Username is the RPC username
	Username string `json:"username"`

	// Password is the RPC password
	Password string `json:"password"`

	// SessionSecretKey is the key used to sign the
	// session tokens. Must be kept secret.
	SessionSecretKey string `json:"sessionSecretKey"`
}

RPCConfig defines configuration for the RPC component

type TxPoolConfig

type TxPoolConfig struct {

	// Capacity is the maximum amount of item the transaction pool can hold
	Capacity int64 `json:"cap"`
}

TxPoolConfig defines configuration for the transaction pool

type VersionInfo

type VersionInfo struct {
	BuildVersion string
	BuildCommit  string
	BuildDate    string
	GoVersion    string
}

VersionInfo describes the clients components and runtime version information