DO NOT MERGE: zksync deploy branch

package.json

@@ -16,7 +16,8 @@
     "lint-staged": "^12.4.3",
     "prettier": "^2.8.8",
     "syncpack": "^13.0.0",
-    "tsx": "^4.19.1"
+    "tsx": "^4.19.1",
+    "zksync-ethers": "^5.10.0"
   },
   "dependencies": {
     "@changesets/cli": "^2.26.2"

solidity/.gitignore

@@ -1,6 +1,6 @@
 node_modules/
 cache/
-artifacts/
+.artifacts/
 types/
 dist/
 coverage/
@@ -15,3 +15,13 @@ docs
 flattened/
 buildArtifact.json
 fixtures/
+
+
+# zksync artifacts
+artifacts-zk
+cache-zk
+
+core-utils/zksync/artifacts/output
+
+.zksolc-libraries-cache/
+typechain-types/

solidity/core-utils/zksync/artifacts/index.ts

@@ -0,0 +1,102 @@
+import { readdirSync } from 'fs';
+import path, { join } from 'path';
+import { fileURLToPath } from 'url';
+
+/**
+ * @dev Represents a ZkSync artifact.
+ */
+export type ZkSyncArtifact = {
+  contractName: string;
+  sourceName: string;
+  abi: any;
+  bytecode: string;
+  deployedBytecode: string;
+  factoryDeps?: Record<string, string>;
+};
+
+/**
+ * @dev A mapping of artifact names to their corresponding ZkSync artifacts.
+ */
+export type ArtifactMap = {
+  [key: string]: ZkSyncArtifact; // Key is the artifact name, value is the ZkSyncArtifact
+};
+
+// Get the resolved path to the current file
+const currentFilePath = fileURLToPath(import.meta.url); // Convert the module URL to a file path
+const currentDirectory = path.dirname(currentFilePath);
+
+/**
+ * @dev Reads artifact files from the specified directory.
+ * @param directory The directory to read artifact files from.
+ * @return An array of artifact file names that end with '.js'.
+ */
+const getArtifactFiles = (directory: string): string[] => {
+  return readdirSync(directory).filter((file) => file.endsWith('.js')); // Filter for .js files
+};
+
+/**
+ * @dev Exports the list of artifact names without the .js extension.
+ * @return An array of artifact names without the .js extension.
+ */
+export const zksyncArtifactNames = getArtifactFiles(
+  join(currentDirectory, 'output'),
+).map((file) => file.replace('.js', ''));
+
+/**
+ * @dev Checks if a ZkSync artifact exists by its name.
+ * @param name The name of the artifact to check.
+ * @return True if the artifact exists, false otherwise.
+ */
+export const artifactExists = (name: string): boolean => {
+  return zksyncArtifactNames.includes(`${name}.js`); // Check if the artifact file exists
+};
+
+/**
+ * @dev Loads a ZkSync artifact by its name.
+ * @param name The name of the artifact to load.
+ * @return The loaded ZkSyncArtifact or undefined if it cannot be loaded.
+ */
+const loadZkArtifact = async (
+  name: string,
+): Promise<ZkSyncArtifact | undefined> => {
+  try {
+    const artifactModule = await import(
+      join(currentDirectory, 'output', `${name}.js`)
+    ); // Dynamically import the artifact module
+    return artifactModule[name]; // Return the artifact from the artifactModule
+  } catch (error) {
+    console.error(`Error loading artifact: ${name}`, error);
+    return undefined;
+  }
+};
+
+/**
+ * @dev Loads all ZkSync artifacts into a map.
+ * @return A map of artifact names to their corresponding ZkSync artifacts.
+ */
+export const loadAllZkArtifacts = async (): Promise<ArtifactMap> => {
+  const zkSyncArtifactMap: ArtifactMap = {};
+
+  // Load all artifacts concurrently
+  const loadPromises = zksyncArtifactNames.map(async (artifactFileName) => {
+    const artifact = await loadZkArtifact(artifactFileName);
+    if (artifact) {
+      zkSyncArtifactMap[artifactFileName] = artifact;
+    }
+  });
+
+  await Promise.all(loadPromises);
+
+  return zkSyncArtifactMap; // Return the populated artifact map
+};
+
+/**
+ * @dev Retrieves a specific ZkSync artifact by its file name.
+ * @param name The name of the artifact to retrieve.
+ * @return The loaded ZkSyncArtifact or undefined if it cannot be loaded.
+ */
+export const getZkArtifactByName = async (
+  name: string,
+): Promise<ZkSyncArtifact | undefined> => {
+  return loadZkArtifact(name);
+};

solidity/exportBuildArtifact.sh

@@ -6,12 +6,12 @@ cd "$(dirname "$0")"
 # Define the artifacts directory
 artifactsDir="./artifacts/build-info"
 # Define the output file
-outputFileJson="./dist/buildArtifact.json"
-outputFileJs="./dist/buildArtifact.js"
-outputFileTsd="./dist/buildArtifact.d.ts"
+outputFileJson="./dist/evm/buildArtifact.json"
+outputFileJs="./dist/evm/buildArtifact.js"
+outputFileTsd="./dist/evm/buildArtifact.d.ts"
 
 # log that we're in the script
-echo 'Finding and processing hardhat build artifact...'
+echo 'Finding and processing hardhat build EVM artifact...'
 
 # Find most recently modified JSON build artifact
 if [ "$(uname)" = "Darwin" ]; then
@@ -37,3 +37,40 @@ else
   echo 'Failed to process build artifact with jq'
   exit 1
 fi
+
+# ZKSYNC
+
+# Define the artifacts directory
+artifactsDir="./artifacts-zk/build-info"
+# Define the output file
+outputFileJson="./dist/zksync/buildArtifact.json"
+outputFileJs="./dist/zksync/buildArtifact.js"
+outputFileTsd="./dist/zksync/buildArtifact.d.ts"
+
+# log that we're in the script
+echo 'Finding and processing hardhat build ZKSync artifact...'
+
+# Find most recently modified JSON build artifact
+if [ "$(uname)" = "Darwin" ]; then
+    # for local flow
+    jsonFiles=$(find "$artifactsDir" -type f -name "*.json" -exec stat -f "%m %N" {} \; | sort -rn | head -n 1 | cut -d' ' -f2-)
+else
+    # for CI flow
+    jsonFiles=$(find "$artifactsDir" -type f -name "*.json" -exec stat -c "%Y %n" {} \; | sort -rn | head -n 1 | cut -d' ' -f2-)
+fi
+
+if [ ! -f "$jsonFiles" ]; then
+  echo 'Failed to find build artifact'
+  exit 1
+fi
+
+# Extract required keys and write to outputFile
+if jq -c '{input, solcLongVersion, zk_version: .output.zk_version}' "$jsonFiles" > "$outputFileJson"; then
+  echo "export const buildArtifact = " > "$outputFileJs"
+  cat "$outputFileJson" >> "$outputFileJs"
+  echo "export const buildArtifact: any" > "$outputFileTsd"
+  echo 'Finished processing build artifact.'
+else
+  echo 'Failed to process build artifact with jq'
+  exit 1
+fi

solidity/generate-artifact-exports.mjs

@@ -0,0 +1,56 @@
+import { existsSync, mkdirSync, readFileSync, writeFileSync } from 'fs';
+import { basename, dirname, join } from 'path';
+import { glob } from 'typechain';
+import { fileURLToPath } from 'url';
+
+const cwd = process.cwd();
+
+const zksyncArtifacts = glob(cwd, [
+  `!./artifacts-zk/!(build-info)/**/*.dbg.json`,
+  `./artifacts-zk/!(build-info)/**/+([a-zA-Z0-9_]).json`,
+]);
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+// Directory to store individual artifact files
+const srcOutputDir = join(__dirname, 'core-utils/zksync/artifacts/output');
+
+// Ensure the output directory exists
+if (!existsSync(srcOutputDir)) {
+  mkdirSync(srcOutputDir, { recursive: true });
+}
+
+const zkSyncFileNames = new Set();
+let zkSyncArtifactMap = {};
+
+// Process each artifact file
+zksyncArtifacts.forEach((file) => {
+  const fileContent = readFileSync(file, 'utf-8');
+  const jsonObject = JSON.parse(fileContent);
+  const contractName = jsonObject.contractName;
+  let fileName = `${basename(file, '.json')}`;
+
+  if (zkSyncFileNames.has(fileName)) {
+    return;
+  }
+  zkSyncFileNames.add(fileName);
+
+  // Add to artifact map
+  zkSyncArtifactMap[contractName] = fileName;
+
+  // Create a TypeScript object export statement
+  const fileContentEx = `export const ${fileName} = ${JSON.stringify(
+    jsonObject,
+    null,
+    2,
+  )} as const;`;
+
+  // Write individual file
+  const outputFile = join(srcOutputDir, `${fileName}.ts`);
+  writeFileSync(outputFile, fileContentEx);
+});
+
+console.log(
+  `Generated ${zksyncArtifacts.length} individual TypeScript files in ${srcOutputDir}`,
+);

solidity/hardhat.config.cts

@@ -22,7 +22,7 @@ module.exports = {
     currency: 'USD',
   },
   typechain: {
-    outDir: './types',
+    outDir: './core-utils/evm/types',
     target: 'ethers-v5',
     alwaysGenerateOverloads: true,
     node16Modules: true,

solidity/package.json

@@ -9,10 +9,13 @@
     "@layerzerolabs/lz-evm-oapp-v2": "2.0.2",
     "@openzeppelin/contracts": "^4.9.3",
     "@openzeppelin/contracts-upgradeable": "^4.9.3",
-    "fx-portal": "^1.0.3"
+    "fx-portal": "^1.0.3",
+    "zksync-ethers": "^5.10.0"
   },
   "devDependencies": {
     "@layerzerolabs/solidity-examples": "^1.1.0",
+    "@matterlabs/hardhat-zksync-deploy": "^0.7.0",
+    "@matterlabs/hardhat-zksync-solc": "^1.2.4",
     "@nomiclabs/hardhat-ethers": "^2.2.3",
     "@nomiclabs/hardhat-waffle": "^2.0.6",
     "@typechain/ethers-v5": "^11.1.2",
@@ -42,16 +45,20 @@
   },
   "type": "module",
   "exports": {
-    ".": "./dist/index.js",
-    "./mailbox": "./dist/contracts/Mailbox.js",
-    "./buildArtifact.js": "./dist/buildArtifact.js",
-    "./buildArtifact.json": "./dist/buildArtifact.json",
-    "./contracts": "./contracts"
+    ".": "./dist/evm/types/index.js",
+    "./mailbox": "./dist/evm/types/contracts/Mailbox.js",
+    "./buildArtifact.js": "./dist/evm/buildArtifact.js",
+    "./buildArtifact-zksync.js": "./dist/zksync/buildArtifact.js",
+    "./buildArtifact.json": "./dist/evm/buildArtifact.json",
+    "./contracts": "./contracts",
+    "./zksync-artifacts": "./dist/zksync/artifacts/index.js",
+    "./zksync-artifacts/*": "./dist/zksync/artifacts/*.js"
   },
-  "types": "./dist/index.d.ts",
+  "types": "./dist/evm/types/index.d.ts",
   "files": [
     "/dist",
-    "/contracts"
+    "/contracts",
+    "/dist/zksync/artifacts"
   ],
   "engines": {
     "node": ">=16"
@@ -64,13 +71,14 @@
   ],
   "license": "Apache-2.0",
   "scripts": {
-    "build": "yarn version:update && yarn hardhat-esm compile && tsc && ./exportBuildArtifact.sh",
+    "build": "yarn version:update && yarn hardhat-esm compile && yarn hardhat-zk compile && ts-node generate-artifact-exports.mjs && tsc && ./exportBuildArtifact.sh",
     "lint": "solhint contracts/**/*.sol",
-    "clean": "yarn hardhat-esm clean && rm -rf ./dist ./cache ./types ./coverage ./out ./forge-cache ./fixtures",
+    "clean": "yarn hardhat-esm clean && yarn hardhat-zk clean && rm -rf ./dist ./cache ./cache-zk ./types ./coverage ./out ./forge-cache ./fixtures",
     "coverage": "yarn fixtures && ./coverage.sh",
     "docs": "forge doc",
     "fixtures": "mkdir -p ./fixtures/aggregation ./fixtures/multisig",
     "hardhat-esm": "NODE_OPTIONS='--experimental-loader ts-node/esm/transpile-only --no-warnings=ExperimentalWarning' hardhat --config hardhat.config.cts",
+    "hardhat-zk": "NODE_OPTIONS='--experimental-loader ts-node/esm/transpile-only --no-warnings=ExperimentalWarning' hardhat --config zk-hardhat.config.cts",
     "prettier": "prettier --write ./contracts ./test",
     "test": "yarn version:exhaustive && yarn hardhat-esm test && yarn test:forge",
     "test:hardhat": "yarn hardhat-esm test",

solidity/test/lib/mailboxes.ts

@@ -18,8 +18,8 @@ import {
   LegacyMultisigIsm,
   TestMailbox,
   TestMerkleTreeHook,
-} from '../../types';
-import { DispatchEvent } from '../../types/contracts/Mailbox';
+} from '../../dist/evm/types';
+import { DispatchEvent } from '../../dist/evm/types/contracts/Mailbox';
 
 export type MessageAndProof = {
   proof: MerkleProof;

solidity/test/merkle.test.ts

@@ -2,7 +2,7 @@ import { expect } from 'chai';
 import { utils } from 'ethers';
 
 import merkleTestCases from '../../vectors/merkle.json' assert { type: 'json' };
-import { TestMerkle, TestMerkle__factory } from '../types';
+import { TestMerkle, TestMerkle__factory } from '../dist/evm/types';
 
 import { getSigner } from './signer';
 

solidity/test/message.test.ts

@@ -8,7 +8,11 @@ import {
 } from '@hyperlane-xyz/utils';
 
 import testCases from '../../vectors/message.json' assert { type: 'json' };
-import { Mailbox__factory, TestMessage, TestMessage__factory } from '../types';
+import {
+  Mailbox__factory,
+  TestMessage,
+  TestMessage__factory,
+} from '../dist/evm/types';
 
 import { getSigner, getSigners } from './signer';
 

solidity/test/mockMailbox.test.ts

@@ -3,7 +3,10 @@ import { utils } from 'ethers';
 
 import { addressToBytes32 } from '@hyperlane-xyz/utils';
 
-import { MockMailbox__factory, TestRecipient__factory } from '../types';
+import {
+  MockMailbox__factory,
+  TestRecipient__factory,
+} from '../dist/evm/types';
 
 import { getSigner } from './signer';
 

solidity/test/testrecipient.test.ts

@@ -3,7 +3,7 @@ import { utils } from 'ethers';
 
 import { addressToBytes32 } from '@hyperlane-xyz/utils';
 
-import { TestRecipient, TestRecipient__factory } from '../types';
+import { TestRecipient, TestRecipient__factory } from '../dist/evm/types';
 
 import { getSigner } from './signer';
 

solidity/tsconfig.json

@@ -2,7 +2,7 @@
   "extends": "../tsconfig.json",
   "compilerOptions": {
     "outDir": "./dist",
-    "rootDir": "./types"
+    "rootDir": "./core-utils"
   },
-  "exclude": ["./test", "hardhat.config.cts", "./dist"]
+  "exclude": ["./test", "hardhat.config.cts", "zk-hardhat.config.cts", "./dist"]
 }