Documentation

Overview

    Package miner implements Ethereum block creation and mining.

    Index

    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 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 New

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

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

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

                  func (*Miner) SetExtra

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

                  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

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

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