Delete unused simulator code (#1671)

* Delete unused simulator code * Add hourly epochs to the x/epochs DefaultGenesis * Add changelog * Delete the unused x/gamm/simulation folder * Fix epochs module tests for updated DefaultGenesis (cherry picked from commit f21e29e) # Conflicts: # CHANGELOG.md # x/epochs/module.go # x/epochs/simulation/genesis.go # x/gamm/module.go # x/gamm/simulation/operations.go # x/mint/simulation/params_test.go
osmosis-labs · Jul 19, 2022 · 3a70ebf · 3a70ebf
1 parent 06a49e8
commit 3a70ebf
Show file tree

Hide file tree

Showing 12 changed files with 42 additions and 231 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -70,6 +70,12 @@ This release contains minor CLI bug fixes.
 
 * [#1699](https://github.com/osmosis-labs/osmosis/pull/1699) Fixes bug in sig fig rounding on spot price queries for small values
 
+<<<<<<< HEAD
+=======
+* [#1671](https://github.com/osmosis-labs/osmosis/pull/1671) Remove methods that constitute AppModuleSimulation APIs for several modules' AppModules, which implemented no-ops
+* [#1671](https://github.com/osmosis-labs/osmosis/pull/1671) Add hourly epochs to `x/epochs` DefaultGenesis.
+* [#1665](https://github.com/osmosis-labs/osmosis/pull/1665) Delete app/App interface, instead use simapp.App
+>>>>>>> f21e29eb (Delete unused simulator code (#1671))
 * [#1630](https://github.com/osmosis-labs/osmosis/pull/1630) Delete the v043_temp module, now that we're on an updated SDK version.
 
 ### Bug Fixes
@@ -81,6 +87,7 @@ This release contains minor CLI bug fixes.
 * [1931](https://github.com/osmosis-labs/osmosis/pull/1931) Add explicit check for input denoms to `CalcJoinPoolShares`
 
 
+
 ## [v9.0.0 - Nitrogen](https://github.com/osmosis-labs/osmosis/releases/tag/v9.0.0)
 
 The Nitrogen release brings with it a number of features enabling further cosmwasm development work in Osmosis.

diff --git a/app/modules.go b/app/modules.go
@@ -220,8 +220,6 @@ func simulationModules(
 		bank.NewAppModule(appCodec, app.BankKeeper, app.AccountKeeper),
 		capability.NewAppModule(appCodec, *app.CapabilityKeeper),
 		authzmodule.NewAppModule(appCodec, *app.AuthzKeeper, app.AccountKeeper, app.BankKeeper, app.interfaceRegistry),
-		gamm.NewAppModule(appCodec, *app.GAMMKeeper, app.AccountKeeper, app.BankKeeper),
-		txfees.NewAppModule(appCodec, *app.TxFeesKeeper),
 		gov.NewAppModule(appCodec, *app.GovKeeper, app.AccountKeeper, app.BankKeeper),
 		mint.NewAppModule(appCodec, *app.MintKeeper, app.AccountKeeper, app.BankKeeper),
 		slashing.NewAppModule(appCodec, *app.SlashingKeeper, app.AccountKeeper, app.BankKeeper, *app.StakingKeeper),
@@ -234,7 +232,6 @@ func simulationModules(
 		incentives.NewAppModule(appCodec, *app.IncentivesKeeper, app.AccountKeeper, app.BankKeeper, app.EpochsKeeper),
 		lockup.NewAppModule(appCodec, *app.LockupKeeper, app.AccountKeeper, app.BankKeeper),
 		poolincentives.NewAppModule(appCodec, *app.PoolIncentivesKeeper),
-		epochs.NewAppModule(appCodec, *app.EpochsKeeper),
 		superfluid.NewAppModule(
 			appCodec,
 			*app.SuperfluidKeeper,
@@ -245,7 +242,6 @@ func simulationModules(
 			app.GAMMKeeper,
 			app.EpochsKeeper,
 		),
-		tokenfactory.NewAppModule(appCodec, *app.TokenFactoryKeeper, app.AccountKeeper, app.BankKeeper),
 		app.TransferModule,
 	}
 }

diff --git a/x/epochs/keeper/epoch_test.go b/x/epochs/keeper/epoch_test.go
@@ -9,21 +9,15 @@ import (
 func (suite *KeeperTestSuite) TestEpochLifeCycle() {
 	suite.SetupTest()
 
-	epochInfo := types.EpochInfo{
-		Identifier:            "monthly",
-		StartTime:             time.Time{},
-		Duration:              time.Hour * 24 * 30,
-		CurrentEpoch:          0,
-		CurrentEpochStartTime: time.Time{},
-		EpochCountingStarted:  false,
-	}
+	epochInfo := types.NewGenesisEpochInfo("monthly", time.Hour*24*30)
 	suite.App.EpochsKeeper.SetEpochInfo(suite.Ctx, epochInfo)
 	epochInfoSaved := suite.App.EpochsKeeper.GetEpochInfo(suite.Ctx, "monthly")
 	suite.Require().Equal(epochInfo, epochInfoSaved)
 
 	allEpochs := suite.App.EpochsKeeper.AllEpochInfos(suite.Ctx)
-	suite.Require().Len(allEpochs, 3)
+	suite.Require().Len(allEpochs, 4)
 	suite.Require().Equal(allEpochs[0].Identifier, "day") // alphabetical order
-	suite.Require().Equal(allEpochs[1].Identifier, "monthly")
-	suite.Require().Equal(allEpochs[2].Identifier, "week")
+	suite.Require().Equal(allEpochs[1].Identifier, "hour")
+	suite.Require().Equal(allEpochs[2].Identifier, "monthly")
+	suite.Require().Equal(allEpochs[3].Identifier, "week")
 }
diff --git a/x/epochs/keeper/genesis_test.go b/x/epochs/keeper/genesis_test.go
@@ -19,22 +19,14 @@ func TestEpochsExportGenesis(t *testing.T) {
 	chainStartHeight := ctx.BlockHeight()
 
 	genesis := app.EpochsKeeper.ExportGenesis(ctx)
-	require.Len(t, genesis.Epochs, 2)
+	require.Len(t, genesis.Epochs, 3)
 
-	require.Equal(t, genesis.Epochs[0].Identifier, "day")
-	require.Equal(t, genesis.Epochs[0].StartTime, chainStartTime)
-	require.Equal(t, genesis.Epochs[0].Duration, time.Hour*24)
-	require.Equal(t, genesis.Epochs[0].CurrentEpoch, int64(0))
-	require.Equal(t, genesis.Epochs[0].CurrentEpochStartHeight, chainStartHeight)
-	require.Equal(t, genesis.Epochs[0].CurrentEpochStartTime, chainStartTime)
-	require.Equal(t, genesis.Epochs[0].EpochCountingStarted, false)
-	require.Equal(t, genesis.Epochs[1].Identifier, "week")
-	require.Equal(t, genesis.Epochs[1].StartTime, chainStartTime)
-	require.Equal(t, genesis.Epochs[1].Duration, time.Hour*24*7)
-	require.Equal(t, genesis.Epochs[1].CurrentEpoch, int64(0))
-	require.Equal(t, genesis.Epochs[1].CurrentEpochStartHeight, chainStartHeight)
-	require.Equal(t, genesis.Epochs[1].CurrentEpochStartTime, chainStartTime)
-	require.Equal(t, genesis.Epochs[1].EpochCountingStarted, false)
+	expectedEpochs := types.DefaultGenesis().Epochs
+	for i := 0; i < len(expectedEpochs); i++ {
+		expectedEpochs[i].CurrentEpochStartHeight = chainStartHeight
+		expectedEpochs[i].CurrentEpochStartTime = chainStartTime
+	}
+	require.Equal(t, expectedEpochs, genesis.Epochs)
 }
 
 func TestEpochsInitGenesis(t *testing.T) {

diff --git a/x/epochs/keeper/grpc_query_test.go b/x/epochs/keeper/grpc_query_test.go
@@ -2,7 +2,6 @@ package keeper_test
 
 import (
 	gocontext "context"
-	"time"
 
 	"github.com/osmosis-labs/osmosis/v10/x/epochs/types"
 )
@@ -11,42 +10,10 @@ func (suite *KeeperTestSuite) TestQueryEpochInfos() {
 	suite.SetupTest()
 	queryClient := suite.queryClient
 
-	chainStartTime := suite.Ctx.BlockHeader().Time
-	epochInfo := types.EpochInfo{
-		Identifier:            "day",
-		StartTime:             chainStartTime,
-		Duration:              time.Hour * 24,
-		CurrentEpoch:          0,
-		CurrentEpochStartTime: chainStartTime,
-		EpochCountingStarted:  false,
-	}
-	suite.App.EpochsKeeper.SetEpochInfo(suite.Ctx, epochInfo)
-	epochInfo = types.EpochInfo{
-		Identifier:            "week",
-		StartTime:             chainStartTime,
-		Duration:              time.Hour * 24 * 7,
-		CurrentEpoch:          0,
-		CurrentEpochStartTime: chainStartTime,
-		EpochCountingStarted:  false,
-	}
-	suite.App.EpochsKeeper.SetEpochInfo(suite.Ctx, epochInfo)
-
-	// Invalid param
+	// Check that querying epoch infos on default genesis returns the default genesis epoch infos
 	epochInfosResponse, err := queryClient.EpochInfos(gocontext.Background(), &types.QueryEpochsInfoRequest{})
 	suite.Require().NoError(err)
-	suite.Require().Len(epochInfosResponse.Epochs, 2)
-
-	// check if EpochInfos are correct
-	suite.Require().Equal(epochInfosResponse.Epochs[0].Identifier, "day")
-	suite.Require().Equal(epochInfosResponse.Epochs[0].StartTime, chainStartTime)
-	suite.Require().Equal(epochInfosResponse.Epochs[0].Duration, time.Hour*24)
-	suite.Require().Equal(epochInfosResponse.Epochs[0].CurrentEpoch, int64(0))
-	suite.Require().Equal(epochInfosResponse.Epochs[0].CurrentEpochStartTime, chainStartTime)
-	suite.Require().Equal(epochInfosResponse.Epochs[0].EpochCountingStarted, false)
-	suite.Require().Equal(epochInfosResponse.Epochs[1].Identifier, "week")
-	suite.Require().Equal(epochInfosResponse.Epochs[1].StartTime, chainStartTime)
-	suite.Require().Equal(epochInfosResponse.Epochs[1].Duration, time.Hour*24*7)
-	suite.Require().Equal(epochInfosResponse.Epochs[1].CurrentEpoch, int64(0))
-	suite.Require().Equal(epochInfosResponse.Epochs[1].CurrentEpochStartTime, chainStartTime)
-	suite.Require().Equal(epochInfosResponse.Epochs[1].EpochCountingStarted, false)
+	suite.Require().Len(epochInfosResponse.Epochs, 3)
+	expectedEpochs := types.DefaultGenesis().Epochs
+	suite.Require().Equal(expectedEpochs, epochInfosResponse.Epochs)
 }
diff --git a/x/epochs/module.go b/x/epochs/module.go
@@ -4,7 +4,6 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
-	"math/rand"
 
 	"github.com/gorilla/mux"
 	"github.com/grpc-ecosystem/grpc-gateway/runtime"
@@ -16,13 +15,19 @@ import (
 	cdctypes "github.com/cosmos/cosmos-sdk/codec/types"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	"github.com/cosmos/cosmos-sdk/types/module"
-	simtypes "github.com/cosmos/cosmos-sdk/types/simulation"
 
+<<<<<<< HEAD
 	"github.com/osmosis-labs/osmosis/v10/x/epochs/client/cli"
 	"github.com/osmosis-labs/osmosis/v10/x/epochs/keeper"
 	"github.com/osmosis-labs/osmosis/v10/x/epochs/simulation"
 	"github.com/osmosis-labs/osmosis/v10/x/epochs/types"
 	"github.com/osmosis-labs/osmosis/v10/x/mint/client/rest"
+=======
+	"github.com/osmosis-labs/osmosis/v7/x/epochs/client/cli"
+	"github.com/osmosis-labs/osmosis/v7/x/epochs/keeper"
+	"github.com/osmosis-labs/osmosis/v7/x/epochs/types"
+	"github.com/osmosis-labs/osmosis/v7/x/mint/client/rest"
+>>>>>>> f21e29eb (Delete unused simulator code (#1671))
 )
 
 var (
@@ -163,33 +168,5 @@ func (am AppModule) EndBlock(ctx sdk.Context, _ abci.RequestEndBlock) []abci.Val
 	return []abci.ValidatorUpdate{}
 }
 
-// ___________________________________________________________________________
-
-// AppModuleSimulation functions
-
-// GenerateGenesisState creates a randomized GenState of the pool-incentives module.
-func (AppModule) GenerateGenesisState(simState *module.SimulationState) {
-	simulation.RandomizedGenState(simState)
-}
-
-// ProposalContents doesn't return any content functions for governance proposals.
-func (AppModule) ProposalContents(simState module.SimulationState) []simtypes.WeightedProposalContent {
-	return nil
-}
-
-// RandomizedParams creates randomized pool-incentives param changes for the simulator.
-func (AppModule) RandomizedParams(r *rand.Rand) []simtypes.ParamChange {
-	return nil
-}
-
-// RegisterStoreDecoder registers a decoder for supply module's types.
-func (am AppModule) RegisterStoreDecoder(sdr sdk.StoreDecoderRegistry) {
-}
-
-// WeightedOperations returns the all the gov module operations with their respective weights.
-func (am AppModule) WeightedOperations(simState module.SimulationState) []simtypes.WeightedOperation {
-	return nil // TODO
-}
-
 // ConsensusVersion implements AppModule/ConsensusVersion.
 func (AppModule) ConsensusVersion() uint64 { return 1 }
diff --git a/x/epochs/types/genesis.go b/x/epochs/types/genesis.go
@@ -15,8 +15,9 @@ func NewGenesisState(epochs []EpochInfo) *GenesisState {
 // DefaultGenesis returns the default Capability genesis state.
 func DefaultGenesis() *GenesisState {
 	epochs := []EpochInfo{
+		NewGenesisEpochInfo("day", time.Hour*24), // alphabetical order
+		NewGenesisEpochInfo("hour", time.Hour),
 		NewGenesisEpochInfo("week", time.Hour*24*7),
-		NewGenesisEpochInfo("day", time.Hour*24),
 	}
 	return NewGenesisState(epochs)
 }

diff --git a/x/gamm/module.go b/x/gamm/module.go
@@ -4,7 +4,6 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
-	"math/rand"
 
 	"github.com/gorilla/mux"
 	"github.com/grpc-ecosystem/grpc-gateway/runtime"
@@ -16,20 +15,25 @@ import (
 	codectypes "github.com/cosmos/cosmos-sdk/codec/types"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	"github.com/cosmos/cosmos-sdk/types/module"
-	simtypes "github.com/cosmos/cosmos-sdk/types/simulation"
 	stakingtypes "github.com/cosmos/cosmos-sdk/x/staking/types"
 
+<<<<<<< HEAD
 	"github.com/osmosis-labs/osmosis/v10/x/gamm/client/cli"
 	"github.com/osmosis-labs/osmosis/v10/x/gamm/keeper"
 	"github.com/osmosis-labs/osmosis/v10/x/gamm/pool-models/balancer"
 	"github.com/osmosis-labs/osmosis/v10/x/gamm/simulation"
 	"github.com/osmosis-labs/osmosis/v10/x/gamm/types"
+=======
+	"github.com/osmosis-labs/osmosis/v7/x/gamm/client/cli"
+	"github.com/osmosis-labs/osmosis/v7/x/gamm/keeper"
+	"github.com/osmosis-labs/osmosis/v7/x/gamm/pool-models/balancer"
+	"github.com/osmosis-labs/osmosis/v7/x/gamm/types"
+>>>>>>> f21e29eb (Delete unused simulator code (#1671))
 )
 
 var (
-	_ module.AppModule           = AppModule{}
-	_ module.AppModuleBasic      = AppModuleBasic{}
-	_ module.AppModuleSimulation = AppModule{}
+	_ module.AppModule      = AppModule{}
+	_ module.AppModuleBasic = AppModuleBasic{}
 )
 
 type AppModuleBasic struct {
@@ -160,36 +164,5 @@ func (am AppModule) EndBlock(ctx sdk.Context, _ abci.RequestEndBlock) []abci.Val
 	return []abci.ValidatorUpdate{}
 }
 
-// ___________________________________________________________________________
-
-// AppModuleSimulation functions
-
-// GenerateGenesisState creates a randomized GenState of the gamm module.
-// However, at launch the gamm module has no state, hence this is a no-op.
-func (AppModule) GenerateGenesisState(simState *module.SimulationState) {
-	// simulation.RandomizedGenState(simState)
-}
-
-// ProposalContents doesn't return any content functions for governance proposals.
-func (AppModule) ProposalContents(simState module.SimulationState) []simtypes.WeightedProposalContent {
-	return nil
-}
-
-// RandomizedParams creates randomized gamm param changes for the simulator.
-// There are no params that we view as sensible to randomize at the moment.
-func (AppModule) RandomizedParams(r *rand.Rand) []simtypes.ParamChange {
-	return nil
-	// return simulation.ParamChanges(r)
-}
-
-// RegisterStoreDecoder registers a decoder for supply module's types.
-func (am AppModule) RegisterStoreDecoder(sdr sdk.StoreDecoderRegistry) {
-}
-
-// WeightedOperations returns all the simulation operations with their respective weights.
-func (am AppModule) WeightedOperations(simState module.SimulationState) []simtypes.WeightedOperation {
-	return simulation.WeightedOperations(simState.AppParams, simState.Cdc, am.ak, am.bk, am.keeper)
-}
-
 // ConsensusVersion implements AppModule/ConsensusVersion.
 func (AppModule) ConsensusVersion() uint64 { return 1 }
diff --git a/x/mint/module.go b/x/mint/module.go
@@ -178,7 +178,7 @@ func (AppModule) ProposalContents(simState module.SimulationState) []simtypes.We
 
 // RandomizedParams creates randomized mint param changes for the simulator.
 func (AppModule) RandomizedParams(r *rand.Rand) []simtypes.ParamChange {
-	return simulation.ParamChanges(r)
+	return nil
 }
 
 // RegisterStoreDecoder registers a decoder for mint module's types.

diff --git a/x/mint/simulation/params.go b/x/mint/simulation/params.go
diff --git a/x/tokenfactory/module.go b/x/tokenfactory/module.go
@@ -4,7 +4,6 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
-	"math/rand"
 
 	"github.com/gorilla/mux"
 	"github.com/grpc-ecosystem/grpc-gateway/runtime"
@@ -17,7 +16,6 @@ import (
 	cdctypes "github.com/cosmos/cosmos-sdk/codec/types"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	"github.com/cosmos/cosmos-sdk/types/module"
-	simtypes "github.com/cosmos/cosmos-sdk/types/simulation"
 
 	"github.com/osmosis-labs/osmosis/v10/x/tokenfactory/client/cli"
 	"github.com/osmosis-labs/osmosis/v10/x/tokenfactory/keeper"
@@ -168,31 +166,3 @@ func (am AppModule) BeginBlock(_ sdk.Context, _ abci.RequestBeginBlock) {}
 func (am AppModule) EndBlock(_ sdk.Context, _ abci.RequestEndBlock) []abci.ValidatorUpdate {
 	return []abci.ValidatorUpdate{}
 }
-
-// ___________________________________________________________________________
-
-// AppModuleSimulation functions
-
-// GenerateGenesisState creates a randomized GenState of the tokenfactory module.
-func (am AppModule) GenerateGenesisState(simState *module.SimulationState) {
-	simState.GenState[types.ModuleName] = simState.Cdc.MustMarshalJSON(types.DefaultGenesis())
-}
-
-// ProposalContents doesn't return any content functions for governance proposals.
-func (am AppModule) ProposalContents(simState module.SimulationState) []simtypes.WeightedProposalContent {
-	return nil
-}
-
-// RandomizedParams creates randomized txfees param changes for the simulator.
-func (am AppModule) RandomizedParams(r *rand.Rand) []simtypes.ParamChange {
-	return nil
-}
-
-// RegisterStoreDecoder registers a decoder for tokenfactory module's types
-func (am AppModule) RegisterStoreDecoder(sdr sdk.StoreDecoderRegistry) {
-}
-
-// WeightedOperations returns simulator module operations with their respective weights.
-func (am AppModule) WeightedOperations(simState module.SimulationState) []simtypes.WeightedOperation {
-	return nil // TODO
-}