miner

package
v1.10.59 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 23, 2024 License: GPL-3.0, GPL-3.0 Imports: 20 Imported by: 0

Documentation

Overview

Package miner implements Cortex block creation and mining.

Index

Constants

This section is empty.

Variables

View Source
var DefaultConfig = Config{
	GasFloor: params.MinerGasFloor,
	GasCeil:  params.MinerGasCeil,
	GasPrice: big.NewInt(params.GWei / 1000),
	Recommit: 3 * time.Second,
}

Functions

This section is empty.

Types

type Backend

type Backend interface {
	BlockChain() *core.BlockChain
	TxPool() *txpool.TxPool
	CheckPoint() uint64
	CheckPointName() string
}

Backend wraps all methods required for mining.

type Config added in v1.10.2

type Config struct {
	Coinbase  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 cuckoo).
	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 cuckoo).

	Cuda    bool
	Devices string
}

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 New

func New(ctxc Backend, config *Config, chainConfig *params.ChainConfig, mux *event.TypeMux, engine consensus.Engine, isLocalBlock func(block *types.Block) bool) *Miner

New create an instance of Miner

func (*Miner) Close

func (miner *Miner) Close()

func (*Miner) DisablePreseal added in v1.10.3

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 added in v1.10.3

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) 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 added in v1.10.34

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

PendingBlockAndReceipts returns the currently pending block and corresponding receipts.

func (*Miner) SetCoinbase added in v1.0.0

func (miner *Miner) SetCoinbase(addr common.Address)

func (*Miner) SetExtra

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

func (*Miner) SetGasCeil added in v1.10.25

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(coinbase common.Address)

func (*Miner) Stop

func (miner *Miner) Stop()

func (*Miner) SubscribePendingLogs added in v1.10.3

func (miner *Miner) SubscribePendingLogs(ch chan<- []*types.Log) event.Subscription

SubscribePendingLogs starts delivering logs from pending transactions to the given channel.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL