Add simsx support to modules

Author: alpe

simapp/sim_bench_test.go

@@ -48,7 +48,7 @@ func BenchmarkFullAppSimulation(b *testing.B) {
 	app := NewSimApp(logger, db, nil, true, appOptions, interBlockCacheOpt(), baseapp.SetChainID(simsx.SimAppChainID))
 
 	// run randomized simulation
-	simParams,_, simErr := simulation.SimulateFromSeedX(
+	simParams, _, simErr := simulation.SimulateFromSeedX(
 		b,
 		log.NewNopLogger(),
 		os.Stdout,

simsx/delivery.go

@@ -7,7 +7,6 @@ import (
 	"math/rand"
 
 	"github.com/cosmos/cosmos-sdk/baseapp"
-
 	"github.com/cosmos/cosmos-sdk/client"
 	cryptotypes "github.com/cosmos/cosmos-sdk/crypto/types"
 	"github.com/cosmos/cosmos-sdk/testutil/sims"

simsx/environment.go

@@ -289,7 +289,7 @@ func NewChainDataSource(
 // AnyAccount returns a random SimAccount matching the filter criteria. Module accounts are excluded.
 // In case of an error or no matching account found, the reporter is set to skip and an empty value is returned.
 func (c *ChainDataSource) AnyAccount(r SimulationReporter, filters ...SimAccountFilter) SimAccount {
-	acc := c.randomAccount(r, 5, filters...)
+	acc := c.randomAccount(r, 1, filters...)
 	return acc
 }
 

simsx/runner.go

@@ -9,8 +9,6 @@ import (
 	"strings"
 	"testing"
 
-	servertypes "github.com/cosmos/cosmos-sdk/server/types"
-
 	dbm "github.com/cosmos/cosmos-db"
 	"github.com/stretchr/testify/require"
 
@@ -21,6 +19,7 @@ import (
 	"github.com/cosmos/cosmos-sdk/client/flags"
 	"github.com/cosmos/cosmos-sdk/codec"
 	"github.com/cosmos/cosmos-sdk/runtime"
+	servertypes "github.com/cosmos/cosmos-sdk/server/types"
 	simtestutil "github.com/cosmos/cosmos-sdk/testutil/sims"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	"github.com/cosmos/cosmos-sdk/types/module"

x/auth/module.go

@@ -16,6 +16,7 @@ import (
 	"github.com/cosmos/cosmos-sdk/client"
 	"github.com/cosmos/cosmos-sdk/codec"
 	codectypes "github.com/cosmos/cosmos-sdk/codec/types"
+	"github.com/cosmos/cosmos-sdk/simsx"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	"github.com/cosmos/cosmos-sdk/types/module"
 	simtypes "github.com/cosmos/cosmos-sdk/types/simulation"
@@ -171,10 +172,16 @@ func (am AppModule) GenerateGenesisState(simState *module.SimulationState) {
 }
 
 // ProposalMsgs returns msgs used for governance proposals for simulations.
+// Deprecated: migrate to ProposalMsgsX. This method is ignored when ProposalMsgsX exists and will be removed in the future.
 func (AppModule) ProposalMsgs(simState module.SimulationState) []simtypes.WeightedProposalMsg {
 	return simulation.ProposalMsgs()
 }
 
+// ProposalMsgsX registers governance proposal messages in the simulation registry.
+func (AppModule) ProposalMsgsX(weights simsx.WeightSource, reg simsx.Registry) {
+	reg.Add(weights.Get("msg_update_params", 100), simulation.MsgUpdateParamsFactory())
+}
+
 // RegisterStoreDecoder registers a decoder for auth module's types
 func (am AppModule) RegisterStoreDecoder(sdr simtypes.StoreDecoderRegistry) {
 	sdr[types.StoreKey] = simtypes.NewStoreDecoderFuncFromCollectionsSchema(am.accountKeeper.Schema)

x/auth/simulation/genesis.go

@@ -1,8 +1,6 @@
 package simulation
 
 import (
-	"encoding/json"
-	"fmt"
 	"math/rand"
 
 	sdk "github.com/cosmos/cosmos-sdk/types"
@@ -112,11 +110,5 @@ func RandomizedGenState(simState *module.SimulationState, randGenAccountsFn type
 	genesisAccs := randGenAccountsFn(simState)
 
 	authGenesis := types.NewGenesisState(params, genesisAccs)
-
-	bz, err := json.MarshalIndent(&authGenesis.Params, "", " ")
-	if err != nil {
-		panic(err)
-	}
-	fmt.Printf("Selected randomly generated auth parameters:\n%s\n", bz)
 	simState.GenState[types.ModuleName] = simState.Cdc.MustMarshalJSON(authGenesis)
 }

x/auth/simulation/msg_factory.go

@@ -0,0 +1,25 @@
+package simulation
+
+import (
+	"context"
+
+	"github.com/cosmos/cosmos-sdk/simsx"
+	"github.com/cosmos/cosmos-sdk/x/auth/types"
+)
+
+func MsgUpdateParamsFactory() simsx.SimMsgFactoryFn[*types.MsgUpdateParams] {
+	return func(_ context.Context, testData *simsx.ChainDataSource, reporter simsx.SimulationReporter) ([]simsx.SimAccount, *types.MsgUpdateParams) {
+		r := testData.Rand()
+		params := types.DefaultParams()
+		params.MaxMemoCharacters = r.Uint64InRange(1, 1000)
+		params.TxSigLimit = r.Uint64InRange(1, 1000)
+		params.TxSizeCostPerByte = r.Uint64InRange(1, 1000)
+		params.SigVerifyCostED25519 = r.Uint64InRange(1, 1000)
+		params.SigVerifyCostSecp256k1 = r.Uint64InRange(1, 1000)
+
+		return nil, &types.MsgUpdateParams{
+			Authority: testData.ModuleAccountAddress(reporter, "gov"),
+			Params:    params,
+		}
+	}
+}

x/auth/simulation/proposals.go

@@ -11,13 +11,14 @@ import (
 )
 
 // Simulation operation weights constants
+// Deprecated: will be removed in the future
 const (
 	DefaultWeightMsgUpdateParams int = 100
-
-	OpWeightMsgUpdateParams = "op_weight_msg_update_params"
+	OpWeightMsgUpdateParams          = "op_weight_msg_update_params"
 )
 
 // ProposalMsgs defines the module weighted proposals' contents
+// Deprecated: migrate to MsgUpdateParamsFactory instead
 func ProposalMsgs() []simtypes.WeightedProposalMsg {
 	return []simtypes.WeightedProposalMsg{
 		simulation.NewWeightedProposalMsg(
@@ -29,6 +30,7 @@ func ProposalMsgs() []simtypes.WeightedProposalMsg {
 }
 
 // SimulateMsgUpdateParams returns a random MsgUpdateParams
+// Deprecated: will be removed in the future
 func SimulateMsgUpdateParams(r *rand.Rand, _ sdk.Context, _ []simtypes.Account) sdk.Msg {
 	// use the default gov module account address as authority
 	var authority sdk.AccAddress = address.Module("gov")

x/authz/module/module.go

@@ -19,6 +19,7 @@ import (
 	sdkclient "github.com/cosmos/cosmos-sdk/client"
 	"github.com/cosmos/cosmos-sdk/codec"
 	cdctypes "github.com/cosmos/cosmos-sdk/codec/types"
+	"github.com/cosmos/cosmos-sdk/simsx"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	"github.com/cosmos/cosmos-sdk/types/module"
 	simtypes "github.com/cosmos/cosmos-sdk/types/simulation"
@@ -196,10 +197,18 @@ func (am AppModule) RegisterStoreDecoder(sdr simtypes.StoreDecoderRegistry) {
 }
 
 // WeightedOperations returns the all the gov module operations with their respective weights.
+// Deprecated: migrate to WeightedOperationsX. This method is ignored when WeightedOperationsX exists and will be removed in the future
 func (am AppModule) WeightedOperations(simState module.SimulationState) []simtypes.WeightedOperation {
 	return simulation.WeightedOperations(
 		am.registry,
 		simState.AppParams, simState.Cdc, simState.TxConfig,
 		am.accountKeeper, am.bankKeeper, am.keeper,
 	)
 }
+
+// WeightedOperationsX registers weighted authz module operations for simulation.
+func (am AppModule) WeightedOperationsX(weights simsx.WeightSource, reg simsx.Registry) {
+	reg.Add(weights.Get("msg_grant", 100), simulation.MsgGrantFactory())
+	reg.Add(weights.Get("msg_revoke", 90), simulation.MsgRevokeFactory(am.keeper))
+	reg.Add(weights.Get("msg_exec", 90), simulation.MsgExecFactory(am.keeper))
+}

x/authz/simulation/msg_factory.go

@@ -0,0 +1,104 @@
+package simulation
+
+import (
+	"context"
+	"time"
+
+	"github.com/cosmos/cosmos-sdk/simsx"
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	"github.com/cosmos/cosmos-sdk/x/authz"
+	"github.com/cosmos/cosmos-sdk/x/authz/keeper"
+	banktype "github.com/cosmos/cosmos-sdk/x/bank/types"
+)
+
+func MsgGrantFactory() simsx.SimMsgFactoryFn[*authz.MsgGrant] {
+	return func(ctx context.Context, testData *simsx.ChainDataSource, reporter simsx.SimulationReporter) ([]simsx.SimAccount, *authz.MsgGrant) {
+		granter := testData.AnyAccount(reporter, simsx.WithSpendableBalance())
+		grantee := testData.AnyAccount(reporter, simsx.ExcludeAccounts(granter))
+		spendLimit := granter.LiquidBalance().RandSubsetCoins(reporter, simsx.WithSendEnabledCoins())
+
+		r := testData.Rand()
+		var expiration *time.Time
+		if t1 := r.Timestamp(); !t1.Before(simsx.BlockTime(ctx)) {
+			expiration = &t1
+		}
+		// pick random authorization
+		authorizations := []authz.Authorization{
+			banktype.NewSendAuthorization(spendLimit, nil),
+			authz.NewGenericAuthorization(sdk.MsgTypeURL(&banktype.MsgSend{})),
+		}
+		randomAuthz := simsx.OneOf(r, authorizations)
+
+		msg, err := authz.NewMsgGrant(granter.Address, grantee.Address, randomAuthz, expiration)
+		if err != nil {
+			reporter.Skip(err.Error())
+			return nil, nil
+		}
+		return []simsx.SimAccount{granter}, msg
+	}
+}
+
+func MsgExecFactory(k keeper.Keeper) simsx.SimMsgFactoryFn[*authz.MsgExec] {
+	return func(ctx context.Context, testData *simsx.ChainDataSource, reporter simsx.SimulationReporter) ([]simsx.SimAccount, *authz.MsgExec) {
+		bankSendOnlyFilter := func(a authz.Authorization) bool {
+			_, ok := a.(*banktype.SendAuthorization)
+			return ok
+		}
+		granterAddr, granteeAddr, gAuthz := findGrant(ctx, k, reporter, bankSendOnlyFilter)
+		granter := testData.GetAccountbyAccAddr(reporter, granterAddr)
+		grantee := testData.GetAccountbyAccAddr(reporter, granteeAddr)
+		if reporter.IsSkipped() {
+			return nil, nil
+		}
+		amount := granter.LiquidBalance().RandSubsetCoins(reporter, simsx.WithSendEnabledCoins())
+		amount = amount.Min(gAuthz.(*banktype.SendAuthorization).SpendLimit)
+
+		payloadMsg := []sdk.Msg{banktype.NewMsgSend(granter.Address, grantee.Address, amount)}
+		msgExec := authz.NewMsgExec(grantee.Address, payloadMsg)
+		return []simsx.SimAccount{grantee}, &msgExec
+	}
+}
+
+func MsgRevokeFactory(k keeper.Keeper) simsx.SimMsgFactoryFn[*authz.MsgRevoke] {
+	return func(ctx context.Context, testData *simsx.ChainDataSource, reporter simsx.SimulationReporter) ([]simsx.SimAccount, *authz.MsgRevoke) {
+		granterAddr, granteeAddr, auth := findGrant(ctx, k, reporter)
+		granter := testData.GetAccountbyAccAddr(reporter, granterAddr)
+		grantee := testData.GetAccountbyAccAddr(reporter, granteeAddr)
+		if reporter.IsSkipped() {
+			return nil, nil
+		}
+		msgExec := authz.NewMsgRevoke(granter.Address, grantee.Address, auth.MsgTypeURL())
+		return []simsx.SimAccount{granter}, &msgExec
+	}
+}
+
+func findGrant(
+	ctx context.Context,
+	k keeper.Keeper,
+	reporter simsx.SimulationReporter,
+	acceptFilter ...func(a authz.Authorization) bool,
+) (granterAddr, granteeAddr sdk.AccAddress, auth authz.Authorization) {
+	var innerErr error
+	k.IterateGrants(ctx, func(granter, grantee sdk.AccAddress, grant authz.Grant) bool {
+		a, err2 := grant.GetAuthorization()
+		if err2 != nil {
+			innerErr = err2
+			return true
+		}
+		for _, filter := range acceptFilter {
+			if !filter(a) {
+				return false
+			}
+		}
+		granterAddr, granteeAddr, auth = granter, grantee, a
+		return true
+	})
+	if innerErr != nil {
+		reporter.Skip(innerErr.Error())
+		return
+	}
+	if auth == nil {
+		reporter.Skip("no grant found")
+	}
+	return
+}