miner

Documentation

Overview

Package miner implements Ethereum block creation and mining.

Index

• type Agent
• type Backend
• type Config
• type CpuAgent
  • func NewCpuAgent(chain consensus.ChainReader, engine consensus.Engine) *CpuAgent
  • func (self *CpuAgent) DispatchWork(block *types.Block)
  • func (self *CpuAgent) GetHashRate() uint64
  • func (self *CpuAgent) Start()
  • func (self *CpuAgent) Stop()
  • func (self *CpuAgent) SubscribeResult(ch chan<- *types.Block)
• type Miner
  • func New(eth Backend, config *Config, chainConfig *params.ChainConfig, ...) *Miner
  • func (miner *Miner) Close()
  • func (miner *Miner) HashRate() uint64
  • func (miner *Miner) InvalidRaftOrdering() chan<- raft.InvalidRaftOrdering
  • func (miner *Miner) IsRegistered() bool
  • func (miner *Miner) Mining() bool
  • func (miner *Miner) Pending() (*types.Block, *state.StateDB)
  • func (miner *Miner) PendingBlock() *types.Block
  • func (miner *Miner) Register(agent Agent)
  • func (miner *Miner) SetEtherbase(addr common.Address)
  • func (miner *Miner) SetExtra(extra []byte) error
  • func (miner *Miner) SetRecommitInterval(interval time.Duration)
  • func (miner *Miner) Start(coinbase common.Address)
  • func (miner *Miner) Stop()
  • func (miner *Miner) Unregister(agent Agent)
• type StratumAgent
  • func NewStratumAgent(chain consensus.ChainReader, engine consensus.Engine) *StratumAgent
  • func (self *StratumAgent) DispatchWork(block *types.Block)
  • func (self *StratumAgent) GetHashRate() uint64
  • func (self *StratumAgent) Register(s *stratum.Server)
  • func (self *StratumAgent) Start()
  • func (self *StratumAgent) Stop()
  • func (self *StratumAgent) SubscribeResult(ch chan<- *types.Block)

Types

type Agent

type Agent interface {
	DispatchWork(block *types.Block)
	SubscribeResult(ch chan<- *types.Block)
	Stop()
	Start()
	GetHashRate() uint64
}

type Backend

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

Backend wraps all methods required for mining.

type Config

type Config struct {
	Etherbase common.Address `toml:",omitempty"` // Public address for block mining rewards (default = first account)
	Notify    []string       `toml:",omitempty"` // HTTP URL list to be notified of new work packages(only useful in ethash).
	ExtraData hexutil.Bytes  `toml:",omitempty"` // Block extra data set by the miner
	GasFloor  uint64         // Target gas floor for mined blocks.
	GasCeil   uint64         // Target gas ceiling for mined blocks.
	GasPrice  *big.Int       // Minimum gas price for mining a transaction
	Recommit  time.Duration  // The time interval for miner to re-create mining work.
	Noverify  bool           // Disable remote mining solution verification(only useful in ethash).
}

Config is the configuration parameters of mining.

type CpuAgent

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

func NewCpuAgent

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

func (*CpuAgent) DispatchWork

func (self *CpuAgent) DispatchWork(block *types.Block)

func (*CpuAgent) GetHashRate

func (self *CpuAgent) GetHashRate() uint64

func (*CpuAgent) Start

func (self *CpuAgent) Start()

func (*CpuAgent) Stop

func (self *CpuAgent) Stop()

func (*CpuAgent) SubscribeResult

func (self *CpuAgent) SubscribeResult(ch chan<- *types.Block)

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 *Config, chainConfig *params.ChainConfig, mux *event.TypeMux, engine consensus.Engine, isLocalBlock func(block *types.Block) bool) *Miner

func (*Miner) Close

func (miner *Miner) Close()

func (*Miner) HashRate

func (miner *Miner) HashRate() uint64

func (*Miner) InvalidRaftOrdering

func (miner *Miner) InvalidRaftOrdering() chan<- raft.InvalidRaftOrdering

func (*Miner) IsRegistered

func (miner *Miner) IsRegistered() bool

func (*Miner) Mining

func (miner *Miner) Mining() bool

func (*Miner) Pending

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

Pending returns the currently pending block and associated state.

func (*Miner) PendingBlock

func (miner *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 (miner *Miner) Register(agent Agent)

func (*Miner) SetEtherbase

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

func (*Miner) SetExtra

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

func (*Miner) SetRecommitInterval

func (miner *Miner) SetRecommitInterval(interval time.Duration)

SetRecommitInterval sets the interval for sealing work resubmitting.

func (*Miner) Start

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

func (*Miner) Stop

func (miner *Miner) Stop()

func (*Miner) Unregister

func (miner *Miner) Unregister(agent Agent)

type StratumAgent

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

func NewStratumAgent

func NewStratumAgent(chain consensus.ChainReader, engine consensus.Engine) *StratumAgent

func (*StratumAgent) DispatchWork

func (self *StratumAgent) DispatchWork(block *types.Block)

func (*StratumAgent) GetHashRate

func (self *StratumAgent) GetHashRate() uint64

func (*StratumAgent) Register

func (self *StratumAgent) Register(s *stratum.Server)

func (*StratumAgent) Start

func (self *StratumAgent) Start()

func (*StratumAgent) Stop

func (self *StratumAgent) Stop()

func (*StratumAgent) SubscribeResult

func (self *StratumAgent) SubscribeResult(ch chan<- *types.Block)