sync

Documentation

Index

• type State
  • func (s State) Finished() bool
• type Syncer
  • func NewSyncer(exchange header.Exchange, store header.Store, sub header.Subscriber) *Syncer
  • func (s *Syncer) Start(context.Context) error
  • func (s *Syncer) State() State
  • func (s *Syncer) Stop(ctx context.Context) error
  • func (s *Syncer) WaitSync(ctx context.Context) error

Types

type State

type State struct {
	ID                   uint64 // incrementing ID of a sync
	Height               uint64 // height at the moment when State is requested for a sync
	FromHeight, ToHeight uint64 // the starting and the ending point of a sync
	FromHash, ToHash     tmbytes.HexBytes
	Start, End           time.Time
	Error                error // the error that might happen within a sync
}

State collects all the information about a sync.

func (State) Finished

func (s State) Finished() bool

Finished returns true if sync is done, false otherwise.

type Syncer

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

Syncer implements efficient synchronization for headers.

There are two main processes running in Syncer: 1. Main syncing loop(s.syncLoop)

• Performs syncing from the subjective(local chain view) header up to the latest known trusted header
• Syncs by requesting missing headers from Exchange or
• By accessing cache of pending and verified headers

2. Receives new headers from PubSub subnetwork (s.processIncoming)

• Usually, a new header is adjacent to the trusted head and if so, it is simply appended to the local store, incrementing the subjective height and making it the new latest known trusted header.
• Or, if it receives a header further in the future,
• verifies against the latest known trusted header
• adds the header to pending cache(making it the latest known trusted header)
• and triggers syncing loop to catch up to that point.

func NewSyncer

func NewSyncer(exchange header.Exchange, store header.Store, sub header.Subscriber) *Syncer

NewSyncer creates a new instance of Syncer.

func (*Syncer) Start

func (s *Syncer) Start(context.Context) error

Start starts the syncing routine.

func (*Syncer) State

func (s *Syncer) State() State

State reports state of the current (if in progress), or last sync (if finished). Note that throughout the whole Syncer lifetime there might an initial sync and multiple catch-ups. All of them are treated as different syncs with different state IDs and other information.

func (*Syncer) Stop

func (s *Syncer) Stop(ctx context.Context) error

Stop stops Syncer.

func (*Syncer) WaitSync

func (s *Syncer) WaitSync(ctx context.Context) error

WaitSync blocks until ongoing sync is done.