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 (miner *Miner) Close()
  • func (miner *Miner) HashRate() uint64
  • func (miner *Miner) Mining() bool
  • func (miner *Miner) Pending() (*types.Block, *state.StateDB)
  • func (miner *Miner) PendingBlock() *types.Block
  • func (miner *Miner) SetExtra(extra []byte) error
  • func (miner *Miner) SetRecommitInterval(interval time.Duration)
  • func (miner *Miner) SetTxFeeRecipient(addr common.Address)
  • func (miner *Miner) SetValidator(addr common.Address)
  • func (miner *Miner) Start(validator common.Address, txFeeRecipient common.Address)
  • func (miner *Miner) Stop()
  • func (self *Miner) SubscribePendingLogs(ch chan<- []*types.Log) event.Subscription

Types

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 {
	Validator           common.Address `toml:",omitempty"` // Public address for block signing and randomness (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).
	VerificationService string         // Celo verification service URL
}

Config is the configuration parameters of mining.

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, db ethdb.Database) *Miner

func (*Miner) Close

func (miner *Miner) Close()

func (*Miner) HashRate

func (miner *Miner) HashRate() uint64

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) 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) SetTxFeeRecipient

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

SetTxFeeRecipient sets the address where the miner and worker will receive fees

func (*Miner) SetValidator

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

SetValidator sets the miner and worker's address for message and block signing

func (*Miner) Start

func (miner *Miner) Start(validator common.Address, txFeeRecipient common.Address)

func (*Miner) Stop

func (miner *Miner) Stop()

func (*Miner) SubscribePendingLogs

func (self *Miner) SubscribePendingLogs(ch chan<- []*types.Log) event.Subscription

SubscribePendingLogs starts delivering logs from pending transactions to the given channel.