Documentation
¶
Overview ¶
Package miner implements Ethereum block creation and mining.
Index ¶
- type Backend
- type BidRuntime
- type BuildPayloadArgs
- type Miner
- func (miner *Miner) AddBuilder(builder common.Address, url string) error
- func (miner *Miner) BestPackedBlockReward(parentHash common.Hash) *big.Int
- func (miner *Miner) BuildPayload(args *BuildPayloadArgs, witness bool) (*Payload, error)
- func (miner *Miner) Close()
- func (miner *Miner) GasCeil() uint64
- func (miner *Miner) HasBuilder(builder common.Address) bool
- func (miner *Miner) InTurn() bool
- func (miner *Miner) MevParams() *types.MevParams
- func (miner *Miner) MevRunning() bool
- func (miner *Miner) Mining() bool
- func (miner *Miner) Pending() (*types.Block, types.Receipts, *state.StateDB)
- func (miner *Miner) RemoveBuilder(builderAddr common.Address) error
- func (miner *Miner) SendBid(ctx context.Context, bidArgs *types.BidArgs) (common.Hash, error)
- func (miner *Miner) SetEtherbase(addr common.Address)
- func (miner *Miner) SetExtra(extra []byte) error
- func (miner *Miner) SetGasCeil(ceil uint64)
- func (miner *Miner) SetGasTip(tip *big.Int) error
- func (miner *Miner) SetPrioAddresses(prio []common.Address)
- func (miner *Miner) SetRecommitInterval(interval time.Duration)
- func (miner *Miner) Start()
- func (miner *Miner) StartMev()
- func (miner *Miner) Stop()
- func (miner *Miner) StopMev()
- func (miner *Miner) SubscribePendingLogs(ch chan<- []*types.Log) event.Subscription
- func (miner *Miner) TryWaitProposalDoneWhenStopping()
- type Payload
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
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 BidRuntime ¶
type BidRuntime struct {
// contains filtered or unexported fields
}
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 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 (*Miner) AddBuilder ¶
AddBuilder adds a builder to the bid simulator.
func (*Miner) BestPackedBlockReward ¶
func (*Miner) BuildPayload ¶
func (miner *Miner) BuildPayload(args *BuildPayloadArgs, witness bool) (*Payload, error)
BuildPayload builds the payload according to the provided parameters.
func (*Miner) HasBuilder ¶
HasBuilder returns true if the builder is in the builder list.
func (*Miner) MevRunning ¶
MevRunning return true if mev is running.
func (*Miner) 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) RemoveBuilder ¶
RemoveBuilder removes a builder from the bid simulator.
func (*Miner) SetEtherbase ¶
func (*Miner) SetGasCeil ¶
SetGasCeil sets the gaslimit to strive for when mining blocks post 1559. For pre-1559 blocks, it sets the ceiling.
func (*Miner) SetPrioAddresses ¶
SetPrioAddresses sets a list of addresses to prioritize for transaction inclusion.
func (*Miner) SetRecommitInterval ¶
SetRecommitInterval sets the interval for sealing work resubmitting.
func (*Miner) SubscribePendingLogs ¶
func (miner *Miner) SubscribePendingLogs(ch chan<- []*types.Log) event.Subscription
SubscribePendingLogs starts delivering logs from pending transactions to the given channel.
func (*Miner) TryWaitProposalDoneWhenStopping ¶
func (miner *Miner) TryWaitProposalDoneWhenStopping()
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.
Source Files
¶
Directories
¶
| Path | Synopsis |
|---|---|
|
Package miner implements Ethereum block creation and mining.
|
Package miner implements Ethereum block creation and mining. |