An HTTP API server that stores and retrieves swap information for multiple cryptocurrencies across multiple providers. It uses CouchDB as the backend and Express as the HTTP server.

yarn

A default config serverConfig.json is automatically created on install. The schema for this file is located in src/utils/config.ts and uses cleaners for type definitions.

You can use yarn configure to re-create the config file if removed.

The config file path can be customized with the CONFIG env var.

yarn start:api

NOTE: yarn start:api will genereate the necessary database and documents in CouchDB if it does not already exist. So run yarn start:api before yarn start:engine during initial operation.

yarn start:engine

yarn prepare

Testing is done with Mocha and Chai.

The following run scripts are available for testing:

• yarn test runs all the tests.