tornadocash/tornado-cli
3
0
Fork 1
Code Issues Pull Requests 1 Packages Projects Releases Wiki Activity

Compare commits

base: tornadocash:f000d0af363c445bb04a43d00f05b97bc805e006
Branches Tags
tornadocash:master
tornadocash:proposal-29
tornadocash:proposal-27
tornadocash:archive
tornadocash:package
..
compare: tornadocash:b7929bd16ccff6a6514aa60a6aee303249b32d3f
Branches Tags
tornadocash:master
tornadocash:proposal-29
tornadocash:proposal-27
tornadocash:archive
tornadocash:package

No commits in common. "f000d0af363c445bb04a43d00f05b97bc805e006" and "b7929bd16ccff6a6514aa60a6aee303249b32d3f" have entirely different histories.
f000d0af36 ... b7929bd16c

2 changed files with 105 additions and 65 deletions
Show Stats Expand all files Collapse all files

121
README.md
View File

@ -1,6 +1,6 @@
# Tornado-CLI
Command line tool to interact with [Tornado Cash](https://tornado.ws).
Command line tool to interact with [Tornado Cash](https://tornadocashcommunity.eth.link).
### Warning!
Current cli version doesn't support [Anonymity Mining](https://tornado-cash.medium.com/tornado-cash-governance-proposal-a55c5c7d0703)
@ -19,10 +19,12 @@ You also need to install C++ build tools in order to do 'npm install', for more
If you have git installed on your system, clone the master branch.
```bash
$ git clone https://git.tornado.ws/tornadocash/tornado-cli
$ git clone https://development.tornadocash.community/tornadocash/tornado-cli
```
Or, download the archive file from git: https://git.tornado.ws/tornadocash/tornado-cli/archive/master.zip
Or, download the archive file from github
https://development.tornadocash.community/tornadocash/tornado-cli/archive/refs/heads/master.zip
After downloading or cloning the repository, you must install necessary libraries using the following command.
@ -36,23 +38,23 @@ If you want to use Tor connection to conceal ip address, install [Tor Browser](h
Note that you should reset your tor connection by restarting the browser every time when you deposit & withdraw otherwise you will have the same exit node used for connection.
### Goerli, Mainnet, Binance Smart Chain, Gnosis Chain, Polygon Network, Arbitrum, Avalanche
1. `node cli.js --help`
2. If you want to use secure, anonymous tor connection add `--tor <torPort>` behind the command.
3. Add `PRIVATE_KEY` to `.env` file (optional, only if you want to use it for many operations) - open `.env.example` file, add private key after `PRIVATE_KEY=` and rename file to `.env`.
1. Add `PRIVATE_KEY` to `.env` file
2. `node cli.js --help`
3. If you want to use secure, anonymous tor connection add `--tor <torPort>` behind the command.
#### To deposit:
```bash
$ node cli.js deposit <currency> <amount> --rpc <rpc url> --tor <torPort> --private-key <private key>
$ node cli.js deposit <currency> <amount> --rpc <rpc url> --tor <torPort>
```
Note that `--tor <torPort>` is optional, and use `--private-key <private key>` only if you didn't add it to `.env` file.
Note that `--tor <torPort>` is optional.
For RPC nodes please refer to the list of public RPC nodes below.
##### Example:
```bash
$ node cli.js deposit ETH 0.1 --rpc https://mainnet.chainnodes.org/d692ae63-0a7e-43e0-9da9-fe4f4cc6c607 --tor 9150
$ node cli.js deposit ETH 0.1 --rpc https://goerli.infura.io/v3/9aa3d95b3bc440fa88ea12eaa4456161 --tor 9150
Your note: tornado-eth-0.1-5-0xf73dd6833ccbcc046c44228c8e2aa312bf49e08389dadc7c65e6a73239867b7ef49c705c4db227e2fadd8489a494b6880bdcb6016047e019d1abec1c7652
Tornado ETH balance is 8.9
@ -65,19 +67,21 @@ Sender account ETH balance is 1004873.361652048361352542
#### To withdraw:
```bash
$ node cli.js withdraw <note> <recipient> --rpc <rpc url> --relayer <relayer url> --tor <torPort> --private-key <private key>
$ node cli.js withdraw <note> <recipient> --rpc <rpc url> --relayer <relayer url> --tor <torPort>
```
Note that `--relayer <relayer url>`, `--tor <torPort>` is optional, and use `--private-key <private key>` only if you withdraw without relayer.
Note that `--relayer <relayer url>`, `--tor <torPort>` is optional.
If you want to use Tornado Cash relayer for your first withdrawal to your new ethereum account, please refer to the list of relayers below.
If you don't need relayer while doing withdrawals, you must provide your withdrawal account's private key - either as parameter, or by adding it to `.env` file.
If you don't need relayer while doing withdrawals, you must apply your withdrawal account's private key to `.env` file.
Copy the `PRIVATE_KEY=` line of `.env.example` to `.env`, and add your private key behind the `=`.
##### Example:
```bash
$ node cli.js withdraw tornado-eth-0.1-5-0xf73dd6833ccbcc046c44228c8e2aa312bf49e08389dadc7c65e6a73239867b7ef49c705c4db227e2fadd8489a494b6880bdcb6016047e019d1abec1c7652 0x8589427373D6D84E98730D7795D8f6f8731FDA16 --rpc https://mainnet.chainnodes.org/d692ae63-0a7e-43e0-9da9-fe4f4cc6c607 --relayer https://goerli-relay.example.org --tor 9150
$ node cli.js withdraw tornado-eth-0.1-5-0xf73dd6833ccbcc046c44228c8e2aa312bf49e08389dadc7c65e6a73239867b7ef49c705c4db227e2fadd8489a494b6880bdcb6016047e019d1abec1c7652 0x8589427373D6D84E98730D7795D8f6f8731FDA16 --rpc https://goerli.infura.io/v3/9aa3d95b3bc440fa88ea12eaa4456161 --relayer https://goerli-frelay.duckdns.org --tor 9150
Relay address: 0x6A31736e7490AbE5D5676be059DFf064AB4aC754
Getting current state from tornado contract
@ -137,19 +141,42 @@ Tornado contract balance is xxx.x ETH
Sender account balance is x.xxxxxxx ETH
```
### List of rpc & relayers for withdrawal
#### To withdraw, you will need deposit note that matches with your deposit transaction.
```bash
$ node cli.js withdraw <note> <recipient>
```
##### Example:
```bash
$ node cli.js withdraw tornado-eth-0.1-5-0xf73dd6833ccbcc046c44228c8e2aa312bf49e08389dadc7c65e6a73239867b7ef49c705c4db227e2fadd8489a494b6880bdcb6016047e019d1abec1c7652 0x8589427373D6D84E98730D7795D8f6f8731FDA16 --rpc https://goerli.infura.io/v3/9aa3d95b3bc440fa88ea12eaa4456161 --relayer https://goerli-frelay.duckdns.org --tor 9150
Relay address: 0x6A31736e7490AbE5D5676be059DFf064AB4aC754
Getting current state from tornado contract
Generating SNARK proof
Proof time: 9117.051ms
Sending withdraw transaction through relay
Transaction submitted through the relay. View transaction on etherscan https://goerli.etherscan.io/tx/0xcb21ae8cad723818c6bc7273e83e00c8393fcdbe74802ce5d562acad691a2a7b
Transaction mined in block 17036120
Done
```
### List of public rpc & relayers for withdrawal
Infura API key fetched from https://rpc.info (Same one with Metamask)
```json
{
"netId1":{
"rpcUrls":{
"publicRpc1":{
"name":"1RPC",
"url":"https://1rpc.io/eth"
"name":"SecureRPC",
"url":"https://api.securerpc.com/v1"
},
"Chainnodes":{
"name": "Chainnodes",
"url": "https://mainnet.chainnodes.org/d692ae63-0a7e-43e0-9da9-fe4f4cc6c607"
"publicRpc2":{
"name":"CloudFlare",
"url":"https://cloudflare-eth.com"
}
},
"relayers": {
@ -249,7 +276,7 @@ Sender account balance is x.xxxxxxx ETH
"rpcUrls":{
"publicRpc1":{
"name":"BSC Public RPC 1",
"url":"https://1rpc.io/bnb"
"url":"https://bsc-dataseed.binance.org"
},
"publicRpc2":{
"name":"BSC Public RPC 2",
@ -338,7 +365,7 @@ Sender account balance is x.xxxxxxx ETH
"publicRpc":{
"name":"Gnosis Chain RPC",
"url":"https://rpc.gnosischain.com"
}
},
},
"relayers":{
"torndao.eth": {
@ -351,12 +378,20 @@ Sender account balance is x.xxxxxxx ETH
"netId137":{
"rpcUrls":{
"publicRpc1":{
"name":"1RPC",
"url":"https://1rpc.io/matic"
"name":"publicRpc1",
"url":"https://rpc-mainnet.maticvigil.com"
},
"Chainnodes":{
"name": "Chainnodes",
"url": "https://polygon-mainnet.chainnodes.org/d692ae63-0a7e-43e0-9da9-fe4f4cc6c607"
"publicRpc2":{
"name":"publicRpc2",
"url":"https://rpc-mainnet.matic.network"
},
"publicRpc3":{
"name":"publicRpc3",
"url":"https://matic-mainnet.chainstacklabs.com"
},
"MyEtherWallet":{
"name":"MyEtherWallet",
"url":"https://nodes.mewapi.io/ws/matic"
}
},
"relayers": {
@ -407,10 +442,6 @@ Sender account balance is x.xxxxxxx ETH
"publicRpc1":{
"name":"Arbitrum Public RPC",
"url":"https://arb1.arbitrum.io/rpc"
},
"publicRpc2":{
"name": "ChainnodesRPC",
"url": "https://arbitrum-one.chainnodes.org/d692ae63-0a7e-43e0-9da9-fe4f4cc6c607"
}
},
"relayers":{
@ -429,8 +460,8 @@ Sender account balance is x.xxxxxxx ETH
"netId43114":{
"rpcUrls":{
"publicRpc":{
"name":"1RPC",
"url":"https://1rpc.io/avax/c"
"name":"Avalanche RPC",
"url":"https://api.avax.network/ext/bc/C/rpc"
}
},
"relayers":{
@ -458,13 +489,9 @@ Sender account balance is x.xxxxxxx ETH
},
"netId10":{
"rpcUrls":{
"publicRpc1":{
"name":"1RPC",
"url":"https://1rpc.io/op"
},
"Chainnodes":{
"name": "Chainnodes",
"url": "https://optimism-mainnet.chainnodes.org/d692ae63-0a7e-43e0-9da9-fe4f4cc6c607"
"Optimism":{
"name":"Optimism Public RPC",
"url":"https://mainnet.optimism.io"
}
},
"relayers":{
@ -477,10 +504,18 @@ Sender account balance is x.xxxxxxx ETH
},
"netId5":{
"rpcUrls":{
"Chainnodes":{
"name":"Chainnodes RPC",
"url":"https://goerli.chainnodes.org/d692ae63-0a7e-43e0-9da9-fe4f4cc6c607"
}
"publicRpc1":{
"name":"Infura",
"url":"https://goerli.infura.io/v3/9aa3d95b3bc440fa88ea12eaa4456161"
},
"Slockit":{
"name":"Slockit",
"url":"https://rpc.slock.it/goerli"
},
"Prylabs":{
"name":"Prylabs",
"url":"https://goerli.prylabs.net"
},
},
"relayers":{}
}

49
cli.js
View File

@ -373,12 +373,25 @@ async function deposit({ currency, amount, commitmentNote }) {
* @param deposit Deposit object
*/
async function generateMerkleProof(deposit, currency, amount) {
let leafIndex = -1;
// Get all deposit events from smart contract and assemble merkle tree from them
const cachedEvents = await fetchEvents({ type: 'deposit', currency, amount });
const { tree, leaves, root } = computeDepositEventsTree(cachedEvents);
// Validate that merkle tree is valid, deposit data is correct and note not spent.
const leafIndex = leaves.findIndex((commitment) => toBN(deposit.commitmentHex).toString(10) === commitment);
const cachedEvents = await fetchEvents({ type: 'deposit', currency, amount });
const leaves = cachedEvents
.sort((a, b) => a.leafIndex - b.leafIndex) // Sort events in chronological order
.map((e) => {
const index = toBN(e.leafIndex).toNumber();
if (toBN(e.commitment).eq(toBN(deposit.commitmentHex))) {
leafIndex = index;
}
return toBN(e.commitment).toString(10);
});
const tree = new merkleTree(MERKLE_TREE_HEIGHT, leaves);
// Validate that our data is correct
const root = tree.root();
let isValidRoot, isSpent;
if (!isTestRPC && !multiCall) {
const callContract = await useMultiCall([
@ -1368,7 +1381,7 @@ async function promptConfirmation() {
/**
* Init web3, contracts, and snark
*/
async function init({ rpc, noteNetId, currency = 'dai', amount = '100', balanceCheck, localMode, privateKey }) {
async function init({ rpc, noteNetId, currency = 'dai', amount = '100', balanceCheck, localMode }) {
let contractJson, instanceJson, erc20ContractJson, erc20tornadoJson, tornadoAddress, tokenAddress;
let ipOptions = {};
@ -1428,13 +1441,13 @@ async function init({ rpc, noteNetId, currency = 'dai', amount = '100', balanceC
MERKLE_TREE_HEIGHT = process.env.MERKLE_TREE_HEIGHT || 20;
ETH_AMOUNT = process.env.ETH_AMOUNT;
TOKEN_AMOUNT = process.env.TOKEN_AMOUNT;
const privKey = privateKey || process.env.PRIVATE_KEY;
const privKey = process.env.PRIVATE_KEY;
if (privKey) {
if (privKey.startsWith('0x')) {
PRIVATE_KEY = privKey.substring(2);
if (privKey.includes('0x')) {
PRIVATE_KEY = process.env.PRIVATE_KEY.substring(2);
} else {
PRIVATE_KEY = privKey;
PRIVATE_KEY = process.env.PRIVATE_KEY;
}
}
if (PRIVATE_KEY) {
@ -1502,7 +1515,6 @@ async function main() {
.option('-r, --rpc <URL>', 'The RPC that CLI should interact with', 'http://localhost:8545')
.option('-R, --relayer <URL>', 'Withdraw via relayer')
.option('-T, --tor <PORT>', 'Optional tor port')
.option('-p, --private-key <KEY>', "Wallet private key - If you didn't add it to .env file and it is needed for operation")
.option('-S --gas_speed <SPEED>', 'Gas speed preference [ instant, fast, standard, low ]')
.option('-N --noconfirmation', 'No confirmation mode - Does not query confirmation ')
.option('-L, --local-rpc', 'Local node mode - Does not submit signed transaction to the node')
@ -1523,7 +1535,7 @@ async function main() {
statePreferences(program);
const { currency, amount, netId, commitmentNote } = parseInvoice(invoice);
await init({ rpc: program.rpc, currency, amount, localMode: program.local, privateKey: program.privateKey });
await init({ rpc: program.rpc, currency, amount, localMode: program.local });
console.log('Creating', currency.toUpperCase(), amount, 'deposit for', netName, 'Tornado Cash Instance');
await deposit({ currency, amount, commitmentNote });
});
@ -1537,7 +1549,7 @@ async function main() {
statePreferences(program);
await init({ rpc: program.rpc, currency, amount, localMode: program.local, privateKey: program.privateKey });
await init({ rpc: program.rpc, currency, amount, localMode: program.local });
await deposit({ currency, amount });
});
program
@ -1550,14 +1562,7 @@ async function main() {
const { currency, amount, netId, deposit } = parseNote(noteString);
await init({
rpc: program.rpc,
noteNetId: netId,
currency,
amount,
localMode: program.local,
privateKey: program.privateKey
});
await init({ rpc: program.rpc, noteNetId: netId, currency, amount, localMode: program.local });
await withdraw({
deposit,
currency,
@ -1589,7 +1594,7 @@ async function main() {
.action(async (address, amount, tokenAddress) => {
statePreferences(program);
await init({ rpc: program.rpc, balanceCheck: true, localMode: program.local, privateKey: program.privateKey });
await init({ rpc: program.rpc, balanceCheck: true, localMode: program.local });
await send({ address, amount, tokenAddress });
});
program
@ -1701,7 +1706,7 @@ async function main() {
console.log('Start performing ETH deposit-withdraw test');
let currency = 'eth';
let amount = '0.1';
await init({ rpc: program.rpc, currency, amount, privateKey: program.privateKey });
await init({ rpc: program.rpc, currency, amount });
let noteString = await deposit({ currency, amount });
let parsedNote = parseNote(noteString);
await withdraw({