add verify script for verifying a whole spec file

Author: RnkSngh

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-ibc/vibc-core-smart-contracts",
-  "version": "2.1.11",
+  "version": "2.1.12",
   "main": "dist/index.js",
   "bin": {
     "verify-vibc-core-smart-contracts": "./dist/scripts/verify-contract-script.js",

specs/evm.accounts.yaml

@@ -1,11 +1,12 @@
 # These accounts are derived from a test mnemonic by Anvil/Hardhat and used for testing purposes only.
 - name: 'KEY_POLYMER'
-  privateKey: '0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80'
+  privateKey: '{{DEPLOYER_PRIVATE_KEY}}'
+
 
   # Dapp accounts
 - name: 'KEY_DAPP1'
-  privateKey: '0x6cbed15c793ce57650b9877cf6fa156fbef513c4e6134f022a85b1ffdd59b2a1'
+  privateKey: '{{ DAPP_PRIVATE_KEY_1 }}'
 - name: 'KEY_DAPP2'
-  privateKey: '0xb0057716d5917badaf911b193b12b910811c1497b5bada8d7711f758981c3773'
+  privateKey: '{{ DAPP_PRIVATE_KEY_2 }}'
 - name: 'KEY_DAPP3'
-  privateKey: '0x829e924fdf021ba3dbbc4225edfece9aca04b929d6e75613329ca6f1d31c0bb4'
+  privateKey: '{{ DAPP_PRIVATE_KEY_2 }}' 

src/scripts/verify-contract-script.ts

@@ -1,18 +1,25 @@
 #!/usr/bin/env node
 import {
+  ChainFolder,
+  parseObjFromFile,
   parseVerifyArgsFromCLI,
   readFromDeploymentFile,
   readMetadata,
 } from "../utils/io";
 import { $, cd } from "zx";
 import { MODULE_ROOT_PATH } from "../utils/constants";
-/**
- * Take a deployment name, and verify the result to blockscout api
- */
-async function main() {
-  const { deploymentName, verifierUrl, chainFolder, etherscanApiKey } =
-    await parseVerifyArgsFromCLI();
+import { Logger } from "winston";
+import { getMainLogger } from "../utils/cli";
+import { ContractItemSchema } from "../evm/schemas/contract";
+import { loadContractUpdateRegistry } from "../evm/schemas/contractUpdate";
 
+const verifyContract = async (
+  deploymentName: string,
+  chainFolder: ChainFolder,
+  etherscanApiKey: string,
+  verifierUrl: string,
+  logger: Logger
+) => {
   // Read deployment file, so that we can find path to artifact
   const deployment = await readFromDeploymentFile(deploymentName, chainFolder);
   const metadata = await readMetadata(deployment.factory);
@@ -27,7 +34,6 @@ async function main() {
     `${etherscanApiKey}`,
     `--verifier-url=${verifierUrl}`,
   ];
-
   // Find libraries into string that foundry verification expects if there are any
   let libraries: Record<string, string> | null = null;
   if (deployment.libraries && deployment.libraries.length > 0) {
@@ -37,7 +43,7 @@ async function main() {
     });
   }
 
-  console.log(
+  logger.info(
     `verifying ${deploymentName}'s deployment with ${deployment.factory} ${
       libraries ? `and libraries ${libraries}` : ``
     }`
@@ -49,10 +55,44 @@ async function main() {
   try {
     command = await $`forge verify-contract ${args} 2>&1 | tee verify-out.txt`; // command = await $`cd ${MODULE_ROOT_PATH} && forge verify-contract ${
   } catch (e) {
-    console.log("error ", e);
+    logger.error("error ", e);
   }
 
-  console.log("verification result ", command);
+  logger.info("verification result ", command);
+};
+/**
+ * Take a deployment name, and verify the result to blockscout api
+ */
+async function main() {
+  const { verifierUrl, chainFolder, etherscanApiKey, updateSpecs } =
+    await parseVerifyArgsFromCLI();
+
+  // Fetch spec from contract
+
+  const contractUpdates = loadContractUpdateRegistry(
+    parseObjFromFile(updateSpecs)
+  );
+
+  const logger = getMainLogger();
+  for (const contractUpdate of contractUpdates.values()) {
+    const parsed = ContractItemSchema.safeParse(contractUpdate);
+    if (parsed.success) {
+      // Only try to verify contractName if it matches the deploymentName
+      try {
+        await verifyContract(
+          parsed.data.name,
+          chainFolder,
+          etherscanApiKey,
+          verifierUrl,
+          logger
+        );
+      } catch (e) {
+        logger.error(
+          `Failed to verify contract ${parsed.data.name} with error: ${e}`
+        );
+      }
+    }
+  }
 }
 
 main();

src/utils/io.ts

@@ -20,6 +20,7 @@ import {
   DEPLOYMENT_ENVIRONMENT,
   ANVIL_PORT,
   UPGRADE_SPECS_PATH,
+  UPDATE_SPECS_PATH,
 } from "./constants";
 import yargs from "yargs/yargs";
 import { hideBin } from "yargs/helpers";
@@ -389,15 +390,11 @@ export const parseVerifyArgsFromCLI = async () => {
   const deploymentEnvironment =
     (argv1.DEPLOYMENT_ENVIRONMENT as string) || DEPLOYMENT_ENVIRONMENT; // Needed to search for deployment
 
+  const updateSpecs = (argv1.UPDATE_SPECS_PATH as string) || UPDATE_SPECS_PATH;
+
   if (!verifierUrl) {
     throw new Error(`Verifier URL not provided`);
   }
-  if (!deploymentName) {
-    throw new Error(`Deployment name not provided`);
-  }
-  if (!rpcUrl) {
-    throw new Error(`RPC url needed`);
-  }
 
   const chainFolderParse = ChainFolderSchema.safeParse({
     chainId,
@@ -416,5 +413,7 @@ export const parseVerifyArgsFromCLI = async () => {
     chainFolder: chainFolderParse.data,
     rpcUrl,
     etherscanApiKey,
+    updateSpecs,
+    args: argv1,
   };
 };