fix: Add verification and monitoring to Deploy Campaign

hardhat.config.ts

@@ -35,7 +35,7 @@ subtask(TASK_TEST_RUN_MOCHA_TESTS)
 // does not work properly locally or in CI, so we
 // keep it commented out and uncomment when using DevNet
 // locally.
-// !!! Uncomment this when using Tenderly DevNet !!!
+// !!! Uncomment this when using Tenderly !!!
 // tenderly.setup({ automaticVerifications: false });
 
 const config : HardhatUserConfig = {
@@ -98,21 +98,17 @@ const config : HardhatUserConfig = {
   },
   networks: {
     mainnet: {
-      url: "https://mainnet.infura.io/v3/97e75e0bbc6a4419a5dd7fe4a518b917",
+      url: `${process.env.MAINNET_RPC_URL}`,
       gasPrice: 80000000000,
     },
     sepolia: {
-      url: "https://eth-sepolia.g.alchemy.com/v2/mX2eTgCe-osaWbsEJ1s7sRgmjZ1c178y",
+      url: `${process.env.SEPOLIA_RPC_URL}`,
       timeout: 10000000,
       // accounts: [ // Comment out for CI, uncomment this when using Sepolia
       //   `${process.env.TESTNET_PRIVATE_KEY_A}`,
       //   `${process.env.TESTNET_PRIVATE_KEY_B}`,
       // ]
     },
-    goerli: {
-      url: "https://goerli.infura.io/v3/77c3d733140f4c12a77699e24cb30c27",
-      timeout: 10000000,
-    },
     devnet: {
       // Add current URL that you spawned if not using automated spawning
       url: `${process.env.DEVNET_RPC_URL}`,

package.json

@@ -16,9 +16,9 @@
     "lint": "yarn lint-sol & yarn lint-ts --no-error-on-unmatched-pattern",
     "clean": "hardhat clean",
     "build": "yarn run clean && yarn run compile",
-    "postbuild": "yarn save-tag-bash",
+    "postbuild": "yarn save-tag",
     "typechain": "hardhat typechain",
-    "pretest": "yarn mongo:start && yarn save-tag",
+    "pretest": "yarn mongo:start",
     "test": "hardhat test",
     "test-local": "yarn test",
     "posttest": "yarn mongo:stop",
@@ -28,8 +28,7 @@
     "devnet": "ts-node src/tenderly/devnet/devnet-execute.ts",
     "gas-cost": "ts-node src/utils/gas-costs.ts",
     "docgen": "hardhat docgen",
-    "save-tag": "ts-node src/utils/git-tag/save-tag.ts",
-    "save-tag-bash": "chmod a+x ./src/utils/git-tag/save-tag.sh && bash ./src/utils/git-tag/save-tag.sh",
+    "save-tag": "chmod a+x ./src/utils/git-tag/save-tag.sh && bash ./src/utils/git-tag/save-tag.sh",
     "mongo:start": "docker-compose up -d",
     "mongo:stop": "docker-compose stop",
     "mongo:down": "docker-compose down",

src/deploy/campaign/deploy-campaign.ts

@@ -11,6 +11,7 @@ import { TDeployMissionCtor } from "../missions/types";
 import { BaseDeployMission } from "../missions/base-deploy-mission";
 import { Contract } from "ethers";
 import { MongoDBAdapter } from "../db/mongo-adapter/mongo-adapter";
+import { ContractByName } from "@tenderly/hardhat-tenderly/dist/tenderly/types";
 
 
 export class DeployCampaign {
@@ -93,6 +94,14 @@ export class DeployCampaign {
       Promise.resolve()
     );
 
+    if (this.config.postDeploy.verifyContracts) {
+      await this.verify();
+    }
+
+    if (this.config.postDeploy.monitorContracts) {
+      await this.monitor();
+    }
+
     this.logger.debug("Deploy Campaign execution finished successfully.");
   }
 
@@ -101,4 +110,38 @@ export class DeployCampaign {
     // TODO dep: make better logger and decide which levels to call where
     this.logger.debug(`Data of deployed contract '${contractName}' is added to Campaign state at '${instanceName}'.`);
   }
+
+  async verify () {
+    return Object.values(this.state.instances).reduce(
+      async (
+        acc : Promise<void>,
+        missionInstance : BaseDeployMission,
+      ) => {
+        await acc;
+        return missionInstance.verify();
+      },
+      Promise.resolve()
+    );
+  }
+
+  async monitor () {
+    this.logger.info("Pushing contracts to Tenderly...");
+
+    const contracts = await Object.values(this.state.instances).reduce(
+      async (
+        acc : Promise<Array<ContractByName>>,
+        missionInstance : BaseDeployMission,
+      ) : Promise<Array<ContractByName>> => {
+        const newAcc = await acc;
+        const data = await missionInstance.getMonitoringData();
+
+        return [...newAcc, ...data];
+      },
+      Promise.resolve([])
+    );
+
+    await this.deployer.tenderlyVerify(contracts);
+
+    this.logger.info(`Tenderly push finished successfully for Project ${this.config.postDeploy.tenderlyProjectSlug}.`);
+  }
 }

src/deploy/campaign/environments.ts

@@ -125,6 +125,11 @@ export const getConfig = (
     zeroVaultAddress: process.env.ZERO_VAULT_ADDRESS ? process.env.ZERO_VAULT_ADDRESS : zeroVault.address,
     mockMeowToken: process.env.MOCK_MEOW_TOKEN ? !!process.env.MOCK_MEOW_TOKEN : true,
     stakingTokenAddress: process.env.STAKING_TOKEN_ADDRESS ? process.env.STAKING_TOKEN_ADDRESS : MeowMainnet.address,
+    postDeploy: {
+      tenderlyProjectSlug: process.env.TENDERLY_PROJECT_SLUG ? process.env.TENDERLY_PROJECT_SLUG : "",
+      monitorContracts: process.env.MONITOR_CONTRACTS === "true",
+      verifyContracts: process.env.VERIFY_CONTRACTS === "true",
+    },
   };
 
   // Will throw an error based on any invalid setup, given the `ENV_LEVEL` set
@@ -159,9 +164,19 @@ export const validate = (
     requires(config.stakingTokenAddress === MeowMainnet.address, STAKING_TOKEN_ERR);
     requires(validatePrice(config.rootPriceConfig), INVALID_CURVE_ERR);
     requires(!mongoUri.includes("localhost"), MONGO_URI_ERR);
+
+    if (config.postDeploy.verifyContracts) {
+      requires(!!process.env.ETHERSCAN_API_KEY, "Must provide an Etherscan API Key to verify contracts");
+    }
+
+    if (config.postDeploy.monitorContracts) {
+      requires(!!process.env.TENDERLY_PROJECT_SLUG, "Must provide a Tenderly Project Slug to monitor contracts");
+      requires(!!process.env.TENDERLY_ACCOUNT_ID, "Must provide a Tenderly Account ID to monitor contracts");
+      requires(!!process.env.TENDERLY_ACCESS_KEY, "Must provide a Tenderly Access Key to monitor contracts");
+    }
   }
 
-  // If we reach this code, there is an env variable but it's not valid.
+  // If we reach this code, there is an env variable, but it's not valid.
   throw new Error(INVALID_ENV_ERR);
 };
 

src/deploy/campaign/types.ts

@@ -22,6 +22,11 @@ export interface IDeployCampaignConfig {
   zeroVaultAddress : string;
   mockMeowToken : boolean;
   stakingTokenAddress : string;
+  postDeploy : {
+    tenderlyProjectSlug : string;
+    monitorContracts : boolean;
+    verifyContracts : boolean;
+  };
 }
 
 export type TLogger = WinstonLogger | Console;

src/deploy/deployer/hardhat-deployer.ts

@@ -2,6 +2,7 @@ import * as hre from "hardhat";
 import { HardhatRuntimeEnvironment } from "hardhat/types";
 import { TDeployArgs, TProxyKind } from "../missions/types";
 import { SignerWithAddress } from "@nomiclabs/hardhat-ethers/signers";
+import { ContractByName } from "@tenderly/hardhat-tenderly/dist/tenderly/types";
 
 export class HardhatDeployer {
   hre : HardhatRuntimeEnvironment;
@@ -61,4 +62,23 @@ export class HardhatDeployer {
   async getBytecodeFromChain (address : string) {
     return this.hre.ethers.provider.getCode(address);
   }
+
+  async tenderlyVerify (contracts : Array<ContractByName>) {
+    return this.hre.tenderly.verify(...contracts);
+  }
+
+  async etherscanVerify ({
+    address,
+    ctorArgs,
+  } : {
+    address : string;
+    ctorArgs ?: TDeployArgs;
+  }) {
+    return this.hre.run("verify:verify", {
+      address,
+      // this should only be used for non-proxied contracts
+      // or proxy impls that have actual constructors
+      constructorArguments: ctorArgs,
+    });
+  }
 }

src/deploy/missions/base-deploy-mission.ts

@@ -7,6 +7,9 @@ import {
 import { DeployCampaign } from "../campaign/deploy-campaign";
 import { IDeployCampaignConfig, TLogger } from "../campaign/types";
 import { IContractDbData } from "../db/types";
+import { erc1967ProxyName, transparentProxyName } from "./contracts/names";
+import { ProxyKinds } from "../constants";
+import { ContractByName } from "@tenderly/hardhat-tenderly/dist/tenderly/types";
 
 
 // TODO dep:
@@ -19,6 +22,7 @@ export class BaseDeployMission {
   campaign : DeployCampaign;
   logger : TLogger;
   config : IDeployCampaignConfig;
+  implAddress! : string | null;
 
   constructor ({
     campaign,
@@ -37,11 +41,11 @@ export class BaseDeployMission {
   async saveToDB (contract : Contract) {
     this.logger.debug(`Writing ${this.contractName} to DB...`);
 
-    const implAddress = this.proxyData.isProxy
+    this.implAddress = this.proxyData.isProxy
       ? await this.campaign.deployer.getProxyImplAddress(contract.address)
       : null;
 
-    const contractDbDoc = this.buildDbObject(contract, implAddress);
+    const contractDbDoc = this.buildDbObject(contract, this.implAddress);
 
     return this.campaign.dbAdapter.writeContract(this.contractName, contractDbDoc);
   }
@@ -136,4 +140,47 @@ export class BaseDeployMission {
       await this.postDeploy();
     }
   }
+
+  async verify () {
+    this.logger.info(`Verifying ${this.contractName} on Etherscan...`);
+    const { address } = await this.campaign[this.instanceName];
+
+    const ctorArgs = !this.proxyData.isProxy ? this.deployArgs() : undefined;
+
+    await this.campaign.deployer.etherscanVerify({
+      address,
+      ctorArgs,
+    });
+
+    this.logger.info(`Etherscan verification for ${this.contractName} finished successfully.`);
+  }
+
+  async getMonitoringData () : Promise<Array<ContractByName>> {
+    const implName = this.contractName;
+    let implAddress = this.campaign[this.instanceName].address;
+
+    if (this.proxyData.isProxy) {
+      const proxyName = this.proxyData.kind === ProxyKinds.uups ? erc1967ProxyName : transparentProxyName;
+      const proxyAddress = this.campaign[this.instanceName].address;
+      implAddress = this.implAddress || await this.campaign.deployer.getProxyImplAddress(proxyAddress);
+
+      return [
+        {
+          name: proxyName,
+          address: proxyAddress,
+        },
+        {
+          name: implName,
+          address: implAddress,
+        },
+      ];
+    }
+
+    return [
+      {
+        name: implName,
+        address: implAddress,
+      },
+    ];
+  }
 }

src/deploy/missions/contracts/names.ts

@@ -1,4 +1,6 @@
 export const erc1967ProxyName = "ERC1967Proxy";
+export const transparentProxyName = "TransparentUpgradeableProxy";
+
 
 export const znsNames = {
   accessController: {

src/deploy/run-campaign.ts

@@ -9,14 +9,13 @@ const runCampaign = async () => {
   const [deployer, zeroVault] = await hre.ethers.getSigners();
 
   // Reading `ENV_LEVEL` environment variable to determine rules to be enforced
-  const config = await getConfig(
+  const config = getConfig(
     deployer,
     zeroVault,
   );
 
   await runZnsCampaign({
     config,
-    logger,
   });
 };
 

src/deploy/zns-campaign.ts

@@ -17,16 +17,18 @@ import { getLogger } from "./logger/create-logger";
 export const runZnsCampaign = async ({
   config,
   dbVersion,
+  deployer,
 } : {
   config : IDeployCampaignConfig;
   dbVersion ?: string;
+  deployer ?: HardhatDeployer;
 }) => {
   // TODO dep: figure out the best place to put this at!
   hre.upgrades.silenceWarnings();
 
   const logger = getLogger();
 
-  const deployer = new HardhatDeployer(config.deployAdmin);
+  if (!deployer) deployer = new HardhatDeployer(config.deployAdmin);
 
   const dbAdapter = await getMongoAdapter();
 

src/utils/git-tag/save-tag.ts

@@ -9,7 +9,7 @@ const execAsync = promisify(exec);
 const logger = getLogger();
 
 
-const acquireLatestGitTag = async () => {
+export const acquireLatestGitTag = async () => {
   const gitTag = await execAsync("git describe --tags --abbrev=0");
   const tag = gitTag.stdout.trim();
 
@@ -24,17 +24,9 @@ const acquireLatestGitTag = async () => {
   return full;
 };
 
-const saveTag = async () => {
+export const saveTag = async () => {
   const tag = await acquireLatestGitTag();
 
   fs.writeFileSync(tagFilePath, tag, "utf8");
   logger.info(`Saved git tag-commit to ${tagFilePath}}`);
 };
-
-saveTag()
-  // eslint-disable-next-line @typescript-eslint/no-empty-function
-  .then(process.exit(0))
-  .catch(e => {
-    logger.error(e);
-    process.exit(1);
-  });

tenderly.yaml

@@ -1,4 +1,6 @@
-account_id: e750f9f2-65bc-4765-84a8-7f8dbddd73ee
+account_id: "zer0-os"
+project_slug: "zns-sepolia-test"
+provider: ""
 exports:
   hardhat:
     project_slug: zer0-os/zns-1
@@ -17,5 +19,3 @@ exports:
       istanbul_block: 0
       berlin_block: 0
       london_block: 0
-project_slug: zer0-os/zns-1
-provider: ""