tornado-core/contracts/Mixer.sol

140 lines
5.7 KiB
Solidity
Raw Normal View History

2019-08-02 19:12:30 +02:00
// 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
*/
2019-07-09 15:05:30 +02:00
pragma solidity ^0.5.8;
import "./MerkleTreeWithHistory.sol";
contract IVerifier {
function verifyProof(uint256[8] memory _proof, uint256[6] memory _input) public returns(bool);
2019-07-09 15:05:30 +02:00
}
contract Mixer is MerkleTreeWithHistory {
2019-10-04 16:27:47 +02:00
uint256 public denomination;
2019-07-25 15:58:21 +02:00
mapping(uint256 => bool) public nullifierHashes;
2019-07-15 17:04:48 +02:00
// we store all commitments just to prevent accidental deposits with the same commitment
mapping(uint256 => bool) public commitments;
2019-08-04 19:57:01 +02:00
IVerifier public verifier;
2019-10-04 16:27:47 +02:00
// operator can
// - disable new deposits in case of emergency
// - update snark verification key until this ability is permanently disabled
2019-11-01 01:56:24 +01:00
address public operator;
bool public isDepositsDisabled;
bool public isVerifierUpdateDisabled;
2019-10-04 16:27:47 +02:00
modifier onlyOperator {
require(msg.sender == operator, "Only operator can call this function.");
_;
}
2019-07-09 15:05:30 +02:00
2019-07-22 22:37:02 +02:00
event Deposit(uint256 indexed commitment, uint256 leafIndex, uint256 timestamp);
2019-11-01 02:12:32 +01:00
event Withdrawal(address to, uint256 nullifierHash, address indexed relayer, uint256 fee);
2019-07-09 15:05:30 +02:00
2019-07-10 14:35:46 +02:00
/**
@dev The constructor
@param _verifier the address of SNARK verifier for this contract
2019-11-04 20:45:56 +01:00
@param _denomination transfer amount for each deposit
2019-08-27 22:42:24 +02:00
@param _merkleTreeHeight the height of deposits' Merkle Tree
2019-11-04 20:45:56 +01:00
@param _operator operator address (see operator comment above)
2019-07-10 14:35:46 +02:00
*/
2019-07-12 17:04:45 +02:00
constructor(
2019-11-01 02:14:01 +01:00
IVerifier _verifier,
2019-10-04 16:27:47 +02:00
uint256 _denomination,
2019-07-12 17:04:45 +02:00
uint8 _merkleTreeHeight,
2019-11-01 01:56:24 +01:00
address _operator
2019-11-02 13:35:22 +01:00
) MerkleTreeWithHistory(_merkleTreeHeight) public {
2019-11-01 02:15:55 +01:00
require(_denomination > 0, "denomination should be greater than 0");
2019-11-01 02:14:01 +01:00
verifier = _verifier;
2019-08-02 19:12:30 +02:00
operator = _operator;
2019-10-04 16:27:47 +02:00
denomination = _denomination;
2019-07-09 15:05:30 +02:00
}
2019-10-04 16:27:47 +02:00
2019-09-06 23:22:30 +02:00
/**
2019-10-04 16:27:47 +02:00
@dev Deposit funds into mixer. The caller must send (for ETH) or approve (for ERC20) value equal to or `denomination` of this mixer.
@param _commitment the note commitment, which is PedersenHash(nullifier + secret)
2019-09-06 23:22:30 +02:00
*/
function deposit(uint256 _commitment) public payable {
require(!isDepositsDisabled, "deposits are disabled");
require(!commitments[_commitment], "The commitment has been submitted");
uint256 insertedIndex = _insert(_commitment);
commitments[_commitment] = true;
_processDeposit();
2019-07-09 15:05:30 +02:00
emit Deposit(_commitment, insertedIndex, block.timestamp);
2019-09-06 23:22:30 +02:00
}
2019-10-04 16:27:47 +02:00
/** @dev this function is defined in a child contract */
2019-11-01 02:17:00 +01:00
function _processDeposit() internal;
2019-10-04 16:27:47 +02:00
2019-09-06 23:22:30 +02:00
/**
2019-11-04 20:45:56 +01:00
@dev Withdraw a deposit from the mixer. `proof` is a zkSNARK proof data, and input is an array of circuit public inputs
2019-09-06 23:22:30 +02:00
`input` array consists of:
- merkle root of all deposits in the mixer
- hash of unique deposit nullifier to prevent double spends
- the receiver of funds
- optional fee that goes to the transaction sender (usually a relay)
*/
function withdraw(uint256[8] memory _proof, uint256[6] memory _input) public payable {
uint256 root = _input[0];
uint256 nullifierHash = _input[1];
address payable receiver = address(_input[2]);
address payable relayer = address(_input[3]);
uint256 fee = _input[4];
uint256 refund = _input[5];
2019-11-01 01:54:29 +01:00
require(fee <= denomination, "Fee exceeds transfer value");
2019-07-25 15:58:21 +02:00
require(!nullifierHashes[nullifierHash], "The note has been already spent");
2019-08-20 22:39:21 +02:00
2019-07-09 15:05:30 +02:00
require(isKnownRoot(root), "Cannot find your merkle root"); // Make sure to use a recent one
require(verifier.verifyProof(_proof, _input), "Invalid withdraw proof");
2019-07-25 15:58:21 +02:00
nullifierHashes[nullifierHash] = true;
_processWithdraw(receiver, relayer, fee, refund);
2019-11-01 02:12:32 +01:00
emit Withdrawal(receiver, nullifierHash, relayer, fee);
2019-07-09 15:05:30 +02:00
}
2019-07-15 18:15:06 +02:00
2019-10-04 16:27:47 +02:00
/** @dev this function is defined in a child contract */
2019-11-01 02:17:00 +01:00
function _processWithdraw(address payable _receiver, address payable _relayer, uint256 _fee, uint256 _refund) internal;
2019-10-04 16:27:47 +02:00
/** @dev whether a note is already spent */
function isSpent(uint256 _nullifierHash) public view returns(bool) {
return nullifierHashes[_nullifierHash];
2019-10-04 16:27:47 +02:00
}
/**
@dev Allow operator to temporarily disable new deposits. This is needed to protect users funds in case a vulnerability is discovered.
It does not affect existing deposits.
*/
function toggleDeposits(bool _state) external onlyOperator {
isDepositsDisabled = _state;
2019-08-01 10:41:22 +02:00
}
2019-10-04 16:27:47 +02:00
/**
@dev allow operator to update SNARK verification keys. This is needed to update keys after the final trusted setup ceremony is held.
After that operator is supposed to permanently disable this ability.
*/
function updateVerifier(address _newVerifier) external onlyOperator {
require(!isVerifierUpdateDisabled, "Verifier updates have been disabled.");
verifier = IVerifier(_newVerifier);
}
2019-10-04 16:27:47 +02:00
/**
@dev an option for operator to permanently disable verification keys update ability.
This is supposed to be called after the final trusted setup ceremony is held.
*/
function disableVerifierUpdate() external onlyOperator {
isVerifierUpdateDisabled = true;
}
2019-10-04 16:27:47 +02:00
/** @dev operator can change his address */
2019-11-01 02:28:46 +01:00
function changeOperator(address _newOperator) external onlyOperator {
operator = _newOperator;
2019-08-01 18:58:34 +02:00
}
2019-07-10 18:58:21 +02:00
}