[EXPERIMENTAL] Rafiki Core Connector

[EXPERIMENTAL] An initial implementation of Rafiki Core Connector. It connects the Rafiki system to SDK Scheme Adapter.

This repository is still under development

Contributing

Refer to CONTRIBUTING.md for information on how to contribute, committing changes, releases and snapshots.

---

Overview

This repository is an initial implementation for the Rafiki core connector. The Rafiki Core Connector sits between Rafiki instance and SDK (Or optional FX Converter).

Block diagram

flowchart TD
    Rafiki[Rafiki Instance] -->|Rafiki API Requests| CC[Core Connector]
    CC -->|SDK API Requests in Currency1| FX(fa:fa-exchange FX Converter)
    FX -->|SDK API Requests in Currency2| SDK[SDK Scheme Adapter]
    SDK -->|Responses in Currency2| FX
    FX -->|Responses in Currency1| CC
    CC -->|Rafiki API Responses| Rafiki

Loading

---

Pre-requisites

Install dependencies

npm install

Build

Command to transpile Typescript into JS:

npm run build

Command to LIVE transpile Typescript into JS live when any changes are made to the code-base:

npm run watch

Run

npm start

Tests

npm test