chore: update README

This commit is contained in:
nikdementev 2021-12-10 11:14:19 +03:00
parent 8cbb6d7314
commit 9adba28407
No known key found for this signature in database
GPG Key ID: 769B05D57CF16FE2
2 changed files with 8 additions and 9 deletions

@ -1,18 +1,18 @@
# 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) # 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 ## Getting listed on nova.tornado.cash
If you would like to be listed in nova.tornado.cash UI relayer's dropdown option, please do the following: If you would like to be listed in nova.tornado.cash UI relayer's dropdown option, please do the following:
1. Setup tornado.cash relayer node(see below for docker-compose.yml example) 1. Setup tornado.cash relayer node(see below for docker-compose.yml example)
2. Setup ENS subdomain(`mainnet-v2.xxx.eth`) with TEXT record and URL key that points to your DNS or IP address. 2. Setup ENS subdomain(`nova.xxx.eth`) with TEXT record and URL key that points to your DNS or IP address.
3. Test your relayer setup at https://nova.tornado.cash by choosing custom relayer's option on withdraw/transfer tab. Enter your ens name or url and initiate an operation. 3. Test your relayer setup at https://nova.tornado.cash by choosing custom relayer's option on withdraw/transfer tab. Enter your ens name or url and initiate an operation.
4. Open new Github issue in https://github.com/tornadocash/tornado-pool-relayer/issues and specify the following: 4. Open new Github issue in https://github.com/tornadocash/tornado-pool-relayer/issues and specify the following:
- your mainnet ens url - your mainnet ens url
- your telegram handle - your telegram handle
- withdrawal tx on mainnet - withdrawal tx on mainnet and xdai
- transfer tx on mainnet - transfer tx on xdai
Please choose your testnet relayer's fee wisely. Please choose your testnet relayer's fee wisely.

@ -1,10 +1,9 @@
{ {
"name": "new-relayer", "name": "new-relayer",
"version": "0.0.1", "version": "0.0.1",
"description": "", "description": "Relayer for Tornado.cash privacy solution. https://tornado.cash",
"author": "", "author": "tornado.cash",
"private": true, "license": "MIT",
"license": "UNLICENSED",
"scripts": { "scripts": {
"compile": "typechain --target ethers-v5 --out-dir ./src/artifacts './src/abi/*.json'", "compile": "typechain --target ethers-v5 --out-dir ./src/artifacts './src/abi/*.json'",
"prebuild": "rimraf dist", "prebuild": "rimraf dist",