miner

Documentation

Overview

Package miner mints blocks.

Currently, there is a single miner. It is created by CpchainService.

A miner contains an engine. The job of the engine is to dispatch un-sealed blocks to several workers and seal the returned block.

Index

• type Backend
• type Miner
  • func New(backend Backend, config *configs.ChainConfig, mux *event.TypeMux, ...) *Miner
  • func (m *Miner) IsMining() bool
  • func (m *Miner) Pending() (*types.Block, *state.StateDB)
  • func (m *Miner) PendingBlock() *types.Block
  • func (m *Miner) Register(agent Worker)
  • func (m *Miner) SetCoinbase(addr common.Address)
  • func (m *Miner) SetExtra(extra []byte) error
  • func (m *Miner) Start(coinbase common.Address)
  • func (m *Miner) Stop()
  • func (m *Miner) Unregister(agent Worker)
• type NativeWorker
  • func NewNativeWorker(chain consensus.ChainReader, cons consensus.Engine) *NativeWorker
  • func (nw *NativeWorker) SetReturnCh(ch chan<- *Result)
  • func (nw *NativeWorker) Start()
  • func (nw *NativeWorker) Stop()
  • func (nw *NativeWorker) Work() chan<- *Work
• type Result
• type Work
• type Worker

Types

type Backend

type Backend interface {
	AccountManager() *accounts.Manager
	BlockChain() *core.BlockChain
	TxPool() *core.TxPool
	ChainDb() database.Database
}

Backend wraps all methods required for mining.

type Miner

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

Miner creates blocks.

func New

func New(backend Backend, config *configs.ChainConfig, mux *event.TypeMux, cons consensus.Engine) *Miner

func (*Miner) IsMining

func (m *Miner) IsMining() bool

func (*Miner) Pending

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

Pending returns the currently pending block and associated state.

func (*Miner) PendingBlock

func (m *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 (m *Miner) Register(agent Worker)

func (*Miner) SetCoinbase

func (m *Miner) SetCoinbase(addr common.Address)

func (*Miner) SetExtra

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

func (*Miner) Start

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

func (*Miner) Stop

func (m *Miner) Stop()

func (*Miner) Unregister

func (m *Miner) Unregister(agent Worker)

type NativeWorker

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

func NewNativeWorker

func NewNativeWorker(chain consensus.ChainReader, cons consensus.Engine) *NativeWorker

func (*NativeWorker) SetReturnCh

func (nw *NativeWorker) SetReturnCh(ch chan<- *Result)

func (*NativeWorker) Start

func (nw *NativeWorker) Start()

func (*NativeWorker) Stop

func (nw *NativeWorker) Stop()

func (*NativeWorker) Work

func (nw *NativeWorker) Work() chan<- *Work

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

type Worker

type Worker interface {
	// retrieve the channel to pass work to a worker
	Work() chan<- *Work
	// retrieve result from a worker
	SetReturnCh(chan<- *Result)
	Stop()
	Start()
}

Worker can register itself with the engine