Documentation ¶
Overview ¶
Package consensus implements different Infinet consensus engines.
Index ¶
- Variables
- type ChainReader
- type DElection
- func (dpos *DElection) APIs(chain ChainReader) []rpc.API
- func (dpos *DElection) Author(header *types.Header) (common.Address, error)
- func (dpos *DElection) CalcDifficulty(chain ChainReader, time uint64, parent *types.Header) *big.Int
- func (dpos *DElection) Finalize(chain ChainReader, header *types.Header, state *state.StateDB, ...) (*types.Block, error)
- func (dpos *DElection) Prepare(chain ChainReader, header *types.Header) error
- func (dpos *DElection) Seal(chain ChainReader, block *types.Block, stop <-chan struct{}) (*types.Block, error)
- func (dpos *DElection) VerifyHeader(chain ChainReader, header *types.Header, seal bool) error
- func (dpos *DElection) VerifyHeaders(chain ChainReader, headers []*types.Header, seals []bool) (chan<- struct{}, <-chan error)
- func (dpos *DElection) VerifySeal(chain ChainReader, header *types.Header) error
- func (dpos *DElection) VerifyUncles(chain ChainReader, block *types.Block) error
- type DPoSAPI
- type Engine
- type PoW
Constants ¶
This section is empty.
Variables ¶
var ( // ErrUnknownAncestor is returned when validating a block requires an ancestor // that is unknown. ErrUnknownAncestor = errors.New("unknown ancestor") // ErrPrunedAncestor is returned when validating a block requires an ancestor // that is known, but the state of which is not available. ErrPrunedAncestor = errors.New("pruned ancestor") // ErrFutureBlock is returned when a block's timestamp is in the future according // to the current node. ErrFutureBlock = errors.New("block in the future") // ErrInvalidNumber is returned if a block's number doesn't equal it's parent's // plus one. ErrInvalidNumber = errors.New("invalid block number") )
var (
ByzantiumBlockReward *big.Int = big.NewInt(3e+18) // Block reward in wei for successfully mining a block upward from Byzantium
)
Functions ¶
This section is empty.
Types ¶
type ChainReader ¶
type ChainReader interface { // Config retrieves the blockchain's chain configuration. Config() *config.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 // GetHeaderByHash retrieves a block header from the database by its hash. GetHeaderByHash(hash common.Hash) *types.Header // GetBlock retrieves a block from the database by hash and number. GetBlock(hash common.Hash, number uint64) *types.Block }
ChainReader defines a small collection of methods needed to access the local blockchain during header and/or uncle verification.
type DElection ¶
type DElection struct {
// contains filtered or unexported fields
}
func New ¶
func New(config *config.DPoSConfig, db store.Database) *DElection
New creates a Clique proof-of-authority consensus engine with the initial signers set to the ones provided by the user.
func (*DElection) APIs ¶
func (dpos *DElection) APIs(chain ChainReader) []rpc.API
APIs returns the RPC APIs this consensus engine provides.
func (*DElection) Author ¶
Author implements Engine, returning the header's coinbase as the proof-of-work verified author of the block.
func (*DElection) CalcDifficulty ¶
func (dpos *DElection) CalcDifficulty(chain ChainReader, time uint64, parent *types.Header) *big.Int
CalcDifficulty is the difficulty adjustment algorithm. It returns the difficulty that a new block should have when created at time given the parent block's time and difficulty.
func (*DElection) Finalize ¶
func (dpos *DElection) Finalize(chain ChainReader, header *types.Header, state *state.StateDB, txs []*types.Transaction, uncles []*types.Header, receipts []*types.Receipt) (*types.Block, error)
Finalize implements Engine, accumulating the block and uncle rewards, setting the final state and assembling the block.
func (*DElection) Prepare ¶
func (dpos *DElection) Prepare(chain ChainReader, header *types.Header) error
Prepare implements Engine, initializing the difficulty field of a header to conform to the dpos protocol. The changes are done inline.
func (*DElection) Seal ¶
func (dpos *DElection) Seal(chain ChainReader, block *types.Block, stop <-chan struct{}) (*types.Block, error)
Seal generates a new block for the given input block with the local miner's seal place on top.
func (*DElection) VerifyHeader ¶
VerifyHeader checks whether a header conforms to the consensus rules of the stock Ethereum dpos engine.
func (*DElection) VerifyHeaders ¶
func (dpos *DElection) VerifyHeaders(chain ChainReader, headers []*types.Header, seals []bool) (chan<- struct{}, <-chan 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.
func (*DElection) VerifySeal ¶
func (dpos *DElection) VerifySeal(chain ChainReader, header *types.Header) error
VerifySeal implements Engine, checking whether the given block satisfies the DPoS difficulty requirements.
func (*DElection) VerifyUncles ¶
func (dpos *DElection) VerifyUncles(chain ChainReader, block *types.Block) error
VerifyUncles verifies that the given block's uncles conform to the consensus rules of the stock Ethereum dpos engine.
type DPoSAPI ¶
type DPoSAPI struct {
// contains filtered or unexported fields
}
PublicDebugAPI is the collection of Ethereum APIs exposed over the public debugging endpoint.
type Engine ¶
type Engine interface { // Author retrieves the Ethereum address of the account that minted the given // block, which may be different from the header's coinbase if a consensus // engine is based on signatures. Author(header *types.Header) (common.Address, error) // 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) // CalcDifficulty is the difficulty adjustment algorithm. It returns the difficulty // that a new block should have. CalcDifficulty(chain ChainReader, time uint64, parent *types.Header) *big.Int // APIs returns the RPC APIs this consensus engine provides. APIs(chain ChainReader) []rpc.API }
Engine is an algorithm agnostic consensus engine.
func CreateFakeEngine ¶
func CreateFakeEngine() Engine
func NewFakeDelayer ¶
NewFakeDelayer creates a ethash consensus engine with a fake PoW scheme that accepts all blocks as valid, but delays verifications by some time, though they still have to conform to the Ethereum consensus rules.
func NewFakeFailer ¶
NewFakeFailer creates a ethash consensus engine with a fake PoW scheme that accepts all blocks as valid apart from the single one specified, though they still have to conform to the Ethereum consensus rules.
func NewFullFaker ¶
func NewFullFaker() Engine
NewFullFaker creates an ethash consensus engine with a full fake scheme that accepts all blocks as valid, without checking any consensus rules whatsoever.