09777952ee
This commit adds pluggable consensus engines to go-ethereum. In short, it introduces a generic consensus interface, and refactors the entire codebase to use this interface.
95 lines
3.9 KiB
Go
95 lines
3.9 KiB
Go
// Copyright 2017 The go-ethereum Authors
|
|
// This file is part of the go-ethereum library.
|
|
//
|
|
// The go-ethereum library is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU Lesser General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// The go-ethereum library is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU Lesser General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU Lesser General Public License
|
|
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
// Package consensus implements different Ethereum consensus engines.
|
|
package consensus
|
|
|
|
import (
|
|
"github.com/ethereum/go-ethereum/common"
|
|
"github.com/ethereum/go-ethereum/core/state"
|
|
"github.com/ethereum/go-ethereum/core/types"
|
|
"github.com/ethereum/go-ethereum/params"
|
|
"github.com/ethereum/go-ethereum/rpc"
|
|
)
|
|
|
|
// ChainReader defines a small collection of methods needed to access the local
|
|
// blockchain during header and/or uncle verification.
|
|
type ChainReader interface {
|
|
// Config retrieves the blockchain's chain configuration.
|
|
Config() *params.ChainConfig
|
|
|
|
// CurrentHeader retrieves the current header from the local chain.
|
|
CurrentHeader() *types.Header
|
|
|
|
// GetHeader retrieves a block header from the database by hash and number.
|
|
GetHeader(hash common.Hash, number uint64) *types.Header
|
|
|
|
// GetHeaderByNumber retrieves a block header from the database by number.
|
|
GetHeaderByNumber(number uint64) *types.Header
|
|
|
|
// GetBlock retrieves a block from the database by hash and number.
|
|
GetBlock(hash common.Hash, number uint64) *types.Block
|
|
}
|
|
|
|
// Engine is an algorithm agnostic consensus engine.
|
|
type Engine interface {
|
|
// VerifyHeader checks whether a header conforms to the consensus rules of a
|
|
// given engine. Verifying the seal may be done optionally here, or explicitly
|
|
// via the VerifySeal method.
|
|
VerifyHeader(chain ChainReader, header *types.Header, seal bool) error
|
|
|
|
// VerifyHeaders is similar to VerifyHeader, but verifies a batch of headers
|
|
// concurrently. The method returns a quit channel to abort the operations and
|
|
// a results channel to retrieve the async verifications (the order is that of
|
|
// the input slice).
|
|
VerifyHeaders(chain ChainReader, headers []*types.Header, seals []bool) (chan<- struct{}, <-chan error)
|
|
|
|
// VerifyUncles verifies that the given block's uncles conform to the consensus
|
|
// rules of a given engine.
|
|
VerifyUncles(chain ChainReader, block *types.Block) error
|
|
|
|
// VerifySeal checks whether the crypto seal on a header is valid according to
|
|
// the consensus rules of the given engine.
|
|
VerifySeal(chain ChainReader, header *types.Header) error
|
|
|
|
// Prepare initializes the consensus fields of a block header according to the
|
|
// rules of a particular engine. The changes are executed inline.
|
|
Prepare(chain ChainReader, header *types.Header) error
|
|
|
|
// Finalize runs any post-transaction state modifications (e.g. block rewards)
|
|
// and assembles the final block.
|
|
//
|
|
// Note, the block header and state database might be updated to reflect any
|
|
// consensus rules that happen at finalization (e.g. block rewards).
|
|
Finalize(chain ChainReader, header *types.Header, state *state.StateDB, txs []*types.Transaction,
|
|
uncles []*types.Header, receipts []*types.Receipt) (*types.Block, error)
|
|
|
|
// Seal generates a new block for the given input block with the local miner's
|
|
// seal place on top.
|
|
Seal(chain ChainReader, block *types.Block, stop <-chan struct{}) (*types.Block, error)
|
|
|
|
// APIs returns the RPC APIs this consensus engine provides.
|
|
APIs(chain ChainReader) []rpc.API
|
|
}
|
|
|
|
// PoW is a consensus engine based on proof-of-work.
|
|
type PoW interface {
|
|
Engine
|
|
|
|
// Hashrate returns the current mining hashrate of a PoW consensus engine.
|
|
Hashrate() float64
|
|
}
|