README

truffle-plugin-blockscout-verify

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

This plugin is based in the Truffle Plugin to verify Smart Contracts on Etherscan.

Installation

Install the plugin with npm

npm install truffle-plugin-blockscout-verify

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

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

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

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 --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 mainnet as network in Truffle, and we wish to verify the SimpleStorage contract:

truffle run verify SimpleStorage --network mainnet

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 Blockscout 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.

Plugin Development

During the development of the plugin, you can run it from the truffle folder running the following command:

npm link /path/to/truffle-plugin-blockscout-verify
./node_modules/.bin/truffle run verify Random --network integration

Adding Preamble (Optional)

There is also the option of adding 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 Doe.\nVersion: 0.0.1"
  }
}

Notes

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

@poofcash/truffle-plugin-blockscout-verify

Usage no npm install needed!