simapp

package module
v0.0.0-...-e8d56d6 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 21, 2024 License: Apache-2.0 Imports: 107 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	StakePerAccount           = "stake_per_account"
	InitiallyBondedValidators = "initially_bonded_validators"
)

Simulation parameter constants

Variables

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

	// 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(
		auth.AppModuleBasic{},
		genutil.NewAppModuleBasic(genutiltypes.DefaultMessageValidator),
		bank.AppModuleBasic{},
		capability.AppModuleBasic{},
		staking.AppModuleBasic{},
		mint.AppModuleBasic{},
		distr.AppModuleBasic{},
		gov.NewAppModuleBasic(
			[]govclient.ProposalHandler{
				paramsclient.ProposalHandler,
				upgradeclient.LegacyProposalHandler,
				upgradeclient.LegacyCancelProposalHandler,
			},
		),
		params.AppModuleBasic{},
		crisis.AppModuleBasic{},
		slashing.AppModuleBasic{},
		feegrantmodule.AppModuleBasic{},
		upgrade.AppModuleBasic{},
		evidence.AppModuleBasic{},
		authzmodule.AppModuleBasic{},
		groupmodule.AppModuleBasic{},
		vesting.AppModuleBasic{},
		consensus.AppModuleBasic{},
	)
)

Functions

func AddTestAddrs 

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 

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

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

func AddTestAddrsIncremental 

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

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

func AppStateFn 

func AppStateFn(cdc codec.JSONCodec, 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 

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

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

func AppStateRandomizedFn 

func AppStateRandomizedFn(
	simManager *module.SimulationManager, r *rand.Rand, cdc codec.JSONCodec,
	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 

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

CheckBalance checks the balance of an account.

func ConvertAddrsToValAddrs 

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

ConvertAddrsToValAddrs converts the provided addresses to ValAddress.

func CreateTestAddrs 

func CreateTestAddrs(numAddrs int) []sdk.AccAddress

CreateTestAddrs creates test addresses

func CreateTestPubKeys 

func CreateTestPubKeys(numPubKeys int) []cryptotypes.PubKey

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

func FundAccount 

func FundAccount(
	bankKeeper bankkeeper.Keeper,
	ctx sdk.Context,
	addr sdk.AccAddress,
	amounts sdk.Coins,
) error

FundAccount is a utility function that funds an account by minting and sending the coins to the address. This should be used for testing purposes only!

TODO: Instead of using the mint module account, which has the permission of minting, create a "faucet" account. (@fdymylja)

func FundModuleAccount 

func FundModuleAccount(
	bankKeeper bankkeeper.Keeper,
	ctx sdk.Context,
	recipientMod string,
	amounts sdk.Coins,
) error

FundModuleAccount is a utility function that funds a module account by minting and sending the coins to the address. This should be used for testing purposes only!

TODO: Instead of using the mint module account, which has the permission of minting, create a "faucet" account. (@fdymylja)

func GenSequenceOfTxs 

func GenSequenceOfTxs(
	txGen client.TxConfig,
	msgs []sdk.Msg,
	accNums []uint64,
	initSeqNums []uint64,
	numToGenerate int,
	priv ...cryptotypes.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 NewConfig 

func NewConfig(depInjectOptions DepinjectOptions) network.Config

func NewPubKeyFromHex 

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

NewPubKeyFromHex returns a PubKey from a hex string.

func NewTestNetworkFixture 

func NewTestNetworkFixture(depInjectOptions DepinjectOptions) network.TestFixture

NewTestNetworkFixture returns a new simapp AppConstructor for network simulation tests

func QueryAccountExec 

func QueryAccountExec(
	t *testing.T,
	network Network,
	clientCtx client.Context,
	address string,
	extraArgs ...string,
) authtypes.AccountI

func QueryBalanceExec 

func QueryBalanceExec(
	t *testing.T,
	network Network,
	clientCtx client.Context,
	address string,
	denom string,
	extraArgs ...string,
) *sdk.Coin

func QueryBalancesExec 

func QueryBalancesExec(
	t *testing.T,
	network Network,
	clientCtx client.Context,
	address string,
	extraArgs ...string,
) sdk.Coins

func QueryTx 

func QueryTx(t *testing.T, clientCtx client.Context, txHash string) abci.ResponseDeliverTx

func QueryTxWithHeight 

func QueryTxWithHeight(
	t *testing.T,
	clientCtx client.Context,
	txHash string,
) (abci.ResponseDeliverTx, int64)

func SignCheckDeliver 

func SignCheckDeliver(
	t *testing.T,
	txCfg client.TxConfig,
	app *bam.BaseApp,
	header tmproto.Header,
	msgs []sdk.Msg,
	chainID string,
	accNums, accSeqs []uint64,
	expSimPass, expPass bool,
	priv ...cryptotypes.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 TestAddr 

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

Types

type DepinjectOptions 

type DepinjectOptions struct {
	Config    depinject.Config
	Providers []interface{}
	Consumers []interface{}
}

DepinjectOptions are passed to the app on creation

type EmptyAppOptions 

type EmptyAppOptions struct{}

EmptyAppOptions is a stub implementing AppOptions

func (EmptyAppOptions) Get 

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

Get implements AppOptions

type EncodingConfig 

type EncodingConfig struct {
	InterfaceRegistry types.InterfaceRegistry
	Codec             codec.Codec
	TxConfig          client.TxConfig
	Amino             *codec.LegacyAmino
}

EncodingConfig specifies the concrete encoding types to use for a given app. This is provided for compatibility between protobuf and amino implementations.

func MakeTestEncodingConfig 

func MakeTestEncodingConfig() 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]

type GenerateAccountStrategy 

type GenerateAccountStrategy func(int) []sdk.AccAddress

type GenesisState 

type GenesisState map[string]json.RawMessage

GenesisState 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(cdc codec.JSONCodec) GenesisState

NewDefaultGenesisState generates the default state for the application.

type Network 

type Network struct {
	*network.Network
	network.Config
}

func SetupNetwork 

func SetupNetwork(t *testing.T, depInjectOptions DepinjectOptions) Network

func SetupNetworkWithConfig 

func SetupNetworkWithConfig(t *testing.T, cfg network.Config) Network

func (Network) BlockSendMsgs 

func (n Network) BlockSendMsgs(t *testing.T,
	msgs ...sdk.Msg,
) *ResponseTx

func (Network) ExecQueryCmd 

func (n Network) ExecQueryCmd(t *testing.T,
	clientCtx client.Context,
	cmd *cobra.Command,
	extraArgs []string,
	resp proto.Message,
)

func (Network) ExecTxCmdWithResult 

func (n Network) ExecTxCmdWithResult(t *testing.T,
	clientCtx client.Context,
	cmd *cobra.Command,
	extraArgs []string,
) *ResponseTx

func (Network) GetAttribute 

func (n Network) GetAttribute(typ, key string, events []abci.Event) string

func (Network) QueryTx 

func (n Network) QueryTx(t *testing.T,
	clientCtx client.Context,
	txHash string,
) *ResponseTx

func (Network) SendMsgs 

func (n Network) SendMsgs(
	t *testing.T,
	msgs ...sdk.Msg,
) *sdk.TxResponse

func (Network) WaitForNBlock 

func (n Network) WaitForNBlock(wait int64) error

type ResponseTx 

type ResponseTx struct {
	abci.ResponseDeliverTx
	Height int64
}

func MsgSendExec 

func MsgSendExec(
	t *testing.T,
	network Network,
	clientCtx client.Context,
	from, to, amount fmt.Stringer,
	extraArgs ...string,
) *ResponseTx

type SetupOptions 

type SetupOptions struct {
	Logger  log.Logger
	DB      *dbm.MemDB
	AppOpts servertypes.AppOptions
}

SetupOptions defines arguments that are passed into `Simapp` constructor.

type SimApp 

type SimApp struct {
	*runtime.App

	// 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
	AuthzKeeper           authzkeeper.Keeper
	EvidenceKeeper        evidencekeeper.Keeper
	FeeGrantKeeper        feegrantkeeper.Keeper
	ConsensusParamsKeeper consensusparamkeeper.Keeper
	// 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 

func NewSimApp(
	logger log.Logger,
	db dbm.DB,
	traceStore io.Writer,
	loadLatest bool,
	depInjectOptions DepinjectOptions,
	appOpts servertypes.AppOptions,
	baseAppOptions ...func(*baseapp.BaseApp),
) *SimApp

NewSimApp returns a reference to an initialized SimApp.

func Setup 

func Setup(t *testing.T, isCheckTx bool, depInjectOptions DepinjectOptions) *SimApp

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

func SetupWithGenesisAccounts 

func SetupWithGenesisAccounts(
	t *testing.T,
	depInjectOptions DepinjectOptions,
	genAccs []authtypes.GenesisAccount,
	balances ...banktypes.Balance,
) *SimApp

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

func SetupWithGenesisStateFn 

func SetupWithGenesisStateFn(
	t *testing.T,
	depInjectOptions DepinjectOptions,
	merge func(cdc codec.Codec, state GenesisState) GenesisState,
) *SimApp

func SetupWithGenesisValSet 

func SetupWithGenesisValSet(
	t *testing.T,
	depInjectOptions DepinjectOptions,
	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 

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

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) ExportAppStateAndValidators 

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

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

func (*SimApp) GetKey 

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

GetKey returns the KVStoreKey for the provided store key.

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

func (*SimApp) GetSubspace 

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) InitChainer 

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

InitChainer application update at chain initialization

func (*SimApp) InterfaceRegistry 

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

InterfaceRegistry returns SimApp's InterfaceRegistry

func (*SimApp) LegacyAmino 

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

LegacyAmino returns SimApp'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 (*SimApp) Name 

func (app *SimApp) Name() string

Name returns the name of the App

func (*SimApp) RegisterAPIRoutes 

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

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

func (*SimApp) SimulationManager 

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

SimulationManager implements the SimulationApp interface.

func (*SimApp) TxConfig 

func (app *SimApp) TxConfig() client.TxConfig

TxConfig returns SimApp's TxConfig

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.