mirror of
https://gitlab.com/pulsechaincom/prysm-pulse.git
synced 2025-01-07 02:02:18 +00:00
4c869fa587
* remove equivocating votes from forkchoice * shutup deepsource Co-authored-by: terencechain <terence@prysmaticlabs.com> Co-authored-by: prylabs-bulldozer[bot] <58059840+prylabs-bulldozer[bot]@users.noreply.github.com>
77 lines
2.8 KiB
Go
77 lines
2.8 KiB
Go
package forkchoice
|
|
|
|
import (
|
|
"context"
|
|
|
|
forkchoicetypes "github.com/prysmaticlabs/prysm/beacon-chain/forkchoice/types"
|
|
fieldparams "github.com/prysmaticlabs/prysm/config/fieldparams"
|
|
types "github.com/prysmaticlabs/prysm/consensus-types/primitives"
|
|
pbrpc "github.com/prysmaticlabs/prysm/proto/prysm/v1alpha1"
|
|
)
|
|
|
|
// ForkChoicer represents the full fork choice interface composed of all the sub-interfaces.
|
|
type ForkChoicer interface {
|
|
HeadRetriever // to compute head.
|
|
BlockProcessor // to track new block for fork choice.
|
|
AttestationProcessor // to track new attestation for fork choice.
|
|
Pruner // to clean old data for fork choice.
|
|
Getter // to retrieve fork choice information.
|
|
Setter // to set fork choice information.
|
|
ProposerBooster // ability to boost timely-proposed block roots.
|
|
}
|
|
|
|
// HeadRetriever retrieves head root and optimistic info of the current chain.
|
|
type HeadRetriever interface {
|
|
Head(context.Context, types.Epoch, [32]byte, []uint64, types.Epoch) ([32]byte, error)
|
|
Tips() ([][32]byte, []types.Slot)
|
|
IsOptimistic(root [32]byte) (bool, error)
|
|
}
|
|
|
|
// BlockProcessor processes the block that's used for accounting fork choice.
|
|
type BlockProcessor interface {
|
|
InsertOptimisticBlock(ctx context.Context,
|
|
slot types.Slot,
|
|
root [32]byte,
|
|
parentRoot [32]byte,
|
|
payloadHash [32]byte,
|
|
justifiedEpoch types.Epoch,
|
|
finalizedEpoch types.Epoch,
|
|
) error
|
|
}
|
|
|
|
// AttestationProcessor processes the attestation that's used for accounting fork choice.
|
|
type AttestationProcessor interface {
|
|
ProcessAttestation(context.Context, []uint64, [32]byte, types.Epoch)
|
|
InsertSlashedIndex(context.Context, types.ValidatorIndex)
|
|
}
|
|
|
|
// Pruner prunes the fork choice upon new finalization. This is used to keep fork choice sane.
|
|
type Pruner interface {
|
|
Prune(context.Context, [32]byte) error
|
|
}
|
|
|
|
// ProposerBooster is able to boost the proposer's root score during fork choice.
|
|
type ProposerBooster interface {
|
|
BoostProposerRoot(ctx context.Context, args *forkchoicetypes.ProposerBoostRootArgs) error
|
|
ResetBoostedProposerRoot(ctx context.Context) error
|
|
}
|
|
|
|
// Getter returns fork choice related information.
|
|
type Getter interface {
|
|
HasNode([32]byte) bool
|
|
ProposerBoost() [fieldparams.RootLength]byte
|
|
HasParent(root [32]byte) bool
|
|
AncestorRoot(ctx context.Context, root [32]byte, slot types.Slot) ([]byte, error)
|
|
IsCanonical(root [32]byte) bool
|
|
FinalizedEpoch() types.Epoch
|
|
JustifiedEpoch() types.Epoch
|
|
ForkChoiceNodes() []*pbrpc.ForkChoiceNode
|
|
NodeCount() int
|
|
}
|
|
|
|
// Setter allows to set forkchoice information
|
|
type Setter interface {
|
|
SetOptimisticToValid(context.Context, [fieldparams.RootLength]byte) error
|
|
SetOptimisticToInvalid(context.Context, [fieldparams.RootLength]byte, [fieldparams.RootLength]byte, [fieldparams.RootLength]byte) ([][32]byte, error)
|
|
}
|