commands

Documentation

Overview

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

Index

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

Constants

const (
	ChainFlag   = "chain-id"
	NodeFlag    = "node"
	CliHomeFlag = "cli-home"
)

const (
	CommitFlag    = "commit"
	HashFlag      = "valhash"
	GenesisFlag   = "genesis"
	FlagTrustNode = "trust-node"

	ConfigFile = "config.toml"
)

nolint

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)

AddBasicFlags adds --node and --chain-id, which we need for everything

func GetChainID

func GetChainID() string

GetChainID reads ChainID from the flags

func GetNode

func GetNode() rpcclient.Client

GetNode prepares a simple rpc.Client from the flags

func GetProviders

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

GetProviders creates a trusted (local) seed provider and a remote provider based on configuration.

func GetSourceProvider

func GetSourceProvider() lite.Provider

GetSourceProvider returns a provider pointing to an rpc handler

func GetTrustedProvider

func GetTrustedProvider() lite.Provider

GetTrustedProvider returns a reference to a local store with cache

func WasInited

func WasInited(root string) (bool, error)

WasInited returns true if a basecoin 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 basecoin 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.