truffle-verify v1.0.8

truffle-verify

Thanks to Rosco Kalis for the heavy lifting.

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

NOTE: The main difference between truffle-verify and truffle-plugin-verify is that truffle-verify verifies particular contracts amongst a flattened source file.

Installation

1. Install the plugin with npm

   npm install truffle-verify

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

   module.exports = {
     /* ... rest of truffle-config */
   
     plugins: [
       'truffle-verify'
     ]
   }

3. Generate an API Key on your Etherscan account (see the Etherscan website)

4. 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 your contracts to a public network with Truffle. After deployment, run the following command with one or more contracts that you wish to verify:

truffle run verify <SomeContractName> <AnotherContractName>... <FlattenedSource.sol> --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 main 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 flattened/Flattened.sol --network rinkeby

This can take some time, and will eventually either return

Pass - Verified or Fail - Unable to verify for each contract.

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.

Address override (Optional)

You can optionally provide an explicit address of the contract(s) that you wish to verify. This may be useful when you have deployed multiple instances of the same contract. The address is appended with @<address> as follows:

truffle run verify SimpleStorage@0x61C9157A9EfCaf6022243fA65Ef4666ECc9FD3D7 --network rinkeby

Adding Preamble (Optional)

You can optionally provide a preamble to the beginning of your verified source code. This may be useful for adding authorship information, links to source code, copyright information, or versioning information.

To do so, add the following to your truffle.js or truffle-config.js file

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

  verify: {
    preamble: "Author: John Citizen.\nVersion: 1.0.1"
  }
}