feat(Foundry): zkSync support (#1097)

* feat(Foundry): zkSync support

Signed-off-by: Faisal Usmani <faisal.of.usmani@gmail.com>

* Added forge sksync script

Signed-off-by: Faisal Usmani <faisal.of.usmani@gmail.com>

* Added forge zksync command

Signed-off-by: Faisal Usmani <faisal.of.usmani@gmail.com>

* Added foundry zksync profile check in deployment utils

Signed-off-by: Faisal Usmani <faisal.of.usmani@gmail.com>

* Removed redundant check

Signed-off-by: Faisal Usmani <faisal.of.usmani@gmail.com>

* Fixed zksync profile

Signed-off-by: Faisal Usmani <faisal.of.usmani@gmail.com>

* Added zkout to clean script

Signed-off-by: Faisal Usmani <faisal.of.usmani@gmail.com>

* Added zksync rpc and readme

Signed-off-by: Faisal Usmani <faisal.of.usmani@gmail.com>

---------

Signed-off-by: Faisal Usmani <faisal.of.usmani@gmail.com>

Author: fusmanii

.gitignore

@@ -28,6 +28,7 @@ artifacts-zk
 
 # Foundry files
 out
+zkout
 
 # Upgradeability files
 .openzeppelin

README.md

@@ -77,6 +77,24 @@ forge script script/001DeployHubPool.s.sol:DeployHubPool --rpc-url ethereum --br
 
 ```
 
+#### Foundry (ZKSync)
+
+To enable ZKSync support, the zksync fork of foundry must be installed (see [here](https://foundry-book.zksync.io/introduction/installation#using-foundryup-zksync) for instructions).
+
+Also, the `FOUNDRY_PROFILE` environment variable must be set to `zksync`.
+
+```shell
+export FOUNDRY_PROFILE=zksync
+
+forge script script/016DeployZkSyncSpokePool.s.sol:DeployZkSyncSpokePool --rpc-url zksync --broadcast --verify -vvvv
+```
+
+Alternatively, the `yarn forge-script-zksync` command can be used to deploy the contract.
+
+```shell
+yarn forge-script-zksync script/016DeployZkSyncSpokePool.s.sol:DeployZkSyncSpokePool --rpc-url zksync --broadcast --verify -vvvv
+```
+
 ### SVM
 
 Before deploying for the first time make sure all program IDs in `lib.rs` and `Anchor.toml` are the same as listed when running `anchor keys list`. If not, update them to match the deployment keypairs under `target/deploy/` and commit the changes.

foundry.toml

@@ -35,8 +35,31 @@ fs_permissions = [{ access = "read", path = "./"}]
 solc = "0.8.23"
 evm_version = "prague"
 
+[profile.zksync.zksync]
+compile = true
+fallback_oz = true
+mode = '3'
+zksolc = "1.5.7"
+
 [rpc_endpoints]
+arbitrum = "${NODE_URL_42161}"
+base = "${NODE_URL_8453}"
+bsc = "${NODE_URL_56}"
 ethereum = "${NODE_URL_1}"
+ink = "${NODE_URL_57073}"
+lens = "${NODE_URL_262}"
+linea = "${NODE_URL_59144}"
+lisk = "${NODE_URL_1135}"
+mode = "${NODE_URL_34443}"
+optimism = "${NODE_URL_10}"
+polygon = "${NODE_URL_137}"
+redstone = "${NODE_URL_690}"
+scroll = "${NODE_URL_534352}"
+soneium = "${NODE_URL_1868}"
+unichain = "${NODE_URL_130}"
+world-chain = "${NODE_URL_480}"
+zksync = "${NODE_URL_324}"
+
 
 [etherscan]
 ethereum = { key = "${ETHERSCAN_API_KEY}" }

package.json

@@ -19,13 +19,14 @@
   "main": "dist/index.js",
   "scripts": {
     "compile-zksync": "COMPILE_ZK=true yarn hardhat compile",
+    "forge-script-zksync": " FOUNDRY_PROFILE=zksync forge script --zksync --suppress-errors sendtransfer",
     "lint": "yarn lint-solidity && yarn lint-js && yarn lint-rust",
     "lint-solidity": "yarn solhint ./contracts/**/*.sol",
     "lint-js": "yarn prettier --list-different **/*.js **/*.ts",
     "lint-rust": "cargo +nightly fmt --all -- --check && cargo clippy",
     "lint-fix": "yarn prettier --write **/*.js **/*.ts ./programs/**/*.rs ./contracts**/*.sol && cargo +nightly fmt  --all && cargo clippy",
-    "clean-fast": "for dir in node_modules cache cache-zk artifacts artifacts-zk dist typechain out; do mv \"${dir}\" \"_${dir}\"; rm -rf \"_${dir}\" &; done",
-    "clean": "rm -rf node_modules cache cache-zk artifacts artifacts-zk dist typechain out",
+    "clean-fast": "for dir in node_modules cache cache-zk artifacts artifacts-zk dist typechain out zkout; do mv \"${dir}\" \"_${dir}\"; rm -rf \"_${dir}\" &; done",
+    "clean": "rm -rf node_modules cache cache-zk artifacts artifacts-zk dist typechain out zkout",
     "generate-svm-artifacts": "bash ./scripts/svm/buildHelpers/buildIdl.sh && sh ./scripts/svm/buildHelpers/generateSvmAssets.sh && yarn generate-svm-clients",
     "generate-svm-clients": "yarn ts-node ./scripts/svm/buildHelpers/generateSvmClients.ts && yarn ts-node ./scripts/svm/buildHelpers/renameClientsImports.ts",
     "build-evm": "hardhat compile",

script/059DeployLensSpokePool.s.sol

@@ -11,11 +11,11 @@ import { DeploymentUtils } from "./utils/DeploymentUtils.sol";
 
 // How to run:
 // 1. `source .env` where `.env` has MNEMONIC="x x x ... x"
-// 2. forge script script/059DeployLensSpokePool.s.sol:DeployLensSpokePool --rpc-url $NODE_URL_1 -vvvv
+// 2. yarn forge-script-zksync script/059DeployLensSpokePool.s.sol:DeployLensSpokePool --rpc-url lens -vvvv
 // 3. Verify the above works in simulation mode.
 // 4. Deploy with:
-//        forge script script/059DeployLensSpokePool.s.sol:DeployLensSpokePool --rpc-url \
-//        $NODE_URL_1 --broadcast --verify --verifier blockscout --verifier-url https://verify.lens.xyz/contract_verification
+//        yarn forge-script-zksync script/059DeployLensSpokePool.s.sol:DeployLensSpokePool --rpc-url lens \
+//        --broadcast --verify --verifier blockscout --verifier-url https://verify.lens.xyz/contract_verification
 
 contract DeployLensSpokePool is Script, Test, DeploymentUtils {
     function run() external {

script/utils/DeploymentUtils.sol

@@ -30,6 +30,10 @@ contract DeploymentUtils is Script, Test, Constants, DeployedAddresses {
         bool isNewProxy;
     }
 
+    constructor() {
+        checkZkSyncChain(block.chainid);
+    }
+
     /**
      * @notice Get deployment information for SpokePool deployment
      * @dev This function mimics getSpokePoolDeploymentInfo from utils.hre.ts
@@ -190,4 +194,26 @@ contract DeploymentUtils is Script, Test, Constants, DeployedAddresses {
             chainId == getChainId("LISK_SEPOLIA") ||
             chainId == getChainId("MODE_SEPOLIA");
     }
+
+    /**
+     * @notice Check if a chain ID is a ZkSync chain
+     * @dev This function will revert if the chain ID is a ZkSync chain but the FOUNDRY_PROFILE is not zksync
+     * @param chainId Chain ID to check
+     */
+    function checkZkSyncChain(uint256 chainId) internal view {
+        bool isZkSyncChain = chainId == getChainId("ZK_SYNC") ||
+            chainId == getChainId("ZK_SYNC_SEPOLIA") ||
+            chainId == getChainId("LENS") ||
+            chainId == getChainId("LENS_TESTNET");
+
+        string memory foundryProfile = vm.envOr("FOUNDRY_PROFILE", string("default"));
+
+        if (isZkSyncChain) {
+            vm.assertEq(
+                foundryProfile,
+                string("zksync"),
+                "Chain is a ZkSync chain but FOUNDRY_PROFILE is not zksync. Use yarn forge-script-zksync to deploy"
+            );
+        }
+    }
 }