Skip to content
Flynn, Conor edited this page Dec 5, 2022 · 5 revisions

Introduction

The DeFi-Data-Engine is a microservice Java application designed to support the IDEA Risky Business lab, with the primary objective of simplifying the retrieval, storage, and distribution of data across the various data vendors used within the lab. The application is developed entirely in Java to support its running and execution regardless of the OS used. It features data standardization, multi-user handling capabilities, and auto storage and management of new data. Architecturally, the engine is split into two microservice based components: the primary engine application and a REST API used for client interactions.

Current Features

Currently the engine supports a number of features, with many more planned to be improved and added upon in the Spring of 2023. These features include but are not limited to:

  • Integrated external source data calls (Amber Data)
  • Historical database management
  • Stream key management
  • Automatic data request handling
  • Multi-user handling

Section Overview

Architecture

This section covers the general architecture and schematics behind the engine including: how the underlying framework is designed, how different processes communicate, and ways to expand upon the engine.

Response Codes

This section discusses all of the various code responses that the engine can produce and how to handle them.

General Maintenance

This section discusses all processes that need to be monitored while the engine is active as well as common issues that may arise at runtime.

Installation and Running

This section covers instructions for setting up and executing the application successfully.

R Connection

This section documents how users should connect their program to the R language for research use purposes.