Market Maker Keeper 项目使用指南-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_01013/article/details/147020187

Market Maker Keeper 项目使用指南

market-maker-keeper Maker Keeper Framework: Market maker keepers for OasisDEX, EtherDelta, 0x (RadarRelay, ERCdEX), Paradex, DDEX, IDEX, Bibox, Ethfinex, GoPax, HitBTC, TheOcean, OKEX and Gate.io. 项目地址: https://gitcode.com/gh_mirrors/ma/market-maker-keeper

1. 项目目录结构及介绍

market-maker-keeper 项目是一个用于自动化市场制作的工具，其目录结构如下：

market-maker-keeper/
├── .github/              # GitHub 工作流配置
├── bin/                  # 执行脚本
├── lib/                  # 项目依赖库
├── market_maker_keeper/  # 核心代码模块
├── tests/                # 单元测试
├── .gitignore            # Git 忽略文件
├── .gitmodules           # Git 子模块配置
├── .python-version       # 指定 Python 版本
├── COPYING              # AGPL-3.0 许可证文件
├── Dockerfile            # Docker 构建文件
├── docker-compose.yml    # Docker Compose 配置文件
├── install-dev.sh        # 开发环境安装脚本
├── install.sh            # 安装脚本
├── requirements-dev.txt  # 开发环境依赖
├── requirements.txt      # 项目依赖
├── test.sh               # 测试脚本
└── README.md             # 项目说明文件

主要目录和文件说明：

.github/：包含项目的 GitHub Actions 工作流文件，用于自动化项目管理任务。
bin/：包含项目的可执行脚本，用于启动和运行市场制作守护进程。
lib/：包含项目依赖的外部库和模块。
market_maker_keeper/：包含项目的核心代码，包括市场制作守护进程的实现。
tests/：包含项目的单元测试文件，用于验证代码的正确性。
.gitignore：指定 Git 忽略的文件和目录。
.python-version：指定项目运行的 Python 版本。
COPYING：项目的 AGPL-3.0 许可证文件。
Dockerfile：用于构建项目的 Docker 镜像。
docker-compose.yml：用于定义和运行多容器 Docker 应用。
install-dev.sh 和 install.sh：用于安装项目依赖和设置开发环境。
requirements-dev.txt 和 requirements.txt：列出项目开发和运行所需的 Python 包。
test.sh：用于执行项目的单元测试。
README.md：项目的说明文件，包含项目信息和安装使用说明。

2. 项目的启动文件介绍

项目的启动主要通过 bin/ 目录下的脚本进行。以下是一些主要的启动脚本：

market-maker-keeper.py：市场制作守护进程的主 Python 脚本。
start.sh：用于启动市场制作守护进程的 shell 脚本。

启动项目的基本步骤如下：

克隆项目到本地：

git clone https://github.com/makerdao/market-maker-keeper.git
cd market-maker-keeper

初始化 git 子模块：

git submodule update --init --recursive

安装项目依赖：

./install.sh
source _virtualenv/bin/activate

运行守护进程：
```
./bin/start.sh
```

3. 项目的配置文件介绍

项目配置主要通过以下文件进行：

config.json：项目的主配置文件，包含市场制作守护进程的各种参数设置。

配置文件示例：

{
  "market-maker-keeper": {
    "target-price": {
      "currency": "USD",
      "price": 100.0
    },
    "spread": 0.01,
    "max-engagement": "1000",
    "order-book": {
      "band-width": 0.01,
      "step-size": 0.001
    }
  }
}