No Description

Roman Storm fd173c5234 migrate 5 years ago
circuits 9757978d27 new circomlib update 5 years ago
contracts fd173c5234 migrate 5 years ago
lib e6a4208b52 change zero value constant 5 years ago
migrations fd173c5234 migrate 5 years ago
test 4114f7b52c rename variables 5 years ago
.editorconfig b5b3474165 Move contracts to repository root 5 years ago
.env.example 1515959a01 change tree depth to 20 5 years ago
.eslintrc.json b0c896c681 styling final 5 years ago
.gitattributes 641c76fa39 add dummy test 5 years ago
.gitignore 4114f7b52c rename variables 5 years ago
.nvmrc e8fa073caf fix tests 5 years ago
.solhint.json d91435dd00 add pauseDeposits 5 years ago
.travis.yml c7f0ca9dfa add erc20 to integration test 5 years ago
LICENSE 21a9545b54 Create LICENSE 5 years ago
README.md 08f8bfb070 tidy 5 years ago
cli.js 6cd0ae8d87 fix cli 5 years ago
diagram.png 4114f7b52c rename variables 5 years ago
index.html 4114f7b52c rename variables 5 years ago
migrationDeposits.js fd173c5234 migrate 5 years ago
package-lock.json 9757978d27 new circomlib update 5 years ago
package.json 9757978d27 new circomlib update 5 years ago
truffle-config.js a94281ccc5 update dependencies 5 years ago

README.md

Tornado Cash Privacy Solution Build Status

Tornado Cash is a non-custodial Ethereum and ERC20 privacy solution based on zkSNARKs. It improves transaction privacy by breaking the on-chain link between recipient and destination addresses. It uses a smart contract that accepts ETH deposits that can be withdrawn by a different address. Whenever ETH is withdrawn by the new address, there is no way to link the withdrawal to the deposit, ensuring complete privacy.

To make a deposit user generates a secret and sends its hash (called a commitment) along with the deposit amount to the Tornado smart contract. The contract accepts the deposit and adds the commitment to its list of deposits.

Later, the user decides to make a withdrawal. In order to do that, the user should provide a proof that he or she possesses a secret to an unspent commitment from the smart contract’s list of deposits. zkSnark technology allows that to happen without revealing which exact deposit corresponds to this secret. The smart contract will check the proof, and transfer deposited funds to the address specified for withdrawal. An external observer will be unable to determine which deposit this withdrawal came from.

You can read more about it in this medium article

Specs

  • Deposit gas const: 1088354 (43381 + 50859 * tree_depth)
  • Withdraw gas cost: 301233
  • Circuit Constraints = 28271 (1869 + 1325 * tree_depth)
  • Circuit Proof time = 10213ms (1071 + 347 * tree_depth)
  • Serverless

image

Was it audited?

Tornado.cash protocols, circuits, and smart contracts were audited by a group of experts from ABDK Consulting, specializing in zero knowledge, cryptography, and smart contracts.

During the audit no critical issues were found and all outstanding issues were fixed. The results can be found here:

Underlying circomlib dependency is currently being audited, and the team already published most of the fixes for found issues

Requirements

  1. node v11.15.0
  2. npm install -g npx

Usage

You can see example usage in cli.js, it works both in console and in browser.

  1. npm install
  2. cp .env.example .env
  3. npm run build - this may take 10 minutes or more
  4. npx ganache-cli
  5. npm run test - optionally runs tests. It may fail on the first try, just run it again.

Use browser version on Kovan:

  1. vi .env - add your Kovan private key to deploy contracts
  2. npm run migrate
  3. npx http-server - serve current dir, you can use any other static http server
  4. Open localhost:8080

Use with command line version with Ganache:

ETHTornado

  1. npm run migrate:dev
  2. ./cli.js deposit
  3. ./cli.js withdraw <note from previous step> <destination eth address>
  4. ./cli.js balance <destination eth address>

ERC20Tornado

  1. npm run migrate:dev
  2. ./cli.js depositErc20
  3. ./cli.js withdrawErc20 <note from previous step> <destination eth address> <relayer eth address>
  4. ./cli.js balanceErc20 <destination eth address> <relayer eth address>

If you want, you can point the app to existing tornado contracts on Mainnet or Kovan. It should work without any problems

Deploy ETH Tornado Cash

  1. cp .env.example .env
  2. Tune all necessary params
  3. npx truffle migrate --network kovan --reset --f 2 --to 4

Deploy ERC20 Tornado Cash

  1. cp .env.example .env
  2. Tune all necessary params
  3. npx truffle migrate --network kovan --reset --f 2 --to 3
  4. npx truffle migrate --network kovan --reset --f 5

Note. If you want to reuse the same verifier for all the instances, then after you deployed one of the instances you should only run 4th or 5th migration for ETH or ERC20 contracts respectively (--f 4 --to 4 or --f 5).

Migraton

  1. npm install
  2. cp .env.example .env
  3. npm run build - this may take 10 minutes or more
  4. npm run migrate:kovan
  5. Take ETHTornado's address address from the output and set it as HELPER_INSTANCE in ./migrationDeposits.js
  6. Go to ./migrations/4_deploy_eth_mixer.js and change const ETHTornado = artifacts.require('ETHTornado') to const ETHTornado = artifacts.require('MigratableETHTornado')
  7. npm run migrate:mainnet
  8. Take ETHTornado's address address from the output and set it as NEW_INSTANCE in ./migrationDeposits.js
  9. Setup right SOURCE_RPC and TARGET_RPC in the ./migrationDeposits.js
  10. Go to ./migrationDeposits.js at the line 141 (// 3. Decide should we uncomment here)
  11. node migrationDeposits.js

Credits

Special thanks to @barryWhiteHat and @kobigurk for valuable input, and to @jbaylina for awesome Circom & Websnark framework