pruner

package

v0.26.4 Latest Latest Go to latest Published: Oct 6, 2025 License: Apache-2.0 Imports: 16 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/celestiaorg/celestia-node

Links

Documentation ¶

Index ¶

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, hstore libhead.Store[*header.ExtendedHeader], ...) (*Service, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func WithPrunerMetrics ¶ added in v0.14.0

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 ¶ added in v0.14.0

type Option func(*Params)

func WithPruneCycle ¶ added in v0.14.0

func WithPruneCycle(cycle time.Duration) Option

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

func (*Params) Validate ¶ added in v0.14.0

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,
	hstore libhead.Store[*header.ExtendedHeader],
	ds datastore.Datastore,
	blockTime time.Duration,
	opts ...Option,
) (*Service, error)

func (*Service) LastPruned ¶ added in v0.21.5

func (s *Service) LastPruned(ctx context.Context) (uint64, error)

func (*Service) ResetCheckpoint ¶ added in v0.21.5

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

func (*Service) Start ¶

func (s *Service) Start(ctx 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 ¶ added in v0.14.0

func (s *Service) WithMetrics() error

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL