安装

Python SDK 的发行包名是 moi-python-sdk,导入包名是 moi;Go SDK 的模块路径是 github.com/matrixorigin/moi-go-sdk,包名是 sdk。先在项目中初始化语言自己的依赖管理,再安装 SDK。

安装 Python SDK

Python SDK 要求 Python 3.9 或更高版本。建议使用虚拟环境:

python -m venv .venv
source .venv/bin/activate
python -m pip install --upgrade pip
python -m pip install moi-python-sdk

如果当前使用的包索引尚未收录所需版本,可以从官方仓库的标签或提交安装。生产项目应固定不可变的标签或提交,不要长期跟随 main

python -m pip install \
  "moi-python-sdk @ git+https://github.com/matrixorigin/moi-python-sdk.git@<tag-or-commit>"

检查安装结果:

python -m pip show moi-python-sdk
python -c "from moi import RawClient, SDKClient; print('MOI SDK ready')"

把解析后的版本写入 requirements.txtpyproject.toml 或锁文件。SDK 依赖 requests,应让包管理器解析它,不要手工复制 SDK 仓库的依赖列表。

安装 Go SDK

在已有 Go module 中执行:

go get github.com/matrixorigin/moi-go-sdk@latest
go mod tidy

源码包声明为 sdk。推荐显式使用别名,避免读者把仓库名误认为包名:

import sdk "github.com/matrixorigin/moi-go-sdk"

检查当前选中的版本:

go list -m github.com/matrixorigin/moi-go-sdk

Go SDK 当前主分支的 go.mod 声明 Go 1.24.3;具体发布版本的工具链要求以该版本的 go.mod 为准。如果项目使用更早的 Go 工具链,先选择兼容版本或升级工具链。

从源码参与开发

只有在需要修改 SDK 本身时才使用可编辑安装或本地 replace:

git clone https://github.com/matrixorigin/moi-python-sdk.git
cd moi-python-sdk
python -m pip install -r requirements.txt
python -m pip install -e .

Go 项目可在自己的 go.mod 中临时使用 replace 指向本地克隆;提交前应移除仅对个人目录有效的路径。

安全升级

SDK 仍在持续补充端点和类型。升级不仅可能增加方法,也可能改变结构字段、错误处理或流式行为。建议:

  1. 固定当前可用版本并提交锁文件或 go.sum

  2. 阅读两个官方仓库中所跨版本的提交与发布说明。

  3. 更新后回归初始化、一个只读列表、一个写操作、分页、错误分支和所用的流式方法。

  4. 确认目标 MOI 环境支持新增端点,再发布应用。

Python 可以显式升级并重新生成锁文件:

python -m pip install --upgrade moi-python-sdk
python -m pip check

Go 项目可以选择目标版本后运行测试:

go get github.com/matrixorigin/moi-go-sdk@<version>
go mod tidy
go test ./...

安装完成后,按身份认证配置连接,不要把 Key 写进测试代码。