feat: zksync support for core solidity package

.changeset/chatty-starfishes-double.md

@@ -0,0 +1,11 @@
+---
+'@hyperlane-xyz/core': minor
+---
+
+Add ZKSync support and restructure build artifacts:
+
+- Add ZKSync compilation support
+- Restructure typechain directory location to core-utils/typechain
+- Add ZKSync-specific artifact generation and exports
+- Update build process to handle both standard and ZKSync artifacts
+- Add new exports for ZKSync build artifacts and contract types

solidity/.gitignore

@@ -15,3 +15,10 @@ docs
 flattened/
 buildArtifact.json
 fixtures/
+# ZKSync
+artifacts-zk
+cache-zk
+core-utils/zksync/artifacts/output
+.zksolc-libraries-cache/
+typechain-types/
+typechain/

solidity/core-utils/index.ts

@@ -0,0 +1,2 @@
+export * from './typechain/index.js';
+export * from './zksync/index.js';

solidity/core-utils/zksync/artifacts.ts

@@ -0,0 +1,5 @@
+import type { ZKSyncArtifact } from './types.js';
+
+// Default empty artifact array when `yarn build:zk` hasn't been run
+// This file will be populated with contract artifacts in dist after running the build:zk command
+export const zkSyncContractArtifacts: ZKSyncArtifact[] = [] as const;

solidity/core-utils/zksync/buildArtifact.ts

@@ -0,0 +1,19 @@
+// Default empty artifact array when `yarn build:zk` hasn't been run
+// This file will be populated with build artifacts in dist/zksync after running the build:zk command
+export const buildArtifact = {
+  solcLongVersion: '',
+  zk_version: '',
+  input: {
+    language: 'Solidity',
+    sources: {},
+    settings: {
+      optimizer: {
+        enabled: false,
+        runs: 200,
+      },
+      outputSelection: {},
+      evmVersion: 'london',
+      remappings: [],
+    },
+  },
+};

solidity/core-utils/zksync/index.ts

@@ -0,0 +1,4 @@
+export * from './artifacts.js';
+export * from './buildArtifact.js';
+export * from './utils.js';
+export * from './types.js';

solidity/core-utils/zksync/types.ts

@@ -0,0 +1,11 @@
+export interface ZKSyncArtifact {
+  _format: string;
+  contractName: string;
+  sourceName: string;
+  abi: any[];
+  bytecode: string;
+  deployedBytecode: string;
+  linkReferences: Record<string, any>;
+  deployedLinkReferences: Record<string, any>;
+  factoryDeps: Record<string, any>;
+}

solidity/core-utils/zksync/utils.ts

@@ -0,0 +1,23 @@
+import { zkSyncContractArtifacts } from './artifacts.js';
+import { ZKSyncArtifact } from './types.js';
+
+/**
+ * @dev Get a ZkSync artifact by its name.
+ * @param name The name of the artifact to get.
+ * @return The loaded ZKSyncArtifact or undefined if it cannot be found.
+ */
+export function getZKSyncArtifactByName(
+  name: string,
+): ZKSyncArtifact | undefined {
+  return zkSyncContractArtifacts.find(
+    (artifact) => artifact.contractName === name,
+  );
+}
+
+/**
+ * @dev Loads all ZkSync artifacts into an array.
+ * @return An array of ZkSync artifacts.
+ */
+export function loadAllZKSyncArtifacts(): ZKSyncArtifact[] {
+  return zkSyncContractArtifacts;
+}

solidity/eslint.config.mjs

@@ -4,9 +4,11 @@ export default [
   ...MonorepoDefaults,
   {
     ignores: [
-      './test/**/*',
-      './dist/**/*',
+      '**/test/**/*',
+      '**/dist/**/*',
+      '**/typechain/**/*',
       '.solcover.js',
+      'generate-artifact-exports.mjs',
     ],
   },
 ];

solidity/exportBuildArtifact.sh

@@ -37,3 +37,42 @@ else
   echo 'Failed to process build artifact with jq'
   exit 1
 fi
+
+# ZKSYNC
+
+if [ "$ZKSYNC" = "true" ]; then
+  # 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 ZKSync hardhat build 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 ZKSync 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 ZKSync build artifact.'
+  else
+    echo 'Failed to process ZKSync build artifact with jq'
+    exit 1
+  fi
+fi

solidity/generate-artifact-exports.mjs

@@ -0,0 +1,174 @@
+import { promises as fs } from 'fs';
+import { basename, dirname, join } from 'path';
+import { glob } from 'typechain';
+import { fileURLToPath } from 'url';
+
+const cwd = process.cwd();
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+const ROOT_OUTPUT_DIR = join(__dirname, 'dist/zksync/');
+const ARTIFACTS_OUTPUT_DIR = join(ROOT_OUTPUT_DIR, 'artifacts');
+
+/**
+ * @notice Templates for TypeScript artifact generation
+ */
+const TEMPLATES = {
+  JS_ARTIFACT: `\
+export const {name} = {artifact};
+`,
+
+  DTS_ARTIFACT: `\
+import type { ZKSyncArtifact } from '../types.js';
+
+export declare const {name}: ZKSyncArtifact;
+`,
+
+  JS_INDEX: `\
+{imports}
+
+export const zkSyncContractArtifacts = [
+{exports}
+];
+`,
+
+  DTS_INDEX: `\
+import type { ZKSyncArtifact } from './types.js';
+
+export declare const zkSyncContractArtifacts: readonly ZKSyncArtifact[];
+`,
+};
+
+class ArtifactGenerator {
+  constructor() {
+    this.processedFiles = new Set();
+  }
+
+  /**
+   * @notice Retrieves paths of all relevant artifact files
+   * @dev Excludes debug files and build-info directory
+   * @return {string[]} Array of file paths matching the glob pattern
+   */
+  getArtifactPaths() {
+    return glob(cwd, [
+      `!./artifacts-zk/!(build-info)/**/*.dbg.json`,
+      `./artifacts-zk/!(build-info)/**/+([a-zA-Z0-9_]).json`,
+    ]);
+  }
+
+  /**
+   * @notice Creates the output directory if it doesn't exist
+   */
+  async createOutputDirectory() {
+    await fs.mkdir(ARTIFACTS_OUTPUT_DIR, { recursive: true });
+  }
+
+  /**
+   * @notice Reads and parses a JSON artifact file
+   * @param filePath Path to the artifact file
+   * @return {Promise<Object>} Parsed JSON content
+   */
+  async readArtifactFile(filePath) {
+    const content = await fs.readFile(filePath, 'utf-8');
+    return JSON.parse(content);
+  }
+
+  /**
+   * @notice Generates JavaScript content for a contract artifact
+   */
+  generateJavaScriptContent(name, artifact) {
+    return TEMPLATES.JS_ARTIFACT.replace('{name}', name).replace(
+      '{artifact}',
+      JSON.stringify(artifact, null, 2),
+    );
+  }
+
+  /**
+   * @notice Generates TypeScript declaration content for a contract artifact
+   */
+  generateDeclarationContent(name) {
+    return TEMPLATES.DTS_ARTIFACT.replace('{name}', name);
+  }
+
+  /**
+   * @notice Generates index file contents
+   */
+  generateIndexContents(artifactNames) {
+    const imports = artifactNames
+      .map((name) => `import { ${name} } from './artifacts/${name}.js';`)
+      .join('\n');
+    const exports = artifactNames.map((name) => `  ${name},`).join('\n');
+
+    const jsContent = TEMPLATES.JS_INDEX.replace('{imports}', imports).replace(
+      '{exports}',
+      exports,
+    );
+
+    const dtsContent = TEMPLATES.DTS_INDEX.replace(
+      '{imports}',
+      imports,
+    ).replace('{exports}', exports);
+
+    return { jsContent, dtsContent };
+  }
+
+  /**
+   * @notice Processes a single artifact file
+   */
+  async processArtifact(filePath) {
+    const name = basename(filePath, '.json');
+
+    if (this.processedFiles.has(name)) {
+      return;
+    }
+
+    const artifact = await this.readArtifactFile(filePath);
+
+    // Generate and write .js file
+    const jsContent = this.generateJavaScriptContent(name, artifact);
+    await fs.writeFile(
+      join(ROOT_OUTPUT_DIR, 'artifacts', `${name}.js`),
+      jsContent,
+    );
+
+    // Generate and write .d.ts file
+    const dtsContent = this.generateDeclarationContent(name);
+    await fs.writeFile(
+      join(ROOT_OUTPUT_DIR, 'artifacts', `${name}.d.ts`),
+      dtsContent,
+    );
+
+    this.processedFiles.add(name);
+  }
+
+  async generate() {
+    try {
+      await this.createOutputDirectory();
+
+      const artifactPaths = this.getArtifactPaths();
+
+      for (const filePath of artifactPaths) {
+        await this.processArtifact(filePath);
+      }
+
+      const processedNames = Array.from(this.processedFiles);
+
+      // Generate and write index files
+      const { jsContent, dtsContent } =
+        this.generateIndexContents(processedNames);
+
+      await fs.writeFile(join(ROOT_OUTPUT_DIR, 'artifacts.js'), jsContent);
+      await fs.writeFile(join(ROOT_OUTPUT_DIR, 'artifacts.d.ts'), dtsContent);
+
+      console.log(
+        `Successfully processed ${processedNames.length} zksync artifacts`,
+      );
+    } catch (error) {
+      console.error('Error processing zksync artifacts:', error);
+      throw error;
+    }
+  }
+}
+
+const generator = new ArtifactGenerator();
+generator.generate().catch(console.error);

solidity/hardhat.config.cts

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

solidity/package.json

@@ -13,6 +13,7 @@
   },
   "devDependencies": {
     "@layerzerolabs/solidity-examples": "^1.1.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",
@@ -36,17 +37,19 @@
     "ts-node": "^10.8.0",
     "tsx": "^4.19.1",
     "typechain": "patch:typechain@npm%3A8.3.2#~/.yarn/patches/typechain-npm-8.3.2-b02e27439e.patch",
-    "typescript": "5.3.3"
+    "typescript": "5.3.3",
+    "zksync-ethers": "^5.10.0"
   },
   "directories": {
     "test": "test"
   },
   "type": "module",
   "exports": {
     ".": "./dist/index.js",
-    "./mailbox": "./dist/contracts/Mailbox.js",
+    "./mailbox": "./dist/typechain/contracts/Mailbox.js",
     "./buildArtifact.js": "./dist/buildArtifact.js",
     "./buildArtifact.json": "./dist/buildArtifact.json",
+    "./buildArtifact-zksync.js": "./dist/zksync/buildArtifact.js",
     "./contracts": "./contracts"
   },
   "types": "./dist/index.d.ts",
@@ -66,12 +69,15 @@
   "license": "Apache-2.0",
   "scripts": {
     "build": "yarn version:update && yarn hardhat-esm compile && tsc && ./exportBuildArtifact.sh",
-    "lint": "solhint contracts/**/*.sol",
-    "clean": "yarn hardhat-esm clean && rm -rf ./dist ./cache ./types ./coverage ./out ./forge-cache ./fixtures",
+    "build:zk": "yarn hardhat-zk compile && tsc && ts-node generate-artifact-exports.mjs && ZKSYNC=true ./exportBuildArtifact.sh",
+    "prepublishOnly": "yarn build && yarn build:zk",
+    "lint": "solhint contracts/**/*.sol && eslint -c ./eslint.config.mjs",
+    "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 '../../core-utils/typechain';
+import { DispatchEvent } from '../../core-utils/typechain/contracts/Mailbox';
 
 export type MessageAndProof = {
   proof: MerkleProof;