[WIP] Feat: Upgrade Functionality

.npmignore

@@ -1,7 +1,7 @@
 .idea
-src
 .eslintrc
 tsconfig.json
-test
+src/
+test/
 .circleci
 ```

package.json

@@ -15,7 +15,8 @@
     "npm": ">=9"
   },
   "scripts": {
-    "build": "tsc",
+    "clean": "rm -rf dist",
+    "build": "yarn clean && tsc",
     "prepare": "yarn build",
     "lint": "yarn eslint .",
     "test": "mocha --require ts-node/register ./test/cases/*.ts"
@@ -31,7 +32,11 @@
   "devDependencies": {
     "@types/mocha": "^10.0.6",
     "@types/node": "^18.15.11",
-    "@zero-tech/eslint-config-cpt": "0.2.7",
+    "ethers": "^6.13.2",
+    "hardhat": "^2.22.10",
+    "@openzeppelin/hardhat-upgrades": "^3.2.1",
+    "@nomicfoundation/hardhat-ethers": "^3.0.8",
+    "@zero-tech/eslint-config-cpt": "0.2.8",
     "eslint": "^8.56.0",
     "mocha": "^10.2.0",
     "ts-node": "10.9.1",

src/campaign/deploy-campaign.ts

@@ -1,147 +1,145 @@
-import {
-  ICampaignArgs,
-  ICampaignState,
-  TLogger,
-  IMissionInstances,
-  IContractV6, IDeployCampaignConfig, IContractState,
-} from "./types";
-import { HardhatDeployer } from "../deployer/hardhat-deployer";
-import { ITenderlyContractData, TDeployMissionCtor } from "../missions/types";
-import { BaseDeployMission } from "../missions/base-deploy-mission";
-import { MongoDBAdapter } from "../db/mongo-adapter/mongo-adapter";
-import { IHardhatBase, ISignerBase } from "../deployer/types";
-import { makeCampaignProxy } from "./proxy";
-
-
-export class DeployCampaign <
-  H extends IHardhatBase,
-  S extends ISignerBase,
-  C extends IDeployCampaignConfig<S>,
-  St extends IContractState<IContractV6>,
-> {
-  state : ICampaignState<H, S, C, St>;
-  deployer : HardhatDeployer<H, S>;
-  dbAdapter : MongoDBAdapter;
-  logger : TLogger;
-  config : C;
-
-  // TODO dep: improve typing here so that methods of each contract type are resolved in Mission classes!
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  [name : string | symbol] : any;
-
-  constructor ({
-    missions,
-    deployer,
-    dbAdapter,
-    logger,
-    config,
-  } : ICampaignArgs<H, S, C, St>) {
-    this.state = {
-      missions,
-      instances: {},
-      contracts: {} as St,
-    };
-    this.deployer = deployer;
-    this.dbAdapter = dbAdapter;
-    this.logger = logger;
-    this.config = config;
-
-    const campaignProxy = makeCampaignProxy(this);
-
-    // instantiate all missions
-    this.state.instances = missions.reduce(
-      (acc : IMissionInstances<H, S, C, St>, mission : TDeployMissionCtor<H, S, C, St>) => {
-        const instance = new mission({
-          campaign: campaignProxy,
-          logger,
-          config,
-        });
-
-        acc[instance.instanceName] = instance;
-        return acc;
-      },
-      {}
-    );
-
-    this.logger.info("Deploy Campaign initialized.");
-
-    return campaignProxy;
-  }
-
-  async execute () {
-    this.logger.info("Deploy Campaign execution started.");
-
-    await this.dbAdapter.configureVersioning();
-
-    await Object.values(this.state.instances).reduce(
-      async (
-        acc : Promise<void>,
-        missionInstance : BaseDeployMission<H, S, C, St>,
-      ) : Promise<void> => {
-        await acc;
-        return missionInstance.execute();
-      },
-      Promise.resolve()
-    );
-
-    if (this.config.postDeploy.verifyContracts) {
-      await this.verify();
-    }
-
-    if (this.config.postDeploy.monitorContracts) {
-      await this.monitor();
-    }
-
-    // eslint-disable-next-line max-len
-    this.logger.info(`Deploy Campaign execution finished successfully under DB Version: ${this.dbAdapter.versioner.curDbVersion}.`);
-  }
-
-  updateStateContract (instanceName : string, contractName : string, contract : IContractV6) {
-    // TODO: can we improve this?
-    (this.state.contracts as IContractState)[instanceName] = contract;
-    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<H, S, C, St>,
-      ) => {
-        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<ITenderlyContractData>>,
-        missionInstance : BaseDeployMission<H, S, C, St>,
-      ) : Promise<Array<ITenderlyContractData>> => {
-        const newAcc = await acc;
-        const data = await missionInstance.getMonitoringData();
-
-        return [...newAcc, ...data];
-      },
-      Promise.resolve([])
-    );
-
-    try {
-      const response = await this.deployer.tenderlyPush(contracts);
-      this.logger.info(
-        `Tenderly push finished successfully for Project ${this.config.postDeploy.tenderlyProjectSlug}
-        with data: ${JSON.stringify(response, null, "\t")}`
-      );
-      /* eslint-disable-next-line @typescript-eslint/no-explicit-any */
-    } catch (e : any) {
-      this.logger.error("Tenderly push failed.");
-      this.logger.error(e.message);
-      this.logger.debug("Continuing...");
-    }
-  }
-}
+import {
+  ICampaignArgs,
+  ICampaignState,
+  TLogger,
+  IMissionInstances,
+  IDeployCampaignConfig, IContractState,
+} from "./types";
+import { HardhatDeployer } from "../deployer/hardhat-deployer";
+import { ITenderlyContractData, TDeployMissionCtor } from "../missions/types";
+import { BaseDeployMission } from "../missions/base-deploy-mission";
+import { MongoDBAdapter } from "../db/mongo-adapter/mongo-adapter";
+import { makeCampaignProxy } from "./proxy";
+import { Contract } from "ethers";
+
+
+export class DeployCampaign <
+  C extends IDeployCampaignConfig,
+  St extends IContractState,
+> {
+  state : ICampaignState<C, St>;
+  deployer : HardhatDeployer;
+  dbAdapter : MongoDBAdapter;
+  logger : TLogger;
+  config : C;
+
+  // TODO dep: improve typing here so that methods of each contract type are resolved in Mission classes!
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  [name : string | symbol] : any;
+
+  constructor ({
+    missions,
+    deployer,
+    dbAdapter,
+    logger,
+    config,
+  } : ICampaignArgs<C, St>) {
+    this.state = {
+      missions,
+      instances: {},
+      contracts: {} as St,
+    };
+    this.deployer = deployer;
+    this.dbAdapter = dbAdapter;
+    this.logger = logger;
+    this.config = config;
+
+    const campaignProxy = makeCampaignProxy(this);
+
+    // instantiate all missions
+    this.state.instances = missions.reduce(
+      (acc : IMissionInstances<C, St>, mission : TDeployMissionCtor<C, St>) => {
+        const instance = new mission({
+          campaign: campaignProxy,
+          logger,
+          config,
+        });
+
+        acc[instance.instanceName] = instance;
+        return acc;
+      },
+      {}
+    );
+
+    this.logger.info("Deploy Campaign initialized.");
+
+    return campaignProxy;
+  }
+
+  async execute () {
+    this.logger.info("Deploy Campaign execution started.");
+
+    await this.dbAdapter.configureVersioning();
+
+    await Object.values(this.state.instances).reduce(
+      async (
+        acc : Promise<void>,
+        missionInstance : BaseDeployMission<C, St>,
+      ) : Promise<void> => {
+        await acc;
+        return missionInstance.execute();
+      },
+      Promise.resolve()
+    );
+
+    if (this.config.postDeploy.verifyContracts) {
+      await this.verify();
+    }
+
+    if (this.config.postDeploy.monitorContracts) {
+      await this.monitor();
+    }
+
+    // eslint-disable-next-line max-len
+    this.logger.info(`Deploy Campaign execution finished successfully under DB Version: ${this.dbAdapter.versioner.curDbVersion}.`);
+  }
+
+  updateStateContract (instanceName : string, contractName : string, contract : Contract) {
+    // TODO: can we improve this?
+    (this.state.contracts as IContractState)[instanceName] = contract;
+    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<C, St>,
+      ) => {
+        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<ITenderlyContractData>>,
+        missionInstance : BaseDeployMission<C, St>,
+      ) : Promise<Array<ITenderlyContractData>> => {
+        const newAcc = await acc;
+        const data = await missionInstance.getMonitoringData();
+
+        return [...newAcc, ...data];
+      },
+      Promise.resolve([])
+    );
+
+    try {
+      const response = await this.deployer.tenderlyPush(contracts);
+      this.logger.info(
+        `Tenderly push finished successfully for Project ${this.config.postDeploy.tenderlyProjectSlug}
+        with data: ${JSON.stringify(response, null, "\t")}`
+      );
+      /* eslint-disable-next-line @typescript-eslint/no-explicit-any */
+    } catch (e : any) {
+      this.logger.error("Tenderly push failed.");
+      this.logger.error(e.message);
+      this.logger.debug("Continuing...");
+    }
+  }
+}

src/campaign/proxy.ts

@@ -1,22 +1,19 @@
-import { IHardhatBase, ISignerBase } from "../deployer/types";
-import { DeployCampaign } from "./deploy-campaign";
-import { IContractState, IDeployCampaignConfig } from "./types";
-
-export const makeCampaignProxy = <
-  H extends IHardhatBase,
-  S extends ISignerBase,
-  C extends IDeployCampaignConfig<S>,
-  St extends IContractState,
-> (campaign : DeployCampaign<H, S, C, St>) => new Proxy(campaign, {
-  get : (target, prop) => {
-    if (typeof prop === "string") {
-      if (!!target.state.contracts[prop]) {
-        return target.state.contracts[prop];
-      }
-
-      if (!!target[prop]) {
-        return target[prop];
-      }
-    }
-  },
-});
+import { DeployCampaign } from "./deploy-campaign";
+import { IContractState, IDeployCampaignConfig } from "./types";
+
+export const makeCampaignProxy = <
+  C extends IDeployCampaignConfig,
+  St extends IContractState,
+> (campaign : DeployCampaign<C, St>) => new Proxy(campaign, {
+  get : (target, prop) => {
+    if (typeof prop === "string") {
+      if (!!target.state.contracts[prop]) {
+        return target.state.contracts[prop];
+      }
+
+      if (!!target[prop]) {
+        return target[prop];
+      }
+    }
+  },
+});