2015-07-06 19:54:22 -05:00
|
|
|
// Copyright 2014 The go-ethereum Authors
|
2015-07-22 11:48:40 -05:00
|
|
|
// This file is part of the go-ethereum library.
|
2015-07-06 19:54:22 -05:00
|
|
|
//
|
2015-07-23 11:35:11 -05:00
|
|
|
// The go-ethereum library is free software: you can redistribute it and/or modify
|
2015-07-06 19:54:22 -05:00
|
|
|
// 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.
|
|
|
|
//
|
2015-07-22 11:48:40 -05:00
|
|
|
// The go-ethereum library is distributed in the hope that it will be useful,
|
2015-07-06 19:54:22 -05:00
|
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
2015-07-22 11:48:40 -05:00
|
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
2015-07-06 19:54:22 -05:00
|
|
|
// GNU Lesser General Public License for more details.
|
|
|
|
//
|
|
|
|
// You should have received a copy of the GNU Lesser General Public License
|
2015-07-22 11:48:40 -05:00
|
|
|
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
|
2015-07-06 19:54:22 -05:00
|
|
|
|
2015-07-06 22:08:16 -05:00
|
|
|
// Package miner implements Ethereum block creation and mining.
|
2014-10-31 08:56:42 -05:00
|
|
|
package miner
|
|
|
|
|
|
|
|
import (
|
2015-08-07 05:12:05 -05:00
|
|
|
"fmt"
|
2019-04-23 02:08:51 -05:00
|
|
|
"math/big"
|
2015-05-14 17:43:00 -05:00
|
|
|
"sync/atomic"
|
2018-08-21 14:56:54 -05:00
|
|
|
"time"
|
2014-10-31 08:56:42 -05:00
|
|
|
|
2015-03-18 07:00:01 -05:00
|
|
|
"github.com/ethereum/go-ethereum/common"
|
2019-04-23 02:08:51 -05:00
|
|
|
"github.com/ethereum/go-ethereum/common/hexutil"
|
2017-04-04 17:16:29 -05:00
|
|
|
"github.com/ethereum/go-ethereum/consensus"
|
2015-02-17 05:24:51 -06:00
|
|
|
"github.com/ethereum/go-ethereum/core"
|
2015-04-07 05:32:55 -05:00
|
|
|
"github.com/ethereum/go-ethereum/core/state"
|
|
|
|
"github.com/ethereum/go-ethereum/core/types"
|
2015-05-14 17:43:00 -05:00
|
|
|
"github.com/ethereum/go-ethereum/eth/downloader"
|
|
|
|
"github.com/ethereum/go-ethereum/event"
|
2017-02-22 06:10:07 -06:00
|
|
|
"github.com/ethereum/go-ethereum/log"
|
2015-08-07 05:12:05 -05:00
|
|
|
"github.com/ethereum/go-ethereum/params"
|
2014-10-31 08:56:42 -05:00
|
|
|
)
|
|
|
|
|
2016-08-15 13:14:05 -05:00
|
|
|
// Backend wraps all methods required for mining.
|
|
|
|
type Backend interface {
|
|
|
|
BlockChain() *core.BlockChain
|
|
|
|
TxPool() *core.TxPool
|
|
|
|
}
|
|
|
|
|
2019-04-23 02:08:51 -05:00
|
|
|
// 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).
|
|
|
|
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).
|
|
|
|
}
|
|
|
|
|
2016-08-15 13:14:05 -05:00
|
|
|
// Miner creates blocks and searches for proof-of-work values.
|
2014-10-31 08:56:42 -05:00
|
|
|
type Miner struct {
|
2018-08-03 03:33:37 -05:00
|
|
|
mux *event.TypeMux
|
|
|
|
worker *worker
|
2015-05-14 17:43:00 -05:00
|
|
|
coinbase common.Address
|
2016-08-15 13:14:05 -05:00
|
|
|
eth Backend
|
2017-04-04 17:16:29 -05:00
|
|
|
engine consensus.Engine
|
2018-08-14 10:34:33 -05:00
|
|
|
exitCh chan struct{}
|
2015-05-14 17:43:00 -05:00
|
|
|
|
|
|
|
canStart int32 // can start indicates whether we can start the mining operation
|
|
|
|
shouldStart int32 // should start indicates whether we should start after sync
|
2014-11-07 05:18:48 -06:00
|
|
|
}
|
|
|
|
|
2019-04-23 02:08:51 -05:00
|
|
|
func New(eth Backend, config *Config, chainConfig *params.ChainConfig, mux *event.TypeMux, engine consensus.Engine, isLocalBlock func(block *types.Block) bool) *Miner {
|
2016-08-15 13:14:05 -05:00
|
|
|
miner := &Miner{
|
|
|
|
eth: eth,
|
|
|
|
mux: mux,
|
2017-04-04 17:16:29 -05:00
|
|
|
engine: engine,
|
2018-08-14 10:34:33 -05:00
|
|
|
exitCh: make(chan struct{}),
|
2019-11-20 04:36:41 -06:00
|
|
|
worker: newWorker(config, chainConfig, engine, eth, mux, isLocalBlock, true),
|
2016-08-15 13:14:05 -05:00
|
|
|
canStart: 1,
|
|
|
|
}
|
2015-05-14 17:43:00 -05:00
|
|
|
go miner.update()
|
|
|
|
|
|
|
|
return miner
|
2014-10-31 08:56:42 -05:00
|
|
|
}
|
|
|
|
|
2015-05-21 04:57:00 -05:00
|
|
|
// 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.
|
2019-11-24 13:46:34 -06:00
|
|
|
func (miner *Miner) update() {
|
|
|
|
events := miner.mux.Subscribe(downloader.StartEvent{}, downloader.DoneEvent{}, downloader.FailedEvent{})
|
2018-08-14 10:34:33 -05:00
|
|
|
defer events.Unsubscribe()
|
2015-05-14 17:43:00 -05:00
|
|
|
|
2018-08-14 10:34:33 -05:00
|
|
|
for {
|
|
|
|
select {
|
|
|
|
case ev := <-events.Chan():
|
|
|
|
if ev == nil {
|
|
|
|
return
|
|
|
|
}
|
|
|
|
switch ev.Data.(type) {
|
|
|
|
case downloader.StartEvent:
|
2019-11-24 13:46:34 -06:00
|
|
|
atomic.StoreInt32(&miner.canStart, 0)
|
|
|
|
if miner.Mining() {
|
|
|
|
miner.Stop()
|
|
|
|
atomic.StoreInt32(&miner.shouldStart, 1)
|
2018-08-14 10:34:33 -05:00
|
|
|
log.Info("Mining aborted due to sync")
|
|
|
|
}
|
|
|
|
case downloader.DoneEvent, downloader.FailedEvent:
|
2019-11-24 13:46:34 -06:00
|
|
|
shouldStart := atomic.LoadInt32(&miner.shouldStart) == 1
|
2018-08-14 10:34:33 -05:00
|
|
|
|
2019-11-24 13:46:34 -06:00
|
|
|
atomic.StoreInt32(&miner.canStart, 1)
|
|
|
|
atomic.StoreInt32(&miner.shouldStart, 0)
|
2018-08-14 10:34:33 -05:00
|
|
|
if shouldStart {
|
2019-11-24 13:46:34 -06:00
|
|
|
miner.Start(miner.coinbase)
|
2018-08-14 10:34:33 -05:00
|
|
|
}
|
|
|
|
// stop immediately and ignore all further pending events
|
|
|
|
return
|
2015-05-14 17:43:00 -05:00
|
|
|
}
|
2019-11-24 13:46:34 -06:00
|
|
|
case <-miner.exitCh:
|
2018-08-14 10:34:33 -05:00
|
|
|
return
|
2015-05-14 17:43:00 -05:00
|
|
|
}
|
|
|
|
}
|
2015-05-09 05:04:00 -05:00
|
|
|
}
|
|
|
|
|
2019-11-24 13:46:34 -06:00
|
|
|
func (miner *Miner) Start(coinbase common.Address) {
|
|
|
|
atomic.StoreInt32(&miner.shouldStart, 1)
|
|
|
|
miner.SetEtherbase(coinbase)
|
2015-05-14 17:43:00 -05:00
|
|
|
|
2019-11-24 13:46:34 -06:00
|
|
|
if atomic.LoadInt32(&miner.canStart) == 0 {
|
2017-04-04 17:16:29 -05:00
|
|
|
log.Info("Network syncing, will start miner afterwards")
|
2015-05-14 17:43:00 -05:00
|
|
|
return
|
|
|
|
}
|
2019-11-24 13:46:34 -06:00
|
|
|
miner.worker.start()
|
2014-10-31 08:56:42 -05:00
|
|
|
}
|
2014-11-07 05:18:48 -06:00
|
|
|
|
2019-11-24 13:46:34 -06:00
|
|
|
func (miner *Miner) Stop() {
|
|
|
|
miner.worker.stop()
|
|
|
|
atomic.StoreInt32(&miner.shouldStart, 0)
|
2015-05-11 08:43:14 -05:00
|
|
|
}
|
|
|
|
|
2019-11-24 13:46:34 -06:00
|
|
|
func (miner *Miner) Close() {
|
|
|
|
miner.worker.close()
|
|
|
|
close(miner.exitCh)
|
2015-10-29 07:28:00 -05:00
|
|
|
}
|
|
|
|
|
2019-11-24 13:46:34 -06:00
|
|
|
func (miner *Miner) Mining() bool {
|
|
|
|
return miner.worker.isRunning()
|
2015-05-14 17:43:00 -05:00
|
|
|
}
|
|
|
|
|
2019-11-24 13:46:34 -06:00
|
|
|
func (miner *Miner) HashRate() uint64 {
|
|
|
|
if pow, ok := miner.engine.(consensus.PoW); ok {
|
2018-08-03 03:33:37 -05:00
|
|
|
return uint64(pow.Hashrate())
|
2015-08-06 04:58:14 -05:00
|
|
|
}
|
2018-08-03 03:33:37 -05:00
|
|
|
return 0
|
2014-11-07 05:18:48 -06:00
|
|
|
}
|
2015-04-05 11:57:03 -05:00
|
|
|
|
2019-11-24 13:46:34 -06:00
|
|
|
func (miner *Miner) SetExtra(extra []byte) error {
|
2017-01-04 13:17:24 -06:00
|
|
|
if uint64(len(extra)) > params.MaximumExtraDataSize {
|
2019-11-24 13:46:34 -06:00
|
|
|
return fmt.Errorf("extra exceeds max length. %d > %v", len(extra), params.MaximumExtraDataSize)
|
2015-08-07 05:12:05 -05:00
|
|
|
}
|
2019-11-24 13:46:34 -06:00
|
|
|
miner.worker.setExtra(extra)
|
2015-08-07 05:12:05 -05:00
|
|
|
return nil
|
2015-04-05 11:57:03 -05:00
|
|
|
}
|
2015-04-07 05:32:55 -05:00
|
|
|
|
2018-08-21 14:56:54 -05:00
|
|
|
// SetRecommitInterval sets the interval for sealing work resubmitting.
|
2019-11-24 13:46:34 -06:00
|
|
|
func (miner *Miner) SetRecommitInterval(interval time.Duration) {
|
|
|
|
miner.worker.setRecommitInterval(interval)
|
2018-08-21 14:56:54 -05:00
|
|
|
}
|
|
|
|
|
2016-03-16 04:20:02 -05:00
|
|
|
// Pending returns the currently pending block and associated state.
|
2019-11-24 13:46:34 -06:00
|
|
|
func (miner *Miner) Pending() (*types.Block, *state.StateDB) {
|
|
|
|
return miner.worker.pending()
|
2015-04-07 05:32:55 -05:00
|
|
|
}
|
2015-07-07 03:58:47 -05:00
|
|
|
|
2016-11-30 03:48:48 -06:00
|
|
|
// PendingBlock returns the currently pending block.
|
2016-12-13 06:03:18 -06:00
|
|
|
//
|
|
|
|
// Note, to access both the pending block and the pending state
|
|
|
|
// simultaneously, please use Pending(), as the pending state can
|
2016-11-30 03:48:48 -06:00
|
|
|
// change between multiple method calls
|
2019-11-24 13:46:34 -06:00
|
|
|
func (miner *Miner) PendingBlock() *types.Block {
|
|
|
|
return miner.worker.pendingBlock()
|
2016-11-30 03:48:48 -06:00
|
|
|
}
|
|
|
|
|
2019-11-24 13:46:34 -06:00
|
|
|
func (miner *Miner) SetEtherbase(addr common.Address) {
|
|
|
|
miner.coinbase = addr
|
|
|
|
miner.worker.setEtherbase(addr)
|
2015-07-07 03:58:47 -05:00
|
|
|
}
|
2019-12-10 05:39:14 -06:00
|
|
|
|
2020-05-12 05:11:34 -05:00
|
|
|
// 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()
|
|
|
|
}
|
|
|
|
|
2019-12-10 05:39:14 -06:00
|
|
|
// SubscribePendingLogs starts delivering logs from pending transactions
|
|
|
|
// to the given channel.
|
|
|
|
func (self *Miner) SubscribePendingLogs(ch chan<- []*types.Log) event.Subscription {
|
|
|
|
return self.worker.pendingLogsFeed.Subscribe(ch)
|
|
|
|
}
|