add getting started guide #153
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
daejunpark
force-pushed
the
docs/getting-started
branch
from
f40f7a4
to
fb31c42
Compare
docs/getting-started.md
Outdated
|
|
||
| - You need to be careful not to exclude valid inputs by setting too strong input conditions. | ||
|
|
||
| - In symbolic tests, avoid using `bound()` as it tends to perform poorly. Instead, use `vm.assume()` which is more efficient and easier to read and write. |
There was a problem hiding this comment.
I would give an example like this:
uint256 tokenId = svm.createSymbolicUint256("tokenId");
// ❌ don't do this
tokenId = bound(tokenId, 1, MAX_TOKEN_ID);
// ✅ do this
vm.assume(1 <= tokenId && tokenId <= MAX_TOKEN_ID);
unfortunaly the bad pattern is more concise than our recommended pattern, maybe we want to introduce svm.bound(val, min, max)?
Comment on lines
+207
to
+209
| (bool success,) = address(token).call( | ||
| abi.encodeWithSelector(token.transfer.selector, receiver, amount) | ||
| ); |
There was a problem hiding this comment.
do you want to add assert(!success) in the example?
that's something we could probably be doing by implementing vm.expectRevert(), right?
karmacoma-eth
approved these changes
Jul 31, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.