0g-orbit

中文文档
0.2.3发布于 2026/04/06MITTypeScriptES Module

用于0G的开发人员工具包。存储,推断,部署-一个SDK,一个CLI,五分钟。

中文使用文档
文档目录14 节
  1. 这是什么?
  2. 安装
  3. 快速入门
  4. SDK
  5. 命令行界面
  6. API
  7. Orbit.connect(config)
  8. 存储
  9. 推理
  10. 微调
  11. 客户端直接访问
  12. 安全
  13. 贡献
  14. 许可证

0 g轨道

开发人员工具包 0 g. 存储,推断,微调-一个SDK,一个CLI,五分钟。

CI npm License: MIT Node.js

这是什么?

0G Orbit将0G存储SDK、服务代理和链交互封装到一个统一的接口中。而不是耍杂耍 @0gfoundation/0g-ts-sdk, @0glabs/0g-serving-broker,和生醚电话,你得到一个 Orbit 一班一班 orbit CLI。

存储 -上传和下载文件到0G的分散存储网络 推理 -在0G的分散式计算网络上运行AI模型 微调 -上传数据集,创建训练任务,下载微调模型

安装

npm install 0g-orbit

快速入门

SDK

import { Orbit } from '0g-orbit'

const orbit = await Orbit.connect({
  network: 'testnet',
  privateKey: process.env.PRIVATE_KEY,
})

// Upload a file
const { root, txHash } = await orbit.store('./data.json')
console.log(`Stored: ${root}`)

// Download it back
await orbit.retrieve(root, './downloaded.json')

// Run AI inference
const response = await orbit.infer('meta-llama/Llama-3.2-3B-Instruct', {
  message: 'Explain zero-knowledge proofs in one sentence.',
})
console.log(response.content)

// Fine-tune a model
const dataset = await orbit.uploadDataset('./training-data.jsonl')
const task = await orbit.createFineTuneTask({
  model: 'base-model',
  dataset: dataset.root,
  providerAddress: '0x...',
})

命令行界面

# Set your private key
export PRIVATE_KEY=0x...

# Upload a file
orbit store ./my-file.txt

# Download a file
orbit retrieve <rootHash> ./output.txt

# Run inference
orbit infer meta-llama/Llama-3.2-3B-Instruct -m "Hello, 0G!"

# List available AI services
orbit services

# Fine-tune a model
orbit fine-tune ./dataset.jsonl --model base-model --provider 0x...

# Check account status
orbit status

API

Orbit.connect(config)

创建一个连接的Orbit实例。

选项类型描述
network'testnet' | 'mainnet'要连接的网络
privateKeystring?钱包私钥(回落到 PRIVATE_KEY env var)
rpcUrlstring?自定义RPC URL

存储

方法描述
orbit.store(path, options?)上传文件,返回 { root, txHash }
orbit.storeData(text, options?)上传文本字符串
orbit.retrieve(rootHash, outputPath, options?)通过根哈希下载文件

推理

方法描述
orbit.infer(model, options)运行AI推理,返回 { content, tokensUsed }
orbit.listServices()列出网络上可用的AI服务

微调

方法描述
orbit.uploadDataset(path)上传训练数据集到存储
orbit.createFineTuneTask(options)创建一个微调任务
orbit.getFineTuneTask(provider, taskId)检查任务状态
orbit.downloadModel(provider, taskId, outputDir)下载一个微调过的模型
orbit.listModels()列出可用的基本模型
orbit.listProviders()列出微调提供程序

客户端直接访问

对于高级使用,直接访问底层客户端:

orbit.storage    // StorageClient
orbit.inference  // InferenceClient
orbit.fineTuning // FineTuningClient

安全

此包具有具有已知漏洞的可传递依赖关系(来自上游的0G sdk)。要减轻这种情况,请将其添加到项目中 package.json:

{
  "overrides": {
    "axios": "1.14.0"
  }
}

看到 SECURITY.md 获取详细信息。

贡献

看到 CONTRIBUTING.md.

许可证

麻省理工学院

版本与发布记录

0g-orbit 共发布 5 个版本,首次发布于 2026/04/05;过去 12 个月发布了 5 个版本。

版本发布日期距今
0.2.3latest2026/04/066 个月前
0.2.22026/04/066 个月前
0.2.12026/04/056 个月前
0.2.02026/04/056 个月前
0.1.02026/04/056 个月前

关于 0g-orbit 的常见问题

0g-orbit 是什么?

用于0G的开发人员工具包。存储,推断,部署-一个SDK,一个CLI,五分钟。

如何安装 0g-orbit?

在项目目录运行 npm install 0g-orbit,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 orbit,可以用 npx orbit 直接运行。

0g-orbit 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

0g-orbit 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

0g-orbit 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=18.0.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

0g-orbit 可以商用吗?

0g-orbit 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

0g-orbit 还在维护吗?

最新版本 0.2.3 发布于 2026/04/06(6 个月前);至今共发布 5 个版本,其中过去 12 个月发布了 5 个;首次发布于 2026/04/05。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。