miner

Documentation

Overview

Package miner implements Ethereum block creation and mining.

Index

• Variables
• func NewDBForFakes(t TensingObject) (ethdb.Database, *core.Genesis, *params.ChainConfig)
• func NewFakeBor(t TensingObject, chainDB ethdb.Database, chainConfig *params.ChainConfig, ...) consensus.Engine
• func NewMockBackend(bc *core.BlockChain, txPool *txpool.TxPool) *mockBackend
• func NewTestWorker(t TensingObject, chainConfig *params.ChainConfig, engine consensus.Engine, ...) (*worker, *testWorkerBackend, func())
• type Backend
• type BuildPayloadArgs
  • func (args *BuildPayloadArgs) Id() engine.PayloadID
• type Config
• type DefaultBorMiner
  • func NewBorDefaultMiner(t *testing.T) *DefaultBorMiner
• type Miner
  • func New(eth Backend, config *Config, chainConfig *params.ChainConfig, ...) *Miner
  • func (miner *Miner) BuildPayload(args *BuildPayloadArgs) (*Payload, error)
  • func (miner *Miner) Close()
  • func (miner *Miner) DisablePreseal()
  • func (miner *Miner) EnablePreseal()
  • func (miner *Miner) GetWorker() *worker
  • func (miner *Miner) Hashrate() uint64
  • func (miner *Miner) Mining() bool
  • func (miner *Miner) Pending() (*types.Block, *state.StateDB)
  • func (miner *Miner) PendingBlock() *types.Block
  • func (miner *Miner) PendingBlockAndReceipts() (*types.Block, types.Receipts)
  • func (miner *Miner) SetEtherbase(addr common.Address)
  • func (miner *Miner) SetExtra(extra []byte) error
  • func (miner *Miner) SetGasCeil(ceil uint64)
  • func (miner *Miner) SetRecommitInterval(interval time.Duration)
  • func (miner *Miner) Start()
  • func (miner *Miner) Stop(ch chan struct{})
  • func (miner *Miner) SubscribePendingLogs(ch chan<- []*types.Log) event.Subscription
• type Payload
  • func (payload *Payload) Resolve() *engine.ExecutionPayloadEnvelope
  • func (payload *Payload) ResolveEmpty() *engine.ExecutionPayloadEnvelope
  • func (payload *Payload) ResolveFull() *engine.ExecutionPayloadEnvelope
• type TensingObject

Variables

var DefaultConfig = Config{
	GasCeil:  30000000,
	GasPrice: big.NewInt(params.GWei),

	Recommit:          2 * time.Second,
	NewPayloadTimeout: 2 * time.Second,
}

DefaultConfig contains default settings for miner.

var (
	TestBankAddress = crypto.PubkeyToAddress(testBankKey.PublicKey)
)

Functions

func NewDBForFakes

func NewDBForFakes(t TensingObject) (ethdb.Database, *core.Genesis, *params.ChainConfig)

func NewFakeBor

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

func NewMockBackend

func NewMockBackend(bc *core.BlockChain, txPool *txpool.TxPool) *mockBackend

func NewTestWorker

func NewTestWorker(t TensingObject, chainConfig *params.ChainConfig, engine consensus.Engine, db ethdb.Database, blocks int, noempty bool, delay uint, opcodeDelay uint) (*worker, *testWorkerBackend, func())

NewTestWorker creates a new test worker with the given parameters.

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
}

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/specification.md#payloadattributesv1

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:",omitempty"` // Public address for block mining rewards
	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).
	CommitInterruptFlag bool           // Interrupt commit when time is up ( default = true)

	NewPayloadTimeout time.Duration // The maximum time allowance for creating a new payload
}

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 creates blocks and searches for proof-of-work values. 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) *Miner

func (*Miner) BuildPayload

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

BuildPayload builds the payload according to the provided parameters.

func (*Miner) Close

func (miner *Miner) Close()

func (*Miner) DisablePreseal

func (miner *Miner) DisablePreseal()

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

func (miner *Miner) EnablePreseal()

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) 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, *state.StateDB)

Pending returns the currently pending block and associated state.

func (*Miner) PendingBlock

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

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

func (miner *Miner) PendingBlockAndReceipts() (*types.Block, types.Receipts)

PendingBlockAndReceipts returns the currently pending block and corresponding receipts.

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) 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. It's only used in tests.

type TensingObject

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