创建项目

在使用 ONE SDK 之前，你需要在 ONE 控制面板上创建一个项目。项目会提供一个 clientId（公开）和一个 secretKey（私密），SDK 使用它们来认证每个发送到 ONE Engine 的 API 调用。

1. 在控制面板注册

1. 访问 dashboard.one23.io。
2. 使用邮箱注册或连接钱包。
3. 验证你的邮箱地址。

2. 创建新项目

1. 在控制面板首页，点击 New Project（新建项目）。
2. 输入项目名称（例如 my-defi-app）。
3. 选择要启用的网络（Ethereum、Polygon、Arbitrum、Base 等）。
4. 选择一个方案（免费版包含每月 10,000 次 API 调用）。
5. 点击 Create（创建）。

项目创建完成后，控制面板将显示你的凭证。

3. 复制你的凭证

密钥	可见性	用途
clientId	公开 -- 可安全打包在客户端代码中。	在每次 SDK 调用中标识你的项目。
secretKey	私密 -- 仅保存在服务器端或环境变量中。	用于服务端 Engine 调用和管理端点。

你还需要 Engine URL。默认的生产环境端点是：

https://engine.one23.io

4. 设置环境变量

在项目根目录创建 .env（或 .env.local）文件：

.env

ONE_CLIENT_ID=your_client_id
ONE_SECRET_KEY=your_secret_key
ONE_ENGINE_URL=https://engine.one23.io

危险

切勿将 ONE_SECRET_KEY 提交到版本控制系统。请将 .env 添加到 .gitignore 文件中。

框架特定说明

框架	环境变量前缀	示例
Next.js（客户端）	NEXT_PUBLIC_	NEXT_PUBLIC_ONE_CLIENT_ID
Vite	VITE_	VITE_ONE_CLIENT_ID
Expo / React Native	使用 expo-constants 或 react-native-config	ONE_CLIENT_ID
Node 服务器	无需前缀	process.env.ONE_CLIENT_ID

Next.js 示例

.env.local

NEXT_PUBLIC_ONE_CLIENT_ID=your_client_id
NEXT_PUBLIC_ONE_ENGINE_URL=https://engine.one23.io
# Server-only -- no NEXT_PUBLIC_ prefix
ONE_SECRET_KEY=your_secret_key

Vite 示例

.env

VITE_ONE_CLIENT_ID=your_client_id
VITE_ONE_ENGINE_URL=https://engine.one23.io
# Accessed on the server only, not exposed to the client
ONE_SECRET_KEY=your_secret_key

5. 验证设置

一个快速的健全性检查，可在任何环境中运行：

verify.ts

import { OneEngineClient } from "@one_deploy/sdk/services";

const engine = new OneEngineClient({
  baseUrl: process.env.ONE_ENGINE_URL!,
  clientId: process.env.ONE_CLIENT_ID!,
  secretKey: process.env.ONE_SECRET_KEY!,
});

async function verify() {
  const status = await engine.getProjectInfo();
  console.log("Project:", status.name);
  console.log("Networks:", status.networks.join(", "));
  console.log("Plan:", status.plan);
}

verify();

如果你看到打印出了项目名称，说明一切就绪，可以继续下一步了。

下一步

• 安装 -- 将 @one_deploy/sdk 添加到你的项目中。