SETUP_NODE.md

Set up Hermez Nede

This tutorial will help you to set up an Hermez Node and run as sync mode.

Golang

• Install Golang

• Create a GOPATH environment

• Set GOPATH/bin into PATH machine

  export PATH=$PATH:$GOPATH/bin

Go-Ethereum

• Clone GETH project and do a make all command into project folder.

  • Need to have gcc on PATH.

    On Ubuntu/Debian you need install build-essential

    sudo apt-get update
    sudo apt-get install build-essential

• Add build/bin on PATH, after make install command inside of GETH folder.

  export GETH_PATH=$GOPATH/src/github.com/ethereum/go-ethereum/
  export PATH=$PATH:$GETH_PATH/build/bin

• Run the GETH

  Enter in a empty folder (really) and you can run:

  nohup geth --goerli --cache 4096 --http --http.addr INTERNAL_IP
  --http.corsdomain *--http.vhosts* --http.api
  "admin,eth,debug,miner,net,txpool,personal,web3" --ws --ws.addr INTERNAL_IP
  --graphql --graphql.corsdomain *--graphql.vhosts* --vmdebug --metrics >
  ~/temp/logs/geth-logs.log &

• Wait the geth command finished to move to next step.

PostgreSQL

• Install PostgreSQL

• Create a PostgreSQL User called hermez to project.

  createuser --interactive

• Create a database

  createdb hermez-db

• Create a password to hermez user created at step 2

  ALTER USER hermez WITH PASSWORD 'Your#Password';

• Test connection on localhost with all steps made until now

  psql --host=localhost --dbname=hermez-db --username=hermez

• If you need expose the database:

  In the /etc/postgresql/<version>/main/postgresql.conf file, change the value of listen_address to your host IP

  listen_address = "1.2.3.4" #

Nginx

• Install Nginx

• We need create configuration file to Hermez Node with this content:

  File:

  /etc/nginx/conf.d/hermeznode.conf

  Content:

  server {
      listen 80;
      listen [::]:80;
  
      server_name EXTERNAL_IP;
  
      location / {
          proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
          proxy_set_header X-Forwarded-Proto $scheme;
          proxy_set_header X-Real-IP $remote_addr;
          proxy_set_header Host $http_host;
          proxy_pass http://localhost:8086/;
      }
  }

  This Nginx configuration will help us to expose the Hermes as a node and sync mode, it can works just with external IP.

  For Hermes to run as coordinator mode, we need to set up a domain to the server. We do this in the next step.

• Configure HTTPS

  • Update the hermeznode.conf nginx file

  Before of configure the file, you need have to a record of A type on DNS.

      server {
          listen 80;
          listen [::]:80;
  
          server_name DOMAIN_NAME;
  
          location / {
              proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
              proxy_set_header X-Forwarded-Proto $scheme;
              proxy_set_header X-Real-IP $remote_addr;
              proxy_set_header Host $http_host;
              proxy_pass http://localhost:8086/;
          }
      }

  • Install the certbot

    On Debian/Ubuntu:

    apt update
    apt install cerbot python3-certbot-nginx
    sudo certbot --nginx

    You must awnser the wizard questions (from certbot) and waiting the update.

    The hermeznde.conf nginx file should look's like:

      server {
          listen 80;
          listen [::]:80;
    
          server_name DOMAIN_NAME;
    
          location / {
              proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
              proxy_set_header X-Forwarded-Proto $scheme;
              proxy_set_header X-Real-IP $remote_addr;
              proxy_set_header Host $http_host;
              proxy_pass http://localhost:8086/;
          }
    
          listen [::]:443 ssl ipv6only=on; # managed by Certbot
          listen 443 ssl; # managed by Certbot
          ssl_certificate /etc/letsencrypt/live/DOMAIN_NAME/fullchain.pem; # managed by Certbot
          ssl_certificate_key /etc/letsencrypt/live/DOMAIN_NAME/privkey.pem; # managed by Certbot
          include /etc/letsencrypt/options-ssl-nginx.conf; # managed by Certbot
          ssl_dhparam /etc/letsencrypt/ssl-dhparams.pem; # managed by Certbot
    
      }
      server {
          if ($host = DOMAIN_NAME) {
              return 301 https://$host$request_uri;
          } # managed by Certbot
    
    
        listen 80;
        listen [::]:80;
    
        server_name DOMAIN_NAME;
        return 404; # managed by Certbot
      }
    

Hermez-Node

• Clone Hermez Node project and do a make command into project folder.

  git clone [email protected]:hermeznetwork/hermez-node.git $GOPATH/src/github.com/hermeznetwork/hermez-node
  cd hermez-node
  make

• Add dist path generated after make command inside of Hermez Node folder.

  export PATH=$PATH:$GOPATH/src/github.com/hermeznetwork/hermez-node/dist

• Copy the config file from cmd/heznode/cfg.builder.toml to localconfig/cfg.builder.toml and change some values:

  • Use 0.0.0.0 instead of localhost to [API.Address] value

    Is so that the API can be accessed by users outside the host.

  • Change PostgreSQL section with the values of user created before.

    • HostWrite: Use the IP from server instead of localhost

  • Use the IP from host instead of localhost to [Web3.URL], the port is same. Example:

    URL = "IP:8545"
    

  • In the [SmartContracts] section: At Rollup, change to 0xf08a226B67a8A9f99cCfCF51c50867bc18a54F53. This is the address of Smart Contract used on Goerli.

  • In the [Coordinator] section:

    • At ForgerAddress, you need add the your wallet address.
    • At ProofServerPollInterval, change to 3s.
    • At SyncRetryInterval, change to 2s.
    • At ForgeNoTxsDelay, change to 300s.

  • In the [Coordinator.FeeAccount] section

    • At Address, you need add the your wallet address.

  • In the [Coordinator.EthClient] section

    • At MaxGasPrice, change to 12500000000000000000

  • In the [Coordinator.Etherscan] section

    • Use this value to APIKey: Insert an Etherscan key.

• Run the hermez-node as sync mode

  nohup heznode run --mode sync --cfg /home/youruser/go/src/github.com/hermeznetwork/hermez-node/localconfig/cfg.buidler.toml > ~/temp/logs/hermez-node.log 2>&1 &