test: initialize simulation tests for custom zetachain modules

Makefile

@@ -404,7 +404,7 @@ test-sim-fullappsimulation:
 	$(call run-sim-test,"TestFullAppSimulation",TestFullAppSimulation,100,200,30m)
 
 test-sim-import-export:
-	$(call run-sim-test,"test-import-export",TestAppImportExport,100,200,30m)
+	$(call run-sim-test,"test-import-export",TestAppImportExport,50,100,30m)
 
 test-sim-after-import:
 	$(call run-sim-test,"test-sim-after-import",TestAppSimulationAfterImport,100,200,30m)

app/app.go

@@ -481,6 +481,8 @@ func New(
 		app.SlashingKeeper,
 		app.AuthorityKeeper,
 		app.LightclientKeeper,
+		app.BankKeeper,
+		app.AccountKeeper,
 		authtypes.NewModuleAddress(govtypes.ModuleName).String(),
 	)
 

app/modules.go

@@ -178,5 +178,8 @@ func simulationModules(
 		evm.NewAppModule(app.EvmKeeper, app.AccountKeeper, app.GetSubspace(evmtypes.ModuleName)),
 		authzmodule.NewAppModule(appCodec, app.AuthzKeeper, app.AccountKeeper, app.BankKeeper, app.interfaceRegistry),
 		groupmodule.NewAppModule(appCodec, app.GroupKeeper, app.AccountKeeper, app.BankKeeper, app.interfaceRegistry),
+		crosschainmodule.NewAppModule(appCodec, app.CrosschainKeeper),
+		observermodule.NewAppModule(appCodec, *app.ObserverKeeper),
+		fungiblemodule.NewAppModule(appCodec, app.FungibleKeeper),
 	}
 }

changelog.md

@@ -8,10 +8,7 @@
 
 ### Tests
 * [3075](https://github.com/zeta-chain/node/pull/3075) - ton: withdraw concurrent, deposit & revert.
-
-### Refactor
-
-### Tests
+* [3095](https://github.com/zeta-chain/node/pull/3095) - initialize simulation tests for custom zetachain modules
 
 ### Fixes
 * [3041](https://github.com/zeta-chain/node/pull/3041) - replace libp2p public DHT with private gossip peer discovery and connection gater for inbound connections

codecov.yml

@@ -52,7 +52,7 @@ ignore:
   - "x/**/events.go"
   - "x/**/migrator.go"
   - "x/**/module_simulation.go"
-  - "x/**/simulation/**/*"
+  - "x/**/simulation/*.go"
   - "**/*.proto"
   - "**/*.md"
   - "**/*.yml"

contrib/docker-scripts/start.sh

@@ -332,4 +332,4 @@ else
 
   logt "Start Network"
   start_network
-fi
+fi

server/start.go

@@ -175,7 +175,7 @@ which accepts a path for the resulting pprof file.
 	cmd.Flags().
 		String(server.FlagMinGasPrices, "", "Minimum gas prices to accept for transactions; Any fee in a tx must meet this minimum (e.g. 0.01photon;0.0001stake)")
 
-		//nolint:lll
+	//nolint:lll
 	cmd.Flags().
 		IntSlice(server.FlagUnsafeSkipUpgrades, []int{}, "Skip a set of upgrade heights to continue the old binary")
 	cmd.Flags().
@@ -192,7 +192,7 @@ which accepts a path for the resulting pprof file.
 	cmd.Flags().
 		Uint64(server.FlagPruningInterval, 0, "Height interval at which pruned heights are removed from disk (ignored if pruning is not 'custom')")
 
-		//nolint:lll
+	//nolint:lll
 	cmd.Flags().Uint(server.FlagInvCheckPeriod, 0, "Assert registered invariants every N blocks")
 	cmd.Flags().
 		Uint64(server.FlagMinRetainBlocks, 0, "Minimum block height offset during ABCI commit to prune Tendermint blocks")
@@ -220,11 +220,11 @@ which accepts a path for the resulting pprof file.
 	cmd.Flags().
 		Uint64(srvflags.JSONRPCGasCap, config.DefaultGasCap, "Sets a cap on gas that can be used in eth_call/estimateGas unit is aphoton (0=infinite)")
 
-		//nolint:lll
+	//nolint:lll
 	cmd.Flags().
 		Float64(srvflags.JSONRPCTxFeeCap, config.DefaultTxFeeCap, "Sets a cap on transaction fee that can be sent via the RPC APIs (1 = default 1 photon)")
 
-		//nolint:lll
+	//nolint:lll
 	cmd.Flags().
 		Int32(srvflags.JSONRPCFilterCap, config.DefaultFilterCap, "Sets the global cap for total number of filters that can be created")
 	cmd.Flags().
@@ -236,26 +236,26 @@ which accepts a path for the resulting pprof file.
 	cmd.Flags().
 		Bool(srvflags.JSONRPCAllowUnprotectedTxs, config.DefaultAllowUnprotectedTxs, "Allow for unprotected (non EIP155 signed) transactions to be submitted via the node's RPC when the global parameter is disabled")
 
-		//nolint:lll
+	//nolint:lll
 	cmd.Flags().
 		Int32(srvflags.JSONRPCLogsCap, config.DefaultLogsCap, "Sets the max number of results can be returned from single `eth_getLogs` query")
 	cmd.Flags().
 		Int32(srvflags.JSONRPCBlockRangeCap, config.DefaultBlockRangeCap, "Sets the max block range allowed for `eth_getLogs` query")
 	cmd.Flags().
 		Int(srvflags.JSONRPCMaxOpenConnections, config.DefaultMaxOpenConnections, "Sets the maximum number of simultaneous connections for the server listener")
 
-		//nolint:lll
+	//nolint:lll
 	cmd.Flags().Bool(srvflags.JSONRPCEnableIndexer, false, "Enable the custom tx indexer for json-rpc")
 	cmd.Flags().Bool(srvflags.JSONRPCEnableMetrics, false, "Define if EVM rpc metrics server should be enabled")
 
 	cmd.Flags().
 		String(srvflags.EVMTracer, config.DefaultEVMTracer, "the EVM tracer type to collect execution traces from the EVM transaction execution (json|struct|access_list|markdown)")
 
-		//nolint:lll
+	//nolint:lll
 	cmd.Flags().
 		Uint64(srvflags.EVMMaxTxGasWanted, config.DefaultMaxTxGasWanted, "the gas wanted for each eth tx returned in ante handler in check tx mode")
 
-		//nolint:lll
+	//nolint:lll
 
 	cmd.Flags().String(srvflags.TLSCertPath, "", "the cert.pem file path for the server TLS configuration")
 	cmd.Flags().String(srvflags.TLSKeyPath, "", "the key.pem file path for the server TLS configuration")

simulation/simulation_test.go

@@ -10,29 +10,30 @@ import (
 
 	abci "github.com/cometbft/cometbft/abci/types"
 	tmproto "github.com/cometbft/cometbft/proto/tendermint/types"
+	"github.com/cosmos/cosmos-sdk/baseapp"
+	"github.com/cosmos/cosmos-sdk/client/flags"
+	"github.com/cosmos/cosmos-sdk/server"
 	"github.com/cosmos/cosmos-sdk/store"
 	storetypes "github.com/cosmos/cosmos-sdk/store/types"
+	cosmossimutils "github.com/cosmos/cosmos-sdk/testutil/sims"
 	sdk "github.com/cosmos/cosmos-sdk/types"
-	authtypes "github.com/cosmos/cosmos-sdk/x/auth/types"
+	cosmossim "github.com/cosmos/cosmos-sdk/types/simulation"
 	banktypes "github.com/cosmos/cosmos-sdk/x/bank/types"
 	distrtypes "github.com/cosmos/cosmos-sdk/x/distribution/types"
 	evidencetypes "github.com/cosmos/cosmos-sdk/x/evidence/types"
 	govtypes "github.com/cosmos/cosmos-sdk/x/gov/types"
 	paramtypes "github.com/cosmos/cosmos-sdk/x/params/types"
+	"github.com/cosmos/cosmos-sdk/x/simulation"
+	cosmossimcli "github.com/cosmos/cosmos-sdk/x/simulation/client/cli"
 	slashingtypes "github.com/cosmos/cosmos-sdk/x/slashing/types"
 	stakingtypes "github.com/cosmos/cosmos-sdk/x/staking/types"
 	"github.com/stretchr/testify/require"
 	evmtypes "github.com/zeta-chain/ethermint/x/evm/types"
 	"github.com/zeta-chain/node/app"
 	zetasimulation "github.com/zeta-chain/node/simulation"
-
-	"github.com/cosmos/cosmos-sdk/baseapp"
-	"github.com/cosmos/cosmos-sdk/client/flags"
-	"github.com/cosmos/cosmos-sdk/server"
-	cosmossimutils "github.com/cosmos/cosmos-sdk/testutil/sims"
-	cosmossim "github.com/cosmos/cosmos-sdk/types/simulation"
-	"github.com/cosmos/cosmos-sdk/x/simulation"
-	cosmossimcli "github.com/cosmos/cosmos-sdk/x/simulation/client/cli"
+	crosschaintypes "github.com/zeta-chain/node/x/crosschain/types"
+	fungibletypes "github.com/zeta-chain/node/x/fungible/types"
+	observertypes "github.com/zeta-chain/node/x/observer/types"
 )
 
 // AppChainID hardcoded chainID for simulation
@@ -41,10 +42,12 @@ func init() {
 	zetasimulation.GetSimulatorFlags()
 }
 
+// StoreKeysPrefixes defines a struct used in comparing two keys for two different stores
+// SkipPrefixes is used to skip certain prefixes when comparing the stores
 type StoreKeysPrefixes struct {
-	A        storetypes.StoreKey
-	B        storetypes.StoreKey
-	Prefixes [][]byte
+	A            storetypes.StoreKey
+	B            storetypes.StoreKey
+	SkipPrefixes [][]byte
 }
 
 const (
@@ -133,9 +136,11 @@ func TestAppStateDeterminism(t *testing.T) {
 				os.Stdout,
 				simApp.BaseApp,
 				zetasimulation.AppStateFn(
+					t,
 					simApp.AppCodec(),
 					simApp.SimulationManager(),
 					simApp.BasicManager().DefaultGenesis(simApp.AppCodec()),
+					nil,
 				),
 				cosmossim.RandomAccounts,
 				cosmossimutils.SimulationOperations(simApp, simApp.AppCodec(), config),
@@ -222,9 +227,11 @@ func TestFullAppSimulation(t *testing.T) {
 		os.Stdout,
 		simApp.BaseApp,
 		zetasimulation.AppStateFn(
+			t,
 			simApp.AppCodec(),
 			simApp.SimulationManager(),
 			simApp.BasicManager().DefaultGenesis(simApp.AppCodec()),
+			nil,
 		),
 		cosmossim.RandomAccounts,
 		cosmossimutils.SimulationOperations(simApp, simApp.AppCodec(), config),
@@ -292,9 +299,11 @@ func TestAppImportExport(t *testing.T) {
 		os.Stdout,
 		simApp.BaseApp,
 		zetasimulation.AppStateFn(
+			t,
 			simApp.AppCodec(),
 			simApp.SimulationManager(),
 			simApp.BasicManager().DefaultGenesis(simApp.AppCodec()),
+			nil,
 		),
 		cosmossim.RandomAccounts,
 		cosmossimutils.SimulationOperations(simApp, simApp.AppCodec(), config),
@@ -314,7 +323,6 @@ func TestAppImportExport(t *testing.T) {
 	exported, err := simApp.ExportAppStateAndValidators(false, []string{}, []string{})
 	require.NoError(t, err)
 
-	t.Log("importing genesis")
 	newDB, newDir, _, _, err := cosmossimutils.SetupSimulation(
 		config,
 		SimDBBackend+"_new",
@@ -360,20 +368,28 @@ func TestAppImportExport(t *testing.T) {
 	ctxSimApp := simApp.NewContext(true, tmproto.Header{
 		Height:  simApp.LastBlockHeight(),
 		ChainID: SimAppChainID,
-	}).WithChainID(SimAppChainID)
+	})
+
 	ctxNewSimApp := newSimApp.NewContext(true, tmproto.Header{
 		Height:  simApp.LastBlockHeight(),
 		ChainID: SimAppChainID,
-	}).WithChainID(SimAppChainID)
+	})
 
+	t.Log("initializing genesis for the new app using exported genesis state")
 	// Use genesis state from the first app to initialize the second app
 	newSimApp.ModuleManager().InitGenesis(ctxNewSimApp, newSimApp.AppCodec(), genesisState)
 	newSimApp.StoreConsensusParams(ctxNewSimApp, exported.ConsensusParams)
 
 	t.Log("comparing stores")
+
 	// The ordering of the keys is not important, we compare the same prefix for both simulations
 	storeKeysPrefixes := []StoreKeysPrefixes{
-		{simApp.GetKey(authtypes.StoreKey), newSimApp.GetKey(authtypes.StoreKey), [][]byte{}},
+		// Interaction with EVM module,
+		//such as deploying contracts or interacting with them such as setting gas price,
+		// causes the state for the auth module to change on export.The order of keys within the store is modified.
+		// We will need to explore this further to find a definitive answer
+		// TODO : https://github.com/zeta-chain/node/issues/3263
+		//{simApp.GetKey(authtypes.StoreKey), newSimApp.GetKey(authtypes.StoreKey), [][]byte{}},
 		{
 			simApp.GetKey(stakingtypes.StoreKey), newSimApp.GetKey(stakingtypes.StoreKey),
 			[][]byte{
@@ -388,13 +404,23 @@ func TestAppImportExport(t *testing.T) {
 		{simApp.GetKey(govtypes.StoreKey), newSimApp.GetKey(govtypes.StoreKey), [][]byte{}},
 		{simApp.GetKey(evidencetypes.StoreKey), newSimApp.GetKey(evidencetypes.StoreKey), [][]byte{}},
 		{simApp.GetKey(evmtypes.StoreKey), newSimApp.GetKey(evmtypes.StoreKey), [][]byte{}},
+		{simApp.GetKey(crosschaintypes.StoreKey), newSimApp.GetKey(crosschaintypes.StoreKey), [][]byte{
+			// We update the timestamp for cctx when importing the genesis state which results in a different value
+			crosschaintypes.KeyPrefix(crosschaintypes.CCTXKey),
+		}},
+
+		{simApp.GetKey(observertypes.StoreKey), newSimApp.GetKey(observertypes.StoreKey), [][]byte{
+			// The order of ballots when importing is not preserved which causes the value to be different.
+			observertypes.KeyPrefix(observertypes.BallotListKey),
+		}},
+		{simApp.GetKey(fungibletypes.StoreKey), newSimApp.GetKey(fungibletypes.StoreKey), [][]byte{}},
 	}
 
 	for _, skp := range storeKeysPrefixes {
 		storeA := ctxSimApp.KVStore(skp.A)
 		storeB := ctxNewSimApp.KVStore(skp.B)
 
-		failedKVAs, failedKVBs := sdk.DiffKVStores(storeA, storeB, skp.Prefixes)
+		failedKVAs, failedKVBs := sdk.DiffKVStores(storeA, storeB, skp.SkipPrefixes)
 		require.Equal(t, len(failedKVAs), len(failedKVBs), "unequal sets of key-values to compare")
 
 		t.Logf("compared %d different key/value pairs between %s and %s\n", len(failedKVAs), skp.A, skp.B)
@@ -459,9 +485,11 @@ func TestAppSimulationAfterImport(t *testing.T) {
 		os.Stdout,
 		simApp.BaseApp,
 		zetasimulation.AppStateFn(
+			t,
 			simApp.AppCodec(),
 			simApp.SimulationManager(),
 			simApp.BasicManager().DefaultGenesis(simApp.AppCodec()),
+			nil,
 		),
 		cosmossim.RandomAccounts,
 		cosmossimutils.SimulationOperations(simApp, simApp.AppCodec(), config),
@@ -487,8 +515,6 @@ func TestAppSimulationAfterImport(t *testing.T) {
 	exported, err := simApp.ExportAppStateAndValidators(true, []string{}, []string{})
 	require.NoError(t, err)
 
-	t.Log("importing genesis")
-
 	newDB, newDir, _, _, err := cosmossimutils.SetupSimulation(
 		config,
 		SimDBBackend+"_new",
@@ -517,6 +543,7 @@ func TestAppSimulationAfterImport(t *testing.T) {
 	)
 	require.NoError(t, err)
 
+	t.Log("Importing genesis into the new app")
 	newSimApp.InitChain(abci.RequestInitChain{
 		ChainId:       SimAppChainID,
 		AppStateBytes: exported.AppState,
@@ -527,9 +554,11 @@ func TestAppSimulationAfterImport(t *testing.T) {
 		os.Stdout,
 		newSimApp.BaseApp,
 		zetasimulation.AppStateFn(
-			simApp.AppCodec(),
-			simApp.SimulationManager(),
-			simApp.BasicManager().DefaultGenesis(simApp.AppCodec()),
+			t,
+			nil,
+			nil,
+			nil,
+			exported.AppState,
 		),
 		cosmossim.RandomAccounts,
 		cosmossimutils.SimulationOperations(newSimApp, newSimApp.AppCodec(), config),