tornadocontrib/tornado-cli
1
0
Fork 0
forked from tornadocash/tornado-cli
Code Issues Pull Requests Actions Packages Projects Releases 1 Activity

Remove deprecated info about Anonymity Mining (ended in 2021)

Browse Source
This commit is contained in:
Theo 2023-09-07 14:29:17 -07:00
parent 4231f5ab09
commit 5ad9b5ef05
1 changed files with 337 additions and 336 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

119
README.md
View File

@ -2,10 +2,8 @@
Command line tool to interact with [Tornado Cash](https://tornado.ws). Command line tool to interact with [Tornado Cash](https://tornado.ws).
### Warning!
Current cli version doesn't support [Anonymity Mining](https://tornado-cash.medium.com/tornado-cash-governance-proposal-a55c5c7d0703)
### How to install tornado cli ### How to install tornado cli
Download and install [node.js](https://nodejs.org/en/download/). Download and install [node.js](https://nodejs.org/en/download/).
You also need to install C++ build tools in order to do 'npm install', for more information please checkout https://github.com/nodejs/node-gyp#on-unix. You also need to install C++ build tools in order to do 'npm install', for more information please checkout https://github.com/nodejs/node-gyp#on-unix.
@ -36,6 +34,7 @@ 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. 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 ### Goerli, Mainnet, Binance Smart Chain, Gnosis Chain, Polygon Network, Arbitrum, Avalanche
1. `node cli.js --help` 1. `node cli.js --help`
2. If you want to use secure, anonymous tor connection add `--tor <torPort>` behind the command. 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`. 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`.
@ -51,6 +50,7 @@ Note that `--tor <torPort>` is optional, and use `--private-key <private key>` o
For RPC nodes please refer to the list of public RPC nodes below. For RPC nodes please refer to the list of public RPC nodes below.
##### Example: ##### Example:
```bash ```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://mainnet.chainnodes.org/d692ae63-0a7e-43e0-9da9-fe4f4cc6c607 --tor 9150
@ -91,6 +91,7 @@ Done
``` ```
### (Optional) Creating Deposit Notes & Invoices offline ### (Optional) Creating Deposit Notes & Invoices offline
One of the main features of tornado-cli is that it supports creating deposit notes & invoices inside the offline computing environment. One of the main features of tornado-cli is that it supports creating deposit notes & invoices inside the offline computing environment.
After the private-key like notes are backed up somewhere safe, you can copy the created deposit invoices and use them to create new deposit transaction on online environment. After the private-key like notes are backed up somewhere safe, you can copy the created deposit invoices and use them to create new deposit transaction on online environment.
@ -144,13 +145,13 @@ Sender account balance is x.xxxxxxx ETH
```json ```json
{ {
"netId1":{ "netId1": {
"rpcUrls":{ "rpcUrls": {
"publicRpc1":{ "publicRpc1": {
"name":"1RPC", "name": "1RPC",
"url":"https://1rpc.io/eth" "url": "https://1rpc.io/eth"
}, },
"Chainnodes":{ "Chainnodes": {
"name": "Chainnodes", "name": "Chainnodes",
"url": "https://mainnet.chainnodes.org/d692ae63-0a7e-43e0-9da9-fe4f4cc6c607" "url": "https://mainnet.chainnodes.org/d692ae63-0a7e-43e0-9da9-fe4f4cc6c607"
} }
@ -248,20 +249,20 @@ Sender account balance is x.xxxxxxx ETH
} }
} }
}, },
"netId56":{ "netId56": {
"rpcUrls":{ "rpcUrls": {
"publicRpc1":{ "publicRpc1": {
"name":"BSC Public RPC 1", "name": "BSC Public RPC 1",
"url":"https://1rpc.io/bnb" "url": "https://1rpc.io/bnb"
}, },
"publicRpc2":{ "publicRpc2": {
"name":"BSC Public RPC 2", "name": "BSC Public RPC 2",
"url":"https://bsc-dataseed1.defibit.io" "url": "https://bsc-dataseed1.defibit.io"
},
"publicRpc3":{
"name":"BSC Public RPC 3",
"url":"https://bsc-dataseed1.ninicoin.io"
}, },
"publicRpc3": {
"name": "BSC Public RPC 3",
"url": "https://bsc-dataseed1.ninicoin.io"
}
}, },
"relayers": { "relayers": {
"0xproxy.eth": { "0xproxy.eth": {
@ -336,14 +337,14 @@ Sender account balance is x.xxxxxxx ETH
} }
} }
}, },
"netId100":{ "netId100": {
"rpcUrls":{ "rpcUrls": {
"publicRpc":{ "publicRpc": {
"name":"Gnosis Chain RPC", "name": "Gnosis Chain RPC",
"url":"https://rpc.gnosischain.com" "url": "https://rpc.gnosischain.com"
} }
}, },
"relayers":{ "relayers": {
"torndao.eth": { "torndao.eth": {
"url": "torndao.eth", "url": "torndao.eth",
"name": "torndao.eth", "name": "torndao.eth",
@ -351,13 +352,13 @@ Sender account balance is x.xxxxxxx ETH
} }
} }
}, },
"netId137":{ "netId137": {
"rpcUrls":{ "rpcUrls": {
"publicRpc1":{ "publicRpc1": {
"name":"1RPC", "name": "1RPC",
"url":"https://1rpc.io/matic" "url": "https://1rpc.io/matic"
}, },
"Chainnodes":{ "Chainnodes": {
"name": "Chainnodes", "name": "Chainnodes",
"url": "https://polygon-mainnet.chainnodes.org/d692ae63-0a7e-43e0-9da9-fe4f4cc6c607" "url": "https://polygon-mainnet.chainnodes.org/d692ae63-0a7e-43e0-9da9-fe4f4cc6c607"
} }
@ -405,18 +406,18 @@ Sender account balance is x.xxxxxxx ETH
} }
} }
}, },
"netId42161":{ "netId42161": {
"rpcUrls":{ "rpcUrls": {
"publicRpc1":{ "publicRpc1": {
"name":"Arbitrum Public RPC", "name": "Arbitrum Public RPC",
"url":"https://arb1.arbitrum.io/rpc" "url": "https://arb1.arbitrum.io/rpc"
}, },
"publicRpc2":{ "publicRpc2": {
"name": "ChainnodesRPC", "name": "ChainnodesRPC",
"url": "https://arbitrum-one.chainnodes.org/d692ae63-0a7e-43e0-9da9-fe4f4cc6c607" "url": "https://arbitrum-one.chainnodes.org/d692ae63-0a7e-43e0-9da9-fe4f4cc6c607"
} }
}, },
"relayers":{ "relayers": {
"tornado-crypto-bot-exchange.eth": { "tornado-crypto-bot-exchange.eth": {
"url": "tornado-crypto-bot-exchange.eth", "url": "tornado-crypto-bot-exchange.eth",
"name": "tornado-crypto-bot-exchange.eth", "name": "tornado-crypto-bot-exchange.eth",
@ -429,14 +430,14 @@ Sender account balance is x.xxxxxxx ETH
} }
} }
}, },
"netId43114":{ "netId43114": {
"rpcUrls":{ "rpcUrls": {
"publicRpc":{ "publicRpc": {
"name":"1RPC", "name": "1RPC",
"url":"https://1rpc.io/avax/c" "url": "https://1rpc.io/avax/c"
} }
}, },
"relayers":{ "relayers": {
"cheap-relayer.eth": { "cheap-relayer.eth": {
"url": "cheap-relayer.eth", "url": "cheap-relayer.eth",
"name": "cheap-relayer.eth", "name": "cheap-relayer.eth",
@ -459,18 +460,18 @@ Sender account balance is x.xxxxxxx ETH
} }
} }
}, },
"netId10":{ "netId10": {
"rpcUrls":{ "rpcUrls": {
"publicRpc1":{ "publicRpc1": {
"name":"1RPC", "name": "1RPC",
"url":"https://1rpc.io/op" "url": "https://1rpc.io/op"
}, },
"Chainnodes":{ "Chainnodes": {
"name": "Chainnodes", "name": "Chainnodes",
"url": "https://optimism-mainnet.chainnodes.org/d692ae63-0a7e-43e0-9da9-fe4f4cc6c607" "url": "https://optimism-mainnet.chainnodes.org/d692ae63-0a7e-43e0-9da9-fe4f4cc6c607"
} }
}, },
"relayers":{ "relayers": {
"tornado-crypto-bot-exchange.eth": { "tornado-crypto-bot-exchange.eth": {
"url": "tornado-crypto-bot-exchange.eth", "url": "tornado-crypto-bot-exchange.eth",
"name": "tornado-crypto-bot-exchange.eth", "name": "tornado-crypto-bot-exchange.eth",
@ -478,14 +479,14 @@ Sender account balance is x.xxxxxxx ETH
} }
} }
}, },
"netId5":{ "netId5": {
"rpcUrls":{ "rpcUrls": {
"Chainnodes":{ "Chainnodes": {
"name":"Chainnodes RPC", "name": "Chainnodes RPC",
"url":"https://goerli.chainnodes.org/d692ae63-0a7e-43e0-9da9-fe4f4cc6c607" "url": "https://goerli.chainnodes.org/d692ae63-0a7e-43e0-9da9-fe4f4cc6c607"
} }
}, },
"relayers":{} "relayers": {}
} }
} }
``` ```