consensus

Documentation

Overview

Package consensus implements different Quai consensus engines.

Index

• Variables
• func DifficultyToTarget(difficulty *big.Int) *big.Int
• func TargetToDifficulty(target *big.Int) *big.Int
• type ChainHeaderReader
• type ChainReader
• type Engine
• type GenesisReader
• type PoW

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 its parent's
	// plus one.
	ErrInvalidNumber = errors.New("invalid block number")
)

Functions

func DifficultyToTarget

func DifficultyToTarget(difficulty *big.Int) *big.Int

func TargetToDifficulty

func TargetToDifficulty(target *big.Int) *big.Int

Types

type ChainHeaderReader

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

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

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

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

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

	// GetBlockByhash retrieves a block from the database by hash.
	GetBlockByHash(hash common.Hash) *types.WorkObject

	// GetTerminiByHash retrieves the termini for a given header hash
	GetTerminiByHash(hash common.Hash) *types.Termini

	// ProcessingState returns true for slices that are running
	ProcessingState() bool

	// ComputeEfficiencyScore returns the efficiency score computed at each prime block
	ComputeEfficiencyScore(header *types.WorkObject) uint16

	// IsGenesisHash returns true if the given hash is the genesis block hash.
	IsGenesisHash(hash common.Hash) bool

	// UpdateEtxEligibleSlices updates the etx eligible slice for the given zone location
	UpdateEtxEligibleSlices(header *types.WorkObject, location common.Location) common.Hash
}

ChainHeaderReader defines a small collection of methods needed to access the local blockchain during header verification.

type ChainReader

type ChainReader interface {
	ChainHeaderReader

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

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

type Engine

type Engine interface {
	// Author retrieves the Quai 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.WorkObject) (common.Address, error)

	// IntrinsicLogS returns the logarithm of the intrinsic entropy reduction of a PoW hash
	IntrinsicLogS(powHash common.Hash) *big.Int

	// CalcOrder returns the order of the block within the hierarchy of chains
	CalcOrder(header *types.WorkObject) (*big.Int, int, error)

	// TotalLogS returns the log of the total entropy reduction if the chain since genesis to the given header
	TotalLogS(chain GenesisReader, header *types.WorkObject) *big.Int

	// TotalLogPhS returns the log of the total entropy reduction if the chain since genesis for a pending header
	TotalLogPhS(header *types.WorkObject) *big.Int

	// DeltaLogS returns the log of the entropy delta for a chain since its prior coincidence
	DeltaLogS(chain GenesisReader, header *types.WorkObject) *big.Int

	// UncledLogS returns the log of the entropy reduction by uncles referenced in the block
	UncledLogS(block *types.WorkObject) *big.Int

	// WorkShareLogS returns the log of the entropy reduction by the workshare referenced in the block
	WorkShareLogS(block *types.WorkObject) (*big.Int, error)

	// CheckIfValidWorkShare checks if the workshare meets the work share
	// requirements defined by the protocol
	CheckIfValidWorkShare(workShare *types.WorkObjectHeader) bool

	// UncledUncledSubDeltaLogS returns the log of the uncled entropy reduction  since the past coincident
	UncledSubDeltaLogS(chain GenesisReader, header *types.WorkObject) *big.Int

	// CalcRank calculates the rank of the prime block
	CalcRank(chain GenesisReader, header *types.WorkObject) (int, error)

	ComputePowLight(header *types.WorkObjectHeader) (mixHash, powHash common.Hash)

	// 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 ChainHeaderReader, header *types.WorkObject) 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 ChainHeaderReader, headers []*types.WorkObject) (chan<- struct{}, <-chan error)

	// VerifyUncles verifies that the given block's uncles conform to the consensus
	// rules of a given engine.
	VerifyUncles(chain ChainReader, wo *types.WorkObject) 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 ChainHeaderReader, header *types.WorkObject, parent *types.WorkObject) error

	// Finalize runs any post-transaction state modifications (e.g. block rewards)
	// but does not assemble the 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 ChainHeaderReader, header *types.WorkObject, state *state.StateDB)

	// FinalizeAndAssemble 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).
	FinalizeAndAssemble(chain ChainHeaderReader, woHeader *types.WorkObject, state *state.StateDB, txs []*types.Transaction, uncles []*types.WorkObjectHeader, etxs []*types.Transaction, subManifest types.BlockManifest, receipts []*types.Receipt) (*types.WorkObject, error)

	// Seal generates a new sealing request for the given input block and pushes
	// the result into the given channel.
	//
	// Note, the method returns immediately and will send the result async. More
	// than one result may also be returned depending on the consensus algorithm.
	Seal(header *types.WorkObject, results chan<- *types.WorkObject, stop <-chan struct{}) error

	// CalcDifficulty is the difficulty adjustment algorithm. It returns the difficulty
	// that a new block should have.
	CalcDifficulty(chain ChainHeaderReader, parent *types.WorkObjectHeader, expansionNum uint8) *big.Int

	// ComputePowHash returns the pow hash of the workobject header
	ComputePowHash(header *types.WorkObjectHeader) (common.Hash, error)

	// IsDomCoincident returns true if this block satisfies the difficulty order
	// of a dominant chain. If this node does not have a dominant chain (i.e.
	// if this is a prime node), then the function will always return false.
	//
	// Importantly, this check does NOT mean the block is canonical in the
	// dominant chain, or even that the claimed dominant difficulty is valid.
	IsDomCoincident(chain ChainHeaderReader, header *types.WorkObject) bool

	// VerifySeal computes the PowHash and checks if work meets the difficulty
	// requirement specified in header
	VerifySeal(header *types.WorkObjectHeader) (common.Hash, error)

	SetThreads(threads int)
}

Engine is an algorithm agnostic consensus engine.

type GenesisReader

type GenesisReader interface {
	// IsGenesisHash returns true if the given hash is the genesis block hash.
	IsGenesisHash(hash common.Hash) bool
}

type PoW

type PoW interface {
	Engine
}

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