helpers

Documentation

Index

• func IsOptimistic(ctx context.Context, stateId []byte, ...) (bool, error)
• func PrepareStateFetchGRPCError(err error) error
• func ValidateSyncGRPC(ctx context.Context, syncChecker sync.Checker, ...) error
• func ValidatorStatus(validator state.ReadOnlyValidator, epoch primitives.Epoch) (ethpb.ValidatorStatus, error)
• func ValidatorSubStatus(validator state.ReadOnlyValidator, epoch primitives.Epoch) (ethpb.ValidatorStatus, error)
• type IndexedVerificationFailure
• type SingleIndexedVerificationFailure
• type SyncDetailsContainer
  • func ValidateSyncHTTP(ctx context.Context, syncChecker sync.Checker, ...) (bool, *SyncDetailsContainer, error)
• type SyncDetailsJson

Functions

func IsOptimistic

func IsOptimistic(
	ctx context.Context,
	stateId []byte,
	optimisticModeFetcher blockchain.OptimisticModeFetcher,
	stateFetcher lookup.Stater,
	chainInfo blockchain.ChainInfoFetcher,
	database db.ReadOnlyDatabase,
) (bool, error)

IsOptimistic checks whether the beacon state's block is optimistic.

func PrepareStateFetchGRPCError

func PrepareStateFetchGRPCError(err error) error

PrepareStateFetchGRPCError returns an appropriate gRPC error based on the supplied argument. The argument error should be a result of fetching state.

func ValidateSyncGRPC

func ValidateSyncGRPC(
	ctx context.Context,
	syncChecker sync.Checker,
	headFetcher blockchain.HeadFetcher,
	timeFetcher blockchain.TimeFetcher,
	optimisticModeFetcher blockchain.OptimisticModeFetcher,
) error

ValidateSyncGRPC checks whether the node is currently syncing and returns an error if it is. It also appends syncing info to gRPC headers.

func ValidatorStatus

func ValidatorStatus(validator state.ReadOnlyValidator, epoch primitives.Epoch) (ethpb.ValidatorStatus, error)

ValidatorStatus returns a validator's status at the given epoch.

func ValidatorSubStatus

func ValidatorSubStatus(validator state.ReadOnlyValidator, epoch primitives.Epoch) (ethpb.ValidatorStatus, error)

ValidatorSubStatus returns a validator's sub-status at the given epoch.

Types

type IndexedVerificationFailure

type IndexedVerificationFailure struct {
	Failures []*SingleIndexedVerificationFailure `json:"failures"`
}

IndexedVerificationFailure represents a collection of verification failures.

type SingleIndexedVerificationFailure

type SingleIndexedVerificationFailure struct {
	Index   int    `json:"index"`
	Message string `json:"message"`
}

SingleIndexedVerificationFailure represents an issue when verifying a single indexed object e.g. an item in an array.

type SyncDetailsContainer

type SyncDetailsContainer struct {
	Data *SyncDetailsJson `json:"data"`
}

SyncDetailsContainer is a wrapper for Data.

func ValidateSyncHTTP

func ValidateSyncHTTP(
	ctx context.Context,
	syncChecker sync.Checker,
	headFetcher blockchain.HeadFetcher,
	timeFetcher blockchain.TimeFetcher,
	optimisticModeFetcher blockchain.OptimisticModeFetcher,
) (bool, *SyncDetailsContainer, error)

ValidateSyncHTTP checks whether the node is currently syncing and returns sync information. It returns information whether the node is currently syncing along with sync details.

type SyncDetailsJson

type SyncDetailsJson struct {
	HeadSlot     string `json:"head_slot"`
	SyncDistance string `json:"sync_distance"`
	IsSyncing    bool   `json:"is_syncing"`
	IsOptimistic bool   `json:"is_optimistic"`
	ElOffline    bool   `json:"el_offline"`
}

SyncDetailsJson contains information about node sync status.