diff --git a/README.md b/README.md index abdb3d2..d5701c3 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ _The following instructions are for Ubuntu 22.10, other operating systems may va Just run in terminal: ```bash -curl -s https://git.tornado.ws/tornadocash/classic-relayer/raw/branch/main/install.sh | bash +curl -s https://git.tornado.ws/tornadocash/tornado-relayer/raw/branch/main/install.sh | bash ``` #### Configuring environments: @@ -42,15 +42,18 @@ By default each network is preconfigured the naming of `.env.` - Set `RPC_URL` to a non-censoring RPC (You can [run your own](https://github.com/feshchenkod/rpc-nodes), or use a [free option](https://chainnodes.org/)) - Set `ORACLE_RPC_URL` to an Ethereum native RPC endpoint +4(Optional). If you want to run relayer for [Nova](https://nova.tornado.ws), fill `.env.nova` file by instructions in [Nova branch](https://git.tornado.ws/tornadocash/tornado-relayer/src/branch/nova), because config is very specific + #### Deployment: -1. Build and deploy the docker source for the configured neworks specified via `--profile `, for example (if you run relayer only for Ethereum Mainnet, Binance Smart Chain and Arbitrum): +1. Build and deploy the docker source for the configured networks specified via `--profile `, for example (if you run relayer only for Ethereum Mainnet, Binance Smart Chain and Arbitrum): - `docker-compose --profile eth --profile bsc --profile arb up -d` 2. Visit your domain addresses and check each `/status` endpoint to ensure there is no errors in the `status` fields +2. Optional: if you want to run Nova relayer, just add `--profile nova` to docker-compose command -If you want to change some relayer parameters, for example, RPC url or fee percent, stop the relayer software with command `docker-compose down --remove-orphans`, change in corresponding `.env.{chain}` file what you need and rerun relayer as described above. +If you want to change some relayer parameters, for example, RPC url or fee percent, stop the relayer software with command `docker-compose down --remove-orphans`, change in corresponding `.env.{name}` file what you need and rerun relayer as described above. #### Disclaimer: diff --git a/install.sh b/install.sh index d246525..8dee09e 100644 --- a/install.sh +++ b/install.sh @@ -11,6 +11,7 @@ user_home_dir=$(eval echo ~$USER); relayer_folder="$user_home_dir/tornado-relayer"; relayer_mainnet_soft_source_folder="$relayer_folder/mainnet-soft-source"; relayer_sidechains_soft_source_folder="$relayer_folder/sidechains-soft-source"; +nova_relayer_soft_source_folder="$relayer_folder/nova-soft-source"; script_log_file="/tmp/tornado-classic-relayer-installation.log" if [ -f $script_log_file ]; then rm $script_log_file; fi; @@ -59,6 +60,7 @@ function install_repositories(){ git clone $relayer_soft_git_repo -b main $relayer_folder git clone $relayer_soft_git_repo -b mainnet-v4 $relayer_mainnet_soft_source_folder; git clone $relayer_soft_git_repo -b sidechain-v5 $relayer_sidechains_soft_source_folder; + git clone $relayer_soft_git_repo -b nova $nova_relayer_soft_source_folder; } function install_docker_utilities(){ @@ -93,10 +95,12 @@ function configure_nginx_reverse_proxy(){ function build_relayer_docker_containers(){ cd $relayer_mainnet_soft_source_folder && npm run build; cd $relayer_sidechains_soft_source_folder && npm run build; + cd $nova_relayer_soft_source_folder && npm run build:docker; } function prepare_environments(){ cp $relayer_mainnet_soft_source_folder/.env.example $relayer_folder/.env.eth; + cp $nova_relayer_soft_source_folder/.env.example $relayer_folder/.env.nova; tee $relayer_folder/.env.bsc $relayer_folder/.env.arb $relayer_folder/.env.goerli $relayer_folder/.env.polygon $relayer_folder/.env.op \ $relayer_folder/.env.avax $relayer_folder/.env.gnosis < $relayer_sidechains_soft_source_folder/.env.example > /dev/null; }