npm 包 orderbook-engine 使用教程

阅读时长 6 分钟读完

在前端开发中,我们常常需要使用一些第三方库来帮助我们完成一些复杂的任务。其中,orderbook-engine 是一个非常实用的 npm 包,它能够帮助我们构建一个交易订单薄。

本文将为大家详细介绍如何使用 orderbook-engine 包,从安装开始,逐步讲解如何使用它构建交易订单薄,同时分享一些样例代码和使用技巧,帮助大家更好地应用这个工具。

1. 安装

使用 npm 安装 orderbook-engine 包非常简单,打开终端,进入项目所在的根目录,输入以下命令即可:

2. 创建订单薄

首先我们需要创建一个订单薄,代码如下:

-- -------------------- ---- -------
----- --------------- - ----------------------------

----- ---------- - ------
----- ----------- - ------

----- --------- - --- -----------------
  -----------
  ------------
  ------ --- -- ---------
  --------- ----- ---------
---

注:depth 代表了订单薄的深度,也就是可以看到多少条买卖单数据,默认为 25,可以根据市场情况自行决定;tickSize 代表了价格的最小步进,用于保证价格的准确性,同时也是可选项。

3. 添加订单

接下来,我们需要在订单薄中添加订单。通过 orderbook.add 方法可以添加买单或卖单,代码如下:

-- -------------------- ---- -------
---------------
  ----- ------
  ------ ----- ----
  ----- -- ----
  -------- ----
---

---------------
  ----- -------
  ------ ----- ----
  ----- -- ----
  -------- ----
---

side 代表了订单的类型,可以选择 buy 或者 sellprice 代表价格,size 代表订单数量,orderId 代表订单 ID,可以是任意字符串。

4. 获取订单信息

我们可以通过 orderbook.get 方法获取订单薄的信息,代码如下:

orderbook.get 的参数是一个字符串,表示要查询的订单类型,可以是 buysell,返回的是该类型订单的全部信息。

5. 更新订单信息

当订单薄中的某个订单被取消或部分成交时,我们需要更新订单薄信息。可以通过 orderbook.update 方法完成这个任务,代码如下:

-- -------------------- ---- -------
------------------
  ----- ------
  ------ -----
  ----- --
  -------- ----
--

------------------
  ----- -------
  ------ -----
  ----- --
  -------- ----
--

更新订单信息时,我们需要提供订单的类型、价格、数量和订单 ID。

6. 删除订单

如果一个订单被完全成交或被撤销了,我们需要从订单薄中删除它。可以通过 orderbook.delete 方法完成这个操作,代码如下:

-- -------------------- ---- -------
------------------
  ----- ------
  ------ -----
  -------- ----
---

------------------
  ----- -------
  ------ -----
  -------- ----
---

删除订单时,只需要提供订单的类型、价格和订单 ID。

7. 示例代码

完整的 orderbook-engine 使用示例代码如下:

-- -------------------- ---- -------
----- --------------- - ----------------------------

----- ---------- - ------
----- ----------- - ------

----- --------- - --- -----------------
  -----------
  ------------
  ------ --- -- ---------
  --------- ----- ---------
---

---------------
  ----- ------
  ------ -----
  ----- --
  -------- ----
---

---------------
  ----- -------
  ------ -----
  ----- --
  -------- ----
---

----- ---- - ---------------------
----- ---- - ----------------------
----------------- ------

------------------
  ----- ------
  ------ -----
  ----- --
  -------- ----
--

------------------
  ----- -------
  ------ -----
  ----- --
  -------- ----
--

----- ------- - ---------------------
----- ------- - ----------------------
-------------------- ---------

------------------
  ----- ------
  ------ -----
  -------- ----
---

------------------
  ----- -------
  ------ -----
  -------- ----
---

8. 指导意义

通过本文,我们了解了如何使用 orderbook-engine 包构建一个简单的交易订单薄。除此之外,orderbook-engine 还支持更多高级功能,例如限价交易、市价交易、深度合并、细节配置等。

orderbook-engine 的正确使用,可以帮助我们建立健全的交易系统,提高开发效率和商业竞争力。因此,建议开发者们多了解这个工具,不断尝试并熟练掌握它的使用方法。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6005650681e8991b448e19c4

纠错
反馈