⚠️ Truffle (and truffle-plugin-verify) has been sunset. It is recommended to move over to Hardhat or Foundry ⚠️

This fork only gets the minimal changes required to keep it working.

truffle-plugin-verify


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

I wrote a tutorial on my website that goes through the entire process of installing and using this plugin: Automatically verify Truffle smart contracts on Etherscan.

Note: This version of the plugin uses multi-file verification. If you want to use source code flattening instead for any reason, please use the legacy version (v0.4.x) of the plugin.

Installation / preparation

1. Install the plugin with npm or yarn
``sh
npm install -D truffle-plugin-verify
yarn add -D truffle-plugin-verify
`
2. Add the plugin to your truffle-config.js file

`js
module.exports = {
/ ... rest of truffle-config /

plugins: ['truffle-plugin-verify'],
};
`

When only verifying on Sourcify, no more steps are required. When verifying on Etherscan (and derived explorers like PolygonScan), the appropriate API keys need to be specified:

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)

`js
module.exports = {
/ ... rest of truffle-config /

api_keys: {
etherscan_v2: 'MY_API_KEY',
},
};
`

Usage

Before running verification, make sure that you have successfully deployed your contracts to a supported network with Truffle. The contract deployment must have completely finished without errors. After deploying, run the following command with one or more contracts that you wish to verify:

`
truffle run verify SomeContractName AnotherContractName --network networkName [--debug] [--verifiers=etherscan,sourcify]
`

The network parameter should correspond to a network defined in the Truffle config file, with the correct network id set. For example, if we defined goerli as a network in Truffle, and we wish to verify the SimpleStorage contract:

`
truffle run verify SimpleStorage --network goerli
`

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.

By default the plugin attempts to verify contracts both on Etherscan and Sourcify. If you only want to verify with one of them instead of both, you can specify so using the --verifiers argument.

`
truffle run verify SimpleStorage --network goerli --verifiers=etherscan
truffle run verify SimpleStorage --network goerli --verifiers=sourcify
`

$3

In 2022, Truffle launched an awesome new feature called the Truffle Dashboard that allows you to deploy your contracts using your MetaMask wallet. truffle-plugin-verify works with the Truffle Dashboard out of the box, but for it to work correctly you need to make sure that you are running the truffle dashboard, connected to the same network as you used for deployment _while_ you're running truffle run verify ...

$3

This plugin supports EIP1967 proxies out of the box. If you try to verify a proxy contract (e.g. contracts deployed with OpenZeppelin's deployProxy), it will correctly verify the implementation contract and call Etherscan's "proxy verification" so that the proxy contract gets marked as a proxy on Etherscan (enabling Read/Write as Proxy). Note that EIP1967 _Beacon_ contracts are not yet supported, and other types of non-standard proxies are also not supported.

When using OpenZeppelin's deployProxy functionality, proxy verification should work automatically. For custom proxy contracts you need to use the --custom-proxy flag. The name of the proxy contract should be passed after this flag.

`
truffle run verify SimpleTokenUpgradeable --network goerli
truffle run verify SimpleTokenUpgradeable --custom-proxy SimpleProxy --network goerli
`

$3

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 @