collection_sync

type BlockCollectionIndexer interface {
	// IndexCollectionsForBlock stores and indexes collections for a given block height.
	// No error is exepcted during normal operation.
	IndexCollectionsForBlock(blockHeight uint64, cols []*flow.Collection) error

	// GetMissingCollections retrieves the block and returns collection guarantees that whose collections
	// are missing in storage.
	// Only garantees whose collections that are not already in storage are returned.
	GetMissingCollections(block *flow.Block) ([]*flow.CollectionGuarantee, error)
}

type BlockProcessor interface {
	// RequestCollectionsForBlock requests all missing collections for the given block.
	FetchCollections(ctx irrecoverable.SignalerContext, block *flow.Block, done func()) error
	// MissingCollectionQueueSize returns the number of missing collections currently in the queue.
	MissingCollectionQueueSize() uint
	// PruneUpToHeight removes all tracked heights up to and including the given height.
	PruneUpToHeight(height uint64)
}

type CollectionRequester interface {
	RequestCollectionsByGuarantees(guarantees []*flow.CollectionGuarantee) error
}

type ExecutionDataProcessor interface {
	OnNewExectuionData()
}

type ExecutionDataProvider interface {
	HighestIndexedHeight() uint64
	GetExecutionDataByHeight(ctx context.Context, height uint64) ([]*flow.Collection, error)
}

type Fetcher interface {
	component.Component
	ProgressReader
	OnFinalizedBlock()
	Size() uint
}

type MissingCollectionQueue interface {
	// EnqueueMissingCollections tracks the given missing collection IDs for the given block height.
	EnqueueMissingCollections(blockHeight uint64, ids []flow.Identifier, callback func()) error

	// OnIndexedForBlock returns the callback function for the given block height
	OnIndexedForBlock(blockHeight uint64) (func(), bool)

	// On receipt of a collection, MCQ updates internal state and, if a block
	// just became complete, returns: (collections, height, true).
	// Otherwise, returns (nil, 0, false).
	OnReceivedCollection(collection *flow.Collection) ([]*flow.Collection, uint64, bool)

	// PruneUpToHeight removes all tracked heights up to and including the given height.
	PruneUpToHeight(height uint64) (callbacks []func())

	// IsHeightQueued returns true if the given height is still being tracked (has not been indexed yet).
	IsHeightQueued(height uint64) bool

	// Size returns the number of missing collections currently in the queue.
	Size() uint
}

type ProgressReader interface {
	ProcessedHeight() uint64
}