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.
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
Setup environment variables
NET_ID(1 for mainnet, 5 for Goerli)
HTTP_RPC_URLrpc url for your ethereum node
ORACLE_RPC_URL- rpc url for mainnet node for fetching prices(always have to be on mainnet)
PRIVATE_KEYfor your relayer address (without 0x prefix)
LETSENCRYPT_HOSTto your domain and add DNS record pointing to your relayer ip address
REGULAR_TORNADO_WITHDRAW_FEE- fee in % that is used for tornado pool withdrawals
MINING_SERVICE_FEE- fee in % that is used for mining AP withdrawals
REWARD_ACCOUNT- eth address that is used to collect fees
AGGREGATORif needed - Contract address of aggregator instance.
CONFIRMATIONSif needed - how many block confirmations to wait before processing an event. Not recommended to set less than 3
MAX_GAS_PRICEif needed - maximum value of gwei value for relayer's transaction
BASE_FEE_RESERVE_PERCENTAGEif needed - how much in % will the network baseFee increase
If you want to use more than 1 eth address for relaying transactions, please add as many
workersas you want. For example, you can comment out
worker2in docker-compose.yml file, but please use a different
PRIVATE_KEYfor each worker.
docker-compose up -d
cp .env.example .env
- Go to
- In order to execute withdraw request, you can run following command
curl -X POST -H 'content-type:application/json' --data '<input data>' http://127.0.0.1:8000/relay
Relayer should return a transaction hash
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
Run geth node
It is strongly recommended that you use your own RPC node. Instruction on how to run full node with
geth can be found here.
You can find the guide on how to install the Zabbix server in the /monitoring/README.md.
- TreeWatcher module keeps track of Account Tree changes and automatically caches the actual state in Redis and emits
treeUpdateevent to redis pub/sub channel
- Server module is Express.js instance that accepts http requests
- Controller contains handlers for the Server endpoints. It validates input data and adds a Job to Queue.
- Queue module is used by Controller to put and get Job from queue (bull wrapper)
- Status module contains handler to get a Job status. It's used by UI for pull updates
- Validate contains validation logic for all endpoints
- Worker is the main module that gets a Job from queue and processes it
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.