orderly-onboarding
Orderly Network onboarding: omnichain perps infra, MCP server, SDK and CLI quickstart. Also indexes executed Orderly fills into Starchild trade analytics. Use when starting on Orderly (e.g. install Orderly MCP, set up the DEX template, integrate the React SDK, use the orderly CLI), and after executi
By starchild-ai-agent · 7,017 installs
npx skills add starchild-ai-agent/official-skills --skill orderly-onboarding
Source repository · Upstream listing
Orderly Network: Agent Onboarding
Orderly is an omnichain orderbook based trading infrastructure providing perpetual futures liquidity for decentralized exchanges. This skill is your starting point for building on or learning about Orderly Network.
When to Use
First time encountering Orderly Network
Setting up AI agent tools for Orderly development
Understanding the Orderly ecosystem and offerings
Finding the right skill or resource for your task
Understanding what tools are available for AI agents
What is Orderly Network
Orderly is a combination of an orderbook based trading infrastructure and a robust liquidity layer offering perpetual futures orderbooks. Unlike traditional platforms, Orderly doesn't have a front end—it operates at the core of the ecosystem, providing essential services to projects built on top.
Key Characteristics:
Omnichain CLOB : Shared Central Limit Order Book accessible from all major EVM chains and Solana
Backend Infrastructure : No official front end; builders create DEXes and trading interfaces on top
On chain Settlement : All trades settle on chain while maintaining full self custody
Unified Liquidity : One orderbook serves all integrated front ends
Perpetual Futures : Trade BTC, ETH, SOL, and more with up to 50x leverage
Gasless Trading : No gas fees once funds are deposited and trading keys activated
One Click Trading : New trading key pair per session, no further signatures needed
Primary Use Cases:
Use Case Description
Builders/DEXes Create your own Perps DEX on EVM and Solana with plug and play SDKs
Perps Aggregators Access Orderly's shared liquidity directly via API or SDK
Trading Desks Use APIs for CEX level trading with low latency orderbook
Trading Bots Connect to orderbook for best rates, SL/limit orders, gasless transactions
Key Advantages
Unified Orderbook & Liquidity : Access all major chains through a single trading infrastructure
Quick Development : Launch a DEX within days using our SDKs
Ready to Use Liquidity : Powered by multiple top tier market makers
Revenue Sharing : Earn a share of generated fees from your platform
CEX Level Performance : Low latency matching engine with on chain settlement
Self Custody : You control your assets and private keys
Collaborative Ecosystem : Join a thriving community of builders
Architecture
Your Application (DEX, Bot, Wallet, Aggregator)
Orderly Infrastructure
CLOB — Shared Central Limit Order Book (unified across all chains)
Matching Engine — Low latency order matching (CEX level performance)
Vault — On chain settlement with self custody
Risk Management — Liquidation engine and position monitoring
Settlement Networks
EVM : Arbitrum, Optimism, Base, Ethereum, Polygon, Mantle
Non EVM : Solana
Getting Started: AI Agent Tools
To build on Orderly, install the MCP server for the best development experience. It provides 8 powerful tools for documentation search, SDK patterns, contract addresses, workflows, and API reference.
MCP Server (Recommended)
The MCP server provides AI assistants with instant access to Orderly documentation, code patterns, and API references.
Quick Install:
Supported Clients:
Client Command Config File
Claude Code client claude .mcp.json
Cursor client cursor .cursor/mcp.json
VS Code client vscode .vscode/mcp.json
Codex client codex ~/.codex/config.toml
OpenCode client opencode .opencode/mcp.json
Manual Configuration:
If automatic setup doesn't work, add this configuration to your AI client:
Claude Code ( .mcp.json ):
Cursor ( .cursor/mcp.json ):
VS Code ( .vscode/mcp.json ):
OpenCode ( .opencode/mcp.json ):
Codex ( ~/.codex/config.toml ):
What the MCP Server Provides:
Tool Description
search orderly docs Search Orderly documentation for specific topics
get sdk pattern Get code examples for SDK v2 hooks and patterns
get contract addresses Lookup smart contract addresses for any chain
explain workflow Step by step guides for common tasks
get api info REST API and WebSocket endpoint documentation
get indexer api info Trading metrics, events, volume statistics
get component guide React UI component building guides
get orderly one api info DEX creation and management API for Orderly One
Agent Skills
Install Orderly skills to enhance your AI agent with procedural knowledge for building on Orderly.
Install all skills globally (recommended):
Install all skills locally:
Install specific skills:
Global vs Local:
Global ( g ) : Available across all projects, installed to user directory
Local : Project specific, creates .skills/ in repo, can be committed to version control
Available Skills:
Category Skill Description
API / Protocol orderly api authentication Two layer auth: EIP 712 (EVM) + Ed25519 (Solana)
orderly trading orders Place, manage, cancel orders via REST API or SDK
orderly positions tpsl Monitor positions, TP/SL, leverage, PnL
orderly websocket streaming Real time WebSocket for orderbook and executions
orderly deposit withdraw Token deposits, withdrawals, cross chain operations
SDK / React orderly sdk react hooks Reference for all React SDK hooks
orderly ui components Pre built React UI components
orderly sdk install dependency Install Orderly SDK packages
orderly sdk dex architecture Complete DEX project structure and setup
orderly sdk page components Pre built page components
orderly sdk theming CSS variable theming and customization
orderly sdk trading workflows End to end trading flows
Platform orderly sdk wallet connection Wallet integration for EVM and Solana
orderly sdk debugging Debug/troubleshoot SDK errors
orderly one dex Create/manage custom DEX with Orderly One API
For Builders (SDK & DEX Development)
Build custom trading interfaces using Orderly's React SDK v2.
Fastest Way to Get Started (Default for DEX Creation)
Fork the [DEX Template](https://github.com/OrderlyNetwork/dex template) to get a working DEX in minutes.
⚠️ CRITICAL FOR AGENTS — NEVER try to build a DEX by installing @orderly.network/cli :
@orderly.network/cli is a terminal trading tool for placing perp orders, NOT a DEX builder or scaffolding CLI. Installing it pulls keytar (native C++ build via node gyp ), which will OOM kill (SIGKILL / 137) 1GB sandboxes.
Zero install DEX deployment : The official DEX template requires NO heavy installs on the agent box. Fork OrderlyNetwork/dex template to the user's GitHub, configure .env , and let GitHub Actions build and deploy it directly to GitHub Pages for free (or deploy to Vercel/Netlify).
1. Fork the repository OrderlyNetwork/dex template to your GitHub account (or user's GitHub via Composio/gh)
2. Configure .env with your broker ID ( VITE ORDERLY BROKER ID ) and name ( VITE ORDERLY BROKER NAME )
3. Customize your theme in app/styles/theme.css with orderly sdk theming (pure CSS custom properties, no build step needed)
4. Complete the required one time GitHub settings after forking (see template README / AGENTS.md):
Enable Actions : gh api repos/$REPO/actions/permissions X PUT f enabled=true f allowed actions=all
Grant workflow write permissions : gh api repos/$REPO/actions/permissions/workflow X PUT f default workflow permissions=write F can approve pull request reviews=true
Enable GitHub Pages with Actions : gh api repos/$REPO/pages X POST f build type=workflow
(Without these permissions, GitHub Actions will not run and auto deployment will fail.)
5. Push to main — GitHub Actions builds via GitHub hosted runner and publishes to https://<user .github.io/<repo /
This template uses the components SDK — pre built page components that work out of the box with less customization. For full control over individual components, use the MCP server and load SDK skills (especially orderly sdk react hooks and orderly sdk ui components ) for hooks level development.
Core SDK Packages:
Package Manager : Prefer pnpm add (or yarn add ) over npm install — pnpm uses ~⅓ the peak memory during dependency resolution, avoiding memory pressure in resource constrained container environments.
Key Components Available:
OrderEntry Order placement form
Orderbook Market depth display
PositionsView Position management table
TradingPage Full trading page
Portfolio User portfolio dashboard
ConnectWalletButton Wallet connection UI
Orderly One (White Label DEX):
Launch your own branded perpetuals DEX without building from scratch. Orderly One provides a turnkey solution with:
Custom domain and branding
Fee revenue sharing after paying graduation fee
Full trading infrastructure
Custom theme
Load these skills for SDK development:
orderly sdk install dependency Package installation guide
orderly sdk dex architecture Project structure and providers
orderly sdk wallet connection Wallet integration
orderly sdk trading workflows Complete trading flows
orderly sdk theming Customization guide
For API / Bot Developers
Integrate directly with Orderly's REST API and WebSocket streams.
API Base URLs:
Network URL
Mainnet https://api.orderly.org
Testnet https://testnet api.orderly.org
WebSocket URLs:
Network URL
Mainnet wss://ws.orderly.org/ws
Testnet wss://testnet ws.orderly.org/ws
Authentication:
Ed25519 key pair generation for API signing
EIP 712 wallet signatures for EVM accounts
Ed25519 message signing for Solana accounts
Symbol Format:
Examples: PERP ETH USDC , PERP BTC USDC , PERP SOL USDC
Key Endpoints:
POST /v1/order Place order
GET /v1/positions Get positions
GET /v1/orders Get orders
GET /v1/orderbook/{symbol} Orderbook snapshot
GET /v1/public/futures Market info
Load these skills for API development:
orderly api authentication Complete auth setup
orderly trading orders Order management
orderly positions tpsl Position management
orderly websocket streaming Real time data
Orderly CLI (Terminal Trading Only — NOT for DEX Building)
A terminal trading tool ( @orderly.network/cli ) wrapping the Orderly REST API for CLI based trading.
⚠️ Memory Warning : Do NOT install @orderly.network/cli in resource constrained environments (≤1GB RAM). It depends on keytar which triggers native C++ compilation ( node gyp ) and will OOM kill the containe