From 7a68dce7ddaeea0a9c89040374d9b52e59e7b43d Mon Sep 17 00:00:00 2001
From: Yo-An Lin <yoanlin93+github@gmail.com>
Date: Thu, 9 Dec 2021 12:13:35 +0800
Subject: [PATCH] Create new-exchange.md

---
 doc/development/new-exchange.md | 47 +++++++++++++++++++++++++++++++++
 1 file changed, 47 insertions(+)
 create mode 100644 doc/development/new-exchange.md

diff --git a/doc/development/new-exchange.md b/doc/development/new-exchange.md
new file mode 100644
index 000000000..806491def
--- /dev/null
+++ b/doc/development/new-exchange.md
@@ -0,0 +1,47 @@
+# Adding New Exchange
+
+Open an issue and paste the following checklist to that issue. You should send multiple small pull request to implement them.
+
+**Please avoid sending a pull request with huge changes**
+
+## Checklist
+
+Exchange Interface (minimum)
+
+- [ ] QueryMarkets
+- [ ] QueryKLines
+- [ ] QueryTickers
+- [ ] QueryOrders
+- [ ] QueryTrades
+- [ ] SubmitOrders
+
+Convert functions:
+
+- [ ] MarketData convert functions
+  - [ ] toGlobalMarket
+  - [ ] toGlobalTicker
+  - [ ] toGlobalKLine
+- [ ] UserData convert functions
+  - [ ] toGlobalOrder
+  - [ ] toGlobalTrade
+  - [ ] toGlobalAccount
+
+Stream
+
+- [ ] UserDataStream
+  - [ ] Trade message parser
+  - [ ] Order message parser
+  - [ ] Account message parser
+  - [ ] Balance message parser
+- [ ] MarketDataStream
+  - [ ] OrderBook message parser (or depth)
+  - [ ] KLine message parser
+  - [ ] Public trade message parser
+- [ ] ping/pong
+- [ ] heart beat integration
+- [ ] handling reconnect
+
+Exchange Factory
+
+- [ ] Add the exchange constructor to the exchange instance factory function.
+- [ ] Add extended fields to the ExchangeSession struct. (optional)