This project was scaffolded with zksync-cli.
/contracts
: Contains solidity smart contracts./deploy
: Scripts for contract deployment and interaction./test
: Test files.hardhat.config.ts
: Configuration settings.
yarn hardhat compile
: Compiles contracts.yarn deploy
: Deploys using script/deploy/deploy.ts
.yarn interact
: Interacts with the deployed contract using/deploy/interact.ts
.yarn test
: Tests the contracts.
Note: Both yarn deploy
and yarn interact
are set in the package.json
. You can also run your files directly, for example: yarn hardhat deploy-zksync --script deploy.ts
To keep private keys safe, this project pulls in environment variables from .env
files. Primarily, it fetches the wallet's private key.
Rename .env.example
to .env
and fill in your private key:
WALLET_PRIVATE_KEY=your_private_key_here...
hardhat.config.ts
comes with a list of networks to deploy and test contracts. Add more by adjusting the networks
section in the hardhat.config.ts
. To make a network the default, set the defaultNetwork
to its name. You can also override the default using the --network
option, like: hardhat test --network dockerizedNode
.
Running yarn test
by default runs the zkSync In-memory Node provided by the @matterlabs/hardhat-zksync-node tool.
Important: zkSync In-memory Node currently supports only the L2 node. If contracts also need L1, use another testing environment like Dockerized Node. Refer to test documentation for details.
This project is under the MIT license.