crytic / crytic/crytic-compile

Document platform formats and export formats

Open
#481 0 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Python
Stars
197
Forks
97
PR merge metrics
No merged PRs in 30d

Description

There's several platforms and export formats that are not documented. It would be great to understand what is legacy and what is the correct choice if one uses the format today i.e. how to make a selection
```
--export-format EXPORT_FORMAT
Export json with non crytic-compile format (default None. Accepted: (standard, crytic-compile, solc, truffle, archive)
```
It's also unclear what is the difference between `solc-json` and `standard` for the platforms since it sounds like they could both use the solc standard json format

Contributor guide

Open the contributing guide

Research direction

Start with the CLI help entry for --export-format and the platform and export-format definitions referenced by the issue. Trace the accepted values, including solc-json and standard, to determine which are legacy and which should be selected today. Done means the documentation explains each platform and export format, their differences, and how to choose among them.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.