utils

Documentation

Index

• Constants
• Variables
• func BasePath(name string) string
• func ExpandDir(targetPath string) string
• func GetDevGenesisPath(t *testing.T) string
• func GetDevGenesisSpecPathTest(t *testing.T) string
• func GetGssmrGenesisPath() (path string, err error)
• func GetGssmrGenesisPathTest(t *testing.T) string
• func GetGssmrGenesisRawPath() (path string, err error)
• func GetGssmrGenesisRawPathTest(t *testing.T) string
• func GetProjectRootPath() (rootPath string, err error)
• func GetProjectRootPathTest(t *testing.T) (rootPath string)
• func HomeDir() string
• func KeystoreDir(basepath string) (keystorepath string, err error)
• func KeystoreFilepaths(basepath string) ([]string, error)
• func KeystoreFiles(basepath string) ([]string, error)
• func LoadBadgerDB(basePath string) (*badger.DB, error)
• func LoadChainDB(basePath string) (*chaindb.BadgerDB, error)
• func PathExists(p string) bool
• func SetupDatabase(basepath string, inMemory bool) (chaindb.Database, error)

Constants

const DefaultDatabaseDir = "db"

DefaultDatabaseDir directory inside basepath where database contents are stored

Variables

var (
	ErrFindProjectRoot = errors.New("cannot find project root")
)

Functions

func BasePath

func BasePath(name string) string

BasePath attempts to create a data directory using the given name within the gossamer directory within the user's HOME directory, returns absolute path or, if unable to locate HOME directory, returns within current directory

func ExpandDir

func ExpandDir(targetPath string) string

ExpandDir expands a tilde prefix path to a full home path

func GetDevGenesisPath

func GetDevGenesisPath(t *testing.T) string

GetDevGenesisPath gets the dev genesis path

func GetDevGenesisSpecPathTest

func GetDevGenesisSpecPathTest(t *testing.T) string

GetDevGenesisSpecPathTest gets the dev genesis spec path

func GetGssmrGenesisPath

func GetGssmrGenesisPath() (path string, err error)

GetGssmrGenesisPath gets the gssmr genesis path and returns an error if it cannot find it.

func GetGssmrGenesisPathTest

func GetGssmrGenesisPathTest(t *testing.T) string

GetGssmrGenesisPathTest gets the gssmr genesis path and fails the test if it cannot find it.

func GetGssmrGenesisRawPath

func GetGssmrGenesisRawPath() (path string, err error)

GetGssmrGenesisRawPath gets the gssmr raw genesis path and returns an error if it cannot find it.

func GetGssmrGenesisRawPathTest

func GetGssmrGenesisRawPathTest(t *testing.T) string

GetGssmrGenesisRawPathTest gets the gssmr raw genesis path and fails the test if it cannot find it.

func GetProjectRootPath

func GetProjectRootPath() (rootPath string, err error)

GetProjectRootPath finds the root of the project where `go.mod` is and returns it as an absolute path.

func GetProjectRootPathTest

func GetProjectRootPathTest(t *testing.T) (rootPath string)

GetProjectRootPathTest finds the root of the project where `go.mod` is and returns it as an absolute path. It fails the test if it's not found.

func HomeDir

func HomeDir() string

HomeDir returns the user's current HOME directory

func KeystoreDir

func KeystoreDir(basepath string) (keystorepath string, err error)

KeystoreDir returns the absolute filepath of the keystore directory

func KeystoreFilepaths

func KeystoreFilepaths(basepath string) ([]string, error)

KeystoreFilepaths lists all the keys in the basepath/keystore/ directory and returns them as a list of filepaths

func KeystoreFiles

func KeystoreFiles(basepath string) ([]string, error)

KeystoreFiles returns the filenames of all the keys in the basepath's keystore

func LoadBadgerDB

func LoadBadgerDB(basePath string) (*badger.DB, error)

LoadBadgerDB load the db at the given path.

func LoadChainDB

func LoadChainDB(basePath string) (*chaindb.BadgerDB, error)

LoadChainDB load the db at the given path.

func PathExists

func PathExists(p string) bool

PathExists returns true if the named file or directory exists, otherwise false

func SetupDatabase

func SetupDatabase(basepath string, inMemory bool) (chaindb.Database, error)

SetupDatabase will return an instance of database based on basepath