nodeconfig

Documentation

Index

• Constants
• Variables
• type Config
• type NetworkID
• type SwarmConfig
• type TimeConfig

Constants

const (
	ClientVersion      = "go-spacemesh-node/0.0.1"
	MinClientVersion   = "0.0.1"
	NodesDirectoryName = "nodes"
	NodeDataFileName   = "id.json"
	NodeDbFileName     = "node.db"
)

params are non-configurable (hard-coded) consts. To create a configurable param use Config. add all node params here (non-configurable consts) - ideally most node params should be configurable.

Variables

var (
	// KSecurityFlag is the security param to start the app with.
	KSecurityFlag = altsrc.NewIntFlag(cli.IntFlag{
		Name:  "security-param",
		Usage: "Consensus protocol k security param",

		Value:       ConfigValues.SecurityParam,
		Destination: &ConfigValues.SecurityParam,
	})

	// LocalTCPPortFlag is the local tcp port that the app will listen to.
	LocalTCPPortFlag = altsrc.NewIntFlag(cli.IntFlag{
		Name:        "tcp-port",
		Usage:       "tcp port to listen on",
		Value:       ConfigValues.TCPPort,
		Destination: &ConfigValues.TCPPort,
	})

	// NetworkDialTimeout is the dial timeout for the node.
	NetworkDialTimeout = altsrc.NewStringFlag(cli.StringFlag{
		Name:        "dial-timeout",
		Usage:       "network dial timeout duration",
		Value:       ConfigValues.DialTimeout.string,
		Destination: &ConfigValues.DialTimeout.string,
	})

	// NetworkConnKeepAlive is the time that we'll keep alive the connection.
	NetworkConnKeepAlive = altsrc.NewStringFlag(cli.StringFlag{
		Name:        "conn-keepalive",
		Usage:       "Network connection keep alive",
		Value:       ConfigValues.ConnKeepAlive.string,
		Destination: &ConfigValues.ConnKeepAlive.string,
	})

	// NetworkIDFlag is a flag that holds the network id the node will run on.
	NetworkIDFlag = altsrc.NewIntFlag(cli.IntFlag{
		Name:        "network-id",
		Usage:       "NetworkID to run on (0 - mainnet, 1 - testnet)",
		Value:       ConfigValues.NetworkID,
		Destination: &ConfigValues.NetworkID,
	})

	// NodeIDFlag is holding our node id.
	NodeIDFlag = altsrc.NewStringFlag(cli.StringFlag{
		Name:        "node-id",
		Usage:       "Load node data by id (pub key) from local store",
		Value:       ConfigValues.NodeID,
		Destination: &ConfigValues.NodeID,
	})

	// SwarmBootstrap is flag to bootstrap the swarm.
	SwarmBootstrap = altsrc.NewBoolFlag(cli.BoolFlag{
		Name:        "swarm-bootstrap",
		Usage:       "Bootstrap the swarm",
		Destination: &SwarmConfigValues.Bootstrap,
	})

	// RoutingTableBucketSizdFlag will determine the swarm rounding table bucket size.
	RoutingTableBucketSizdFlag = altsrc.NewIntFlag(cli.IntFlag{
		Name:        "swarm-rtbs",
		Usage:       "The rounding table bucket size",
		Value:       SwarmConfigValues.RoutingTableBucketSize,
		Destination: &SwarmConfigValues.RoutingTableBucketSize,
	})

	// RoutingTableAlphaFlag will determine the swarm table routing alpha.
	RoutingTableAlphaFlag = altsrc.NewIntFlag(cli.IntFlag{
		Name:        "swarm-rtalpha",
		Usage:       "The rounding table Alpha",
		Value:       SwarmConfigValues.RoutingTableAlpha,
		Destination: &SwarmConfigValues.RoutingTableAlpha,
	})

	// RandomConnectionsFlag will determine how much random connection the swarm have.
	RandomConnectionsFlag = altsrc.NewIntFlag(cli.IntFlag{
		Name:        "swarm-randcon",
		Usage:       "Number of random connections",
		Value:       SwarmConfigValues.RandomConnections,
		Destination: &SwarmConfigValues.RandomConnections,
	})

	// BootstrapNodesFlag holds an array of nodes the will be use to bootstrap the spacemesh node.
	BootstrapNodesFlag = altsrc.NewStringSliceFlag(cli.StringSliceFlag{
		Name:  "swarm-bootstrap-nodes",
		Usage: "Foundation nodes to bootstrap spacemesh",
		Value: &SwarmConfigValues.BootstrapNodes,
	})

	// MaxAllowedDriftFlag holds the time to allow the node to be off sync with ntp clock before abortion.
	MaxAllowedDriftFlag = altsrc.NewStringFlag(cli.StringFlag{
		Name:        "max-allowed-time-drift",
		Usage:       "When to close the app until user resolves time sync problems",
		Value:       TimeConfigValues.MaxAllowedDrift.string,
		Destination: &TimeConfigValues.MaxAllowedDrift.string,
	})

	// NtpQueriesFlag holds the number of ntp servers to query for information.
	NtpQueriesFlag = altsrc.NewIntFlag(cli.IntFlag{
		Name:        "ntp-queries",
		Usage:       "How much ntp servers to query",
		Value:       TimeConfigValues.NtpQueries,
		Destination: &TimeConfigValues.NtpQueries,
	})

	// DefaultTimeoutLatencyFlag holds the timeout we allow to ntp requests.
	DefaultTimeoutLatencyFlag = altsrc.NewStringFlag(cli.StringFlag{
		Name:        "default-timeout-latency",
		Usage:       "Timeout to ntp requests",
		Value:       TimeConfigValues.DefaultTimeoutLatency.string,
		Destination: &TimeConfigValues.DefaultTimeoutLatency.string,
	})

	// RefreshNtpIntervalFlag holds a duration to wait before each time sync refresh.
	RefreshNtpIntervalFlag = altsrc.NewStringFlag(cli.StringFlag{
		Name:        "refresh-ntp-interval",
		Usage:       "How much time to wait between ntp sync requests",
		Value:       TimeConfigValues.RefreshNtpInterval.string,
		Destination: &TimeConfigValues.RefreshNtpInterval.string,
	})
)

var ConfigValues = Config{
	SecurityParam: 20,
	FastSync:      true,
	TCPPort:       7513,
	NodeID:        "",
	DialTimeout:   duration{"1m"},
	ConnKeepAlive: duration{"48h"},
	NetworkID:     int(TestNet),
	SwarmConfig:   SwarmConfigValues,
	TimeConfig:    TimeConfigValues,
}

ConfigValues specifies default values for node config params.

var SwarmConfigValues = SwarmConfig{
	Bootstrap:              false,
	RoutingTableBucketSize: 20,
	RoutingTableAlpha:      3,
	RandomConnections:      5,
	BootstrapNodes: cli.StringSlice{
		"125.0.0.1:3572/iaMujEYTByKcjMZWMqg79eJBGMDm8ADsWZFdouhpfeKj",
		"125.0.0.1:3763/x34UDdiCBAsXmLyMMpPQzs313B9UDeHNqFpYsLGfaFvm",
	},
}

SwarmConfigValues defines default values for swarm config params.

var TimeConfigValues = TimeConfig{
	MaxAllowedDrift:       duration{"10s"},
	NtpQueries:            5,
	DefaultTimeoutLatency: duration{"10s"},
	RefreshNtpInterval:    duration{"30m"},
}

TimeConfigValues defines default values for all time and ntp related params.

Types

type Config

type Config struct {
	SecurityParam int
	FastSync      bool
	TCPPort       int
	NodeID        string
	DialTimeout   duration
	ConnKeepAlive duration
	NetworkID     int
	SwarmConfig   SwarmConfig
	TimeConfig    TimeConfig
}

Config specifies node config params.

type NetworkID

type NetworkID int32

NetworkID represents the network that the node lives in that indicates what nodes it can communicate with, and which bootstrap nodes to use

const (
	MainNet NetworkID = iota
	TestNet
)

NetworkID

type SwarmConfig

type SwarmConfig struct {
	Bootstrap              bool
	RoutingTableBucketSize int
	RoutingTableAlpha      int
	RandomConnections      int
	BootstrapNodes         cli.StringSlice
}

SwarmConfig specifies swarm config params.

type TimeConfig

type TimeConfig struct {
	MaxAllowedDrift       duration
	NtpQueries            int
	DefaultTimeoutLatency duration
	RefreshNtpInterval    duration
}

TimeConfig specifies the timesync params for ntp.