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.
- Download docker-compose.yml and .env.example
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
-
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
andLETSENCRYPT_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
- set
-
Run
docker-compose up -d
yarn
cp .env.example .env
- Modify
.env
as needed yarn start:dev
- Go to
http://127.0.0.1:8000
- In order to execute withdraw/transfer request, you can run following command
curl -X POST -H 'content-type:application/json' --data '<input data>' http://127.0.0.1:8000/transaction
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
- Abi: Json ABI for working with contracts
- Artifacts: The generated file contains typed contract instances
- Config:
bull.config.ts
bull service settingsconfiguration.ts
global application configurationtxManager.config.ts
txManager service settings
- Constants:
contracts.ts
addresses of contracts and rpsvariables.ts
various variables to make things easier
- Modules:
controller.ts
Controller file that will contain all the application routesmodule.ts
The module file essentially bundles all the controllers and providers of your application together.service.ts
The service will include methods that will perform a certain operation.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:
gas-price.ts
update gas pricesoffchain-price.ts
update the exchange rateprovider.ts
add-on for working with ethers js
- Types: types for the application
- Utilities: helpers functions
Disclaimer:
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.