test: add crosschain and observer operations

Makefile

@@ -175,8 +175,7 @@ protoImageName=ghcr.io/cosmos/proto-builder:$(protoVer)
 protoImage=$(DOCKER) run --rm -v $(CURDIR):/workspace --workdir /workspace --user $(shell id -u):$(shell id -g) $(protoImageName)
 
 proto-format:
-	@echo "--> Formatting Protobuf files"
-	@$(protoImage) find ./ -name "*.proto" -exec clang-format -i {} \;
+	@echo "--> Formatting Protobuf files"	@$(protoImage) find ./ -name "*.proto" -exec clang-format -i {} \;
 .PHONY: proto-format
 
 typescript: proto-format
@@ -409,7 +408,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,50,100,30m)
+	$(call run-sim-test,"test-import-export",TestAppImportExport,100,200,30m)
 
 test-sim-after-import:
 	$(call run-sim-test,"test-sim-after-import",TestAppSimulationAfterImport,100,200,30m)
@@ -430,6 +429,12 @@ test-sim-after-import-long: runsim
 	@echo "Running application simulation-after-import. This may take several minute"
 	@$(BINDIR)/runsim -Jobs=4 -SimAppPkg=$(SIMAPP) -ExitOnFail 500 50 TestAppSimulationAfterImport
 
+# Use to run all simulation tests quickly (for example, before a creating a PR)
+test-sim-quick:
+	$(call run-sim-test,"test-full-app-sim",TestFullAppSimulation,10,20,30m)
+	$(call run-sim-test,"test-import-export",TestAppImportExport,10,20,30m)
+	$(call run-sim-test,"test-sim-after-import",TestAppSimulationAfterImport,10,20,30m)
+
 .PHONY: \
 test-sim-nondeterminism \
 test-sim-fullappsimulation \

changelog.md

@@ -11,6 +11,7 @@
 * [3205](https://github.com/zeta-chain/node/issues/3205) - move Bitcoin revert address test to advanced group to avoid upgrade test failure
 * [3254](https://github.com/zeta-chain/node/pull/3254) - rename v2 E2E tests as evm tests and rename old evm tests as legacy
 * [3095](https://github.com/zeta-chain/node/pull/3095) - initialize simulation tests for custom zetachain modules
+* [3207](https://github.com/zeta-chain/node/pull/3207) - add simulation test operations for all messages in crosschain and observer module
 
 ## Refactor
 

pkg/chains/chain_filters.go

@@ -18,6 +18,11 @@ func FilterByConsensus(cs Consensus) ChainFilter {
 	return func(chain Chain) bool { return chain.Consensus == cs }
 }
 
+// FilterByVM filters chains by VM type
+func FilterByVM(vm Vm) ChainFilter {
+	return func(chain Chain) bool { return chain.Vm == vm }
+}
+
 // FilterChains applies a list of filters to a list of chains
 func FilterChains(chainList []Chain, filters ...ChainFilter) []Chain {
 	// Apply each filter to the list of supported chains

pkg/chains/chain_filters_test.go

@@ -14,42 +14,57 @@ func TestFilterChains(t *testing.T) {
 		expected func() []chains.Chain
 	}{
 		{
-			name:    "Filter external chains",
+			name:    "filter external chains",
 			filters: []chains.ChainFilter{chains.FilterExternalChains},
 			expected: func() []chains.Chain {
 				return chains.ExternalChainList([]chains.Chain{})
 			},
 		},
 		{
-			name:    "Filter gateway observer chains",
+			name:    "filter gateway observer chains",
 			filters: []chains.ChainFilter{chains.FilterByGateway(chains.CCTXGateway_observers)},
 			expected: func() []chains.Chain {
 				return chains.ChainListByGateway(chains.CCTXGateway_observers, []chains.Chain{})
 			},
 		},
 		{
-			name:    "Filter consensus ethereum chains",
+			name:    "filter consensus ethereum chains",
 			filters: []chains.ChainFilter{chains.FilterByConsensus(chains.Consensus_ethereum)},
 			expected: func() []chains.Chain {
 				return chains.ChainListByConsensus(chains.Consensus_ethereum, []chains.Chain{})
 			},
 		},
 		{
-			name:    "Filter consensus bitcoin chains",
+			name:    "filter consensus bitcoin chains",
 			filters: []chains.ChainFilter{chains.FilterByConsensus(chains.Consensus_bitcoin)},
 			expected: func() []chains.Chain {
 				return chains.ChainListByConsensus(chains.Consensus_bitcoin, []chains.Chain{})
 			},
 		},
 		{
-			name:    "Filter consensus solana chains",
+			name:    "filter consensus solana chains",
 			filters: []chains.ChainFilter{chains.FilterByConsensus(chains.Consensus_solana_consensus)},
 			expected: func() []chains.Chain {
 				return chains.ChainListByConsensus(chains.Consensus_solana_consensus, []chains.Chain{})
 			},
 		},
 		{
-			name: "Apply multiple filters external chains and gateway observer",
+			name: "filter evm chains",
+			filters: []chains.ChainFilter{
+				chains.FilterByVM(chains.Vm_evm),
+			},
+			expected: func() []chains.Chain {
+				var chainList []chains.Chain
+				for _, chain := range chains.ExternalChainList([]chains.Chain{}) {
+					if chain.Vm == chains.Vm_evm {
+						chainList = append(chainList, chain)
+					}
+				}
+				return chainList
+			},
+		},
+		{
+			name: "apply multiple filters external chains and gateway observer",
 			filters: []chains.ChainFilter{
 				chains.FilterExternalChains,
 				chains.FilterByGateway(chains.CCTXGateway_observers),
@@ -66,7 +81,7 @@ func TestFilterChains(t *testing.T) {
 			},
 		},
 		{
-			name: "Apply multiple filters external chains with gateway observer and consensus ethereum",
+			name: "apply multiple filters external chains with gateway observer and consensus ethereum",
 			filters: []chains.ChainFilter{
 				chains.FilterExternalChains,
 				chains.FilterByGateway(chains.CCTXGateway_observers),
@@ -85,7 +100,7 @@ func TestFilterChains(t *testing.T) {
 			},
 		},
 		{
-			name: "Apply multiple filters external chains with gateway observer and consensus bitcoin",
+			name: "apply multiple filters external chains with gateway observer and consensus bitcoin",
 			filters: []chains.ChainFilter{
 				chains.FilterExternalChains,
 				chains.FilterByGateway(chains.CCTXGateway_observers),
@@ -116,7 +131,7 @@ func TestFilterChains(t *testing.T) {
 			},
 		},
 		{
-			name: "Test multiple filters in random order",
+			name: "test multiple filters in random order",
 			filters: []chains.ChainFilter{
 				chains.FilterByGateway(chains.CCTXGateway_observers),
 				chains.FilterByConsensus(chains.Consensus_ethereum),

pkg/coin/coin.go

@@ -34,3 +34,7 @@ func GetAzetaDecFromAmountInZeta(zetaAmount string) (sdk.Dec, error) {
 	zetaToAzetaConvertionFactor := sdk.NewDecFromInt(sdk.NewInt(1000000000000000000))
 	return zetaDec.Mul(zetaToAzetaConvertionFactor), nil
 }
+
+func (c CoinType) SupportsRefund() bool {
+	return c == CoinType_ERC20 || c == CoinType_Gas || c == CoinType_Zeta
+}

pkg/coin/coint_test.go

@@ -0,0 +1,28 @@
+package coin_test
+
+import (
+	"testing"
+
+	"github.com/zeta-chain/node/pkg/coin"
+)
+
+func TestCoinType_SupportsRefund(t *testing.T) {
+	tests := []struct {
+		name string
+		c    coin.CoinType
+		want bool
+	}{
+		{"ERC20", coin.CoinType_ERC20, true},
+		{"Gas", coin.CoinType_Gas, true},
+		{"Zeta", coin.CoinType_Zeta, true},
+		{"Cmd", coin.CoinType_Cmd, false},
+		{"Unknown", coin.CoinType(100), false},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			if got := tt.c.SupportsRefund(); got != tt.want {
+				t.Errorf("CoinType.SupportsRefund() = %v, want %v", got, tt.want)
+			}
+		})
+	}
+}

pkg/memo/memo_test.go

@@ -7,6 +7,7 @@ import (
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/stretchr/testify/require"
 	"github.com/zeta-chain/node/pkg/memo"
+	"github.com/zeta-chain/node/testutil/sample"
 	crosschaintypes "github.com/zeta-chain/node/x/crosschain/types"
 )
 
@@ -324,6 +325,7 @@ func Test_DecodeLegacyMemoHex(t *testing.T) {
 		{"empty msg", "", common.Address{}, nil, false},
 		{"invalid hex", "invalidHex", common.Address{}, nil, true},
 		{"short msg", "1a2b3c4d5e6f708192a3b4c5d6e7f808", common.Address{}, expectedShortMsgResult, false},
+		{"random message", sample.EthAddress().String(), common.Address{}, nil, true},
 	}
 
 	for _, tt := range tests {

simulation/simulation_test.go

@@ -42,8 +42,6 @@ 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
@@ -66,6 +64,12 @@ func interBlockCacheOpt() func(*baseapp.BaseApp) {
 }
 
 // TestAppStateDeterminism runs a full application simulation , and produces multiple blocks as per the config
+// It does the following
+// 1. It runs the simulation multiple times with the same seed value
+// 2. It checks the apphash at the end of each run
+// 3. It compares the apphash at the end of each run to check for determinism
+// 4. Repeat steps 1-3 for multiple seeds
+
 // It checks the determinism of the application by comparing the apphash at the end of each run to other runs
 // The following test certifies that , for the same set of operations ( irrespective of what the operations are ) ,
 // we would reach the same final state if the initial state is the same
@@ -179,7 +183,10 @@ func TestAppStateDeterminism(t *testing.T) {
 }
 
 // TestFullAppSimulation runs a full simApp simulation with the provided configuration.
-// At the end of the run it tries to export the genesis state to make sure the export works.
+// This test does the following
+// 1. It runs a full simulation with the provided configuration
+// 2. It exports the state and validators
+// 3. Verifies that the run and export were successful
 func TestFullAppSimulation(t *testing.T) {
 
 	config := zetasimulation.NewConfigFromFlags()
@@ -252,6 +259,15 @@ func TestFullAppSimulation(t *testing.T) {
 	zetasimulation.PrintStats(db)
 }
 
+// TestAppImportExport tests the application simulation after importing the state exported from a previous.At a high level,it does the following
+//  1. It runs a full simulation and exports the state
+//  2. It creates a new app, and db
+//  3. It imports the exported state into the new app
+//  4. It compares the key value pairs for the two apps.The comparison function takes a list of keys to skip as an input as well
+//     a. First app which ran the simulation
+//     b. Second app which imported the state
+
+// This can verify the export and import process do not modify the state in anyway irrespective of the operations performed
 func TestAppImportExport(t *testing.T) {
 	config := zetasimulation.NewConfigFromFlags()
 
@@ -270,7 +286,6 @@ func TestAppImportExport(t *testing.T) {
 		t.Skip("skipping application simulation")
 	}
 	require.NoError(t, err, "simulation setup failed")
-
 	t.Cleanup(func() {
 		if err := db.Close(); err != nil {
 			require.NoError(t, err, "Error closing new database")
@@ -375,7 +390,6 @@ func TestAppImportExport(t *testing.T) {
 		ChainID: 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)
@@ -390,7 +404,7 @@ func TestAppImportExport(t *testing.T) {
 		// 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(authtypes.StoreKey), newSimApp.GetKey(authtypes.StoreKey), [][]byte{}},
 		{
 			simApp.GetKey(stakingtypes.StoreKey), newSimApp.GetKey(stakingtypes.StoreKey),
 			[][]byte{
@@ -439,6 +453,12 @@ func TestAppImportExport(t *testing.T) {
 	}
 }
 
+// TestAppSimulationAfterImport tests the application simulation after importing the state exported from a previous simulation run.
+// It does the following steps
+// 1. It runs a full simulation and exports the state
+// 2. It creates a new app, and db
+// 3. It imports the exported state into the new app
+// 4. It runs a simulation on the new app and verifies that there is no error in the second simulation
 func TestAppSimulationAfterImport(t *testing.T) {
 	config := zetasimulation.NewConfigFromFlags()
 
@@ -516,16 +536,15 @@ func TestAppSimulationAfterImport(t *testing.T) {
 	exported, err := simApp.ExportAppStateAndValidators(true, []string{}, []string{})
 	require.NoError(t, err)
 
+	// Setup a new app with new database and directory
 	newDB, newDir, _, _, err := cosmossimutils.SetupSimulation(
 		config,
 		SimDBBackend+"_new",
 		SimDBName+"_new",
 		zetasimulation.FlagVerboseValue,
 		zetasimulation.FlagEnabledValue,
 	)
-
 	require.NoError(t, err, "simulation setup failed")
-
 	t.Cleanup(func() {
 		if err := newDB.Close(); err != nil {
 			require.NoError(t, err, "Error closing new database")
@@ -534,7 +553,6 @@ func TestAppSimulationAfterImport(t *testing.T) {
 			require.NoError(t, err, "Error removing directory")
 		}
 	})
-
 	newSimApp, err := zetasimulation.NewSimApp(
 		logger,
 		newDB,
@@ -544,12 +562,14 @@ func TestAppSimulationAfterImport(t *testing.T) {
 	)
 	require.NoError(t, err)
 
+	// Initialize the new app with the exported genesis state of the first run
 	t.Log("Importing genesis into the new app")
 	newSimApp.InitChain(abci.RequestInitChain{
 		ChainId:       SimAppChainID,
 		AppStateBytes: exported.AppState,
 	})
 
+	// Run simulation on the new app
 	stopEarly, simParams, simErr = simulation.SimulateFromSeed(
 		t,
 		os.Stdout,
@@ -567,5 +587,5 @@ func TestAppSimulationAfterImport(t *testing.T) {
 		config,
 		simApp.AppCodec(),
 	)
-	require.NoError(t, err)
+	require.NoError(t, simErr)
 }