|
| 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 | + "github.com/ethereum/go-ethereum/common" |
| 22 | + "github.com/ethereum/go-ethereum/core/state" |
| 23 | + "github.com/ethereum/go-ethereum/core/types" |
| 24 | + "github.com/ethereum/go-ethereum/params" |
| 25 | + "github.com/ethereum/go-ethereum/rpc" |
| 26 | +) |
| 27 | + |
| 28 | +// ChainReader defines a small collection of methods needed to access the local |
| 29 | +// blockchain during header and/or uncle verification. |
| 30 | +type ChainReader interface { |
| 31 | + // Config retrieves the blockchain's chain configuration. |
| 32 | + Config() *params.ChainConfig |
| 33 | + |
| 34 | + // CurrentHeader retrieves the current header from the local chain. |
| 35 | + CurrentHeader() *types.Header |
| 36 | + |
| 37 | + // GetHeader retrieves a block header from the database by hash and number. |
| 38 | + GetHeader(hash common.Hash, number uint64) *types.Header |
| 39 | + |
| 40 | + // GetHeaderByNumber retrieves a block header from the database by number. |
| 41 | + GetHeaderByNumber(number uint64) *types.Header |
| 42 | + |
| 43 | + // GetBlock retrieves a block from the database by hash and number. |
| 44 | + GetBlock(hash common.Hash, number uint64) *types.Block |
| 45 | +} |
| 46 | + |
| 47 | +// Engine is an algorithm agnostic consensus engine. |
| 48 | +type Engine interface { |
| 49 | + // VerifyHeader checks whether a header conforms to the consensus rules of a |
| 50 | + // given engine. Verifying the seal may be done optionally here, or explicitly |
| 51 | + // via the VerifySeal method. |
| 52 | + VerifyHeader(chain ChainReader, header *types.Header, seal bool) error |
| 53 | + |
| 54 | + // VerifyHeaders is similar to VerifyHeader, but verifies a batch of headers |
| 55 | + // concurrently. The method returns a quit channel to abort the operations and |
| 56 | + // a results channel to retrieve the async verifications (the order is that of |
| 57 | + // the input slice). |
| 58 | + VerifyHeaders(chain ChainReader, headers []*types.Header, seals []bool) (chan<- struct{}, <-chan error) |
| 59 | + |
| 60 | + // VerifyUncles verifies that the given block's uncles conform to the consensus |
| 61 | + // rules of a given engine. |
| 62 | + VerifyUncles(chain ChainReader, block *types.Block) error |
| 63 | + |
| 64 | + // VerifySeal checks whether the crypto seal on a header is valid according to |
| 65 | + // the consensus rules of the given engine. |
| 66 | + VerifySeal(chain ChainReader, header *types.Header) error |
| 67 | + |
| 68 | + // Prepare initializes the consensus fields of a block header according to the |
| 69 | + // rules of a particular engine. The changes are executed inline. |
| 70 | + Prepare(chain ChainReader, header *types.Header) error |
| 71 | + |
| 72 | + // Finalize runs any post-transaction state modifications (e.g. block rewards) |
| 73 | + // and assembles the final block. |
| 74 | + // |
| 75 | + // Note, the block header and state database might be updated to reflect any |
| 76 | + // consensus rules that happen at finalization (e.g. block rewards). |
| 77 | + Finalize(chain ChainReader, header *types.Header, state *state.StateDB, txs []*types.Transaction, |
| 78 | + uncles []*types.Header, receipts []*types.Receipt) (*types.Block, error) |
| 79 | + |
| 80 | + // Seal generates a new block for the given input block with the local miner's |
| 81 | + // seal place on top. |
| 82 | + Seal(chain ChainReader, block *types.Block, stop <-chan struct{}) (*types.Block, error) |
| 83 | + |
| 84 | + // APIs returns the RPC APIs this consensus engine provides. |
| 85 | + APIs(chain ChainReader) []rpc.API |
| 86 | +} |
| 87 | + |
| 88 | +// PoW is a consensus engine based on proof-of-work. |
| 89 | +type PoW interface { |
| 90 | + Engine |
| 91 | + |
| 92 | + // Hashrate returns the current mining hashrate of a PoW consensus engine. |
| 93 | + Hashrate() float64 |
| 94 | +} |
0 commit comments