mirror of
https://github.com/ethereum/go-ethereum.git
synced 2026-08-20 10:52:25 +00:00
240 lines
9.2 KiB
Go
240 lines
9.2 KiB
Go
// 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"
|
|
"sync"
|
|
"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/txpool"
|
|
"github.com/ethereum/go-ethereum/core/types"
|
|
"github.com/ethereum/go-ethereum/log"
|
|
"github.com/ethereum/go-ethereum/metrics"
|
|
"github.com/ethereum/go-ethereum/params"
|
|
)
|
|
|
|
// Backend wraps all methods required for mining. Only full node is capable
|
|
// to offer all the functions here.
|
|
type Backend interface {
|
|
BlockChain() *core.BlockChain
|
|
TxPool() *txpool.TxPool
|
|
}
|
|
|
|
// Config is the configuration parameters of mining.
|
|
type Config struct {
|
|
Etherbase common.Address `toml:"-"` // Deprecated
|
|
PendingFeeRecipient common.Address `toml:"-"` // Address for pending block rewards.
|
|
ExtraData hexutil.Bytes `toml:",omitempty"` // Block extra data set by the miner
|
|
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.
|
|
}
|
|
|
|
// DefaultConfig contains default settings for miner.
|
|
var DefaultConfig = Config{
|
|
GasCeil: 30_000_000,
|
|
GasPrice: big.NewInt(params.GWei),
|
|
|
|
// The default recommit time is chosen as two seconds since
|
|
// consensus-layer usually will wait a half slot of time(6s)
|
|
// for payload generation. It should be enough for Geth to
|
|
// run 3 rounds.
|
|
Recommit: 2 * time.Second,
|
|
}
|
|
|
|
// Miner is the main object which takes care of submitting new work to consensus
|
|
// engine and gathering the sealing result.
|
|
type Miner struct {
|
|
confMu sync.RWMutex // The lock used to protect the config fields: GasCeil, GasTip and Extradata
|
|
config *Config
|
|
chainConfig *params.ChainConfig
|
|
engine consensus.Engine
|
|
txpool *txpool.TxPool
|
|
chain *core.BlockChain
|
|
pending *pending
|
|
pendingMu sync.Mutex // Lock protects the pending block
|
|
}
|
|
|
|
// New creates a new miner with provided config.
|
|
func New(eth Backend, config Config, engine consensus.Engine) *Miner {
|
|
return &Miner{
|
|
config: &config,
|
|
chainConfig: eth.BlockChain().Config(),
|
|
engine: engine,
|
|
txpool: eth.TxPool(),
|
|
chain: eth.BlockChain(),
|
|
pending: &pending{},
|
|
}
|
|
}
|
|
|
|
// Pending returns the currently pending block and associated receipts, logs
|
|
// and statedb. The returned values can be nil in case the pending block is
|
|
// not initialized.
|
|
func (miner *Miner) Pending() (*types.Block, types.Receipts, *state.StateDB) {
|
|
pending := miner.getPending()
|
|
if pending == nil {
|
|
return nil, nil, nil
|
|
}
|
|
return pending.block, pending.receipts, pending.stateDB.Copy()
|
|
}
|
|
|
|
// SetExtra sets the content used to initialize the block extra field.
|
|
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.confMu.Lock()
|
|
miner.config.ExtraData = extra
|
|
miner.confMu.Unlock()
|
|
return nil
|
|
}
|
|
|
|
// SetGasCeil sets the gaslimit to strive for when mining blocks post 1559.
|
|
// For pre-1559 blocks, it sets the ceiling.
|
|
func (miner *Miner) SetGasCeil(ceil uint64) {
|
|
miner.confMu.Lock()
|
|
miner.config.GasCeil = ceil
|
|
miner.confMu.Unlock()
|
|
}
|
|
|
|
// SetGasTip sets the minimum gas tip for inclusion.
|
|
func (miner *Miner) SetGasTip(tip *big.Int) error {
|
|
miner.confMu.Lock()
|
|
miner.config.GasPrice = tip
|
|
miner.confMu.Unlock()
|
|
return nil
|
|
}
|
|
|
|
// BuildPayload builds the payload according to the provided parameters.
|
|
func (miner *Miner) BuildPayload(args *BuildPayloadArgs) (*Payload, error) {
|
|
return miner.buildPayload(args)
|
|
}
|
|
|
|
// getPending retrieves the pending block based on the current head block.
|
|
// The result might be nil if pending generation is failed.
|
|
func (miner *Miner) getPending() *newPayloadResult {
|
|
header := miner.chain.CurrentHeader()
|
|
miner.pendingMu.Lock()
|
|
defer miner.pendingMu.Unlock()
|
|
if cached := miner.pending.resolve(header.Hash()); cached != nil {
|
|
return cached
|
|
}
|
|
|
|
var (
|
|
timestamp = uint64(time.Now().Unix())
|
|
withdrawal types.Withdrawals
|
|
)
|
|
if miner.chainConfig.IsShanghai(new(big.Int).Add(header.Number, big.NewInt(1)), timestamp) {
|
|
withdrawal = []*types.Withdrawal{}
|
|
}
|
|
ret := miner.generateWork(&generateParams{
|
|
timestamp: timestamp,
|
|
forceTime: false,
|
|
parentHash: header.Hash(),
|
|
coinbase: miner.config.PendingFeeRecipient,
|
|
random: common.Hash{},
|
|
withdrawals: withdrawal,
|
|
beaconRoot: nil,
|
|
noTxs: false,
|
|
})
|
|
if ret.err != nil {
|
|
return nil
|
|
}
|
|
miner.pending.update(header.Hash(), ret)
|
|
return ret
|
|
}
|
|
|
|
// ReportFeeMetrics injects a few miner metrics based on live blocks matched with
|
|
// previously locally proposed blocks.
|
|
func (miner *Miner) ReportFeeMetrics(payload *Payload, block *types.Block) {
|
|
// Skip everything if something's screwy being sent to us
|
|
if payload.full == nil {
|
|
return
|
|
}
|
|
// Report all the local recommits into individual metrics
|
|
for i := len(payload.recommits) - 1; i >= 0; i-- {
|
|
// Track the generated fees in the metrics
|
|
gauge := fmt.Sprintf("%s/%d", blockRecommitFeeGaugeName, len(payload.recommits)-i-1)
|
|
metrics.GetOrRegisterResettingGauge(gauge, nil).Update(new(big.Int).Div(payload.recommits[i], bigGwei).Int64())
|
|
}
|
|
// Report the local proposed fees into its own metric
|
|
blockProposedFeeGauge.Update(new(big.Int).Div(payload.fullFees, bigGwei).Int64())
|
|
|
|
// If the local fee recipient is the zero address, we're running in benchmark
|
|
// mode. In this case we cannot know if a block is or is not MEV. In this case,
|
|
// case, assume that MEV blocks will do a final tx to the actual fee recipient
|
|
// from the coinbase and hope it's a goon enough heuristic.
|
|
if payload.full.Coinbase() == (common.Address{}) {
|
|
if count := len(block.Transactions()); count > 0 {
|
|
payout := block.Transactions()[count-1]
|
|
|
|
payer, err := types.Sender(types.LatestSignerForChainID(miner.chainConfig.ChainID), payout)
|
|
if err != nil {
|
|
log.Error("Failed to retrieve potential MEV sender", "err", err)
|
|
return
|
|
}
|
|
if block.Coinbase() == payer {
|
|
// The fee recipient made the last transaction, possibly MEV block
|
|
mevInEther := new(big.Float).Quo(new(big.Float).SetInt(payout.Value()), big.NewFloat(params.Ether))
|
|
feeInEther := new(big.Float).Quo(new(big.Float).SetInt(payload.fullFees), big.NewFloat(params.Ether))
|
|
|
|
log.Info("MEV block detected", "reward", mevInEther, "local", feeInEther)
|
|
blockIncludedFeeGauge.Update(new(big.Int).Div(payout.Value(), bigGwei).Int64())
|
|
} else {
|
|
// Possibly not an MEV block, report the boring mining fees
|
|
feeInEther := new(big.Float).Quo(new(big.Float).SetInt(payload.fullFees), big.NewFloat(params.Ether))
|
|
|
|
log.Info("Plain block detected", "reward", feeInEther)
|
|
blockIncludedFeeGauge.Update(new(big.Int).Div(payload.fullFees, bigGwei).Int64())
|
|
}
|
|
}
|
|
} else if payload.full.Coinbase() != block.Coinbase() {
|
|
// We are not in benchmarking mode and out proposed fee recipient is
|
|
// different from the live reward recipient. Definitely an MEV block.
|
|
// Try to extract the rewards.
|
|
if count := len(block.Transactions()); count > 0 {
|
|
payout := block.Transactions()[count-1]
|
|
if payout.To() != nil && *payout.To() == payload.full.Coinbase() {
|
|
mevInEther := new(big.Float).Quo(new(big.Float).SetInt(payout.Value()), big.NewFloat(params.Ether))
|
|
feeInEther := new(big.Float).Quo(new(big.Float).SetInt(payload.fullFees), big.NewFloat(params.Ether))
|
|
|
|
log.Info("MEV reward received", "reward", mevInEther, "local", feeInEther)
|
|
blockIncludedFeeGauge.Update(new(big.Int).Div(payout.Value(), bigGwei).Int64())
|
|
} else {
|
|
// Unknown MEV block, report the boring mining fees
|
|
feeInEther := new(big.Float).Quo(new(big.Float).SetInt(payload.fullFees), big.NewFloat(params.Ether))
|
|
|
|
log.Warn("MEV block detected, unknown reward", "reward", "unknown", "local", feeInEther)
|
|
blockIncludedFeeGauge.Update(new(big.Int).Div(payload.fullFees, bigGwei).Int64())
|
|
}
|
|
}
|
|
} else {
|
|
// Probably not an MEV block, report the boring mining fees
|
|
feeInEther := new(big.Float).Quo(new(big.Float).SetInt(payload.fullFees), big.NewFloat(params.Ether))
|
|
|
|
log.Info("Plain reward received", "reward", feeInEther)
|
|
blockIncludedFeeGauge.Update(new(big.Int).Div(payload.fullFees, bigGwei).Int64())
|
|
}
|
|
}
|