github/zkopru
1
1
Fork 0
mirror of https://github.com/zkopru-network/zkopru.git synced 2026-01-10 06:57:58 -05:00
Code Issues Packages Projects Releases Wiki Activity

docs: update README

Browse Source
This commit is contained in:
Wanseob Lim
2021-11-10 23:34:17 +09:00
parent e737cf3d69
commit fa398ef2c4
1 changed files with 19 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@@ -2,11 +2,10 @@
![GitHub tag (latest SemVer)](https://img.shields.io/github/v/tag/zkopru-network/zkopru)
An audit for the Zkopru testnet v2 is on the process!
| Branch | Status |
| --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `develop` | [![zkopru-network](https://circleci.com/gh/zkopru-network/zkopru/tree/develop.svg?style=svg)](https://app.circleci.com/pipelines/github/zkopru-network/zkopru) |
| Branch | Status |
| --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `main` | [![zkopru-network](https://circleci.com/gh/zkopru-network/zkopru/tree/main.svg?style=svg)](https://app.circleci.com/pipelines/github/zkopru-network/zkopru?branch=main) |
| `develop` | [![zkopru-network](https://circleci.com/gh/zkopru-network/zkopru/tree/develop.svg?style=svg)](https://app.circleci.com/pipelines/github/zkopru-network/zkopru?branch=develop) |
![Banner](https://docs.google.com/drawings/d/e/2PACX-1vRwGTvmJAbNBZCK5syubcrWZgYc3wuK9cHZScbc5lgyLbBYsx42Xzo60unw4-oLlPg_-nwXxaE3t9c6/pub?w=1280)
@@ -14,12 +13,11 @@ An audit for the Zkopru testnet v2 is on the process!
Zkopru(zk-optimistic-rollup) is a layer-2 scaling solution for private transactions using zk-SNARK and optimistic rollup. It supports private transfer and private atomic swap within the layer-2 network between ETH, ERC20, ERC721 at a low cost. Also, with the pay-in-advance feature, users can withdraw assets from the layer-2 before the finalization.
## Usage
## Related projects
```shell
npm install -g @zkopru/cli
zkopru-wallet
```
- [Zkopru Wallet](https://github.com/zkopru-network/wallet)
- [Private Exchange](https://github.com/zkopru-network/private-exchange)
- [Payment Service](https://github.com/zkopru-network/merchant-payment-service)
## Get more information
@@ -27,11 +25,20 @@ zkopru-wallet
- [Document](https://docs.zkopru.network) [(edit)](https://github.com/wanseob/docs.zkopru.network)
## Audits
- [1st audit report by Least Authority](https://github.com/zkopru-network/resources/blob/main/audits/v1/Least%20Authority%20-%20Ethereum%20Foundation%20Zkopru%20zk-SNARK%20Circuits%20%2B%20Smart%20Contracts%20-%20Final%20Audit%20Report.pdf)
- [2nd audit report by Igor Gulamov](https://github.com/zkopru-network/resources/blob/main/audits/v2/AUDIT-REPORT.md)
## Trusted Setup
- [Trusted Setup Result](https://storage.googleapis.com/zkopru-mpc-files/index.html)
- [Keys](https://ipfs.io/ipfs/QmSQtbTnt5RWrP8uWJ3S5xUKntTx2DqcM7mM5vUg9uJGxq)(ipfs cid: QmSQtbTnt5RWrP8uWJ3S5xUKntTx2DqcM7mM5vUg9uJGxq)
## Stress Testing
- [Go to repo](https://github.com/zkopru-network/stress-test)
## Contribution
- [Code of conduct](./CODE_OF_CONDUCT.md)
@@ -53,6 +60,8 @@ zkopru-wallet
- Thore Hildebrandt ([@ETHorHIL](https://github.com/ETHorHIL), hildebrandtthore@gmail.com)
- Geoff Lamperd ([@glamperd](https://github.com/glamperd))
- Jinhwan Shin ([@sifnoc](https://github.com/sifnoc))
- Rachel Akerley ([@rachelaux](https://github.com/rachelaux))
- Takamichi Tsutsumi ([@tkmct](https:?/github.com/tkmct))
## License