Skip to content
This repository has been archived by the owner on Jan 25, 2022. It is now read-only.

Commit

Permalink
API key documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
danielrea committed Jan 28, 2020
1 parent 20b0c05 commit 3a64117
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Expand Up @@ -39,7 +39,7 @@ module.exports = {

### MythX Account

By default, the plugin is configured with a MythX trial account that allows a limited number of requests. You can set up a free account on the [MythX website](https://mythx.io) to get full access.
You can set up a free account on the [MythX website](https://mythx.io) to get full access.

After setting up an account, set the following enviromment variables to your ETH address and password (add this to your `.bashrc` or `.bash_profile` for added convenience):

Expand All @@ -54,6 +54,14 @@ $env:MYTHX_ETH_ADDRESS="0x1234567891235678900000000000000000000000"
$env:MYTHX_PASSWORD="Put your password in here!"
```

### API Key

This is the recommended way of authenticating with the MythX smart contract analysis API. In the tools section there is an elements labeled “MythX API Key”. To generate a new API key, the account password must be entered:

This key can be passed to the MythX CLI either as an environment variable names MYTHX_API_KEY or as an explicit parameter --apiKey. For security reasons it is recommended to always pass the token through an environment variable, e.g. defined in the settings of a Continuous Integration (CI) server or a shell script that can be sourced from.



### Solc Version

You can specify which version of solc to use in `truffle-config.js` as explained in [truffle's documentation](https://truffleframework.com/docs/truffle/reference/configuration#solc). MythX for Truffle will use the same version of solc that Truffle uses to compile and analyze your contracts.
Expand Down

0 comments on commit 3a64117

Please sign in to comment.