cerc-io/lotus
16
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 27 Wiki Activity

added comments to consensus interface

Browse Source
This commit is contained in:
Alfonso de la Rocha 2022-09-28 12:15:57 +02:00
parent 627d6e70a6
commit 536600c95c
1 changed files with 24 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
chain/consensus/iface.go
View File

@ -18,12 +18,35 @@ import (
)
type Consensus interface {
ValidateBlock(ctx context.Context, b *types.FullBlock) (err error)
// ValidateBlockHeader is called by peers when they receive a new block through the network.
//
// This is a fast sanity-check validation performed by the PubSub protocol before delivering
// it to the syncer. It checks that the block has the right format and it performs
// other consensus-specific light verifications like ensuring that the block is signed by
// a valid miner, or that it includes all the data required for a full verification.
ValidateBlockHeader(ctx context.Context, b *types.BlockHeader) (rejectReason string, err error)
// ValidateBlock is called by the syncer to determine if to accept a block or not.
//
// It performs all the checks needed by the syncer to accept
// the block (signature verifications, VRF checks, message validity, etc.)
ValidateBlock(ctx context.Context, b *types.FullBlock) (err error)
// IsEpochBeyondCurrMax is used to configure the fork rules for longest-chain
// consensus protocols.
IsEpochBeyondCurrMax(epoch abi.ChainEpoch) bool
// CreateBlock implements all the logic required to propose and assemble a new Filecoin block.
//
// This function encapsulate all the consensus-specific actions to propose a new block
// such as the ordering of transactions, the inclusion of consensus proofs, the signature
// of the block, etc.
CreateBlock(ctx context.Context, w api.Wallet, bt *api.BlockTemplate) (*types.FullBlock, error)
// SignBlock determines how should blocks be signed for them to be considered valid by the consensus
// engine.
SignBlock(ctx context.Context, w api.Wallet, addr address.Address, next *types.BlockHeader) error
// VerifyBlockSignature verifies the signature scheme implemented by the consensus algorithm.
VerifyBlockSignature(ctx context.Context, h *types.BlockHeader, addr address.Address) error
}