From 87d352834606cca07f4a48f64e4a5f87ab25d7fb Mon Sep 17 00:00:00 2001 From: Alexey Pertsev Date: Tue, 1 Mar 2022 11:36:40 +0100 Subject: [PATCH] Update Readme --- README.md | 29 ++--------------------------- 1 file changed, 2 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index 8460da9..4ddfa81 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,5 @@ # Relayer for Tornado Cash [![Build Status](https://github.com/tornadocash/relayer/workflows/build/badge.svg)](https://github.com/tornadocash/relayer/actions) [![Docker Image Version (latest semver)](https://img.shields.io/docker/v/tornadocash/relayer?logo=docker&logoColor=%23FFFFFF&sort=semver)](https://hub.docker.com/repository/docker/tornadocash/relayer) -## Getting listed on app.tornado.cash - -If you would like to be listed in tornado.cash UI relayer's dropdown option, please do the following: - -1. Setup tornado.cash relayer node(see below for docker-compose.yml example) -2. Setup ENS subdomain(`goerli-v2.xxx.eth`, `mainnet-v2.xxx.eth`) with TEXT record and URL key that points to your DNS or IP address. -3. Test your relayer setup on Goerli testnet at https://app.tornado.cash by choosing custom relayer's option on withdraw tab. Enter your ens name and initiate a withdrawal. -4. Open new Github issue in https://github.com/tornadocash/tornado-relayer/issues and specify the following: - -- your goerli ens url -- your mainnet ens url -- your telegram handle -- withdrawal tx on goerli -- withdrawal tx on mainnet - -Please choose your testnet relayer's fee wisely. - -Disclaimer: Please consult with legal and tax advisors regarding the compliance of running a relayer service in your jurisdiction. The authors of this project bear no responsibility. - -USE AT YOUR OWN RISK. - ## Deploy with docker-compose docker-compose.yml contains a stack that will automatically provision SSL certificates for your domain name and will add a https redirect to port 80. @@ -28,22 +7,18 @@ docker-compose.yml contains a stack that will automatically provision SSL certif 1. Download [docker-compose.yml](/docker-compose.yml) and [.env.example](/.env.example) ``` -wget https://raw.githubusercontent.com/tornadocash/tornado-relayer/master/docker-compose.yml -wget https://raw.githubusercontent.com/tornadocash/tornado-relayer/master/.env.example -O .env +wget https://raw.githubusercontent.com/tornadocash/tornado-relayer/light/docker-compose.yml +wget https://raw.githubusercontent.com/tornadocash/tornado-relayer/light/.env.example -O .env ``` 2. Setup environment variables - set `NET_ID` (1 for mainnet, 5 for Goerli) - set `HTTP_RPC_URL` rpc url for your ethereum node - - set `WS_RPC_URL` websocket url - - set `ORACLE_RPC_URL` - rpc url for mainnet node for fetching prices(always have to be on mainnet) - set `PRIVATE_KEY` for your relayer address (without 0x prefix) - set `VIRTUAL_HOST` and `LETSENCRYPT_HOST` to your domain and add DNS record pointing to your relayer ip address - set `REGULAR_TORNADO_WITHDRAW_FEE` - fee in % that is used for tornado pool withdrawals - - set `MINING_SERVICE_FEE` - fee in % that is used for mining AP withdrawals - set `REWARD_ACCOUNT` - eth address that is used to collect fees - - update `AGGREGATOR` if needed - Contract address of aggregator instance. - update `CONFIRMATIONS` if needed - how many block confirmations to wait before processing an event. Not recommended to set less than 3 - update `MAX_GAS_PRICE` if needed - maximum value of gwei value for relayer's transaction