Skip to content

Commit

Permalink
feat: add zksync instructions to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
clauBv23 committed Jan 20, 2025
1 parent bd92b28 commit 593e9bc
Showing 1 changed file with 17 additions and 13 deletions.
30 changes: 17 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,35 +76,26 @@ 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
```

### 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
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 593e9bc

Please sign in to comment.