README.md

ZkLink Contracts

ZkLink is a cross chain protocol powered by ZK-Rollup. It currently supports evm based chain such as Ethereum, Binance Smart Chain, Heco Chain.

Install Dependencies

npm install

Prepare for compile

Before compile contracts, you should generate KeysWithPlonkVerifier.sol and put it to contracts/zksync directory. For local development, you could copy and rename the KeysWithPlonkVerifier.example at the root path.

cp KeysWithPlonkVerifier.example contracts/zksync/KeysWithPlonkVerifier.sol

Compile contracts

npx hardhat compile

Run tests

Run all unit tests:

npx hardhat test

Run a unit test:

npx hardhat test test/bytes_test.js

Deploy

• Firstly deploy
• Upgrade
• Interact with zkLink

Development

For developers, static analysis need to be done before committing code. Read more of SecurityCheck.