commands

Documentation

Overview

Package commands contains any general setup/helpers valid for all subcommands

Index

• Constants
• Variables
• func AddBasicFlags(cmd *cobra.Command)
• func GetCertifier() (*certifiers.InquiringCertifier, error)
• func GetChainID() string
• func GetNode() rpcclient.Client
• func GetProviders() (trusted certifiers.Provider, source certifiers.Provider)
• func WasInited(root string) (bool, error)
• type Config
• type Runable
  • func RequireInit(run Runable) Runable

Constants

const (
	ChainFlag = "chain-id"
	NodeFlag  = "node"
)

const (
	SeedFlag    = "seed"
	HashFlag    = "valhash"
	GenesisFlag = "genesis"

	ConfigFile = "config.toml"
)

Variables

var InitCmd = &cobra.Command{
	Use:   "init",
	Short: "Initialize the light client for a new chain",
	RunE:  runInit,
}

InitCmd will initialize the basecli store

var ResetCmd = &cobra.Command{
	Use:   "reset_all",
	Short: "DANGEROUS: Wipe out all client data, including keys",
	RunE:  runResetAll,
}

Functions

func AddBasicFlags

func AddBasicFlags(cmd *cobra.Command)

func GetCertifier

func GetCertifier() (*certifiers.InquiringCertifier, error)

func GetChainID

func GetChainID() string

func GetNode

func GetNode() rpcclient.Client

func GetProviders

func GetProviders() (trusted certifiers.Provider, source certifiers.Provider)

func WasInited

func WasInited(root string) (bool, error)

WasInited returns true if a light-client was previously initialized in this directory. Important to ensure proper behavior.

Returns error if we have filesystem errors

Types

type Config

type Config struct {
	Chain    string `toml:"chain-id,omitempty"`
	Node     string `toml:"node,omitempty"`
	Output   string `toml:"output,omitempty"`
	Encoding string `toml:"encoding,omitempty"`
}

type Runable

type Runable func(cmd *cobra.Command, args []string) error

func RequireInit

func RequireInit(run Runable) Runable

Any commands that require and init'ed light-client directory should wrap their RunE command with RequireInit to make sure that the client is initialized.

This cannot be called during PersistentPreRun, as they are called from the most specific command first, and root last, and the root command sets up viper, which is needed to find the home dir.