This monorepo contains the Orderly TypeScript SDKs, React hooks, and UI components for building trading applications.
To integrate the SDKs into your application, start with the SDK documentation and integration templates. To develop the SDKs locally, follow Getting Started.
If you have any questions about the code in this repository, you can also ask .
Start building with Orderly SDKs using these ready-to-use templates:
See the SDK release notes for version updates, new features, bug fixes, and upgrade notices.
- Node.js >= 20.19.0
- pnpm >= 10.0.0; this repository pins pnpm 10.26.2 in
package.json.
Run the following commands from the repository root.
pnpm install
pnpm buildBuild once before starting either development server. Some workspace packages resolve to their dist output, and the playground imports @orderly.network/ui/dist/styles.css. These generated files are not included in a fresh clone. Rebuild affected packages after changing code consumed from dist; see Watching Local Packages.
Use the playground to develop and test application pages:
pnpm devOpen http://localhost:5173, or use the address printed in the terminal if the port is occupied. For URL parameters, environment settings, and wallet modes, see the Playground Configuration.
Use Storybook to develop and inspect individual components and stories:
pnpm storybookOpen http://localhost:6006. Choose either the playground or Storybook for your task; running both is optional.
Run these commands from the repository root:
| Command | Purpose |
|---|---|
pnpm build |
Build workspace packages and generate documentation artifacts through Turbo. |
pnpm build-storybook |
Build the static Storybook site after building workspace dependencies. |
pnpm lint |
Run workspace packages that define a lint script. |
pnpm lint:error |
Run ESLint from the root and report errors only. |
pnpm exec prettier --write README.md apps/storybook/README.md |
Format selected files; replace the paths with the files you changed. |
pnpm --filter @orderly.network/core build |
Rebuild one package whose dependencies have already been built. |
Check the target package's package.json before running tests: packages use different test runners, and some still have placeholder test scripts. For example:
pnpm --filter @orderly.network/react-app test
pnpm --filter @orderly.network/hooks test
pnpm --filter @orderly.network/devkit testThe root pnpm test command currently fails because turbo.json does not define a test task. Run the relevant package's test script directly.
| Directory | Purpose |
|---|---|
packages/ |
SDK packages, including core, hooks, types, utils, UI components, and trading features. |
apps/storybook/ |
Vite playground and Storybook for local development. |
apps/ai-docs/ |
Documentation generators for components and hooks. |
Packages do not all share the same version number: perp, layout packages, DevKit, and SDK Docs have different version series. When upgrading an application, follow the release notes and each package's dependency and peer dependency requirements; do not force every package to the same version number. The badges below show published versions, which may differ from the checked-out source.
All Packages
Public npm packages maintained in this repository. Version badges show the published npm latest version.
| Package | Purpose | Version |
|---|---|---|
| @orderly.network/affiliate | Affiliate dashboards, referral programs, and rebate settings. | |
| @orderly.network/chart | Charts for PnL, assets, and trading volume. | |
| @orderly.network/core | Account management, signing, key storage, and SDK configuration. | |
| @orderly.network/default-evm-adapter | Default EVM wallet adapter. | |
| @orderly.network/default-solana-adapter | Default Solana wallet adapter. | |
| @orderly.network/devkit | Plugin scaffolding, Marketplace management, and MCP / agent skill integrations. | |
| @orderly.network/hooks | React hooks for account state, market data, and trading operations. | |
| @orderly.network/i18n | Translations, locale resources, and internationalization providers. | |
| @orderly.network/layout-core | Shared layout interfaces, runtime, and persistence helpers. | |
| @orderly.network/layout-grid | Resizable grid layouts and trading layout presets. | |
| @orderly.network/layout-split | Resizable split layouts and trading panel components. | |
| @orderly.network/markets | Market lists, favorites, symbol information, and funding views. | |
| @orderly.network/net | REST request helpers and WebSocket connections. | |
| @orderly.network/perp | Perpetual trading calculations for accounts, positions, and orders. | |
| @orderly.network/plugin-core | Plugin registration, extension slots, and component interceptors. | |
| @orderly.network/portfolio | Portfolio pages for assets, performance, and account activity. | |
| @orderly.network/react-app | Application providers, shared configuration, and trading access helpers. | |
| @orderly.network/sdk-docs | SDK documentation retrieval and MCP server. | |
| @orderly.network/trading | Trading pages, order books, trade feeds, and layout components. | |
| @orderly.network/trading-leaderboard | Trading leaderboard pages and ranking components. | |
| @orderly.network/trading-next | Trading page implementation with additional layout controls. | |
| @orderly.network/trading-rewards | Trading rewards pages and components. | |
| @orderly.network/types | Shared TypeScript types, API models, and constants. | |
| @orderly.network/ui | Base UI components, themes, dialogs, and formatting primitives. | |
| @orderly.network/ui-chain-selector | Chain selection widgets, dialogs, and sheets. | |
| @orderly.network/ui-connector | Wallet connection UI, onboarding, and authentication guards. | |
| @orderly.network/ui-leverage | Account and symbol leverage editors. | |
| @orderly.network/ui-notification | Notifications and announcement center components. | |
| @orderly.network/ui-order-entry | Order entry forms, validation feedback, and confirmation dialogs. | |
| @orderly.network/ui-orders | Order lists and order management components. | |
| @orderly.network/ui-positions | Position lists, position actions, and funding fee history. | |
| @orderly.network/ui-scaffold | Application shell, navigation, account menus, and subaccount UI. | |
| @orderly.network/ui-share | PnL sharing dialogs and components. | |
| @orderly.network/ui-tpsl | Take-profit and stop-loss editors and position controls. | |
| @orderly.network/ui-tradingview | TradingView chart integration and display controls. | |
| @orderly.network/ui-transfer | Deposit, withdrawal, transfer, and asset conversion forms. | |
| @orderly.network/utils | Decimal arithmetic, date, formatting, and trading utilities. | |
| @orderly.network/vaults | Vault pages, components, and data access helpers. | |
| @orderly.network/wallet-connector | EVM and Solana wallet connection provider. | |
| @orderly.network/wallet-connector-privy | Wallet connection and user center with Privy integration. | |
| @orderly.network/web3-provider-ethers | Ethers-backed Web3 provider for EVM integration. |