Skip to content
Verify your deployed smart contracts on Etherscan from the Truffle CLI
Branch: master
Clone or download
Latest commit 9cac00a Jun 12, 2019

README.md

truffle-plugin-verify

NPM Version NPM Monthly Downloads NPM License

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

I wrote a tutorial on my website that goes through the entire process of installing and using this plugin.

Installation

  1. Install the plugin with npm
npm install truffle-plugin-verify
  1. Add the plugin to your truffle.js or truffle-config.js file
module.exports = {
  /* ... rest of truffle-config */

  plugins: [
    'truffle-plugin-verify'
  ]
}
  1. Generate an API Key on your Etherscan account (see the Etherscan website)
  2. Add your Etherscan API key to your truffle config (make sure to use something like dotenv so you don't commit the api key)
module.exports = {
  /* ... rest of truffle-config */

  api_keys: {
    etherscan: 'MY_API_KEY'
  }
}

Usage

Before running verification, make sure that you have actually deployed a contract to a public network with Truffle. After deployment, run the following command for every contract you wish to verify.

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 mainnet 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. Since the information we get from the Etherscan API is quite limited, it is currently impossible to retrieve any more information on verification failure. There should be no reason though why the verification should fail if the usage is followed correctly. If you do receive a Fail - Unable to verify and you are sure that you followed the instructions correctly, please open an issue and I will look into it.

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.

Donations

If you''ve used this plugin and found it helpful in your workflow, please consider sending some Ξ or tokens to 0xe126b3E5d052f1F575828f61fEBA4f4f2603652a.

You can’t perform that action at this time.