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) GenerateBlock() (*types.Block, error)
  • func (miner *Miner) SetEtherbase(addr common.Address)
  • func (miner *Miner) SubscribeNewMinedBlockEvent() *event.TypeMuxSubscription
  • func (miner *Miner) SubscribePendingLogs(ch chan<- []*types.Log) event.Subscription
• 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)
	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
	ApricotPhase1GasLimit uint64         // Gas Limit for mined blocks as of Apricot Phase 1.
}

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

func (miner *Miner) GenerateBlock() (*types.Block, error)

func (*Miner) SetEtherbase

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

func (*Miner) SubscribeNewMinedBlockEvent

func (miner *Miner) SubscribeNewMinedBlockEvent() *event.TypeMuxSubscription

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 MinerCallbacks

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