embarklabs
/
embark-mythx
mirror of https://github.com/embarklabs/embark-mythx.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

chore: readme update

This commit is contained in:
emizzle 2020-04-08 09:51:10 +10:00
parent 75affcdd44
commit f31c6c7ed6
No known key found for this signature in database
GPG Key ID: 1FD4BAB3C37EE9BA
2 changed files with 9 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -46,20 +46,14 @@ Bank.sol
14:28 warning A call to a user-supplied address is executed https://swcregistry.io/docs/SWC-107 14:28 warning A call to a user-supplied address is executed https://swcregistry.io/docs/SWC-107
1:0 warning A floating pragma is set https://swcregistry.io/docs/SWC-103 1:0 warning A floating pragma is set https://swcregistry.io/docs/SWC-103
<unknown> ✖ 3 problems (1 error, 2 warnings)
-1:0 warning You are running MythX in free mode. Analysis depth is limited in this mode so some issues might not be detected. Upgrade to a Dev or Pro plan to unlock in-depth analysis and higher rate limits. https://mythx.io/plans N/A
✖ 4 problems (1 error, 3 warnings)
Rendering Hack analysis report... Rendering Hack analysis report...
Hack.sol Hack.sol
1:0 warning A floating pragma is set https://swcregistry.io/SWC-registry/docs/SWC-103 1:0 warning A floating pragma is set https://swcregistry.io/SWC-registry/docs/SWC-103
<unknown> ✖ 1 problem (0 errors, 1 warning)
-1:0 warning You are running MythX in free mode. Analysis depth is limited in this mode so some issues might not be detected. Upgrade to a Dev or Pro plan to unlock in-depth analysis and higher rate limits. https://mythx.io/plans N/A
✖ 2 problems (0 errors, 2 warnings)
Done! Done!
``` ```
@ -109,7 +103,7 @@ Verify options
-c, --no-cache-lookup Deactivate MythX cache lookups (default: false). -c, --no-cache-lookup Deactivate MythX cache lookups (default: false).
-d, --debug Print MythX API request and response. -d, --debug Print MythX API request and response.
-l, --limit number Maximum number of concurrent analyses (default: 10). -l, --limit number Maximum number of concurrent analyses (default: 10).
--timeout number Timeout in secs to wait for analysis to finish (default: smart default based -t, --timeout number Timeout in secs to wait for analysis to finish (default: smart default based
on mode). on mode).
``` ```
@ -120,10 +114,13 @@ Verify options
$ verify $ verify
# 'ERC20' and 'Ownable' full analysis # 'ERC20' and 'Ownable' full analysis
$ verify ERC20 Ownable --full $ verify --mode full ERC20 Ownable
# Check status of previous or ongoing analysis # Check status of previous or ongoing analysis
$ verify status ef5bb083-c57a-41b0-97c1-c14a54617812 $ verify status ef5bb083-c57a-41b0-97c1-c14a54617812
# Get list of 20 previous analyses
$ verify list
``` ```
## `embark-mythx` Development ## `embark-mythx` Development

4
package.json
View File

@ -18,8 +18,8 @@
"embark", "embark",
"embark-plugin", "embark-plugin",
"mythx", "mythx",
"smart contract", "smart-contract",
"security analysis", "security-analysis",
"solidity" "solidity"
], ],
"main": "dist/index.js", "main": "dist/index.js",