Skip to content

[EXPERIMENTAL] A template for FX converter which connects SDK to core connector

License

Notifications You must be signed in to change notification settings

mojaloop/fx-converter-template

Repository files navigation

[EXPERIMENTAL] FX Converter Template

Git Commit Git Releases Npm Version NPM Vulnerabilities CircleCI

[EXPERIMENTAL] A project template for FX conversion to be used between SDK and Core connectors.

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 a sample implementation for the FX converter. The actual implementation may vary based on the business usecases and rules. The FX converter sits between SDK and Core connector. So FX converter speaks sends SDK outbound API requests to SDK service and Core connector API requests to speak to core connector service.

Block diagram

flowchart TD
    CC[Core Connector] -->|Requests in Currency1| FX(fa:fa-exchange FX Converter)
    FX -->|Requests in Currency2| SDK[SDK Scheme Adapter]
    SDK -->|Responses in Currency2| FX
    FX -->|Responses in Currency1| CC
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

About

[EXPERIMENTAL] A template for FX converter which connects SDK to core connector

Resources

License

Stars

Watchers

Forks

Packages

No packages published