cmd

Documentation

Overview

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

Index

• 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
• type InitConfig
  • func (c InitConfig) HaloCfg(cfg *halocfg.Config)
  • func (c InitConfig) Verify() error

Functions

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 halo. 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.

Types

type InitConfig

type InitConfig struct {
	HomeDir       string
	Moniker       string
	Network       netconf.ID
	TrustedSync   bool
	HaloCfgFunc   func(*halocfg.Config)
	Force         bool
	Clean         bool
	ExecutionHash common.Hash
}

InitConfig is the config for the init command.

func (InitConfig) HaloCfg

func (c InitConfig) HaloCfg(cfg *halocfg.Config)

func (InitConfig) Verify

func (c InitConfig) Verify() error