db

Documentation

Overview

Package db defines a persistent backend for the slasher service.

Index

• Variables
• func NewDB(dirPath string, cfg *kv.Config) (*kv.Store, error)
• type Database
• type FullAccessDatabase
• type ReadOnlyDatabase
• type WriteAccessDatabase

Variables

var DatabaseCommands = &cli.Command{
	Name:     "db",
	Category: "db",
	Usage:    "defines commands for interacting with the Prysm slasher database",
	Subcommands: []*cli.Command{
		{
			Name:        "restore",
			Description: `restores a database from a backup file`,
			Flags: cmd.WrapFlags([]cli.Flag{
				cmd.RestoreSourceFileFlag,
				cmd.RestoreTargetDirFlag,
			}),
			Before: tos.VerifyTosAcceptedOrPrompt,
			Action: func(cliCtx *cli.Context) error {
				if err := restore(cliCtx); err != nil {
					log.Fatalf("Could not restore database: %v", err)
				}
				return nil
			},
		},
	},
}

DatabaseCommands for Prysm slasher.

Functions

func NewDB

func NewDB(dirPath string, cfg *kv.Config) (*kv.Store, error)

NewDB initializes a new DB.

Types

type Database

type Database = iface.Database

Database defines the necessary methods for the Slasher's DB which may be implemented by any key-value or relational database in practice. This is the full database interface which should not be used often. Prefer a more restrictive interface in this package.

type FullAccessDatabase

type FullAccessDatabase = iface.FullAccessDatabase

FullAccessDatabase exposes Slasher's DB write and read functions for all slasher related buckets.

type ReadOnlyDatabase

type ReadOnlyDatabase = iface.ReadOnlyDatabase

ReadOnlyDatabase exposes the Slasher's DB read only functions for all slasher related buckets.

type WriteAccessDatabase

type WriteAccessDatabase = iface.WriteAccessDatabase

WriteAccessDatabase exposes the Slasher's DB writing functions for all slasher related buckets.