From 593e9bce2e391e90966390aaadd825e124505d02 Mon Sep 17 00:00:00 2001 From: Claudia Date: Mon, 20 Jan 2025 10:34:04 +0100 Subject: [PATCH] feat: add zksync instructions to readme --- README.md | 30 +++++++++++++++++------------- 1 file changed, 17 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index cc2fdf04..81519c2a 100644 --- a/README.md +++ b/README.md @@ -76,7 +76,7 @@ Before deploying, you MUST also change the default hardhat private key (`PRIVATE ## Contracts -In `packages/contracts`, first run +This package is located in `packages/contracts`, first run ```sh yarn install @@ -84,27 +84,18 @@ yarn install ### Building -First build the contracts and +To build the contracts on EVM based networks: ```sh yarn build ``` -and generate the [typechain TypeScript bindings](https://github.com/dethcrypto/TypeChain) with +On Zksync: ```sh -yarn typechain +yarn build:zksync ``` -During development of your smart contracts, changes can result in altered typechain bindings. -You can remove the outdated build- and typechain-related files with - -```sh -yarn clean -``` - -which will execute `yarn typechain` again. For convenience, use `yarn clean && yarn build`. - ### Testing To test your contracts, run @@ -113,6 +104,12 @@ To test your contracts, run yarn test ``` +on zksync: + +```sh +yarn test:zksync +``` + ### Linting Lint the Solidity and TypeScript code all together with @@ -224,6 +221,13 @@ This will upgrade your plugin repo to the latest Aragon OSx protocol version imp Note, that if the deploying account doesn't own the repo anymore, this will create a `upgradeRepoProposalData-sepolia.json` containing the data for a management DAO signer to create a proposal upgrading the repo. +If you want to run deployments against zksync, you can use: + +```sh +yarn deploy:zksync --network zksyncSepolia --tags ... +yarn deploy:zksync --network zksyncMainnet --tags ... +``` + ## Subgraph ### Installing