Documentation

Overview

    nolint autogenerated code using github.com/rigelrozanski/multitool aliases generated for the following subdirectories: ALIASGEN: github.com/cosmos/cosmos-sdk/x/genutil/types

    Package genutil contains a variety of genesis utility functionality for usage within a blockchain application. Namely:

     - Genesis transactions related (gentx)
        - commands for collection and creation of gentxs
    	- initchain processing of gentxs
     - Genesis file validation
     - Tendermint related initialization
    

    Index

    Constants

    View Source
    const (
    	ModuleName = types.ModuleName
    )

    Variables

    View Source
    var (
    	// functions aliases
    	NewGenesisState             = types.NewGenesisState
    	NewGenesisStateFromStdTx    = types.NewGenesisStateFromStdTx
    	NewInitConfig               = types.NewInitConfig
    	GetGenesisStateFromAppState = types.GetGenesisStateFromAppState
    	SetGenesisStateInAppState   = types.SetGenesisStateInAppState
    	GenesisStateFromGenDoc      = types.GenesisStateFromGenDoc
    	GenesisStateFromGenFile     = types.GenesisStateFromGenFile
    	ValidateGenesis             = types.ValidateGenesis
    
    	// variable aliases
    	ModuleCdc = types.ModuleCdc
    )

    Functions

    func CollectStdTxs

    func CollectStdTxs(cdc *codec.Codec, moniker, genTxsDir string,
    	genDoc tmtypes.GenesisDoc, genAccIterator types.GenesisAccountsIterator,
    ) (appGenTxs []authtypes.StdTx, persistentPeers string, err error)

      CollectStdTxs processes and validates application's genesis StdTxs and returns the list of appGenTxs, and persistent peers required to generate genesis.json.

      func DeliverGenTxs

      func DeliverGenTxs(ctx sdk.Context, cdc *codec.Codec, genTxs []json.RawMessage,
      	stakingKeeper types.StakingKeeper, deliverTx deliverTxfn) []abci.ValidatorUpdate

        DeliverGenTxs - deliver a genesis transaction

        func ExportGenesisFile

        func ExportGenesisFile(genDoc *tmtypes.GenesisDoc, genFile string) error

          ExportGenesisFile creates and writes the genesis configuration to disk. An error is returned if building or writing the configuration to file fails.

          func ExportGenesisFileWithTime

          func ExportGenesisFileWithTime(
          	genFile, chainID string, validators []tmtypes.GenesisValidator,
          	appState json.RawMessage, genTime time.Time,
          ) error

            ExportGenesisFileWithTime creates and writes the genesis configuration to disk. An error is returned if building or writing the configuration to file fails.

            func GenAppStateFromConfig

            func GenAppStateFromConfig(cdc *codec.Codec, config *cfg.Config,
            	initCfg InitConfig, genDoc tmtypes.GenesisDoc,
            	genAccIterator types.GenesisAccountsIterator,
            ) (appState json.RawMessage, err error)

              GenAppStateFromConfig gets the genesis app state from the config

              func InitGenesis

              func InitGenesis(
              	ctx sdk.Context, cdc *codec.Codec, stakingKeeper types.StakingKeeper,
              	deliverTx deliverTxfn, genesisState GenesisState,
              ) []abci.ValidatorUpdate

                InitGenesis - initialize accounts and deliver genesis transactions

                func InitializeNodeValidatorFiles

                func InitializeNodeValidatorFiles(config *cfg.Config) (nodeID string, valPubKey crypto.PubKey, err error)

                  InitializeNodeValidatorFiles creates private validator and p2p configuration files.

                  func NewAppModule

                  func NewAppModule(accountKeeper types.AccountKeeper,
                  	stakingKeeper types.StakingKeeper, deliverTx deliverTxfn) module.AppModule

                    NewAppModule creates a new AppModule object

                    func SetGenTxsInAppGenesisState

                    func SetGenTxsInAppGenesisState(cdc *codec.Codec, appGenesisState map[string]json.RawMessage,
                    	genTxs []authtypes.StdTx) (map[string]json.RawMessage, error)

                      SetGenTxsInAppGenesisState - sets the genesis transactions in the app genesis state

                      func ValidateAccountInGenesis

                      func ValidateAccountInGenesis(appGenesisState map[string]json.RawMessage,
                      	genAccIterator types.GenesisAccountsIterator,
                      	key sdk.Address, coins sdk.Coins, cdc *codec.Codec) error

                        ValidateAccountInGenesis checks that the provided key has sufficient coins in the genesis accounts

                        Types

                        type AppMap

                        type AppMap = types.AppMap

                        type AppModule

                        type AppModule struct {
                        	AppModuleBasic
                        	// contains filtered or unexported fields
                        }

                          AppModule implements an application module for the genutil module.

                          func (AppModule) ExportGenesis

                          func (am AppModule) ExportGenesis(ctx sdk.Context) json.RawMessage

                            ExportGenesis returns the exported genesis state as raw bytes for the genutil module.

                            func (AppModule) InitGenesis

                            func (am AppModule) InitGenesis(ctx sdk.Context, data json.RawMessage) []abci.ValidatorUpdate

                              InitGenesis performs genesis initialization for the genutil module. It returns no validator updates.

                              type AppModuleBasic

                              type AppModuleBasic struct{}

                                AppModuleBasic defines the basic application module used by the genutil module.

                                func (AppModuleBasic) DefaultGenesis

                                func (AppModuleBasic) DefaultGenesis() json.RawMessage

                                  DefaultGenesis returns default genesis state as raw bytes for the genutil module.

                                  func (AppModuleBasic) GetQueryCmd

                                  func (AppModuleBasic) GetQueryCmd(_ *codec.Codec) *cobra.Command

                                    GetQueryCmd returns no root query command for the genutil module.

                                    func (AppModuleBasic) GetTxCmd

                                    func (AppModuleBasic) GetTxCmd(_ *codec.Codec) *cobra.Command

                                      GetTxCmd returns no root tx command for the genutil module.

                                      func (AppModuleBasic) Name

                                      func (AppModuleBasic) Name() string

                                        Name returns the genutil module's name.

                                        func (AppModuleBasic) RegisterCodec

                                        func (AppModuleBasic) RegisterCodec(cdc *codec.Codec)

                                          RegisterCodec registers the genutil module's types for the given codec.

                                          func (AppModuleBasic) RegisterRESTRoutes

                                          func (AppModuleBasic) RegisterRESTRoutes(_ context.CLIContext, _ *mux.Router)

                                            RegisterRESTRoutes registers the REST routes for the genutil module.

                                            func (AppModuleBasic) ValidateGenesis

                                            func (AppModuleBasic) ValidateGenesis(bz json.RawMessage) error

                                              ValidateGenesis performs genesis state validation for the genutil module.

                                              type GenesisState

                                              type GenesisState = types.GenesisState

                                              type InitConfig

                                              type InitConfig = types.InitConfig

                                              type MigrationCallback

                                              type MigrationCallback = types.MigrationCallback

                                              type MigrationMap

                                              type MigrationMap = types.MigrationMap

                                              Directories

                                              Path Synopsis
                                              client
                                              cli
                                              legacy