diff --git a/README.md b/README.md index de811a5..eee9d8d 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,15 @@ # Tornado Pool [![Build Status](https://github.com/tornadocash/tornado-pool/workflows/build/badge.svg)](https://github.com/tornadocash/tornado-pool/actions) +This an experimental version of tornado.cash that allows to deposit arbitrary amounts and make internal(shielded) transfers. + +Other facts about this version: + +1. It uses L2 (xdai). Xdai has a ETH(mainnet)<>WETH(xdai) bridge that will be used under hood. +2. Contracts will be upgradable by tornado-cash governance! xdai bridge supports transferring messages from L1 to L2 and vise versa, so community can always upgrade tornado-pool to a new version in case of an issue. +3. Since it's a beta version, deposits are limited by 1ETH. Governance can always increase the limit. +4. Withdrawal amount from pool to L1 has to be larger than 0.05 ETH to prevent spam attack on the bridge. +5. The code was [audited](./resources/Zeropool-Tornado.pool-audit.pdf) by Igor Gulamov from Zeropool. + ## Usage ```shell @@ -8,15 +18,3 @@ yarn download yarn build yarn test ``` - -TODO - -1. deposit from mainnet to the pool on optimism in one tx - -## Useful - -How we do transaction inside pool of A amount. - -1. sort inputs by amount -2. try to take 1 or 2 smallest inputs to satisfy A amount. Get 16 inputs if it's not possible using the same way -3. Also you can always use transaction to merge your inputs with change (especially in 16 inputs case) diff --git a/resources/Zeropool-Tornado.pool-audit.pdf b/resources/Zeropool-Tornado.pool-audit.pdf new file mode 100644 index 0000000..fd2a9c0 Binary files /dev/null and b/resources/Zeropool-Tornado.pool-audit.pdf differ