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) Mining() bool
  • func (miner *Miner) Pending() (*types.Block, *state.StateDB)
  • func (miner *Miner) PendingBlock() *types.Block
  • func (miner *Miner) SetRecommitInterval(interval time.Duration)
  • func (miner *Miner) Start()
  • func (miner *Miner) Stop()
  • func (miner *Miner) SubscribePendingLogs(ch chan<- []*types.Log) event.Subscription
• type ParallelTxsCommitter
  • func NewParallelTxsCommitter(w *worker) *ParallelTxsCommitter
  • func (c *ParallelTxsCommitter) CommitTransactions(header *types.Header, txs *types.TransactionsByPriceAndNonce, interrupt *int32, ...) (bool, bool)
• type TxsCommitter
  • func NewTxsCommitter(w *worker) *TxsCommitter
  • func (c *TxsCommitter) CommitTransactions(header *types.Header, txs *types.TransactionsByPriceAndNonce, interrupt *int32, ...) (bool, bool)

Types

type Backend

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

Backend wraps all methods required for mining.

type Config

type Config struct {
	ExtraData hexutil.Bytes `toml:",omitempty"` // Block extra data set by the miner
	GasFloor  uint64        // Target gas floor 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 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, miningConfig *core.MiningConfig, mux *event.TypeMux,
	engine consensus.Engine, isLocalBlock func(block *types.Block) bool,
	blockChainCache *core.BlockChainCache, vmTimeout uint64) *Miner

func (*Miner) Close

func (miner *Miner) Close()

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

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

SetRecommitInterval sets the interval for sealing work resubmitting.

func (*Miner) Start

func (miner *Miner) Start()

func (*Miner) Stop

func (miner *Miner) Stop()

func (*Miner) SubscribePendingLogs

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

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

type ParallelTxsCommitter

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

func NewParallelTxsCommitter

func NewParallelTxsCommitter(w *worker) *ParallelTxsCommitter

func (*ParallelTxsCommitter) CommitTransactions

func (c *ParallelTxsCommitter) CommitTransactions(header *types.Header, txs *types.TransactionsByPriceAndNonce, interrupt *int32, timestamp int64, blockDeadline time.Time, tempContractCache map[common.Address]struct{}) (bool, bool)

type TxsCommitter

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

func NewTxsCommitter

func NewTxsCommitter(w *worker) *TxsCommitter

func (*TxsCommitter) CommitTransactions

func (c *TxsCommitter) CommitTransactions(header *types.Header, txs *types.TransactionsByPriceAndNonce, interrupt *int32, timestamp int64, blockDeadline time.Time, tempContractCache map[common.Address]struct{}) (bool, bool)