cli

Documentation

Index

• Constants
• Variables
• func AddBulkGenesisAccountCmd() *cobra.Command
• func AddGenesisAccountCmd() *cobra.Command
• func CollectGenTxsCmd(validator types.MessageValidator) *cobra.Command
• func Commands(genutilModule genutil.AppModule, genMM genesisMM, ...) *cobra.Command
• func CommandsWithCustomMigrationMap(genutilModule genutil.AppModule, genMM genesisMM, ...) *cobra.Command
• func ExportCmd(appExporter servertypes.AppExporter) *cobra.Command
• func GenTxCmd(genMM genesisMM, genBalIterator types.GenesisBalancesIterator) *cobra.Command
• func InitCmd(mm genesisMM) *cobra.Command
• func MigrateGenesisCmd(migrations types.MigrationMap) *cobra.Command
• func MigrateHandler(cmd *cobra.Command, args []string, migrations types.MigrationMap) error
• func ValidateGenesisCmd(genMM genesisMM) *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"

	// FlagConsensusKeyAlgo defines the algorithm to use for the consensus signing key.
	FlagConsensusKeyAlgo = "consensus-key-algo"
)

Variables

var MigrationMap = types.MigrationMap{}

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

Functions

func AddBulkGenesisAccountCmd

func AddBulkGenesisAccountCmd() *cobra.Command

AddBulkGenesisAccountCmd returns bulk-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 AddGenesisAccountCmd

func AddGenesisAccountCmd() *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(validator types.MessageValidator) *cobra.Command

CollectGenTxsCmd - return the cobra command to collect genesis transactions

func Commands

func Commands(genutilModule genutil.AppModule, genMM genesisMM, appExport servertypes.AppExporter) *cobra.Command

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

func CommandsWithCustomMigrationMap

func CommandsWithCustomMigrationMap(genutilModule genutil.AppModule, genMM genesisMM, appExport servertypes.AppExporter, 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 ExportCmd

func ExportCmd(appExporter servertypes.AppExporter) *cobra.Command

ExportCmd dumps app state to JSON.

func GenTxCmd

func GenTxCmd(genMM genesisMM, genBalIterator types.GenesisBalancesIterator) *cobra.Command

GenTxCmd builds the application's gentx command.

func InitCmd

func InitCmd(mm genesisMM) *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(genMM genesisMM) *cobra.Command

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