chore: add support for zkSync

aragon · May 21, 2024 · 5817641 · 5817641
1 parent 18353ce
commit 5817641
Show file tree

Hide file tree

Showing 22 changed files with 194 additions and 111 deletions.
diff --git a/modules/client-common/src/context-core.ts b/modules/client-common/src/context-core.ts
@@ -16,15 +16,19 @@ import {
   UnsupportedProtocolError,
 } from "./errors";
 import {
-  ContractNames,
+  FrameworkContractsNames,
   getNetworkDeploymentForVersion,
   getNetworkNameByAlias,
+  NonFrameworkContractsNames,
   SupportedVersions,
 } from "@aragon/osx-commons-configs";
 
 const DEFAULT_GAS_FEE_ESTIMATION_FACTOR = 0.625;
 const supportedProtocols = ["https:"];
-const contractNames = Object.values(ContractNames);
+const contractNames = [
+  ...Object.values(FrameworkContractsNames),
+  ...Object.values(NonFrameworkContractsNames),
+] as (FrameworkContractsNames | NonFrameworkContractsNames)[];
 if (typeof process !== "undefined" && process?.env?.TESTING) {
   supportedProtocols.push("http:");
 }
@@ -130,7 +134,10 @@ export abstract class ContextCore {
         }
         // custom check for ensRegistryAddress
         // set the ensRegistryAddress to the network.ensAddress
-        if (contractName === ContractNames.ENS_REGISTRY && !contractAddress) {
+        if (
+          contractName === NonFrameworkContractsNames.ENS_REGISTRY &&
+          !contractAddress
+        ) {
           contractAddress = this.network.ensAddress;
         }
         if (contractAddress) {
@@ -225,7 +232,9 @@ export abstract class ContextCore {
     return this.state.graphql;
   }
 
-  public getAddress(contractName: ContractNames): string {
+  public getAddress(
+    contractName: FrameworkContractsNames | NonFrameworkContractsNames,
+  ): string | undefined {
     return this.state[contractName];
   }
 

diff --git a/modules/client-common/src/internal/interfaces.ts b/modules/client-common/src/internal/interfaces.ts
@@ -6,7 +6,11 @@ import { JsonRpcProvider } from "@ethersproject/providers";
 import { Client as IpfsClient, PinResponse } from "@aragon/sdk-ipfs";
 import { GraphQLClient } from "graphql-request";
 import { GasFeeEstimation } from "../types";
-import { ContractNames, SupportedNetworks } from "@aragon/osx-commons-configs";
+import {
+  FrameworkContractsNames,
+  NonFrameworkContractsNames,
+  SupportedNetworks,
+} from "@aragon/osx-commons-configs";
 
 export interface IClientWeb3Core {
   shiftProvider: () => void;
@@ -21,7 +25,9 @@ export interface IClientWeb3Core {
     address: string,
     abi: ContractInterface,
   ) => Contract & T;
-  getAddress: (addressName: ContractNames) => string;
+  getAddress: (
+    addressName: FrameworkContractsNames | NonFrameworkContractsNames,
+  ) => string;
   getApproximateGasFee: (estimatedFee: bigint) => Promise<GasFeeEstimation>;
 }
 export interface IClientIpfsCore {

diff --git a/modules/client-common/src/internal/modules/web3.ts b/modules/client-common/src/internal/modules/web3.ts
@@ -15,8 +15,9 @@ import {
   UnsupportedNetworkError,
 } from "../../errors";
 import {
-  ContractNames,
+  FrameworkContractsNames,
   getNetworkByAlias,
+  NonFrameworkContractsNames,
   SupportedNetworks,
 } from "@aragon/osx-commons-configs";
 export class Web3Module implements IClientWeb3Core {
@@ -139,7 +140,9 @@ export class Web3Module implements IClientWeb3Core {
   }
 
   /** FRAMEWORK ADDRESSES */
-  public getAddress(addressName: ContractNames): string {
+  public getAddress(
+    addressName: FrameworkContractsNames | NonFrameworkContractsNames,
+  ): string {
     const address = this.context.getAddress(addressName);
     if (!address || !isAddress(address)) {
       throw new InvalidAddressError();

diff --git a/modules/client-common/src/internal/types.ts b/modules/client-common/src/internal/types.ts
@@ -2,11 +2,17 @@ import { Signer } from "@ethersproject/abstract-signer";
 import { JsonRpcProvider, Network, Networkish } from "@ethersproject/providers";
 import { Client as IpfsClient } from "@aragon/sdk-ipfs";
 import { GraphQLClient } from "graphql-request";
-import { ContractNames } from "@aragon/osx-commons-configs";
+import {
+  FrameworkContractsNames,
+  NonFrameworkContractsNames,
+} from "@aragon/osx-commons-configs";
 
 export type Web3ContextParams =
   & {
-    [index in ContractNames]?: string;
+    [index in FrameworkContractsNames]?: string;
+  }
+  & {
+    [index in NonFrameworkContractsNames]?: string;
   }
   & {
     /** Defaults to mainnet */
@@ -28,7 +34,10 @@ export type GraphQLContextParams = {
 
 export type Web3ContextState =
   & {
-    [index in ContractNames]: string;
+    [index in FrameworkContractsNames]: string;
+  }
+  & {
+    [index in NonFrameworkContractsNames]?: string;
   }
   & {
     network: Network;

diff --git a/modules/client-common/src/types.ts b/modules/client-common/src/types.ts
@@ -1,4 +1,7 @@
-import { ContractNames } from "@aragon/osx-commons-configs";
+import {
+  FrameworkContractsNames,
+  NonFrameworkContractsNames,
+} from "@aragon/osx-commons-configs";
 import {
   GraphQLContextParams,
   GraphQLContextState,
@@ -20,7 +23,10 @@ export type ContextState =
 
 export type OverriddenState =
   & {
-    [key in ContractNames]: boolean;
+    [key in FrameworkContractsNames]: boolean;
+  }
+  & {
+    [key in NonFrameworkContractsNames]: boolean;
   }
   & {
     gasFeeEstimationFactor: boolean;

diff --git a/modules/client-common/src/utils.ts b/modules/client-common/src/utils.ts
@@ -45,7 +45,7 @@ import {
 } from "./errors";
 import { Zero } from "@ethersproject/constants";
 import {
-  ContractNames,
+  FrameworkContractsNames,
   getNetworkAlias,
   getNetworkByChainId,
   getNetworkByNameOrAlias,
@@ -180,7 +180,7 @@ export async function prepareGenericInstallationEstimation(
     throw new UnsupportedNetworkError(networkName);
   }
   const pspContract = PluginSetupProcessor__factory.connect(
-    deployment[ContractNames.PLUGIN_SETUP_PROCESSOR].address,
+    deployment[FrameworkContractsNames.PLUGIN_SETUP_PROCESSOR].address,
     provider,
   );
 

diff --git a/modules/client-common/test/unit/context.test.ts b/modules/client-common/test/unit/context.test.ts
@@ -10,8 +10,9 @@ import { Client as IpfsClient } from "@aragon/sdk-ipfs";
 import { JsonRpcProvider } from "@ethersproject/providers";
 import { GraphQLClient } from "graphql-request";
 import {
-  ContractNames,
   contracts,
+  FrameworkContractsNames,
+  NonFrameworkContractsNames,
   SupportedNetworks,
 } from "@aragon/osx-commons-configs";
 
@@ -40,10 +41,12 @@ describe("Context instances", () => {
     expect(context).toBeInstanceOf(TestContext);
     expect(context.network.name).toBe("homestead");
     expect(context.network.chainId).toBe(1);
-    expect(context.getAddress(ContractNames.DAO_FACTORY)).toBe(
+    expect(context.getAddress(FrameworkContractsNames.DAO_FACTORY)).toBe(
       contracts.mainnet["v1.3.0"]?.DAOFactory.address,
     );
-    expect(context.getAddress(ContractNames.ENS_REGISTRY)).toBe(context.network.ensAddress);
+    expect(context.getAddress(NonFrameworkContractsNames.ENS_REGISTRY)).toBe(
+      context.network.ensAddress,
+    );
     expect(context.gasFeeEstimationFactor).toBe(0.625);
     expect(context.web3Providers.length).toBe(0);
     expect(context.ipfs.length).toBe(
@@ -68,10 +71,12 @@ describe("Context instances", () => {
     expect(context).toBeInstanceOf(TestContext);
     expect(context.network.name).toBe("homestead");
     expect(context.network.chainId).toBe(1);
-    expect(context.getAddress(ContractNames.DAO_FACTORY)).toBe(
+    expect(context.getAddress(FrameworkContractsNames.DAO_FACTORY)).toBe(
       contextParams.DAOFactory,
     );
-    expect(context.getAddress(ContractNames.ENS_REGISTRY)).toBe(context.network.ensAddress);
+    expect(context.getAddress(NonFrameworkContractsNames.ENS_REGISTRY)).toBe(
+      context.network.ensAddress,
+    );
     expect(context.gasFeeEstimationFactor).toBe(
       contextParams.gasFeeEstimationFactor,
     );
@@ -102,7 +107,9 @@ describe("Context instances", () => {
     expect(context.network.name).toEqual("goerli");
     expect(context.network.chainId).toEqual(5);
     expect(context.signer).toBeInstanceOf(Wallet);
-    expect(context.getAddress(ContractNames.DAO_FACTORY)).toEqual("0x2345");
+    expect(context.getAddress(FrameworkContractsNames.DAO_FACTORY)).toEqual(
+      "0x2345",
+    );
     context.web3Providers?.map((provider) =>
       expect(provider).toBeInstanceOf(JsonRpcProvider)
     );
@@ -122,10 +129,12 @@ describe("Context instances", () => {
     expect(context).toBeInstanceOf(TestContext);
     expect(context.network.name).toBe("goerli");
     expect(context.network.chainId).toBe(5);
-    expect(context.getAddress(ContractNames.DAO_FACTORY)).toBe(
+    expect(context.getAddress(FrameworkContractsNames.DAO_FACTORY)).toBe(
       contracts.goerli["v1.3.0"]?.DAOFactory.address,
     );
-    expect(context.getAddress(ContractNames.ENS_REGISTRY)).toBe(context.network.ensAddress);
+    expect(context.getAddress(NonFrameworkContractsNames.ENS_REGISTRY)).toBe(
+      context.network.ensAddress,
+    );
     expect(context.gasFeeEstimationFactor).toBe(0.625);
     expect(context.web3Providers.length).toBe(1);
     expect(context.ipfs.length).toBe(
@@ -149,10 +158,10 @@ describe("Context instances", () => {
     });
     expect(context.network.name).toBe("matic");
     expect(context.network.chainId).toBe(137);
-    expect(context.getAddress(ContractNames.DAO_FACTORY)).toBe(
+    expect(context.getAddress(FrameworkContractsNames.DAO_FACTORY)).toBe(
       contracts.polygon["v1.3.0"]?.DAOFactory.address,
     );
-    expect(context.getAddress(ContractNames.ENS_REGISTRY)).toBe(
+    expect(context.getAddress(NonFrameworkContractsNames.ENS_REGISTRY)).toBe(
       contracts.polygon["v1.3.0"]?.ENSRegistry?.address,
     );
     expect(context.gasFeeEstimationFactor).toBe(0.625);
@@ -182,10 +191,10 @@ describe("Context instances", () => {
     });
     expect(context.network.name).toBe("matic");
     expect(context.network.chainId).toBe(137);
-    expect(context.getAddress(ContractNames.DAO_FACTORY)).toBe(
+    expect(context.getAddress(FrameworkContractsNames.DAO_FACTORY)).toBe(
       contracts.polygon["v1.3.0"]?.DAOFactory.address,
     );
-    expect(context.getAddress(ContractNames.ENS_REGISTRY)).toBe(
+    expect(context.getAddress(NonFrameworkContractsNames.ENS_REGISTRY)).toBe(
       contracts.polygon["v1.3.0"]?.ENSRegistry?.address,
     );
     expect(context.gasFeeEstimationFactor).toBe(0.625);
@@ -229,10 +238,12 @@ describe("Context instances", () => {
     expect(context).toBeInstanceOf(TestContext);
     expect(context.network.name).toBe("matic");
     expect(context.network.chainId).toBe(137);
-    expect(context.getAddress(ContractNames.DAO_FACTORY)).toBe(
+    expect(context.getAddress(FrameworkContractsNames.DAO_FACTORY)).toBe(
       contracts.polygon["v1.3.0"]?.DAOFactory.address,
     );
-    expect(context.getAddress(ContractNames.ENS_REGISTRY)).toBe(ADDRESS_ONE);
+    expect(context.getAddress(NonFrameworkContractsNames.ENS_REGISTRY)).toBe(
+      ADDRESS_ONE,
+    );
     expect(context.gasFeeEstimationFactor).toBe(0.625);
     expect(context.web3Providers.length).toBe(0);
     expect(context.ipfs.length).toBe(
@@ -280,10 +291,10 @@ describe("Context instances", () => {
         );
       })
     );
-    expect(context.getAddress(ContractNames.DAO_FACTORY)).toEqual(
+    expect(context.getAddress(FrameworkContractsNames.DAO_FACTORY)).toEqual(
       contracts.polygon["v1.3.0"]?.DAOFactory.address,
     );
-    expect(context.getAddress(ContractNames.ENS_REGISTRY)).toEqual(
+    expect(context.getAddress(NonFrameworkContractsNames.ENS_REGISTRY)).toEqual(
       contracts.polygon["v1.3.0"]?.ENSRegistry?.address,
     );
   });
@@ -296,10 +307,10 @@ describe("Context instances", () => {
     expect(context).toBeInstanceOf(TestContext);
     expect(context.network.name).toBe("baseGoerli");
     expect(context.network.chainId).toBe(84531);
-    expect(context.getAddress(ContractNames.DAO_FACTORY)).toBe(
+    expect(context.getAddress(FrameworkContractsNames.DAO_FACTORY)).toBe(
       contracts.baseGoerli["v1.3.0"]?.DAOFactory.address,
     );
-    expect(context.getAddress(ContractNames.ENS_REGISTRY)).toBe(
+    expect(context.getAddress(NonFrameworkContractsNames.ENS_REGISTRY)).toBe(
       contracts.baseGoerli["v1.3.0"]?.ENSRegistry?.address,
     );
     expect(context.gasFeeEstimationFactor).toBe(0.625);
@@ -312,7 +323,7 @@ describe("Context instances", () => {
       expect(nw.name).toEqual("baseGoerli");
       expect(nw.ensAddress).toEqual(
         contracts.baseGoerli["v1.3.0"]?.ENSRegistry?.address,
-        );
+      );
     }
   });
 });
diff --git a/modules/client/src/addresslistVoting/internal/client/encoding.ts b/modules/client/src/addresslistVoting/internal/client/encoding.ts
@@ -57,7 +57,7 @@ export class AddresslistVotingClientEncoding extends ClientCore
       ],
     );
     const repoAddress = contracts[aragonNetwork][SupportedVersions.V1_3_0]
-      ?.AddresslistVotingRepoProxy.address;
+      ?.AddresslistVotingRepoProxy?.address;
     if (!repoAddress) {
       throw new Error("AddresslistVotingRepoProxy address not found");
     }

diff --git a/modules/client/src/addresslistVoting/internal/client/estimation.ts b/modules/client/src/addresslistVoting/internal/client/estimation.ts
@@ -6,15 +6,18 @@ import {
 import { IAddresslistVotingClientEstimation } from "../interfaces";
 import { toUtf8Bytes } from "@ethersproject/strings";
 import {
+  boolArrayToBitmap,
   ClientCore,
   decodeProposalId,
   GasFeeEstimation,
   prepareGenericUpdateEstimation,
   SizeMismatchError,
-  boolArrayToBitmap,
 } from "@aragon/sdk-client-common";
 import { AddresslistVotingPluginPrepareUpdateParams } from "../../types";
-import { ContractNames } from "@aragon/osx-commons-configs";
+import {
+  FrameworkContractsNames,
+  NonFrameworkContractsNames,
+} from "@aragon/osx-commons-configs";
 
 /**
  * Estimation module the SDK Address List Client
@@ -129,10 +132,10 @@ export class AddresslistVotingClientEstimation extends ClientCore
     return await prepareGenericUpdateEstimation(this.web3, this.graphql, {
       ...params,
       pluginSetupProcessorAddress: this.web3.getAddress(
-        ContractNames.PLUGIN_SETUP_PROCESSOR,
+        FrameworkContractsNames.PLUGIN_SETUP_PROCESSOR,
       ),
       pluginRepo: this.web3.getAddress(
-        ContractNames.ADDRESSLIST_VOTING_REPO_PROXY,
+        NonFrameworkContractsNames.ADDRESSLIST_VOTING_REPO_PROXY,
       ),
     });
   }