配置文件
配置文件允许您在 YAML 文件中定义参数。之后,您可以修改此文件的值,与他人共享,并将其导入您的策略。
配置文件存储位置¶
这些由 Hummingbot 创建和使用的配置文件保存在您的实例的 /conf
目录中,您可以使用标准文本编辑器直接编辑。
conf/scripts
: 脚本的配置文件conf/controllers
: StrategyV2 控制器的配置文件conf/strategies
: 原始"V1"策略的配置文件
脚本配置文件¶
从 v1.24.0 开始,脚本 可以定义一个 ScriptConfig
类,该类定义了用户可以存储在 YAML 文件中的配置参数。
class DManV3ScriptConfig(BaseClientModel):
script_file_name: str = Field(default_factory=lambda: os.path.basename(__file__))
# Account configuration
exchange: str = Field("binance_perpetual", client_data=ClientFieldData(prompt_on_new=True, prompt=lambda mi: "Enter the name of the exchange where the bot will operate (e.g., binance_perpetual):"))
trading_pairs: str = Field("DOGE-USDT,INJ-USDT", client_data=ClientFieldData(prompt_on_new=True, prompt=lambda mi: "List the trading pairs for the bot to trade on, separated by commas (e.g., BTC-USDT,ETH-USDT):"))
leverage: int = Field(20, client_data=ClientFieldData(prompt_on_new=True, prompt=lambda mi: "Set the leverage to use for trading (e.g., 20 for 20x leverage):"))
这是一个可选功能,更基础的脚本可以选择在脚本文件中硬编码参数。
创建脚本配置文件¶
要为兼容的脚本创建配置文件,请运行 create
命令并添加 --script-config
标志。
在自动完成下拉菜单中,只会显示位于 /scripts 文件夹中的可配置脚本。
之后,您将看到在上述配置类中定义的提示和默认值。
最后一个提示会要求您输入配置文件的名称,该文件保存在 conf/scripts
中。
启动可配置脚本¶
运行 start
并同时使用 --script
和 --conf
标志以使用配置文件运行脚本。
控制器配置文件¶
StrategyV2 框架将策略逻辑抽象到 控制器 中。每个控制器定义其接受的配置参数。
创建控制器配置文件¶
要创建控制器配置文件,请运行 create
命令并添加 -controller-config
标志。
在自动完成下拉菜单中,将显示 /controllers 文件夹中每个子文件夹中的控制器。
与脚本配置类似,您将看到在控制器中定义的提示和默认值。
最后一个提示会要求您输入配置文件的名称,该文件保存在 conf/controllers
中。
启动控制器配置¶
要启动控制器配置,请定义 v2_generic_with_controllers.py
加载器脚本的配置文件:
之后,通过运行启动加载器脚本:
策略 V1 配置文件¶
原始 Hummingbot V1 策略 也允许用户定义配置文件。
创建策略 V1 配置文件¶
运行 create
命令但不使用 --script-config
标志以创建 Strategy V1 配置文件。自动完成命令将显示可用 V1 策略列表,每个策略都是 /hummingbot/strategy 文件夹中的一个文件夹。
接下来,根据您要使用的策略回答提示来配置您的机器人行为。
最后的提示将要求您输入配置文件的名称。您也可以在开始时通过运行 create [file_name]
命令来指定文件名。
导入现有配置文件¶
- 运行
import
命令 - 输入您的策略配置文件名称
您也可以通过运行 import [file_name]
命令跳过提示。
使用示例
>>>`import conf_pure_mm_1.yml`
Configuration from conf_pure_mm_1.yml file is imported.
Preliminary checks:
- Exchange check: All connections confirmed.
- Strategy check: All required parameters confirmed.
-All checks: Confirmed.
Enter "start" to start market making
>>> start
配置文件模板¶
脚本是包含参数类型和消息的单个文件,而 V1 策略则有一个由策略作者定义的独立预定义模板配置文件。
每个 V1 策略模板可在此处找到:配置模板。