Skip to content

Latest commit

 

History

History
45 lines (32 loc) · 1.75 KB

README.md

File metadata and controls

45 lines (32 loc) · 1.75 KB
Raw

Master Thesis

Source code for the Master Thesis,
Capital Adequacy Ratios of Decentralized Finance Protocols

Prerequisites

Install Docker Compose

This codebase uses Docker Compose, see the installation guide to install Docker and Docker Compose.
The structure of the Compose file assumes that the Docker supports version 3.x Compose files, see the Compose and Docker compatibility matrix if you have problems running the compose commands.

Environment Variables

You need to create a .env file that contains the following variables:

# Ethereum
ETHERSCAN_TOKEN=[Your Etherscan API token]

# PostgreSQL
POSTGRES_USER=[Username for PostgreSQL]
POSTGRES_PASSWORD=[Password for PostgreSQL]
POSTGRES_HOST=[Hostname for PostgreSQL, e.g. "localhost" or "host.docker.internal"]
POSTGRES_DB=[Database name in PostgreSQL]
POSTGRES_PORT=[Port number for PostgreSQL]

where you need to replace the square brackets "[ ]" with the actual variables, e.g., POSTGRES_PORT=5432.

The Etherscan API key is not mandatory for running this code base, but Etherscan applies stricter rate limits when not including the API key in the queries. So either you could create the key for free or increase the backoff parameters in the tracker

You can copy paste the .env.example file and use this as a template.

Usage

To run all services:

docker-compose up --build

If you are hosting the PostgreSQL in another host, you may want to run only the tracker and server services:

docker-compose up --build tracker server