consensus

Documentation

Index

• type Service
  • func New(ctx context.Context, database db.Database, ...) (service *Service)
  • func (service *Service) Canonicalize(fromSlot uint64, batchLimit uint64) (vanguardErr error, pandoraErr error, realmErr error)
  • func (service *Service) Start()
  • func (service *Service) Status() error
  • func (service *Service) Stop() error

Types

type Service

type Service struct {
	VanguardHeaderHashDB      iface.VanHeaderAccessDatabase
	PandoraHeaderHashDB       iface.PanHeaderAccessDatabase
	RealmDB                   iface.RealmAccessDatabase
	VanguardHeadersChan       chan *types.HeaderHash
	VanguardConsensusInfoChan chan *types.MinimalEpochConsensusInfo
	PandoraHeadersChan        chan *types.HeaderHash
	// contains filtered or unexported fields
}

This part could be moved to other place during refactor, might be registered as a service

func New

func New(
	ctx context.Context,
	database db.Database,
	vanguardHeadersChan chan *types.HeaderHash,
	vanguardConsensusInfoChan chan *types.MinimalEpochConsensusInfo,
	pandoraHeadersChan chan *types.HeaderHash,
) (service *Service)

func (*Service) Canonicalize

func (service *Service) Canonicalize(
	fromSlot uint64,
	batchLimit uint64,
) (
	vanguardErr error,
	pandoraErr error,
	realmErr error,
)

Canonicalize must be called numerous of times with different from slot new slots may arrive after canonicalization, so Canonicalize must be invoked again

func (*Service) Start

func (service *Service) Start()

This service should be registered only after Pandora and Vanguard notified about: - consensus info (Vanguard) - pendingHeaders (Vanguard) - pendingHeaders (Pandora) In current implementation we use debounce to determine state of syncing

func (*Service) Status

func (service *Service) Status() error

func (*Service) Stop

func (service *Service) Stop() error