history

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

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

type Factory func(runtimeID common.Namespace, dataDir string) (History, error)

type History interface {
	roothash.BlockHistory
	consensus.StatePruneHandler

	// Pruner returns the history pruner.
	Pruner() Pruner

	// PruneBefore prunes runtime history before the given round.
	PruneBefore(round uint64) (uint64, error)

	// Compact triggers compaction of the History underlying storage engine.
	Compact() error

	// Close closes the history keeper.
	Close()
}

type IndexerStatus struct {
	// Status is the concise status of runtime history indexer state.
	Status string `json:"status"`

	// LastRound is the last runtime round that was indexed.
	LastRound uint64 `json:"last_round"`

	// ReindexStatus is history reindex status.
	//
	// It is nil unless during history reindex.
	ReindexStatus *ReindexStatus `json:"reindex_status,omitempty"`
}

type PruneHandler interface {
	// CanPruneRuntime is called before to check if the specified round can be pruned.
	//
	// Note that this can be called for the same round multiple
	// times (e.g., if one of the handlers fails but others succeed
	// and pruning is later retried).
	CanPruneRuntime(rounds []uint64) error
}

type Pruner interface {
	// Prune purges unneeded history, given the latest round.
	Prune(latestRound uint64) error

	// PruneInterval specifies how often pruning should occur.
	PruneInterval() time.Duration

	// RegisterHandler registers a prune handler.
	RegisterHandler(handler PruneHandler)
}

type PrunerFactory func(runtimeID common.Namespace, db *DB) (Pruner, error)

type ReindexStatus struct {
	// BatchSize is the number of blocks to reindex in a single batch.
	BatchSize uint16 `json:"batch_size"`
	// LastHeight is the last consensus height that was indexed.
	LastHeight int64 `json:"last_height"`
	// StartHeight is the first height of history reindex interval.
	StartHeight int64 `json:"start_height"`
	// EndHeight is the last height of history reindex interval.
	EndHeight int64 `json:"end_height"`
	// ETA is expected time of history reindex completition.
	ETA time.Time `json:"eta"`
}