https://github.com/zkLinkProtocol/zklink-contracts

zklink core contract, EVM compatible.
https://github.com/zkLinkProtocol/zklink-contracts

cross-chain dex layer2 zkrollup zksnark

Last synced: 3 months ago
JSON representation

zklink core contract, EVM compatible.

• Host: GitHub
• URL: https://github.com/zkLinkProtocol/zklink-contracts
• Owner: zkLinkProtocol
• License: apache-2.0
• Created: 2021-06-14T09:59:12.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-04-01T09:43:40.000Z (3 months ago)
• Last Synced: 2024-04-02T08:52:50.416Z (3 months ago)
• Topics: cross-chain, dex, layer2, zkrollup, zksnark
• Language: Solidity
• Homepage: https://zk.link
• Size: 1.73 MB
• Stars: 76
• Watchers: 3
• Forks: 50
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-APACHE
  • Security: docs/SecurityCheck.md

Lists

• awesome-zk - ZkLink: cross chain amm swap protocol powered by ZK-Rollup

README

        
# [ZkLink Contracts](https://zk.link/)

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.

```shell

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:

```shell

npx hardhat test test/bytes_test.js

```

## Deploy

* [Firstly deploy](docs/Deploy.md)

* [Upgrade](docs/Upgrade.md)

* [Interact with zkLink](docs/Interact.md)

## Development

For developers, static analysis need to be done before committing code. Read more of [SecurityCheck](docs/SecurityCheck.md).