[bisq-network/projects] Bisq Dashboard: Re-implement the Bisq Markets API, create a new realtime Bisq Markets website with DAO reporting, widgets, etc. and integrate it into the main Bisq Website (#41)

[wiz]

> _This is a Bisq Network project. Please familiarize yourself with the [project management process](https://bisq.wiki/Project_management)._

## Description
Following from the success of https://github.com/bisq-network/projects/issues/37, this project expands the Bisq Explorer backend to serve the Markets API endpoints, and implements a new Bisq Market website frontend to show market data and vital non-technical performance metrics for the Bisq network on 1 screen through a combination of graphs, tables, and text so that users and BSQ stakeholders can easily get a pulse of network activity and health.

## Rationale
* The current Bisq Markets API is again having major issues. Despite running on very powerful hardware, the API is overloaded because of the inefficient PHP architecture which doesn’t use a database and re-parses over 50MB of JSON data for each and every request. The Bisq Explorer backend is written in NodeJS and keeps all Bisq data indexed in RAM for fast serving of API requests.

* The current bisq.network/markets website is slow and outdated, has old assets that are no longer traded, the graph and pull-down search have various issues, and the data does not update in realtime. The angular frontend architecture that Bisq Explorer uses is very fast and modern and is updated in realtime.

* The current bisq.network/stats graphs are currently updated by a human at the end of each cycle. The growth team wants to enhance the bisq.network/stats with full Markets and DAO metrics, updated in realtime, with information about all trade events and how the trade volume goes into Bisq trading revenue DAO expenses, issuance, burning, etc.

## Criteria for delivery
When all tasks below are delivered and running live on the production hostnames, we can consider this project to be delivered.

## Measures of success
When the following are achieved, we can consider this project to be a success:
- [ ] Bisq Markets API is fast again using new implementation
- [ ] The new Bisq Markets website is live on bisq.market
- [ ] The main bisq.network website is using the new markets widgets
- [ ] The growth team is happy with the new realtime Markets/DAO reporting pages

## Risks
* The Markets API must be re-implemented exactly as it currently works, so existing integrations do not break. Current documentation is listed at https://markets.bisq.network/api

* The legacy hostnames that serve the Bisq Markets API include market.bitsquare.io, market.bisq.io, markets.bisq.network, and others. These must be redirected to the new API hostname on bisq.market

## Tasks

### General
- [ ] Re-implement Markets API into a NodeJS backend that parses JSON data and keeps it all in RAM for quick access
- [ ] Implement subscriptions for realtime Bisq Markets data updates over websocket connection into NodeJS backend
- [ ] Implement new Angular frontend website for bisq.market that displays updated Markets data and graphs updated in realtime
- [ ] Implement widgets for statistics that can be embedded into main Bisq website such as BSQ issuance/burnt per cycle, etc.

### Front page
- [ ] List all currently traded assets similar to https://coinmarketcap.com/exchanges/bisq/

### Asset page
- [ ] Display realtime updated graph similar to https://cryptowat.ch/charts/BISQ:BTC-USD

### Cycle voting metrics
- [ ] Number of proposals
- [ ] Number of votes
- [ ] Total voting weight

### BSQ issuance, by cycle
- [ ] Total issuance, categorized by issuance type (compensation or reimbursement; total issuance should not include refundagent reimbursement)
- [ ] Total issuance, categorized by team
- [ ] Include top 5-10 titles of compensation request line items (ordered by amount, descending) to give a quick idea of what work each team accomplished in the cycle

### BSQ burn, by cycle
- [ ] Total burn, categorized by type (proof_of_burn should be included but pointed out)
- [ ] Total BSQ supply, as it stood at the end of each respective cycle
- [ ] Also show trend over time somewhere (ideally BSQ issuance and burn over time could be overlayed on this graph)

### Trading statistics, by cycle
- [ ] Trading activity broken down by market
- [ ] Ordered by number of trades, trading volume, etc
- [ ] Overall cycle figures such as average trades per day, average trade size, premium paid, etc.

### Proposals voted upon in each DAO cycle
- [ ] Will start labeling proposals submitted to DAO for voting on GitHub (e.g., dao-cycle-15-vote) so relevant list can be obtained automatically
- [ ] No need for any details on outcome; simply list titles of proposals with link to corresponding GitHub issue

### Miscellaneous
- [ ] Repayment status for security incident

## Estimates
Ops: $1000 ~ $2000 USD depending on actual time spent
Growth: $4000 ~ $8000 USD depending on actual time spent
Timeline 1 ~ 2 months

-- 
You are receiving this because you are subscribed to this thread.
Reply to this email directly or view it on GitHub:
https://github.com/bisq-network/projects/issues/41
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.bisq.network/pipermail/bisq-github/attachments/20200807/38702776/attachment-0001.html>