genaccounts

Documentation

Overview

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

Package genaccounts contains specialized functionality for initializing accounts from genesis including:

• genesis account validation,
• initchain processing of genesis accounts,
• export processing (to genesis) of accounts,
• server command for adding accounts to the genesis file.

Index

• Constants
• Variables
• func InitGenesis(ctx sdk.Context, _ *codec.Codec, accountKeeper types.AccountKeeper, ...)
• func NewAppModule(accountKeeper types.AccountKeeper) module.AppModule
• type AppModule
  • func (am AppModule) ExportGenesis(ctx sdk.Context) json.RawMessage
  • func (am AppModule) InitGenesis(ctx sdk.Context, data json.RawMessage) []abci.ValidatorUpdate
• type AppModuleBasic
  • func (AppModuleBasic) DefaultGenesis() json.RawMessage
  • func (AppModuleBasic) GetQueryCmd(_ *codec.Codec) *cobra.Command
  • func (AppModuleBasic) GetTxCmd(_ *codec.Codec) *cobra.Command
  • func (AppModuleBasic) IterateGenesisAccounts(cdc *codec.Codec, appGenesis map[string]json.RawMessage, ...)
  • func (AppModuleBasic) Name() string
  • func (AppModuleBasic) RegisterCodec(cdc *codec.Codec)
  • func (AppModuleBasic) RegisterRESTRoutes(_ context.CLIContext, _ *mux.Router)
  • func (AppModuleBasic) ValidateGenesis(bz json.RawMessage) error
• type GenesisAccount
• type GenesisAccounts
• type GenesisState
  • func ExportGenesis(ctx sdk.Context, accountKeeper types.AccountKeeper) GenesisState

Constants

const (
	ModuleName = types.ModuleName
)

Variables

var (
	// functions aliases
	NewGenesisAccountRaw        = types.NewGenesisAccountRaw
	NewGenesisAccount           = types.NewGenesisAccount
	NewGenesisAccountI          = types.NewGenesisAccountI
	GetGenesisStateFromAppState = types.GetGenesisStateFromAppState
	SetGenesisStateInAppState   = types.SetGenesisStateInAppState
	ValidateGenesis             = types.ValidateGenesis

	// variable aliases
	ModuleCdc = types.ModuleCdc
)

Functions

func InitGenesis

func InitGenesis(ctx sdk.Context, _ *codec.Codec, accountKeeper types.AccountKeeper, genesisState GenesisState)

InitGenesis initializes accounts and deliver genesis transactions

func NewAppModule

func NewAppModule(accountKeeper types.AccountKeeper) module.AppModule

NewAppModule creates a new AppModule object

Types

type AppModule

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

___________________________ app module

func (AppModule) ExportGenesis

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

module export genesis

func (AppModule) InitGenesis

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

module init-genesis

type AppModuleBasic

type AppModuleBasic struct{}

app module basics object

func (AppModuleBasic) DefaultGenesis

func (AppModuleBasic) DefaultGenesis() json.RawMessage

default genesis state

func (AppModuleBasic) GetQueryCmd

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

get the root query command of this module

func (AppModuleBasic) GetTxCmd

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

get the root tx command of this module

func (AppModuleBasic) IterateGenesisAccounts

func (AppModuleBasic) IterateGenesisAccounts(cdc *codec.Codec, appGenesis map[string]json.RawMessage,
	iterateFn func(exported.Account) (stop bool))

extra function from sdk.AppModuleBasic iterate the genesis accounts and perform an operation at each of them - to used by other modules

func (AppModuleBasic) Name

func (AppModuleBasic) Name() string

module name

func (AppModuleBasic) RegisterCodec

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

register module codec

func (AppModuleBasic) RegisterRESTRoutes

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

register rest routes

func (AppModuleBasic) ValidateGenesis

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

module validate genesis

type GenesisAccount

type GenesisAccount = types.GenesisAccount

type GenesisAccounts

type GenesisAccounts = types.GenesisAccounts

type GenesisState

type GenesisState = types.GenesisState

func ExportGenesis

func ExportGenesis(ctx sdk.Context, accountKeeper types.AccountKeeper) GenesisState

ExportGenesis exports genesis for all accounts