node

Documentation

Index

• type Config
  • func NewConfig(path string) (*Config, error)
• type LocalEndpoints
• type Node
  • func New(ctx context.Context, cfg *Config, options ...Option) (*Node, error)
  • func (m *Node) Serve(ctx context.Context) error
• type Option
  • func WithLog(log *zap.Logger) Option
• type SSHServer
• type Server
  • func (m *Server) LocalEndpoints() LocalEndpoints
  • func (m *Server) Serve(ctx context.Context) error
• type ServerOption
  • func WithGRPCSecure(credentials credentials.TransportCredentials, key *ecdsa.PrivateKey) ServerOption
  • func WithGRPCServer() ServerOption
  • func WithGRPCServerMetrics() ServerOption
  • func WithQUIC(cfg *tls.Config) ServerOption
  • func WithRESTSecure(key *ecdsa.PrivateKey) ServerOption
  • func WithRESTServer() ServerOption
  • func WithSSH(cfg ssh.ProxyServerConfig, privateKey *ecdsa.PrivateKey, ...) ServerOption
  • func WithServerLog(log *zap.Logger) ServerOption
• type Services

Types

type Config

type Config struct {
	Node              nodeConfig               `yaml:"node"`
	NPP               npp.Config               `yaml:"npp"`
	Log               logging.Config           `yaml:"log"`
	Blockchain        *blockchain.Config       `yaml:"blockchain"`
	Eth               accounts.EthConfig       `yaml:"ethereum" required:"false"`
	DWH               dwh.YAMLConfig           `yaml:"dwh"`
	MetricsListenAddr string                   `yaml:"metrics_listen_addr" default:"127.0.0.1:14003"`
	Benchmarks        benchmarks.Config        `yaml:"benchmarks"`
	Matcher           *matcher.YAMLConfig      `yaml:"matcher"`
	Predictor         *optimus.PredictorConfig `yaml:"predictor"`
	Debug             *debug.Config            `yaml:"debug"`
	SSH               *ssh.ProxyServerConfig   `yaml:"ssh"`
}

func NewConfig

func NewConfig(path string) (*Config, error)

NewConfig loads localNode config from given .yaml file

type LocalEndpoints

type LocalEndpoints struct {
	GRPC []net.Addr
	QRPC []net.Addr
	REST []net.Addr
}

type Node

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

func New

func New(ctx context.Context, cfg *Config, options ...Option) (*Node, error)

New constructs a new Node instance.

The specified context should outlive the returned Node value, because it is used for certificate refreshing.

func (*Node) Serve

func (m *Node) Serve(ctx context.Context) error

type Option

type Option func(o *options)

func WithLog

func WithLog(log *zap.Logger) Option

type SSHServer

type SSHServer interface {
	Serve(ctx context.Context) error
}

type Server

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

Server is a server for LocalNode instance.

Its responsibility is to manage network part, i.e. creating TCP servers and exposing API provided outside.

func (*Server) LocalEndpoints

func (m *Server) LocalEndpoints() LocalEndpoints

func (*Server) Serve

func (m *Server) Serve(ctx context.Context) error

Serve starts serving current Node instance until either critical error occurs or the given context is canceled.

Warning: after this call the next callings of "Serve" will have no effect.

type ServerOption

type ServerOption func(o *serverOptions) error

func WithGRPCSecure

func WithGRPCSecure(credentials credentials.TransportCredentials, key *ecdsa.PrivateKey) ServerOption

func WithGRPCServer

func WithGRPCServer() ServerOption

func WithGRPCServerMetrics

func WithGRPCServerMetrics() ServerOption

func WithQUIC

func WithQUIC(cfg *tls.Config) ServerOption

func WithRESTSecure

func WithRESTSecure(key *ecdsa.PrivateKey) ServerOption

func WithRESTServer

func WithRESTServer() ServerOption

func WithSSH

func WithSSH(cfg ssh.ProxyServerConfig, privateKey *ecdsa.PrivateKey, credentials *xgrpc.TransportCredentials, market blockchain.MarketAPI, log *zap.SugaredLogger) ServerOption

func WithServerLog

func WithServerLog(log *zap.Logger) ServerOption

type Services

type Services interface {
	RegisterGRPC(server *grpc.Server) error
	RegisterREST(server *rest.Server) error
	Interceptor() grpc.UnaryServerInterceptor
	StreamInterceptor() grpc.StreamServerInterceptor
	Run(ctx context.Context) error
}