pruner

Jun 8, 2026

Changes in this version

+ var ErrBlockPruned = errors.New("block has been pruned")

+ var ErrNoBlockInWindow = errors.New("no block in window")

+ func FindOldestBlockAtOrAfter(database db.KeyValueStore, lower, upper uint64, cutoff time.Time) (uint64, error)

+ func HeaderByHashIfStateRetained(r db.KeyValueReader, blockHash *felt.Felt) (*core.Header, error)

+ func HeaderByNumberIfStateRetained(r db.KeyValueReader, blockNumber uint64) (*core.Header, error)

+ func InitializeRunningEventFilter(database db.KeyValueStore) (*core.RunningEventFilter, error)

+ func OldestRetainedBlock(r db.KeyValueReader) (uint64, error)

+ func PruneBlockDataUpto(w db.KeyValueRangeDeleter, rangeEndExclusive uint64) error

+ func PruneUpto(ctx context.Context, database db.KeyValueStore, endExclusive uint64, ...) (blocksPruned, oldestKept uint64, err error)

+ func RequireRetained(r db.KeyValueReader, blockNumber uint64) error

+ type BlockPrunedError struct

+ BlockNumber uint64

+ OldestRetained uint64

+ func (e *BlockPrunedError) Error() string

+ func (e *BlockPrunedError) Is(target error) bool

+ type EventListener interface

+ OnL1Stale func()

+ OnPrune func(oldestBlockKept uint64, blocksPruned uint64, took time.Duration)

+ OnPruneError func(err error)

+ type Option func(*options)

+ func WithFloorTickInterval(duration time.Duration) Option

+ func WithL2HeadsPerPrune(n uint64) Option

+ func WithListener(listener EventListener) Option

+ func WithMinAge(duration time.Duration) Option

+ func WithTargetBatchByteSize(size int) Option

+ type Pruner struct

+ func New(database db.KeyValueStore, retainedBlocks uint64, ...) *Pruner

+ func (p *Pruner) Run(ctx context.Context) error

+ type SelectiveListener struct

+ OnL1StaleCb func()

+ OnPruneCb func(oldestBlockKept uint64, blocksPruned uint64, took time.Duration)

+ OnPruneErrorCb func(err error)

+ func (l *SelectiveListener) OnL1Stale()

+ func (l *SelectiveListener) OnPrune(oldestBlockKept uint64, blocksPruned uint64, took time.Duration)

+ func (l *SelectiveListener) OnPruneError(err error)