sync

Documentation

Index

• Constants
• type EventListener
• type HeaderSubscription
• type NoopSynchronizer
  • func (n *NoopSynchronizer) HighestBlockHeader() *core.Header
  • func (n *NoopSynchronizer) StartingBlockNumber() (uint64, error)
  • func (n *NoopSynchronizer) SubscribeNewHeads() HeaderSubscription
• type Reader
• type SelectiveListener
  • func (l *SelectiveListener) OnReorg(blockNum uint64)
  • func (l *SelectiveListener) OnSyncStepDone(op string, blockNum uint64, took time.Duration)
• type Synchronizer
  • func New(bc *blockchain.Blockchain, starkNetData starknetdata.StarknetData, ...) *Synchronizer
  • func (s *Synchronizer) HighestBlockHeader() *core.Header
  • func (s *Synchronizer) Run(ctx context.Context) error
  • func (s *Synchronizer) StartingBlockNumber() (uint64, error)
  • func (s *Synchronizer) SubscribeNewHeads() HeaderSubscription
  • func (s *Synchronizer) WithListener(listener EventListener) *Synchronizer

Constants

const (
	OpVerify = "verify"
	OpStore  = "store"
	OpFetch  = "fetch"
)

Types

type EventListener

type EventListener interface {
	OnSyncStepDone(op string, blockNum uint64, took time.Duration)
	OnReorg(blockNum uint64)
}

type HeaderSubscription

type HeaderSubscription struct {
	*feed.Subscription[*core.Header]
}

This is a work-around. mockgen chokes when the instantiated generic type is in the interface.

type NoopSynchronizer

type NoopSynchronizer struct{}

This is temporary and will be removed once the p2p synchronizer implements this interface.

func (*NoopSynchronizer) HighestBlockHeader

func (n *NoopSynchronizer) HighestBlockHeader() *core.Header

func (*NoopSynchronizer) StartingBlockNumber

func (n *NoopSynchronizer) StartingBlockNumber() (uint64, error)

func (*NoopSynchronizer) SubscribeNewHeads

func (n *NoopSynchronizer) SubscribeNewHeads() HeaderSubscription

type Reader

type Reader interface {
	StartingBlockNumber() (uint64, error)
	HighestBlockHeader() *core.Header
	SubscribeNewHeads() HeaderSubscription
}

Todo: Since this is also going to be implemented by p2p package we should move this interface to node package

type SelectiveListener

type SelectiveListener struct {
	OnSyncStepDoneCb func(op string, blockNum uint64, took time.Duration)
	OnReorgCb        func(blockNum uint64)
}

func (*SelectiveListener) OnReorg

func (l *SelectiveListener) OnReorg(blockNum uint64)

func (*SelectiveListener) OnSyncStepDone

func (l *SelectiveListener) OnSyncStepDone(op string, blockNum uint64, took time.Duration)

type Synchronizer

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

Synchronizer manages a list of StarknetData to fetch the latest blockchain updates

func New

func New(bc *blockchain.Blockchain, starkNetData starknetdata.StarknetData,
	log utils.SimpleLogger, pendingPollInterval time.Duration, readOnlyBlockchain bool,
) *Synchronizer

func (*Synchronizer) HighestBlockHeader

func (s *Synchronizer) HighestBlockHeader() *core.Header

func (*Synchronizer) Run

func (s *Synchronizer) Run(ctx context.Context) error

Run starts the Synchronizer, returns an error if the loop is already running

func (*Synchronizer) StartingBlockNumber

func (s *Synchronizer) StartingBlockNumber() (uint64, error)

func (*Synchronizer) SubscribeNewHeads

func (s *Synchronizer) SubscribeNewHeads() HeaderSubscription

func (*Synchronizer) WithListener

func (s *Synchronizer) WithListener(listener EventListener) *Synchronizer

WithListener registers an EventListener