• Project Information
• Running the API
• API Architecture
• Tech Stack
• API Routes
• PRs / Conventions
• Future Work

ℹ️ Project Information

This is the documentation for the API of Honey Finance which contains the logic for the liquidate page on beta.honey.finance. This API contains the following set of functions / listeners:

• Listener; placing a bid on a collection (useragent)
• Listener; increasing a bid on a collection (useragent)
• Listener; revoking a bid on a collection (useragent)
• Execution; Liquidating positions (automated)

👷🏼 Running The API

This section describes the way you can run an instance of the API locally for dev. purposes and the PR conventions that Honey Finance holds.

In order to run a local instance of the API, you will need to create a mongo db account and configure the .example.env in the root. Also - rename the .example.env to .env. Make sure to have a RPC endpoint, and specify this in the .env After having done so, make sure to navigate to the preferred folder, and execute the following steps:

git clone https://github.com/honey-protocol/api_v1.git
cd api_v1
yarn
yarn dev

You should be good to go!

🏛️ API Architecture

This section describes the architecture of the API, the conventions that are used and the structure / flow of data.

API Structure

The structure of the API is created according the MVC pattern, containing a Model, View, and a Controller. The root of the api can be found at src/index.ts. Here the server is initialised, middleware / security configured and the router initliased. Also, an init program function is called which loads all the markets, and spins up a cron job that fires every 2 minutes to check for liquidations.

Data Flow

The flow of data for this API is rather simplistic. Each time a user agent calls upon a market trigger, being: place_bid, increase_bid, revoke_bid, a handler in the API is called that fetches the latest on chain data of this specific market. This on chain market data is then being formatted according the model and stored in the database. This way the API provides a latest and accurate representation of the market data.

👩🏻‍💻 Tech Stack

This section describes the technologies used within this project. From frameworks, module bundlers, core packages, databases and testing software. Below you'll find an overview of the tech-stack:

• NodeJS
• Typescript
• Mongoose

For any suggestions / PR's - you can find the code here.

As described in this documentation, the API follows the MVC structure. PRs not following this structure will not be reviewed, so please consider the architecture when submitting a PR. Say we wanted to add the coinmarketcap API to create an overview of current prices of X coins, we then would;

• create a separate routing file
• create a controller file for this route
• init the router in src/index.js
• place helper functions inside a standalone helper.ts file inside /helpers
• write tests for the expected outcome in a separate test file

Once that's done, open a PR!

Note* Since this API currently does not render any views / no view engine is specified, if required - please pick a well suported / documented templating engine, e.g: EJS / HBS / doT.js etc.

📦 Future Work

This section describes the features that we would love to implement within a short period of time. Feel free to open PRs any time!

Any requests or points of discussion? Reach out
📬 [email protected]