cmd

Documentation

Overview

Package cmd provides the cli for running the story consensus client.

Package cmd provides commands for interacting with the Story consensus client.

Index

• func CheckStatus(ctx context.Context, cfg StatusConfig) error
• func DefaultCometConfig(homeDir string) cfg.Config
• func InitFiles(ctx context.Context, initCfg InitConfig) error
• func MakeGenesis(network netconf.ID, valPubKeys ...crypto.PubKey) (*types.GenesisDoc, error)
• func New() *cobra.Command
• func SplitAndTrim(input string) []string
• func WriteConfigFile(configFilePath string, config *cmtconfig.Config)
• type InitConfig
• type KeyInfo
• type StakingPeriod
  • func (sp *StakingPeriod) Set(v string) error
  • func (sp *StakingPeriod) String() string
  • func (*StakingPeriod) Type() string
• type StatusConfig
• type ValidatorKey

Functions

func CheckStatus

func CheckStatus(ctx context.Context, cfg StatusConfig) error

checkStatus queries the status endpoint of the Story chain and fetches the latest block height.

func DefaultCometConfig

func DefaultCometConfig(homeDir string) cfg.Config

DefaultCometConfig returns the default cometBFT config.

func InitFiles

func InitFiles(ctx context.Context, initCfg InitConfig) error

InitFiles initializes the files and folders required by story. It ensures a network and genesis file is generated/downloaded for the provided network.

func MakeGenesis

func MakeGenesis(network netconf.ID, valPubKeys ...crypto.PubKey) (*types.GenesisDoc, error)

func New

func New() *cobra.Command

New returns a new root cobra command that handles our command line tool.

func SplitAndTrim

func SplitAndTrim(input string) []string

func WriteConfigFile

func WriteConfigFile(configFilePath string, config *cmtconfig.Config)

WriteConfigFile renders config using the template and writes it to configFilePath.

Types

type InitConfig

type InitConfig struct {
	HomeDir         string
	Network         netconf.ID
	TrustedSync     bool
	Force           bool
	Clean           bool
	Cosmos          bool
	ExecutionHash   common.Hash
	RPCLaddr        string
	ExternalAddress string
	Seeds           string
	SeedMode        bool
	Moniker         string
	PersistentPeers string
}

InitConfig is the config for the init command.

type KeyInfo

type KeyInfo struct {
	Type  string `json:"type"`
	Value string `json:"value"`
}

type StakingPeriod

type StakingPeriod int

const (
	FLEXIBLE StakingPeriod = iota
	SHORT
	MEDIUM
	LONG
)

func (*StakingPeriod) Set

func (sp *StakingPeriod) Set(v string) error

func (*StakingPeriod) String

func (sp *StakingPeriod) String() string

func (*StakingPeriod) Type

func (*StakingPeriod) Type() string

type StatusConfig

type StatusConfig struct {
	HomeDir  string
	RPCLaddr string
}

StatusConfig is the config for the status command.

type ValidatorKey

type ValidatorKey struct {
	Address string  `json:"address"`
	PubKey  KeyInfo `json:"pub_key"`
	PrivKey KeyInfo `json:"priv_key"`
}