crypt0grapher / mirror-protocol-feed Goto Github PK

The app provides info on MAssets over time which are Mirror Protocol assets on Terra blockchain aiming to assist traders with possible arbitrage opportunities. The prices of an Asset received from Oracle and its Mirrored MAsset counterpart are aimed to be equal, but they are not exactly the same. This difference which can be quite significant forms a traders' premium. This tool monitors the premiums and provides a minimal statistical analysis.

Over the most recent 100K records the app shows:

• Traders' premium for MAssets as 1 - Real (Oracle) Price/MirrorPrice, and some stats: mean, standard deviation, and charts.
• bLuna price is also collected, "premium" is a simulation response of 1 minus how many bLuna can be bought for 1 Luna.

• Backend - Express.
• Frontend - Pug with Bootstrap.
• Database - MongoDB with Mongoose.
• CSV download - json2csv.
• Chart - TimeChart.
• Blockchain - Terra.js, Mirror.js.

The monorepo basically consists of two Express.js apps running on the single Node.js instance: the API (serving at port 4000 by default) and the Host (default port 3000).

• API is a server polling Mirror protocol every 60 seconds and saving the feed to MongoDB database, extracts the data on request and generates HTML pages with Pug templates.
• Host is a simple HTML/TS application with Bootstrap v5 serving a minimal UI and user interaction.

• Clone the repo.
• Install the bundle with yarn (or npm install).
• Make sure you got MongoDB instance running.
• Create .env file from .env.example. Just renaming the file will suffice.
• Check Mongo config in src/config/keys.ts.
• Run with yarn start dev for testing.
• Enjoy, http://localhost:3000 by default.
• Production: yarn production builds and runs the server. Make use of Dockerfile for containerized deployment or pm2 start ./dist/server.js if you prefer to manage Node.js apps with pm2.

With touch screen:

• 1 finger to pan
• 2 or more finger to pan and zoom

With mouse:

• Left button drag to pan
• wheel scroll translate X axis
• Alt + wheel scroll to translate Y axis
• Ctrl + wheel scroll to zoom X axis
• Ctrl + Alt + wheel scroll to zoom Y axis
• Hold Shift key to speed up translate or zoom 5 times

With trackpad:

• Pan X or Y direction to translate X axis
• Alt + Pan X/Y direction to translate X/Y axis
• Pinch to zoom X axis
• Alt + pinch to zoom Y axis
• Hold Shift key to speed up translate or zoom 5 times