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 NewBus(cfg BusConfig, dir string, seed types.PrivateKey, l *zap.Logger) (http.Handler, BusSetupFn, ShutdownFn, error)
• func NewChainManager(cs modules.ConsensusSet, tp bus.TransactionPool, network *consensus.Network) (*chainManager, error)
• func NewTransactionPool(tp modules.TransactionPool) bus.TransactionPool
• func NewWorker(cfg config.Worker, s3Opts s3.Opts, b Bus, seed types.PrivateKey, l *zap.Logger) (http.Handler, http.Handler, WorkerSetupFn, ShutdownFn, error)
• type AutopilotConfig
• type Bus
• type BusConfig
• type BusSetupFn
• 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
• type WorkerSetupFn

Variables

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

var NoopFn = func(context.Context) error { return nil }

Functions

func NewAutopilot

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

func NewBus

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

func NewChainManager

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

NewManager creates a new chain manager.

func NewTransactionPool

func NewTransactionPool(tp modules.TransactionPool) bus.TransactionPool

func NewWorker

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

Types

type AutopilotConfig

type AutopilotConfig struct {
	config.Autopilot
	ID string
}

type Bus

type Bus interface {
	worker.Bus
	s3.Bus
}

type BusConfig

type BusConfig struct {
	config.Bus
	Database    config.Database
	DatabaseLog config.DatabaseLog
	Network     *consensus.Network
	Logger      *zap.Logger
	Miner       *Miner
}

type BusSetupFn

type BusSetupFn = func(context.Context) error

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

type WorkerSetupFn

type WorkerSetupFn = func(context.Context, string, string) error