New zksolc metadata format (#4568)

## Problem solved

Handle new zksolc metadata format
ref: ipfs://QmS6ehXYWKJEJq3LBSfG2ujKPzQQJooNE7L375zyFbpxmw

<!-- start pr-codex -->

---

## PR-Codex overview
This PR introduces support for a new `zksolc` metadata format in the `thirdweb` package, enhancing the handling of zkSync contracts by updating various functions and types to accommodate the new compiler type.

### Detailed summary
- Added `compilerType` option to several functions and types to support `solc` and `zksolc`.
- Updated `fetchPublishedContractMetadata` and `deployPublishedContract` to utilize `compilerType`.
- Enhanced `formatCompilerMetadata` to handle `zksolc` specific metadata.
- Modified `fetchDeployMetadata` to validate and fetch `zksolc` metadata correctly.
- Updated `CustomContractForm` to determine `compilerType` based on the active wallet chain.
- Improved error handling for missing `zksolc` metadata.

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

<!-- end pr-codex -->

Author: kumaryash90

.changeset/gold-moons-exercise.md

@@ -0,0 +1,5 @@
+---
+"thirdweb": patch
+---
+
+Handle new zksolc metadata format

apps/dashboard/src/components/contract-components/contract-deploy-form/custom-contract.tsx

@@ -37,6 +37,7 @@ import {
 } from "thirdweb/deploys";
 import { useActiveAccount, useActiveWalletChain } from "thirdweb/react";
 import { upload } from "thirdweb/storage";
+import { isZkSyncChain } from "thirdweb/utils";
 import { FormHelperText, FormLabel, Heading, Text } from "tw-components";
 import { useCustomFactoryAbi, useFunctionParamsFromABI } from "../hooks";
 import { addContractToMultiChainRegistry } from "../utils";
@@ -385,6 +386,8 @@ export const CustomContractForm: React.FC<CustomContractFormProps> = ({
         throw new Error("no chain");
       }
 
+      const compilerType = isZkSyncChain(walletChain) ? "zksolc" : "solc";
+
       let _contractURI = "";
 
       if (hasContractURI && params.contractMetadata) {
@@ -449,6 +452,7 @@ export const CustomContractForm: React.FC<CustomContractFormProps> = ({
           deployMetadata: m,
           initializeParams: params.moduleData[m.name],
         })),
+        compilerType,
       });
     },
   });

packages/thirdweb/src/contract/actions/compiler-metadata.ts

@@ -18,6 +18,7 @@ export type CompilerMetadata = {
   };
   licenses: string[];
   isPartialAbi?: boolean;
+  zk_version?: string;
 };
 
 /**
@@ -26,29 +27,37 @@ export type CompilerMetadata = {
  * @returns The formatted metadata.
  * @internal
  */
-// biome-ignore lint/suspicious/noExplicitAny: TODO: fix later
-export function formatCompilerMetadata(metadata: any): CompilerMetadata {
-  const compilationTarget = metadata.settings.compilationTarget;
+export function formatCompilerMetadata(
+  // biome-ignore lint/suspicious/noExplicitAny: TODO: fix later
+  metadata: any,
+  compilerType?: "solc" | "zksolc",
+): CompilerMetadata {
+  let meta = metadata;
+  if (compilerType === "zksolc") {
+    meta = metadata.source_metadata || meta;
+  }
+  const compilationTarget = meta.settings.compilationTarget;
   const targets = Object.keys(compilationTarget);
   const name = compilationTarget[targets[0] as keyof typeof compilationTarget];
   const info = {
-    title: metadata.output.devdoc.title,
-    author: metadata.output.devdoc.author,
-    details: metadata.output.devdoc.detail,
-    notice: metadata.output.userdoc.notice,
+    title: meta.output.devdoc.title,
+    author: meta.output.devdoc.author,
+    details: meta.output.devdoc.detail,
+    notice: meta.output.userdoc.notice,
   };
   const licenses: string[] = [
     ...new Set(
       // biome-ignore lint/suspicious/noExplicitAny: TODO: fix later
-      Object.entries(metadata.sources).map(([, src]) => (src as any).license),
+      Object.entries(meta.sources).map(([, src]) => (src as any).license),
     ),
   ];
   return {
     name,
-    abi: metadata?.output?.abi || [],
-    metadata,
+    abi: meta?.output?.abi || [],
+    metadata: meta,
     info,
     licenses,
-    isPartialAbi: metadata.isPartialAbi,
+    isPartialAbi: meta.isPartialAbi,
+    zk_version: metadata.zk_version,
   };
 }

packages/thirdweb/src/contract/deployment/publisher.ts

@@ -24,6 +24,7 @@ export async function fetchPublishedContractMetadata(options: {
   contractId: string;
   publisher?: string;
   version?: string;
+  compilerType?: "solc" | "zksolc";
 }): Promise<FetchDeployMetadataResult> {
   const cacheKey = `${options.contractId}-${options.publisher}-${options.version}`;
   return withCache(
@@ -33,6 +34,7 @@ export async function fetchPublishedContractMetadata(options: {
         publisherAddress: options.publisher || THIRDWEB_DEPLOYER,
         contractId: options.contractId,
         version: options.version,
+        compilerType: options.compilerType,
       });
       if (!publishedContract.publishMetadataUri) {
         throw new Error(
@@ -42,6 +44,7 @@ export async function fetchPublishedContractMetadata(options: {
       const data = await fetchDeployMetadata({
         client: options.client,
         uri: publishedContract.publishMetadataUri,
+        compilerType: options.compilerType,
       });
       return data;
     },
@@ -211,6 +214,7 @@ type FetchPublishedContractOptions = {
   contractId: string;
   version?: string;
   client: ThirdwebClient;
+  compilerType?: "solc" | "zksolc";
 };
 
 /**

packages/thirdweb/src/contract/deployment/utils/bootstrap.ts

@@ -27,6 +27,7 @@ export async function getOrDeployInfraForPublishedContract(
     constructorParams?: Record<string, unknown>;
     publisher?: string;
     version?: string;
+    compilerType?: "solc" | "zksolc";
   },
 ): Promise<{
   cloneFactoryContract: ThirdwebContract;
@@ -40,6 +41,7 @@ export async function getOrDeployInfraForPublishedContract(
     constructorParams,
     publisher,
     version,
+    compilerType,
   } = args;
 
   if (isZkSyncChain(chain)) {
@@ -50,9 +52,10 @@ export async function getOrDeployInfraForPublishedContract(
     });
     const compilerMetadata = await fetchPublishedContractMetadata({
       client,
-      contractId: `${contractId}_ZkSync`, // different contract id for zkSync
+      contractId,
       publisher,
       version,
+      compilerType,
     });
     const implementationContract = await zkDeployContractDeterministic({
       chain,

packages/thirdweb/src/exports/utils.ts

@@ -22,6 +22,7 @@ export { isEIP155Enforced } from "../utils/any-evm/is-eip155-enforced.js";
 export { keccakId } from "../utils/any-evm/keccak-id.js";
 export { getKeylessTransaction } from "../utils/any-evm/keyless-transaction.js";
 export type { ExtendedMetadata } from "../utils/any-evm/deploy-metadata.js";
+export { isZkSyncChain } from "../utils/any-evm/zksync/isZkSyncChain.js";
 
 //signatures
 export {

packages/thirdweb/src/extensions/prebuilts/deploy-published.ts

@@ -33,6 +33,7 @@ export type DeployPublishedContractOptions = {
   version?: string;
   implementationConstructorParams?: Record<string, unknown>;
   salt?: string;
+  compilerType?: "solc" | "zksolc";
 };
 
 /**
@@ -92,12 +93,14 @@ export async function deployPublishedContract(
     version,
     implementationConstructorParams,
     salt,
+    compilerType,
   } = options;
   const deployMetadata = await fetchPublishedContractMetadata({
     client,
-    contractId: isZkSyncChain(chain) ? `${contractId}_ZkSync` : contractId,
+    contractId,
     publisher,
     version,
+    compilerType,
   });
 
   return deployContractfromDeployMetadata({
@@ -108,6 +111,7 @@ export async function deployPublishedContract(
     initializeParams: contractParams,
     implementationConstructorParams,
     salt,
+    compilerType,
   });
 }
 
@@ -126,6 +130,7 @@ export type DeployContractfromDeployMetadataOptions = {
     initializeParams?: Record<string, unknown>;
   }[];
   salt?: string;
+  compilerType?: "solc" | "zksolc";
 };
 
 /**
@@ -143,6 +148,7 @@ export async function deployContractfromDeployMetadata(
     implementationConstructorParams,
     modules,
     salt,
+    compilerType,
   } = options;
   switch (deployMetadata?.deployType) {
     case "standard": {
@@ -176,6 +182,7 @@ export async function deployContractfromDeployMetadata(
               client,
             })),
           publisher: deployMetadata.publisher,
+          compilerType,
         });
 
       const initializeTransaction = await getInitializeTransaction({

packages/thirdweb/src/transaction/actions/zksync/send-eip712-transaction.ts

@@ -1,4 +1,4 @@
-import { toRlp } from "viem";
+import { hexToBytes, toRlp } from "viem";
 import { eth_sendRawTransaction } from "../../../rpc/actions/eth_sendRawTransaction.js";
 import { getRpcClient } from "../../../rpc/rpc.js";
 import { toBigInt } from "../../../utils/bigint.js";
@@ -87,25 +87,17 @@ export async function populateEip712Transaction(
   options: SendEip712TransactionOptions,
 ): Promise<EIP721TransactionSerializable> {
   const { account, transaction } = options;
-  let [
-    data,
-    to,
-    value,
-    gas,
-    maxFeePerGas,
-    maxPriorityFeePerGas,
-    gasPerPubdata,
-  ] = await Promise.all([
-    encode(transaction),
-    resolvePromisedValue(transaction.to),
-    resolvePromisedValue(transaction.value),
-    resolvePromisedValue(transaction.gas),
-    resolvePromisedValue(transaction.maxFeePerGas),
-    resolvePromisedValue(transaction.maxPriorityFeePerGas),
-    resolvePromisedValue(transaction.eip712).then(
-      (eip712) => eip712?.gasPerPubdata,
-    ),
-  ]);
+  let [data, to, value, gas, maxFeePerGas, maxPriorityFeePerGas, eip712] =
+    await Promise.all([
+      encode(transaction),
+      resolvePromisedValue(transaction.to),
+      resolvePromisedValue(transaction.value),
+      resolvePromisedValue(transaction.gas),
+      resolvePromisedValue(transaction.maxFeePerGas),
+      resolvePromisedValue(transaction.maxPriorityFeePerGas),
+      resolvePromisedValue(transaction.eip712),
+    ]);
+  let gasPerPubdata = eip712?.gasPerPubdata;
   if (!gas || !maxFeePerGas || !maxPriorityFeePerGas) {
     // fetch fees and gas
     const rpc = getRpcClient(transaction);
@@ -118,6 +110,15 @@ export async function populateEip712Transaction(
           to,
           data,
           value: value ? numberToHex(value) : undefined,
+          gasPerPubdata,
+          eip712Meta: {
+            ...eip712,
+            gasPerPubdata: gasPerPubdata ? toHex(gasPerPubdata) : toHex(50000n),
+            factoryDeps: eip712?.factoryDeps?.map((dep) =>
+              Array.from(hexToBytes(dep)),
+            ),
+          },
+          type: "0x71",
           // biome-ignore lint/suspicious/noExplicitAny: TODO add to RPC method types
         } as any,
       ],

packages/thirdweb/src/utils/any-evm/deploy-metadata.ts

@@ -8,6 +8,7 @@ import type { Prettify } from "../type-utils.js";
 type FetchDeployMetadataOptions = {
   uri: string;
   client: ThirdwebClient;
+  compilerType?: "solc" | "zksolc";
 };
 
 export type FetchDeployMetadataResult = Partial<ExtendedMetadata> &
@@ -22,26 +23,33 @@ export type FetchDeployMetadataResult = Partial<ExtendedMetadata> &
 export async function fetchDeployMetadata(
   options: FetchDeployMetadataOptions,
 ): Promise<FetchDeployMetadataResult> {
+  const isZksolc = options.compilerType === "zksolc";
   const rawMeta: RawCompilerMetadata = await download({
     uri: options.uri,
     client: options.client,
   }).then((r) => r.json());
-  // TODO: proper handling of different compiler metadata types
-  const metadataUri =
-    rawMeta.compilers?.zksolc?.length > 0 && rawMeta.name.endsWith("_ZkSync")
-      ? rawMeta.compilers.zksolc[0].metadataUri
-      : rawMeta.metadataUri;
-  const bytecodeUri =
-    rawMeta.compilers?.zksolc?.length > 0 && rawMeta.name.endsWith("_ZkSync")
-      ? rawMeta.compilers.zksolc[0].bytecodeUri
-      : rawMeta.bytecodeUri;
+
+  if (
+    isZksolc &&
+    (!rawMeta.compilers?.zksolc || rawMeta.compilers?.zksolc.length === 0)
+  ) {
+    throw new Error(`No zksolc metadata found for contract: ${rawMeta.name}`);
+  }
+
+  const metadataUri = isZksolc
+    ? rawMeta.compilers.zksolc[0].metadataUri
+    : rawMeta.metadataUri;
+  const bytecodeUri = isZksolc
+    ? rawMeta.compilers.zksolc[0].bytecodeUri
+    : rawMeta.bytecodeUri;
   const [deployBytecode, parsedMeta] = await Promise.all([
     download({ uri: bytecodeUri, client: options.client }).then(
       (res) => res.text() as Promise<Hex>,
     ),
     fetchAndParseCompilerMetadata({
       client: options.client,
       uri: metadataUri,
+      compilerType: options.compilerType,
     }),
   ]);
 
@@ -66,12 +74,18 @@ async function fetchAndParseCompilerMetadata(
       requestTimeoutMs: CONTRACT_METADATA_TIMEOUT_SEC,
     })
   ).json();
-  if (!metadata || !metadata.output) {
+  if (
+    (!metadata || !metadata.output) &&
+    (!metadata.source_metadata || !metadata.source_metadata.output)
+  ) {
     throw new Error(
       `Could not resolve metadata for contract at ${options.uri}`,
     );
   }
-  return { ...metadata, ...formatCompilerMetadata(metadata) };
+  return {
+    ...metadata,
+    ...formatCompilerMetadata(metadata, options.compilerType),
+  };
 }
 
 // types
@@ -128,6 +142,7 @@ type ParsedCompilerMetadata = {
   };
   licenses: string[];
   isPartialAbi?: boolean;
+  zk_version?: string;
 };
 
 export type CompilerMetadata = Prettify<