123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228 |
- // Copyright 2014 The go-ethereum Authors
- // This file is part of the go-ethereum library.
- //
- // The go-ethereum library is free software: you can redistribute it and/or modify
- // it under the terms of the GNU Lesser General Public License as published by
- // the Free Software Foundation, either version 3 of the License, or
- // (at your option) any later version.
- //
- // The go-ethereum library is distributed in the hope that it will be useful,
- // but WITHOUT ANY WARRANTY; without even the implied warranty of
- // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- // GNU Lesser General Public License for more details.
- //
- // You should have received a copy of the GNU Lesser General Public License
- // along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
- // Package miner implements Ethereum block creation and mining.
- package miner
- import (
- "fmt"
- "math/big"
- "time"
- "github.com/ethereum/go-ethereum/common"
- "github.com/ethereum/go-ethereum/common/hexutil"
- "github.com/ethereum/go-ethereum/consensus"
- "github.com/ethereum/go-ethereum/core"
- "github.com/ethereum/go-ethereum/core/state"
- "github.com/ethereum/go-ethereum/core/types"
- "github.com/ethereum/go-ethereum/eth/downloader"
- "github.com/ethereum/go-ethereum/ethdb"
- "github.com/ethereum/go-ethereum/event"
- "github.com/ethereum/go-ethereum/log"
- "github.com/ethereum/go-ethereum/params"
- )
- // Backend wraps all methods required for mining.
- type Backend interface {
- BlockChain() *core.BlockChain
- TxPool() *core.TxPool
- ChainDb() ethdb.Database
- }
- // Config is the configuration parameters of mining.
- 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).
- // Quorum
- AllowedFutureBlockTime uint64 // Max time (in seconds) from current time allowed for blocks, before they're considered future blocks
- }
- // Miner creates blocks and searches for proof-of-work values.
- type Miner struct {
- mux *event.TypeMux
- worker *worker
- coinbase common.Address
- eth Backend
- engine consensus.Engine
- exitCh chan struct{}
- startCh chan common.Address
- stopCh chan struct{}
- }
- func New(eth Backend, config *Config, chainConfig *params.ChainConfig, mux *event.TypeMux, engine consensus.Engine, isLocalBlock func(block *types.Block) bool) *Miner {
- miner := &Miner{
- eth: eth,
- mux: mux,
- engine: engine,
- exitCh: make(chan struct{}),
- startCh: make(chan common.Address),
- stopCh: make(chan struct{}),
- worker: newWorker(config, chainConfig, engine, eth, mux, isLocalBlock, true),
- }
- go miner.update()
- return miner
- }
- // update keeps track of the downloader events. Please be aware that this is a one shot type of update loop.
- // It's entered once and as soon as `Done` or `Failed` has been broadcasted the events are unregistered and
- // the loop is exited. This to prevent a major security vuln where external parties can DOS you with blocks
- // and halt your mining operation for as long as the DOS continues.
- func (miner *Miner) update() {
- events := miner.mux.Subscribe(downloader.StartEvent{}, downloader.DoneEvent{}, downloader.FailedEvent{})
- defer func() {
- if !events.Closed() {
- events.Unsubscribe()
- }
- }()
- shouldStart := false
- canStart := true
- dlEventCh := events.Chan()
- for {
- select {
- case ev := <-dlEventCh:
- if ev == nil {
- // Unsubscription done, stop listening
- dlEventCh = nil
- continue
- }
- switch ev.Data.(type) {
- case downloader.StartEvent:
- wasMining := miner.Mining()
- miner.worker.stop()
- canStart = false
- if wasMining {
- // Resume mining after sync was finished
- shouldStart = true
- log.Info("Mining aborted due to sync")
- }
- case downloader.FailedEvent:
- canStart = true
- if shouldStart {
- miner.SetEtherbase(miner.coinbase)
- miner.worker.start()
- }
- case downloader.DoneEvent:
- canStart = true
- if shouldStart {
- miner.SetEtherbase(miner.coinbase)
- miner.worker.start()
- }
- // Stop reacting to downloader events
- events.Unsubscribe()
- }
- case addr := <-miner.startCh:
- miner.SetEtherbase(addr)
- if canStart {
- miner.worker.start()
- }
- shouldStart = true
- case <-miner.stopCh:
- shouldStart = false
- miner.worker.stop()
- case <-miner.exitCh:
- miner.worker.close()
- return
- }
- }
- }
- func (miner *Miner) Start(coinbase common.Address) {
- miner.startCh <- coinbase
- }
- func (miner *Miner) Stop() {
- miner.stopCh <- struct{}{}
- }
- func (miner *Miner) Close() {
- close(miner.exitCh)
- }
- func (miner *Miner) Mining() bool {
- return miner.worker.isRunning()
- }
- func (miner *Miner) Hashrate() uint64 {
- if pow, ok := miner.engine.(consensus.PoW); ok {
- return uint64(pow.Hashrate())
- }
- return 0
- }
- func (miner *Miner) SetExtra(extra []byte) error {
- if uint64(len(extra)) > params.MaximumExtraDataSize {
- return fmt.Errorf("extra exceeds max length. %d > %v", len(extra), params.MaximumExtraDataSize)
- }
- miner.worker.setExtra(extra)
- return nil
- }
- // SetRecommitInterval sets the interval for sealing work resubmitting.
- func (miner *Miner) SetRecommitInterval(interval time.Duration) {
- miner.worker.setRecommitInterval(interval)
- }
- // Pending returns the currently pending block and associated state.
- func (self *Miner) Pending(psi types.PrivateStateIdentifier) (*types.Block, *state.StateDB, *state.StateDB) {
- return self.worker.pending(psi)
- }
- // 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 *Miner) PendingBlock() *types.Block {
- return miner.worker.pendingBlock()
- }
- func (miner *Miner) SetEtherbase(addr common.Address) {
- miner.coinbase = addr
- miner.worker.setEtherbase(addr)
- }
- // 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 *Miner) EnablePreseal() {
- miner.worker.enablePreseal()
- }
- // 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 *Miner) DisablePreseal() {
- miner.worker.disablePreseal()
- }
- // SubscribePendingLogs starts delivering logs from pending transactions
- // to the given channel.
- func (miner *Miner) SubscribePendingLogs(ch chan<- []*types.Log) event.Subscription {
- return miner.worker.pendingLogsFeed.Subscribe(ch)
- }
|