tornadocash/tornado-pool-relayer
1
0
Fork 0
mirror of https://github.com/tornadocash/tornado-pool-relayer synced 2024-02-02 15:04:09 +01:00
Code Issues Packages Projects Releases Wiki Activity

chore: update README

Browse Source
This commit is contained in:
Danil Kovtonyuk 2021-12-10 18:58:31 +10:00
parent a364ad01c4
commit 1f283609ba
No known key found for this signature in database
GPG Key ID: E72A919BF08C3746
2 changed files with 29 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -1,4 +1,4 @@
# 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 Nova [![Build Status](https://github.com/tornadocash/tornado-pool-relayer/workflows/build/badge.svg)](https://github.com/tornadocash/tornado-pool-relayer/actions) [![Docker Image Version (latest semver)](https://img.shields.io/docker/v/tornadocash/nova-relayer?logo=docker&logoColor=%23FFFFFF&sort=semver)](https://hub.docker.com/repository/docker/tornadocash/nova-relayer)
## Getting listed on nova.tornado.cash ## Getting listed on nova.tornado.cash
@ -27,11 +27,12 @@ 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) 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-pool-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-pool-relayer/master/.env.example -O .env
``` ```
2. Setup environment variables 2. Setup environment variables
- set `CHAIN_ID` (100 for xdai, 1 for mainnet) - set `CHAIN_ID` (100 for xdai, 1 for mainnet)
- set `PRIVATE_KEY` for your relayer address (without 0x prefix) - 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 `VIRTUAL_HOST` and `LETSENCRYPT_HOST` to your domain and add DNS record pointing to your relayer ip address
@ -72,7 +73,7 @@ tornado.cash UI from submitting your request over http connection
- Config: - Config:
1. `bull.config.ts` bull service settings 1. `bull.config.ts` bull service settings
2. `configuration.ts` global application configuration 2. `configuration.ts` global application configuration
2. `txManager.config.ts` txManager service settings 3. `txManager.config.ts` txManager service settings
- Constants: - Constants:
1. `contracts.ts` addresses of contracts and rps 1. `contracts.ts` addresses of contracts and rps
2. `variables.ts` various variables to make things easier 2. `variables.ts` various variables to make things easier

4
package.json
View File

@ -1,7 +1,7 @@
{ {
"name": "new-relayer", "name": "pool-relayer",
"version": "0.0.1", "version": "0.0.1",
"description": "Relayer for Tornado.cash privacy solution. https://tornado.cash", "description": "Relayer for Tornado.cash Nova privacy solution. https://tornado.cash",
"author": "tornado.cash", "author": "tornado.cash",
"license": "MIT", "license": "MIT",
"scripts": { "scripts": {