miner

Documentation

Overview

Package miner implements Ethereum block creation and mining.

Index

• type Backend
• type Config
• type Miner
  • func New(eth Backend, config *Config, chainConfig *params.ChainConfig, ...) *Miner
  • func (self *Miner) GenBlock()
  • 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) SetEtherbase(addr common.Address)
  • func (self *Miner) SetExtra(extra []byte) error
  • func (self *Miner) SetRecommitInterval(interval time.Duration)
  • func (self *Miner) Start(coinbase common.Address)
  • func (self *Miner) Stop()
• type MinerCallbacks

Types

type Backend

type Backend interface {
	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).
	ManualMining bool
	ManualUncle  bool
	DisableUncle bool
}

Config is the configuration parameters of mining.

type Miner

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

func New

func New(eth Backend, config *Config, chainConfig *params.ChainConfig, mux *event.TypeMux, engine consensus.Engine, isLocalBlock func(block *types.Block) bool, mcb *MinerCallbacks) *Miner

func (*Miner) GenBlock

func (self *Miner) GenBlock()

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)

func (*Miner) PendingBlock

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

func (*Miner) SetEtherbase

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

func (*Miner) SetExtra

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

func (*Miner) SetRecommitInterval

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

func (*Miner) Start

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

func (*Miner) Stop

func (self *Miner) Stop()

type MinerCallbacks

type MinerCallbacks struct {
	OnSealFinish func(*types.Block) error
	OnSealDrop   func(*types.Block)
	OnHeaderNew  func(*types.Header)
}