Documentation
¶
Overview ¶
Package consensus implements different Matrix 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") // 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") )
Functions ¶
This section is empty.
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
GetGraphByHash(hash common.Hash) (*mc.TopologyGraph, *mc.ElectGraph, error)
GetInnerMinerAccounts(blockHash common.Hash) ([]common.Address, error)
}
ChainReader defines a small collection of methods needed to access the local blockchain during header and/or uncle verification.
type DPOSEngine ¶
type DPOSEngine interface {
VerifyVersionSigns(reader StateReader, header *types.Header) error
CheckSuperBlock(reader StateReader, header *types.Header) error
VerifyBlock(reader StateReader, header *types.Header) error
//verify hash in current block
VerifyHash(reader StateReader, signHash common.Hash, signs []common.Signature) ([]common.Signature, error)
//verify hash in given block
VerifyHashWithBlock(reader StateReader, signHash common.Hash, signs []common.Signature, blockHash common.Hash) ([]common.Signature, error)
VerifyHashWithVerifiedSigns(reader StateReader, signs []*common.VerifiedSign) ([]common.Signature, error)
VerifyHashWithVerifiedSignsAndBlock(reader StateReader, signs []*common.VerifiedSign, blockHash common.Hash) ([]common.Signature, error)
}
type Engine ¶
type Engine interface {
// Author retrieves the Matrix 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.StateDBManage,
uncles []*types.Header, currencyBlock []types.CurrencyBlock) (*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, header *types.Header, stop <-chan struct{}, isBroadcastNode bool) (*types.Header, 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.
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 StateReader ¶ added in v1.1.1
type StateReader interface {
GetCurrentHash() common.Hash
GetGraphByHash(hash common.Hash) (*mc.TopologyGraph, *mc.ElectGraph, error)
GetBroadcastAccounts(blockHash common.Hash) ([]common.Address, error)
GetVersionSuperAccounts(blockHash common.Hash) ([]common.Address, error)
GetBlockSuperAccounts(blockHash common.Hash) ([]common.Address, error)
GetBroadcastIntervalByHash(blockHash common.Hash) (*mc.BCIntervalInfo, error)
GetA0AccountFromAnyAccount(account common.Address, blockHash common.Hash) (common.Address, common.Address, error)
}
Directories
¶
| Path | Synopsis |
|---|---|
|
Package clique implements the proof-of-authority consensus engine.
|
Package clique implements the proof-of-authority consensus engine. |
|
Package manash implements the manash proof-of-work consensus engine.
|
Package manash implements the manash proof-of-work consensus engine. |
Click to show internal directories.
Click to hide internal directories.