123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124 |
- // https://tornado.cash
- /*
- * d888888P dP a88888b. dP
- * 88 88 d8' `88 88
- * 88 .d8888b. 88d888b. 88d888b. .d8888b. .d888b88 .d8888b. 88 .d8888b. .d8888b. 88d888b.
- * 88 88' `88 88' `88 88' `88 88' `88 88' `88 88' `88 88 88' `88 Y8ooooo. 88' `88
- * 88 88. .88 88 88 88 88. .88 88. .88 88. .88 dP Y8. .88 88. .88 88 88 88
- * dP `88888P' dP dP dP `88888P8 `88888P8 `88888P' 88 Y88888P' `88888P8 `88888P' dP dP
- * ooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo
- */
- // SPDX-License-Identifier: MIT
- pragma solidity ^0.7.0;
- import "./MerkleTreeWithHistory.sol";
- import "@openzeppelin/contracts/utils/ReentrancyGuard.sol";
- interface IVerifier {
- function verifyProof(bytes memory _proof, uint256[6] memory _input) external returns (bool);
- }
- abstract contract Tornado is MerkleTreeWithHistory, ReentrancyGuard {
- IVerifier public immutable verifier;
- uint256 public denomination;
- mapping(bytes32 => bool) public nullifierHashes;
- // we store all commitments just to prevent accidental deposits with the same commitment
- mapping(bytes32 => bool) public commitments;
- event Deposit(bytes32 indexed commitment, uint32 leafIndex, uint256 timestamp);
- event Withdrawal(address to, bytes32 nullifierHash, address indexed relayer, uint256 fee);
- /**
- @dev The constructor
- @param _verifier the address of SNARK verifier for this contract
- @param _hasher the address of MiMC hash contract
- @param _denomination transfer amount for each deposit
- @param _merkleTreeHeight the height of deposits' Merkle Tree
- */
- constructor(
- IVerifier _verifier,
- IHasher _hasher,
- uint256 _denomination,
- uint32 _merkleTreeHeight
- ) MerkleTreeWithHistory(_merkleTreeHeight, _hasher) {
- require(_denomination > 0, "denomination should be greater than 0");
- verifier = _verifier;
- denomination = _denomination;
- }
- /**
- @dev Deposit funds into the contract. The caller must send (for ETH) or approve (for ERC20) value equal to or `denomination` of this instance.
- @param _commitment the note commitment, which is PedersenHash(nullifier + secret)
- */
- function deposit(bytes32 _commitment) external payable nonReentrant {
- require(!commitments[_commitment], "The commitment has been submitted");
- uint32 insertedIndex = _insert(_commitment);
- commitments[_commitment] = true;
- _processDeposit();
- emit Deposit(_commitment, insertedIndex, block.timestamp);
- }
- /** @dev this function is defined in a child contract */
- function _processDeposit() internal virtual;
- /**
- @dev Withdraw a deposit from the contract. `proof` is a zkSNARK proof data, and input is an array of circuit public inputs
- `input` array consists of:
- - merkle root of all deposits in the contract
- - hash of unique deposit nullifier to prevent double spends
- - the recipient of funds
- - optional fee that goes to the transaction sender (usually a relay)
- */
- function withdraw(
- bytes calldata _proof,
- bytes32 _root,
- bytes32 _nullifierHash,
- address payable _recipient,
- address payable _relayer,
- uint256 _fee,
- uint256 _refund
- ) external payable nonReentrant {
- require(_fee <= denomination, "Fee exceeds transfer value");
- require(!nullifierHashes[_nullifierHash], "The note has been already spent");
- require(isKnownRoot(_root), "Cannot find your merkle root"); // Make sure to use a recent one
- require(
- verifier.verifyProof(
- _proof,
- [uint256(_root), uint256(_nullifierHash), uint256(_recipient), uint256(_relayer), _fee, _refund]
- ),
- "Invalid withdraw proof"
- );
- nullifierHashes[_nullifierHash] = true;
- _processWithdraw(_recipient, _relayer, _fee, _refund);
- emit Withdrawal(_recipient, _nullifierHash, _relayer, _fee);
- }
- /** @dev this function is defined in a child contract */
- function _processWithdraw(
- address payable _recipient,
- address payable _relayer,
- uint256 _fee,
- uint256 _refund
- ) internal virtual;
- /** @dev whether a note is already spent */
- function isSpent(bytes32 _nullifierHash) public view returns (bool) {
- return nullifierHashes[_nullifierHash];
- }
- /** @dev whether an array of notes is already spent */
- function isSpentArray(bytes32[] calldata _nullifierHashes) external view returns (bool[] memory spent) {
- spent = new bool[](_nullifierHashes.length);
- for (uint256 i = 0; i < _nullifierHashes.length; i++) {
- if (isSpent(_nullifierHashes[i])) {
- spent[i] = true;
- }
- }
- }
- }
|