cosmos-sdk: Index | Files | Directories

package simapp

import ""


Package Files

app.go config.go encoding.go export.go genesis.go genesis_account.go state.go test_helpers.go types.go utils.go


var (
    // DefaultNodeHome default home directories for the application daemon
    DefaultNodeHome = os.ExpandEnv("$HOME/.simapp")

    // ModuleBasics defines the module BasicManager is in charge of setting up basic,
    // non-dependant module elements, such as codec registration
    // and genesis verification.
    ModuleBasics = module.NewBasicManager(
            paramsclient.ProposalHandler, distrclient.ProposalHandler, upgradeclient.ProposalHandler, upgradeclient.CancelProposalHandler,
var (
    FlagGenesisFileValue        string
    FlagParamsFileValue         string
    FlagExportParamsPathValue   string
    FlagExportParamsHeightValue int
    FlagExportStatePathValue    string
    FlagExportStatsPathValue    string
    FlagSeedValue               int64
    FlagInitialBlockHeightValue int
    FlagNumBlocksValue          int
    FlagBlockSizeValue          int
    FlagLeanValue               bool
    FlagCommitValue             bool
    FlagOnOperationValue        bool // TODO: Remove in favor of binary search for invariant violation
    FlagAllInvariantsValue      bool

    FlagEnabledValue     bool
    FlagVerboseValue     bool
    FlagPeriodValue      uint
    FlagGenesisTimeValue int64

List of available flags for the simulator

var DefaultConsensusParams = &abci.ConsensusParams{
    Block: &abci.BlockParams{
        MaxBytes: 200000,
        MaxGas:   2000000,
    Evidence: &abci.EvidenceParams{
        MaxAgeNumBlocks: 302400,
        MaxAgeDuration:  1814400,
    Validator: &abci.ValidatorParams{
        PubKeyTypes: []string{

DefaultConsensusParams defines the default Tendermint consensus params used in SimApp testing.

func AddTestAddrs Uses

func AddTestAddrs(app *SimApp, ctx sdk.Context, accNum int, accAmt sdk.Int) []sdk.AccAddress

AddTestAddrs constructs and returns accNum amount of accounts with an initial balance of accAmt in random order

func AddTestAddrsFromPubKeys Uses

func AddTestAddrsFromPubKeys(app *SimApp, ctx sdk.Context, pubKeys []crypto.PubKey, accAmt sdk.Int)

AddTestAddrsFromPubKeys adds the addresses into the SimApp providing only the public keys.

func AddTestAddrsIncremental Uses

func AddTestAddrsIncremental(app *SimApp, ctx sdk.Context, accNum int, accAmt sdk.Int) []sdk.AccAddress

AddTestAddrs constructs and returns accNum amount of accounts with an initial balance of accAmt in random order

func AppStateFn Uses

func AppStateFn(cdc *codec.Codec, simManager *module.SimulationManager) simtypes.AppStateFn

AppStateFn returns the initial application state using a genesis or the simulation parameters. It panics if the user provides files for both of them. If a file is not given for the genesis or the sim params, it creates a randomized one.

func AppStateFromGenesisFileFn Uses

func AppStateFromGenesisFileFn(r io.Reader, cdc *codec.Codec, genesisFile string) (tmtypes.GenesisDoc, []simtypes.Account)

AppStateFromGenesisFileFn util function to generate the genesis AppState from a genesis.json file.

func AppStateRandomizedFn Uses

func AppStateRandomizedFn(
    simManager *module.SimulationManager, r *rand.Rand, cdc *codec.Codec,
    accs []simtypes.Account, genesisTimestamp time.Time, appParams simtypes.AppParams,
) (json.RawMessage, []simtypes.Account)

AppStateRandomizedFn creates calls each module's GenesisState generator function and creates the simulation params

func CheckBalance Uses

func CheckBalance(t *testing.T, app *SimApp, addr sdk.AccAddress, balances sdk.Coins)

CheckBalance checks the balance of an account.

func CheckExportSimulation Uses

func CheckExportSimulation(
    app App, config simtypes.Config, params simtypes.Params,
) error

CheckExportSimulation exports the app state and simulation parameters to JSON if the export paths are defined.

func ConvertAddrsToValAddrs Uses

func ConvertAddrsToValAddrs(addrs []sdk.AccAddress) []sdk.ValAddress

ConvertAddrsToValAddrs converts the provided addresses to ValAddress.

func CreateTestPubKeys Uses

func CreateTestPubKeys(numPubKeys int) []crypto.PubKey

CreateTestPubKeys returns a total of numPubKeys public keys in ascending order.

func GenSequenceOfTxs Uses

func GenSequenceOfTxs(txGen client.TxConfig, msgs []sdk.Msg, accNums []uint64, initSeqNums []uint64, numToGenerate int, priv ...crypto.PrivKey) ([]sdk.Tx, error)

GenSequenceOfTxs generates a set of signed transactions of messages, such that they differ only by having the sequence numbers incremented between every transaction.

func GetMaccPerms Uses

func GetMaccPerms() map[string][]string

GetMaccPerms returns a copy of the module account permissions

func GetSimulationLog Uses

func GetSimulationLog(storeName string, sdr sdk.StoreDecoderRegistry, kvAs, kvBs []kv.Pair) (log string)

GetSimulationLog unmarshals the KVPair's Value to the corresponding type based on the each's module store key and the prefix bytes of the KVPair's key.

func GetSimulatorFlags Uses

func GetSimulatorFlags()

GetSimulatorFlags gets the values of all the available simulation flags

func MakeCodecs Uses

func MakeCodecs() (codec.Marshaler, *codec.Codec)

MakeCodecs constructs the *std.Codec and *codec.Codec instances used by simapp. It is useful for tests and clients who do not want to construct the full simapp

func MakeEncodingConfig Uses

func MakeEncodingConfig() params.EncodingConfig

MakeEncodingConfig creates an EncodingConfig for testing

func NewConfigFromFlags Uses

func NewConfigFromFlags() simulation.Config

NewConfigFromFlags creates a simulation from the retrieved values of the flags.

func NewPubKeyFromHex Uses

func NewPubKeyFromHex(pk string) (res crypto.PubKey)

NewPubKeyFromHex returns a PubKey from a hex string.

func PrintStats Uses

func PrintStats(db dbm.DB)

PrintStats prints the corresponding statistics from the app DB.

func SetupSimulation Uses

func SetupSimulation(dirPrefix, dbName string) (simtypes.Config, dbm.DB, string, log.Logger, bool, error)

SetupSimulation creates the config, db (levelDB), temporary directory and logger for the simulation tests. If `FlagEnabledValue` is false it skips the current test. Returns error on an invalid db intantiation or temp dir creation.

func SignCheckDeliver Uses

func SignCheckDeliver(
    t *testing.T, txGen client.TxConfig, app *bam.BaseApp, header abci.Header, msgs []sdk.Msg,
    accNums, seq []uint64, expSimPass, expPass bool, priv ...crypto.PrivKey,
) (sdk.GasInfo, *sdk.Result, error)

SignCheckDeliver checks a generated signed transaction and simulates a block commitment with the given transaction. A test assertion is made using the parameter 'expPass' against the result. A corresponding result is returned.

func SimulationOperations Uses

func SimulationOperations(app App, cdc *codec.Codec, config simtypes.Config) []simtypes.WeightedOperation

SimulationOperations retrieves the simulation params from the provided file path and returns all the modules weighted operations

func TestAddr Uses

func TestAddr(addr string, bech string) (sdk.AccAddress, error)

type App Uses

type App interface {
    // The assigned name of the app.
    Name() string

    // The application types codec.
    // NOTE: This shoult be sealed before being returned.
    Codec() *codec.Codec

    // Application updates every begin block.
    BeginBlocker(ctx sdk.Context, req abci.RequestBeginBlock) abci.ResponseBeginBlock

    // Application updates every end block.
    EndBlocker(ctx sdk.Context, req abci.RequestEndBlock) abci.ResponseEndBlock

    // Application update at chain (i.e app) initialization.
    InitChainer(ctx sdk.Context, req abci.RequestInitChain) abci.ResponseInitChain

    // Loads the app at a given height.
    LoadHeight(height int64) error

    // Exports the state of the application for a genesis file.
        forZeroHeight bool, jailWhiteList []string,
    ) (json.RawMessage, []tmtypes.GenesisValidator, *abci.ConsensusParams, error)

    // All the registered module account addreses.
    ModuleAccountAddrs() map[string]bool

    // Helper for the simulation framework.
    SimulationManager() *module.SimulationManager

App implements the common methods for a Cosmos SDK-based application specific blockchain.

type GenerateAccountStrategy Uses

type GenerateAccountStrategy func(int) []sdk.AccAddress

type GenesisState Uses

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 Uses

func NewDefaultGenesisState() GenesisState

NewDefaultGenesisState generates the default state for the application.

type SimApp Uses

type SimApp struct {

    // keepers
    AccountKeeper    authkeeper.AccountKeeper
    BankKeeper       bankkeeper.Keeper
    CapabilityKeeper *capabilitykeeper.Keeper
    StakingKeeper    stakingkeeper.Keeper
    SlashingKeeper   slashingkeeper.Keeper
    MintKeeper       mintkeeper.Keeper
    DistrKeeper      distrkeeper.Keeper
    GovKeeper        govkeeper.Keeper
    CrisisKeeper     crisiskeeper.Keeper
    UpgradeKeeper    upgradekeeper.Keeper
    ParamsKeeper     paramskeeper.Keeper
    IBCKeeper        *ibckeeper.Keeper // IBC Keeper must be a pointer in the app, so we can SetRouter on it correctly
    EvidenceKeeper   evidencekeeper.Keeper
    TransferKeeper   ibctransferkeeper.Keeper

    // make scoped keepers public for test purposes
    ScopedIBCKeeper      capabilitykeeper.ScopedKeeper
    ScopedTransferKeeper capabilitykeeper.ScopedKeeper
    // contains filtered or unexported fields

SimApp 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 NewSimApp Uses

func NewSimApp(
    logger log.Logger, db dbm.DB, traceStore io.Writer, loadLatest bool, skipUpgradeHeights map[int64]bool,
    homePath string, invCheckPeriod uint, baseAppOptions ...func(*baseapp.BaseApp),
) *SimApp

NewSimApp returns a reference to an initialized SimApp.

func Setup Uses

func Setup(isCheckTx bool) *SimApp

Setup initializes a new SimApp. A Nop logger is set in SimApp.

func SetupWithGenesisAccounts Uses

func SetupWithGenesisAccounts(genAccs []authtypes.GenesisAccount, balances ...banktypes.Balance) *SimApp

SetupWithGenesisAccounts initializes a new SimApp with the provided genesis accounts and possible balances.

func SetupWithGenesisValSet Uses

func SetupWithGenesisValSet(t *testing.T, valSet *tmtypes.ValidatorSet, genAccs []authtypes.GenesisAccount, balances ...banktypes.Balance) *SimApp

SetupWithGenesisValSet initializes a new SimApp with a validator set and genesis accounts that also act as delegators. For simplicity, each validator is bonded with a delegation of one consensus engine unit (10^6) in the default token of the simapp from first genesis account. A Nop logger is set in SimApp.

func (*SimApp) AppCodec Uses

func (app *SimApp) AppCodec() codec.Marshaler

AppCodec returns SimApp'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 (*SimApp) BeginBlocker Uses

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

BeginBlocker application updates every begin block

func (*SimApp) BlockedAddrs Uses

func (app *SimApp) BlockedAddrs() map[string]bool

BlockedAddrs returns all the app's module account addresses that are not allowed to receive external tokens.

func (*SimApp) Codec Uses

func (app *SimApp) Codec() *codec.Codec

Codec returns SimApp's 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 (*SimApp) EndBlocker Uses

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

EndBlocker application updates every end block

func (*SimApp) ExportAppStateAndValidators Uses

func (app *SimApp) ExportAppStateAndValidators(
    forZeroHeight bool, jailWhiteList []string,
) (appState json.RawMessage, validators []tmtypes.GenesisValidator, cp *abci.ConsensusParams, err error)

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

func (*SimApp) GetKey Uses

func (app *SimApp) GetKey(storeKey string) *sdk.KVStoreKey

GetKey returns the KVStoreKey for the provided store key.

NOTE: This is solely to be used for testing purposes.

func (*SimApp) GetMemKey Uses

func (app *SimApp) GetMemKey(storeKey string) *sdk.MemoryStoreKey

GetMemKey returns the MemStoreKey for the provided mem key.

NOTE: This is solely used for testing purposes.

func (*SimApp) GetSubspace Uses

func (app *SimApp) GetSubspace(moduleName string) paramstypes.Subspace

GetSubspace returns a param subspace for a given module name.

NOTE: This is solely to be used for testing purposes.

func (*SimApp) GetTKey Uses

func (app *SimApp) GetTKey(storeKey string) *sdk.TransientStoreKey

GetTKey returns the TransientStoreKey for the provided store key.

NOTE: This is solely to be used for testing purposes.

func (*SimApp) InitChainer Uses

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

InitChainer application update at chain initialization

func (*SimApp) InterfaceRegistry Uses

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

InterfaceRegistry returns SimApp's InterfaceRegistry

func (*SimApp) LoadHeight Uses

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

LoadHeight loads a particular height

func (*SimApp) ModuleAccountAddrs Uses

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

ModuleAccountAddrs returns all the app's module account addresses.

func (*SimApp) Name Uses

func (app *SimApp) Name() string

Name returns the name of the App

func (*SimApp) RegisterAPIRoutes Uses

func (app *SimApp) RegisterAPIRoutes(apiSvr *api.Server)

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

func (*SimApp) SimulationManager Uses

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

SimulationManager implements the SimulationApp interface

type SimGenesisAccount Uses

type SimGenesisAccount struct {

    // 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 Uses

func (sga SimGenesisAccount) Validate() error

Validate checks for errors on the vesting and module account parameters


paramsPackage params defines the simulation parameters in the simapp.

Package simapp imports 92 packages (graph) and is imported by 22 packages. Updated 2020-08-05. Refresh now. Tools for package owners.