govgen

Documentation

Index

• Variables
• func MakeTestEncodingConfig() params.EncodingConfig
• func RegisterSwaggerAPI(rtr *mux.Router)
• type EmptyAppOptions
  • func (ao EmptyAppOptions) Get(_ string) interface{}
• type GenesisState
  • func NewDefaultGenesisState() GenesisState
• type GovGenApp
  • func NewGovGenApp(logger log.Logger, db dbm.DB, traceStore io.Writer, loadLatest bool, ...) *GovGenApp
  • func (app *GovGenApp) AppCodec() codec.Codec
  • func (app *GovGenApp) BeginBlocker(ctx sdk.Context, req abci.RequestBeginBlock) abci.ResponseBeginBlock
  • func (app *GovGenApp) BlockedModuleAccountAddrs(modAccAddrs map[string]bool) map[string]bool
  • func (app *GovGenApp) EndBlocker(ctx sdk.Context, req abci.RequestEndBlock) abci.ResponseEndBlock
  • func (app *GovGenApp) ExportAppStateAndValidators(forZeroHeight bool, jailAllowedAddrs []string) (servertypes.ExportedApp, error)
  • func (app *GovGenApp) GetBaseApp() *baseapp.BaseApp
  • func (app *GovGenApp) GetTxConfig() client.TxConfig
  • func (app *GovGenApp) InitChainer(ctx sdk.Context, req abci.RequestInitChain) abci.ResponseInitChain
  • func (app *GovGenApp) InterfaceRegistry() types.InterfaceRegistry
  • func (app *GovGenApp) LegacyAmino() *codec.LegacyAmino
  • func (app *GovGenApp) LoadHeight(height int64) error
  • func (app *GovGenApp) ModuleAccountAddrs() map[string]bool
  • func (app *GovGenApp) Name() string
  • func (app *GovGenApp) OnTxFailed(_ sdk.Context, _, _ string, _ []byte, _ []byte)
  • func (app *GovGenApp) OnTxSucceeded(_ sdk.Context, _, _ string, _ []byte, _ []byte)
  • func (app *GovGenApp) RegisterAPIRoutes(apiSvr *api.Server, apiConfig config.APIConfig)
  • func (app *GovGenApp) RegisterNodeService(clientCtx client.Context)
  • func (app *GovGenApp) RegisterTendermintService(clientCtx client.Context)
  • func (app *GovGenApp) RegisterTxService(clientCtx client.Context)
  • func (app *GovGenApp) SimulationManager() *module.SimulationManager
• type SimGenesisAccount
  • func (sga SimGenesisAccount) Validate() error

Variables

var (
	// DefaultNodeHome default home directories for the application daemon
	DefaultNodeHome string

	Upgrades = []upgrades.Upgrade{}
)

var ModuleBasics = module.NewBasicManager(
	auth.AppModuleBasic{},
	genutil.AppModuleBasic{},
	bank.AppModuleBasic{},
	capability.AppModuleBasic{},
	staking.AppModuleBasic{},
	mint.AppModuleBasic{},
	distr.AppModuleBasic{},
	gov.NewAppModuleBasic(
		paramsChangeProposalHandler,
		upgradeProposalHandler,
		cancelUpgradeProposalHandler,
	),
	params.AppModuleBasic{},
	crisis.AppModuleBasic{},
	slashing.AppModuleBasic{},
	feegrantmodule.AppModuleBasic{},
	authzmodule.AppModuleBasic{},
	upgrade.AppModuleBasic{},
	evidence.AppModuleBasic{},
	vesting.AppModuleBasic{},
)

ModuleBasics defines the module BasicManager is in charge of setting up basic, non-dependant module elements, such as codec registration and genesis verification.

Functions

func MakeTestEncodingConfig

func MakeTestEncodingConfig() params.EncodingConfig

MakeTestEncodingConfig creates an EncodingConfig for testing. This function should be used only in tests or when creating a new app instance (NewApp*()). App user shouldn't create new codecs - use the app.AppCodec instead. [DEPRECATED]

func RegisterSwaggerAPI

func RegisterSwaggerAPI(rtr *mux.Router)

RegisterSwaggerAPI registers swagger route with API Server

Types

type EmptyAppOptions

type EmptyAppOptions struct{}

EmptyAppOptions is a stub implementing AppOptions

func (EmptyAppOptions) Get

func (ao EmptyAppOptions) Get(_ string) interface{}

Get implements AppOptions

type GenesisState

type GenesisState map[string]json.RawMessage

The genesis state of the blockchain is represented here as a map of raw json messages key'd by a identifier string. The identifier is used to determine which module genesis information belongs to so it may be appropriately routed during init chain. Within this application default genesis information is retrieved from the ModuleBasicManager which populates json from each BasicModule object provided to it during init.

func NewDefaultGenesisState

func NewDefaultGenesisState() GenesisState

NewDefaultGenesisState generates the default state for the application.

type GovGenApp

type GovGenApp struct {
	*baseapp.BaseApp
	keepers.AppKeepers
	// contains filtered or unexported fields
}

GovGenApp extends an ABCI application, but with most of its parameters exported. They are exported for convenience in creating helper functions, as object capabilities aren't needed for testing.

func NewGovGenApp

func NewGovGenApp(
	logger log.Logger,
	db dbm.DB, traceStore io.Writer,
	loadLatest bool,
	skipUpgradeHeights map[int64]bool,
	homePath string,
	invCheckPeriod uint,
	encodingConfig govgenappparams.EncodingConfig,
	appOpts servertypes.AppOptions,
	baseAppOptions ...func(*baseapp.BaseApp),
) *GovGenApp

NewGovGenApp returns a reference to an initialized GovGen.

func (*GovGenApp) AppCodec

func (app *GovGenApp) AppCodec() codec.Codec

AppCodec returns GovGen's app codec.

NOTE: This is solely to be used for testing purposes as it may be desirable for modules to register their own custom testing types.

func (*GovGenApp) BeginBlocker

func (app *GovGenApp) BeginBlocker(ctx sdk.Context, req abci.RequestBeginBlock) abci.ResponseBeginBlock

BeginBlocker application updates every begin block

func (*GovGenApp) BlockedModuleAccountAddrs

func (app *GovGenApp) BlockedModuleAccountAddrs(modAccAddrs map[string]bool) map[string]bool

BlockedModuleAccountAddrs returns all the app's blocked module account addresses.

func (*GovGenApp) EndBlocker

func (app *GovGenApp) EndBlocker(ctx sdk.Context, req abci.RequestEndBlock) abci.ResponseEndBlock

EndBlocker application updates every end block

func (*GovGenApp) ExportAppStateAndValidators

func (app *GovGenApp) ExportAppStateAndValidators(
	forZeroHeight bool, jailAllowedAddrs []string,
) (servertypes.ExportedApp, error)

ExportAppStateAndValidators exports the state of the application for a genesis file.

func (*GovGenApp) GetBaseApp

func (app *GovGenApp) GetBaseApp() *baseapp.BaseApp

GetBaseApp implements the TestingApp interface.

func (*GovGenApp) GetTxConfig

func (app *GovGenApp) GetTxConfig() client.TxConfig

GetTxConfig implements the TestingApp interface.

func (*GovGenApp) InitChainer

func (app *GovGenApp) InitChainer(ctx sdk.Context, req abci.RequestInitChain) abci.ResponseInitChain

InitChainer application update at chain initialization

func (*GovGenApp) InterfaceRegistry

func (app *GovGenApp) InterfaceRegistry() types.InterfaceRegistry

InterfaceRegistry returns GovGen's InterfaceRegistry

func (*GovGenApp) LegacyAmino

func (app *GovGenApp) LegacyAmino() *codec.LegacyAmino

LegacyAmino returns GovGenApp's amino codec.

NOTE: This is solely to be used for testing purposes as it may be desirable for modules to register their own custom testing types.

func (*GovGenApp) LoadHeight

func (app *GovGenApp) LoadHeight(height int64) error

LoadHeight loads a particular height

func (*GovGenApp) ModuleAccountAddrs

func (app *GovGenApp) ModuleAccountAddrs() map[string]bool

ModuleAccountAddrs returns all the app's module account addresses.

func (*GovGenApp) Name

func (app *GovGenApp) Name() string

Name returns the name of the App

func (*GovGenApp) OnTxFailed

func (app *GovGenApp) OnTxFailed(_ sdk.Context, _, _ string, _ []byte, _ []byte)

func (*GovGenApp) OnTxSucceeded

func (app *GovGenApp) OnTxSucceeded(_ sdk.Context, _, _ string, _ []byte, _ []byte)

func (*GovGenApp) RegisterAPIRoutes

func (app *GovGenApp) RegisterAPIRoutes(apiSvr *api.Server, apiConfig config.APIConfig)

RegisterAPIRoutes registers all application module routes with the provided API server.

func (*GovGenApp) RegisterNodeService

func (app *GovGenApp) RegisterNodeService(clientCtx client.Context)

RegisterTxService allows query minimum-gas-prices in app.toml

func (*GovGenApp) RegisterTendermintService

func (app *GovGenApp) RegisterTendermintService(clientCtx client.Context)

RegisterTendermintService implements the Application.RegisterTendermintService method.

func (*GovGenApp) RegisterTxService

func (app *GovGenApp) RegisterTxService(clientCtx client.Context)

RegisterTxService implements the Application.RegisterTxService method.

func (*GovGenApp) SimulationManager

func (app *GovGenApp) SimulationManager() *module.SimulationManager

SimulationManager implements the SimulationApp interface

type SimGenesisAccount

type SimGenesisAccount struct {
	*authtypes.BaseAccount

	// vesting account fields
	OriginalVesting  sdk.Coins `json:"original_vesting" yaml:"original_vesting"`   // total vesting coins upon initialization
	DelegatedFree    sdk.Coins `json:"delegated_free" yaml:"delegated_free"`       // delegated vested coins at time of delegation
	DelegatedVesting sdk.Coins `json:"delegated_vesting" yaml:"delegated_vesting"` // delegated vesting coins at time of delegation
	StartTime        int64     `json:"start_time" yaml:"start_time"`               // vesting start time (UNIX Epoch time)
	EndTime          int64     `json:"end_time" yaml:"end_time"`                   // vesting end time (UNIX Epoch time)

	// module account fields
	ModuleName        string   `json:"module_name" yaml:"module_name"`               // name of the module account
	ModulePermissions []string `json:"module_permissions" yaml:"module_permissions"` // permissions of module account
}

SimGenesisAccount defines a type that implements the GenesisAccount interface to be used for simulation accounts in the genesis state.

func (SimGenesisAccount) Validate

func (sga SimGenesisAccount) Validate() error

Validate checks for errors on the vesting and module account parameters