miner

Documentation

Overview

Package miner implements Ethereum block creation and mining.

Index

• Variables
• type Backend
• type Config
• type Miner
  • func New(eth Backend, config *Config, chainConfig *params.ChainConfig, ...) *Miner
  • func (miner *Miner) Close()
  • func (miner *Miner) DisablePreseal()
  • func (miner *Miner) EnablePreseal()
  • func (miner *Miner) GetSealingBlockAsync(parent common.Hash, timestamp uint64, coinbase common.Address, ...) (chan *types.Block, error)
  • func (miner *Miner) GetSealingBlockSync(parent common.Hash, timestamp uint64, coinbase common.Address, ...) (*types.Block, error)
  • 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) PendingBlockAndReceipts() (*types.Block, types.Receipts)
  • func (miner *Miner) SetEtherbase(addr common.Address)
  • func (miner *Miner) SetExtra(extra []byte) error
  • func (miner *Miner) SetGasCeil(ceil uint64)
  • func (miner *Miner) SetRecommitInterval(interval time.Duration)
  • func (miner *Miner) Start(coinbase common.Address)
  • func (miner *Miner) Stop()
  • func (miner *Miner) SubscribePendingLogs(ch chan<- []*types.Log) event.Subscription

Variables

var DefaultConfig = Config{
	GasCeil:           30000000,
	GasPrice:          big.NewInt(params.GWei),
	Recommit:          3 * time.Second,
	NewPayloadTimeout: 2 * time.Second,
}

DefaultConfig contains default settings for miner.

Types

type Backend

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

Backend wraps all methods required for mining. Only full node is capable to offer all the functions here.

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).
	NotifyFull bool           `toml:",omitempty"` // Notify with pending block headers instead of work packages
	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).

	NewPayloadTimeout time.Duration // The maximum time allowance for creating a new payload
}

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(header *types.Header) bool) *Miner

func (*Miner) Close

func (miner *Miner) Close()

func (*Miner) DisablePreseal

func (miner *Miner) DisablePreseal()

DisablePreseal turns off the preseal mining feature. It's necessary for some fake consensus engine which can seal blocks instantaneously. Note this function shouldn't be exposed to API, it's unnecessary for users (miners) to actually know the underlying detail. It's only for outside project which uses this library.

func (*Miner) EnablePreseal

func (miner *Miner) EnablePreseal()

EnablePreseal turns on the preseal mining feature. It's enabled by default. Note this function shouldn't be exposed to API, it's unnecessary for users (miners) to actually know the underlying detail. It's only for outside project which uses this library.

func (*Miner) GetSealingBlockAsync

func (miner *Miner) GetSealingBlockAsync(parent common.Hash, timestamp uint64, coinbase common.Address, random common.Hash, noTxs bool) (chan *types.Block, error)

GetSealingBlockAsync requests to generate a sealing block according to the given parameters. Regardless of whether the generation is successful or not, there is always a result that will be returned through the result channel. The difference is that if the execution fails, the returned result is nil and the concrete error is dropped silently.

func (*Miner) GetSealingBlockSync

func (miner *Miner) GetSealingBlockSync(parent common.Hash, timestamp uint64, coinbase common.Address, random common.Hash, noTxs bool) (*types.Block, error)

GetSealingBlockSync creates a sealing block according to the given parameters. If the generation is failed or the underlying work is already closed, an error will be returned.

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

func (miner *Miner) PendingBlockAndReceipts() (*types.Block, types.Receipts)

PendingBlockAndReceipts returns the currently pending block and corresponding receipts.

func (*Miner) SetEtherbase

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

func (*Miner) SetExtra

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

func (*Miner) SetGasCeil

func (miner *Miner) SetGasCeil(ceil uint64)

SetGasCeil sets the gaslimit to strive for when mining blocks post 1559. For pre-1559 blocks, it sets the ceiling.

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

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

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