node

Documentation

Overview

Copyright (c) 2020 The JaxNetwork developers Use of this source code is governed by an ISC license that can be found in the LICENSE file.

Index

• func Controller(logger zerolog.Logger) *chainController
• type BeaconCtl
  • func NewBeaconCtl(ctx context.Context, logger zerolog.Logger, cfg *Config) BeaconCtl
  • func (beaconCtl *BeaconCtl) ChainCtx() chain.IChainCtx
  • func (beaconCtl *BeaconCtl) ChainProvider() *cprovider.ChainProvider
  • func (beaconCtl *BeaconCtl) Init() error
  • func (beaconCtl *BeaconCtl) Run(ctx context.Context)
  • func (beaconCtl *BeaconCtl) Stats() map[string]float64
• type Config
• type DBCtl
• type IMetric
  • func ChainMetrics(chain statsProvider, logger zerolog.Logger) (res IMetric)
  • func NodeMetrics(cfg *Config, stats nodeStatsProvider, logger zerolog.Logger) (res IMetric)
• type IMetricManager
  • func Metrics(ctx context.Context, interval time.Duration) IMetricManager
• type Index
  • func (index *Index) AddShard(block *jaxutil.Block, opts p2p.ListenOpts) uint32
• type MetricsConfig
• type NodeConfig
  • func (cfg *NodeConfig) ChainParams() *chaincfg.Params
• type ShardConfig
• type ShardCtl
  • func NewShardCtl(ctx context.Context, log zerolog.Logger, cfg *Config, chain chain.IChainCtx, ...) *ShardCtl
  • func (shardCtl *ShardCtl) ChainCtx() chain.IChainCtx
  • func (shardCtl *ShardCtl) ChainProvider() *cprovider.ChainProvider
  • func (shardCtl *ShardCtl) Init(beaconBlockGen shard.BeaconBlockProvider) error
  • func (shardCtl *ShardCtl) Run(ctx context.Context)
  • func (shardCtl *ShardCtl) Stats() map[string]float64
• type ShardInfo

Functions

func Controller

func Controller(logger zerolog.Logger) *chainController

Types

type BeaconCtl

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

func NewBeaconCtl

func NewBeaconCtl(ctx context.Context, logger zerolog.Logger, cfg *Config) BeaconCtl

func (*BeaconCtl) ChainCtx

func (beaconCtl *BeaconCtl) ChainCtx() chain.IChainCtx

func (*BeaconCtl) ChainProvider

func (beaconCtl *BeaconCtl) ChainProvider() *cprovider.ChainProvider

func (*BeaconCtl) Init

func (beaconCtl *BeaconCtl) Init() error

func (*BeaconCtl) Run

func (beaconCtl *BeaconCtl) Run(ctx context.Context)

func (*BeaconCtl) Stats

func (beaconCtl *BeaconCtl) Stats() map[string]float64

type Config

type Config struct {
	ConfigFile  string `yaml:"-" short:"C" long:"configfile" description:"Path to configuration file"`
	ShowVersion bool   `yaml:"-" short:"V" long:"version" description:"Display version information and exit"`

	Node      NodeConfig         `yaml:"node"`
	LogConfig corelog.Config     `yaml:"log_config" `
	Metrics   MetricsConfig      `yaml:"metrics"`
	BTCD      btcd.Configuration `yaml:"btcd"`

	DataDir       string   `yaml:"data_dir" short:"b" long:"datadir" description:"Directory to store data"`
	LogDir        string   `yaml:"log_dir" long:"logdir" description:"Directory to log output."`
	CPUProfile    string   `yaml:"cpu_profile" long:"cpuprofile" description:"Write CPU profile to the specified file"`
	DebugLevel    string   `` /* 294-byte string literal not displayed */
	Profile       string   `yaml:"profile" long:"profile" description:"Enable HTTP profiling on given port -- NOTE port must be between 1024 and 65536"`
	DropAddrIndex bool     `` /* 147-byte string literal not displayed */
	DropCfIndex   bool     `` /* 159-byte string literal not displayed */
	DropTxIndex   bool     `` /* 140-byte string literal not displayed */
	TorIsolation  bool     `` /* 135-byte string literal not displayed */
	Whitelists    []string `yaml:"whitelists" long:"whitelist" description:"Add an IP network or IP that will not be banned. (eg. 192.168.1.0/24 or ::1)"`
}

type DBCtl

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

type IMetric

type IMetric interface {
	Read()
}

IMetric metric reader

func ChainMetrics

func ChainMetrics(chain statsProvider, logger zerolog.Logger) (res IMetric)

func NodeMetrics

func NodeMetrics(cfg *Config, stats nodeStatsProvider, logger zerolog.Logger) (res IMetric)

type IMetricManager

type IMetricManager interface {
	Add(metrics ...IMetric)
	Listen(route string, port uint16) error
}

IMetricManager metric manager

func Metrics

func Metrics(ctx context.Context, interval time.Duration) IMetricManager

Metrics creates metric instance

type Index

type Index struct {
	LastShardID      uint32               `json:"last_shard_id"`
	LastBeaconHeight int32                `json:"last_beacon_height"`
	Shards           map[uint32]ShardInfo `json:"shards"`
}

func (*Index) AddShard

func (index *Index) AddShard(block *jaxutil.Block, opts p2p.ListenOpts) uint32

type MetricsConfig

type MetricsConfig struct {
	Enable   bool   `yaml:"enable"`
	Interval int    `yaml:"interval"`
	Port     uint16 `yaml:"port"`
}

type NodeConfig

type NodeConfig struct {
	BeaconChain    cprovider.ChainRuntimeConfig `yaml:"beacon_chain"`
	RPC            rpc.Config                   `yaml:"rpc"`
	P2P            p2p.Config                   `yaml:"p2p"`
	Shards         ShardConfig                  `yaml:"shards"`
	DbType         string                       `yaml:"db_type" description:"Database backend to use for the Block Chain"`
	Net            string                       `yaml:"net"`
	EnableCPUMiner bool                         `yaml:"enable_cpu_miner"`
}

func (*NodeConfig) ChainParams

func (cfg *NodeConfig) ChainParams() *chaincfg.Params

type ShardConfig

type ShardConfig struct {
	Enable      bool                                    `yaml:"enable"`
	Autorun     bool                                    `yaml:"autorun"`
	ChainParams map[uint32]cprovider.ChainRuntimeConfig `yaml:"chain_params"`
}

type ShardCtl

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

func NewShardCtl

func NewShardCtl(ctx context.Context, log zerolog.Logger, cfg *Config,
	chain chain.IChainCtx, listenCfg p2p.ListenOpts) *ShardCtl

func (*ShardCtl) ChainCtx

func (shardCtl *ShardCtl) ChainCtx() chain.IChainCtx

func (*ShardCtl) ChainProvider

func (shardCtl *ShardCtl) ChainProvider() *cprovider.ChainProvider

func (*ShardCtl) Init

func (shardCtl *ShardCtl) Init(beaconBlockGen shard.BeaconBlockProvider) error

func (*ShardCtl) Run

func (shardCtl *ShardCtl) Run(ctx context.Context)

func (*ShardCtl) Stats

func (shardCtl *ShardCtl) Stats() map[string]float64

type ShardInfo

type ShardInfo struct {
	ID            uint32         `json:"id"`
	LastVersion   wire.BVersion  `json:"last_version"`
	GenesisHeight int32          `json:"genesis_height"`
	GenesisHash   string         `json:"genesis_hash"`
	Enabled       bool           `json:"enabled"`
	P2PInfo       p2p.ListenOpts `json:"p2p_info"`
}