[SPIKE] Better dev UX with simulations #20411

alpe · 2024-05-16T15:00:28Z

Description

🚧 WIP - early version

Registration example

func (am AppModule) WeightedOperations(simState module.SimulationState) []simtypes.WeightedOperation {
    ak, bk := am.accountKeeper, am.keeper
    reg := simsx.NewSimsRegistryAdapter(&simsx.BasicSimulationReporter{}, ak, bk, simState.TxConfig)
    weight := simsx.ParamWeightSource(simState.AppParams)
    reg.Add(weight.Get("msg_send", 100), simulation.MsgSendFactory(bk))
    reg.Add(weight.Get("msg_multisend", 10), simulation.MsgMultiSendFactory(bk))
    return reg.ToLegacyWeightedOperations()
}

Message factory example

func MsgSendFactory(bk keeper.Keeper) simsx.SimMsgFactoryFn[*types.MsgSend] {
	return func(ctx context.Context, testData *simsx.ChainDataSource, reporter simsx.SimulationReporter) ([]simsx.SimAccount, sdk.Msg) {
		from := testData.AnyAccount(reporter, simsx.WithSpendableBalance())
		to := testData.AnyAccount(reporter, simsx.ExcludeAccounts(from))
		coins := from.LiquidBalance().RandSubsetCoins(reporter, simsx.WithSendEnabledCoins(ctx, bk))
		return []simsx.SimAccount{from}, types.NewMsgSend(from.AddressBech32, to.AddressBech32, coins)
	}
}

or mixed with old sims setup

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

included the correct type prefix in the PR title
confirmed ! in the type prefix if API or client breaking change
targeted the correct branch (see PR Targeting)
provided a link to the relevant issue or specification
reviewed "Files changed" and left comments if necessary
included the necessary unit and integration tests
added a changelog entry to CHANGELOG.md
updated the relevant documentation or specification, including comments for documenting Go code
confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

confirmed the correct type prefix in the PR title
confirmed all author checklist items have been addressed
reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

coderabbitai · 2024-05-16T15:00:35Z

Important

Review Skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

* main: (95 commits) fix(x/accounts): check for overflows in multisig weights and votes (#20384) docs(x/account/auth): Improve error handling and comments in fee.go (#20426) docs: fix some markdown syntax (#20432) revert: bank change module to account change (#20427) fix: nil pointer panic when store don't exists in historical version (#20425) fix(store/v2): Remove should not error on miss (#20423) chore: upstream more changes from v2 (#20387) docs(x/auth/ante): fixed typo in TxWithTimeoutHeight interface name (#20418) fix: avoid default sendenabled for module accounts (#20419) docs(x/auth): fixed typo in command example for multisign transaction (#20417) build(deps): Bump bufbuild/buf-setup-action from 1.31.0 to 1.32.0 (#20413) build(deps): Bump github.com/hashicorp/go-plugin from 1.6.0 to 1.6.1 in /store (#20414) feat(x/accounts): Add schema caching feature and corresponding test case (#20055) refactor(runtime/v2): remove dependency on sdk (#20389) refactor!: turn MsgsV2 into ReflectMessages to make it less confusing (#19839) docs: Enhanced the ParsePagination method documentation (#20385) refactor(runtime,core): split router service (#20401) chore: fix spelling errors (#20400) docs: Documented error handling in OfferSnapshot method (#20380) build(deps): Bump google.golang.org/grpc from 1.63.2 to 1.64.0 (#20390) ...

types/simulation/rand_util.go

x/simulation/simulate.go

 params := RandomParams(r)

- fmt.Fprintf(w, "Starting SimulateFromSeed with randomness created with seed %d\n", int(config.Seed))
- fmt.Fprintf(w, "Randomized simulation params: \n%s\n", mustMarshalJSONIndent(params))
+ startTime := time.Now()


x/bank/module.go

- )
+ panic("old")
+
+ ak, bk := am.accountKeeper, am.keeper


x/protocolpool/depinject.go

- am.accountKeeper, am.bankKeeper, am.keeper,
- )
+ panic("old code")
+ ak, bk := am.accountKeeper, am.bankKeeper


simsx/reporter.go

+ for m, c := range s.reasons {
+ sb.WriteString(fmt.Sprintf("%s: %q\n", m, c))
+ }


alpe added 25 commits April 30, 2024 15:44

Enable in sims for PR

8b07a47

Start: use vanilla Go tests for sims

dba0ded

x

282ff4c

x

86edf2d

Run sims on dedicated box

47e4df9

x

eda02ad

x

ce1436a

x

93f5d47

x

dd06e2c

Add simple fuzz test

5941449

x

af0e9ef

x

9b614e1

Use fuzzer filled random source from #18946

2bdf61b

x

ce27b3b

x

88f2f8a

x

aa90d54

x

d8b03bf

x

86a1c9a

x

e55571c

x

58cb180

x

3d3f5c9

y

da4d0e3

x

fe89966

x

b3fac8e

x

db61a7a

github-actions bot added C:x/staking C:CLI C:x/gov C:x/slashing labels May 16, 2024

github-actions bot added C:x/distribution distribution module related C:x/mint C:Simulations C:x/bank C:x/auth C:x/evidence Type: Build Type: CI C:x/protocolpool C:x/epochs labels May 16, 2024

alpe added 2 commits May 17, 2024 14:14

x

96bf67a

x

788a1ac

github-actions bot added the C:x/authz label May 17, 2024

alpe added 5 commits May 21, 2024 16:10

Start fuzz

1214d23

x

40ca406

x

2438c69

x

02aee6f

github-advanced-security bot found potential problems May 23, 2024

View reviewed changes

types/simulation/rand_util.go Dismissed Show dismissed Hide dismissed

x/simulation/simulate.go Dismissed Show dismissed Hide dismissed

x/simulation/simulate.go Dismissed Show dismissed Hide dismissed

github-advanced-security bot found potential problems May 23, 2024

View reviewed changes

alpe added 3 commits May 23, 2024 14:23

x

553511f

x

a562285

x

e2ed3d1

github-advanced-security bot found potential problems May 24, 2024

View reviewed changes

x

6a3df96

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[SPIKE] Better dev UX with simulations #20411

[SPIKE] Better dev UX with simulations #20411

alpe commented May 16, 2024 •

edited

coderabbitai bot commented May 16, 2024 •

edited

Review Skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

[SPIKE] Better dev UX with simulations #20411

Are you sure you want to change the base?

[SPIKE] Better dev UX with simulations #20411

Conversation

alpe commented May 16, 2024 • edited

Description

Author Checklist

Reviewers Checklist

coderabbitai bot commented May 16, 2024 • edited

Review Skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

alpe commented May 16, 2024 •

edited

coderabbitai bot commented May 16, 2024 •

edited

CodeRabbit Configration File (`.coderabbit.yaml`)