backup

Documentation

Index

• func ValidateConfig(cfg Config) error
• type Config
  • func DefaultConfig() Config
• type Option
  • func WithLogger(l log.Logger) Option
• type Service
  • func NewService(client client.Client, writer writer.Writer, opts ...Option) *Service
  • func (s *Service) ExecuteBackup(ctx context.Context, cfg Config) error

Functions

func ValidateConfig

func ValidateConfig(cfg Config) error

ValidateConfig validates the base backup configuration

Types

type Config

type Config struct {
	ToBlock   *uint64 // the right bound for the block range; latest if not specified
	FromBlock uint64  // the left bound for the block range

	Watch bool // flag indicating if incoming tx data should be backed up
}

Config is the base chain backup configuration

func DefaultConfig

func DefaultConfig() Config

DefaultConfig returns the default backup configuration

type Option

type Option func(s *Service)

func WithLogger

func WithLogger(l log.Logger) Option

WithLogger specifies the logger for the backup service

type Service

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

Service is the chain backup service

func NewService

func NewService(client client.Client, writer writer.Writer, opts ...Option) *Service

NewService creates a new backup service

func (*Service) ExecuteBackup

func (s *Service) ExecuteBackup(ctx context.Context, cfg Config) error

ExecuteBackup executes the node backup process