@compound-finance/hardhat-match

@compound-finance/hardhat-match forked from @nomiclabs/hardhat-etherscan

Hardhat plugin for matching deployed contract bytecode to locally compiled version.

Installation

Build project using npm run build and then add to your project via npm.

Add the following statement to your hardhat.config.js:

require("@compound-finance/hardhat-match");

Or, if you are using TypeScript, add this to your hardhat.config.ts:

import "@compound-finance/hardhat-match";

Tasks

This plugin provides the match task, which allows you to match contracts by pulling deployed bytecode and locally compiling contracts. If the etherscan key is set, the constructor arguments will be compaired with the verified values on etherscan.

Usage

You may add the following Etherscan config to your hardhat.config.js file:

module.exports = {
  networks: {
    mainnet: { ... }
  },
  etherscan: {
    // Your API key for Etherscan
    // Obtain one at https://etherscan.io/
    apiKey: "YOUR_ETHERSCAN_API_KEY"
  }
};

Lastly, run the match task, passing the address of the contract, the network where it's deployed, and the constructor arguments that were used to deploy it (if any):

npx hardhat match --network mainnet DEPLOYED_CONTRACT_ADDRESS "Constructor argument 1"

Using programmatically

To call the verification task from within a Hardhat task or script, use the "match:match" subtask. You can run the subtask like this:

await hre.run("match:match", {
  address: contractAddress,
  constructorArguments: [
    50,
    "a string argument",
    {
      x: 10,
      y: 5,
    },
    "0xabcdef",
  ],
});

If the match is not successful, an error will be thrown.

Known limitations

• Adding, removing, moving or renaming new contracts to the hardhat project or reorganizing the directory structure of contracts after deployment may alter the resulting bytecode in some solc versions. See this Solidity issue for further information.
• Bytecode metadata is not part of the match comparison. If comments or whitespacing are changed, the match will still be successful.