Documentation ¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( // ErrDisallowRevertToArchival is returned when a node has been run with pruner enabled before and // launching it with archival mode. ErrDisallowRevertToArchival = errors.New( "node has been run with pruner enabled before, it is not safe to convert to an archival" + "Run with --experimental-pruning enabled or consider re-initializing the store") )
Functions ¶
func DetectPreviousRun ¶ added in v0.14.0
DetectPreviousRun checks if the pruner has run before by checking for the existence of a checkpoint.
func IsWithinAvailabilityWindow ¶ added in v0.14.0
func IsWithinAvailabilityWindow(t time.Time, window AvailabilityWindow) bool
IsWithinAvailabilityWindow checks whether the given timestamp is within the given AvailabilityWindow. If the window is disabled (0), it returns true for every timestamp.
func WithPrunerMetrics ¶ added in v0.14.0
WithPrunerMetrics is a utility function to turn on pruner metrics and that is expected to be "invoked" by the fx lifecycle.
Types ¶
type AvailabilityWindow ¶
func (AvailabilityWindow) Duration ¶ added in v0.14.0
func (aw AvailabilityWindow) Duration() time.Duration
type Option ¶ added in v0.14.0
type Option func(*Params)
func WithPruneCycle ¶ added in v0.14.0
WithPruneCycle configures how often the pruning Service triggers a pruning cycle.
type Params ¶ added in v0.14.0
type Params struct {
// contains filtered or unexported fields
}
func DefaultParams ¶ added in v0.14.0
func DefaultParams() Params
type Pruner ¶
type Pruner interface {
Prune(context.Context, *header.ExtendedHeader) error
}
Pruner contains methods necessary to prune data from the node's datastore.
type Service ¶
type Service struct {
// contains filtered or unexported fields
}
Service handles running the pruning cycle for the node.
func NewService ¶
func (*Service) Start ¶
Start loads the pruner's last pruned height (1 if pruner is freshly initialized) and runs the prune loop, pruning any blocks older than the given availability window.