consensus

package
v0.0.0-...-11e53f0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 8, 2023 License: GPL-3.0, GPL-3.0 Imports: 10 Imported by: 0

Documentation

Overview

Package consensus implements different Ethereum consensus engines.

Index

Constants

This section is empty.

Variables

View Source
var (
	// ErrUnknownAncestor is returned when validating a block requires an ancestor
	// that is unknown.
	ErrUnknownAncestor = errors.New("unknown ancestor")

	//ErrBlockOnChain is returned when validating a block but it is
	//already on the fast chain.
	ErrBlockOnChain = errors.New("block already insert fastchain")

	// ErrForkFastBlock is returned when validating a block but the same number other
	// block already in the chain.
	ErrForkFastBlock = errors.New("fork fastBlock")

	// 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")

	// ErrTooFutureBlock is returned when a block's number is too future than
	// the current fastblock.
	ErrTooFutureBlock = errors.New("fruit is too higher than current fastblock")
	// ErrTooOldBlock is returned when a block's number is too old than
	// the current fastblock.
	ErrTooOldBlock = errors.New("this hight's fruit already packed in the snailchain")
	// ErrInvalidNumber is returned if a block's number doesn't equal it's parent's
	// plus one.
	ErrInvalidNumber = errors.New("invalid block number")

	//ErrInvalidSignsLength If the number of returned committees and the results are inconsistent, return ErrInvalidSignsLength
	ErrInvalidSignsLength = errors.New("invalid signs length")

	// ErrValidSignsZero is returned if a block's signs length is zero
	ErrValidSignsZero = errors.New("valid signs length equal zero in fruit")

	ErrInvalidBlock = errors.New("invalid snail block")

	ErrUnknownPointer = errors.New("unknown pointer hash")

	ErrFreshness = errors.New("invalid fruit freshness")

	ErrInvalidSign = errors.New("invalid sign")

	ErrInvalidSwitchInfo = errors.New("invalid switch info")

	ErrUnknownFast = errors.New("unknown fast block")

	//ErrInvalidFast is returned if the fastchain not have the hash
	ErrInvalidFast = errors.New("invalid fast hash")

	//ErrFruitTime is returned if the fruit's time less than fastblock's time
	ErrFruitTime = errors.New("invalid fruit time")
)

Functions

func InitTIP8

func InitTIP8(config *params.ChainConfig, reader SnailChainReader)

func IsTIP8

func IsTIP8(fastHeadNumber *big.Int, config *params.ChainConfig, reader SnailChainReader) bool

func OnceInitImpawnState

func OnceInitImpawnState(config *params.ChainConfig, state *state.StateDB, fastNumber *big.Int) bool

func OnceUpdateWhitelist

func OnceUpdateWhitelist(state *state.StateDB, fastNumber *big.Int)

Types

type ChainReader

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

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

	GetBlockReward(snumber uint64) *types.BlockReward
}

ChainReader defines a small collection of methods needed to access the local blockchain during header and/or uncle verification.

type CommitteeElection

type CommitteeElection interface {
	// VerifySigns verify the fast chain committee signatures in batches
	VerifySigns(pvs []*types.PbftSign) ([]*types.CommitteeMember, []error)

	// VerifySwitchInfo verify committee members and it's state
	VerifySwitchInfo(fastnumber *big.Int, info []*types.CommitteeMember) error

	FinalizeCommittee(block *types.Block) error

	//Get a list of committee members
	//GetCommittee(FastNumber *big.Int, FastHash common.Hash) (*big.Int, []*types.CommitteeMember)
	GetCommittee(fastNumber *big.Int) []*types.CommitteeMember

	GenerateFakeSigns(fb *types.Block) ([]*types.PbftSign, error)
}

CommitteeElection module implementation committee interface

type Engine

type Engine interface {
	SetElection(e CommitteeElection)

	GetElection() CommitteeElection

	SetSnailChainReader(scr SnailChainReader)

	SetSnailHeaderHash(db icedb.Database)
	// 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)
	AuthorSnail(header *types.SnailHeader) (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) error
	VerifySnailHeader(chain SnailChainReader, fastchain ChainReader, header *types.SnailHeader, seal bool, isFruit 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)

	// VerifySnailHeaders is similar to VerifySnailHeader, but verifies a batch of headers concurrently.
	// VerifySnailHeaders only verifies snail header rather than fruit header.
	// 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).
	VerifySnailHeaders(chain SnailChainReader, headers []*types.SnailHeader, seals []bool) (chan<- struct{}, <-chan error)

	ValidateRewarded(number uint64, hash common.Hash, fastchain ChainReader) error

	ValidateFruitHeader(block *types.SnailHeader, fruit *types.SnailHeader, snailchain SnailChainReader, fastchain ChainReader, checkpoint uint64) error
	// VerifySeal checks whether the crypto seal on a header is valid according to
	// the consensus rules of the given engine.
	VerifySnailSeal(chain SnailChainReader, header *types.SnailHeader, isFruit bool) error

	VerifyFreshness(chain SnailChainReader, fruit *types.SnailHeader, headerNumber *big.Int, canonical bool) error

	VerifySigns(fastnumber *big.Int, fastHash common.Hash, signs []*types.PbftSign) error

	VerifySwitchInfo(fastnumber *big.Int, info []*types.CommitteeMember) 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
	PrepareSnail(chain ChainReader, snailchain SnailChainReader, header *types.SnailHeader) error
	PrepareSnailWithParent(chain ChainReader, snailchain SnailChainReader, header *types.SnailHeader, parents []*types.SnailHeader) 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,
		receipts []*types.Receipt, feeAmount *big.Int) (*types.Block, *types.ChainReward, error)
	FinalizeSnail(chain SnailChainReader, header *types.SnailHeader,
		uncles []*types.SnailHeader, fruits []*types.SnailBlock, signs []*types.PbftSign) (*types.SnailBlock, error)

	FinalizeCommittee(block *types.Block) error

	// Seal generates a new block for the given input block with the local miner's
	Seal(chain SnailChainReader, block *types.SnailBlock, stop <-chan struct{}) (*types.SnailBlock, error)

	// ConSeal generates a new block for the given input block with the local miner's
	// seal place on top.
	ConSeal(chain SnailChainReader, block *types.SnailBlock, stop <-chan struct{}, send chan *types.SnailBlock)

	CalcSnailDifficulty(chain SnailChainReader, time uint64, parents []*types.SnailHeader) *big.Int

	GetDifficulty(header *types.SnailHeader, isFruit bool) (*big.Int, *big.Int)

	// APIs returns the RPC APIs this consensus engine provides.
	APIs(chain ChainReader) []rpc.API

	DataSetHash(epoch uint64) string

	GetRewardContentBySnailNumber(sBlock *types.SnailBlock) *types.SnailRewardContenet
}

Engine is an algorithm agnostic consensus engine.

type PoW

type PoW interface {
	Engine

	// Hashrate returns the current mining hashrate of a PoW consensus engine.
	Hashrate() float64
}

PoW is a consensus engine based on proof-of-work.

type RewardInfosAccess

type RewardInfosAccess interface {
	GetRewardInfos(number uint64) *types.ChainReward
	SetRewardInfos(number uint64, infos *types.ChainReward) error
}

type SnailChainReader

type SnailChainReader interface {
	// Config retrieves the blockchain's chain configuration.
	Config() *params.ChainConfig

	// CurrentHeader retrieves the current header from the local chain.
	CurrentHeader() *types.SnailHeader

	// GetHeader retrieves a block header from the database by hash and number.
	GetHeader(hash common.Hash, number uint64) *types.SnailHeader

	// GetHeaderByNumber retrieves a block header from the database by number.
	GetHeaderByNumber(number uint64) *types.SnailHeader

	// GetHeaderByHash retrieves a block header from the database by its hash.
	GetHeaderByHash(hash common.Hash) *types.SnailHeader

	// GetBlock retrieves a block from the database by hash and number.
	GetBlock(hash common.Hash, number uint64) *types.SnailBlock
}

SnailChainReader defines a small collection of methods needed to access the local block chain during header and/or uncle verification. Temporary interface for snail

Directories

Path Synopsis
Package minerva implements the icechain hybrid consensus engine.
Package minerva implements the icechain hybrid consensus engine.
help/flowrate
Package flowrate provides the tools for monitoring and limiting the flow rate of an arbitrary data stream.
Package flowrate provides the tools for monitoring and limiting the flow rate of an arbitrary data stream.
tp2p/upnp
Taken from taipei-torrent.
Taken from taipei-torrent.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL