updated readme

Author: filippetroviccc

README.md

@@ -15,148 +15,124 @@ privately push contracts to [Tenderly](https://tenderly.co).
 npm install --save-dev @tenderly/hardhat-tenderly
 ```
 
-And add the following statement to your `hardhat.config.js`:
+And add the following statement to your `hardhat.config.js` or `hardhat.config.ts`:
 
 ```js
-require("@tenderly/hardhat-tenderly");
+const tdly = require("@tenderly/hardhat-tenderly");
+tdly.setup();
 ```
 
 Or, if you are using typescript:
 
 ```ts
-import "@tenderly/hardhat-tenderly"
+import * as tdly from "@tenderly/hardhat-tenderly";
+tdly.setup();
 ```
 
-## Tasks
+# Verification options
 
-This plugin adds the `tenderly:verify` task to Hardhat:
+## Automatic verification
 
-```
-Usage: hardhat [GLOBAL OPTIONS] tenderly:verify ...contracts
-
-POSITIONAL ARGUMENTS:
-
-  contracts     Addresses and names of contracts that will be verified formatted ContractName=Address 
-
-tenderly-verify: Verifies contracts on Tenderly
-```
-
-And the `tenderly:push` task:
-```
-Usage: hardhat [GLOBAL OPTIONS] tenderly:push ...contracts
-
-POSITIONAL ARGUMENTS:
-
-  contracts     Addresses and names of contracts that will be verified formatted ContractName=Address 
-
-tenderly-push: Privately pushes contracts to Tenderly
-```
-
-## How to set up HardHat with Tenderly CLI
-
-For Tenderly CLI to work you need to have a `deployments` directory inside your project. You can generate that
-one in next steps:
-
-1. First install hardhat-tenderly.
-
-```bash
-npm install --save-dev @tenderly/hardhat-tenderly
-```
-
-2. Add the following statement to your `hardhat.config.js`:
-
-```js
-require("@tenderly/hardhat-tenderly");
-```
+Contract verification works out-of-the box if contracts is deployed via ethers provided in HRE object.
 
-Or, if you are using typescript:
+## Manual contract verification - Environment extensions
 
-```js
-import "@tenderly/hardhat-tenderly"
-```
+This plugin extends the Hardhat Runtime Environment by adding a `tenderly` field
+whose type is `Tenderly`.
 
-3. Then you need to call it from your scripts (using ethers to deploy a contract):
+This field has the `verify` and `push` methods, and you can use to trigger manual contract verification.
 
-```js
+This is an example on how you can call it from your scripts (using ethers to deploy a contract):
+```ts
 const Greeter = await ethers.getContractFactory("Greeter");
 const greeter = await Greeter.deploy("Hello, Hardhat!");
 
 await greeter.deployed()
 
-await hre.tenderly.persistArtifacts({
+// public contract verification
+await hre.tenderly.verify({
     name: "Greeter",
     address: greeter.address,
 })
 ```
 
-`persistArtifacts` accept variadic parameters:
-
-```js
+Both functions accept variadic parameters:
+```ts
 const contracts = [
-    {
-        name: "Greeter",
-        address: "123"
-    },
-    {
-        name: "Greeter2",
-        address: "456"
-    }
-]
+{
+    name: "Greeter",
+    address: "123"
+},
+{
+    name: "Greeter2",
+    address: "456"
+}]
 
-await hre.tenderly.persistArtifacts(...contracts)
+// private contract verification
+await hre.tenderly.push(...contracts)
 ```
 
-4. Run: `npx hardhat compile` to compile contracts
-5. Run: `npx hardhat node --network hardhat` to start a local node
-6. Run: `npx hardhat run scripts/sample-script.js --network localhost` to run a script
-7. And at the end now when `deployments` directory was built you can run `tenderly init`
+## Manual contract verification - HRE Tasks
 
-## Environment extensions
+This plugin adds the _`tenderly:verify`_ task to Hardhat:
+```
+Usage: hardhat [GLOBAL OPTIONS] tenderly:verify ...contracts
 
-This plugin extends the Hardhat Runtime Environment by adding a `tenderly` field
-whose type is `Tenderly`.
+POSITIONAL ARGUMENTS:
 
-This field has the `verify` and `push` methods.
+  contracts     Addresses and names of contracts that will be verified formatted ContractName=Address 
 
-This is an example on how you can call it from your scripts (using ethers to deploy a contract):
+tenderly-verify: Verifies contracts on Tenderly
+```
 
-```js
-const Greeter = await ethers.getContractFactory("Greeter");
-const greeter = await Greeter.deploy("Hello, Hardhat!");
+And the `tenderly:push` task:
+```
+Usage: hardhat [GLOBAL OPTIONS] tenderly:push ...contracts
 
-await greeter.deployed()
+POSITIONAL ARGUMENTS:
 
-await hre.tenderly.persistArtifacts({
-    name: "Greeter",
-    address: greeter.address,
-})
+  contracts     Addresses and names of contracts that will be verified formatted ContractName=Address 
 
-await hre.tenderly.verify({
-    name: "Greeter",
-    address: greeter.address,
-})
+tenderly-push: Privately pushes contracts to Tenderly
 ```
 
-Both functions accept variadic parameters:
+## Manual contract verification - Source & compiler config manually provided
 
-```js
-const contracts = [
-{
-    name: "Greeter",
-    address: "123"
-},
-{
-    name: "Greeter2",
-    address: "456"
-}]
+In order to offer the most flexibility we have exposed our internal API interface in the plugin interface.
 
-await hre.tenderly.verify(...contracts)
+There are `verifyAPI` and `pushAPI` functions with all necessary data for verification.
+
+Here is the types example that are needed in order for verification to be successful.
+```typescript
+export interface TenderlyContractConfig {
+  compiler_version?: string;
+  optimizations_used?: boolean;
+  optimizations_count?: number;
+  evm_version?: string;
+  debug?: CompilerDebugInput;
+}
+
+export interface TenderlyContract {
+    contractName: string;
+    source: string;
+    sourcePath: string;
+    compiler?: ContractCompiler;
+    networks?: Record<string, ContractNetwork>;
+}
+
+export interface TenderlyContractUploadRequest {
+    config: TenderlyContractConfig;
+    contracts: TenderlyContract[];
+    tag?: string;
+}
+
+public async verifyAPI(request: TenderlyContractUploadRequest)
 ```
 
 ## Configuration
 
-This plugin extends the `HardhatConfig` object with optional 
-`project` and `username` fields.
+This plugin extends the `HardhatConfig` object with
+`project`, `username`, `forkNetwork` and `privateVerification` fields.
 
 This is an example of how to set it:
 
@@ -165,15 +141,17 @@ module.exports = {
     tenderly: {
         project: "",
         username: "",
+        forkNetwork: "",
+        // privateVerification: false,
+        // deploymentsDir: "deployments"
     }
 };
 ```
 
 ## Usage
 
-For this plugin to function you need to create a `config.yaml` file at 
+For this plugin to function you need to create a `config.yaml` file at
 `$HOME/.tenderly/config.yaml` or `%HOMEPATH%\.tenderly\config.yaml` and add an `access_key` field to it:
-
 ```yaml
 access_key: super_secret_access_key
 ```