github.com/luckypickle/go-ethereum-vet@v1.14.2/consensus/consensus.go (about)

     1  // Copyright 2017 The go-ethereum Authors
     2  // This file is part of the go-ethereum library.
     3  //
     4  // The go-ethereum library is free software: you can redistribute it and/or modify
     5  // it under the terms of the GNU Lesser General Public License as published by
     6  // the Free Software Foundation, either version 3 of the License, or
     7  // (at your option) any later version.
     8  //
     9  // The go-ethereum library is distributed in the hope that it will be useful,
    10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
    11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    12  // GNU Lesser General Public License for more details.
    13  //
    14  // You should have received a copy of the GNU Lesser General Public License
    15  // along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
    16  
    17  // Package consensus implements different Ethereum consensus engines.
    18  package consensus
    19  
    20  import (
    21  	"math/big"
    22  
    23  	"github.com/luckypickle/go-ethereum-vet/common"
    24  	"github.com/luckypickle/go-ethereum-vet/core/state"
    25  	"github.com/luckypickle/go-ethereum-vet/core/types"
    26  	"github.com/luckypickle/go-ethereum-vet/params"
    27  	"github.com/luckypickle/go-ethereum-vet/rpc"
    28  )
    29  
    30  // ChainReader defines a small collection of methods needed to access the local
    31  // blockchain during header and/or uncle verification.
    32  type ChainReader interface {
    33  	// Config retrieves the blockchain's chain configuration.
    34  	Config() *params.ChainConfig
    35  
    36  	// CurrentHeader retrieves the current header from the local chain.
    37  	CurrentHeader() *types.Header
    38  
    39  	// GetHeader retrieves a block header from the database by hash and number.
    40  	GetHeader(hash common.Hash, number uint64) *types.Header
    41  
    42  	// GetHeaderByNumber retrieves a block header from the database by number.
    43  	GetHeaderByNumber(number uint64) *types.Header
    44  
    45  	// GetHeaderByHash retrieves a block header from the database by its hash.
    46  	GetHeaderByHash(hash common.Hash) *types.Header
    47  
    48  	// GetBlock retrieves a block from the database by hash and number.
    49  	GetBlock(hash common.Hash, number uint64) *types.Block
    50  }
    51  
    52  // Engine is an algorithm agnostic consensus engine.
    53  type Engine interface {
    54  	// Author retrieves the Ethereum address of the account that minted the given
    55  	// block, which may be different from the header's coinbase if a consensus
    56  	// engine is based on signatures.
    57  	Author(header *types.Header) (common.Address, error)
    58  
    59  	// VerifyHeader checks whether a header conforms to the consensus rules of a
    60  	// given engine. Verifying the seal may be done optionally here, or explicitly
    61  	// via the VerifySeal method.
    62  	VerifyHeader(chain ChainReader, header *types.Header, seal bool) error
    63  
    64  	// VerifyHeaders is similar to VerifyHeader, but verifies a batch of headers
    65  	// concurrently. The method returns a quit channel to abort the operations and
    66  	// a results channel to retrieve the async verifications (the order is that of
    67  	// the input slice).
    68  	VerifyHeaders(chain ChainReader, headers []*types.Header, seals []bool) (chan<- struct{}, <-chan error)
    69  
    70  	// VerifyUncles verifies that the given block's uncles conform to the consensus
    71  	// rules of a given engine.
    72  	VerifyUncles(chain ChainReader, block *types.Block) error
    73  
    74  	// VerifySeal checks whether the crypto seal on a header is valid according to
    75  	// the consensus rules of the given engine.
    76  	VerifySeal(chain ChainReader, header *types.Header) error
    77  
    78  	// Prepare initializes the consensus fields of a block header according to the
    79  	// rules of a particular engine. The changes are executed inline.
    80  	Prepare(chain ChainReader, header *types.Header) error
    81  
    82  	// Finalize runs any post-transaction state modifications (e.g. block rewards)
    83  	// and assembles the final block.
    84  	// Note: The block header and state database might be updated to reflect any
    85  	// consensus rules that happen at finalization (e.g. block rewards).
    86  	Finalize(chain ChainReader, header *types.Header, state *state.StateDB, txs []*types.Transaction,
    87  		uncles []*types.Header, receipts []*types.Receipt) (*types.Block, error)
    88  
    89  	// Seal generates a new block for the given input block with the local miner's
    90  	// seal place on top.
    91  	Seal(chain ChainReader, block *types.Block, stop <-chan struct{}) (*types.Block, error)
    92  
    93  	// CalcDifficulty is the difficulty adjustment algorithm. It returns the difficulty
    94  	// that a new block should have.
    95  	CalcDifficulty(chain ChainReader, time uint64, parent *types.Header) *big.Int
    96  
    97  	// APIs returns the RPC APIs this consensus engine provides.
    98  	APIs(chain ChainReader) []rpc.API
    99  
   100  	// Close terminates any background threads maintained by the consensus engine.
   101  	Close() error
   102  }
   103  
   104  // PoW is a consensus engine based on proof-of-work.
   105  type PoW interface {
   106  	Engine
   107  
   108  	// Hashrate returns the current mining hashrate of a PoW consensus engine.
   109  	Hashrate() float64
   110  }