[contract-manager] General improvements (#1024)

* Better return types for transaction execution functions

* Use new type for passing PrivateKey

* Small typing improvements

* Stricter liniting

* Rename edge to beta for DeploymentType

* Reduce any usage across the contract manager

* Fix explicit any linting warnings

Author: m30m

contract_manager/.eslintrc.js

@@ -0,0 +1,6 @@
+module.exports = {
+  root: true,
+  parser: "@typescript-eslint/parser",
+  plugins: ["@typescript-eslint"],
+  extends: ["eslint:recommended", "plugin:@typescript-eslint/recommended"],
+};

contract_manager/package.json

@@ -10,7 +10,8 @@
   ],
   "scripts": {
     "build": "tsc",
-    "shell": "ts-node ./src/shell.ts"
+    "shell": "ts-node ./src/shell.ts",
+    "lint": "eslint src/"
   },
   "author": "",
   "license": "Apache-2.0",

contract_manager/scripts/update_pricefeed.ts

@@ -1,6 +1,6 @@
 import yargs from "yargs";
 import { hideBin } from "yargs/helpers";
-import { DefaultStore } from "../src";
+import { DefaultStore, toPrivateKey } from "../src";
 import { PriceServiceConnection } from "@pythnetwork/price-service-client";
 
 const parser = yargs(hideBin(process.argv))
@@ -43,9 +43,12 @@ async function main() {
     argv.endpoint || defaultEndpoint
   );
   const vaas = await priceService.getLatestVaas(argv["feed-id"] as string[]);
-  await contract.executeUpdatePriceFeed(
-    argv["private-key"],
-    vaas.map((vaa) => Buffer.from(vaa, "base64"))
+  const privateKey = toPrivateKey(argv["private-key"]);
+  console.log(
+    await contract.executeUpdatePriceFeed(
+      privateKey,
+      vaas.map((vaa) => Buffer.from(vaa, "base64"))
+    )
   );
 }
 

contract_manager/src/base.ts

@@ -1,6 +1,24 @@
 import { DataSource } from "xc_admin_common";
 import { Chain } from "./chains";
 
+export interface TxResult {
+  id: string;
+  info: unknown; // chain specific info
+}
+
+export type DeploymentType = "stable" | "beta";
+export type PrivateKey = string & { __type: "PrivateKey" };
+function checkIsPrivateKey(key: string): asserts key is PrivateKey {
+  if (Buffer.from(key, "hex").length !== 32)
+    throw new Error("Invalid private key, must be 64 hex chars");
+}
+export function toPrivateKey(key: string): PrivateKey {
+  checkIsPrivateKey(key);
+  return key;
+}
+
+export type KeyValueConfig = Record<string, string | number | boolean>;
+
 export abstract class Storable {
   /**
    * Returns the unique identifier for this object
@@ -17,7 +35,7 @@ export abstract class Storable {
    * Returns a JSON representation of this object. It should be possible to
    * reconstruct the object from the JSON using the fromJson method.
    */
-  abstract toJson(): any;
+  abstract toJson(): KeyValueConfig;
 }
 
 export interface Price {
@@ -75,31 +93,31 @@ export abstract class Contract extends Storable {
    * @param vaas an array of VAAs containing price update messages to execute
    */
   abstract executeUpdatePriceFeed(
-    senderPrivateKey: string,
+    senderPrivateKey: PrivateKey,
     vaas: Buffer[]
-  ): Promise<any>;
+  ): Promise<TxResult>;
 
   /**
    * Executes the governance instruction contained in the VAA using the sender credentials
    * @param senderPrivateKey private key of the sender in hex format without 0x prefix
    * @param vaa the VAA to execute
    */
   abstract executeGovernanceInstruction(
-    senderPrivateKey: string,
+    senderPrivateKey: PrivateKey,
     vaa: Buffer
-  ): Promise<any>;
+  ): Promise<TxResult>;
 
   /**
    * Returns the single data source that this contract accepts governance messages from
    */
   abstract getGovernanceDataSource(): Promise<DataSource>;
 }
 
-export function getDefaultDeploymentConfig(deploymentType: "stable" | "edge"): {
+export function getDefaultDeploymentConfig(deploymentType: DeploymentType): {
   dataSources: DataSource[];
   governanceDataSource: DataSource;
   wormholeConfig: {
-    governanceChainId: Number;
+    governanceChainId: number;
     governanceContract: string; // 32 byte address in 64 char hex format
     initialGuardianSet: string[]; // 20 byte addresses in 40 char hex format
   };
@@ -135,7 +153,7 @@ export function getDefaultDeploymentConfig(deploymentType: "stable" | "edge"): {
         initialGuardianSet: ["58cc3ae5c097b213ce3c81979e1b9f9570746aa5"],
       },
     };
-  else if (deploymentType === "edge")
+  else if (deploymentType === "beta")
     return {
       dataSources: [
         {

contract_manager/src/chains.ts

@@ -1,7 +1,6 @@
-import { Storable } from "./base";
+import { KeyValueConfig, PrivateKey, Storable } from "./base";
 import {
   ChainName,
-  CHAINS,
   SetFee,
   CosmosUpgradeContract,
   EvmUpgradeContract,
@@ -22,6 +21,10 @@ import {
 } from "@pythnetwork/cosmwasm-deploy-tools";
 import { Network } from "@injectivelabs/networks";
 
+export type ChainConfig = Record<string, string> & {
+  mainnet: boolean;
+  id: string;
+};
 export abstract class Chain extends Storable {
   public wormholeChainName: ChainName;
 
@@ -92,15 +95,15 @@ export abstract class Chain extends Storable {
    * Returns the payload for a governance contract upgrade instruction for contracts deployed on this chain
    * @param upgradeInfo based on the contract type, this can be a contract address, codeId, package digest, etc.
    */
-  abstract generateGovernanceUpgradePayload(upgradeInfo: any): Buffer;
+  abstract generateGovernanceUpgradePayload(upgradeInfo: unknown): Buffer;
 }
 
 export class GlobalChain extends Chain {
-  static type: string = "GlobalChain";
+  static type = "GlobalChain";
   constructor() {
     super("global", true, "unset");
   }
-  generateGovernanceUpgradePayload(upgradeInfo: any): Buffer {
+  generateGovernanceUpgradePayload(): Buffer {
     throw new Error(
       "Can not create a governance message for upgrading contracts on all chains!"
     );
@@ -110,7 +113,7 @@ export class GlobalChain extends Chain {
     return GlobalChain.type;
   }
 
-  toJson(): any {
+  toJson(): KeyValueConfig {
     return {
       id: this.id,
       wormholeChainName: this.wormholeChainName,
@@ -121,7 +124,7 @@ export class GlobalChain extends Chain {
 }
 
 export class CosmWasmChain extends Chain {
-  static type: string = "CosmWasmChain";
+  static type = "CosmWasmChain";
 
   constructor(
     id: string,
@@ -135,7 +138,7 @@ export class CosmWasmChain extends Chain {
     super(id, mainnet, wormholeChainName);
   }
 
-  static fromJson(parsed: any): CosmWasmChain {
+  static fromJson(parsed: ChainConfig): CosmWasmChain {
     if (parsed.type !== CosmWasmChain.type) throw new Error("Invalid type");
     return new CosmWasmChain(
       parsed.id,
@@ -148,7 +151,7 @@ export class CosmWasmChain extends Chain {
     );
   }
 
-  toJson(): any {
+  toJson(): KeyValueConfig {
     return {
       endpoint: this.endpoint,
       id: this.id,
@@ -174,7 +177,7 @@ export class CosmWasmChain extends Chain {
     return new CosmosUpgradeContract(this.wormholeChainName, codeId).encode();
   }
 
-  async getExecutor(privateKey: string) {
+  async getExecutor(privateKey: PrivateKey) {
     if (this.getId().indexOf("injective") > -1) {
       return InjectiveExecutor.fromPrivateKey(
         this.isMainnet() ? Network.Mainnet : Network.Testnet,
@@ -190,7 +193,7 @@ export class CosmWasmChain extends Chain {
 }
 
 export class SuiChain extends Chain {
-  static type: string = "SuiChain";
+  static type = "SuiChain";
 
   constructor(
     id: string,
@@ -201,7 +204,7 @@ export class SuiChain extends Chain {
     super(id, mainnet, wormholeChainName);
   }
 
-  static fromJson(parsed: any): SuiChain {
+  static fromJson(parsed: ChainConfig): SuiChain {
     if (parsed.type !== SuiChain.type) throw new Error("Invalid type");
     return new SuiChain(
       parsed.id,
@@ -211,7 +214,7 @@ export class SuiChain extends Chain {
     );
   }
 
-  toJson(): any {
+  toJson(): KeyValueConfig {
     return {
       id: this.id,
       wormholeChainName: this.wormholeChainName,
@@ -238,7 +241,7 @@ export class SuiChain extends Chain {
 }
 
 export class EvmChain extends Chain {
-  static type: string = "EvmChain";
+  static type = "EvmChain";
 
   constructor(
     id: string,
@@ -250,7 +253,7 @@ export class EvmChain extends Chain {
     super(id, mainnet, wormholeChainName);
   }
 
-  static fromJson(parsed: any): EvmChain {
+  static fromJson(parsed: ChainConfig & { networkId: number }): EvmChain {
     if (parsed.type !== EvmChain.type) throw new Error("Invalid type");
     return new EvmChain(
       parsed.id,
@@ -277,7 +280,7 @@ export class EvmChain extends Chain {
     return new EvmSetWormholeAddress(this.wormholeChainName, address).encode();
   }
 
-  toJson(): any {
+  toJson(): KeyValueConfig {
     return {
       id: this.id,
       wormholeChainName: this.wormholeChainName,
@@ -311,10 +314,10 @@ export class EvmChain extends Chain {
    * @returns the address of the deployed contract
    */
   async deploy(
-    privateKey: string,
-    abi: any,
+    privateKey: PrivateKey,
+    abi: any, // eslint-disable-line  @typescript-eslint/no-explicit-any
     bytecode: string,
-    deployArgs: any[]
+    deployArgs: any[] // eslint-disable-line  @typescript-eslint/no-explicit-any
   ): Promise<string> {
     const web3 = new Web3(this.getRpcUrl());
     const signer = web3.eth.accounts.privateKeyToAccount(privateKey);
@@ -375,7 +378,7 @@ export class AptosChain extends Chain {
     return AptosChain.type;
   }
 
-  toJson(): any {
+  toJson(): KeyValueConfig {
     return {
       id: this.id,
       wormholeChainName: this.wormholeChainName,
@@ -385,7 +388,7 @@ export class AptosChain extends Chain {
     };
   }
 
-  static fromJson(parsed: any): AptosChain {
+  static fromJson(parsed: ChainConfig): AptosChain {
     if (parsed.type !== AptosChain.type) throw new Error("Invalid type");
     return new AptosChain(
       parsed.id,