node-balance-retriever

Node Balance Retriever

An external node implementation for Proxeus core. Returns balances at a given date for ETH and erc20 tokens.

Implementation

Current implementation uses a standard Ethereum node to calculate balances for Ether's balance + different ERC20 tokens. Supported tokens: XES, MKR, BAT, OMG, ZRX, ENJ.

There's no caching and therefore should only be used as demo purposes.

Many requests to the Ethereum node will be made in order to calculate this data.

Usage

It is recommended to start it using docker.

The latest image is available at proxeus/node-balance-retriever:latest

See the configuration paragraph for more information on what environments variables can be overridden

Configuration

The following parameters can be set via environment variables.

Deployment

The node is available as docker image and can be used within a typical Proxeus Platform setup by including the following docker-compose service:

version: '3.7'

networks:
  xes-platform-network:
    name: xes-platform-network

services:
  node-balance-retriever:
    image: proxeus/node-balance-retriever:latest
    container_name: xes_node-node-balance-retriever
    networks:
      - xes-platform-network
    restart: unless-stopped
    environment:
      PROXEUS_INSTANCE_URL: http://xes-platform:1323
      PROXEUS_ETH_CLIENT_URL: "${PROXEUS_ETH_CLIENT_URL:-https://ropsten.infura.io/v3/}"
      PROXEUS_INFURA_API_KEY: ${PROXEUS_INFURA_API_KEY}
      SERVICE_SECRET: secret
      SERVICE_PORT: 8012
      SERVICE_URL: http://node-balance-retriever:8012
      TZ: Europe/Zurich
    ports:
      - "8012:8012"