precompute

Documentation

Index

• func AttestedCurrentEpoch(s *stateTrie.BeaconState, a *pb.PendingAttestation) (bool, bool, error)
• func AttestedPrevEpoch(s *stateTrie.BeaconState, a *pb.PendingAttestation) (bool, bool, bool, error)
• func New(ctx context.Context, state *stateTrie.BeaconState) ([]*Validator, *Balance)
• func ProcessAttestations(ctx context.Context, state *stateTrie.BeaconState, vp []*Validator, ...) ([]*Validator, *Balance, error)
• func ProcessJustificationAndFinalizationPreCompute(state *stateTrie.BeaconState, p *Balance) (*stateTrie.BeaconState, error)
• func ProcessRewardsAndPenaltiesPrecompute(state *stateTrie.BeaconState, bp *Balance, vp []*Validator) (*stateTrie.BeaconState, error)
• func ProcessSlashingsPrecompute(state *stateTrie.BeaconState, p *Balance) error
• func SameHead(state *stateTrie.BeaconState, a *pb.PendingAttestation) (bool, error)
• func SameTarget(state *stateTrie.BeaconState, a *pb.PendingAttestation, e uint64) (bool, error)
• type Balance
  • func UpdateBalance(vp []*Validator, bp *Balance) *Balance
• type Validator
  • func UpdateValidator(vp []*Validator, record *Validator, indices []uint64, a *pb.PendingAttestation, ...) []*Validator

Functions

func AttestedCurrentEpoch

func AttestedCurrentEpoch(s *stateTrie.BeaconState, a *pb.PendingAttestation) (bool, bool, error)

AttestedCurrentEpoch returns true if attestation `a` attested once in current epoch and/or epoch boundary block.

func AttestedPrevEpoch

func AttestedPrevEpoch(s *stateTrie.BeaconState, a *pb.PendingAttestation) (bool, bool, bool, error)

AttestedPrevEpoch returns true if attestation `a` attested once in previous epoch and epoch boundary block and/or the same head.

func New

func New(ctx context.Context, state *stateTrie.BeaconState) ([]*Validator, *Balance)

New gets called at the beginning of process epoch cycle to return pre computed instances of validators attesting records and total balances attested in an epoch.

func ProcessAttestations

func ProcessAttestations(
	ctx context.Context,
	state *stateTrie.BeaconState,
	vp []*Validator,
	bp *Balance,
) ([]*Validator, *Balance, error)

ProcessAttestations process the attestations in state and update individual validator's pre computes, it also tracks and updates epoch attesting balances.

func ProcessJustificationAndFinalizationPreCompute

func ProcessJustificationAndFinalizationPreCompute(state *stateTrie.BeaconState, p *Balance) (*stateTrie.BeaconState, error)

ProcessJustificationAndFinalizationPreCompute processes justification and finalization during epoch processing. This is where a beacon node can justify and finalize a new epoch. Note: this is an optimized version by passing in precomputed total and attesting balances.

func ProcessRewardsAndPenaltiesPrecompute

func ProcessRewardsAndPenaltiesPrecompute(
	state *stateTrie.BeaconState,
	bp *Balance,
	vp []*Validator,
) (*stateTrie.BeaconState, error)

ProcessRewardsAndPenaltiesPrecompute processes the rewards and penalties of individual validator. This is an optimized version by passing in precomputed validator attesting records and and total epoch balances.

func ProcessSlashingsPrecompute

func ProcessSlashingsPrecompute(state *stateTrie.BeaconState, p *Balance) error

ProcessSlashingsPrecompute processes the slashed validators during epoch processing. This is an optimized version by passing in precomputed total epoch balances.

func SameHead

func SameHead(state *stateTrie.BeaconState, a *pb.PendingAttestation) (bool, error)

SameHead returns true if attestation `a` attested to the same block by attestation slot in state.

func SameTarget

func SameTarget(state *stateTrie.BeaconState, a *pb.PendingAttestation, e uint64) (bool, error)

SameTarget returns true if attestation `a` attested to the same target block in state.

Types

type Balance

type Balance struct {
	// CurrentEpoch is the total effective balance of all active validators during current epoch.
	CurrentEpoch uint64
	// PrevEpoch is the total effective balance of all active validators during prev epoch.
	PrevEpoch uint64
	// CurrentEpochAttesters is the total effective balance of all validators who attested during current epoch.
	CurrentEpochAttesters uint64
	// CurrentEpochTargetAttesters is the total effective balance of all validators who attested
	// for epoch boundary block during current epoch.
	CurrentEpochTargetAttesters uint64
	// PrevEpochAttesters is the total effective balance of all validators who attested during prev epoch.
	PrevEpochAttesters uint64
	// PrevEpochTargetAttesters is the total effective balance of all validators who attested
	// for epoch boundary block during prev epoch.
	PrevEpochTargetAttesters uint64
	// PrevEpochHeadAttesters is the total effective balance of all validators who attested
	// correctly for head block during prev epoch.
	PrevEpochHeadAttesters uint64
}

Balance stores the pre computation of the total participated balances for a given epoch Pre computing and storing such record is essential for process epoch optimizations.

var Balances *Balance

Balances stores balances such as prev/current total validator balances, attested balances and more. It's used for metrics reporting.

func UpdateBalance

func UpdateBalance(vp []*Validator, bp *Balance) *Balance

UpdateBalance updates pre computed balance store.

type Validator

type Validator struct {
	// IsSlashed is true if the validator has been slashed.
	IsSlashed bool
	// IsWithdrawableCurrentEpoch is true if the validator can withdraw current epoch.
	IsWithdrawableCurrentEpoch bool
	// IsActiveCurrentEpoch is true if the validator was active current epoch.
	IsActiveCurrentEpoch bool
	// IsActivePrevEpoch is true if the validator was active prev epoch.
	IsActivePrevEpoch bool
	// IsCurrentEpochAttester is true if the validator attested current epoch.
	IsCurrentEpochAttester bool
	// IsCurrentEpochTargetAttester is true if the validator attested current epoch target.
	IsCurrentEpochTargetAttester bool
	// IsPrevEpochAttester is true if the validator attested previous epoch.
	IsPrevEpochAttester bool
	// IsPrevEpochTargetAttester is true if the validator attested previous epoch target.
	IsPrevEpochTargetAttester bool
	// IsHeadAttester is true if the validator attested head.
	IsPrevEpochHeadAttester bool

	// CurrentEpochEffectiveBalance is how much effective balance this validator validator has current epoch.
	CurrentEpochEffectiveBalance uint64
	// InclusionSlot is the slot of when the attestation gets included in the chain.
	InclusionSlot uint64
	// InclusionDistance is the distance between the assigned slot and this validator's attestation was included in block.
	InclusionDistance uint64
	// ProposerIndex is the index of proposer at slot where this validator's attestation was included.
	ProposerIndex uint64
	// BeforeEpochTransitionBalance is the validator balance prior to epoch transition.
	BeforeEpochTransitionBalance uint64
	// AfterEpochTransitionBalance is the validator balance after epoch transition.
	AfterEpochTransitionBalance uint64
}

Validator stores the pre computation of individual validator's attesting records these records consist of attestation votes, block inclusion record. Pre computing and storing such record is essential for process epoch optimizations.

func UpdateValidator

func UpdateValidator(vp []*Validator, record *Validator, indices []uint64, a *pb.PendingAttestation, aSlot uint64) []*Validator

UpdateValidator updates pre computed validator store.