cleanup

Documentation

Index

• type Chore
  • func NewChore(log *zap.Logger, db blockchain.HeadersDB, config Config) *Chore
  • func (chore *Chore) Close() error
  • func (chore *Chore) Run(ctx context.Context) (err error)
  • func (chore *Chore) RunOnce(ctx context.Context) (err error)
• type Config

Types

type Chore

type Chore struct {
	Loop *sync2.Cycle
	// contains filtered or unexported fields
}

Chore to remove old block headers.

architecture: Chore

func NewChore

func NewChore(log *zap.Logger, db blockchain.HeadersDB, config Config) *Chore

NewChore creates new chore for removing old block headers.

func (*Chore) Close

func (chore *Chore) Close() error

Close stops the chore.

func (*Chore) Run

func (chore *Chore) Run(ctx context.Context) (err error)

Run starts the chore.

func (*Chore) RunOnce

func (chore *Chore) RunOnce(ctx context.Context) (err error)

RunOnce removes old block headers.

type Config

type Config struct {
	Interval   time.Duration `help:"how often to remove old block headers" default:"336h" testDefault:"$TESTINTERVAL"`
	RetainDays int           `help:"number of days of block headers to retain" default:"30"`
}

Config is a configuration struct for the Chore.