Register zksync contract on multichain registry after deployment (#3717)

kumaryash90 · kumaryash90 · commit d6b2c259d9a0 · 2024-07-19T22:35:39.000Z
&lt;!-- start pr-codex --&gt;

## PR-Codex overview
The focus of this PR is to enhance the deployment process of contracts by adding a gas override option and improving the registration process on the multichain registry for ZkSync contracts.

### Detailed summary
- Added `gasOverride` option for contract deployment
- Improved ZkSync contract registration process
- Removed unnecessary contract registration function
- Updated contract deployment handling for ZkSync
- Refactored contract deployment logic and metadata handling

&gt; ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your question}`

&lt;!-- end pr-codex --&gt;
diff --git a/apps/dashboard/src/components/contract-components/hooks.ts b/apps/dashboard/src/components/contract-components/hooks.ts
@@ -30,6 +30,7 @@ import {
   extractEventsFromAbi,
   extractFunctionParamsFromAbi,
   extractFunctionsFromAbi,
+  fetchAndCacheDeployMetadata,
   fetchContractMetadata,
   fetchPreDeployMetadata,
   fetchRawPredeployMetadata,
@@ -638,6 +639,12 @@ export function useCustomContractDeployMutation(
       // open the modal with the appropriate steps
       deployContext.open(steps);
 
+      const isZkSync =
+        chainId === Zksync.chainId ||
+        chainId === ZksyncSepoliaTestnet.chainId ||
+        chainId === ZkcandySepoliaTestnet.chainId ||
+        chainId === ZksyncEraGoerliTestnetDeprecated.chainId;
+
       let contractAddress: string;
       try {
         if (hasContractURI) {
@@ -692,14 +699,15 @@ export function useCustomContractDeployMutation(
         }
 
         // Handle ZkSync deployments separately
-        const isZkSync =
-          chainId === Zksync.chainId ||
-          chainId === ZksyncSepoliaTestnet.chainId ||
-          chainId === ZkcandySepoliaTestnet.chainId ||
-          chainId === ZksyncEraGoerliTestnetDeprecated.chainId;
 
         // deploy contract
         if (isZkSync) {
+          const publishUri = ipfsHash.startsWith("ipfs://")
+            ? ipfsHash
+            : `ipfs://${ipfsHash}`;
+
+          let uriToRegister = "";
+
           if (
             fullPublishMetadata?.data?.compilers?.zksolc ||
             rawPredeployMetadata?.data?.compilers?.zksolc
@@ -712,9 +720,7 @@ export function useCustomContractDeployMutation(
                 : data.saltForCreate2;
 
               contractAddress = await zkDeployContractFromUri(
-                ipfsHash.startsWith("ipfs://")
-                  ? ipfsHash
-                  : `ipfs://${ipfsHash}`,
+                publishUri,
                 Object.values(data.deployParams),
                 signer,
                 StorageSingleton,
@@ -729,9 +735,7 @@ export function useCustomContractDeployMutation(
               );
             } else {
               contractAddress = await zkDeployContractFromUri(
-                ipfsHash.startsWith("ipfs://")
-                  ? ipfsHash
-                  : `ipfs://${ipfsHash}`,
+                publishUri,
                 Object.values(data.deployParams),
                 signer,
                 StorageSingleton,
@@ -743,15 +747,44 @@ export function useCustomContractDeployMutation(
                 },
               );
             }
+
+            const { compilerMetadata } = await fetchAndCacheDeployMetadata(
+              publishUri,
+              StorageSingleton,
+              {
+                compilerType: "zksolc",
+              },
+            );
+            uriToRegister = compilerMetadata.fetchedMetadataUri;
           } else {
             contractAddress = await zkDeployContractFromUri(
-              ipfsHash.startsWith("ipfs://") ? ipfsHash : `ipfs://${ipfsHash}`,
+              publishUri,
               Object.values(data.deployParams),
               signer,
               StorageSingleton,
               chainId as number,
             );
+
+            const { compilerMetadata } = await fetchAndCacheDeployMetadata(
+              publishUri,
+              StorageSingleton,
+              {
+                compilerType: "zksolc",
+              },
+            );
+            uriToRegister = compilerMetadata.fetchedMetadataUri;
           }
+
+          // register deployed zksync contract on multichain registry
+          await addContractToMultiChainRegistry(
+            {
+              address: contractAddress,
+              chainId,
+              metadataURI: uriToRegister,
+            },
+            account,
+            300000n,
+          );
         } else {
           if (data.deployDeterministic) {
             const salt = data.signerAsSalt
@@ -805,7 +838,7 @@ export function useCustomContractDeployMutation(
 
       try {
         // let user decide if they want this or not
-        if (data.addToDashboard) {
+        if (data.addToDashboard && !isZkSync) {
           invariant(chainId, "chainId is not provided");
           await addContractToMultiChainRegistry(
             {
diff --git a/apps/dashboard/src/components/contract-components/utils.ts b/apps/dashboard/src/components/contract-components/utils.ts
@@ -73,6 +73,7 @@ const registry = getContract({
 export async function addContractToMultiChainRegistry(
   contractData: AddContractInput,
   account: Account,
+  gasOverride?: bigint,
 ) {
   const transaction = prepareContractCall({
     contract: registry,
@@ -86,7 +87,10 @@ export async function addContractToMultiChainRegistry(
   });
 
   await sendAndConfirmTransaction({
-    transaction,
+    transaction: {
+      ...transaction,
+      gas: gasOverride || transaction.gas,
+    },
     account,
     gasless: {
       experimentalChainlessSupport: true,
diff --git a/legacy_packages/sdk/src/evm/zksync/zkDeployContractDeterministic.ts b/legacy_packages/sdk/src/evm/zksync/zkDeployContractDeterministic.ts
@@ -5,7 +5,6 @@ import { isZkContractDeployed } from "./isZkContractDeployed";
 import {
   Contract,
   Signer,
-  Wallet,
   ContractFactory as ZkContractFactory,
 } from "zksync-ethers";
 import { DeployOptions } from "../types/deploy/deploy-options";
@@ -18,7 +17,6 @@ import { PrecomputedDeploymentTransaction } from "./types/deploy-data";
 import { zkVerify } from "./zksync-verification";
 import { blockExplorerApiMap } from "./constants/addresses";
 import { ThirdwebStorage } from "@thirdweb-dev/storage";
-import { ThirdwebSDK } from "../core/sdk";
 
 /**
  * Deploy a contract at a deterministic address, using Create2 method
@@ -110,16 +108,9 @@ export async function zkDeployContractDeterministic(
       }
     }
 
-    // register on multichain registry, and verify -- no await
+    // verify -- no await
     if (metadataUri && storage) {
       const chainId = await signer.getChainId();
-      try {
-        registerContractOnMultiChainRegistry(
-          transaction.predictedAddress,
-          chainId,
-          metadataUri,
-        );
-      } catch (error) {}
 
       zkVerify(
         transaction.predictedAddress,
@@ -134,41 +125,3 @@ export async function zkDeployContractDeterministic(
     }
   }
 }
-
-export async function registerContractOnMultiChainRegistry(
-  address: string,
-  chainId: number,
-  metadataURI: string,
-) {
-  try {
-    // random wallet is fine here, we're doing gasless calls
-    const wallet = Wallet.createRandom();
-    const sdk = ThirdwebSDK.fromPrivateKey(wallet.privateKey, "polygon", {
-      gasless: {
-        openzeppelin: {
-          relayerUrl:
-            "https://api.defender.openzeppelin.com/autotasks/dad61716-3624-46c9-874f-0e73f15f04d5/runs/webhook/7d6a1834-dd33-4b7b-8af4-b6b4719a0b97/FdHMqyF3p6MGHw6K2nkLsv",
-          relayerForwarderAddress: "0x409d530a6961297ece29121dbee2c917c3398659",
-        },
-        experimentalChainlessSupport: true,
-      },
-    });
-    const existingMeta = await sdk.multiChainRegistry.getContractMetadataURI(
-      chainId,
-      address,
-    );
-    if (existingMeta && existingMeta !== "") {
-      return true;
-    }
-    // add to multichain registry with metadata uri unlocks the contract on SDK/dashboard for everyone
-    await sdk.multiChainRegistry.addContract({
-      address,
-      chainId,
-      metadataURI,
-    });
-    return true;
-  } catch (e) {
-    console.debug("Error registering contract on multi chain registry", e);
-    return false;
-  }
-}
diff --git a/legacy_packages/sdk/src/evm/zksync/zksync-deploy-utils.ts b/legacy_packages/sdk/src/evm/zksync/zksync-deploy-utils.ts
@@ -19,7 +19,6 @@ import { DeploymentTransaction } from "../types/any-evm/deploy-data";
 import { zkDeployCreate2Factory } from "./zkDeployCreate2Factory";
 import { getZkDeploymentInfo } from "./getZkDeploymentInfo";
 import {
-  registerContractOnMultiChainRegistry,
   zkDeployContractDeterministic,
 } from "./zkDeployContractDeterministic";
 import invariant from "tiny-invariant";
@@ -206,13 +205,6 @@ export async function zkDeployContractFromUri(
 
       await proxy.deployed();
 
-      // register on multichain registry
-      await registerContractOnMultiChainRegistry(
-        proxy.address,
-        chainId,
-        compilerMetadata.fetchedMetadataUri,
-      );
-
       deployedAddress = proxy.address;
     } else {
       throw new Error("Invalid deploy type");
@@ -292,15 +284,6 @@ export async function zkDeployContractFromUri(
       const contract = await factory.deploy(...paramValues);
       deployedAddress = contract.address;
     }
-
-    if (deployedAddress) {
-      // register on multichain registry
-      await registerContractOnMultiChainRegistry(
-        deployedAddress,
-        chainId,
-        compilerMetadata.fetchedMetadataUri,
-      );
-    }
   }
 
   // fire-and-forget verification, don't await
