node

Documentation

Index

• func EnsureRuntimeDirs(cfg *Config) (string, error)
• type Config
  • func LoadConfiguration(networkName, configRoot, runtimeRoot string, nodeID uint64) (*Config, error)
• type Server
  • func Run(dir string, cfg *Config) (*Server, error)
  • func (s *Server) Shutdown()

Functions

func EnsureRuntimeDirs

func EnsureRuntimeDirs(cfg *Config) (string, error)

Init initialize the the fs for the node runtime

Types

type Config

type Config struct {
	Directory   string
	Keys        *config.Keys
	Network     *config.Network
	NetworkName string
	NodeID      uint64
	Node        *config.Node
}

Config represents the configuration of an individual node within a Chainspace network.

func LoadConfiguration

func LoadConfiguration(networkName, configRoot, runtimeRoot string, nodeID uint64) (*Config, error)

type Server

type Server struct {
	Broadcast *broadcast.Service
	// contains filtered or unexported fields
}

Server represents a running Chainspace node.

func Run

func Run(dir string, cfg *Config) (*Server, error)

Run initialises a node with the given config.

func (*Server) Shutdown

func (s *Server) Shutdown()

Shutdown closes all underlying resources associated with the node.