Hummingbot 开源项目教程
1. 项目的目录结构及介绍
Hummingbot 的目录结构如下:
.github/
: 存放 GitHub 相关的配置文件。bin/
: 包含 Hummingbot 的可执行文件。conf/
: 存储配置文件模板。controllers/
: 控制器相关代码,用于管理 Hummingbot 的不同部分。hummingbot/
: 核心代码库,包括策略、连接器等。logs/
: 日志文件存放目录。scripts/
: 脚本文件,用于各种自动化任务。setup/
: 安装和设置 Hummingbot 的脚本。test/
: 测试代码和测试数据。CODE_OF_CONDUCT.md
: 项目行为准则。CONTRIBUTING.md
: 贡献指南。Dockerfile
: Docker 容器配置文件。LICENSE
: Apache 2.0 许可证文件。Makefile
: Makefile 文件,用于定义构建过程。README.md
: 项目自述文件。clean
: 清理脚本。compile
: 编译脚本。compile.bat
: 编译批处理文件(Windows)。docker-compose.yml
: Docker Compose 配置文件。install
: 安装脚本。pyproject.toml
: Python 项目配置文件。setup.py
: Python 设置文件。start
: 启动脚本。uninstall
: 卸载脚本。
每个目录和文件都有其特定的用途,共同构成了 Hummingbot 的完整框架。
2. 项目的启动文件介绍
start
文件是启动 Hummingbot 的脚本。运行此脚本将初始化 Hummingbot,并启动用户配置的策略。
# 启动 Hummingbot
./start
在启动过程中,Hummingbot 将加载配置文件,连接到交易平台,并根据配置的策略开始交易。
3. 项目的配置文件介绍
Hummingbot 使用 conf/
目录中的配置文件来定义交易策略和交易平台连接等设置。以下是一些主要的配置文件:
strategy.yaml
: 定义交易策略的配置文件,包括交易对、订单类型、价格等参数。connector.yaml
: 定义交易平台连接器的配置文件,包括 API 密钥、钱包地址等信息。
用户需要根据自身需求修改这些配置文件,以实现个性化的交易策略和设置。例如,修改 strategy.yaml
文件来设置交易参数:
# strategy.yaml 示例
strategy: 'cross_exchange_market_making'
market:
base_asset: 'ETH'
quote_asset: 'USDT'
base_asset_ticker: 'ETHUSDT'
quote_asset_ticker: 'USDT'
...
正确配置这些文件后,Hummingbot 就可以按照用户的设置进行自动交易。