miner

Documentation

Overview

Package miner implements Ethereum block creation and mining.

Index

• Variables
• type Backend
• type BuildPayloadArgs
  • func (args *BuildPayloadArgs) Id() engine.PayloadID
• type Config
• type Miner
  • func New(eth Backend, config Config, engine consensus.Engine) *Miner
  • func (miner *Miner) BuildPayload(args *BuildPayloadArgs, witness bool) (*Payload, error)
  • func (miner *Miner) Pending() (*types.Block, types.Receipts, *state.StateDB)
  • func (miner *Miner) SetExtra(extra []byte) error
  • func (miner *Miner) SetGasCeil(ceil uint64)
  • func (miner *Miner) SetGasTip(tip *big.Int) error
• type Payload
  • func (payload *Payload) Resolve() *engine.ExecutionPayloadEnvelope
  • func (payload *Payload) ResolveEmpty() *engine.ExecutionPayloadEnvelope
  • func (payload *Payload) ResolveFull() *engine.ExecutionPayloadEnvelope

Variables

var DefaultConfig = Config{
	GasCeil:  30_000_000,
	GasPrice: big.NewInt(params.GWei / 1000),

	Recommit: 2 * time.Second,
}

DefaultConfig contains default settings for miner.

Types

type Backend

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

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 {
	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.
}

Config is the configuration parameters of mining.

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.

func New

func New(eth Backend, config Config, engine consensus.Engine) *Miner

New creates a new miner with provided config.

func (*Miner) BuildPayload

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

BuildPayload builds the payload according to the provided parameters.

func (*Miner) Pending

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

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

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

SetExtra sets the content used to initialize the block extra field.

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

SetGasTip sets the minimum gas tip for inclusion.

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.