feat: zkSync (#320)

* chore: zksync configs

* chore: copy ProtocolV3TestBase

* fix: ProtocolV3TestBase

* chore: misc cleanup

* test: protocolV3TestBase

* fix: script utils

* feat: create2 utils

* chore: some comments

* fix: create2Utils

* fix: zksync govV3 helpers

* chore: add zksync payloadsController

* chore: update address-book

* fix: govV3Helpers

* chore: make method pure

* chore: fix chainId

* chore: update libs

* feat: zksync config engine payload

* chore: update solidity-utils

* fix: generate diff in snapshot helpers

* chore: update address book

* fix: move create2 zksync to solidity-utils

* chore: fix rpc name

* fix: evm version

* chore: update libs

* chore: add zksync ci

* chore: test ci

* chore: trigger

* chore: update forge-std

* chore: test ci

* chore: test ci

* fix: remove test

* fix: workflow to main branch

* fix: update foundry.toml

* fix: updated libs to main

---------

Co-authored-by: sendra <[email protected]>

.env.example

@@ -16,6 +16,7 @@ RPC_GNOSIS=https://rpc.gnosischain.com
 RPC_ZKEVM=https://polygon-zkevm.drpc.org
 RPC_SCROLL=https://rpc.scroll.io
 RPC_ZKEVM=https://zkevm-rpc.com	
+RPC_ZKSYNC=https://mainnet.era.zksync.io
 
 # Testnet rpc_endpoints
 RPC_SEPOLIA=wss://ethereum-sepolia.publicnode.com
@@ -29,3 +30,4 @@ ETHERSCAN_API_KEY_ARBITRUM=
 ETHERSCAN_API_KEY_BASE=
 ETHERSCAN_API_KEY_BNB=
 ETHERSCAN_API_KEY_ZKEVM=
+ETHERSCAN_API_KEY_ZKSYNC=

.github/workflows/merge-main.yml

@@ -14,6 +14,13 @@ jobs:
   test:
     uses: bgd-labs/github-workflows/.github/workflows/foundry-test.yml@main
     secrets: inherit
+  test-sol-zksync:
+    uses: bgd-labs/github-workflows/.github/workflows/foundry-test.yml@main
+    secrets: inherit
+    with:
+      mode: "CHANGED"
+      zksync: true
+      ROOT_DIR: "zksync"
   release:
     needs: [test]
     uses: bgd-labs/github-workflows/.github/workflows/release.yml@main

.gitignore

@@ -1,5 +1,6 @@
 cache/
 out/
+zkout/
 .idea
 .env
 broadcast

foundry.toml

@@ -10,6 +10,21 @@ ffi = true
 solc = '0.8.18'
 evm_version = 'shanghai'
 
+[profile.zksync]
+src = 'zksync/src'
+test = 'zksync/tests'
+libs = ['lib']
+solc = '0.8.20'
+fs_permissions = [{ access = "write", path = "./reports" }]
+ffi = true
+evm_version = 'shanghai'
+
+[profile.zksync.zksync]
+compile = true
+fallback_oz = true
+mode = '3'
+zksolc = '1.5.1'
+
 [rpc_endpoints]
 mainnet = "${RPC_MAINNET}"
 optimism = "${RPC_OPTIMISM}"
@@ -25,6 +40,7 @@ sepolia = "${RPC_SEPOLIA}"
 gnosis = "${RPC_GNOSIS}"
 scroll = "${RPC_SCROLL}"
 zkevm = "${RPC_ZKEVM}"
+zksync = "${RPC_ZKSYNC}"
 
 [etherscan]
 mainnet = { key = "${ETHERSCAN_API_KEY_MAINNET}", chainId = 1 }
@@ -39,4 +55,5 @@ sepolia = { key = "${ETHERSCAN_API_KEY_MAINNET}", chainId = 11155111 }
 gnosis = { key = "${ETHERSCAN_API_KEY_GNOSIS}", chainId = 100, url = 'https://api.gnosisscan.io/api' }
 scroll = { key = "${ETHERSCAN_API_KEY_SCROLL}", chainId = 534352 }
 zkevm = { key = "${ETHERSCAN_API_KEY_ZKEVM}", chainId = 1101 }
+zksync = { key = "${ETHERSCAN_API_KEY_ZKSYNC}", chain = 324 }
 # See more config options https://github.com/gakonst/foundry/tree/master/config

src/GovV3Helpers.sol

@@ -19,11 +19,13 @@ import {GovernanceV3BNB} from 'aave-address-book/GovernanceV3BNB.sol';
 import {GovernanceV3Gnosis} from 'aave-address-book/GovernanceV3Gnosis.sol';
 import {GovernanceV3Scroll} from 'aave-address-book/GovernanceV3Scroll.sol';
 import {GovernanceV3PolygonZkEvm} from 'aave-address-book/GovernanceV3PolygonZkEvm.sol';
+import {GovernanceV3ZkSync} from 'aave-address-book/GovernanceV3ZkSync.sol';
 import {MiscEthereum} from 'aave-address-book/MiscEthereum.sol';
 import {Address} from 'solidity-utils/contracts/oz-common/Address.sol';
 import {Create2Utils} from 'solidity-utils/contracts/utils/ScriptUtils.sol';
 import {StorageHelpers} from './StorageHelpers.sol';
 import {ProxyHelpers} from './ProxyHelpers.sol';
+import {Create2UtilsZkSync} from 'solidity-utils/../zksync/src/contracts/utils/ScriptUtilsZkSync.sol';
 
 interface IGovernance_V2_5 {
   /**
@@ -156,6 +158,32 @@ library GovV3Helpers {
     IVotingMachineWithProofs(machine).submitVote(proposalId, support, votingBalanceProofs);
   }
 
+  // Deploys using the unsanitized bytecodeHash we get via `type(Contract).creationCode`
+  function deployDeterministicZkSync(bytes memory bytecodeHash) internal returns (address) {
+    return Create2UtilsZkSync.create2Deploy('v1', bytecodeHash);
+  }
+
+  // Deploys using the unsanitized bytecodeHash we get via `type(Contract).creationCode`
+  function deployDeterministicZkSync(
+    bytes memory bytecodeHash,
+    bytes memory arguments
+  ) internal returns (address) {
+    return Create2UtilsZkSync.create2Deploy('v1', bytecodeHash, arguments);
+  }
+
+  // Deploys using the sanitized bytecodeHash
+  function deployDeterministicZkSync(bytes32 bytecodeHash) internal returns (address) {
+    return Create2UtilsZkSync.create2Deploy('v1', bytecodeHash);
+  }
+
+  // Deploys using the sanitized bytecodeHash
+  function deployDeterministicZkSync(
+    bytes32 bytecodeHash,
+    bytes memory arguments
+  ) internal returns (address) {
+    return Create2UtilsZkSync.create2Deploy('v1', bytecodeHash, arguments);
+  }
+
   /**
    * Deploys a contract with a constant salt
    */
@@ -184,6 +212,35 @@ library GovV3Helpers {
     return Create2Utils.computeCreate2Address('v1', bytecode, arguments);
   }
 
+  function predictDeterministicAddressZkSync(bytes32 bytecodeHash) internal pure returns (address) {
+    return Create2UtilsZkSync.computeCreate2Address('v1', bytecodeHash);
+  }
+
+  function predictDeterministicAddressZkSync(
+    bytes32 bytecodeHash,
+    bytes memory arguments
+  ) internal pure returns (address) {
+    return Create2UtilsZkSync.computeCreate2Address('v1', bytecodeHash, arguments);
+  }
+
+  function buildActionZkSync(
+    Vm vm,
+    string memory contractName
+  ) internal view returns (IPayloadsControllerCore.ExecutionAction memory) {
+    bytes32 bytecodeHash = _getBytecodeHashFromArtifacts(vm, contractName);
+    address payloadAddress = predictDeterministicAddressZkSync(bytecodeHash);
+    return buildAction(payloadAddress);
+  }
+
+  function _getBytecodeHashFromArtifacts(Vm vm, string memory contractName) private view returns (bytes32 bytecodeHash) {
+    string memory artifactPath = string.concat('zkout/', contractName, '.sol/', contractName, '.json');
+    string memory artifact = vm.readFile(artifactPath);
+    bytecodeHash = vm.parseJsonBytes32(artifact, ".hash");
+
+    require(bytecodeHash != (bytes32(0)), 'Unable to fetch bytecodeHash from the zkout artifacts');
+    return bytecodeHash;
+  }
+
   /**
    * @dev builds a action to be registered on a payloadsController
    * - assumes accesscontrol level 1
@@ -606,6 +663,30 @@ library GovV3Helpers {
     return _buildPayload(vm, ChainIds.SCROLL, action);
   }
 
+  /**
+   * Builds a payload to be executed via governance
+   * @param vm Vm
+   * @param actions actions array
+   */
+  function buildZkSyncPayload(
+    Vm vm,
+    IPayloadsControllerCore.ExecutionAction[] memory actions
+  ) internal returns (PayloadsControllerUtils.Payload memory) {
+    return _buildPayload(vm, ChainIds.ZKSYNC, actions);
+  }
+
+  /**
+   * Builds a payload to be executed via governance
+   * @param vm Vm
+   * @param action actions array
+   */
+  function buildZkSyncPayload(
+    Vm vm,
+    IPayloadsControllerCore.ExecutionAction memory action
+  ) internal returns (PayloadsControllerUtils.Payload memory) {
+    return _buildPayload(vm, ChainIds.ZKSYNC, action);
+  }
+
   /**
    * @dev creates a proposal with multiple payloads
    * @param vm Vm
@@ -685,6 +766,8 @@ library GovV3Helpers {
       return GovernanceV3Scroll.PAYLOADS_CONTROLLER;
     } else if (chainId == ChainIds.ZK_EVM) {
       return GovernanceV3PolygonZkEvm.PAYLOADS_CONTROLLER;
+    } else if (chainId == ChainIds.ZKSYNC) {
+      return GovernanceV3ZkSync.PAYLOADS_CONTROLLER;
     }
 
     revert CannotFindPayloadsController();

src/ProtocolV3TestBase.sol

@@ -385,7 +385,7 @@ contract ProtocolV3TestBase is RawProtocolV3TestBase, CommonTestBase {
   function _writeStrategyConfigs(
     string memory path,
     ReserveConfig[] memory configs
-  ) internal override {
+  ) internal virtual override {
     // keys for json stringification
     string memory strategiesKey = 'stategies';
     string memory content = '{}';

src/v3-config-engine/AaveV3PayloadZkSync.sol

@@ -0,0 +1,15 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.0;
+
+import {AaveV3ZkSync} from 'aave-address-book/AaveV3ZkSync.sol';
+import 'aave-v3-origin/periphery/contracts/v3-config-engine/AaveV3Payload.sol';
+
+/**
+ * @dev Base smart contract for an Aave v3.1.0 listing on v3 ZkSync.
+ * @author BGD Labs
+ */
+abstract contract AaveV3PayloadZkSync is AaveV3Payload(IEngine(AaveV3ZkSync.CONFIG_ENGINE)) {
+  function getPoolContext() public pure override returns (IEngine.PoolContext memory) {
+    return IEngine.PoolContext({networkName: 'ZkSync', networkAbbreviation: 'Zks'});
+  }
+}