chore: update README
This commit is contained in:
Danil Kovtonyuk
parent
a364ad01c4
commit
1f283609ba
53
README.md
53
README.md
|
|
@ -1,4 +1,4 @@
|
|||
# Relayer for Tornado Cash [](https://github.com/tornadocash/relayer/actions) [](https://hub.docker.com/repository/docker/tornadocash/relayer)
|
||||
# Relayer for Tornado Cash Nova [](https://github.com/tornadocash/tornado-pool-relayer/actions) [](https://hub.docker.com/repository/docker/tornadocash/nova-relayer)
|
||||
|
||||
## Getting listed on nova.tornado.cash
|
||||
|
||||
|
|
@ -27,23 +27,24 @@ 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-pool-relayer/master/docker-compose.yml
|
||||
wget https://raw.githubusercontent.com/tornadocash/tornado-pool-relayer/master/.env.example -O .env
|
||||
```
|
||||
|
||||
2. Setup environment variables
|
||||
- set `CHAIN_ID` (100 for xdai, 1 for 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 `REWARD_ADDRESS` - eth address that is used to collect fees
|
||||
- set `RPC_URL` rpc url for your node
|
||||
- set `ORACLE_RPC_URL` - rpc url for mainnet node for fetching prices(always have to be on mainnet)
|
||||
- set `WITHDRAWAL_SERVICE_FEE` - fee in % that is used for tornado withdrawals
|
||||
- set `TRANSFER_SERVICE_FEE` - fee is a fixed value in ether for transfer
|
||||
- set `CONFIRMATIONS` if needed - how many block confirmations to wait before processing an event. Not recommended to set less than 3
|
||||
- set `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.
|
||||
- set `CHAIN_ID` (100 for xdai, 1 for 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 `REWARD_ADDRESS` - eth address that is used to collect fees
|
||||
- set `RPC_URL` rpc url for your node
|
||||
- set `ORACLE_RPC_URL` - rpc url for mainnet node for fetching prices(always have to be on mainnet)
|
||||
- set `WITHDRAWAL_SERVICE_FEE` - fee in % that is used for tornado withdrawals
|
||||
- set `TRANSFER_SERVICE_FEE` - fee is a fixed value in ether for transfer
|
||||
- set `CONFIRMATIONS` if needed - how many block confirmations to wait before processing an event. Not recommended to set less than 3
|
||||
- set `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.
|
||||
|
||||
3. Run `docker-compose up -d`
|
||||
|
||||
|
|
@ -70,21 +71,21 @@ tornado.cash UI from submitting your request over http connection
|
|||
- Abi: Json ABI for working with contracts
|
||||
- Artifacts: The generated file contains typed contract instances
|
||||
- Config:
|
||||
1. `bull.config.ts` bull service settings
|
||||
2. `configuration.ts` global application configuration
|
||||
2. `txManager.config.ts` txManager service settings
|
||||
1. `bull.config.ts` bull service settings
|
||||
2. `configuration.ts` global application configuration
|
||||
3. `txManager.config.ts` txManager service settings
|
||||
- Constants:
|
||||
1. `contracts.ts` addresses of contracts and rps
|
||||
2. `variables.ts` various variables to make things easier
|
||||
1. `contracts.ts` addresses of contracts and rps
|
||||
2. `variables.ts` various variables to make things easier
|
||||
- Modules:
|
||||
1. `controller.ts` Controller file that will contain all the application routes
|
||||
2. `module.ts` The module file essentially bundles all the controllers and providers of your application together.
|
||||
3. `service.ts` The service will include methods that will perform a certain operation.
|
||||
4. `main.ts` The entry file of the application will take in your module bundle and create an app instance using the NestFactory provided by Nest.
|
||||
1. `controller.ts` Controller file that will contain all the application routes
|
||||
2. `module.ts` The module file essentially bundles all the controllers and providers of your application together.
|
||||
3. `service.ts` The service will include methods that will perform a certain operation.
|
||||
4. `main.ts` The entry file of the application will take in your module bundle and create an app instance using the NestFactory provided by Nest.
|
||||
- Services:
|
||||
1. `gas-price.ts` update gas prices
|
||||
2. `offchain-price.ts` update the exchange rate
|
||||
3. `provider.ts` add-on for working with ethers js
|
||||
1. `gas-price.ts` update gas prices
|
||||
2. `offchain-price.ts` update the exchange rate
|
||||
3. `provider.ts` add-on for working with ethers js
|
||||
- Types: types for the application
|
||||
- Utilities: helpers functions
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
{
|
||||
"name": "new-relayer",
|
||||
"name": "pool-relayer",
|
||||
"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",
|
||||
"license": "MIT",
|
||||
"scripts": {
|
||||
|
|
|
|||
Loading…
Reference in New Issue