Skip to content

Commit

Permalink
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Feature: add zksync support to v1.5.0 (safe-global#742)
Browse files Browse the repository at this point in the history
**This PR:**
- Implements
safe-global#766 by adding
the zksync support for deployment and testing contracts
- It is based on
safe-global#651. However,
Matter Labs has published many updates in the meantime, so there are
many changes
- Add zksync tests to the CI

**Importants changes**
- The zksync team did a great job of adding a lot of interoperability
features with hardhat's environment ethers object, however, there are
certain features we rely on that require zksync-specific adjustments,
such as compiling code from string, contract deployment, create2 address
calculation. Functions specific to that had to be adjusted
- we had incorrect test assumptions: for example, we assumed that
`hre.ethers.getContractAt` would always return a contract instance
connected to the first account returned from `hre.ethers.getSigners`.
This didn't hold in zksync environment as they use the 9th account

**Notes**
- This PR doesn't include changes to Safe Migration contract tests for
zksync, as we decided to merge this first and add the support to 1.4.1
and fix the migration contracts there, then cherry-pick it back to 1.5.0

**Proof of deployment:**
```
> hardhat deploy-contracts --network zkSyncSepolia

Yul codegen is only supported for solc >= 0.8. Flag forceEVMLA will automatically be set to true by default.
Yul codegen is only supported for solc >= 0.8. Flag forceEVMLA will automatically be set to true by default.
The zksolc compiler version in your Hardhat config file (1.5.2) is not the latest. We recommend using the latest version 1.5.3.
Nothing to compile
No need to generate any newer typings.
reusing "SimulateTxAccessor" at 0x1aaa95173dAA2F9B18df1277485CAd842Bb5EeFe
reusing "SafeProxyFactory" at 0x9c8588F1Cfbf54845c06C6924E90b20AB0912B6F
reusing "TokenCallbackHandler" at 0x94AA81a0E2e857A0e5978b7E4218DdAE2d611bCf
reusing "CompatibilityFallbackHandler" at 0x7e940bC046e2a069F67e40f00A9d5749Abf59f70
reusing "CreateCall" at 0xded498F0eEEAe67E2E339a42e5c926335fDDCcf7
reusing "MultiSend" at 0xE25a6DFf1cbD91d195D87ECb90C96517fc98F581
reusing "MultiSendCallOnly" at 0x0E5006a4179dF454031800eC575F413c83d7B025
reusing "SignMessageLib" at 0x97273487793848a571054bf3a5FDc9c0982648B9
reusing "Safe" at 0xB23798CfB614f3A1a6d0820c08e004922475CD76
reusing "SafeL2" at 0x0ED239feb23632cE272A0AE5f8bfd843377897DF
reusing "SafeToL2Migration" at 0x4c81Ce72dD304E27739A5607f0Ba7207eD415360
reusing "SafeMigration" at 0x80dd94053ED6075992771A2Df501eFF101fBc281
Verification status for CompatibilityFallbackHandler: SUCCESS
Verification status for CreateCall: SUCCESS
Verification status for MultiSend: SUCCESS
Verification status for MultiSendCallOnly: SUCCESS
Verification status for Safe: SUCCESS
Verification status for SafeL2: SUCCESS
Verification status for SafeMigration: SUCCESS
Verification status for SafeProxyFactory: SUCCESS
Verification status for SafeToL2Migration: SUCCESS
Verification status for SignMessageLib: SUCCESS
Verification status for SimulateTxAccessor: SUCCESS
Verification status for TokenCallbackHandler: SUCCESS

Running zk verification on block explorer

Verifying CompatibilityFallbackHandler at 0x7e940bC046e2a069F67e40f00A9d5749Abf59f70...
Your verification ID is: 23855
Contract successfully verified on ZKsync block explorer!

Verifying CreateCall at 0xded498F0eEEAe67E2E339a42e5c926335fDDCcf7...
Your verification ID is: 23856
Contract successfully verified on ZKsync block explorer!

Verifying MultiSend at 0xE25a6DFf1cbD91d195D87ECb90C96517fc98F581...
Your verification ID is: 23857
Contract successfully verified on ZKsync block explorer!

Verifying MultiSendCallOnly at 0x0E5006a4179dF454031800eC575F413c83d7B025...
Your verification ID is: 23858
Contract successfully verified on ZKsync block explorer!

Verifying Safe at 0xB23798CfB614f3A1a6d0820c08e004922475CD76...
Your verification ID is: 23859
Contract successfully verified on ZKsync block explorer!

Verifying SafeL2 at 0x0ED239feb23632cE272A0AE5f8bfd843377897DF...
Your verification ID is: 23860
Contract successfully verified on ZKsync block explorer!

Verifying SafeMigration at 0x80dd94053ED6075992771A2Df501eFF101fBc281...
Your verification ID is: 23861
Contract successfully verified on ZKsync block explorer!

Verifying SafeProxyFactory at 0x9c8588F1Cfbf54845c06C6924E90b20AB0912B6F...
Your verification ID is: 23862
Contract successfully verified on ZKsync block explorer!

Verifying SafeToL2Migration at 0x4c81Ce72dD304E27739A5607f0Ba7207eD415360...
Your verification ID is: 23863
Contract successfully verified on ZKsync block explorer!

Verifying SignMessageLib at 0x97273487793848a571054bf3a5FDc9c0982648B9...
Your verification ID is: 23864
Contract successfully verified on ZKsync block explorer!

Verifying SimulateTxAccessor at 0x1aaa95173dAA2F9B18df1277485CAd842Bb5EeFe...
Your verification ID is: 23865
Contract successfully verified on ZKsync block explorer!

Verifying TokenCallbackHandler at 0x94AA81a0E2e857A0e5978b7E4218DdAE2d611bCf...
Your verification ID is: 23866
Contract successfully verified on ZKsync block explorer!
Execution time: 51.41s
```
mmv08 authored Sep 5, 2024
1 parent c266ffc commit 5c1e50e
Showing 49 changed files with 3,622 additions and 1,036 deletions.
4 changes: 4 additions & 0 deletions .env.sample
Original file line number Diff line number Diff line change
@@ -15,5 +15,9 @@ SAFE_CONTRACT_UNDER_TEST="Safe"
SOLIDITY_VERSION= # Example: '0.8.19'
# For running coverage tests, `details` section of solidity settings are required, else could be removed.
SOLIDITY_SETTINGS= # Example: '{"viaIR":true,"optimizer":{"enabled":true, "details": {"yul": true, "yulDetails": { "optimizerSteps": ""}}}}'
# Set to 1 to run hardhat in zksync mode. This will enable the ZK compiler and run the hardhat node in zksync mode.
HARDHAT_ENABLE_ZKSYNC=0
# Sets hardhat chain id. In general, you don't need this, it's only used for testing the SafeToL2Setup contract.
HARDHAT_CHAIN_ID=31337
# (Optional) Hardhat-deploy only supports zksync deployment if the private key for the account is provided. Specify the private key here.
ZKSYNC_DEPLOYER_PK="0x7726827caac94a7f9e1b160f7ea819f172f7b6f9d2a97f992c38edeab82d4110"
1 change: 1 addition & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -26,6 +26,7 @@ jobs:
cache: "npm"
- run: npm ci
- run: npm run lint:ts:prettier
- run: npm run build:ts:dev # runs typecheck
- run: npm run lint:ts

tests:
6 changes: 5 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
.idea/
build/
node_modules/
.DS_Store
@@ -18,4 +19,7 @@ typechain-types
# Certora Formal Verification related files
.certora_internal
.certora_recent_jobs.json
.zip-output-url.txt
.zip-output-url.txt

# zksync era node log
era_test_node.log
3 changes: 0 additions & 3 deletions .husky/pre-commit
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
#!/usr/bin/env sh
. "$(dirname -- "$0")/_/husky.sh"

npm run lint:sol:prettier
npm run lint:ts:prettier
npm run lint:sol
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -55,6 +55,7 @@ This will deploy the contracts deterministically and verify the contracts on eth
Preparation:
- Set `MNEMONIC` in `.env`
- Set `INFURA_KEY` in `.env`
- For zkSync, set `ZKSYNC_DEPLOYER_PK` in `.env`

```bash
npm run deploy-all <network>
36 changes: 35 additions & 1 deletion hardhat.config.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
import "@nomicfoundation/hardhat-toolbox";
import type { HardhatUserConfig, HttpNetworkUserConfig } from "hardhat/types";
import "@matterlabs/hardhat-zksync-deploy";
import "@matterlabs/hardhat-zksync-solc";
import "@matterlabs/hardhat-zksync-verify";
import "@matterlabs/hardhat-zksync-ethers";
import "@matterlabs/hardhat-zksync-node";
import "hardhat-deploy";
import dotenv from "dotenv";
import yargs from "yargs";
@@ -16,7 +21,17 @@ const argv = yargs

// Load environment variables.
dotenv.config();
const { NODE_URL, INFURA_KEY, MNEMONIC, ETHERSCAN_API_KEY, PK, SOLIDITY_VERSION, SOLIDITY_SETTINGS, HARDHAT_CHAIN_ID } = process.env;
const {
NODE_URL,
INFURA_KEY,
MNEMONIC,
ETHERSCAN_API_KEY,
PK,
SOLIDITY_VERSION,
SOLIDITY_SETTINGS,
HARDHAT_ENABLE_ZKSYNC = "0",
HARDHAT_CHAIN_ID = 31337,
} = process.env;

const DEFAULT_MNEMONIC = "candy maple cake sugar pudding cream honey rich smooth crumble sweet treat";

@@ -73,11 +88,16 @@ const userConfig: HardhatUserConfig = {
solidity: {
compilers: [{ version: primarySolidityVersion, settings: soliditySettings }, { version: defaultSolidityVersion }],
},
zksolc: {
version: "1.5.3",
settings: {},
},
networks: {
hardhat: {
allowUnlimitedContractSize: true,
blockGasLimit: 100000000,
gas: 100000000,
zksync: HARDHAT_ENABLE_ZKSYNC === "1",
chainId: typeof HARDHAT_CHAIN_ID === "string" && !Number.isNaN(parseInt(HARDHAT_CHAIN_ID)) ? parseInt(HARDHAT_CHAIN_ID) : 31337,
},
mainnet: {
@@ -116,6 +136,20 @@ const userConfig: HardhatUserConfig = {
...sharedNetworkConfig,
url: `https://api.avax.network/ext/bc/C/rpc`,
},
zkSyncMainnet: {
...sharedNetworkConfig,
url: "https://mainnet.era.zksync.io",
ethNetwork: "mainnet",
zksync: true,
verifyURL: "https://zksync2-mainnet-explorer.zksync.io/contract_verification",
},
zkSyncSepolia: {
...sharedNetworkConfig,
url: "https://sepolia.era.zksync.dev",
ethNetwork: "goerli",
zksync: true,
verifyURL: "https://explorer.sepolia.era.zksync.dev/contract_verification",
},
},
deterministicDeployment,
namedAccounts: {
Loading

0 comments on commit 5c1e50e

Please sign in to comment.