pruner

Documentation

Index

• Variables
• func DetectPreviousRun(ctx context.Context, ds datastore.Datastore) error
• func WithPrunerMetrics(s *Service) error
• type Option
  • func WithPruneCycle(cycle time.Duration) Option
• type Params
  • func DefaultParams() Params
  • func (p *Params) Validate() error
• type Pruner
• type Service
  • func NewService(p Pruner, window time.Duration, getter libhead.Getter[*header.ExtendedHeader], ...) (*Service, error)
  • func (s *Service) Start(context.Context) error
  • func (s *Service) Stop(ctx context.Context) error
  • func (s *Service) WithMetrics() error

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

func DetectPreviousRun(ctx context.Context, ds datastore.Datastore) error

DetectPreviousRun checks if the pruner has run before by checking for the existence of a checkpoint.

func WithPrunerMetrics

func WithPrunerMetrics(s *Service) error

WithPrunerMetrics is a utility function to turn on pruner metrics and that is expected to be "invoked" by the fx lifecycle.

Types

type Option

type Option func(*Params)

func WithPruneCycle

func WithPruneCycle(cycle time.Duration) Option

WithPruneCycle configures how often the pruning Service triggers a pruning cycle.

type Params

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

func DefaultParams

func DefaultParams() Params

func (*Params) Validate

func (p *Params) Validate() error

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 NewService(
	p Pruner,
	window time.Duration,
	getter libhead.Getter[*header.ExtendedHeader],
	ds datastore.Datastore,
	blockTime time.Duration,
	opts ...Option,
) (*Service, error)

func (*Service) Start

func (s *Service) Start(context.Context) error

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.

func (*Service) Stop

func (s *Service) Stop(ctx context.Context) error

func (*Service) WithMetrics

func (s *Service) WithMetrics() error