client

Documentation

Overview

Package client represents the functionality to act as a validator.

Index

• type Config
• type Validator
• type ValidatorService
  • func NewValidatorService(ctx context.Context, cfg *Config) (*ValidatorService, error)
  • func (v *ValidatorService) Start()
  • func (v *ValidatorService) Status() error
  • func (v *ValidatorService) Stop() error

Types

type Config

type Config struct {
	Endpoint             string
	CertFlag             string
	Keys                 map[string]*keystore.Key
	LogValidatorBalances bool
}

Config for the validator service.

type Validator

type Validator interface {
	Done()
	WaitForChainStart(ctx context.Context) error
	WaitForActivation(ctx context.Context) error
	WaitForSync(ctx context.Context) error
	CanonicalHeadSlot(ctx context.Context) (uint64, error)
	NextSlot() <-chan uint64
	SlotDeadline(slot uint64) time.Time
	LogValidatorGainsAndLosses(ctx context.Context, slot uint64) error
	UpdateAssignments(ctx context.Context, slot uint64) error
	RolesAt(slot uint64) map[[48]byte]pb.ValidatorRole // validator pubKey -> role
	SubmitAttestation(ctx context.Context, slot uint64, pubKey [48]byte)
	ProposeBlock(ctx context.Context, slot uint64, pubKey [48]byte)
}

Validator interface defines the primary methods of a validator client.

type ValidatorService

type ValidatorService struct {
	// contains filtered or unexported fields
}

ValidatorService represents a service to manage the validator client routine.

func NewValidatorService

func NewValidatorService(ctx context.Context, cfg *Config) (*ValidatorService, error)

NewValidatorService creates a new validator service for the service registry.

func (*ValidatorService) Start

func (v *ValidatorService) Start()

Start the validator service. Launches the main go routine for the validator client.

func (*ValidatorService) Status

func (v *ValidatorService) Status() error

Status ...

WIP - not done.

func (*ValidatorService) Stop

func (v *ValidatorService) Stop() error

Stop the validator service.