statefulsyncer

Documentation

Index

• Constants
• type Logger
• type Option
  • func WithAdjustmentWindow(adjustmentWindow int64) Option
  • func WithCacheSize(cacheSize int) Option
  • func WithMaxConcurrency(concurrency int64) Option
  • func WithMetaData(metaData string) Option
  • func WithPastBlockLimit(blocks int) Option
  • func WithPruneSleepTime(sleepTime int) Option
  • func WithSeenConcurrency(concurrency int64) Option
• type PruneHelper
• type StatefulSyncer
  • func New(ctx context.Context, network *types.NetworkIdentifier, ...) *StatefulSyncer
  • func (s *StatefulSyncer) Block(ctx context.Context, network *types.NetworkIdentifier, ...) (*types.Block, error)
  • func (s *StatefulSyncer) BlockAdded(ctx context.Context, block *types.Block) error
  • func (s *StatefulSyncer) BlockRemoved(ctx context.Context, blockIdentifier *types.BlockIdentifier) error
  • func (s *StatefulSyncer) BlockSeen(ctx context.Context, block *types.Block) error
  • func (s *StatefulSyncer) NetworkStatus(ctx context.Context, network *types.NetworkIdentifier) (*types.NetworkStatusResponse, error)
  • func (s *StatefulSyncer) Prune(ctx context.Context, helper PruneHelper) error
  • func (s *StatefulSyncer) Sync(ctx context.Context, startIndex int64, endIndex int64) error

Constants

const (
	// DefaultPruneSleepTime is how long we sleep between
	// pruning attempts.
	DefaultPruneSleepTime = 10 * time.Minute
)

Types

type Logger

type Logger interface {
	AddBlockStream(context.Context, *types.Block) error
	RemoveBlockStream(context.Context, *types.BlockIdentifier) error
}

Logger is used by the statefulsyncer to log the addition and removal of blocks.

type Option

type Option func(s *StatefulSyncer)

Option is used to overwrite default values in StatefulSyncer construction. Any Option not provided falls back to the default value.

func WithAdjustmentWindow

func WithAdjustmentWindow(adjustmentWindow int64) Option

WithAdjustmentWindow overrides the default adjustment window.

func WithCacheSize

func WithCacheSize(cacheSize int) Option

WithCacheSize overrides the default cache size.

func WithMaxConcurrency

func WithMaxConcurrency(concurrency int64) Option

WithMaxConcurrency overrides the default max concurrency.

func WithMetaData

func WithMetaData(metaData string) Option

add a metaData map to fetcher

func WithPastBlockLimit

func WithPastBlockLimit(blocks int) Option

WithPastBlockLimit overrides the default past block limit

func WithPruneSleepTime

func WithPruneSleepTime(sleepTime int) Option

WithPruneSleepTime overrides the default prune sleep time.

func WithSeenConcurrency

func WithSeenConcurrency(concurrency int64) Option

WithSeenConcurrency overrides the number of concurrent invocations of BlockSeen we will handle. We default to the value of runtime.NumCPU().

type PruneHelper

type PruneHelper interface {
	// PruneableIndex is the largest block
	// index that is considered safe to prune.
	PruneableIndex(ctx context.Context, headIndex int64) (int64, error)
}

PruneHelper is used by the stateful syncer to determine the safe pruneable index. This is a helper instead of a static argument because the pruneable index is often a function of the state of some number of structs.

type StatefulSyncer

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

StatefulSyncer is an abstraction layer over the stateless syncer package. This layer handles sync restarts and provides fully populated blocks during reorgs (not provided by stateless syncer).

func New

func New(
	ctx context.Context,
	network *types.NetworkIdentifier,
	fetcher *fetcher.Fetcher,
	blockStorage *modules.BlockStorage,
	counterStorage *modules.CounterStorage,
	logger Logger,
	cancel context.CancelFunc,
	workers []modules.BlockWorker,
	options ...Option,
) *StatefulSyncer

New returns a new *StatefulSyncer.

func (*StatefulSyncer) Block

func (s *StatefulSyncer) Block(
	ctx context.Context,
	network *types.NetworkIdentifier,
	block *types.PartialBlockIdentifier,
) (*types.Block, error)

Block is called by the syncer to fetch a block.

func (*StatefulSyncer) BlockAdded

func (s *StatefulSyncer) BlockAdded(ctx context.Context, block *types.Block) error

BlockAdded is called by the syncer when a block is added.

func (*StatefulSyncer) BlockRemoved

func (s *StatefulSyncer) BlockRemoved(
	ctx context.Context,
	blockIdentifier *types.BlockIdentifier,
) error

BlockRemoved is called by the syncer when a block is removed.

func (*StatefulSyncer) BlockSeen

func (s *StatefulSyncer) BlockSeen(ctx context.Context, block *types.Block) error

BlockSeen is called by the syncer when a block is seen.

func (*StatefulSyncer) NetworkStatus

func (s *StatefulSyncer) NetworkStatus(
	ctx context.Context,
	network *types.NetworkIdentifier,
) (*types.NetworkStatusResponse, error)

NetworkStatus is called by the syncer to get the current network status.

func (*StatefulSyncer) Prune

func (s *StatefulSyncer) Prune(ctx context.Context, helper PruneHelper) error

Prune will repeatedly attempt to prune BlockStorage until the context is canceled or an error is encountered.

PruneHelper is provided as an argument here instead of in the initializer because the caller may wish to change pruning strategies during syncing.

func (*StatefulSyncer) Sync

func (s *StatefulSyncer) Sync(ctx context.Context, startIndex int64, endIndex int64) error

Sync starts a new sync run after properly initializing blockStorage.