1---
2name: orderly-onboarding
3version: 1.0.1
4description: Agent onboarding for Orderly Network - omnichain perpetual futures infrastructure, MCP server, skills, and developer quickstart
5---
6 
7# Orderly Network: Agent Onboarding
8 
9Orderly 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.
10 
11## When to Use
12 
13- First time encountering Orderly Network
14- Setting up AI agent tools for Orderly development
15- Understanding the Orderly ecosystem and offerings
16- Finding the right skill or resource for your task
17- Understanding what tools are available for AI agents
18 
19## What is Orderly Network
20 
21Orderly 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.
22 
23**Key Characteristics:**
24 
25- **Omnichain CLOB**: Shared Central Limit Order Book accessible from all major EVM chains and Solana
26- **Backend Infrastructure**: No official front end; builders create DEXes and trading interfaces on top
27- **On-chain Settlement**: All trades settle on-chain while maintaining full self-custody
28- **Unified Liquidity**: One orderbook serves all integrated front-ends
29- **Perpetual Futures**: Trade BTC, ETH, SOL, and more with up to 50x leverage
30- **Gasless Trading**: No gas fees once funds are deposited and trading keys activated
31- **One-Click Trading**: New trading key pair per session, no further signatures needed
32 
33**Primary Use Cases:**
34 
35| Use Case              | Description                                                                |
36| --------------------- | -------------------------------------------------------------------------- |
37| **Builders/DEXes**    | Create your own Perps DEX on EVM and Solana with plug-and-play SDKs        |
38| **Perps Aggregators** | Access Orderly's shared liquidity directly via API or SDK                  |
39| **Trading Desks**     | Use APIs for CEX-level trading with low latency orderbook                  |
40| **Trading Bots**      | Connect to orderbook for best rates, SL/limit orders, gasless transactions |
41 
42## Key Advantages
43 
44- **Unified Orderbook & Liquidity**: Access all major chains through a single trading infrastructure
45- **Quick Development**: Launch a DEX within days using our SDKs
46- **Ready-to-Use Liquidity**: Powered by multiple top-tier market makers
47- **Revenue Sharing**: Earn a share of generated fees from your platform
48- **CEX-Level Performance**: Low latency matching engine with on-chain settlement
49- **Self-Custody**: You control your assets and private keys
50- **Collaborative Ecosystem**: Join a thriving community of builders
51 
52## Architecture
53 
54Your Application (DEX, Bot, Wallet, Aggregator)
55 
56- Orderly Infrastructure
57  - **CLOB** — Shared Central Limit Order Book (unified across all chains)
58  - **Matching Engine** — Low-latency order matching (CEX-level performance)
59  - **Vault** — On-chain settlement with self-custody
60  - **Risk Management** — Liquidation engine and position monitoring
61- Settlement Networks
62  - **EVM**: Arbitrum, Optimism, Base, Ethereum, Polygon, Mantle
63  - **Non-EVM**: Solana
64 
65## Getting Started: AI Agent Tools
66 
67To 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.
68 
69### MCP Server (Recommended)
70 
71The MCP server provides AI assistants with instant access to Orderly documentation, code patterns, and API references.
72 
73**Quick Install:**
74 
75```bash
76npx @orderly.network/mcp-server init --client <client>
77```
78 
79**Supported Clients:**
80 
81| Client      | Command             | Config File            |
82| ----------- | ------------------- | ---------------------- |
83| Claude Code | `--client claude`   | `.mcp.json`            |
84| Cursor      | `--client cursor`   | `.cursor/mcp.json`     |
85| VS Code     | `--client vscode`   | `.vscode/mcp.json`     |
86| Codex       | `--client codex`    | `~/.codex/config.toml` |
87| OpenCode    | `--client opencode` | `.opencode/mcp.json`   |
88 
89**Manual Configuration:**
90 
91If automatic setup doesn't work, add this configuration to your AI client:
92 
93**Claude Code** (`.mcp.json`):
94 
95```json
96{
97  "mcpServers": {
98    "orderly": {
99      "command": "npx",
100      "args": ["@orderly.network/mcp-server@latest"]
101    }
102  }
103}
104```
105 
106**Cursor** (`.cursor/mcp.json`):
107 
108```json
109{
110  "mcpServers": {
111    "orderly": {
112      "command": "npx",
113      "args": ["@orderly.network/mcp-server@latest"]
114    }
115  }
116}
117```
118 
119**VS Code** (`.vscode/mcp.json`):
120 
121```json
122{
123  "servers": {
124    "orderly": {
125      "command": "npx",
126      "args": ["@orderly.network/mcp-server@latest"]
127    }
128  }
129}
130```
131 
132**OpenCode** (`.opencode/mcp.json`):
133 
134```json
135{
136  "$schema": "https://opencode.ai/config.json",
137  "mcp": {
138    "orderly": {
139      "type": "local",
140      "command": ["npx", "@orderly.network/mcp-server@latest"],
141      "enabled": true
142    }
143  }
144}
145```
146 
147**Codex** (`~/.codex/config.toml`):
148 
149```toml
150[mcp_servers.orderly]
151command = "npx"
152args = ["@orderly.network/mcp-server@latest"]
153```
154 
155**What the MCP Server Provides:**
156 
157| Tool                       | Description                                      |
158| -------------------------- | ------------------------------------------------ |
159| `search_orderly_docs`      | Search Orderly documentation for specific topics |
160| `get_sdk_pattern`          | Get code examples for SDK v2 hooks and patterns  |
161| `get_contract_addresses`   | Lookup smart contract addresses for any chain    |
162| `explain_workflow`         | Step-by-step guides for common tasks             |
163| `get_api_info`             | REST API and WebSocket endpoint documentation    |
164| `get_indexer_api_info`     | Trading metrics, events, volume statistics       |
165| `get_component_guide`      | React UI component building guides               |
166| `get_orderly_one_api_info` | DEX creation and management API for Orderly One  |
167 
168### Agent Skills
169 
170Install Orderly skills to enhance your AI agent with procedural knowledge for building on Orderly.
171 
172**Install all skills globally (recommended):**
173 
174```bash
175npx skills add OrderlyNetwork/skills --all --agent '*' -g
176```
177 
178**Install all skills locally:**
179 
180```bash
181npx skills add OrderlyNetwork/skills --all
182```
183 
184**Install specific skills:**
185 
186```bash
187# List available skills
188npx skills add OrderlyNetwork/skills --list
189 
190# Install specific skill
191npx skills add OrderlyNetwork/skills --skill orderly-trading-orders
192 
193# Install multiple skills
194npx skills add OrderlyNetwork/skills --skill orderly-api-authentication --skill orderly-trading-orders
195 
196# Install for specific agent
197npx skills add OrderlyNetwork/skills --all --agent claude-code -g
198```
199 
200**Global vs Local:**
201 
202- **Global (`-g`)**: Available across all projects, installed to user directory
203- **Local**: Project-specific, creates `.skills/` in repo, can be committed to version control
204 
205**Available Skills:**
206 
207| Category           | Skill                            | Description                                         |
208| ------------------ | -------------------------------- | --------------------------------------------------- |
209| **API / Protocol** | `orderly-api-authentication`     | Two-layer auth: EIP-712 (EVM) + Ed25519 (Solana)    |
210|                    | `orderly-trading-orders`         | Place, manage, cancel orders via REST API or SDK    |
211|                    | `orderly-positions-tpsl`         | Monitor positions, TP/SL, leverage, PnL             |
212|                    | `orderly-websocket-streaming`    | Real-time WebSocket for orderbook and executions    |
213|                    | `orderly-deposit-withdraw`       | Token deposits, withdrawals, cross-chain operations |
214| **SDK / React**    | `orderly-sdk-react-hooks`        | Reference for all React SDK hooks                   |
215|                    | `orderly-ui-components`          | Pre-built React UI components                       |
216|                    | `orderly-sdk-install-dependency` | Install Orderly SDK packages                        |
217|                    | `orderly-sdk-dex-architecture`   | Complete DEX project structure and setup            |
218|                    | `orderly-sdk-page-components`    | Pre-built page components                           |
219|                    | `orderly-sdk-theming`            | CSS variable theming and customization              |
220|                    | `orderly-sdk-trading-workflows`  | End-to-end trading flows                            |
221| **Platform**       | `orderly-sdk-wallet-connection`  | Wallet integration for EVM and Solana               |
222|                    | `orderly-sdk-debugging`          | Debug/troubleshoot SDK errors                       |
223|                    | `orderly-one-dex`                | Create/manage custom DEX with Orderly One API       |
224 
225## For Builders (SDK & DEX Development)
226 
227Build custom trading interfaces using Orderly's React SDK v2.
228 
229### Fastest Way to Get Started
230 
231Fork the **[DEX Template](https://github.com/OrderlyNetwork/dex-template)** to get a working DEX in minutes.
232 
2331. Fork the repository to your GitHub account
2342. Configure `.env` with your broker ID and name
2353. Customize your theme with **orderly-sdk-theming** (CSS variables and color tokens)
2364. Deploy to your preferred hosting platform
237 
238This 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.
239 
240**Core SDK Packages:**
241 
242```bash
243# Full DEX setup
244npm install @orderly.network/react-app \
245            @orderly.network/trading \
246            @orderly.network/portfolio \
247            @orderly.network/markets \
248            @orderly.network/wallet-connector \
249            @orderly.network/i18n
250 
251# Required: EVM wallet support
252npm install @web3-onboard/injected-wallets @web3-onboard/walletconnect
253 
254# Required: Solana wallet support
255npm install @solana/wallet-adapter-base @solana/wallet-adapter-wallets
256```
257 
258**Key Components Available:**
259 
260- `OrderEntry` - Order placement form
261- `Orderbook` - Market depth display
262- `PositionsView` - Position management table
263- `TradingPage` - Full trading page
264- `Portfolio` - User portfolio dashboard
265- `ConnectWalletButton` - Wallet connection UI
266 
267**Orderly One (White-Label DEX):**
268 
269Launch your own branded perpetuals DEX without building from scratch. Orderly One provides a turnkey solution with:
270 
271- Custom domain and branding
272- Fee revenue sharing after paying graduation fee
273- Full trading infrastructure
274- Custom theme
275 
276**Load these skills for SDK development:**
277 
278- **orderly-sdk-install-dependency** - Package installation guide
279- **orderly-sdk-dex-architecture** - Project structure and providers
280- **orderly-sdk-wallet-connection** - Wallet integration
281- **orderly-sdk-trading-workflows** - Complete trading flows
282- **orderly-sdk-theming** - Customization guide
283 
284## For API / Bot Developers
285 
286Integrate directly with Orderly's REST API and WebSocket streams.
287 
288**API Base URLs:**
289 
290| Network | URL                               |
291| ------- | --------------------------------- |
292| Mainnet | `https://api.orderly.org`         |
293| Testnet | `https://testnet-api.orderly.org` |
294 
295**WebSocket URLs:**
296 
297| Network | URL                               |
298| ------- | --------------------------------- |
299| Mainnet | `wss://ws.orderly.org/ws`         |
300| Testnet | `wss://testnet-ws.orderly.org/ws` |
301 
302**Authentication:**
303 
304- Ed25519 key pair generation for API signing
305- EIP-712 wallet signatures for EVM accounts
306- Ed25519 message signing for Solana accounts
307 
308**Symbol Format:**
309 
310```
311PERP_<TOKEN>_USDC
312```
313 
314Examples: `PERP_ETH_USDC`, `PERP_BTC_USDC`, `PERP_SOL_USDC`
315 
316**Key Endpoints:**
317 
318- `POST /v1/order` - Place order
319- `GET /v1/positions` - Get positions
320- `GET /v1/orders` - Get orders
321- `GET /v1/orderbook/{symbol}` - Orderbook snapshot
322- `GET /v1/public/futures` - Market info
323 
324**Load these skills for API development:**
325 
326- **orderly-api-authentication** - Complete auth setup
327- **orderly-trading-orders** - Order management
328- **orderly-positions-tpsl** - Position management
329- **orderly-websocket-streaming** - Real-time data
330 
331## Orderly CLI
332 
333A terminal trading tool (`@orderly.network/cli`) wrapping the full Orderly REST API. **AI-safe**: keys in OS keychain, signing internal, agents only see results. `orderly --help` covers everything.
334 
335**Install & Quick Start (Testnet):**
336 
337```bash
338npm install -g @orderly.network/cli
339orderly wallet-create --type EVM --network testnet
340orderly wallet-register --broker-id demo --network testnet
341orderly faucet-usdc <address> --chain-id 421614 --network testnet
342orderly wallet-add-key --network testnet
343orderly auth-list --network testnet
344orderly order-place PERP_ETH_USDC BUY MARKET 0.01 --account <id> --network testnet
345```
346 
347**Note:** `--account` is required for authenticated commands (get IDs via `auth-list`). Hex IDs must be shell-quoted. Default network is testnet — pass `--network mainnet` for production. Linux requires `libsecret`.
348 
349### Broker IDs
350 
351- **`demo`** — For testing, development, and personal use. No setup required.
352- **Custom** — Go to [dex.orderly.network](https://dex.orderly.network), select **"Custom API integration"**. Costs **$10**, requires manual browser interaction (cannot be done via CLI or agent).
353 
354## Supported Chains
355 
356Orderly supports multiple EVM and non-EVM chains. To get the current list of supported networks with their chain IDs, vault addresses, and RPC endpoints:
357 
358```
359GET https://api.orderly.org/v1/public/chain_info
360```
361 
362This endpoint returns all mainnet and testnet chains currently supported by Orderly, including Arbitrum, Optimism, Base, Ethereum, Polygon, Mantle, Solana, Sei, Avalanche, BSC, Abstract, and more.
363 
364## $ORDER Token
365 
366The $ORDER token is central to the Orderly ecosystem:
367 
368- **Maximum Supply:** 1,000,000,000 tokens
369- **Staking:** Stake $ORDER to earn VALOR and protocol revenue share
370- **VALOR:** Non-transferable metric measuring staking position; redeemable for esORDER rewards
371- **Revenue Sharing:** 30% of protocol net fees distributed to stakers
372- **Governance:** Stakers participate in protocol governance decisions
373- **esORDER:** Escrowed ORDER for rewards with vesting mechanics
374 
375**Token Contracts:**
376 
377| Network          | Address                                        |
378| ---------------- | ---------------------------------------------- |
379| Ethereum (ERC20) | `0xABD4C63d2616A5201454168269031355f4764337`   |
380| EVM Chains (OFT) | `0x4E200fE2f3eFb977d5fd9c430A41531FB04d97B8`   |
381| Solana           | `ABt79MkRXUsoHuV2CVQT32YMXQhTparKFjmidQxgiQ6E` |
382 
383For full tokenomics details, visit: https://orderly.network/docs/introduction/tokenomics
384 
385## Key Links
386 
387| Resource              | URL                                                                    | Notes                                          |
388| --------------------- | ---------------------------------------------------------------------- | ---------------------------------------------- |
389| Documentation         | https://orderly.network/docs                                           |                                                |
390| SDK Repository        | https://github.com/orderlynetwork/js-sdk                               |                                                |
391| DEX Template  | https://github.com/OrderlyNetwork/dex-template       | Fastest start, uses components SDK             |
392| MCP Server (npm) | https://www.npmjs.com/package/@orderly.network/mcp-server |
393| CLI (npm)        | https://www.npmjs.com/package/@orderly.network/cli        |
394| Skills (npm)     | https://www.npmjs.com/package/@orderly.network/skills     |
395| Skills.sh        | https://skills.sh                                          |
396| DEX Dashboard    | https://dex.orderly.network                               |
397| Orderly App      | https://app.orderly.network                               |
398| Discord          | https://discord.gg/OrderlyNetwork                         |
399| Twitter          | https://twitter.com/OrderlyNetwork                        |
400 
401## Recommended Next Steps
402 
403**If you're building a DEX:**
404 
4051. Fork the **[DEX Template](https://github.com/OrderlyNetwork/dex-template)** for the fastest start
4062. Install MCP server: `npx @orderly.network/mcp-server init`
4073. Configure your broker settings in `.env` and customize your theme
4084. For more control, load **orderly-sdk-install-dependency** and **orderly-sdk-dex-architecture** to build from scratch
4095. Set up wallet connection with **orderly-sdk-wallet-connection**
410 
411**If you're building trading bots or API integrations:**
412 
4131. Load **orderly-api-authentication** first
4142. Install MCP server for API reference
4153. Load **orderly-trading-orders** and **orderly-websocket-streaming**
416 
417**If you want to trade from the terminal or use the CLI:**
418 
4191. Install the CLI: `npm install -g @orderly.network/cli`
4202. Run `orderly --help` to see all commands
4213. Follow the testnet quick start (6 commands, see Orderly CLI section above)
4224. Use `--broker-id demo` for testing, or get a custom broker ID at [dex.orderly.network](https://dex.orderly.network) ($10, manual browser interaction required)
423 
424**If you're launching a white-label DEX:**
425 
4261. Install MCP server for Orderly One API tools: `npx @orderly.network/mcp-server init`
4272. Load **orderly-one-dex** skill for DEX creation and management workflows
4283. Load **orderly-sdk-theming** skill to understand theme structure for API updates
429 
430**If you're troubleshooting:**
431 
4321. Load **orderly-sdk-debugging**
4332. Use MCP server to search documentation
434 
435**For testing:**
436 
437- Use Testnet environment for development
438- Request testnet USDC from the faucet: `POST /v1/faucet/usdc` (testnet only)
439- Each account can use faucet up to 3 times
440 
441## Common Issues
442 
443### "Where do I start building?"
444 
445**For a quick DEX**: Fork the [DEX Template](https://github.com/OrderlyNetwork/dex-template), configure `.env`, and deploy. Uses pre-built components — fastest path.
446 
447**For more control**: Install the MCP server first: `npx @orderly.network/mcp-server init --client <your-client>`, then load SDK skills like **orderly-sdk-react-hooks** and **orderly-sdk-dex-architecture** to build with the hooks SDK.
448 
449Then ask: "How do I connect to Orderly Network?" or load **orderly-sdk-wallet-connection**.
450 
451### "What's the difference between MCP server and Skills?"
452 
453- **MCP Server**: Runtime tools for your AI assistant (documentation search, pattern lookup, API reference)
454- **Skills**: Procedural knowledge embedded in your context (how-to guides, code examples, best practices)
455 
456Use both for the best experience.
457 
458### "How do I test without real funds?"
459 
460Use the Testnet environment:
461 
462- API: `https://testnet-api.orderly.org`
463- WebSocket: `wss://testnet-ws.orderly.org/ws`
464- Get test USDC: `POST https://testnet-operator-evm.orderly.org/v1/faucet/usdc`
465 
466### "Do I need to handle authentication manually?"
467 
468The SDK handles authentication automatically. For API-only integration, load **orderly-api-authentication** for the complete auth flow.
469 
470### "How do I get a custom broker ID?"
471 
472Go to [dex.orderly.network](https://dex.orderly.network), select the **"Custom API integration"** option, and follow the steps. It costs **$10**. This requires manual browser interaction and cannot be done via CLI or agent. For testing and development, use `--broker-id demo` — no setup needed.
473 
474## Related Skills
475 
476### API / Protocol
477 
478- **orderly-api-authentication** - Complete authentication setup
479- **orderly-trading-orders** - Order management
480- **orderly-positions-tpsl** - Position and risk management
481- **orderly-websocket-streaming** - Real-time data streaming
482- **orderly-deposit-withdraw** - Asset management
483 
484### SDK / React
485 
486- **orderly-sdk-react-hooks** - React hooks reference
487- **orderly-ui-components** - Pre-built UI components
488- **orderly-sdk-install-dependency** - SDK installation
489- **orderly-sdk-dex-architecture** - DEX architecture
490- **orderly-sdk-page-components** - Page components
491- **orderly-sdk-theming** - Theming guide
492- **orderly-sdk-trading-workflows** - Trading workflows
493 
494### Platform
495 
496- **orderly-sdk-wallet-connection** - Wallet integration
497- **orderly-sdk-debugging** - Debugging guide
498- **orderly-one-dex** - Orderly One DEX management
499