[WIP] Feat: Upgrade Functionality

.eslintrc

@@ -11,12 +11,13 @@
         "no-console": "off",
         "no-shadow": "warn",
         "@typescript-eslint/no-shadow": "warn",
-        "no-invalid-this": "off"
+        "no-invalid-this": "off",
+        "jsdoc/newline-after-description": "off"
         // "@typescript-eslint/no-unused-vars": "off" // For debugging
       },
       "parserOptions": {
         "project": "./tsconfig.eslint.json"
       }
     }
   ]
-}
+}

.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"
@@ -24,14 +25,18 @@
     "lint"
   ],
   "dependencies": {
-    "axios": "1.7.4",
+    "axios": "^1.8.4",
     "mongodb": "^6.3.0",
     "winston": "^3.11.0"
   },
   "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

@@ -3,24 +3,22 @@ import {
   ICampaignState,
   TLogger,
   IMissionInstances,
-  IContractV6, IDeployCampaignConfig, IContractState,
+  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";
+import { Contract } from "ethers";
 
 
 export class DeployCampaign <
-  H extends IHardhatBase,
-  S extends ISignerBase,
-  C extends IDeployCampaignConfig<S>,
+  C extends IDeployCampaignConfig,
   St extends IContractState,
 > {
-  state : ICampaignState<H, S, C, St>;
-  deployer : HardhatDeployer<H, S>;
+  state : ICampaignState<C, St>;
+  deployer : HardhatDeployer;
   dbAdapter : MongoDBAdapter;
   logger : TLogger;
   config : C;
@@ -35,7 +33,7 @@ export class DeployCampaign <
     dbAdapter,
     logger,
     config,
-  } : ICampaignArgs<H, S, C, St>) {
+  } : ICampaignArgs<C, St>) {
     this.state = {
       missions,
       instances: {},
@@ -50,7 +48,7 @@ export class DeployCampaign <
 
     // instantiate all missions
     this.state.instances = missions.reduce(
-      (acc : IMissionInstances<H, S, C, St>, mission : TDeployMissionCtor<H, S, C, St>) => {
+      (acc : IMissionInstances<C, St>, mission : TDeployMissionCtor<C, St>) => {
         const instance = new mission({
           campaign: campaignProxy,
           logger,
@@ -85,7 +83,7 @@ export class DeployCampaign <
     await Object.values(this.state.instances).reduce(
       async (
         acc : Promise<void>,
-        missionInstance : BaseDeployMission<H, S, C, St>,
+        missionInstance : BaseDeployMission<C, St>,
       ) : Promise<void> => {
         await acc;
         return missionInstance.execute();
@@ -105,7 +103,7 @@ export class DeployCampaign <
     this.logger.info(`Deploy Campaign execution finished successfully under DB Version: ${this.dbAdapter.versioner.curDbVersion}.`);
   }
 
-  updateStateContract (instanceName : string, contractName : string, contract : IContractV6) {
+  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}'.`);
@@ -115,7 +113,7 @@ export class DeployCampaign <
     return Object.values(this.state.instances).reduce(
       async (
         acc : Promise<void>,
-        missionInstance : BaseDeployMission<H, S, C, St>,
+        missionInstance : BaseDeployMission<C, St>,
       ) => {
         await acc;
         return missionInstance.verify();
@@ -130,7 +128,7 @@ export class DeployCampaign <
     const contracts = await Object.values(this.state.instances).reduce(
       async (
         acc : Promise<Array<ITenderlyContractData>>,
-        missionInstance : BaseDeployMission<H, S, C, St>,
+        missionInstance : BaseDeployMission<C, St>,
       ) : Promise<Array<ITenderlyContractData>> => {
         const newAcc = await acc;
         const data = await missionInstance.getMonitoringData();

src/campaign/proxy.ts

@@ -1,13 +1,10 @@
-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>,
+  C extends IDeployCampaignConfig,
   St extends IContractState,
-> (campaign : DeployCampaign<H, S, C, St>) => new Proxy(campaign, {
+> (campaign : DeployCampaign<C, St>) => new Proxy(campaign, {
   get : (target, prop) => {
     if (typeof prop === "string") {
       if (!!target.state.contracts[prop]) {

src/campaign/types.ts

@@ -3,7 +3,8 @@ import { TDeployMissionCtor } from "../missions/types";
 import { HardhatDeployer } from "../deployer/hardhat-deployer";
 import { Logger as WinstonLogger } from "winston";
 import { MongoDBAdapter } from "../db/mongo-adapter/mongo-adapter";
-import { IHardhatBase, ISignerBase, TEnvironment } from "../deployer/types";
+import { TSigner, TEnvironment } from "../deployer/types";
+import { ContractInterface, BaseContract } from "ethers";
 
 
 export type TSupportedChain = "zchain" | "ethereum";
@@ -12,6 +13,19 @@ export interface ISupportedChains {
   eth : TSupportedChain;
 }
 
+export interface IDeployCampaignConfig extends IBaseDataMap {
+  env : TEnvironment;
+  upgrade : boolean;
+  deployAdmin : TSigner;
+  confirmationsN : number;
+  srcChainName : TSupportedChain;
+  postDeploy : {
+    tenderlyProjectSlug : string;
+    monitorContracts : boolean;
+    verifyContracts : boolean;
+  };
+}
+
 export interface ITransactionReceipt {
   hash : string;
 }
@@ -24,74 +38,49 @@ export type TCampaignDataType = bigint
   | boolean
   | object;
 
-export interface IBaseDataMap<T> {
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  [key : string] : TCampaignDataType | T | IBaseDataMap<T> | undefined;
+export interface IBaseDataMap {
+  [key : string] : TCampaignDataType | TSigner | undefined;
 }
 
 export interface IAddressable {
   getAddress : () => Promise<string>;
 }
 
+export type TLogger = WinstonLogger | Console;
+
 export interface ITransactionResponseBase {
   wait(confirms ?: number, timeout ?: number) : Promise<ITransactionReceipt | null>;
 }
 
-export interface IContractV6 {
-  getAddress : () => Promise<string>;
-  waitForDeployment : () => Promise<IContractV6>;
-  deploymentTransaction : () => ITransactionResponseBase | null;
-  target : string | IAddressable;
-  interface : object;
-}
-
-export type TLogger = WinstonLogger | Console;
+export type TGeneralContract = BaseContract & Omit<ContractInterface, keyof BaseContract>;
 
-export interface IContractState<C extends IContractV6 = IContractV6> {
-  [key : string] : C;
+export interface IContractState {
+  [name : string] : BaseContract;
 }
 
 export interface IMissionInstances <
-  H extends IHardhatBase,
-  S extends ISignerBase,
-  C extends IDeployCampaignConfig<S>,
+  C extends IDeployCampaignConfig,
   St extends IContractState,
 > {
-  [key : string] : BaseDeployMission<H, S, C, St>;
+  [key : string] : BaseDeployMission<C, St>;
 }
 
 export interface ICampaignState <
-  H extends IHardhatBase,
-  S extends ISignerBase,
-  C extends IDeployCampaignConfig<S>,
+  C extends IDeployCampaignConfig,
   St extends IContractState,
 > {
-  missions : Array<TDeployMissionCtor<H, S, C, St>>;
-  instances : IMissionInstances<H, S, C, St>;
+  missions : Array<TDeployMissionCtor<C, St>>;
+  instances : IMissionInstances<C, St>;
   contracts : St;
 }
 
 export interface ICampaignArgs <
-  H extends IHardhatBase,
-  S extends ISignerBase,
-  C extends IDeployCampaignConfig<S>,
+  C extends IDeployCampaignConfig,
   St extends IContractState,
 > {
-  missions : Array<TDeployMissionCtor<H, S, C, St>>;
-  deployer : HardhatDeployer<H, S>;
+  missions : Array<TDeployMissionCtor<C, St>>;
+  deployer : HardhatDeployer;
   dbAdapter : MongoDBAdapter;
   logger : TLogger;
   config : C;
 }
-
-export interface IDeployCampaignConfig <Signer> extends IBaseDataMap<Signer> {
-  env : TEnvironment;
-  deployAdmin : Signer;
-  confirmationsN : number;
-  srcChainName : TSupportedChain;
-  postDeploy : {
-    tenderlyProjectSlug : string;
-    monitorContracts : boolean;
-    verifyContracts : boolean;
-  };
-}

src/create.ts

@@ -1,14 +1,12 @@
 import { getLogger } from "./logger/create-logger";
-import { HardhatDeployer, IHardhatBase, ISignerBase } from "./deployer";
+import { HardhatDeployer, HardhatExtended } from "./deployer";
 import { DeployCampaign, IContractState, IDeployCampaignConfig, TLogger } from "./campaign";
 import { getMongoAdapter, MongoDBAdapter } from "./db";
 import { TDeployMissionCtor } from "./missions";
 
 
 export const createDeployCampaign = async <
-  H extends IHardhatBase,
-  S extends ISignerBase,
-  C extends IDeployCampaignConfig<S>,
+  C extends IDeployCampaignConfig,
   St extends IContractState,
 > ({
   hre,
@@ -24,10 +22,10 @@ export const createDeployCampaign = async <
   clientOpts,
   contractsVersion,
 } : {
-  hre : H;
+  hre : HardhatExtended;
   config : C;
-  missions : Array<TDeployMissionCtor<H, S, C, St>>;
-  deployer ?: HardhatDeployer<H, S>;
+  missions : Array<TDeployMissionCtor<C, St>>;
+  deployer ?: HardhatDeployer;
   logger ?: TLogger;
   dbAdapter ?: MongoDBAdapter;
   dbUri ?: string;
@@ -58,7 +56,7 @@ export const createDeployCampaign = async <
     clientOpts,
   });
 
-  return new DeployCampaign<H, S, C, St>({
+  return new DeployCampaign<C, St>({
     missions,
     deployer,
     dbAdapter,

src/db/mongo-adapter/get-adapter.ts

@@ -40,7 +40,7 @@ export const getMongoAdapter = async ({
     contractsVersion,
   };
 
-  if (!mongoAdapter) {
+  if (mongoAdapter === null) {
     logger.debug("Creating new MongoDBAdapter instance");
     mongoAdapter = new MongoDBAdapter({
       ...params,

src/db/mongo-adapter/mongo-adapter.ts

@@ -112,11 +112,7 @@ export class MongoDBAdapter {
   }
 
   async clearDBForVersion (version : string) {
-    await this.contracts.deleteMany({
-      version,
-    });
-
-    return this.versioner.clearDBForVersion(version);
+    return this.versioner.clearDBForVersion(version, this.db);
   }
 
   async finalize (version ?: string) {

src/db/types.ts

@@ -7,7 +7,7 @@ export interface IContractDbData {
   abi : string;
   bytecode : string;
   implementation : string | null;
-  version : string;
+  version ?: string;
 }
 
 export type TContractDBDoc = WithId<IContractDbData> & IContractDbData;