Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: gov sims to use v1beta2 #11069

Merged
merged 8 commits into from
Feb 2, 2022
Merged

refactor: gov sims to use v1beta2 #11069

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
f1fb496
refactor: gov sims
atheeshp Jan 31, 2022
cf3c6d7
fix sims
atheeshp Jan 31, 2022
a1371b1
fix tests
atheeshp Jan 31, 2022
dbeb3a4
fix tests
atheeshp Feb 1, 2022
771adf7
fix tests
atheeshp Feb 1, 2022
4d99d73
Merge branch 'master' into ap/refactor-gov-sim
atheeshp Feb 1, 2022
05e747d
Merge branch 'master' into ap/refactor-gov-sim
cmwaters Feb 2, 2022
4de48e5
Merge branch 'master' into ap/refactor-gov-sim
mergify[bot] Feb 2, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
88 changes: 51 additions & 37 deletions x/gov/simulation/operations.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,20 @@ import (
simtypes "github.com/cosmos/cosmos-sdk/types/simulation"
"github.com/cosmos/cosmos-sdk/x/gov/keeper"
"github.com/cosmos/cosmos-sdk/x/gov/types"
"github.com/cosmos/cosmos-sdk/x/gov/types/v1beta1"
"github.com/cosmos/cosmos-sdk/x/gov/types/v1beta2"
"github.com/cosmos/cosmos-sdk/x/simulation"
)

var initialProposalID = uint64(100000000000000)

// Governance message types and routes
var (
TypeMsgDeposit = sdk.MsgTypeURL(&v1beta2.MsgDeposit{})
TypeMsgVote = sdk.MsgTypeURL(&v1beta2.MsgVote{})
TypeMsgVoteWeighted = sdk.MsgTypeURL(&v1beta2.MsgVoteWeighted{})
TypeMsgSubmitProposal = sdk.MsgTypeURL(&v1beta2.MsgSubmitProposal{})
)

// Simulation operation weights constants
const (
OpWeightMsgDeposit = "op_weight_msg_deposit"
Expand Down Expand Up @@ -126,19 +134,25 @@ func SimulateMsgSubmitProposal(
// 1) submit proposal now
content := contentSim(r, ctx, accs)
if content == nil {
return simtypes.NoOpMsg(types.ModuleName, v1beta1.TypeMsgSubmitProposal, "content is nil"), nil, nil
return simtypes.NoOpMsg(types.ModuleName, TypeMsgSubmitProposal, "content is nil"), nil, nil
}

simAccount, _ := simtypes.RandomAcc(r, accs)
deposit, skip, err := randomDeposit(r, ctx, ak, bk, k, simAccount.Address)
switch {
case skip:
return simtypes.NoOpMsg(types.ModuleName, v1beta1.TypeMsgSubmitProposal, "skip deposit"), nil, nil
return simtypes.NoOpMsg(types.ModuleName, TypeMsgSubmitProposal, "skip deposit"), nil, nil
case err != nil:
return simtypes.NoOpMsg(types.ModuleName, v1beta1.TypeMsgSubmitProposal, "unable to generate deposit"), nil, err
return simtypes.NoOpMsg(types.ModuleName, TypeMsgSubmitProposal, "unable to generate deposit"), nil, err
}

macc := k.GetGovernanceAccount(ctx)
contentMsg, err := v1beta2.NewLegacyContent(content, macc.GetAddress().String())
if err != nil {
return simtypes.NoOpMsg(types.ModuleName, TypeMsgSubmitProposal, "error converting legacy content into proposal message"), nil, err
}

msg, err := v1beta1.NewMsgSubmitProposal(content, deposit, simAccount.Address)
msg, err := v1beta2.NewMsgSubmitProposal([]sdk.Msg{contentMsg}, deposit, simAccount.Address.String(), nil)
if err != nil {
return simtypes.NoOpMsg(types.ModuleName, msg.Type(), "unable to generate a submit proposal msg"), nil, err
}
Expand Down Expand Up @@ -215,20 +229,20 @@ func SimulateMsgDeposit(ak types.AccountKeeper, bk types.BankKeeper, k keeper.Ke
accs []simtypes.Account, chainID string,
) (simtypes.OperationMsg, []simtypes.FutureOperation, error) {
simAccount, _ := simtypes.RandomAcc(r, accs)
proposalID, ok := randomProposalID(r, k, ctx, v1beta1.StatusDepositPeriod)
proposalID, ok := randomProposalID(r, k, ctx, v1beta2.StatusDepositPeriod)
if !ok {
return simtypes.NoOpMsg(types.ModuleName, v1beta1.TypeMsgDeposit, "unable to generate proposalID"), nil, nil
return simtypes.NoOpMsg(types.ModuleName, TypeMsgDeposit, "unable to generate proposalID"), nil, nil
}

deposit, skip, err := randomDeposit(r, ctx, ak, bk, k, simAccount.Address)
switch {
case skip:
return simtypes.NoOpMsg(types.ModuleName, v1beta1.TypeMsgDeposit, "skip deposit"), nil, nil
return simtypes.NoOpMsg(types.ModuleName, TypeMsgDeposit, "skip deposit"), nil, nil
case err != nil:
return simtypes.NoOpMsg(types.ModuleName, v1beta1.TypeMsgDeposit, "unable to generate deposit"), nil, err
return simtypes.NoOpMsg(types.ModuleName, TypeMsgDeposit, "unable to generate deposit"), nil, err
}

msg := v1beta1.NewMsgDeposit(simAccount.Address, proposalID, deposit)
msg := v1beta2.NewMsgDeposit(simAccount.Address, proposalID, deposit)

account := ak.GetAccount(ctx, simAccount.Address)
spendable := bk.SpendableCoins(ctx, account.GetAddress())
Expand Down Expand Up @@ -278,16 +292,16 @@ func operationSimulateMsgVote(ak types.AccountKeeper, bk types.BankKeeper, k kee
switch {
case proposalIDInt < 0:
var ok bool
proposalID, ok = randomProposalID(r, k, ctx, v1beta1.StatusVotingPeriod)
proposalID, ok = randomProposalID(r, k, ctx, v1beta2.StatusVotingPeriod)
if !ok {
return simtypes.NoOpMsg(types.ModuleName, v1beta1.TypeMsgVote, "unable to generate proposalID"), nil, nil
return simtypes.NoOpMsg(types.ModuleName, TypeMsgVote, "unable to generate proposalID"), nil, nil
}
default:
proposalID = uint64(proposalIDInt)
}

option := randomVotingOption(r)
msg := v1beta1.NewMsgVote(simAccount.Address, proposalID, option)
msg := v1beta2.NewMsgVote(simAccount.Address, proposalID, option)

account := ak.GetAccount(ctx, simAccount.Address)
spendable := bk.SpendableCoins(ctx, account.GetAddress())
Expand Down Expand Up @@ -331,16 +345,16 @@ func operationSimulateMsgVoteWeighted(ak types.AccountKeeper, bk types.BankKeepe
switch {
case proposalIDInt < 0:
var ok bool
proposalID, ok = randomProposalID(r, k, ctx, v1beta1.StatusVotingPeriod)
proposalID, ok = randomProposalID(r, k, ctx, v1beta2.StatusVotingPeriod)
if !ok {
return simtypes.NoOpMsg(types.ModuleName, v1beta1.TypeMsgVoteWeighted, "unable to generate proposalID"), nil, nil
return simtypes.NoOpMsg(types.ModuleName, TypeMsgVoteWeighted, "unable to generate proposalID"), nil, nil
}
default:
proposalID = uint64(proposalIDInt)
}

options := randomWeightedVotingOptions(r)
msg := v1beta1.NewMsgVoteWeighted(simAccount.Address, proposalID, options)
msg := v1beta2.NewMsgVoteWeighted(simAccount.Address, proposalID, options)

account := ak.GetAccount(ctx, simAccount.Address)
spendable := bk.SpendableCoins(ctx, account.GetAddress())
Expand Down Expand Up @@ -405,7 +419,7 @@ func randomDeposit(r *rand.Rand, ctx sdk.Context,
// that matches a given Status.
// It does not provide a default ID.
func randomProposalID(r *rand.Rand, k keeper.Keeper,
ctx sdk.Context, status v1beta1.ProposalStatus) (proposalID uint64, found bool) {
ctx sdk.Context, status v1beta2.ProposalStatus) (proposalID uint64, found bool) {
proposalID, _ = k.GetProposalID(ctx)

switch {
Expand All @@ -420,58 +434,58 @@ func randomProposalID(r *rand.Rand, k keeper.Keeper,
}

proposal, ok := k.GetProposal(ctx, proposalID)
if !ok || v1beta1.ProposalStatus(proposal.Status) != status {
if !ok || v1beta2.ProposalStatus(proposal.Status) != status {
return proposalID, false
}

return proposalID, true
}

// Pick a random voting option
func randomVotingOption(r *rand.Rand) v1beta1.VoteOption {
func randomVotingOption(r *rand.Rand) v1beta2.VoteOption {
switch r.Intn(4) {
case 0:
return v1beta1.OptionYes
return v1beta2.OptionYes
case 1:
return v1beta1.OptionAbstain
return v1beta2.OptionAbstain
case 2:
return v1beta1.OptionNo
return v1beta2.OptionNo
case 3:
return v1beta1.OptionNoWithVeto
return v1beta2.OptionNoWithVeto
default:
panic("invalid vote option")
}
}

// Pick a random weighted voting options
func randomWeightedVotingOptions(r *rand.Rand) v1beta1.WeightedVoteOptions {
func randomWeightedVotingOptions(r *rand.Rand) v1beta2.WeightedVoteOptions {
w1 := r.Intn(100 + 1)
w2 := r.Intn(100 - w1 + 1)
w3 := r.Intn(100 - w1 - w2 + 1)
w4 := 100 - w1 - w2 - w3
weightedVoteOptions := v1beta1.WeightedVoteOptions{}
weightedVoteOptions := v1beta2.WeightedVoteOptions{}
if w1 > 0 {
weightedVoteOptions = append(weightedVoteOptions, v1beta1.WeightedVoteOption{
Option: v1beta1.OptionYes,
Weight: sdk.NewDecWithPrec(int64(w1), 2),
weightedVoteOptions = append(weightedVoteOptions, &v1beta2.WeightedVoteOption{
Option: v1beta2.OptionYes,
Weight: sdk.NewDecWithPrec(int64(w1), 2).String(),
})
}
if w2 > 0 {
weightedVoteOptions = append(weightedVoteOptions, v1beta1.WeightedVoteOption{
Option: v1beta1.OptionAbstain,
Weight: sdk.NewDecWithPrec(int64(w2), 2),
weightedVoteOptions = append(weightedVoteOptions, &v1beta2.WeightedVoteOption{
Option: v1beta2.OptionAbstain,
Weight: sdk.NewDecWithPrec(int64(w2), 2).String(),
})
}
if w3 > 0 {
weightedVoteOptions = append(weightedVoteOptions, v1beta1.WeightedVoteOption{
Option: v1beta1.OptionNo,
Weight: sdk.NewDecWithPrec(int64(w3), 2),
weightedVoteOptions = append(weightedVoteOptions, &v1beta2.WeightedVoteOption{
Option: v1beta2.OptionNo,
Weight: sdk.NewDecWithPrec(int64(w3), 2).String(),
})
}
if w4 > 0 {
weightedVoteOptions = append(weightedVoteOptions, v1beta1.WeightedVoteOption{
Option: v1beta1.OptionNoWithVeto,
Weight: sdk.NewDecWithPrec(int64(w4), 2),
weightedVoteOptions = append(weightedVoteOptions, &v1beta2.WeightedVoteOption{
Option: v1beta2.OptionNoWithVeto,
Weight: sdk.NewDecWithPrec(int64(w4), 2).String(),
})
}
return weightedVoteOptions
Expand Down
Loading