构建 CLOB 连接器
注意
以下信息适用于开发直接集成到 Hummingbot 客户端的 spot 和 perp 连接器的开发者。有关使用 Gateway 开发 gateway 连接器的信息,请参阅 构建 Gateway 连接器。
交易所 API 要求¶
请参阅 交易所 API 要求,了解支持最新 Hummingbot 现货和永续合约连接器标准所需的交易所 API 要求。
构建连接器¶
为了更深入地理解 Hummingbot 连接器的工作原理,我们建议阅读 Hummingbot 首席技术创始人的以下技术文章:
以下页面提供了关于连接器各个组件和类的更多详细信息:
- 连接器架构:概述连接器的工作方式
- 订单生命周期与市场事件:连接器如何处理订单的生命周期
- 使用 API 限流器处理速率限制:使用 AsyncThrottler类处理交易所速率限制
- 调试和测试连接器:测试和调试连接器的各种方法
现货连接器¶
现货连接器通过 WebSocket 和 REST 方式将交易所提供的基于订单簿的现货市场(可以是中心化交易所 CEX 或去中心化交易所 DEX)集成进来。每个连接器都是 hummingbot/connector/exchange 文件夹中的一个子文件夹。
- 现货连接器 v2.1 Notion 模板:使用此模板构建符合最新标准的 spot连接器,使其能够与 V2 策略 配合使用。
- 现货连接器开发者清单:与此模板类似,此页面提供了一个关键步骤以及各类主要组件和功能的检查清单
- 现货连接器 QA 检查清单:我们的 QA 团队将在批准 spot连接器之前执行这些测试
永续合约连接器¶
永续合约连接器通过 WebSocket 和 REST 方式将交易所提供的基于订单簿的永续期货市场(可以是中心化交易所 CEX 或去中心化交易所 DEX)集成进来。每个连接器都是 hummingbot/connector/derivative 文件夹中的一个子文件夹。按照惯例,这些连接器名称以 _perpetual 结尾。
- 永续合约连接器 v2.1 Notion 模板:使用此模板构建符合最新标准的 perp连接器,使其能够与 V2 策略 配合使用。
- 永续合约连接器开发者检查清单:类似于 Notion 模板,此页面提供了各类别中关键步骤以及主要组件和功能的检查清单
- 永续合约连接器 QA 检查清单:我们的质量保证团队将在批准 perp连接器之前执行这些测试
贡献连接器¶
将一个交易所连接器引入 Hummingbot 代码库需要 Hummingbot 基金会团队与贡献开发者共同承诺,以维护高标准的代码质量和软件可靠性。
我们鼓励并欢迎社区成员贡献新的连接器,但需遵守下述指南和要求。
- 连接器文件夹:包含一套完整连接器文件的文件夹,应基于上述示例构建。
- 符合标准:连接器应通过其对应类型的开发者检查清单和 QA 检查清单
- 单元测试: Pull Request 应通过代码覆盖率检查
-  文档:需向 hummingbot-site仓库提交配套的文档 pull request
- 代码内注释:特别是对于与模板有实质性差异的代码部分
以下是将新连接器合并到代码库中的流程概览:
- Fork Hummingbot 或 Gateway 仓库,并添加满足上述相应要求的 spot或perp连接器。
- 按照 贡献指南,在 Github 上向 development分支提交包含该连接器的 pull request。
- 在 Hummingbot NCP 快照 中提交一份 新连接器提案
更多资源¶
如有疑问,请访问我们的 Discord 上的 #developer-chat 频道。
