refactor: optimize zksync chain detection and add Creator Testnet test

joaquim-verges · joaquim-verges · commit b7c0e4a7b625 · 2024-10-02T14:10:04.000+13:00
diff --git a/.changeset/green-books-drop.md b/.changeset/green-books-drop.md
@@ -0,0 +1,5 @@
+---
+"thirdweb": patch
+---
+
+Auto resolve zksync bytecode
diff --git a/packages/thirdweb/src/contract/actions/compiler-metadata.ts b/packages/thirdweb/src/contract/actions/compiler-metadata.ts
@@ -30,11 +30,10 @@ export type CompilerMetadata = {
 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;
+  if ("source_metadata" in metadata) {
+    meta = metadata.source_metadata;
   }
   const compilationTarget = meta.settings.compilationTarget;
   const targets = Object.keys(compilationTarget);
diff --git a/packages/thirdweb/src/contract/deployment/publisher.ts b/packages/thirdweb/src/contract/deployment/publisher.ts
@@ -24,7 +24,6 @@ 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(
@@ -34,7 +33,6 @@ 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(
@@ -44,7 +42,6 @@ export async function fetchPublishedContractMetadata(options: {
       const data = await fetchDeployMetadata({
         client: options.client,
         uri: publishedContract.publishMetadataUri,
-        compilerType: options.compilerType,
       });
       return data;
     },
@@ -214,7 +211,6 @@ type FetchPublishedContractOptions = {
   contractId: string;
   version?: string;
   client: ThirdwebClient;
-  compilerType?: "solc" | "zksolc";
 };
 
 /**
diff --git a/packages/thirdweb/src/contract/deployment/utils/bootstrap.ts b/packages/thirdweb/src/contract/deployment/utils/bootstrap.ts
@@ -1,5 +1,8 @@
 import { sendAndConfirmTransaction } from "../../../transaction/actions/send-and-confirm-transaction.js";
-import type { FetchDeployMetadataResult } from "../../../utils/any-evm/deploy-metadata.js";
+import {
+  type FetchDeployMetadataResult,
+  fetchBytecodeFromCompilerMetadata,
+} from "../../../utils/any-evm/deploy-metadata.js";
 import { isZkSyncChain } from "../../../utils/any-evm/zksync/isZkSyncChain.js";
 import type { ClientAndChainAndAccount } from "../../../utils/types.js";
 import { type ThirdwebContract, getContract } from "../../contract.js";
@@ -27,7 +30,6 @@ export async function getOrDeployInfraForPublishedContract(
     constructorParams?: Record<string, unknown>;
     publisher?: string;
     version?: string;
-    compilerType?: "solc" | "zksolc";
   },
 ): Promise<{
   cloneFactoryContract: ThirdwebContract;
@@ -41,7 +43,6 @@ export async function getOrDeployInfraForPublishedContract(
     constructorParams,
     publisher,
     version,
-    compilerType,
   } = args;
 
   if (await isZkSyncChain(chain)) {
@@ -55,14 +56,17 @@ export async function getOrDeployInfraForPublishedContract(
       contractId,
       publisher,
       version,
-      compilerType,
     });
     const implementationContract = await zkDeployContractDeterministic({
       chain,
       client,
       account,
       abi: compilerMetadata.abi,
-      bytecode: compilerMetadata.bytecode,
+      bytecode: await fetchBytecodeFromCompilerMetadata({
+        compilerMetadata,
+        client,
+        chain,
+      }),
       params: constructorParams,
     });
     return {
diff --git a/packages/thirdweb/src/extensions/prebuilts/deploy-published.ts b/packages/thirdweb/src/extensions/prebuilts/deploy-published.ts
@@ -13,7 +13,10 @@ import { resolveMethod } from "../../transaction/resolve-method.js";
 import { encodeAbiParameters } from "../../utils/abi/encodeAbiParameters.js";
 import { normalizeFunctionParams } from "../../utils/abi/normalizeFunctionParams.js";
 import { getAddress } from "../../utils/address.js";
-import type { CompilerMetadata } from "../../utils/any-evm/deploy-metadata.js";
+import {
+  type CompilerMetadata,
+  fetchBytecodeFromCompilerMetadata,
+} from "../../utils/any-evm/deploy-metadata.js";
 import type { FetchDeployMetadataResult } from "../../utils/any-evm/deploy-metadata.js";
 import { isZkSyncChain } from "../../utils/any-evm/zksync/isZkSyncChain.js";
 import type { Hex } from "../../utils/encoding/hex.js";
@@ -33,7 +36,6 @@ export type DeployPublishedContractOptions = {
   version?: string;
   implementationConstructorParams?: Record<string, unknown>;
   salt?: string;
-  compilerType?: "solc" | "zksolc";
 };
 
 /**
@@ -93,14 +95,12 @@ export async function deployPublishedContract(
     version,
     implementationConstructorParams,
     salt,
-    compilerType,
   } = options;
   const deployMetadata = await fetchPublishedContractMetadata({
     client,
     contractId,
     publisher,
     version,
-    compilerType,
   });
 
   return deployContractfromDeployMetadata({
@@ -111,7 +111,6 @@ export async function deployPublishedContract(
     initializeParams: contractParams,
     implementationConstructorParams,
     salt,
-    compilerType,
   });
 }
 
@@ -130,7 +129,6 @@ export type DeployContractfromDeployMetadataOptions = {
     initializeParams?: Record<string, unknown>;
   }[];
   salt?: string;
-  compilerType?: "solc" | "zksolc";
 };
 
 /**
@@ -148,7 +146,6 @@ export async function deployContractfromDeployMetadata(
     implementationConstructorParams,
     modules,
     salt,
-    compilerType,
   } = options;
   switch (deployMetadata?.deployType) {
     case "standard": {
@@ -182,7 +179,6 @@ export async function deployContractfromDeployMetadata(
               client,
             })),
           publisher: deployMetadata.publisher,
-          compilerType,
         });
 
       const initializeTransaction = await getInitializeTransaction({
@@ -272,7 +268,11 @@ async function directDeploy(options: {
       account,
       client,
       chain,
-      bytecode: compilerMetadata.bytecode,
+      bytecode: await fetchBytecodeFromCompilerMetadata({
+        compilerMetadata,
+        client,
+        chain,
+      }),
       abi: compilerMetadata.abi,
       params: contractParams,
       salt,
@@ -286,7 +286,11 @@ async function directDeploy(options: {
     account,
     client,
     chain,
-    bytecode: compilerMetadata.bytecode,
+    bytecode: await fetchBytecodeFromCompilerMetadata({
+      compilerMetadata,
+      client,
+      chain,
+    }),
     abi: compilerMetadata.abi,
     constructorParams: contractParams,
     salt,
diff --git a/packages/thirdweb/src/utils/any-evm/compute-published-contract-deploy-info.ts b/packages/thirdweb/src/utils/any-evm/compute-published-contract-deploy-info.ts
@@ -7,7 +7,10 @@ import { encodeAbiParameters } from "../abi/encodeAbiParameters.js";
 import { normalizeFunctionParams } from "../abi/normalizeFunctionParams.js";
 import { ensureBytecodePrefix } from "../bytecode/prefix.js";
 import type { Hex } from "../encoding/hex.js";
-import type { FetchDeployMetadataResult } from "./deploy-metadata.js";
+import {
+  type FetchDeployMetadataResult,
+  fetchBytecodeFromCompilerMetadata,
+} from "./deploy-metadata.js";
 import { getInitBytecodeWithSalt } from "./get-init-bytecode-with-salt.js";
 
 /**
@@ -52,7 +55,11 @@ export async function computeDeploymentInfoFromMetadata(args: {
     client: args.client,
     chain: args.chain,
     abi: args.contractMetadata.abi,
-    bytecode: args.contractMetadata.bytecode,
+    bytecode: await fetchBytecodeFromCompilerMetadata({
+      compilerMetadata: args.contractMetadata,
+      client: args.client,
+      chain: args.chain,
+    }),
     constructorParams: args.constructorParams,
     salt: args.salt,
   });
diff --git a/packages/thirdweb/src/utils/any-evm/deploy-metadata.ts b/packages/thirdweb/src/utils/any-evm/deploy-metadata.ts
@@ -1,14 +1,16 @@
 import type { Abi } from "abitype";
+import type { Chain } from "../../chains/types.js";
 import type { ThirdwebClient } from "../../client/client.js";
 import { formatCompilerMetadata } from "../../contract/actions/compiler-metadata.js";
 import { download } from "../../storage/download.js";
 import type { Hex } from "../encoding/hex.js";
+import { withCache } from "../promise/withCache.js";
 import type { Prettify } from "../type-utils.js";
+import { isZkSyncChain } from "./zksync/isZkSyncChain.js";
 
 type FetchDeployMetadataOptions = {
   uri: string;
   client: ThirdwebClient;
-  compilerType?: "solc" | "zksolc";
 };
 
 export type FetchDeployMetadataResult = Partial<ExtendedMetadata> &
@@ -23,41 +25,21 @@ 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());
 
-  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,
-    }),
-  ]);
+  const metadataUri = rawMeta.metadataUri;
+  const parsedMeta = await fetchAndParseCompilerMetadata({
+    client: options.client,
+    uri: metadataUri,
+  });
 
   return {
     ...rawMeta,
     ...parsedMeta,
     version: rawMeta.version,
-    bytecode: deployBytecode,
     name: rawMeta.name,
   };
 }
@@ -84,10 +66,42 @@ async function fetchAndParseCompilerMetadata(
   }
   return {
     ...metadata,
-    ...formatCompilerMetadata(metadata, options.compilerType),
+    ...formatCompilerMetadata(metadata),
   };
 }
 
+export async function fetchBytecodeFromCompilerMetadata(options: {
+  compilerMetadata: FetchDeployMetadataResult;
+  client: ThirdwebClient;
+  chain: Chain;
+}) {
+  const { compilerMetadata, client, chain } = options;
+  return withCache(
+    async () => {
+      const isZksolc = await isZkSyncChain(chain);
+      const bytecodeUri = isZksolc
+        ? compilerMetadata.compilers?.zksolc[0]?.bytecodeUri
+        : compilerMetadata.bytecodeUri;
+
+      if (!bytecodeUri) {
+        throw new Error(
+          `No bytecode URI found in compiler metadata for ${compilerMetadata.name} on chain ${chain.name}`,
+        );
+      }
+      const deployBytecode = await download({
+        uri: bytecodeUri,
+        client,
+      }).then((res) => res.text() as Promise<Hex>);
+
+      return deployBytecode;
+    },
+    {
+      cacheKey: `bytecode:${compilerMetadata.name}:${chain.id}`,
+      cacheTime: 24 * 60 * 60 * 1000,
+    },
+  );
+}
+
 // types
 
 type RawCompilerMetadata = {
@@ -96,8 +110,8 @@ type RawCompilerMetadata = {
   bytecodeUri: string;
   // biome-ignore lint/suspicious/noExplicitAny: TODO: fix later
   analytics?: any;
-  // biome-ignore lint/suspicious/noExplicitAny: TODO: fix later
-  [key: string]: any;
+  version?: string;
+  [key: string]: unknown;
 };
 
 type ParsedCompilerMetadata = {
@@ -146,10 +160,7 @@ type ParsedCompilerMetadata = {
 };
 
 export type CompilerMetadata = Prettify<
-  RawCompilerMetadata &
-    ParsedCompilerMetadata & {
-      bytecode: Hex;
-    }
+  RawCompilerMetadata & ParsedCompilerMetadata
 >;
 
 export type ExtendedMetadata = {
diff --git a/packages/thirdweb/src/utils/any-evm/zksync/isZkSyncChain.ts b/packages/thirdweb/src/utils/any-evm/zksync/isZkSyncChain.ts
@@ -6,19 +6,21 @@ export async function isZkSyncChain(chain: Chain) {
     return false;
   }
 
-  const stack = await getChainStack(chain.id).catch(() => {
-    // fall back to checking against these zksync chain-ids
-    if (
-      chain.id === 324 ||
-      chain.id === 300 ||
-      chain.id === 302 ||
-      chain.id === 11124 ||
-      chain.id === 282 || // cronos zkevm testnet
-      chain.id === 388 // cronos zkevm mainnet
-    ) {
-      return "zksync-stack";
-    }
+  // check known zksync chain-ids first
+  if (
+    chain.id === 324 ||
+    chain.id === 300 ||
+    chain.id === 302 ||
+    chain.id === 11124 ||
+    chain.id === 282 || // cronos zkevm testnet
+    chain.id === 388 // cronos zkevm mainnet
+  ) {
+    return true;
+  }
 
+  // fallback to checking the stack on rpc
+  const stack = await getChainStack(chain.id).catch(() => {
+    // dont throw if network check fails
     return "";
   });
 
diff --git a/packages/thirdweb/src/wallets/smart/smart-wallet-zksync.test.ts b/packages/thirdweb/src/wallets/smart/smart-wallet-zksync.test.ts

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"thirdweb": patch
 +---
++
 +Auto resolve zksync bytecode