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.

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

feat(invariant): add statefulFuzz as an alias to invariant #4922

Merged
merged 2 commits into from
May 11, 2023

Conversation

Evalir
Copy link
Member

@Evalir Evalir commented May 11, 2023

Motivation

Closes #4650

There's been repeated discussion about how to call fuzz/invariant tests. One of the things proposed for invariants is to add some alias that could be used instead of invariant to more properly narrow down its meaning, without necessarily removing the usage of invariant yet.

Solution

Adds statefulFuzz as an alias to invariant, as suggested in the linked issue.

I personally do not have strong opinions on what alias we should use, and statefulFuzz feels a tad long—feel free to nitpick!

Proposed plan is:

  • Foundry 1.0 will support both.
  • Foundry 1.1+ will support both, but will warn users that invariant might not be supported in a future 2.0 release.
  • Foundry 2.0 and beyond: remove the invariant keyword.

@Evalir Evalir requested review from mds1, gakonst and mattsse May 11, 2023 03:31
@Evalir Evalir changed the title feat(tests): add statefulFuzz as an alias to invariant feat(invariant): add statefulFuzz as an alias to invariant May 11, 2023
Copy link
Member

@mattsse mattsse left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm,
ok with merging this now

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add alternative to invariant keyword
2 participants