Clonning era contracts repo and compiling locally system contracts

biome.json

@@ -2,7 +2,7 @@
   "$schema": "https://biomejs.dev/schemas/1.6.4/schema.json",
   "files": {
     "include": ["*.js", "*.ts", "*.json", "*.yml", "*.md"],
-    "ignore": ["./dist/*", "./node_modules/*", "package.json", "**/__snapshots__/*"]
+    "ignore": ["./dist/*", "./node_modules/*", "package.json", "**/__snapshots__/*", "**/coverage/*"]
   },
   "organizeImports": {
     "enabled": false

cli/package.json

@@ -45,7 +45,9 @@
     "chalk": "^5.3.0",
     "cli-table3": "^0.6.4",
     "dotenv": "^16.4.5",
+    "nochoices": "^1.1.4",
     "ora": "^8.0.1",
+    "simple-git": "^3.24.0",
     "tempy": "^3.1.0",
     "tsup": "^8.0.2",
     "tsx": "^4.7.2",

cli/src/commands/check-command.ts

@@ -1,12 +1,14 @@
-import { compareCurrentStateWith } from "../lib";
-import { withSpinner } from "../lib/with-spinner.js";
+import { calculateDiffWithUpgrade } from "../lib";
 import type { EnvBuilder } from "../lib/env-builder.js";
+import { withSpinner } from "../lib/with-spinner";
 
 export async function checkCommand(env: EnvBuilder, upgradeDirectory: string): Promise<void> {
-  const { diff, l1Abis } = await withSpinner(
-    () => compareCurrentStateWith(env, upgradeDirectory),
-    "Gathering contract data"
+  const { diff } = await calculateDiffWithUpgrade(env, upgradeDirectory);
+
+  const report = await withSpinner(
+    async () => diff.toCliReport(env.l1Client(), upgradeDirectory, await env.contractsRepo()),
+    "Generating report"
   );
-  const github = env.github();
-  console.log(await diff.toCliReport(l1Abis, upgradeDirectory, github));
+
+  console.log(report);
 }

cli/src/commands/contract-diff-command.ts

@@ -1,22 +1,20 @@
-import { compareCurrentStateWith } from "../lib";
+import { calculateDiffWithUpgrade } from "../lib";
 import { temporaryDirectory } from "tempy";
 import { exec } from "node:child_process";
-import { withSpinner } from "../lib/with-spinner.js";
 import type { EnvBuilder } from "../lib/env-builder.js";
 
 export const contractDiff = async (
   env: EnvBuilder,
   upgradeDirectory: string,
   contractName: string
 ) => {
-  const github = env.github();
+  const repo = await env.contractsRepo();
   const l2Client = env.l2Client();
-  const targetDir = await withSpinner(async (): Promise<string> => {
-    const { diff, l1Client } = await compareCurrentStateWith(env, upgradeDirectory);
-    const targetDir = temporaryDirectory({ prefix: "zksync-era-upgrade-check" });
-    await diff.writeCodeDiff(targetDir, [contractName], l1Client, l2Client, github);
-    return targetDir;
-  }, "Gathering contract data");
+
+  const targetDir = temporaryDirectory({ prefix: "zksync-era-upgrade-check" });
+  const l1Client = env.l1Client();
+  const { diff } = await calculateDiffWithUpgrade(env, upgradeDirectory);
+  await diff.writeCodeDiff(targetDir, [contractName], l1Client, l2Client, repo);
 
   await new Promise((resolve, reject) => {
     const res = exec(

cli/src/commands/download-code-command.ts

@@ -1,4 +1,4 @@
-import { compareCurrentStateWith } from "../lib";
+import { calculateDiffWithUpgrade } from "../lib";
 
 import { withSpinner } from "../lib/with-spinner.js";
 import type { EnvBuilder } from "../lib/env-builder.js";
@@ -11,18 +11,15 @@ export async function downloadCode(
   l1Filter: string[]
 ): Promise<void> {
   await assertDirectoryExists(targetDir);
+  const { diff } = await calculateDiffWithUpgrade(env, upgradeDirectory);
 
   const l2Client = env.l2Client();
-  const github = env.github();
-
-  const { diff, l1Client } = await withSpinner(
-    () => compareCurrentStateWith(env, upgradeDirectory),
-    "Gathering contract data"
-  );
+  const repo = await env.contractsRepo();
 
   await withSpinner(
-    () => diff.writeCodeDiff(targetDir, l1Filter, l1Client, l2Client, github),
-    "Downloading source code"
+    () => diff.writeCodeDiff(targetDir, l1Filter, env.l1Client(), l2Client, repo),
+    "Downloading all source code"
   );
+
   console.log(`✅ Source code successfully downloaded in: ${targetDir}`);
 }

cli/src/lib/block-explorer-client.ts

@@ -8,13 +8,13 @@ import {
 import { ERA_BLOCK_EXPLORER_ENDPOINTS, ETHERSCAN_ENDPOINTS, type Network } from "./constants.js";
 import type { z, ZodType } from "zod";
 import { ContractData } from "./contract-data.js";
-import * as console from "node:console";
-import { ContracNotVerified } from "./errors.js";
+import { ContracNotVerified, ExternalApiError } from "./errors.js";
+import { ContractAbi } from "./contract-abi";
 
 export class BlockExplorerClient {
   private apiKey: string;
   baseUri: string;
-  private abiCache: Map<string, Abi>;
+  private abiCache: Map<string, ContractAbi>;
   private sourceCache: Map<string, ContractData>;
   private contractsNotVerified: Set<string>;
   private callCount = 0;
@@ -43,15 +43,18 @@ export class BlockExplorerClient {
 
     const response = await fetch(`${this.baseUri}?${query}`);
     if (!response.ok) {
-      throw new Error(`Received error from block explorer: ${await response.text()}`);
+      throw new ExternalApiError(
+        "Block Explorer",
+        `error accessing api. url=${this.baseUri}, status=${response.status}.`
+      );
     }
 
     this.callCount++;
 
     return parser.parse(await response.json());
   }
 
-  async getAbi(rawAddress: string): Promise<Abi> {
+  async getAbi(rawAddress: string): Promise<ContractAbi> {
     const existing = this.abiCache.get(rawAddress);
     if (existing) {
       return existing;
@@ -70,10 +73,10 @@ export class BlockExplorerClient {
     );
 
     if (message !== "OK") {
-      throw new Error(`Failed to fetch ABI for ${rawAddress}`);
+      throw new ExternalApiError("BlockExplorer", `Cannot get abi for ${rawAddress}`);
     }
 
-    const abi = JSON.parse(result);
+    const abi = new ContractAbi(JSON.parse(result));
     this.abiCache.set(rawAddress, abi);
     return abi;
   }
@@ -111,14 +114,15 @@ export class BlockExplorerClient {
       throw new ContracNotVerified(rawAddress);
     }
 
-    const abi = JSON.parse(result[0].ABI);
+    const abi = new ContractAbi(JSON.parse(result[0].ABI));
     this.abiCache.set(rawAddress, abi);
 
     try {
       const rawSourceCode = result[0].SourceCode.replace(/^\{\{/, "{").replace(/}}$/, "}");
       const SourceCode = sourceCodeSchema.parse(JSON.parse(rawSourceCode));
       const data = new ContractData(result[0].ContractName, SourceCode.sources, contractAddr);
       this.sourceCache.set(rawAddress, data);
+      data.remapKeys("cache/solpp-generated-contracts", "contracts");
       return data;
     } catch (e) {
       // This means that the response was not an object, instead it was a string with the source code.
@@ -151,7 +155,7 @@ export class BlockExplorerClient {
     }
   }
 
-  static fromNetwork(apiKey: string, network: Network): BlockExplorerClient {
+  static forL1(apiKey: string, network: Network): BlockExplorerClient {
     const baseUri = ETHERSCAN_ENDPOINTS[network];
     return new BlockExplorerClient(apiKey, baseUri);
   }

cli/src/lib/cli.ts

@@ -1,4 +1,4 @@
-import yargs from "yargs";
+import yargs, { type Argv } from "yargs";
 import { hideBin } from "yargs/helpers";
 import { NetworkSchema } from ".";
 import { downloadCode, checkCommand, contractDiff } from "../commands";
@@ -7,29 +7,25 @@ import { EnvBuilder } from "./env-builder.js";
 import * as console from "node:console";
 import { printError } from "./errors.js";
 
-export const cli = async () => {
-  // printIntro();
+export function buildCli(
+  args: string[],
+  checkCbk: typeof checkCommand,
+  diffCbk: typeof contractDiff,
+  downloadCodeCbk: typeof downloadCode
+): Argv {
   const env = new EnvBuilder();
-
-  const argParser = yargs(hideBin(process.argv))
+  const argParser = yargs(args)
     .middleware((yargs) => {
       if (!yargs.ethscankey) {
         yargs.ethscankey = process.env.ETHERSCAN_API_KEY;
       }
-      if (!yargs.githubApiKey) {
-        yargs.githubApiKey = process.env.API_KEY_GITHUB;
-      }
     }, true)
     .option("ethscankey", {
       describe: "Api key for etherscan",
       type: "string",
       demandOption:
         "Please provide a valid Etherscan api key. You can set ETHERSCAN_API_KEY env var or use the option --ethscankey",
     })
-    .option("githubApiKey", {
-      describe: "Api key for github",
-      type: "string",
-    })
     .option("network", {
       alias: "n",
       describe: "network to check",
@@ -52,7 +48,6 @@ export const cli = async () => {
       env.withNetwork(NetworkSchema.parse(yargs.network));
       env.withRpcUrl(yargs.rpcUrl);
       env.withEtherscanApiKey(yargs.ethscankey);
-      env.withGithubApiKey(yargs.githubApiKey);
       env.withRef(yargs.ref);
     })
     .command(
@@ -65,7 +60,7 @@ export const cli = async () => {
           demandOption: true,
         }),
       async (yargs) => {
-        await checkCommand(env, yargs.upgradeDirectory);
+        await checkCbk(env, yargs.upgradeDirectory);
       }
     )
     .command(
@@ -84,7 +79,7 @@ export const cli = async () => {
             demandOption: true,
           }),
       async (yargs) => {
-        await contractDiff(env, yargs.upgradeDir, `facet:${yargs.facetName}`);
+        await diffCbk(env, yargs.upgradeDir, `facet:${yargs.facetName}`);
       }
     )
     .command(
@@ -97,7 +92,7 @@ export const cli = async () => {
           demandOption: true,
         }),
       async (yargs) => {
-        await contractDiff(env, yargs.upgradeDir, "verifier");
+        await diffCbk(env, yargs.upgradeDir, "verifier");
       }
     )
     .command(
@@ -149,7 +144,7 @@ export const cli = async () => {
             .map((sc) => `sc:${sc}`)
         );
 
-        await downloadCode(env, yargs.upgradeDir, yargs.targetSourceCodeDir, filter);
+        await downloadCodeCbk(env, yargs.upgradeDir, yargs.targetSourceCodeDir, filter);
       }
     )
     .demandCommand(1, "Please specify a command")
@@ -160,15 +155,20 @@ export const cli = async () => {
         const help = await argParser.getHelp();
         console.log(help);
         console.log("");
-        // console.log(_yargs.help())
         console.log(msg);
-        process.exit(1);
+        // process.exit(1);
+        return;
       }
 
       printError(err);
-      process.exit(1);
+      // process.exit(1);
     })
     .strict();
 
+  return argParser;
+}
+
+export const cli = async () => {
+  const argParser = buildCli(hideBin(process.argv), checkCommand, contractDiff, downloadCode);
   await argParser.parseAsync();
 };

cli/src/lib/compare-current-state-with.ts

@@ -1,33 +1,32 @@
-import { AbiSet, type BlockExplorerClient, ZkSyncEraState, type ZkSyncEraDiff } from ".";
+import { ZkSyncEraState, type ZkSyncEraDiff } from ".";
 import type { EnvBuilder } from "./env-builder.js";
+import { withSpinner } from "./with-spinner";
 
-type CreateDiffResponse = {
-  diff: ZkSyncEraDiff;
-  l1Abis: AbiSet;
-  l1Client: BlockExplorerClient;
-};
-
-export async function compareCurrentStateWith(
+export async function calculateDiffWithUpgrade(
   env: EnvBuilder,
   upgradeDirectory: string
-): Promise<CreateDiffResponse> {
-  const importer = env.importer();
+): Promise<{ diff: ZkSyncEraDiff; state: ZkSyncEraState }> {
+  const changes = await withSpinner(async () => {
+    const importer = env.importer();
+    return importer.readFromFiles(upgradeDirectory, env.network);
+  }, "Reading proposed upgrade...");
+
+  const state = await withSpinner(async () => {
+    const l1Client = env.l1Client();
+    return ZkSyncEraState.create(env.network, l1Client, env.rpcL1(), env.rpcL2());
+  }, "Gathering contract data");
 
-  const changes = await importer.readFromFiles(upgradeDirectory, env.network);
+  const diff = await withSpinner(async () => {
+    return state.calculateDiff(changes, env.l1Client());
+  }, "Checking differences between versions");
 
-  const l1Client = env.l1Client();
-  const l1Abis = new AbiSet(l1Client);
-  const zkSyncState = await ZkSyncEraState.create(
-    env.network,
-    l1Client,
-    l1Abis,
-    env.rpcL1(),
-    env.rpcL2()
-  );
+  await withSpinner(async () => {
+    const repo = await env.contractsRepo();
+    await repo.compileSystemContracts();
+  }, "Compiling system contracts");
 
   return {
-    diff: await zkSyncState.calculateDiff(changes, l1Client),
-    l1Abis,
-    l1Client,
+    diff,
+    state,
   };
 }

cli/src/lib/constants.ts

@@ -7,7 +7,7 @@ export const ETHERSCAN_ENDPOINTS = {
 
 export const ERA_BLOCK_EXPLORER_ENDPOINTS = {
   mainnet: "https://block-explorer-api.mainnet.zksync.io/api",
-  sepolia: "https://block-explorer-api.sepolia.zksync.dev",
+  sepolia: "https://block-explorer-api.sepolia.zksync.dev/api",
 } as const;
 
 export const NetworkSchema = z.enum(["mainnet", "sepolia"]);