feat(contract_manager): separate store for wormhole (#1493)

* rename wormhole contract as per other names

* store for wormhole

* fix var name

* rename var

* rename contract based on other namings

* add yaml for aptos and cosmwasm

Author: Dev Kalra

contract_manager/scripts/check_proposal.ts

@@ -23,7 +23,7 @@ import {
   EvmEntropyContract,
   EvmPriceFeedContract,
   getCodeDigestWithoutAddress,
-  WormholeEvmContract,
+  EvmWormholeContract,
 } from "../src/contracts/evm";
 import Web3 from "web3";
 
@@ -73,7 +73,7 @@ async function main() {
               instruction.governanceAction.targetChainId
           ) {
             const address = instruction.governanceAction.address;
-            const contract = new WormholeEvmContract(chain, address);
+            const contract = new EvmWormholeContract(chain, address);
             const currentIndex = await contract.getCurrentGuardianSetIndex();
             const guardianSet = await contract.getGuardianSet();
 

contract_manager/scripts/deploy_evm_entropy_contracts.ts

@@ -10,7 +10,7 @@ import {
   PrivateKey,
   toDeploymentType,
   toPrivateKey,
-  WormholeEvmContract,
+  EvmWormholeContract,
 } from "../src";
 import {
   COMMON_DEPLOY_OPTIONS,
@@ -200,7 +200,7 @@ async function main() {
     saveContract: argv.saveContract,
     wormholeAddr,
   };
-  const wormholeContract = new WormholeEvmContract(
+  const wormholeContract = new EvmWormholeContract(
     chain,
     deploymentConfig.wormholeAddr
   );

contract_manager/scripts/deploy_evm_pricefeed_contracts.ts

@@ -9,7 +9,7 @@ import {
   PrivateKey,
   toDeploymentType,
   toPrivateKey,
-  WormholeEvmContract,
+  EvmWormholeContract,
 } from "../src";
 import {
   COMMON_DEPLOY_OPTIONS,
@@ -98,15 +98,12 @@ async function deployWormholeReceiverContracts(
     [receiverSetupAddr, initData]
   );
 
-  const wormholeEvmContract = new WormholeEvmContract(
-    chain,
-    wormholeReceiverAddr
-  );
+  const wormholeContract = new EvmWormholeContract(chain, wormholeReceiverAddr);
 
   if (config.type === "stable") {
     console.log(`Syncing mainnet guardian sets for ${chain.getId()}...`);
     // TODO: Add a way to pass gas configs to this
-    await wormholeEvmContract.syncMainnetGuardianSets(config.privateKey);
+    await wormholeContract.syncMainnetGuardianSets(config.privateKey);
     console.log(`✅ Synced mainnet guardian sets for ${chain.getId()}`);
   }
 

contract_manager/src/contracts/aptos.ts

@@ -17,7 +17,39 @@ type GuardianSet = {
   index: { number: string };
 };
 
-export class WormholeAptosContract extends WormholeContract {
+export class AptosWormholeContract extends WormholeContract {
+  static type = "AptosWormholeContract";
+
+  getId(): string {
+    return `${this.chain.getId()}_${this.address}`;
+  }
+
+  getType(): string {
+    return AptosWormholeContract.type;
+  }
+
+  toJson() {
+    return {
+      chain: this.chain.getId(),
+      address: this.address,
+      type: AptosWormholeContract.type,
+    };
+  }
+
+  static fromJson(
+    chain: Chain,
+    parsed: {
+      type: string;
+      address: string;
+    }
+  ): AptosWormholeContract {
+    if (parsed.type !== AptosWormholeContract.type)
+      throw new Error("Invalid type");
+    if (!(chain instanceof AptosChain))
+      throw new Error(`Wrong chain type ${chain}`);
+    return new AptosWormholeContract(chain, parsed.address);
+  }
+
   constructor(public chain: AptosChain, public address: string) {
     super();
   }
@@ -124,8 +156,8 @@ export class AptosPriceFeedContract extends PriceFeedContract {
     return this.chain.sendTransaction(senderPrivateKey, txPayload);
   }
 
-  public getWormholeContract(): WormholeAptosContract {
-    return new WormholeAptosContract(this.chain, this.wormholeStateId);
+  public getWormholeContract(): AptosWormholeContract {
+    return new AptosWormholeContract(this.chain, this.wormholeStateId);
   }
 
   async executeUpdatePriceFeed(

contract_manager/src/contracts/cosmwasm.ts

@@ -38,7 +38,36 @@ export interface DeploymentConfig {
   fee: { amount: string; denom: string };
 }
 
-export class WormholeCosmWasmContract extends WormholeContract {
+export class CosmWasmWormholeContract extends WormholeContract {
+  static type = "CosmWasmWormholeContract";
+
+  getId(): string {
+    return `${this.chain.getId()}_${this.address}`;
+  }
+
+  getType(): string {
+    return CosmWasmWormholeContract.type;
+  }
+
+  toJson() {
+    return {
+      chain: this.chain.getId(),
+      address: this.address,
+      type: CosmWasmWormholeContract.type,
+    };
+  }
+
+  static fromJson(
+    chain: Chain,
+    parsed: { type: string; address: string }
+  ): CosmWasmWormholeContract {
+    if (parsed.type !== CosmWasmWormholeContract.type)
+      throw new Error("Invalid type");
+    if (!(chain instanceof CosmWasmChain))
+      throw new Error(`Wrong chain type ${chain}`);
+    return new CosmWasmWormholeContract(chain, parsed.address);
+  }
+
   constructor(public chain: CosmWasmChain, public address: string) {
     super();
   }
@@ -310,10 +339,10 @@ export class CosmWasmPriceFeedContract extends PriceFeedContract {
     return { id: result.txHash, info: result };
   }
 
-  async getWormholeContract(): Promise<WormholeCosmWasmContract> {
+  async getWormholeContract(): Promise<CosmWasmWormholeContract> {
     const config = await this.getConfig();
     const wormholeAddress = config.config_v1.wormhole_contract;
-    return new WormholeCosmWasmContract(this.chain, wormholeAddress);
+    return new CosmWasmWormholeContract(this.chain, wormholeAddress);
   }
 
   async getUpdateFee(msgs: string[]): Promise<Coin> {

contract_manager/src/contracts/evm.ts

@@ -390,7 +390,37 @@ export async function getCodeDigestWithoutAddress(
   return Web3.utils.keccak256(strippedCode);
 }
 
-export class WormholeEvmContract extends WormholeContract {
+export class EvmWormholeContract extends WormholeContract {
+  static type = "EvmWormholeContract";
+
+  getId(): string {
+    return `${this.chain.getId()}_${this.address}`;
+  }
+
+  getChain(): EvmChain {
+    return this.chain;
+  }
+
+  getType(): string {
+    return EvmWormholeContract.type;
+  }
+
+  async getVersion(): Promise<string> {
+    const contract = this.getContract();
+    return contract.methods.version().call();
+  }
+
+  static fromJson(
+    chain: Chain,
+    parsed: { type: string; address: string }
+  ): EvmWormholeContract {
+    if (parsed.type !== EvmWormholeContract.type)
+      throw new Error("Invalid type");
+    if (!(chain instanceof EvmChain))
+      throw new Error(`Wrong chain type ${chain}`);
+    return new EvmWormholeContract(chain, parsed.address);
+  }
+
   constructor(public chain: EvmChain, public address: string) {
     super();
   }
@@ -436,6 +466,14 @@ export class WormholeEvmContract extends WormholeContract {
     );
     return { id: result.transactionHash, info: result };
   }
+
+  toJson() {
+    return {
+      chain: this.chain.getId(),
+      address: this.address,
+      type: EvmWormholeContract.type,
+    };
+  }
 }
 
 interface EntropyProviderInfo {
@@ -651,13 +689,13 @@ export class EvmExecutorContract {
     return `${this.chain.getId()}_${this.address}`;
   }
 
-  async getWormholeContract(): Promise<WormholeEvmContract> {
+  async getWormholeContract(): Promise<EvmWormholeContract> {
     const web3 = new Web3(this.chain.getRpcUrl());
     //Unfortunately, there is no public method to get the wormhole address
     //Found 251 by using `forge build --extra-output storageLayout` and finding the slot for the wormhole variable.
     let address = await web3.eth.getStorageAt(this.address, 251);
     address = "0x" + address.slice(26);
-    return new WormholeEvmContract(this.chain, address);
+    return new EvmWormholeContract(this.chain, address);
   }
 
   getContract() {
@@ -822,10 +860,10 @@ export class EvmPriceFeedContract extends PriceFeedContract {
   /**
    * Returns the wormhole contract which is being used for VAA verification
    */
-  async getWormholeContract(): Promise<WormholeEvmContract> {
+  async getWormholeContract(): Promise<EvmWormholeContract> {
     const pythContract = this.getContract();
     const address = await pythContract.methods.wormhole().call();
-    return new WormholeEvmContract(this.chain, address);
+    return new EvmWormholeContract(this.chain, address);
   }
 
   async getBaseUpdateFee() {

contract_manager/src/contracts/wormhole.ts

@@ -1,6 +1,6 @@
-import { PrivateKey, TxResult } from "../base";
+import { PrivateKey, Storable, TxResult } from "../base";
 
-export abstract class WormholeContract {
+export abstract class WormholeContract extends Storable {
   abstract getCurrentGuardianSetIndex(): Promise<number>;
 
   /**

contract_manager/src/shell.ts

@@ -8,9 +8,9 @@ repl.evalCode(
   "import { loadHotWallet, Vault } from './src/governance';" +
     "import { SuiChain, CosmWasmChain, AptosChain, EvmChain } from './src/chains';" +
     "import { SuiPriceFeedContract } from './src/contracts/sui';" +
-    "import { WormholeCosmWasmContract, CosmWasmPriceFeedContract } from './src/contracts/cosmwasm';" +
-    "import { WormholeEvmContract, EvmPriceFeedContract } from './src/contracts/evm';" +
-    "import { WormholeAptosContract, AptosPriceFeedContract } from './src/contracts/aptos';" +
+    "import { CosmWasmWormholeContract, CosmWasmPriceFeedContract } from './src/contracts/cosmwasm';" +
+    "import { EvmWormholeContract, EvmPriceFeedContract } from './src/contracts/evm';" +
+    "import { AptosWormholeContract, AptosPriceFeedContract } from './src/contracts/aptos';" +
     "import { DefaultStore } from './src/store';" +
     "import { toPrivateKey } from './src/base';" +
     "DefaultStore"

contract_manager/src/store.ts

@@ -8,10 +8,14 @@ import {
 } from "./chains";
 import {
   AptosPriceFeedContract,
+  AptosWormholeContract,
   CosmWasmPriceFeedContract,
+  CosmWasmWormholeContract,
   EvmEntropyContract,
   EvmPriceFeedContract,
+  EvmWormholeContract,
   SuiPriceFeedContract,
+  WormholeContract,
 } from "./contracts";
 import { Token } from "./token";
 import { PriceFeedContract, Storable } from "./base";
@@ -23,6 +27,7 @@ export class Store {
   public chains: Record<string, Chain> = { global: new GlobalChain() };
   public contracts: Record<string, PriceFeedContract> = {};
   public entropy_contracts: Record<string, EvmEntropyContract> = {};
+  public wormhole_contracts: Record<string, WormholeContract> = {};
   public tokens: Record<string, Token> = {};
   public vaults: Record<string, Vault> = {};
 
@@ -81,6 +86,7 @@ export class Store {
     const contractsByType: Record<string, Storable[]> = {};
     const contracts: Storable[] = Object.values(this.contracts);
     contracts.push(...Object.values(this.entropy_contracts));
+    contracts.push(...Object.values(this.wormhole_contracts));
     for (const contract of contracts) {
       if (!contractsByType[contract.getType()]) {
         contractsByType[contract.getType()] = [];
@@ -114,10 +120,13 @@ export class Store {
   loadAllContracts() {
     const allContractClasses = {
       [CosmWasmPriceFeedContract.type]: CosmWasmPriceFeedContract,
+      [CosmWasmWormholeContract.type]: CosmWasmWormholeContract,
       [SuiPriceFeedContract.type]: SuiPriceFeedContract,
       [EvmPriceFeedContract.type]: EvmPriceFeedContract,
       [AptosPriceFeedContract.type]: AptosPriceFeedContract,
+      [AptosWormholeContract.type]: AptosWormholeContract,
       [EvmEntropyContract.type]: EvmEntropyContract,
+      [EvmWormholeContract.type]: EvmWormholeContract,
     };
     this.getYamlFiles(`${this.path}/contracts/`).forEach((yamlFile) => {
       const parsedArray = parse(readFileSync(yamlFile, "utf-8"));
@@ -132,13 +141,16 @@ export class Store {
         );
         if (
           this.contracts[chainContract.getId()] ||
-          this.entropy_contracts[chainContract.getId()]
+          this.entropy_contracts[chainContract.getId()] ||
+          this.wormhole_contracts[chainContract.getId()]
         )
           throw new Error(
             `Multiple contracts with id ${chainContract.getId()} found`
           );
         if (chainContract instanceof EvmEntropyContract) {
           this.entropy_contracts[chainContract.getId()] = chainContract;
+        } else if (chainContract instanceof WormholeContract) {
+          this.wormhole_contracts[chainContract.getId()] = chainContract;
         } else {
           this.contracts[chainContract.getId()] = chainContract;
         }

contract_manager/store/contracts/AptosWormholeContracts.yaml

@@ -0,0 +1,9 @@
+- chain: aptos_mainnet
+  address: "0x5bc11445584a763c1fa7ed39081f1b920954da14e04b32440cba863d03e19625"
+  type: AptosWormholeContract
+- chain: aptos_testnet
+  address: "0x5bc11445584a763c1fa7ed39081f1b920954da14e04b32440cba863d03e19625"
+  type: AptosWormholeContract
+- chain: movement_move_devnet
+  address: "0x9236893d6444b208b7e0b3e8d4be4ace90b6d17817ab7d1584e46a33ef5c50c9"
+  type: AptosWormholeContract