worker

Documentation

Overview

Package worker implements HPB block creation and mining.

Index

• type CpuAgent
  • func NewCpuAgent(chain consensus.ChainReader, engine consensus.Engine) *CpuAgent
  • func (self *CpuAgent) SetReturnCh(ch chan<- *Result)
  • func (self *CpuAgent) Start()
  • func (self *CpuAgent) Stop()
  • func (self *CpuAgent) Work() chan<- *Work
• type Miner
  • func New(config *config.ChainConfig, mux *sub.TypeMux, engine consensus.Engine, ...) *Miner
  • func (self *Miner) Mining() bool
  • func (self *Miner) Pending() (*types.Block, *state.StateDB)
  • func (self *Miner) PendingBlock() *types.Block
  • func (self *Miner) Register(producer Producer)
  • func (self *Miner) SetExtra(extra []byte) error
  • func (self *Miner) SetHpberbase(addr common.Address)
  • func (self *Miner) Start(coinbase common.Address)
  • func (self *Miner) Stop()
  • func (self *Miner) Unregister(producer Producer)
• type Producer
• type Result
• type Work

Types

type CpuAgent

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

func NewCpuAgent

func NewCpuAgent(chain consensus.ChainReader, engine consensus.Engine) *CpuAgent

func (*CpuAgent) SetReturnCh

func (self *CpuAgent) SetReturnCh(ch chan<- *Result)

func (*CpuAgent) Start

func (self *CpuAgent) Start()

func (*CpuAgent) Stop

func (self *CpuAgent) Stop()

func (*CpuAgent) Work

func (self *CpuAgent) Work() chan<- *Work

type Miner

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

Miner creates blocks and searches for proof-of-work values.

func New

func New(config *config.ChainConfig, mux *sub.TypeMux, engine consensus.Engine, coinbase common.Address) *Miner

func (*Miner) Mining

func (self *Miner) Mining() bool

func (*Miner) Pending

func (self *Miner) Pending() (*types.Block, *state.StateDB)

Pending returns the currently pending block and associated state.

func (*Miner) PendingBlock

func (self *Miner) PendingBlock() *types.Block

PendingBlock returns the currently pending block.

Note, to access both the pending block and the pending state simultaneously, please use Pending(), as the pending state can change between multiple method calls

func (*Miner) Register

func (self *Miner) Register(producer Producer)

func (*Miner) SetExtra

func (self *Miner) SetExtra(extra []byte) error

func (*Miner) SetHpberbase

func (self *Miner) SetHpberbase(addr common.Address)

func (*Miner) Start

func (self *Miner) Start(coinbase common.Address)

func (*Miner) Stop

func (self *Miner) Stop()

func (*Miner) Unregister

func (self *Miner) Unregister(producer Producer)

type Producer

type Producer interface {
	Work() chan<- *Work
	SetReturnCh(chan<- *Result)
	Stop()
	Start()
}

Agent can register themself with the worker

type Result

type Result struct {
	Work  *Work
	Block *types.Block
}

type Work

type Work struct {
	Block *types.Block // the new block
	// contains filtered or unexported fields
}

Work is the workers current environment and holds all of the current state information