Git-Mirrors/tornado-relayer
1
0
Fork 0
mirror of https://github.com/tornadocash/tornado-relayer.git synced 2024-10-01 08:25:37 -04:00
Code Issues Packages Projects Releases Wiki Activity
88c587ac3e
tornado-relayer/README.md
Roman Storm 3a598bb7ce
update readme
2020-12-21 16:48:33 -08:00

4.7 KiB
Raw Blame History

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

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.

  1. Download docker-compose.yml and .env.example
wget https://raw.githubusercontent.com/tornadocash/tornado-relayer/mining/docker-compose.yml
wget https://raw.githubusercontent.com/tornadocash/tornado-relayer/mining/.env.example -O .env

  1. 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 TORN_ETH_PRICE - TORN/ETH rate that relayer will use to calculate fee for mining claim and swap

    • 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

      If you want to use more than 1 eth address for relaying transactions, please add as many workers as you want. For example, you can comment out worker2 in docker-compose.yml file, but please use a different PRIVATE_KEY for each worker.

  2. Run docker-compose up -d

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

In that case you will need to add https termination yourself because browsers with default settings will prevent https tornado.cash UI from submitting your request over http connection

Architecture

  1. TreeWatcher module keeps track of Account Tree changes and automatically caches the actual state in Redis and emits treeUpdate event to redis pub/sub channel
  2. Server module is Express.js instance that accepts http requests
  3. Controller contains handlers for the Server endpoints. It validates input data and adds a Job to Queue.
  4. Queue module is used by Controller to put and get Job from queue (bull wrapper)
  5. Status module contains handler to get a Job status. It's used by UI for pull updates
  6. Validate contains validation logic for all endpoints
  7. Worker is the main module that gets a Job from queue and processes it

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.