history

type Config struct {
	// Pruner configures the pruner to use.
	Pruner PrunerFactory

	// PruneInterval configures the pruning interval.
	PruneInterval time.Duration
}

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

type History interface {
	roothash.BlockHistory

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

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

type PruneHandler interface {
	// Prune is called before the specified rounds are pruned.
	//
	// If an error is returned, pruning is aborted and the rounds are
	// not pruned from history.
	//
	// 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).
	Prune(ctx context.Context, rounds []uint64) error
}

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

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

type PrunerFactory func(db *DB) (Pruner, error)