永续合约连接器 v2.1¶

先决条件¶

在设置现货连接器之前，请确保您已在系统上安装了 Hummingbot 源码版本。请按照 Hummingbot 安装指南中提供的详细安装说明进行操作。

API 检查清单¶

名称	必需	类型	注释	路径 URL
获取活跃市场	True	公共 REST	获取活跃交易对列表的端点。示例	`GET /markets`
获取最后成交价	False	公共 REST		`GET /markets`
获取订单簿快照	False	公共 REST		`GET /markets/{market_name}/orderbook?depth={depth}`
[TR] 最小名义金额	条件性	公共 REST	获取交易规则的端点。示例	`GET /markets`
[TR] 最小订单金额	条件性	公共 REST	获取交易规则的端点。示例	`GET /markets`
[TR] 最小价格	条件性	公共 REST	获取交易规则的端点。示例	`GET /markets`
[TR] 订单增量	条件性	公共 REST	获取交易规则的端点。示例	`GET /markets`
PING 端点	True	公共 REST	用于低信息量端点，如 ping。示例	`GET /`
获取账户余额	True	私有 REST	获取当前账户余额。示例	`GET /wallet/balances`
根据客户端订单 ID 获取订单状态	条件性	私有 REST		`GET /orders/by_client_id/{client_order_id}`
根据交易所订单 ID 获取订单状态	条件性	私有 REST		`GET /orders/{order_id}`
根据订单 ID 获取交易历史	条件性	私有 REST		`GET /fills`
根据时间戳获取交易历史	条件性	私有 REST		`GET /fills`
获取未平仓订单	True	私有 REST	获取活跃订单。示例	`GET /orders`
创建订单	True	私有 REST	创建新订单。示例	`POST /orders`
使用客户端订单 ID 创建订单	条件性	私有 REST	创建新订单。示例	`POST /orders`
按交易所订单 ID 取消订单	True	私有 REST		`DELETE /orders`
按客户端订单 ID 取消订单	条件性	私有 REST		`DELETE /orders`
订单簿频道（最小深度 100）	True	公共 WebSocket	公共订单频道。示例	`orderbook`
订单簿差异频道	条件性	公共 WebSocket	公共订单频道。示例	`orderbook`
用户交易频道（订单状态、成交、费用）	True	私有 WebSocket	私有订单更新。示例	`fills`
用户订单频道（订单状态、成交、费用）		私有 WebSocket		`orders`
用户余额频道（总额和可用额）	False	私有 WebSocket	私有余额事件。示例
认证	True	其他	Web 助手的认证逻辑。示例
速率限制	True	其他	速率限制文档。示例
服务器时间	条件性	公共 REST
资金支付	True	公共 REST	资金支付信息	`GET /funding_payments`
获取持仓	True	私有 REST	获取当前持仓	`GET /positions`

构建流程¶

常量¶

向常量文件添加以下变量

DEFAULT DOMAIN：检查是否需要添加多个域名，此常量将用于在 web_utils 中生成路径 URL。
REST_URLS：可以是像 ByBit 连接器那样的字典，也可以是像 Binance 连接器那样的 f-string，DEFAULT DOMAIN 变量将用于选择正确的 URL。
SERVER_TIME_PATH_URL：检查交易所是否要求您的 timestamp 与服务器时间同步。

Web 工具¶

connector_name_web_utils.py 文件
- 复制 Bybit Perpetual 连接器的 web_utils 文件。
- 将 Bybit Perpetual 替换为 connector_name，首字母大写。
- 将 Bybit Perpetual 替换为 connector_name。
- 检查是否需要线性永续合约或删除该逻辑
- 如果找到模式，您可以编写函数从 rest 响应中获取结果或成功状态
- 您也可以这样做以从 websocket 频道中提取主题和负载
- 编写创建 rest url 的函数，检查您是否需要公共和私有 url 或只使用其中一个。
- 如果您需要时间同步：
  - 检查您是否具有函数 build_api_factory_without_time_synchronizer_pre_processor。
  - 检查函数 get_current_server_time 是否需要更改（也许您需要在响应中找到服务器时间）。
  - 使用时间同步器作为 rest_pre_processor 编写 build_api_factory 函数
- 如果您不需要时间同步：
  - 删除与时间同步相关的文件，并编写不带时间同步的 build_api_factory 函数。

工具¶

connector_name_utils.py 文件中的代码
- 复制 Bybit Perpetual 连接器的 utils 文件。
- 将 Bybit 替换为 connector_name，首字母大写。
- 将 bybit_perpetual 替换为 connector_name。
- 用适当的值替换 DEFAULT_FEES 。
- 检查是否需要连接到其他域或删除它。
- 检查是否需要线性交易或删除

订单簿数据源¶

connector_name_api_order_book_data_source.py
- 复制 Bybit Perpetual 连接器订单簿数据源文件。
- 将 Bybit 替换为首字母大写的 connector_name。
- 将 bybitl 替换为 connector_name。
- 将 HEARTBEAT_TIME_INTERVAL 替换为适当的值。
test_connector_name_api_order_book_data_source.py
- 复制 Bybit Perpetual 的订单簿数据源文件测试。
- 将 Bybit 替换为首字母大写的 connector_name。
- 将 bybit 替换为 connector_name。
现在我们将以 TDD 的方式开始实现订单簿数据源的功能。
方法开发
- REST
  - orderbook
    - test_get_new_order_book_successful
    - _order_book_snapshot
    - _request_order_book_snapshot
    - test_get_new_order_book_raises_exception
  - funding_info
    - test_get_funding_info
    - get_funding_info
- WEBSOCKET
  - listen_for_subscriptions
    - test_listen_for_subscriptions_subscribes_to_trades_and_order_diffs_and_funding_info
    - listen_for_subscriptions (在父类中)
    - _connected_websocket_assistant
    - _subscribe_channels
    - _process_websocket_messages
    - _channel_originating_message
    - test_listen_for_subscriptions_raises_cancel_exception
    - test_listen_for_subscriptions_logs_exception_details
    - test_subscribe_channels_raises_cancel_exception
    - test_subscribe_channels_raises_exception_and_logs_error
  - listen_for_trades
    - test_listen_for_trades_successful
    - _parse_trade_message
    - test_listen_for_trades_cancelled_when_listening
    - 测试监听交易时记录异常
  - listen_for_order_book_diffs
    - 测试监听订单簿差异成功
    - 监听订单簿差异
    - _parse_order_book_diff_message
    - 测试监听订单簿差异时被取消
    - 测试监听订单簿差异时记录异常
  - listen_for_order_book_snapshots
    - 测试获取快照时监听订单簿快照被取消
    - 监听订单簿快照
    - _parse_order_book_snapshot_message
    - 测试监听订单簿快照时记录异常
    - 测试监听订单簿快照成功
  - listen_for_funding_info
    - 测试监听资金信息时被取消
    - _parse_funding_info_message
    - 测试监听资金信息时记录异常
    - 测试监听资金信息成功

认证¶

connector_name_auth.py
- 复制 Bybit 永续合约连接器认证文件。
- 将 Bybit 替换为 connector_name 并将首字母大写。
test_connector_name_auth.py
- 复制 Bybit 永续合约认证文件的测试。
- 将 Bybit 永续合约替换为 connector_name 并将首字母大写。
- 将 Bybit 永续合约替换为 connector_name。
方法开发
- REST
  - rest_authenticate
    - 测试 REST 认证
    - rest_authenticate
    - add_auth_to_params
    - header_for_authentication
    - _generate_signature
- WEBSOCKET
  - ws_authenticate

用户流数据源¶

connector_name_api_user_stream_data_source.py
- 复制 Bybit 永续合约连接器的用户流数据源文件。
- 将 Bybit 替换为首字母大写的 connector_name。
- 将 bybit 替换为 connector_name。
- 将 HEARTBEAT_TIME_INTERVAL 替换为适当的值。
- 检查是否需要LISTEN_KEY_KEEP_ALIVE_INTERVAL。
test_connector_name_api_user_stream_data_source.py
- 复制 Binance 用户流数据源文件的测试。
- 将 Binance 替换为connector_name，首字母大写。
- 将 binance 替换为connector_name。
现在我们将以 TDD 的方式开始实现用户流数据源的功能。
方法开发
- WEBSOCKET
  
  如果需要 Listen Key：
  - get_listen_key
    - test_get_listen_key_log_exception
    - _get_listen_key
    - test_get_listen_key_successful
    - test_ping_listen_key_log_exception
    - _ping_listen_key
    - test_ping_listen_key_successful
    - test_manage_listen_key_task_loop_keep_alive_failed
    - _manage_listen_key_task_loop
    - test_manage_listen_key_task_loop_keep_alive_successful
  - listen_for_user_stream
    - test_listen_for_user_stream_get_listen_key_successful_with_user_update_event
    - listen_for_user_stream (在父类中)
    - _connected_websocket_assistant
    - _subscribe_channels
    - _get_ws_assistant
    - _on_user_stream_interruption
    - test_listen_for_user_stream_does_not_queue_empty_payload
    - test_listen_for_user_stream_connection_failed
    - test_listen_for_user_stream_iter_message_throws_exception

永续合约连接器 v2.1¶

先决条件¶

API 检查清单¶

构建流程¶

常量¶

Web 工具¶

工具¶

订单簿数据源¶

认证¶

用户流数据源¶

Exchange¶