miner

Documentation

Overview

Package miner implements Ethereum block creation and mining.

Index

• Constants
• type Backend
• type Config
• type Miner
  • func New(eth Backend, config *Config, chainConfig *params2.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) SetExtra(extra []byte) error
  • 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 (miner *Miner) SubscribePendingLogs(ch chan<- []*types.Log) event.Subscription

Constants

const (
	TxGas uint64 = 1000
)

Types

type Backend

type Backend interface {
	BlockChain() *chain.BlockChain
	TxPool() *chain.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).
	// 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.

}

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 *params2.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) 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) 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)

func (*Miner) Start

func (miner *Miner) Start(validator common.Address, txFeeRecipient 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.