Skip to content

Latest commit

 

History

History
94 lines (61 loc) · 2.28 KB

README.md

File metadata and controls

94 lines (61 loc) · 2.28 KB
Raw

zkevm-contracts

Smart contract implementation which will be used by the polygon-hermez zkevm

Main CI

WARNING: All code here is in WIP

Note

Private keys and mnemonics contained in this repository are used for internal test exclusively. Do not use them in production environments

Requirements

  • node version: 14.x
  • npm version: 7.x

Repository structure

  • contracts: zkevm contracts
    • PolygonZkEVMBridge.sol: transfer assets between chains
      • PolygonZkEVMGlobalExitRoot.sol: manage global exit root in L1
      • PolygonZkEVMGlobalExitRootL2.sol: manage global exit root in L2
    • PolygonZkEVM.sol: consensus algorithm used by polyhon hermez zkevm
  • docs: specs and useful links
  • test: contracts tests

Activate github hook

git config --local core.hooksPath .githooks/

Install

npm i

Run tests

npm run test

Run Linter

See errors:

npm run lint

Autofix errors:

npm run lint:fix

Deploy on hardhat

npm run deploy:ZkEVM:hardhat

Build dockers

npm run docker:contracts

A new docker hermez-geth1.3:latest will be created This docker will contain a geth node with the deployed contracts The deployment output can be found in: docker/deploymentOutput/deploy_output.json To run the docker you can use: docker run -p 8545:8545 hermez-geth1.3:latest

License

Copyright

Polygon zkevm-contracts was developed by Polygon. While we plan to adopt an open source license, we haven’t selected one yet, so all rights are reserved for the time being. Please reach out to us if you have thoughts on licensing.

Note

In order to test, the following private keys are being used. This keys are not meant to be used in any production environment:

  • private key: 0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80
    • address:0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266
  • private key: 0xdfd01798f92667dbf91df722434e8fbe96af0211d4d1b82bbbbc8f1def7a814f
    • address:0xc949254d682d8c9ad5682521675b8f43b102aec4

Disclaimer

This code has not yet been audited, and should not be used in any production systems.