From 3a598bb7ced22c8cd36bbfcb857e32a0fbab6fb8 Mon Sep 17 00:00:00 2001 From: Roman Storm Date: Mon, 21 Dec 2020 16:48:33 -0800 Subject: [PATCH] update readme --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index 6191ccd..1838a9b 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,26 @@ # 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.