tornadocash/tornado-relayer
2
0
Fork 0
Code Issues 3 Pull Requests Packages Projects Releases Wiki Activity
ff05e30bd2
tornado-relayer/README.md
gozzy 1e8ddffdf1 update README.md
2023-03-19 21:13:12 +00:00

7.7 KiB
Raw Blame History

Relayer for Tornado Cash Build Status Docker Image Version (latest semver)

*Tornado Cash was sanctioned by the US Treasury on 08/08/2022, this makes it illegal for US citizens to interact with Tornado Cash and all of it's associated deloyed smart contracts. Please understand the laws where you live and take all necessary steps to protect and anonomize yourself.

*It is recommended to run your Relayer on a VPS instnace (Virtual Private Server). Ensure SSH configuration is enabled for security, you can find information about SSH keygen and management here.

Deploy with docker-compose (recommended)

The following instructions are for Ubuntu 22.10, other operating systems may vary. These instructions include automated SSL configuration with LetsEncrypt.

PREREQUISITES

  1. Update core dependencies
  • sudo apt-get update to make sure everything is up to date
  1. Install docker-compose
  • curl -SL https://github.com/docker/compose/releases/download/v2.16.0/docker-compose-linux-x86_64 -o /usr/local/bin/docker-compose
  • Set read and write permissions for the executable sudo chmod +x /usr/local/bin/docker-compose
  1. Install Docker
  • curl -fsSL https://get.docker.com -o get-docker.sh
  • Set read and write permissions for the executable chmod +x get-docker.sh
  • Execute the install script ./get-docker.sh
  1. Install git
  • sudo apt-get install git-all
  1. Install nginx
  • sudo apt install nginx

FIREWALL CONFIGURATION

* Warning: Failure to configure SSH as the first UFW rule, will lock you out of the instance

  1. Make sure UFW is installed by running apt update and apt install ufw
  2. Allow SSH in the first position in UFW by running ufw insert 1 allow ssh*
  3. Allow HTTP, and HTTPS by running ufw allow https/tcp/http
  4. Finalise changes and enable firewall ufw enable

NETWORK DEPLOYMENT OPTIONS

Ethereum (eth), Binance (bnb), Gnosis (xdai), Polygon (matic), Optimisim (op), Arbitrum (arb) and Goerli (geth)

BASIC DEPLOYMENT

  1. Clone the repository and enter the directory
  • git clone https://development.tornadocash.community/tornadocash/classic-relayer && cd classic-relayer
  1. Clone the example enviroment file .env.example
  • By default each network is preconfigured the naming of .env.<NETWORK SYMBOL>
  • cp .env.example .env.eth
  1. Change environment variables in the cloned file to match the perferred network configuration
  • Set PRIVATE_KEY for your relayer address (remove the 0x from your private key)
  • Set VIRTUAL_HOST and LETSENCRYPT_HOST to your domain address
    • add a A record DNS record with the value assigned to your instance IP address to configure the domain
  • Set RELAYER_FEE to what you would like to charge as your fee (remember 0.3% is deducted from your staked relayer balance)
  • Set RPC_URL to a non-censoring RPC endpoint
  • Set ORACLE_RPC_URL to an Ethereum native RPC endpoint
  1. Build and deploy the docker source by specifying the network through --profile <NETWORK_SYMBOL>
  • docker-compose --profile eth up -d
  1. Visit your domain address and check the /status endpoint and ensure there is no errors in the status field

NGINX REVERSE PROXY

  1. Copy the pre-modified nginx policy as your default policy
  • cp tornado.conf /etc/nginx/sites-available/default
  1. Append the default nginx configuraiton to include streams
  • echo "stream { map_hash_bucket_size 128; map_hash_max_size 128; include /etc/nginx/conf.d/streams/*.conf; }" >> /etc/nginx/nginx.conf
  1. Create the stream configruation
  • mkdir /etc/nginx/conf.d/streams && cp tornado-stream.conf /etc/nginx/conf.d/streams/tornado-stream.conf
  1. Start nginx to make sure the configuration is correct
  • sudo service nginx restart
  1. Stop nginx
  • sudo service nginx stop

MULTIPLE NETWORK DEPLOYMENT

  1. Setup the instructions stated to setup an nginx reverse proxy
  2. Clone the example enviroment file .env.example for the networks of choice
  • By default each network is preconfigured the naming of .env.<NETWORK SYMBOL>
  • cp .env.example .env.eth
  • cp .env.example .env.bnb
  • cp .env.example .env.arb
  • cp .env.example .env.op
  • cp .env.example .env.xdai
  • Add PRIVATE_KEY for your relayer address (remove the 0x from your private key) to each enviroment file
    • It is recommended not to reuse the same private keys for each network as a security measure
  • Set VIRTUAL_HOST and LETSENCRYPT_HOST to uniquely allocated submdomains for each enviroment file
    • add a A wildcard record DNS record with the value assigned to your instance IP address to configure submdomains
    • eg: mainnet.example.com for Ethereum, binance.example.com for Binance etc
  • Set RELAYER_FEE to what you would like to charge as your fee (remember 0.3% is deducted from your staked relayer balance)
  • Set RPC_URL to a non-censoring RPC (You can run your own, or use a free option)
  • Set ORACLE_RPC_URL to an Ethereum native RPC endpoint
  1. Build and deploy the docker source for the configured neworks specified via --profile <NETWORK_SYMBOL>
  • docker-compose --profile eth --profile bnb --profile arb --profile --profile op -profile xdai up -d
  1. Visit your domain addresses and check each /status endpoint to ensure there is no errors in the status fields

Run locally

  1. npm i
  2. cp .env.example .env
  3. Modify .env as needed
  4. npm run start
  5. Go to http://127.0.0.1:8000
  6. In order to execute withdraw request, you can run following command
curl -X POST -H 'content-type:application/json' --data '<input data>' http://127.0.0.1:8000/relay

Relayer should return a transaction hash.

Note. If you want to change contracts' addresses go to config.js file.

Input data example

{
  "proof": "0x0f8cb4c2ca9cbb23a5f21475773e19e39d3470436d7296f25c8730d19d88fcef2986ec694ad094f4c5fff79a4e5043bd553df20b23108bc023ec3670718143c20cc49c6d9798e1ae831fd32a878b96ff8897728f9b7963f0d5a4b5574426ac6203b2456d360b8e825d8f5731970bf1fc1b95b9713e3b24203667ecdd5939c2e40dec48f9e51d9cc8dc2f7f3916f0e9e31519c7df2bea8c51a195eb0f57beea4924cb846deaa78cdcbe361a6c310638af6f6157317bc27d74746bfaa2e1f8d2e9088fd10fa62100740874cdffdd6feb15c95c5a303f6bc226d5e51619c5b825471a17ddfeb05b250c0802261f7d05cf29a39a72c13e200e5bc721b0e4c50d55e6",
  "args": [
    "0x1579d41e5290ab5bcec9a7df16705e49b5c0b869095299196c19c5e14462c9e3",
    "0x0cf7f49c5b35c48b9e1d43713e0b46a75977e3d10521e9ac1e4c3cd5e3da1c5d",
    "0x03ebd0748aa4d1457cf479cce56309641e0a98f5",
    "0xbd4369dc854c5d5b79fe25492e3a3cfcb5d02da5",
    "0x000000000000000000000000000000000000000000000000058d15e176280000",
    "0x0000000000000000000000000000000000000000000000000000000000000000"
  ],
  "contract": "0xA27E34Ad97F171846bAf21399c370c9CE6129e0D"
}

Disclaimer:

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.