truffle-plugin-verify

This truffle plugin allows you to automatically verify your smart contracts source code on Etherscan, straight from the Truffle CLI.

Attention: This plugin is a very early work in progress, all information in this README is subject to change while in alpha.

Installation

Install the plugin with npm

npm install truffle-plugin-verify

Add the plugin to your truffle.js or truffle-config.js file

module.exports = {
  /* ... rest of truffle-config */

  plugins: [
    'truffle-plugin-verify'
  ]
}

Generate an API Key on your Etherscan account (see the Etherscan website)
Add your Etherscan API key to your truffle config (use something like dotenv to make sure you don't commit the api key)

module.exports = {
  /* ... rest of truffle-config */

  api_keys: {
    etherscan: 'MY_API_KEY'
  }
}

Usage

truffle run verify SmartContractName [--network networkName]

The network parameter should correspond to a network defined in the Truffle config file, with the correct network id set. The Ethereum main net and all public testnets are supported.

For example, if we defined rinkeby as network in Truffle, and we wish to verify the SimpleStorage contract:

truffle run verify SimpleStorage --network rinkeby

This can take some time, and will eventually either return Pass - Verified or Fail - Unable to verify.

Notes

This plugin gets compiler optimisation settings from the truffle config file, so make sure that your truffle config settings are the same as when your contracts were compiled.

Limitations & Roadmap

This plugin is in a very early version, so there is still functionality missing. Below is a non-exhaustive list of features that are currently missing from the plugin, that will be added in a later release.

The plugin has no graceful error handling, so be sure to follow the usage exactly
The plugin can only verify one smart contract at a time, instead of automatically verifying all deployed contracts
There is no automatic testing / build process in place

Support