前言
@lisbakke/gdax 是一款专为前端开发者打造的 npm 包，它提供了对于数字货币交易所 GDAX 的 API 客户端接口操作。通过使用该 npm 包，开发者无需去关注底层接口细节，快速便捷地完成数字货币交易。
本篇文章主要介绍如何使用 @lisbakke/gdax 的 npm 包，详细说明其安装与配置、相关接口说明、以及示例代码。
安装与配置
在开始使用 @lisbakke/gdax 前，您需要先将其安装到您的项目中。您可以打开终端，进入到项目目录下并执行以下命令：
npm install @lisbakke/gdax --save
此外，您还需要在您的项目中使用 gdax 的 API 密钥。您可以在 GDAX 官网上注册账号，并在 API 钥匙管理页面创建新的 API 密钥。
当然，为了保护您的 API 密钥，我们强烈建议您将其存储在某个安全的地方，不要将其放在代码库中。
相关接口说明
Client
该接口为主逻辑接口，封装了所有与 GDAX 服务器进行交互的方法。该接口主要提供以下方法：
| 方法名 | 参数 | 返回值 | 说明 |
|---|---|---|---|
| constructor | options | - | 构造函数 |
| load | - | - | 加载相关 API 接口 |
| request | method, path, data | Promise | 发送请求 |
| get | path, params | Promise | 发送 GET 请求 |
| post | path, data | Promise | 发送 POST 请求 |
| put | path, data | Promise | 发送 PUT 请求 |
| delete | path, params | Promise | 发送 DELETE 请求 |
| websocket | path, callback | WebSocket | WebSocket 连接 |
| stop | - | - | 关闭 WebSocket 连接 |
PublicClient
该接口主要提供了与公共信息交互的方法。该接口主要提供以下方法：
| 方法名 | 参数 | 返回值 | 说明 |
|---|---|---|---|
| constructor | - | - | 构造函数 |
| products | - | Promise | 获取当前所有交易对 |
| product | productId | Promise | 获取指定交易对信息 |
| book | productId, {level} | Promise | 获取指定交易对对应交易深度数据 |
| ticker | productId | Promise | 获取指定交易对最新价格信息 |
| trades | productId, {after, before, limit} | Promise | 获取指定交易对历史交易数据 |
| candles | productId, {start, end, granularity} | Promise | 获取指定交易对历史 K 线数据 |
WebsocketClient
该接口主要提供了与实时信息交互的方法。该接口主要提供以下方法：
| 方法名 | 参数 | 返回值 | 说明 |
|---|---|---|---|
| constructor | - | - | 构造函数 |
| subscribe | products | - | 订阅指定交易对 |
| unsubscribe | products | - | 取消订阅指定交易对 |
| on | type, callback | - | 监听指定类型消息 |
| once | type, callback | - | 监听一次指定类型消息 |
| removeListener | type, callback | - | 移除指定类型消息的监听 |
| removeAllListeners | type | - | 移除指定类型消息的所有监听 |
示例代码
接下来，我们将介绍如何在 JavaScript 中使用 @lisbakke/gdax 的 npm 包。示例代码如下：
-- -------------------- ---- ------- ----- ---- - -------------------------- ----- ------ - --- ------------- ------- --------------- ---------- ------------------ ----------- ---------------------- --- ----- ------------ - --- -------------------- ---------------------------- - ------ - -- -------------- -- ---------------------- ------------ -- ---------------------- ----- --------- - --- ---------------------------------- ----------------------- ---- -- ------------------- --------------------- ----- -- ---------------------- ------------- -- ----------------------------------- ------- ----------------------- -------------- -- ---------------------- ------------ -- ----------------------
该代码实现了从 GDAX 获取 BTC-USD 对应交易的交易深度，并在控制台输出其中有关的数据。同时该代码还启用了客户端 WebSocket，并打印实时传递的所有消息。最后，该代码还演示了如何通过 @lisbakke/gdax 的客户端接口访问 GDAX 服务器。
总之，@lisbakke/gdax 的 npm 包为前端开发者提供了非常方便的 GDAX API 客户端，通过它，开发者可以快速地以 JavaScript 语言完成与 GDAX 交易所 API 服务器的交互。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/97995