Hardhat + Tenderly Contract Verification

This repo demonstrates deployment and verification of Smart Contracts in Tenderly platform, using:

• Tenderly Hardhat plugin to perform verification using Ethers in several ways (automatic and manual). There are 18 different possibilities you can play around with.
• API access to perform verification using the API (TBD)

To learn more explore Tenderly documentation.

The examples

There are two example contracts (Greeter.sol and Calculator.sol). Their build scripts are located in:

• scripts/greeter/, deploying the classical Greeter.sol contract.
• scripts/calculator, deploying Calculator.sol and Maths.sol - a library used by the contract.

From these examples, you can learn:

• How to verify a Smart Contract referencing a non-deployed library: Greeter uses non-deployed hardhat/console.log.
• How to verify a Smart Contract referencing an library deployed on-chain: Calculator uses deployed Maths.sol library.

Environment setup

This example requires some environment variables:

• The provider access and tenderly access parameters should be placed in an .env file.
• Run configuration should be set on per-run basis. This allows us to run the same deployment script in public and private mode or on a fork, without changing any code. These values are used only in hardhat.config.ts. See Building and verifying section for more information.

Run the following script to to get an .env file initialized with placeholders, necessary for running the examples:

cat .tpl.env
cp .tpl.env .env

To get going, run

npm install

Try running automatic verification:

TENDERLY_AUTOMATIC_VERIFICATION=true \
hardhat run scripts/greeter/automatic.ts --network ropsten

Biuilding and Verifying Greeter and environment variables

The /scripts/greeter contains 4 deployment scripts that illustrate the 3 methods of verification (automatic, manual simple, manual advanced) and verification of a contract deployed on a Tenderly Fork. The scripts/calculator example has the same structure.

Verification method	Script
Automatic verification	scripts/greeter/automatic.ts
Manual simple	scripts/greeter/manual-simple.ts
Manual advanced	scripts/greeter/manual-simple.ts
Fork	scripts/greeter/fork.ts

For example, to run the automatic verification example, you have to run it with TENDERLY_AUTOMATIC_VERIFICATION variable:

TENDERLY_AUTOMATIC_VERIFICATION=true \
hardhat run scripts/greeter/automatic.ts --network ropsten

And to run the manual simple with private verification, you'd paste this:

TENDERLY_PRIVATE_VERIFICATION=true \
TENDERLY_AUTOMATIC_VERIFICATION=false \
hardhat run scripts/greeter/manual-simple.ts --network ropsten

Don't worry, we generated NPM run scripts to speed things up.

Modes of verification: public, private, and fork

• To easily switch between private and public verification use TENDERLY_PRIVATE_VERIFICATION.
• Default: false, contracts are verified publically.
• To run a private verification set TENDERLY_PRIVATE_VERIFICATION=true. Any other value is considered not true.

Tenderly Plugin verification methods: automatic and manual

• Tenderly Hardhat plugin runs with automatic verifications enabled by default unless explicitly configured otherwise. See hardhat config line 31.
• To control if you're automatic or manual verification, use TENDERLY_AUTOMATIC_VERIFICATION.
• Default: false
• To run an automatic verification set TENDERLY_AUTOMATIC_VERIFICATION=true

NPM run scripts

The pre-populated (generated) scripts in package.json are there to help you quickly run a particular build (out of 18 possibilities), so you don't need to specify environment variables and the tartet deployment script every time you're trying stuff out.

You can choose

category	Meaning	options
example	Smart contract to verify	greeter, calculator
mode	In one of 3 modes of verification	public, private, fork
method	Using one of 3 methods of verification	automatic, manual-simple, manual-advanced

To run private verification of the Greeter using manual-simple method, you need to run the following:

npm run private:greeter:manual-simple