tornado-cli/cli.js

1073 lines
38 KiB
JavaScript
Raw Normal View History

2020-05-22 12:37:21 +03:00
#!/usr/bin/env node
2020-05-21 22:29:33 +03:00
// Temporary demo client
// Works both in browser and node.js
require('dotenv').config()
const fs = require('fs')
const axios = require('axios')
const assert = require('assert')
const snarkjs = require('snarkjs')
const crypto = require('crypto')
const circomlib = require('circomlib')
const bigInt = snarkjs.bigInt
const merkleTree = require('./lib/MerkleTree')
const Web3 = require('web3')
const Web3HttpProvider = require('web3-providers-http');
2020-05-21 22:29:33 +03:00
const buildGroth16 = require('websnark/src/groth16')
const websnarkUtils = require('websnark/src/utils')
const { toWei, fromWei, toBN, BN } = require('web3-utils')
const config = require('./config')
const program = require('commander')
2020-12-24 14:39:20 +03:00
const { GasPriceOracle } = require('gas-price-oracle')
const SocksProxyAgent = require('socks-proxy-agent')
2020-05-21 22:29:33 +03:00
let web3, tornado, tornadoContract, tornadoInstance, circuit, proving_key, groth16, erc20, senderAccount, netId, netName, netSymbol
2020-05-21 22:29:33 +03:00
let MERKLE_TREE_HEIGHT, ETH_AMOUNT, TOKEN_AMOUNT, PRIVATE_KEY
/** Whether we are in a browser or node.js */
2021-02-14 21:23:17 +03:00
const inBrowser = typeof window !== 'undefined'
2020-05-21 22:29:33 +03:00
let isLocalRPC = false
/** Generate random number of specified byte length */
2021-02-14 21:23:17 +03:00
const rbigint = (nbytes) => snarkjs.bigInt.leBuff2int(crypto.randomBytes(nbytes))
2020-05-21 22:29:33 +03:00
/** Compute pedersen hash */
2021-02-14 21:23:17 +03:00
const pedersenHash = (data) => circomlib.babyJub.unpackPoint(circomlib.pedersenHash.hash(data))[0]
2020-05-21 22:29:33 +03:00
/** BigNumber to hex string of specified length */
function toHex(number, length = 32) {
2020-05-22 12:35:00 +03:00
const str = number instanceof Buffer ? number.toString('hex') : bigInt(number).toString(16)
return '0x' + str.padStart(length * 2, '0')
2020-05-21 22:29:33 +03:00
}
/** Display ETH account balance */
async function printETHBalance({ address, name, symbol }) {
console.log(`${name} balance is`, web3.utils.fromWei(await web3.eth.getBalance(address)),`${symbol}`)
2020-05-21 22:29:33 +03:00
}
/** Display ERC20 account balance */
async function printERC20Balance({ address, name, tokenAddress }) {
2020-05-22 12:35:00 +03:00
const erc20ContractJson = require('./build/contracts/ERC20Mock.json')
erc20 = tokenAddress ? new web3.eth.Contract(erc20ContractJson.abi, tokenAddress) : erc20
balance = await erc20.methods.balanceOf(address).call()
decimals = await erc20.methods.decimals().call()
console.log(`${name}`,(await erc20.methods.name().call()),`Token Balance is`,toDecimals(balance, decimals, (balance.length + decimals)).toString().replace(/\B(?<!\.\d*)(?=(\d{3})+(?!\d))/g, ","),(await erc20.methods.symbol().call()))
}
async function generateTransaction(to, encodedData, value = 0) {
const nonce = await web3.eth.getTransactionCount(senderAccount)
const gasPrice = await fetchGasPrice()
let gasLimit;
let tx = {}
async function estimateGas() {
const fetchedGas = await web3.eth.estimateGas({
from : senderAccount,
to : to,
value : value,
nonce : nonce,
data : encodedData
})
const bumped = Math.floor(fetchedGas * 1.3)
gasLimit = web3.utils.toHex(bumped)
}
await estimateGas();
async function txoptions() {
// Generate EIP-1559 transaction
if (netId == 1 || netId == 5) {
tx = {
to : to,
value : value,
nonce : nonce,
maxFeePerGas : gasPrice,
maxPriorityFeePerGas : web3.utils.toHex(web3.utils.toWei('3', 'gwei')),
gas : gasLimit,
data : encodedData
}
} else if (netId == 137 || netId == 43114) {
tx = {
to : to,
value : value,
nonce : nonce,
maxFeePerGas : gasPrice,
maxPriorityFeePerGas : gasPrice,
gas : gasLimit,
data : encodedData
}
} else {
tx = {
to : to,
value : value,
nonce : nonce,
gasPrice : gasPrice,
gas : gasLimit,
data : encodedData
}
}
}
await txoptions();
const signed = await web3.eth.accounts.signTransaction(tx, PRIVATE_KEY);
await web3.eth.sendSignedTransaction(signed.rawTransaction)
.on('transactionHash', function (txHash) {
console.log(`View transaction on block explorer https://${getExplorerLink()}/tx/${txHash}`)
})
.on('error', function (e) {
console.error('on transactionHash error', e.message)
});
2020-05-21 22:29:33 +03:00
}
/**
* Create deposit object from secret and nullifier
*/
function createDeposit({ nullifier, secret }) {
2020-05-22 12:35:00 +03:00
const deposit = { nullifier, secret }
deposit.preimage = Buffer.concat([deposit.nullifier.leInt2Buff(31), deposit.secret.leInt2Buff(31)])
deposit.commitment = pedersenHash(deposit.preimage)
deposit.commitmentHex = toHex(deposit.commitment)
deposit.nullifierHash = pedersenHash(deposit.nullifier.leInt2Buff(31))
deposit.nullifierHex = toHex(deposit.nullifierHash)
return deposit
2020-05-21 22:29:33 +03:00
}
async function backupNote({ currency, amount, netId, note, noteString }) {
try {
await fs.writeFileSync(`./backup-tornado-${currency}-${amount}-${netId}-${note.slice(0, 10)}.txt`, noteString, 'utf8');
2022-01-14 16:16:10 +03:00
console.log("Backed up deposit note as",`./backup-tornado-${currency}-${amount}-${netId}-${note.slice(0, 10)}.txt`)
} catch (e) {
throw new Error('Writing backup note failed:',e)
}
}
2020-05-21 22:29:33 +03:00
/**
* Make a deposit
* @param currency Сurrency
* @param amount Deposit amount
*/
async function deposit({ currency, amount }) {
assert(senderAccount != null, 'Error! PRIVATE_KEY not found. Please provide PRIVATE_KEY in .env file if you deposit')
2021-02-14 21:23:17 +03:00
const deposit = createDeposit({
nullifier: rbigint(31),
secret: rbigint(31)
})
2020-05-22 12:35:00 +03:00
const note = toHex(deposit.preimage, 62)
const noteString = `tornado-${currency}-${amount}-${netId}-${note}`
console.log(`Your note: ${noteString}`)
await backupNote({ currency, amount, netId, note, noteString })
if (currency === netSymbol.toLowerCase()) {
await printETHBalance({ address: tornadoContract._address, name: 'Tornado contract', symbol: currency.toUpperCase() })
await printETHBalance({ address: senderAccount, name: 'Sender account', symbol: currency.toUpperCase() })
2020-05-22 12:35:00 +03:00
const value = isLocalRPC ? ETH_AMOUNT : fromDecimals({ amount, decimals: 18 })
console.log('Submitting deposit transaction')
await generateTransaction(contractAddress, await tornado.methods.deposit(tornadoInstance, toHex(deposit.commitment), []).encodeABI(), value)
await printETHBalance({ address: tornadoContract._address, name: 'Tornado contract', symbol: currency.toUpperCase() })
await printETHBalance({ address: senderAccount, name: 'Sender account', symbol: currency.toUpperCase() })
2021-02-14 21:23:17 +03:00
} else {
// a token
await printERC20Balance({ address: tornadoContract._address, name: 'Tornado contract' })
2020-05-22 12:35:00 +03:00
await printERC20Balance({ address: senderAccount, name: 'Sender account' })
const decimals = isLocalRPC ? 18 : config.deployments[`netId${netId}`][currency].decimals
const tokenAmount = isLocalRPC ? TOKEN_AMOUNT : fromDecimals({ amount, decimals })
if (isLocalRPC) {
console.log('Minting some test tokens to deposit')
await generateTransaction(erc20Address, await erc20.methods.mint(senderAccount, tokenAmount).encodeABI())
2020-05-22 12:35:00 +03:00
}
2020-05-21 22:29:33 +03:00
2020-05-22 12:35:00 +03:00
const allowance = await erc20.methods.allowance(senderAccount, tornado._address).call({ from: senderAccount })
console.log('Current allowance is', fromWei(allowance))
if (toBN(allowance).lt(toBN(tokenAmount))) {
console.log('Approving tokens for deposit')
await generateTransaction(erc20Address, await erc20.methods.approve(tornado._address, tokenAmount).encodeABI())
2020-05-21 22:29:33 +03:00
}
2020-05-22 12:35:00 +03:00
console.log('Submitting deposit transaction')
await generateTransaction(contractAddress, await tornado.methods.deposit(toHex(deposit.commitment)).encodeABI())
await printERC20Balance({ address: tornadoContract._address, name: 'Tornado contract' })
2020-05-22 12:35:00 +03:00
await printERC20Balance({ address: senderAccount, name: 'Sender account' })
}
return noteString
2020-05-21 22:29:33 +03:00
}
/**
* Generate merkle tree for a deposit.
* Download deposit events from the tornado, reconstructs merkle tree, finds our deposit leaf
* in it and generates merkle proof
* @param deposit Deposit object
*/
async function generateMerkleProof(deposit, currency, amount) {
2020-12-24 14:39:20 +03:00
let leafIndex = -1
2020-05-22 12:35:00 +03:00
// Get all deposit events from smart contract and assemble merkle tree from them
2021-07-16 13:30:07 +03:00
const cachedEvents = await fetchEvents({ type: 'deposit', currency, amount })
2020-12-24 14:39:20 +03:00
const leaves = cachedEvents
2021-07-16 13:27:08 +03:00
.sort((a, b) => a.leafIndex - b.leafIndex) // Sort events in chronological order
2020-12-24 14:39:20 +03:00
.map((e) => {
2021-07-16 13:27:08 +03:00
const index = toBN(e.leafIndex).toNumber()
2020-05-22 12:35:00 +03:00
2021-07-16 13:27:08 +03:00
if (toBN(e.commitment).eq(toBN(deposit.commitmentHex))) {
2020-12-24 14:39:20 +03:00
leafIndex = index
}
2021-07-16 13:27:08 +03:00
return toBN(e.commitment).toString(10)
2020-12-24 14:39:20 +03:00
})
const tree = new merkleTree(MERKLE_TREE_HEIGHT, leaves)
2020-05-22 12:35:00 +03:00
// Validate that our data is correct
const root = await tree.root()
2021-07-17 00:54:20 +03:00
const isValidRoot = await tornadoContract.methods.isKnownRoot(toHex(root)).call()
const isSpent = await tornadoContract.methods.isSpent(toHex(deposit.nullifierHash)).call()
2020-05-22 12:35:00 +03:00
assert(isValidRoot === true, 'Merkle tree is corrupted')
assert(isSpent === false, 'The note is already spent')
assert(leafIndex >= 0, 'The deposit is not found in the tree')
// Compute merkle proof of our commitment
return tree.path(leafIndex)
2020-05-21 22:29:33 +03:00
}
/**
* Generate SNARK proof for withdrawal
* @param deposit Deposit object
* @param recipient Funds recipient
* @param relayer Relayer address
* @param fee Relayer fee
* @param refund Receive ether for exchanged tokens
*/
async function generateProof({ deposit, currency, amount, recipient, relayerAddress = 0, fee = 0, refund = 0 }) {
2020-05-22 12:35:00 +03:00
// Compute merkle proof of our commitment
const { root, path_elements, path_index } = await generateMerkleProof(deposit, currency, amount)
2020-05-22 12:35:00 +03:00
// Prepare circuit input
const input = {
// Public snark inputs
root: root,
nullifierHash: deposit.nullifierHash,
recipient: bigInt(recipient),
relayer: bigInt(relayerAddress),
fee: bigInt(fee),
refund: bigInt(refund),
// Private snark inputs
nullifier: deposit.nullifier,
secret: deposit.secret,
pathElements: path_elements,
2021-02-14 21:23:17 +03:00
pathIndices: path_index
2020-05-22 12:35:00 +03:00
}
console.log('Generating SNARK proof')
console.time('Proof time')
const proofData = await websnarkUtils.genWitnessAndProve(groth16, input, circuit, proving_key)
const { proof } = websnarkUtils.toSolidityInput(proofData)
console.timeEnd('Proof time')
const args = [
toHex(input.root),
toHex(input.nullifierHash),
toHex(input.recipient, 20),
toHex(input.relayer, 20),
toHex(input.fee),
toHex(input.refund)
]
return { proof, args }
2020-05-21 22:29:33 +03:00
}
/**
* Do an ETH withdrawal
* @param noteString Note to withdraw
* @param recipient Recipient address
*/
async function withdraw({ deposit, currency, amount, recipient, relayerURL, torPort, refund = '0' }) {
let options = {};
if (currency === netSymbol.toLowerCase() && refund !== '0') {
2020-05-22 12:35:00 +03:00
throw new Error('The ETH purchase is supposted to be 0 for ETH withdrawals')
}
refund = toWei(refund)
if (relayerURL) {
if (relayerURL.endsWith('.eth')) {
throw new Error('ENS name resolving is not supported. Please provide DNS name of the relayer. See instuctions in README.md')
2020-05-21 22:29:33 +03:00
}
if (torPort) {
options = { httpsAgent: new SocksProxyAgent('socks5h://127.0.0.1:'+torPort), headers: { 'User-Agent': 'Mozilla/5.0 (Windows NT 10.0; rv:91.0) Gecko/20100101 Firefox/91.0' } }
}
const relayerStatus = await axios.get(relayerURL + '/status', options)
2020-12-24 14:39:20 +03:00
const { rewardAccount, netId, ethPrices, tornadoServiceFee } = relayerStatus.data
2021-02-14 21:23:17 +03:00
assert(netId === (await web3.eth.net.getId()) || netId === '*', 'This relay is for different network')
console.log('Relay address:', rewardAccount)
2020-12-24 14:39:20 +03:00
const gasPrice = await fetchGasPrice()
2020-05-22 12:35:00 +03:00
const decimals = isLocalRPC ? 18 : config.deployments[`netId${netId}`][currency].decimals
2021-02-14 21:23:17 +03:00
const fee = calculateFee({
currency,
gasPrice,
amount,
refund,
ethPrices,
relayerServiceFee: tornadoServiceFee,
decimals
})
2020-05-22 12:35:00 +03:00
if (fee.gt(fromDecimals({ amount, decimals }))) {
throw new Error('Too high refund')
2020-05-21 22:29:33 +03:00
}
2020-12-24 14:39:20 +03:00
const { proof, args } = await generateProof({ deposit, currency, amount, recipient, relayerAddress: rewardAccount, fee, refund })
2020-05-21 22:29:33 +03:00
2020-05-22 12:35:00 +03:00
console.log('Sending withdraw transaction through relay')
try {
2021-02-14 21:23:17 +03:00
const response = await axios.post(relayerURL + '/v1/tornadoWithdraw', {
contract: tornadoInstance,
proof,
args
}, options)
2020-05-22 12:35:00 +03:00
2020-12-24 14:39:20 +03:00
const { id } = response.data
const result = await getStatus(id, relayerURL, options)
2020-12-24 14:39:20 +03:00
console.log('STATUS', result)
2020-05-22 12:35:00 +03:00
} catch (e) {
if (e.response) {
console.error(e.response.data.error)
} else {
console.error(e.message)
}
2020-05-21 22:29:33 +03:00
}
2021-02-14 21:23:17 +03:00
} else {
// using private key
// check if the address of recepient matches with the account of provided private key from environment to prevent accidental use of deposit address for withdrawal transaction.
const { address } = await web3.eth.accounts.privateKeyToAccount('0x' + PRIVATE_KEY)
assert(recipient.toLowerCase() == address.toLowerCase(), 'Withdrawal amount recepient mismatches with the account of provided private key from environment file')
const { proof, args } = await generateProof({ deposit, currency, amount, recipient, refund })
2020-05-22 12:35:00 +03:00
console.log('Submitting withdraw transaction')
await generateTransaction(contractAddress, await tornado.methods.withdraw(tornadoInstance, proof, ...args).encodeABI())
2020-05-22 12:35:00 +03:00
}
console.log('Done withdrawal from Tornado Cash')
2020-05-22 12:35:00 +03:00
}
2020-05-21 22:29:33 +03:00
function getStatus(id, relayerURL, options) {
2020-12-24 14:39:20 +03:00
return new Promise((resolve) => {
async function getRelayerStatus() {
const responseStatus = await axios.get(relayerURL + '/v1/jobs/' + id, options)
2020-12-24 14:39:20 +03:00
if (responseStatus.status === 200) {
const { txHash, status, confirmations, failedReason } = responseStatus.data
console.log(`Current job status ${status}, confirmations: ${confirmations}`)
if (status === 'FAILED') {
throw new Error(status + ' failed reason:' + failedReason)
}
if (status === 'CONFIRMED') {
const receipt = await waitForTxReceipt({ txHash })
2021-02-14 21:23:17 +03:00
console.log(
`Transaction submitted through the relay. View transaction on block explorer https://${getExplorerLink()}/tx/${txHash}`
2021-02-14 21:23:17 +03:00
)
2020-12-24 14:39:20 +03:00
console.log('Transaction mined in block', receipt.blockNumber)
resolve(status)
}
}
setTimeout(() => {
getRelayerStatus(id, relayerURL)
}, 3000)
}
getRelayerStatus()
})
}
function capitalizeFirstLetter(string) {
return string.charAt(0).toUpperCase() + string.slice(1);
}
2020-05-22 12:35:00 +03:00
function fromDecimals({ amount, decimals }) {
amount = amount.toString()
let ether = amount.toString()
const base = new BN('10').pow(new BN(decimals))
const baseLength = base.toString(10).length - 1 || 1
const negative = ether.substring(0, 1) === '-'
if (negative) {
ether = ether.substring(1)
}
if (ether === '.') {
throw new Error('[ethjs-unit] while converting number ' + amount + ' to wei, invalid value')
}
// Split it into a whole and fractional part
const comps = ether.split('.')
if (comps.length > 2) {
2021-02-14 21:23:17 +03:00
throw new Error('[ethjs-unit] while converting number ' + amount + ' to wei, too many decimal points')
2020-05-22 12:35:00 +03:00
}
let whole = comps[0]
let fraction = comps[1]
if (!whole) {
whole = '0'
}
if (!fraction) {
fraction = '0'
}
if (fraction.length > baseLength) {
2021-02-14 21:23:17 +03:00
throw new Error('[ethjs-unit] while converting number ' + amount + ' to wei, too many decimal places')
2020-05-22 12:35:00 +03:00
}
while (fraction.length < baseLength) {
fraction += '0'
}
whole = new BN(whole)
fraction = new BN(fraction)
let wei = whole.mul(base).add(fraction)
if (negative) {
wei = wei.mul(negative)
}
return new BN(wei.toString(10), 10)
2020-05-21 22:29:33 +03:00
}
function toDecimals(value, decimals, fixed) {
2020-05-22 12:35:00 +03:00
const zero = new BN(0)
const negative1 = new BN(-1)
decimals = decimals || 18
fixed = fixed || 7
value = new BN(value)
const negative = value.lt(zero)
const base = new BN('10').pow(new BN(decimals))
const baseLength = base.toString(10).length - 1 || 1
if (negative) {
value = value.mul(negative1)
}
let fraction = value.mod(base).toString(10)
while (fraction.length < baseLength) {
fraction = `0${fraction}`
}
fraction = fraction.match(/^([0-9]*[1-9]|0)(0*)/)[1]
const whole = value.div(base).toString(10)
value = `${whole}${fraction === '0' ? '' : `.${fraction}`}`
if (negative) {
value = `-${value}`
}
if (fixed) {
value = value.slice(0, fixed)
}
return value
2020-05-21 22:29:33 +03:00
}
// List fetched from https://github.com/ethereum-lists/chains/blob/master/_data/chains
function getExplorerLink() {
switch (netId) {
case 56:
return 'bscscan.com'
case 100:
return 'blockscout.com/poa/xdai'
case 137:
return 'polygonscan.com'
case 42161:
return 'arbiscan.io'
case 43114:
return 'snowtrace.io'
case 5:
return 'goerli.etherscan.io'
case 42:
return 'kovan.etherscan.io'
default:
return 'etherscan.io'
}
}
// List fetched from https://github.com/trustwallet/assets/tree/master/blockchains
2020-05-21 22:29:33 +03:00
function getCurrentNetworkName() {
2020-05-22 12:35:00 +03:00
switch (netId) {
2021-02-14 21:23:17 +03:00
case 1:
return 'Ethereum'
case 56:
return 'BinanceSmartChain'
case 100:
return 'xDai'
case 137:
return 'Polygon'
case 42161:
return 'Arbitrum'
case 43114:
return 'Avalanche'
2021-02-14 21:23:17 +03:00
case 5:
return 'Goerli'
2021-02-14 21:23:17 +03:00
case 42:
return 'Kovan'
default:
return 'localRPC'
2020-05-22 12:35:00 +03:00
}
2020-05-21 22:29:33 +03:00
}
function getCurrentNetworkSymbol() {
switch (netId) {
case 56:
return 'BNB'
case 100:
return 'xDAI'
case 137:
return 'MATIC'
case 43114:
return 'AVAX'
default:
return 'ETH'
}
}
function gasPricesETH(value = 80) {
2020-12-24 14:39:20 +03:00
const tenPercent = (Number(value) * 5) / 100
const max = Math.max(tenPercent, 3)
const bumped = Math.floor(Number(value) + max)
return toHex(toWei(bumped.toString(), 'gwei'))
}
function gasPrices(value = 5) {
return toHex(toWei(value.toString(), 'gwei'))
}
2020-12-24 14:39:20 +03:00
async function fetchGasPrice() {
try {
const options = {
chainId: netId
}
// Bump fees for Ethereum network
if (netId == 1) {
const oracle = new GasPriceOracle(options)
const gas = await oracle.gasPrices()
return gasPricesETH(gas.instant)
} else if (netId == 5 || isLocalRPC) {
return gasPrices(1)
} else {
const oracle = new GasPriceOracle(options)
const gas = await oracle.gasPrices()
return gasPrices(gas.instant)
}
2020-12-24 14:39:20 +03:00
} catch (err) {
throw new Error(`Method fetchGasPrice has error ${err.message}`)
}
}
function calculateFee({ currency, gasPrice, amount, refund, ethPrices, relayerServiceFee, decimals }) {
2021-02-14 21:23:17 +03:00
const decimalsPoint =
Math.floor(relayerServiceFee) === Number(relayerServiceFee) ? 0 : relayerServiceFee.toString().split('.')[1].length
2020-05-22 12:35:00 +03:00
const roundDecimal = 10 ** decimalsPoint
2020-05-22 12:37:21 +03:00
const total = toBN(fromDecimals({ amount, decimals }))
const feePercent = total.mul(toBN(relayerServiceFee * roundDecimal)).div(toBN(roundDecimal * 100))
2020-12-24 14:39:20 +03:00
const expense = toBN(gasPrice).mul(toBN(5e5))
2020-05-22 12:37:21 +03:00
let desiredFee
2020-05-22 12:35:00 +03:00
switch (currency) {
case netSymbol.toLowerCase(): {
desiredFee = expense.add(feePercent)
break
}
2021-02-14 21:23:17 +03:00
default: {
desiredFee = expense
.add(toBN(refund))
.mul(toBN(10 ** decimals))
.div(toBN(ethPrices[currency]))
desiredFee = desiredFee.add(feePercent)
break
}
2020-05-22 12:35:00 +03:00
}
2020-05-22 12:37:21 +03:00
return desiredFee
2020-05-21 22:29:33 +03:00
}
/**
* Waits for transaction to be mined
* @param txHash Hash of transaction
* @param attempts
* @param delay
*/
function waitForTxReceipt({ txHash, attempts = 60, delay = 1000 }) {
2020-05-22 12:35:00 +03:00
return new Promise((resolve, reject) => {
const checkForTx = async (txHash, retryAttempt = 0) => {
const result = await web3.eth.getTransactionReceipt(txHash)
if (!result || !result.blockNumber) {
if (retryAttempt <= attempts) {
setTimeout(() => checkForTx(txHash, retryAttempt + 1), delay)
} else {
reject(new Error('tx was not mined'))
2020-05-21 22:29:33 +03:00
}
2020-05-22 12:35:00 +03:00
} else {
resolve(result)
}
}
checkForTx(txHash)
})
2020-05-21 22:29:33 +03:00
}
function initJson(file) {
return new Promise((resolve, reject) => {
fs.readFile(file, 'utf8', (error, data) => {
if (error) {
reject(error);
}
try {
resolve(JSON.parse(data));
} catch (error) {
resolve([]);
}
});
});
};
function loadCachedEvents({ type, currency, amount }) {
2021-07-16 13:27:08 +03:00
try {
const module = require(`./cache/${netName.toLowerCase()}/${type}s_${currency}_${amount}.json`)
2021-07-16 13:27:08 +03:00
if (module) {
const events = module
return {
events,
lastBlock: events[events.length - 1].blockNumber
}
}
} catch (err) {
console.log("Error fetching cached files, syncing from block",deployedBlockNumber)
return {
events: [],
lastBlock: deployedBlockNumber,
}
2021-07-16 13:27:08 +03:00
}
}
async function fetchEvents({ type, currency, amount}) {
if (type === "withdraw") {
type = "withdrawal"
}
const cachedEvents = loadCachedEvents({ type, currency, amount })
const startBlock = cachedEvents.lastBlock + 1
console.log("Loaded cached",amount,currency.toUpperCase(),type,"events for",startBlock,"block")
console.log("Fetching",amount,currency.toUpperCase(),type,"events for",netName,"network")
async function syncEvents() {
try {
let targetBlock = await web3.eth.getBlockNumber();
let chunks = 1000;
for (let i=startBlock; i < targetBlock; i+=chunks) {
let fetchedEvents = [];
async function fetchLatestEvents(i) {
await tornadoContract.getPastEvents(capitalizeFirstLetter(type), {
fromBlock: i,
toBlock: i+chunks-1,
}).then(r => { fetchedEvents = fetchedEvents.concat(r); console.log("Fetched",amount,currency.toUpperCase(),type,"events to block:", i) }, err => { console.error(i + " failed fetching",type,"events from node", err); process.exit(1); }).catch(console.log);
}
async function mapDepositEvents() {
fetchedEvents = fetchedEvents.map(({ blockNumber, transactionHash, returnValues }) => {
const { commitment, leafIndex, timestamp } = returnValues
return {
blockNumber,
transactionHash,
commitment,
leafIndex: Number(leafIndex),
timestamp
}
})
}
async function mapWithdrawEvents() {
fetchedEvents = fetchedEvents.map(({ blockNumber, transactionHash, returnValues }) => {
const { nullifierHash, to, fee } = returnValues
return {
blockNumber,
transactionHash,
nullifierHash,
to,
fee
}
})
}
async function mapLatestEvents() {
if (type === "deposit"){
await mapDepositEvents();
} else {
await mapWithdrawEvents();
}
}
async function updateCache() {
try {
const fileName = `./cache/${netName.toLowerCase()}/${type}s_${currency}_${amount}.json`
const localEvents = await initJson(fileName);
const events = localEvents.concat(fetchedEvents);
await fs.writeFileSync(fileName, JSON.stringify(events, null, 2), 'utf8')
} catch (error) {
throw new Error('Writing cache file failed:',error)
}
}
await fetchLatestEvents(i);
await mapLatestEvents();
await updateCache();
}
} catch (error) {
throw new Error("Error while updating cache")
process.exit(1)
}
}
await syncEvents();
async function loadUpdatedEvents() {
const fileName = `./cache/${netName.toLowerCase()}/${type}s_${currency}_${amount}.json`
const updatedEvents = await initJson(fileName);
const updatedBlock = updatedEvents[updatedEvents.length - 1].blockNumber
console.log("Cache updated for Tornado",type,amount,currency,"instance to block",updatedBlock,"successfully")
console.log('Total events:', updatedEvents.length)
return updatedEvents;
}
const events = await loadUpdatedEvents();
return events
}
2020-05-21 22:29:33 +03:00
/**
* Parses Tornado.cash note
* @param noteString the note
*/
function parseNote(noteString) {
2020-05-22 12:35:00 +03:00
const noteRegex = /tornado-(?<currency>\w+)-(?<amount>[\d.]+)-(?<netId>\d+)-0x(?<note>[0-9a-fA-F]{124})/g
const match = noteRegex.exec(noteString)
if (!match) {
throw new Error('The note has invalid format')
}
const buf = Buffer.from(match.groups.note, 'hex')
const nullifier = bigInt.leBuff2int(buf.slice(0, 31))
const secret = bigInt.leBuff2int(buf.slice(31, 62))
const deposit = createDeposit({ nullifier, secret })
const netId = Number(match.groups.netId)
2021-02-14 21:23:17 +03:00
return {
currency: match.groups.currency,
amount: match.groups.amount,
netId,
deposit
}
2020-05-21 22:29:33 +03:00
}
async function loadDepositData({ amount, currency, deposit }) {
2020-05-22 12:35:00 +03:00
try {
const cachedEvents = await fetchEvents({ type: 'deposit', currency, amount })
const eventWhenHappened = await cachedEvents.filter(function (event) {
return event.commitment === deposit.commitmentHex;
})[0]
2020-05-22 12:35:00 +03:00
if (eventWhenHappened.length === 0) {
throw new Error('There is no related deposit, the note is invalid')
}
2020-05-21 22:29:33 +03:00
const timestamp = eventWhenHappened.timestamp
const txHash = eventWhenHappened.transactionHash
2021-07-17 00:54:20 +03:00
const isSpent = await tornadoContract.methods.isSpent(deposit.nullifierHex).call()
2020-05-22 12:35:00 +03:00
const receipt = await web3.eth.getTransactionReceipt(txHash)
2020-05-21 22:29:33 +03:00
2021-02-14 21:23:17 +03:00
return {
timestamp,
txHash,
isSpent,
from: receipt.from,
commitment: deposit.commitmentHex
}
2020-05-22 12:35:00 +03:00
} catch (e) {
console.error('loadDepositData', e)
}
return {}
2020-05-21 22:29:33 +03:00
}
async function loadWithdrawalData({ amount, currency, deposit }) {
2020-05-22 12:35:00 +03:00
try {
const cachedEvents = await fetchEvents({ type: 'withdrawal', currency, amount })
2021-07-16 13:27:08 +03:00
const withdrawEvent = cachedEvents.filter((event) => {
2021-07-16 13:27:08 +03:00
return event.nullifierHash === deposit.nullifierHex
2020-05-22 12:35:00 +03:00
})[0]
2021-07-16 13:27:08 +03:00
const fee = withdrawEvent.fee
2020-05-22 12:35:00 +03:00
const decimals = config.deployments[`netId${netId}`][currency].decimals
2021-02-14 21:23:17 +03:00
const withdrawalAmount = toBN(fromDecimals({ amount, decimals })).sub(toBN(fee))
2021-07-29 18:11:53 +03:00
const { timestamp } = await web3.eth.getBlock(withdrawEvent.blockNumber)
2020-05-22 12:35:00 +03:00
return {
amount: toDecimals(withdrawalAmount, decimals, 9),
txHash: withdrawEvent.transactionHash,
2021-07-16 13:27:08 +03:00
to: withdrawEvent.to,
2020-05-22 12:35:00 +03:00
timestamp,
nullifier: deposit.nullifierHex,
fee: toDecimals(fee, decimals, 9)
2020-05-21 22:29:33 +03:00
}
2020-05-22 12:35:00 +03:00
} catch (e) {
console.error('loadWithdrawalData', e)
}
2020-05-21 22:29:33 +03:00
}
/**
* Init web3, contracts, and snark
*/
async function init({ rpc, noteNetId, currency = 'dai', amount = '100', torPort, balanceCheck }) {
2021-07-17 00:54:20 +03:00
let contractJson, instanceJson, erc20ContractJson, erc20tornadoJson, tornadoAddress, tokenAddress
2020-05-22 12:35:00 +03:00
// TODO do we need this? should it work in browser really?
if (inBrowser) {
// Initialize using injected web3 (Metamask)
// To assemble web version run `npm run browserify`
2021-02-14 21:23:17 +03:00
web3 = new Web3(window.web3.currentProvider, null, {
transactionConfirmationBlocks: 1
})
2020-12-24 14:39:20 +03:00
contractJson = await (await fetch('build/contracts/TornadoProxy.abi.json')).json()
2021-07-17 00:54:20 +03:00
instanceJson = await (await fetch('build/contracts/Instance.abi.json')).json()
2020-12-24 14:39:20 +03:00
circuit = await (await fetch('build/circuits/tornado.json')).json()
proving_key = await (await fetch('build/circuits/tornadoProvingKey.bin')).arrayBuffer()
2020-05-22 12:35:00 +03:00
MERKLE_TREE_HEIGHT = 20
ETH_AMOUNT = 1e18
TOKEN_AMOUNT = 1e19
senderAccount = (await web3.eth.getAccounts())[0]
} else {
if (torPort) {
console.log("Using tor network")
web3Options = { agent: { https: new SocksProxyAgent('socks5h://127.0.0.1:'+torPort) }, timeout: 60000 }
// Use forked web3-providers-http from local file to modify user-agent header value which improves privacy.
web3 = new Web3(new Web3HttpProvider(rpc, web3Options), null, { transactionConfirmationBlocks: 1 })
} else if (rpc.includes("ipc")) {
console.log("Using ipc connection")
web3 = new Web3(new Web3.providers.IpcProvider(rpc, net), null, { transactionConfirmationBlocks: 1 })
} else if (rpc.includes("ws") || rpc.includes("wss")) {
console.log("Using websocket connection (Note: Tor is not supported for Websocket providers)")
web3Options = { clientConfig: { keepalive: true, keepaliveInterval: -1 }, reconnect: { auto: true, delay: 1000, maxAttempts: 10, onTimeout: false } }
web3 = new Web3(new Web3.providers.WebsocketProvider(rpc, web3Options), net, { transactionConfirmationBlocks: 1 })
} else {
console.log("Connecting to remote node")
web3 = new Web3(rpc, null, { transactionConfirmationBlocks: 1 })
}
2020-12-24 14:39:20 +03:00
contractJson = require('./build/contracts/TornadoProxy.abi.json')
2021-07-17 00:54:20 +03:00
instanceJson = require('./build/contracts/Instance.abi.json')
2020-12-24 14:39:20 +03:00
circuit = require('./build/circuits/tornado.json')
proving_key = fs.readFileSync('build/circuits/tornadoProvingKey.bin').buffer
2020-05-22 12:35:00 +03:00
MERKLE_TREE_HEIGHT = process.env.MERKLE_TREE_HEIGHT || 20
ETH_AMOUNT = process.env.ETH_AMOUNT
TOKEN_AMOUNT = process.env.TOKEN_AMOUNT
const privKey = process.env.PRIVATE_KEY
if (privKey.includes("0x")) {
PRIVATE_KEY = process.env.PRIVATE_KEY.substring(2)
} else {
PRIVATE_KEY = process.env.PRIVATE_KEY
}
2020-05-22 12:35:00 +03:00
if (PRIVATE_KEY) {
const account = web3.eth.accounts.privateKeyToAccount('0x' + PRIVATE_KEY)
web3.eth.accounts.wallet.add('0x' + PRIVATE_KEY)
web3.eth.defaultAccount = account.address
senderAccount = account.address
2020-05-21 22:29:33 +03:00
}
2020-05-22 12:35:00 +03:00
erc20ContractJson = require('./build/contracts/ERC20Mock.json')
erc20tornadoJson = require('./build/contracts/ERC20Tornado.json')
}
// groth16 initialises a lot of Promises that will never be resolved, that's why we need to use process.exit to terminate the CLI
groth16 = await buildGroth16()
netId = await web3.eth.net.getId()
netName = getCurrentNetworkName()
2020-05-22 12:35:00 +03:00
if (noteNetId && Number(noteNetId) !== netId) {
throw new Error('This note is for a different network. Specify the --rpc option explicitly')
}
if (netName === "localRPC") {
isLocalRPC = true;
}
2020-05-22 12:35:00 +03:00
if (isLocalRPC) {
tornadoAddress = currency === 'eth' ? contractJson.networks[netId].address : erc20tornadoJson.networks[netId].address
tokenAddress = currency !== 'eth' ? erc20ContractJson.networks[netId].address : null
netSymbol = getCurrentNetworkSymbol()
deployedBlockNumber = 0
2020-05-22 12:35:00 +03:00
senderAccount = (await web3.eth.getAccounts())[0]
} else {
try {
if (balanceCheck) {
netSymbol = getCurrentNetworkSymbol()
currency = netSymbol.toLowerCase()
amount = Object.keys(config.deployments[`netId${netId}`][currency].instanceAddress)[0]
}
2020-12-24 14:39:20 +03:00
tornadoAddress = config.deployments[`netId${netId}`].proxy
2021-07-17 00:54:20 +03:00
tornadoInstance = config.deployments[`netId${netId}`][currency].instanceAddress[amount]
deployedBlockNumber = config.deployments[`netId${netId}`][currency].deployedBlockNumber[amount]
2020-12-24 14:39:20 +03:00
2020-05-22 12:35:00 +03:00
if (!tornadoAddress) {
throw new Error()
}
tokenAddress = config.deployments[`netId${netId}`][currency].tokenAddress
} catch (e) {
console.error('There is no such tornado instance, check the currency and amount you provide', e)
2020-05-22 12:35:00 +03:00
process.exit(1)
2020-05-21 22:29:33 +03:00
}
2020-05-22 12:35:00 +03:00
}
netSymbol = getCurrentNetworkSymbol()
2020-12-24 14:39:20 +03:00
tornado = new web3.eth.Contract(contractJson, tornadoAddress)
2021-07-17 00:54:20 +03:00
tornadoContract = new web3.eth.Contract(instanceJson, tornadoInstance)
contractAddress = tornadoAddress
2020-05-22 12:35:00 +03:00
erc20 = currency !== 'eth' ? new web3.eth.Contract(erc20ContractJson.abi, tokenAddress) : {}
erc20Address = tokenAddress
2020-05-21 22:29:33 +03:00
}
async function main() {
2020-05-22 12:35:00 +03:00
if (inBrowser) {
const instance = { currency: 'eth', amount: '0.1' }
await init(instance)
window.deposit = async () => {
await deposit(instance)
}
window.withdraw = async () => {
const noteString = prompt('Enter the note to withdraw')
const recipient = (await web3.eth.getAccounts())[0]
2020-05-21 22:29:33 +03:00
2020-05-22 12:35:00 +03:00
const { currency, amount, netId, deposit } = parseNote(noteString)
await init({ noteNetId: netId, currency, amount })
await withdraw({ deposit, currency, amount, recipient })
}
} else {
program
.option('-r, --rpc <URL>', 'The RPC that CLI should interact with', 'http://localhost:8545')
2020-05-22 12:35:00 +03:00
.option('-R, --relayer <URL>', 'Withdraw via relayer')
.option('-T, --tor <PORT>', 'Optional tor port')
2020-05-22 12:35:00 +03:00
program
.command('deposit <currency> <amount>')
2021-02-14 21:23:17 +03:00
.description(
'Submit a deposit of specified currency and amount from default eth account and return the resulting note. The currency is one of (ETH|DAI|cDAI|USDC|cUSDC|USDT). The amount depends on currency, see config.js file or visit https://tornado.cash.'
)
2020-05-22 12:35:00 +03:00
.action(async (currency, amount) => {
currency = currency.toLowerCase()
await init({ rpc: program.rpc, currency, amount, torPort: program.tor })
2020-05-22 12:35:00 +03:00
await deposit({ currency, amount })
})
program
.command('withdraw <note> <recipient> [ETH_purchase]')
2021-02-14 21:23:17 +03:00
.description(
'Withdraw a note to a recipient account using relayer or specified private key. You can exchange some of your deposit`s tokens to ETH during the withdrawal by specifing ETH_purchase (e.g. 0.01) to pay for gas in future transactions. Also see the --relayer option.'
)
2020-05-22 12:35:00 +03:00
.action(async (noteString, recipient, refund) => {
const { currency, amount, netId, deposit } = parseNote(noteString)
await init({ rpc: program.rpc, noteNetId: netId, currency, amount, torPort: program.tor })
2021-02-14 21:23:17 +03:00
await withdraw({
deposit,
currency,
amount,
recipient,
refund,
relayerURL: program.relayer,
torPort: program.tor
2021-02-14 21:23:17 +03:00
})
2020-05-22 12:35:00 +03:00
})
program
.command('balance <address> [token_address]')
.description('Check ETH and ERC20 balance')
.action(async (address, tokenAddress) => {
await init({ rpc: program.rpc, torPort: program.tor, balanceCheck: true })
await printETHBalance({ address, name: 'Account', symbol: netSymbol })
2020-05-22 12:35:00 +03:00
if (tokenAddress) {
await printERC20Balance({ address, name: 'Account', tokenAddress })
2020-05-21 22:29:33 +03:00
}
2020-05-22 12:35:00 +03:00
})
program
.command('compliance <note>')
2021-02-14 21:23:17 +03:00
.description(
'Shows the deposit and withdrawal of the provided note. This might be necessary to show the origin of assets held in your withdrawal address.'
)
2020-05-22 12:35:00 +03:00
.action(async (noteString) => {
const { currency, amount, netId, deposit } = parseNote(noteString)
await init({ rpc: program.rpc, noteNetId: netId, currency, amount, torPort: program.tor })
const depositInfo = await loadDepositData({ amount, currency, deposit })
2020-05-22 12:35:00 +03:00
const depositDate = new Date(depositInfo.timestamp * 1000)
console.log('\n=============Deposit=================')
console.log('Deposit :', amount, currency.toUpperCase())
2020-05-22 12:35:00 +03:00
console.log('Date :', depositDate.toLocaleDateString(), depositDate.toLocaleTimeString())
console.log('From :', `https://${getExplorerLink()}/address/${depositInfo.from}`)
console.log('Transaction :', `https://${getExplorerLink()}/tx/${depositInfo.txHash}`)
2020-05-22 12:35:00 +03:00
console.log('Commitment :', depositInfo.commitment)
console.log('Spent :', depositInfo.isSpent)
if (!depositInfo.isSpent) {
2020-05-22 12:35:00 +03:00
console.log('The note was not spent')
2021-07-29 18:17:35 +03:00
return
2020-05-21 22:29:33 +03:00
}
console.log('=====================================','\n')
2020-05-22 12:35:00 +03:00
const withdrawInfo = await loadWithdrawalData({ amount, currency, deposit })
2020-05-22 12:35:00 +03:00
const withdrawalDate = new Date(withdrawInfo.timestamp * 1000)
console.log('\n=============Withdrawal==============')
console.log('Withdrawal :', withdrawInfo.amount, currency)
console.log('Relayer Fee :', withdrawInfo.fee, currency)
console.log('Date :', withdrawalDate.toLocaleDateString(), withdrawalDate.toLocaleTimeString())
console.log('To :', `https://${getExplorerLink()}/address/${withdrawInfo.to}`)
console.log('Transaction :', `https://${getExplorerLink()}/tx/${withdrawInfo.txHash}`)
2020-05-22 12:35:00 +03:00
console.log('Nullifier :', withdrawInfo.nullifier)
console.log('=====================================','\n')
})
program
.command('syncEvents <type> <currency> <amount>')
.description(
'Sync the local cache file of deposit / withdrawal events for specific currency.'
)
.action(async (type, currency, amount) => {
console.log("Starting event sync command")
currency = currency.toLowerCase()
await init({ rpc: program.rpc, type, currency, amount, torPort: program.tor })
const cachedEvents = await fetchEvents({ type, currency, amount })
console.log("Synced event for",type,amount,currency.toUpperCase(),netName,"Tornado instance to block",cachedEvents[cachedEvents.length - 1].blockNumber)
2020-05-22 12:35:00 +03:00
})
program
.command('test')
.description('Perform an automated test. It deposits and withdraws one ETH and one ERC20 note. Uses ganache.')
.action(async () => {
console.log('Start performing ETH deposit-withdraw test')
let currency = 'eth'
let amount = '0.1'
await init({ rpc: program.rpc, currency, amount })
let noteString = await deposit({ currency, amount })
let parsedNote = parseNote(noteString)
2021-02-14 21:23:17 +03:00
await withdraw({
deposit: parsedNote.deposit,
currency,
amount,
recipient: senderAccount,
relayerURL: program.relayer
})
2020-05-22 12:35:00 +03:00
console.log('\nStart performing DAI deposit-withdraw test')
currency = 'dai'
amount = '100'
await init({ rpc: program.rpc, currency, amount })
noteString = await deposit({ currency, amount })
2021-02-14 21:23:17 +03:00
parsedNote = parseNote(noteString)
await withdraw({
deposit: parsedNote.deposit,
currency,
amount,
recipient: senderAccount,
refund: '0.02',
relayerURL: program.relayer
})
2020-05-22 12:35:00 +03:00
})
try {
await program.parseAsync(process.argv)
process.exit(0)
} catch (e) {
console.log('Error:', e)
process.exit(1)
2020-05-21 22:29:33 +03:00
}
2020-05-22 12:35:00 +03:00
}
2020-05-21 22:29:33 +03:00
}
main()