Documentation
¶
Overview ¶
Package miner implements Ethereum block creation and mining.
Index ¶
- Variables
- type Backend
- type BuildPayloadArgs
- type Config
- type Miner
- func (miner *Miner) BuildPayload(args *BuildPayloadArgs) (*Payload, error)
- func (miner *Miner) Close()
- 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()
- func (miner *Miner) SubscribePendingLogs(ch chan<- []*types.Log) event.Subscription
- type Payload
Constants ¶
This section is empty.
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.
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 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)
}
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:",omitempty"` // Public address for block mining rewards
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.
NewPayloadTimeout time.Duration // The maximum time allowance for creating a new payload
}
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) BuildPayload ¶
func (miner *Miner) BuildPayload(args *BuildPayloadArgs) (*Payload, error)
BuildPayload builds the payload according to the provided parameters.
func (*Miner) Pending ¶
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 ¶
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) PendingBlockAndReceipts ¶
PendingBlockAndReceipts returns the currently pending block and corresponding receipts. The returned values can be nil in case the pending block is not initialized.
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) 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.
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