miner

package
v0.0.2-tenderly Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 23, 2026 License: GPL-3.0, LGPL-3.0 Imports: 52 Imported by: 0

Documentation

Overview

Package miner implements Ethereum block creation and mining.

Index

Constants

This section is empty.

Variables

View Source
var DefaultConfig = Config{

	GasCeil:  45_000_000,
	GasPrice: big.NewInt(params.BorDefaultMinerGasPrice),

	EnableDynamicGasLimit: false,
	GasLimitMin:           50_000_000,
	GasLimitMax:           65_000_000,
	TargetBaseFee:         500_000_000_000,
	BaseFeeBuffer:         300_000_000_000,

	Recommit:                2 * time.Second,
	EnablePrefetch:          true,
	PrefetchGasLimitPercent: 100,
}

DefaultConfig contains default settings for miner.

Functions

func NewFakeBor

func NewFakeBor(t TensingObject, chainDB ethdb.Database, chainConfig *params.ChainConfig, ethAPIMock api.Caller, spanner bor.Spanner, heimdallClientMock bor.IHeimdallClient, heimdallClientWSMock bor.IHeimdallWSClient, contractMock bor.GenesisContract) consensus.Engine

func NewMockBackendBor

func NewMockBackendBor(bc *core.BlockChain, txPool *txpool.TxPool) *mockBackendBor

Types

type Backend

type Backend interface {
	BlockChain() *core.BlockChain
	TxPool() *txpool.TxPool
	PeerCount() int
}

Backend wraps all methods required for mining. Only full node is capable to offer all the functions here.

type BuildPayloadArgs

type BuildPayloadArgs struct {
	Parent       common.Hash           // The parent block to build payload on top
	Timestamp    uint64                // The provided timestamp of generated payload
	FeeRecipient common.Address        // The provided recipient address for collecting transaction fee
	Random       common.Hash           // The provided randomness value
	Withdrawals  types.Withdrawals     // The provided withdrawals
	BeaconRoot   *common.Hash          // The provided beaconRoot (Cancun)
	Version      engine.PayloadVersion // Versioning byte for payload id calculation.
}

BuildPayloadArgs contains the provided parameters for building payload. Check engine-api specification for more details. https://github.com/ethereum/execution-apis/blob/main/src/engine/cancun.md#payloadattributesv3

func (*BuildPayloadArgs) Id

func (args *BuildPayloadArgs) Id() engine.PayloadID

Id computes an 8-byte identifier by hashing the components of the payload arguments.

type Config

type Config struct {
	AllowGasTipOverride bool           // Won't enforce the default min gas tip (25 gwei) if true and will use user provided value
	Etherbase           common.Address `toml:",omitempty"` // Public address for block mining rewards
	ExtraData           hexutil.Bytes  `toml:",omitempty"` // Block extra data set by the miner
	GasCeil             uint64         // Target gas ceiling for mined blocks.

	// Dynamic gas limit configuration
	EnableDynamicGasLimit bool   // Enable dynamic gas limit adjustment based on base fee
	GasLimitMin           uint64 // Minimum gas limit when dynamic gas limit is enabled
	GasLimitMax           uint64 // Maximum gas limit when dynamic gas limit is enabled
	TargetBaseFee         uint64 // Target base fee in wei for dynamic gas limit adjustment
	BaseFeeBuffer         uint64 // Buffer around target base fee in wei (no adjustment when within buffer)

	GasPrice            *big.Int      // Minimum gas price for mining a transaction
	Recommit            time.Duration // The time interval for miner to re-create mining work.
	CommitInterruptFlag bool          // Interrupt commit when time is up ( default = true)
	BlockTime           time.Duration // The block time defined by the miner. Needs to be larger or equal to the consensus block time. If not set (default = 0), the miner will use the consensus block time.

	NewPayloadTimeout       time.Duration  // The maximum time allowance for creating a new payload
	PendingFeeRecipient     common.Address `toml:"-"` // Address for pending block rewards.
	EnablePrefetch          bool           // Enable transaction prefetching from pool during block building
	PrefetchGasLimitPercent uint64         // Gas limit percentage for prefetching (e.g., 100 = 100%, 110 = 110%)
}

Config is the configuration parameters of mining.

type DefaultBorMiner

type DefaultBorMiner struct {
	Miner   *Miner
	Mux     *event.TypeMux //nolint:staticcheck
	Cleanup func(skipMiner bool)

	Ctrl               *gomock.Controller
	EthAPIMock         api.Caller
	HeimdallClientMock bor.IHeimdallClient
	ContractMock       bor.GenesisContract
}

func NewBorDefaultMiner

func NewBorDefaultMiner(t *testing.T) *DefaultBorMiner

type Miner

type Miner struct {
	// contains filtered or unexported fields
}

Miner is the main object which takes care of submitting new work to consensus engine and gathering the sealing result. nolint:staticcheck

func New

func New(eth Backend, config *Config, chainConfig *params.ChainConfig, mux *event.TypeMux, engine consensus.Engine, isLocalBlock func(header *types.Header) bool, makeWitness bool) *Miner

func (*Miner) BuildPayload

func (miner *Miner) BuildPayload(args *BuildPayloadArgs, witness bool) (*Payload, error)

BuildPayload builds the payload according to the provided parameters.

func (*Miner) Close

func (miner *Miner) Close()

func (*Miner) GetWorker

func (miner *Miner) GetWorker() *worker

func (*Miner) Hashrate

func (miner *Miner) Hashrate() uint64

func (*Miner) Mining

func (miner *Miner) Mining() bool

func (*Miner) Pending

func (miner *Miner) Pending() (*types.Block, types.Receipts, *state.StateDB)

Pending returns the currently pending block and associated state. The returned values can be nil in case the pending block is not initialized

func (*Miner) PendingBlock

func (miner *Miner) PendingBlock() *types.Block

PendingBlock returns the currently pending block. The returned block can be nil in case the pending block is not initialized.

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

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

func (*Miner) SetExtra

func (miner *Miner) SetExtra(extra []byte) error

func (*Miner) SetGasCeil

func (miner *Miner) SetGasCeil(ceil uint64)

SetGasCeil sets the gaslimit to strive for when mining blocks post 1559. For pre-1559 blocks, it sets the ceiling.

func (*Miner) SetGasTip

func (miner *Miner) SetGasTip(tip *big.Int) error

func (*Miner) SetPrioAddresses

func (miner *Miner) SetPrioAddresses(prio []common.Address)

SetPrioAddresses sets a list of addresses to prioritize for transaction inclusion.

func (*Miner) SetRecommitInterval

func (miner *Miner) SetRecommitInterval(interval time.Duration)

SetRecommitInterval sets the interval for sealing work resubmitting.

func (*Miner) Start

func (miner *Miner) Start()

func (*Miner) Stop

func (miner *Miner) Stop(ch chan struct{})

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 Payload

type Payload struct {
	// contains filtered or unexported fields
}

Payload wraps the built payload(block waiting for sealing). According to the engine-api specification, EL should build the initial version of the payload which has an empty transaction set and then keep update it in order to maximize the revenue. Therefore, the empty-block here is always available and full-block will be set/updated afterwards.

func (*Payload) Resolve

func (payload *Payload) Resolve() *engine.ExecutionPayloadEnvelope

Resolve returns the latest built payload and also terminates the background thread for updating payload. It's safe to be called multiple times.

func (*Payload) ResolveEmpty

func (payload *Payload) ResolveEmpty() *engine.ExecutionPayloadEnvelope

ResolveEmpty is basically identical to Resolve, but it expects empty block only. It's only used in tests.

func (*Payload) ResolveFull

func (payload *Payload) ResolveFull() *engine.ExecutionPayloadEnvelope

ResolveFull is basically identical to Resolve, but it expects full block only. Don't call Resolve until ResolveFull returns, otherwise it might block forever.

type TensingObject

type TensingObject interface {
	Helper()
	Fatalf(format string, args ...any)
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL