cli

Documentation

Index

• Constants
• Variables
• func AddGenesisAccountCmd(defaultNodeHome string, addressCodec address.Codec) *cobra.Command
• func CollectGenTxsCmd(genBalIterator types.GenesisBalancesIterator, defaultNodeHome string, ...) *cobra.Command
• func Commands(txConfig client.TxConfig, moduleBasics module.BasicManager, ...) *cobra.Command
• func CommandsWithCustomMigrationMap(txConfig client.TxConfig, moduleBasics module.BasicManager, ...) *cobra.Command
• func GenTxCmd(mbm module.BasicManager, txEncCfg client.TxEncodingConfig, ...) *cobra.Command
• func GenesisCoreCommand(txConfig client.TxConfig, moduleBasics module.BasicManager, ...) *cobra.Command
• func InitCmd(mbm module.BasicManager, defaultNodeHome string) *cobra.Command
• func MigrateGenesisCmd(migrations types.MigrationMap) *cobra.Command
• func MigrateHandler(cmd *cobra.Command, args []string, migrations types.MigrationMap) error
• func ValidateGenesisCmd(mbm module.BasicManager) *cobra.Command

Constants

const (
	// FlagOverwrite defines a flag to overwrite an existing genesis JSON file.
	FlagOverwrite = "overwrite"

	// FlagSeed defines a flag to initialize the private validator key from a specific seed.
	FlagRecover = "recover"

	// FlagDefaultBondDenom defines the default denom to use in the genesis file.
	FlagDefaultBondDenom = "default-denom"
)

Variables

var MigrationMap = types.MigrationMap{
	"v0.43": v043.Migrate,
	"v0.46": v046.Migrate,
	"v0.47": v047.Migrate,
}

MigrationMap is a map of SDK versions to their respective genesis migration functions.

Functions

func AddGenesisAccountCmd

func AddGenesisAccountCmd(defaultNodeHome string, addressCodec address.Codec) *cobra.Command

AddGenesisAccountCmd returns add-genesis-account cobra Command. This command is provided as a default, applications are expected to provide their own command if custom genesis accounts are needed.

func CollectGenTxsCmd

func CollectGenTxsCmd(genBalIterator types.GenesisBalancesIterator, defaultNodeHome string, validator types.MessageValidator, valAddrCodec runtime.ValidatorAddressCodec) *cobra.Command

CollectGenTxsCmd - return the cobra command to collect genesis transactions

func Commands

func Commands(txConfig client.TxConfig, moduleBasics module.BasicManager, defaultNodeHome string) *cobra.Command

Commands adds core sdk's sub-commands into genesis command.

func CommandsWithCustomMigrationMap

func CommandsWithCustomMigrationMap(txConfig client.TxConfig, moduleBasics module.BasicManager, defaultNodeHome string, migrationMap genutiltypes.MigrationMap) *cobra.Command

CommandsWithCustomMigrationMap adds core sdk's sub-commands into genesis command with custom migration map. This custom migration map can be used by the application to add its own migration map.

func GenTxCmd

func GenTxCmd(mbm module.BasicManager, txEncCfg client.TxEncodingConfig, genBalIterator types.GenesisBalancesIterator, defaultNodeHome string, valAdddressCodec address.Codec) *cobra.Command

GenTxCmd builds the application's gentx command.

func GenesisCoreCommand

func GenesisCoreCommand(txConfig client.TxConfig, moduleBasics module.BasicManager, defaultNodeHome string) *cobra.Command

GenesisCoreCommand adds core sdk's sub-commands into genesis command. Deprecated: use Commands instead.

func InitCmd

func InitCmd(mbm module.BasicManager, defaultNodeHome string) *cobra.Command

InitCmd returns a command that initializes all files needed for Tendermint and the respective application.

func MigrateGenesisCmd

func MigrateGenesisCmd(migrations types.MigrationMap) *cobra.Command

MigrateGenesisCmd returns a command to execute genesis state migration. Applications should pass their own migration map to this function. When the application migration includes a SDK migration, the Cosmos SDK migration function should as well be called.

func MigrateHandler

func MigrateHandler(cmd *cobra.Command, args []string, migrations types.MigrationMap) error

MigrateHandler handles the migration command with a migration map as input, returning an error upon failure.

func ValidateGenesisCmd

func ValidateGenesisCmd(mbm module.BasicManager) *cobra.Command

ValidateGenesisCmd takes a genesis file, and makes sure that it is valid.