node

Documentation

Overview

TODO: remove this file when we can import it from hostd

Index

• Variables
• func NewAutopilot(cfg AutopilotConfig, b autopilot.Bus, workers []autopilot.Worker, ...) (http.Handler, RunFn, ShutdownFn, error)
• func NewChainManager(cs modules.ConsensusSet, network *consensus.Network) (*chainManager, error)
• func NewLogger(path string) (*zap.Logger, func(context.Context) error, error)
• func NewTransactionPool(tp modules.TransactionPool) bus.TransactionPool
• type AutopilotConfig
• type BusConfig
• type Consensus
• type Miner
  • func NewMiner(consensus Consensus) *Miner
  • func (m *Miner) Mine(addr types.Address, n int) error
  • func (m *Miner) ProcessConsensusChange(cc modules.ConsensusChange)
  • func (m *Miner) ReceiveUpdatedUnconfirmedTransactions(diff *modules.TransactionPoolDiff)
• type RunFn
• type ShutdownFn
  • func NewBus(cfg BusConfig, dir string, seed types.PrivateKey, l *zap.Logger) (http.Handler, ShutdownFn, error)
  • func NewWorker(cfg config.Worker, b worker.Bus, seed types.PrivateKey, l *zap.Logger) (http.Handler, ShutdownFn, error)

Variables

var (
	ErrBlockNotFound   = errors.New("block not found")
	ErrInvalidChangeID = errors.New("invalid change id")
)

Functions

func NewAutopilot

func NewAutopilot(cfg AutopilotConfig, b autopilot.Bus, workers []autopilot.Worker, l *zap.Logger) (http.Handler, RunFn, ShutdownFn, error)

func NewChainManager

func NewChainManager(cs modules.ConsensusSet, network *consensus.Network) (*chainManager, error)

NewManager creates a new chain manager.

func NewLogger

func NewLogger(path string) (*zap.Logger, func(context.Context) error, error)

func NewTransactionPool

func NewTransactionPool(tp modules.TransactionPool) bus.TransactionPool

Types

type AutopilotConfig

type AutopilotConfig struct {
	config.Autopilot
	ID string
}

type BusConfig

type BusConfig struct {
	config.Bus
	Network            *consensus.Network
	Miner              *Miner
	DBLoggerConfig     stores.LoggerConfig
	DBDialector        gorm.Dialector
	DBMetricsDialector gorm.Dialector
}

type Consensus

type Consensus interface {
	AcceptBlock(context.Context, types.Block) error
}

Consensus defines a minimal interface needed by the miner to interact with the consensus set

type Miner

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

A Miner is a CPU miner that can mine blocks, sending the reward to a specified address.

func NewMiner

func NewMiner(consensus Consensus) *Miner

NewMiner initializes a new CPU miner

func (*Miner) Mine

func (m *Miner) Mine(addr types.Address, n int) error

Mine mines n blocks, sending the reward to addr

func (*Miner) ProcessConsensusChange

func (m *Miner) ProcessConsensusChange(cc modules.ConsensusChange)

ProcessConsensusChange implements modules.ConsensusSetSubscriber.

func (*Miner) ReceiveUpdatedUnconfirmedTransactions

func (m *Miner) ReceiveUpdatedUnconfirmedTransactions(diff *modules.TransactionPoolDiff)

ReceiveUpdatedUnconfirmedTransactions implements modules.TransactionPoolSubscriber

type RunFn

type RunFn = func() error

type ShutdownFn

type ShutdownFn = func(context.Context) error

func NewBus

func NewBus(cfg BusConfig, dir string, seed types.PrivateKey, l *zap.Logger) (http.Handler, ShutdownFn, error)

func NewWorker

func NewWorker(cfg config.Worker, b worker.Bus, seed types.PrivateKey, l *zap.Logger) (http.Handler, ShutdownFn, error)