server

Documentation

Index

• Constants
• func ConsensusSupported(value string) bool
• type Config
• type ConsensusType
• type Entry
• type GenesisFactoryHook
• type JSONRPC
• type Server
  • func NewServer(config *Config) (*Server, error)
  • func (s *Server) Chain() *chain.Chain
  • func (s *Server) Close()
  • func (s *Server) JoinPeer(rawPeerMultiaddr string) error
• type Telemetry

Constants

const DefaultGRPCPort int = 9632

const DefaultJSONRPCPort int = 8545

Functions

func ConsensusSupported

func ConsensusSupported(value string) bool

Types

type Config

type Config struct {
	Chain *chain.Chain

	JSONRPC    *JSONRPC
	GRPCAddr   *net.TCPAddr
	LibP2PAddr *net.TCPAddr

	PriceLimit         uint64
	MaxAccountEnqueued uint64
	MaxSlots           uint64
	BlockTime          uint64

	Telemetry *Telemetry
	Network   *network.Config

	DataDir     string
	RestoreFile *string

	Seal bool

	SecretsManager *secrets.SecretsManagerConfig

	LogLevel hclog.Level

	JSONLogFormat bool

	LogFilePath string

	Relayer bool

	NumBlockConfirmations uint64
}

Config is used to parametrize the minimal client

type ConsensusType

type ConsensusType string

const (
	DevConsensus     ConsensusType = "dev"
	IBFTConsensus    ConsensusType = "ibft"
	PolyBFTConsensus ConsensusType = "polybft"
	DummyConsensus   ConsensusType = "dummy"
)

type Entry

type Entry struct {
	Enabled bool
	Config  map[string]interface{}
}

Entry is a consensus configuration entry

type GenesisFactoryHook

type GenesisFactoryHook func(config *chain.Chain, engineName string) func(*state.Transition) error

type JSONRPC

type JSONRPC struct {
	JSONRPCAddr              *net.TCPAddr
	AccessControlAllowOrigin []string
	BatchLengthLimit         uint64
	BlockRangeLimit          uint64
}

JSONRPC holds the config details for the JSON-RPC server

type Server

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

Server is the central manager of the blockchain client

func NewServer

func NewServer(config *Config) (*Server, error)

NewServer creates a new Minimal server, using the passed in configuration

func (*Server) Chain

func (s *Server) Chain() *chain.Chain

Chain returns the chain object of the client

func (*Server) Close

func (s *Server) Close()

Close closes the Minimal server (blockchain, networking, consensus)

func (*Server) JoinPeer

func (s *Server) JoinPeer(rawPeerMultiaddr string) error

JoinPeer attempts to add a new peer to the networking server

type Telemetry

type Telemetry struct {
	PrometheusAddr *net.TCPAddr
}

Telemetry holds the config details for metric services