doctor

Documentation

Index

• Constants
• type Doctor
  • func New(opts ...Option) *Doctor
  • func (d *Doctor) FixDependencyTools(ctx context.Context) error
  • func (d *Doctor) MigrateConfig(_ context.Context) error
• type Option
  • func CollectEvents(ev events.Bus) Option

Constants

const (
	// ToolsFile defines the app relative path to the Go tools file.
	ToolsFile = "tools/tools.go"
)

Types

type Doctor

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

DONTCOVER: Doctor read and write the filesystem intensively, so it's better to rely on integration tests only. See integration/doctor package.

func New

func New(opts ...Option) *Doctor

New returns a new doctor.

func (*Doctor) FixDependencyTools

func (d *Doctor) FixDependencyTools(ctx context.Context) error

FixDependencyTools ensures that: - tools/tools.go is present and populated properly - dependency tools are installed.

func (*Doctor) MigrateConfig

func (d *Doctor) MigrateConfig(_ context.Context) error

MigrateConfig migrates the chain config if required.

type Option

type Option func(*Doctor)

func CollectEvents

func CollectEvents(ev events.Bus) Option

CollectEvents sets doctor event bus.