feat: zksync support

solidity/.gitignore

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

solidity/contracts/Mailbox.sol

@@ -10,7 +10,7 @@ import {IInterchainSecurityModule, ISpecifiesInterchainSecurityModule} from "./i
 import {IPostDispatchHook} from "./interfaces/hooks/IPostDispatchHook.sol";
 import {IMessageRecipient} from "./interfaces/IMessageRecipient.sol";
 import {IMailbox} from "./interfaces/IMailbox.sol";
-import {PackageVersioned} from "contracts/PackageVersioned.sol";
+import {PackageVersioned} from "./PackageVersioned.sol";
 
 // ============ External Imports ============
 import {Address} from "@openzeppelin/contracts/utils/Address.sol";

solidity/contracts/interfaces/IThresholdAddressFactory.sol

@@ -0,0 +1,9 @@
+// SPDX-License-Identifier: MIT OR Apache-2.0
+pragma solidity >=0.8.0;
+
+interface IThresholdAddressFactory {
+    function deploy(
+        address[] calldata _values,
+        uint8 _threshold
+    ) external returns (address);
+}

solidity/contracts/isms/multisig/AbstractMultisigIsm.sol

@@ -68,7 +68,7 @@ abstract contract AbstractMultisig is PackageVersioned {
  * @notice Manages per-domain m-of-n Validator sets of AbstractMultisig that are used to verify
  * interchain messages.
  */
-abstract contract AbstractMultisigIsm is AbstractMultisig {
+abstract contract AbstractMultisigIsm is AbstractMultisig, IMultisigIsm {
     // ============ Virtual Functions ============
     // ======= OVERRIDE THESE TO IMPLEMENT =======
 

solidity/contracts/isms/multisig/StorageMultisigIsm.sol

@@ -0,0 +1,134 @@
+// SPDX-License-Identifier: MIT OR Apache-2.0
+pragma solidity >=0.8.0;
+
+// ============ Internal Imports ============
+import {AbstractMultisigIsm} from "./AbstractMultisigIsm.sol";
+import {AbstractMerkleRootMultisigIsm} from "./AbstractMerkleRootMultisigIsm.sol";
+import {AbstractMessageIdMultisigIsm} from "./AbstractMessageIdMultisigIsm.sol";
+import {IInterchainSecurityModule} from "../../interfaces/IInterchainSecurityModule.sol";
+import {IThresholdAddressFactory} from "../../interfaces/IThresholdAddressFactory.sol";
+import {MinimalProxy} from "../../libs/MinimalProxy.sol";
+import {PackageVersioned} from "../../PackageVersioned.sol";
+
+// ============ External Imports ============
+import {OwnableUpgradeable} from "@openzeppelin/contracts-upgradeable/access/OwnableUpgradeable.sol";
+
+abstract contract AbstractStorageMultisigIsm is
+    AbstractMultisigIsm,
+    OwnableUpgradeable
+{
+    address[] public validators;
+    uint8 public threshold;
+
+    event ValidatorsAndThresholdSet(address[] validators, uint8 threshold);
+
+    constructor(
+        address[] memory _validators,
+        uint8 _threshold
+    ) OwnableUpgradeable() {
+        validators = _validators;
+        threshold = _threshold;
+        _disableInitializers();
+    }
+
+    function initialize(
+        address[] memory _validators,
+        uint8 _threshold
+    ) external initializer {
+        __Ownable_init();
+        setValidatorsAndThreshold(_validators, _threshold);
+    }
+
+    function setValidatorsAndThreshold(
+        address[] memory _validators,
+        uint8 _threshold
+    ) public onlyOwner {
+        require(_threshold <= _validators.length, "Invalid threshold");
+        validators = _validators;
+        threshold = _threshold;
+        emit ValidatorsAndThresholdSet(_validators, _threshold);
+    }
+
+    function validatorsAndThreshold(
+        bytes calldata /* _message */
+    ) public view override returns (address[] memory, uint8) {
+        return (validators, threshold);
+    }
+}
+
+contract StorageMerkleRootMultisigIsm is
+    AbstractMerkleRootMultisigIsm,
+    AbstractStorageMultisigIsm
+{
+    uint8 public constant moduleType =
+        uint8(IInterchainSecurityModule.Types.MERKLE_ROOT_MULTISIG);
+
+    constructor(
+        address[] memory _validators,
+        uint8 _threshold
+    ) AbstractStorageMultisigIsm(_validators, _threshold) {}
+}
+
+contract StorageMessageIdMultisigIsm is
+    AbstractMessageIdMultisigIsm,
+    AbstractStorageMultisigIsm
+{
+    uint8 public constant moduleType =
+        uint8(IInterchainSecurityModule.Types.MESSAGE_ID_MULTISIG);
+
+    constructor(
+        address[] memory _validators,
+        uint8 _threshold
+    ) AbstractStorageMultisigIsm(_validators, _threshold) {}
+}
+
+abstract contract StorageMultisigIsmFactory is
+    IThresholdAddressFactory,
+    PackageVersioned
+{
+    /**
+     * @notice Emitted when a multisig module is deployed
+     * @param module The deployed ISM
+     */
+    event ModuleDeployed(address module);
+
+    // ============ External Functions ============
+    function deploy(
+        address[] calldata _validators,
+        uint8 _threshold
+    ) external returns (address ism) {
+        ism = MinimalProxy.create(implementation());
+        emit ModuleDeployed(ism);
+        AbstractStorageMultisigIsm(ism).initialize(_validators, _threshold);
+    }
+
+    function implementation() public view virtual returns (address);
+}
+
+contract StorageMerkleRootMultisigIsmFactory is StorageMultisigIsmFactory {
+    address internal immutable _implementation;
+
+    constructor() {
+        _implementation = address(
+            new StorageMerkleRootMultisigIsm(new address[](0), 0)
+        );
+    }
+
+    function implementation() public view override returns (address) {
+        return _implementation;
+    }
+}
+
+contract StorageMessageIdMultisigIsmFactory is StorageMultisigIsmFactory {
+    address internal immutable _implementation;
+
+    constructor() {
+        _implementation = address(
+            new StorageMessageIdMultisigIsm(new address[](0), 0)
+        );
+    }
+
+    function implementation() public view override returns (address) {
+        return _implementation;
+    }
+}

solidity/core-utils/index.ts

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

solidity/core-utils/zksync/index.ts

@@ -0,0 +1,96 @@
+import { readFileSync, 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;
+};
+
+// Get the resolved path to the current file
+const currentFilePath = fileURLToPath(import.meta.url);
+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 '.json'.
+ */
+function getArtifactFiles(directory: string): string[] {
+  return readdirSync(directory).filter((file) => file.endsWith('.json'));
+}
+
+/**
+ * @dev Exports the list of artifact names without the .json extension.
+ * @return An array of artifact names without the .json extension.
+ */
+export const zksyncArtifactNames = getArtifactFiles(
+  join(currentDirectory, 'artifacts'),
+).map((file) => file.replace('.json', ''));
+
+/**
+ * @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 function artifactExists(name: string): boolean {
+  return zksyncArtifactNames.includes(name);
+}
+
+/**
+ * @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.
+ */
+export function loadZKSyncArtifact(name: string): ZKSyncArtifact | undefined {
+  try {
+    const artifactPath = join(currentDirectory, 'artifacts', `${name}.json`);
+    const artifactContent = readFileSync(artifactPath, 'utf-8');
+    return JSON.parse(artifactContent) as ZKSyncArtifact;
+  } 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 function loadAllZKSyncArtifacts(): ArtifactMap {
+  const zkSyncArtifactMap: ArtifactMap = {};
+
+  for (const artifactName of zksyncArtifactNames) {
+    const artifact = loadZKSyncArtifact(artifactName);
+    if (artifact) {
+      zkSyncArtifactMap[artifactName] = artifact;
+    }
+  }
+
+  return zkSyncArtifactMap;
+}
+
+/**
+ * @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 function getZKSyncArtifactByName(
+  name: string,
+): ZKSyncArtifact | undefined {
+  return loadZKSyncArtifact(name);
+}

solidity/exportBuildArtifact.sh

@@ -11,7 +11,7 @@ outputFileJs="./dist/buildArtifact.js"
 outputFileTsd="./dist/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,39 @@
+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();
+
+/**
+ * @dev Only includes primary JSON artifacts & excludes debug files and build-info directory
+ */
+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);
+
+const srcOutputDir = join(__dirname, 'core-utils/zksync/artifacts');
+
+if (!existsSync(srcOutputDir)) {
+  mkdirSync(srcOutputDir, { recursive: true });
+}
+
+/**
+ * @dev Reads each artifact file and writes it to srcOutputDir
+ */
+zksyncArtifacts.forEach((file) => {
+  const fileContent = readFileSync(file, 'utf-8');
+  let fileName = `${basename(file, '.json')}`;
+
+  const outputFile = join(srcOutputDir, `${fileName}.json`);
+
+  writeFileSync(outputFile, fileContent);
+});
+
+console.log(
+  `Generated ${zksyncArtifacts.length} individual JSON Artifacts in ${srcOutputDir}`,
+);

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,