Documentation
¶
Overview ¶
Package miner implements Ethereum block creation and mining.
Index ¶
- type Backend
- type BuildPayloadArgs
- type Config
- type Miner
- func (self *Miner) Close()
- func (self *Miner) HashRate() uint64
- func (self *Miner) Mining() bool
- func (self *Miner) Pending() (*types.Block, *state.StateDB)
- func (self *Miner) PendingBlock() *types.Block
- func (self *Miner) SetEtherbase(addr common.Address)
- func (self *Miner) SetExtra(extra []byte) error
- func (self *Miner) SetRecommitInterval(interval time.Duration)
- func (self *Miner) Start(coinbase common.Address)
- func (self *Miner) Stop()
- 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() *core.TxPool
}
Backend wraps all methods required for mining.
type BuildPayloadArgs ¶ added in v1.0.1
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 ¶ added in v1.0.1
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 (default = first account)
Notify []string `toml:",omitempty"` // HTTP URL list to be notified of new work packages(only useful in ethash).
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).
}
Config is the configuration parameters of mining.
type Miner ¶
type Miner struct {
// contains filtered or unexported fields
}
Miner creates blocks and searches for proof-of-work values.
func (*Miner) PendingBlock ¶
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) SetEtherbase ¶
func (*Miner) SetRecommitInterval ¶
SetRecommitInterval sets the interval for sealing work resubmitting.
type Payload ¶ added in v1.0.1
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 ¶ added in v1.0.1
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 ¶ added in v1.0.1
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 ¶ added in v1.0.1
func (payload *Payload) ResolveFull() *engine.ExecutionPayloadEnvelope
ResolveFull is basically identical to Resolve, but it expects full block only. It's only used in tests.
Source Files
Directories