miner

Documentation

Overview

Package miner implements Ethereum block creation and mining.

Index

• type Agent
• type Backend
• type CpuAgent
  • func NewCpuAgent(chain consensus.ChainReader, engine consensus.Engine) *CpuAgent
  • func (self *CpuAgent) AssignTask(p *Package)
  • func (self *CpuAgent) DeliverTo(ch chan<- *Package)
  • func (self *CpuAgent) Start()
  • func (self *CpuAgent) Stop()
• type Env
• type Miner
  • func New(eth Backend, config *params.ChainConfig, mux *event.TypeMux, ...) *Miner
  • func (self *Miner) HashRate() uint64
  • func (self *Miner) Mining() bool
  • func (self *Miner) Pending() (*types.Block, *state.StateDB)
  • func (self *Miner) PendingBlock() *types.Block
  • func (self *Miner) Register(agent Agent)
  • func (self *Miner) SetEtherbase(addr common.Address)
  • func (self *Miner) SetExtra(extra []byte) error
  • func (self *Miner) Start(coinbase common.Address)
  • func (self *Miner) Stop()
  • func (self *Miner) Unregister(agent Agent)
• type Package

Types

type Agent

type Agent interface {
	AssignTask(*Package)
	DeliverTo(chan<- *Package)
	Start()
	Stop()
}

Agent can register themselves with the worker

type Backend

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

Backend wraps all methods required for mining.

type CpuAgent

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

func NewCpuAgent

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

func (*CpuAgent) AssignTask

func (self *CpuAgent) AssignTask(p *Package)

func (*CpuAgent) DeliverTo

func (self *CpuAgent) DeliverTo(ch chan<- *Package)

func (*CpuAgent) Start

func (self *CpuAgent) Start()

func (*CpuAgent) Stop

func (self *CpuAgent) Stop()

type Env

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

Env is the workers current environment and holds all of the current state information.

type Miner

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

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

func New

func New(eth Backend, config *params.ChainConfig, mux *event.TypeMux, engine consensus.Engine) *Miner

func (*Miner) HashRate

func (self *Miner) HashRate() uint64

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(agent Agent)

func (*Miner) SetEtherbase

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

func (*Miner) SetExtra

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

func (*Miner) Start

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

func (*Miner) Stop

func (self *Miner) Stop()

func (*Miner) Unregister

func (self *Miner) Unregister(agent Agent)

type Package

type Package struct {
	Receipts []*types.Receipt
	State    *state.StateDB
	Block    *types.Block
}

Package contains all information for consensus engine sealing and result submitting.