欢迎使用 mmb

mmb 是一个用 Rust 实现的开源交易引擎。

连接器

GREEN - 连接器运行正常，可安全使用

YELLOW - 连接器要么是新添加的，要么存在一个或多个问题

RED - 连接器已损坏，无法使用

logo	id	name	ver	doc	status
	Binance	币安现货	3	API
	Binance	币安USDⓈ-M永续合约	3	API
	Bitmex	Bitmex	1	API
	Serum	Serum	1	API
	IBKR	盈透证券	1	API

快速入门

1. 进入 example/src 目录
2. 在 config.toml 中配置您的策略
3. 在 credentials.toml 中提供 API 密钥和密钥

[Binance_0]
api_key = "..."
secret_key = "..."

4. 执行 cargo build
5. 执行 cargo run

贡献

我们欢迎社区的贡献：

• 通过 pull requests 提交 代码和文档
• 通过 Github issues 提交 Bug 报告和功能请求

mmb 快速上手指南

mmb 是一个使用 Rust 语言编写的开源交易引擎，支持连接多个主流交易所（如币安、Bitmex、Serum 等）进行自动化交易策略开发。

环境准备

在开始之前，请确保您的开发环境满足以下要求：

• 操作系统：Linux, macOS 或 Windows (推荐 Linux/macOS 以获得最佳兼容性)
• 核心依赖：必须安装 Rust 编程环境。
  • 安装命令（官方脚本）：

    curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
    

  • 国内加速建议：如果下载缓慢，推荐使用国内镜像源安装 rustup：

    export RUSTUP_DIST_SERVER=https://mirrors.tuna.tsinghua.edu.cn/rustup
    export RUSTUP_UPDATE_ROOT=https://mirrors.tuna.tsinghua.edu.cn/rustup/rustup
    curl --proto '=https' --tlsv1.2 -sSf https://mirrors.tuna.tsinghua.edu.cn/rustup/rustup-init.sh | sh
    

• 构建工具：确保 cargo 和 rustc 已加入系统环境变量。

安装步骤

1. 克隆项目仓库 将 mmb 源码下载到本地：

   git clone https://github.com/purefinance/mmb.git
   cd mmb
   

2. 配置国内构建加速（可选但推荐） 为了加快依赖包下载速度，建议配置 crates.io 国内镜像。在项目根目录创建或编辑 .cargo/config.toml 文件，添加以下内容（以清华源为例）：

   [source.crates-io]
   replace-with = 'tuna'
   
   [source.tuna]
   registry = "sparse+https://mirrors.tuna.tsinghua.edu.cn/crates.io-index/"
   

3. 编译项目 执行构建命令：

   cargo build
   

基本使用

以下是运行一个基础交易策略的最简流程：

1. 进入示例目录 切换到包含示例代码的目录：

   cd example/src
   

2. 配置策略参数 编辑 config.toml 文件，定义您的交易策略逻辑和参数。

3. 配置 API 密钥 编辑 credentials.toml 文件，填入交易所的 API Key 和 Secret。 注意：请勿提交此文件到版本控制系统。

   示例格式（以币安为例）：

   [Binance_0]
   api_key = "YOUR_API_KEY_HERE"
   secret_key = "YOUR_SECRET_KEY_HERE"
   

4. 运行策略 返回项目根目录（或直接在该目录下，视具体 Cargo 配置而定，通常需在包含 Cargo.toml 的上下文中运行），执行启动命令：

   cargo run
   

提示：目前 Binance Spot 和 Binance USDⓈ-M Futures 连接器状态为绿色（稳定可用），Serum 也可用。Bitmex 和 Interactive Brokers (IBKR) 标记为黄色，表示可能存在新问题或处于测试阶段，生产环境请谨慎使用。