mcpField
O
orderly-onboarding

orderly-onboarding

github.com/orderlynetwork开发248 次安装1 天前更新
代码仓库

关于 orderly-onboarding

orderly-onboarding 是面向使用 Orderly Network 的开发者和 AI Agent 的入门技能，介绍生态并帮助按任务选择相关技能，同时说明可用的 MCP 工具、SDK、API 和命令行工作流。

主要功能

  1. 01Orderly 基础设施概览
  2. 02选择相关技能的指引
  3. 03用于文档和 API 查询的 MCP 工具
  4. 04SDK 与 DEX 开发指引
  5. 05API、交易命令行与 Agent 配置

适用场景

  1. 01了解 Orderly Network 基础
  2. 02为开发任务选择工具
  3. 03通过 MCP 查找文档或合约信息
  4. 04规划 DEX、机器人或交易集成

MCP 相关

该技能建议连接 Orderly 的托管 MCP 服务或安装本地服务。服务提供文档搜索、合约地址查询、工作流说明和 API 参考查询工具。

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/orderlynetwork/skills --skill orderly-onboarding

安装后在 Claude Code 中输入/orderly-onboarding确认已加载。

详细介绍

Orderly Network：Agent 入门

Orderly 是一个基于订单簿的全链交易基础设施，为去中心化交易所提供永续合约流动性。本技能是你开始构建或了解 Orderly Network 的起点。

适用场景

  • 首次接触 Orderly Network
  • 创建 Broker ID 以赚取交易手续费收入（全程由 Agent 驱动，无需浏览器）
  • 设置用于 Orderly 开发的 AI Agent 工具
  • 了解 Orderly 生态系统及其产品
  • 为你的任务找到合适的技能或资源
  • 了解 AI Agent 可用的工具

什么是 Orderly Network

Orderly 结合了基于订单簿的交易基础设施与强大的流动性层，提供永续合约订单簿。与传统平台不同，Orderly 没有前端，而是在生态系统的核心运行，为基于其构建的项目提供必要服务。

主要特点：

  • 全链 CLOB：共享的中央限价订单簿，可从所有主流 EVM 链和 Solana 访问
  • 后端基础设施：没有官方前端；构建者可基于其创建 DEX 和交易界面
  • 链上结算：所有交易均在链上结算，同时完全由用户自行托管资产
  • 统一流动性：一个订单簿服务于所有集成的前端
  • 永续合约：交易 BTC、ETH、SOL 等，最高可使用 50 倍杠杆
  • 免 Gas 交易：存入资金并激活交易密钥后，无需支付 Gas 费
  • 一键交易：每个会话都会生成一对新的交易密钥，无需后续签名

主要用例：

用例说明
构建者/DEX使用即插即用的 SDK，在 EVM 和 Solana 上创建自己的永续合约 DEX
永续合约聚合器通过 API 或 SDK 直接访问 Orderly 的共享流动性
交易台使用 API 实现 CEX 级交易，并接入低延迟订单簿
交易机器人连接订单簿以获取最佳费率，并执行 SL/限价订单及免 Gas 交易

主要优势

  • 统一的订单簿和流动性：通过单一交易基础设施访问所有主流链
  • 快速开发：使用我们的 SDK，在数天内上线 DEX
  • 即用型流动性：由多家顶级做市商提供支持
  • 收入分成：从平台产生的手续费中赚取分成
  • CEX 级性能：低延迟撮合引擎与链上结算
  • 自行托管：由你掌控资产和私钥
  • 协作生态系统：加入蓬勃发展的构建者社区

架构

你的应用（DEX、机器人、钱包、聚合器）

  • Orderly 基础设施
    • CLOB — 共享的中央限价订单簿（在所有链之间统一）
    • 撮合引擎 — 低延迟订单撮合（CEX 级性能）
    • 金库 — 链上结算，资产由用户自行托管
    • 风险管理 — 清算引擎和仓位监控
  • 结算网络
    • EVM：Arbitrum、Optimism、Base、Ethereum、Polygon、Mantle
    • 非 EVM：Solana

开始使用：AI Agent 工具

要基于 Orderly 构建，建议使用 MCP 服务，以获得最佳开发体验。它提供 9 个强大的工具，用于搜索文档和 SDK 符号、查询合约地址、工作流及 API 参考。你可以连接远程服务（无需安装），也可以通过 npx 在本地安装。

远程 MCP 服务

连接到托管的 MCP 服务 https://mcp.orderly.network，无需安装。它使用 Streamable HTTP 传输，无需身份验证。将你的 AI 客户端的 MCP 配置指向此 URL 即可。

本地 MCP 服务

通过 npx 在本地安装 MCP 服务——支持离线使用，并让你完全掌控。

npx @orderly.network/mcp-server init --client <client>

如果无法自动设置，请手动配置 AI 客户端以运行 npx @orderly.network/mcp-server@latest。

MCP 服务提供的功能（远程和本地均适用）：

工具说明
search_orderly_docs搜索 Orderly 文档和类型准确的 SDK 符号
get_contract_addresses查询任意链上的智能合约地址
explain_workflow常见任务的分步指南
get_api_infoREST API 和 WebSocket 端点文档
get_indexer_api_info交易指标、事件、交易量统计
get_component_guideReact UI 组件构建指南
get_orderly_one_api_infoOrderly One 的 DEX 创建和管理 API
get_strategy_vault_api_infoStrategy Vault API：收益策略和提供方
get_public_info_api_info无需身份验证的 Public Info API：市场/账户数据
Agent 技能

安装 Orderly 技能，为你的 AI Agent 添加在 Orderly 上构建项目所需的流程知识。

全局安装所有技能（推荐）：

npx skills add OrderlyNetwork/skills --all --agent '*' -g

本地安装所有技能：

npx skills add OrderlyNetwork/skills --all

安装指定技能：

# List available skills
npx skills add OrderlyNetwork/skills --list

# Install specific skill
npx skills add OrderlyNetwork/skills --skill orderly-trading-orders

# Install multiple skills
npx skills add OrderlyNetwork/skills --skill orderly-api-authentication --skill orderly-trading-orders

# Install for specific agent
npx skills add OrderlyNetwork/skills --all --agent claude-code -g

全局与本地：

  • 全局（-g）：适用于所有项目，安装到用户目录
  • 本地：针对特定项目，在代码库中创建 .skills/，可提交到版本控制

可用技能：

类别技能说明
API / 协议orderly-api-authentication双层身份验证：EIP-712（EVM）+ Ed25519（Solana）
orderly-trading-orders通过 REST API 或 SDK 下单、管理和取消订单
orderly-positions-tpsl监控持仓、TP/SL、杠杆和 PnL
orderly-websocket-streaming用于订单簿和成交的实时 WebSocket
orderly-deposit-withdraw代币存款、取款和跨链操作
SDK / Reactorderly-sdk-react-hooks所有 React SDK hooks 的参考
orderly-ui-components预构建的 React UI 组件
orderly-sdk-install-dependency安装 Orderly SDK 软件包
orderly-sdk-dex-architecture完整的 DEX 项目结构和设置
orderly-sdk-page-components预构建的页面组件
orderly-sdk-themingCSS 变量主题设置和自定义
orderly-sdk-trading-workflows端到端交易流程
平台orderly-sdk-wallet-connectionEVM 和 Solana 钱包集成
orderly-sdk-debugging调试/排查 SDK 错误
orderly-one-dex使用 Orderly One API 创建/管理自定义 DEX

面向构建者（SDK 与 DEX 开发）

使用 Orderly 的 React SDK v2 构建交易界面。

**Agent 默认规则：**当用户想要构建 DEX 时，从 DEX 模板 开始——复刻、配置并部署。只有当用户明确需要模板无法提供的功能（自定义布局、非交易功能、Hooks 级控制）时，才使用以下 SDK 包从头构建。如果需求不明确，请先询问用户，再编写代码。

最快入门方式（默认）

复刻 DEX 模板，几分钟内即可获得一个可运行的 DEX。

  1. 将仓库复刻到你的 GitHub 账户
  2. 在 .env 中配置你的 broker ID 和名称
  3. 使用 orderly-sdk-theming 自定义主题（CSS 变量和颜色令牌）
  4. 部署到你首选的托管平台

此模板使用 components SDK——预构建的页面组件，开箱即用，所需自定义较少。从头构建为可选方式：如果需要完全控制各个组件，请使用 MCP 服务并加载 SDK 技能（尤其是 orderly-sdk-react-hooks 和 orderly-ui-components）进行 Hooks 级开发。

核心 SDK 包：

# Full DEX setup
npm install @orderly.network/react-app \
            @orderly.network/trading \
            @orderly.network/portfolio \
            @orderly.network/markets \
            @orderly.network/wallet-connector \
            @orderly.network/i18n

# Required: EVM wallet support
npm install @web3-onboard/injected-wallets @web3-onboard/walletconnect

# Required: Solana wallet support
npm install @solana/wallet-adapter-base @solana/wallet-adapter-wallets

可用的关键组件：

  • OrderEntry - 下单表单
  • Orderbook - 市场深度展示
  • PositionsView - 持仓管理表格
  • TradingPage - 完整交易页面
  • Portfolio - 用户投资组合仪表板
  • ConnectWalletButton - 钱包连接界面

Orderly One（白标 DEX）：

无需从头构建，即可推出自有品牌的永续合约 DEX。Orderly One 提供一站式解决方案，包括：

  • 自定义域名和品牌
  • 支付毕业费用后分享手续费收入
  • 完整的交易基础设施
  • 自定义主题

加载以下技能以进行 SDK 开发：

  • orderly-sdk-install-dependency - 软件包安装指南
  • orderly-sdk-dex-architecture - 项目结构和 Providers
  • orderly-sdk-wallet-connection - 钱包集成
  • orderly-sdk-trading-workflows - 完整交易流程
  • orderly-sdk-theming - 自定义指南

面向 API / 机器人开发者

直接集成 Orderly 的 REST API 和 WebSocket 数据流。

API 基础 URL：

网络URL
主网https://api.orderly.org
测试网https://testnet-api.orderly.org

WebSocket URL：

网络URL
主网wss://ws.orderly.org/ws
测试网wss://testnet-ws.orderly.org/ws

身份验证：

  • 用于 API 签名的 Ed25519 密钥对生成
  • 用于 EVM 账户的 EIP-712 钱包签名
  • 用于 Solana 账户的 Ed25519 消息签名

无需身份验证的公开数据：

Public Info API 是一个无需身份验证的单一端点（POST /v1/public/query），涵盖 market、account、platform 和 system 类别下的 24 种查询类型（例如，marketSummary、accountState、orderbook、candles、topAddresses、whaleContext）。可将其用于不需要身份验证交易的机器人和读取操作——传入 type 字段和参数即可，无需签名。可通过 get_public_info_api_info MCP 工具查询各查询类型的准确参数、响应字段、权重和示例。

交易对格式：

PERP_<TOKEN>_USDC

示例：PERP_ETH_USDC、PERP_BTC_USDC、PERP_SOL_USDC

关键端点：

  • POST /v1/order - 下单
  • GET /v1/positions - 获取持仓
  • GET /v1/orders - 获取订单
  • GET /v1/orderbook/{symbol} - 订单簿快照
  • GET /v1/public/futures - 市场信息

加载以下技能以进行 API 开发：

  • orderly-api-authentication - 完整的身份验证设置
  • orderly-trading-orders - 订单管理
  • orderly-positions-tpsl - 持仓管理
  • orderly-websocket-streaming - 实时数据

Orderly CLI

一个终端交易工具（@orderly.network/cli），封装了完整的 Orderly REST API。对 AI 安全：密钥存储在操作系统密钥链中，签名在内部完成，Agent 只能看到结果。orderly --help 涵盖所有功能。

安装与快速开始（测试网）：

npm install -g @orderly.network/cli
orderly wallet-create --type EVM --network testnet
orderly wallet-register --broker-id demo --network testnet
orderly faucet-usdc <address> --chain-id 421614 --network testnet
orderly wallet-add-key --network testnet
orderly auth-list --network testnet
orderly order-place PERP_ETH_USDC BUY MARKET 0.01 --account <id> --network testnet

**注意：**经过身份验证的命令需要 --account（通过 auth-list 获取 ID）。十六进制 ID 必须用引号括起来。默认网络为测试网——生产环境请传入 --network mainnet。Linux 需要 libsecret。

经纪商 ID 与手续费收入

你的经纪商 ID 是 Orderly 将交易量归属到你名下的方式——毕业后，你可以从通过你的经纪商 ID 执行的交易所产生的手续费中分得一部分。这是构建者创收的步骤，而且完全由 Agent 驱动：无需浏览器。

选项成本设置收入
demo免费无——在配置中使用 demo无
自定义经纪商10 USDC（一次性）通过 Orderly One API 自助设置，并使用 x402 付款手续费分成
创建自定义 Broker ID（Agent 流程）

**前提条件：**在 Base（8453）、Arbitrum（42161）或 Ethereum（1）上持有原生 USDC 的 EVM 钱包。对你而言，这笔付款无需 Gas——你在链下签署 EIP-3009 授权，由服务端中继结算，因此不需要 ETH。Base URL：https://dex-api.orderly.network（测试网：https://testnet-dex-api.orderly.network，可用于低成本试运行）。API 的 OpenAPI 规范（https://dex-api.orderly.network/openapi.json）内含采用相同流程的 Agent 快速入门指南。

#步骤调用
1身份验证（EIP-191 personal_sign，仅限 EVM）POST /api/auth/nonce {address} → 对返回的消息签名 → POST /api/auth/verify {address, signature} → Bearer JWT（24 小时）
2创建 DEX 记录POST /api/dex（multipart）：brokerName（3-30 个字符）、integrationType: "custom"——无需托管前端
3查看费用GET /api/graduation/fee-options → { usdc: { amount }, receiverAddress, payerAddress }——payerAddress 必须是你的钱包
4支付费用并注册 Broker（一个请求）POST /api/graduation/graduate?brokerId=…&makerFee=…&takerFee=…&rwaMakerFee=…&rwaTakerFee=…，携带 Bearer——x402 付款，自动完成最终确认
5将钱包注册为 Broker 管理员GET https://api.orderly.org/v1/registration_nonce → EIP-712 签名 → POST /v1/register_account（参见 orderly-api-authentication）
6完成最终确认POST /api/graduation/finalize-admin-wallet，请求体为空 {}，并携带 Bearer
7验证GET /api/graduation/graduation-status，直到 isGraduated: true；GET /api/leaderboard/broker/{brokerId}

x402 步骤（4）详解：首次 POST 会返回 402，并带有 payment-required 响应头（包含 base64 编码的 JSON），其中针对每个受支持的网络（base、arbitrum、ethereum）提供一个 EIP-3009 USDC transferWithAuthorization 选项。使用你的钱包对 EIP-712 授权签名，然后在同一请求中添加 payment-signature 请求头并重试 → 200：转账将在链上结算（交易哈希位于 PAYMENT-RESPONSE 响应头中），并自动注册 Broker。无效参数会在扣费之前被拒绝——返回 400/401，付款会被取消，不会产生任何扣款。使用 @x402/fetch 等 x402 客户端时，只需调用一次 fetch，但其默认的 spendControls.maxAmountPerPayment 为 $1——请将其调高至足以支付费用的额度。

参数：brokerId 为 5-15 个字符，格式为 ^[a-z0-9_-]+$。费用以 bps 为单位，增量为 0.1：makerFee/rwaMakerFee 为 -0.5 至 15（负值表示返利），takerFee/rwaTakerFee 为 1 至 15。例如：maker 为 0、taker 为 5。

**两步模式与恢复：**不带查询参数提交 POST graduate（无需 Bearer——付款本身就是身份验证），然后使用结算交易哈希和 paymentType: "usdc" 调用 POST /api/graduation/verify-tx。如果付款已结算但毕业失败，可通过 POST /api/graduation/refund {txHash, chain} 申请退款（需携带 Bearer，且使用付款方钱包）。

用户也可以通过 dex.orderly.network 上的网页向导完成所有操作。如需查看完整的毕业流程参考（Solana/多签管理员钱包、费用层级、退款恢复），请加载 orderly-one-dex 或查询 get_orderly_one_api_info MCP 工具。

支持的链

Orderly 支持多个 EVM 和非 EVM 链。若要获取当前支持的网络列表及其链 ID、金库地址和 RPC 端点：

GET https://api.orderly.org/v1/public/chain_info

此端点会返回 Orderly 当前支持的所有主网和测试网链，包括 Arbitrum、Optimism、Base、Ethereum、Polygon、Mantle、Solana、Sei、Avalanche、BSC、Abstract 等。

$ORDER 代币

$ORDER 代币是 Orderly 生态系统的核心：

  • 最大供应量： 1,000,000,000 枚代币
  • 质押： 质押 $ORDER 可赚取 VALOR 和协议收入分成
  • VALOR： 用于衡量质押头寸的不可转让指标；可兑换为 esORDER 奖励
  • 收入分成： 协议净手续费的 30% 分配给质押者
  • 治理： 质押者可参与协议治理决策
  • esORDER： 用于奖励的托管 ORDER，带有归属机制

代币合约：

网络地址
Ethereum (ERC20)0xABD4C63d2616A5201454168269031355f4764337
EVM Chains (OFT)0x4E200fE2f3eFb977d5fd9c430A41531FB04d97B8
SolanaABt79MkRXUsoHuV2CVQT32YMXQhTparKFjmidQxgiQ6E

如需了解完整的代币经济详情，请访问：https://orderly.network/docs/introduction/tokenomics

重要链接

资源URL备注
文档https://orderly.network/docs
SDK 仓库https://github.com/orderlynetwork/js-sdk
DEX 模板https://github.com/OrderlyNetwork/dex-template最快上手方式，使用组件 SDK
MCP 服务（远程）https://mcp.orderly.network无需安装
MCP 服务（npm）https://www.npmjs.com/package/@orderly.network/mcp-server本地安装
CLI（npm）https://www.npmjs.com/package/@orderly.network/cli
Skills（npm）https://www.npmjs.com/package/@orderly.network/skills
Skills.shhttps://skills.sh
DEX 仪表板https://dex.orderly.network
Orderly One API 规范https://dex-api.orderly.network/openapi.json内含 Agent 快速入门指南
Orderly Apphttps://app.orderly.network
Discordhttps://discord.gg/OrderlyNetwork
Twitterhttps://twitter.com/OrderlyNetwork

建议的后续步骤

如果你想赚取交易手续费收入：

  1. 按照上文 Broker IDs and Fee Revenue 中的 Agent 流程创建你的 broker ID
  2. 加载 orderly-one-dex，获取完整的上线和 DEX 管理参考
  3. 在你的应用、机器人或 SDK 配置中设置 brokerId，让交易手续费归属于你
  4. 如果用户还想要 DEX 前端，默认使用 DEX Template——参见 For Builders

如果你正在构建 DEX：

  1. 默认方案：分叉 DEX Template——几分钟内即可获得可运行的 DEX，无需配置 SDK
  2. 安装 MCP 服务：npx @orderly.network/mcp-server init，或连接到 https://mcp.orderly.network
  3. 在 .env 中配置你的 broker 设置并自定义主题
  4. 只有当用户需要模板无法提供的功能时，才从头开始构建——加载 orderly-sdk-install-dependency 和 orderly-sdk-dex-architecture；如果不确定，先询问用户
  5. 使用 orderly-sdk-wallet-connection 设置钱包连接

如果你正在构建交易机器人或 API 集成：

  1. 首先加载 orderly-api-authentication
  2. 在本地安装 MCP 服务，或连接到 https://mcp.orderly.network 以查阅 API 参考
  3. 加载 orderly-trading-orders 和 orderly-websocket-streaming

如果你想通过终端进行交易或使用 CLI：

  1. 安装 CLI：npm install -g @orderly.network/cli
  2. 运行 orderly --help 查看所有命令
  3. 按照测试网快速入门操作（6 条命令，参见上文 Orderly CLI 部分）
  4. 测试时使用 --broker-id demo，或通过编程方式创建你自己的 broker ID——参见上文 Broker IDs and Fee Revenue

如果你正在推出白标 DEX：

  1. 安装 MCP 服务以使用 Orderly One API 工具：npx @orderly.network/mcp-server init，或连接到 https://mcp.orderly.network
  2. 加载 orderly-one-dex 技能，了解 DEX 创建和管理工作流
  3. 加载 orderly-sdk-theming 技能，了解用于 API 更新的主题结构

如果你正在排查问题：

  1. 加载 orderly-sdk-debugging
  2. 使用 MCP 服务搜索文档（远程或本地）

测试：

  • 使用测试网环境进行开发
  • 从水龙头申请测试网 USDC：POST /v1/faucet/usdc（仅限测试网）
  • 每个账户最多可使用水龙头 3 次

常见问题

“我应该从哪里开始构建？”

默认方案——快速搭建 DEX：分叉 DEX Template，配置 .env 并部署。使用预构建组件，是最快的途径，也是大多数用户的首选方案。

仅当用户需要更多控制权时：设置 MCP 服务——可以连接到 https://mcp.orderly.network（远程，无需安装），也可以使用 npx @orderly.network/mcp-server init --client <your-client> 在本地安装。然后加载 orderly-sdk-react-hooks 和 orderly-sdk-dex-architecture 等 SDK 技能，使用 hooks SDK 进行构建。如果不确定用户想要哪种方案，请在从头构建前先询问。

接着询问：“如何连接到 Orderly Network？”或加载 orderly-sdk-wallet-connection。

“MCP 服务和 Skills 有什么区别？”
  • MCP Server：供 AI 助手使用的运行时工具（文档搜索、模式查找、API 参考）——可通过 https://mcp.orderly.network 作为远程服务使用，也可通过 npx 在本地安装
  • Skills：嵌入上下文中的流程知识（操作指南、代码示例、最佳实践）

两者结合使用可获得最佳体验。

“如何在没有真实资金的情况下进行测试？”

使用测试网环境：

  • API：https://testnet-api.orderly.org
  • WebSocket：wss://testnet-ws.orderly.org/ws
  • 获取测试 USDC：POST https://testnet-operator-evm.orderly.org/v1/faucet/usdc
“我需要手动处理身份验证吗？”

SDK 会自动处理身份验证。对于仅使用 API 的集成，请加载 orderly-api-authentication，了解完整的身份验证流程。

“如何获取自定义 Broker ID？”

完全通过程序操作，无需浏览器。通过 Orderly One API 创建：完成身份验证（POST /api/auth/nonce → 签名 → POST /api/auth/verify），创建一个 DEX（使用 POST /api/dex，并设置 integrationType: "custom"），通过 x402 端点支付一次性 10 USDC 费用（POST /api/graduation/graduate — 在 Base/Arbitrum/Ethereum 上通过 EIP-3009 USDC 支付，无需支付 Gas），然后将你的钱包绑定为管理员（在 api.orderly.org 上调用 register_account + finalize-admin-wallet）。完整流程请参见上文的 Broker ID 和费用收入；也可以进行测试网试运行。

相关 Skills

API / 协议
  • orderly-api-authentication - 完整的身份验证设置
  • orderly-trading-orders - 订单管理
  • orderly-positions-tpsl - 仓位和风险管理
  • orderly-websocket-streaming - 实时数据流
  • orderly-deposit-withdraw - 资产管理
SDK / React
  • orderly-sdk-react-hooks - React Hooks 参考
  • orderly-ui-components - 预构建 UI 组件
  • orderly-sdk-install-dependency - SDK 安装
  • orderly-sdk-dex-architecture - DEX 架构
  • orderly-sdk-page-components - 页面组件
  • orderly-sdk-theming - 主题指南
  • orderly-sdk-trading-workflows - 交易工作流
平台
  • orderly-sdk-wallet-connection - 钱包集成
  • orderly-sdk-debugging - 调试指南
  • orderly-one-dex - Orderly One DEX 管理

评论

支持 Markdown