Skip to content
OrderlyNetworkPublic

About

A JS SDK for interactions with Orderly Network

Resources

Stars

19 stars

Watchers

2 watching

Forks

Latest commit

 

History

8,188 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Orderly SDKs

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 DeepWiki.

Integration Templates

Start building with Orderly SDKs using these ready-to-use templates:

Release Notes

See the SDK release notes for version updates, new features, bug fixes, and upgrade notices.

Getting Started

Prerequisites

  • 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.

Install Dependencies and Build

pnpm install
pnpm build

Build 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.

Run the Vite Playground

Use the playground to develop and test application pages:

pnpm dev

Open 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.

Run Storybook

Use Storybook to develop and inspect individual components and stories:

pnpm storybook

Open http://localhost:6006. Choose either the playground or Storybook for your task; running both is optional.

Development Commands

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.

Tests

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 test

The root pnpm test command currently fails because turbo.json does not define a test task. Run the relevant package's test script directly.

Repository Structure

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

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/affiliate npm version
@orderly.network/chart Charts for PnL, assets, and trading volume. @orderly.network/chart npm version
@orderly.network/core Account management, signing, key storage, and SDK configuration. @orderly.network/core npm version
@orderly.network/default-evm-adapter Default EVM wallet adapter. @orderly.network/default-evm-adapter npm version
@orderly.network/default-solana-adapter Default Solana wallet adapter. @orderly.network/default-solana-adapter npm version
@orderly.network/devkit Plugin scaffolding, Marketplace management, and MCP / agent skill integrations. @orderly.network/devkit npm version
@orderly.network/hooks React hooks for account state, market data, and trading operations. @orderly.network/hooks npm version
@orderly.network/i18n Translations, locale resources, and internationalization providers. @orderly.network/i18n npm version
@orderly.network/layout-core Shared layout interfaces, runtime, and persistence helpers. @orderly.network/layout-core npm version
@orderly.network/layout-grid Resizable grid layouts and trading layout presets. @orderly.network/layout-grid npm version
@orderly.network/layout-split Resizable split layouts and trading panel components. @orderly.network/layout-split npm version
@orderly.network/markets Market lists, favorites, symbol information, and funding views. @orderly.network/markets npm version
@orderly.network/net REST request helpers and WebSocket connections. @orderly.network/net npm version
@orderly.network/perp Perpetual trading calculations for accounts, positions, and orders. @orderly.network/perp npm version
@orderly.network/plugin-core Plugin registration, extension slots, and component interceptors. @orderly.network/plugin-core npm version
@orderly.network/portfolio Portfolio pages for assets, performance, and account activity. @orderly.network/portfolio npm version
@orderly.network/react-app Application providers, shared configuration, and trading access helpers. @orderly.network/react-app npm version
@orderly.network/sdk-docs SDK documentation retrieval and MCP server. @orderly.network/sdk-docs npm version
@orderly.network/trading Trading pages, order books, trade feeds, and layout components. @orderly.network/trading npm version
@orderly.network/trading-leaderboard Trading leaderboard pages and ranking components. @orderly.network/trading-leaderboard npm version
@orderly.network/trading-next Trading page implementation with additional layout controls. @orderly.network/trading-next npm version
@orderly.network/trading-rewards Trading rewards pages and components. @orderly.network/trading-rewards npm version
@orderly.network/types Shared TypeScript types, API models, and constants. @orderly.network/types npm version
@orderly.network/ui Base UI components, themes, dialogs, and formatting primitives. @orderly.network/ui npm version
@orderly.network/ui-chain-selector Chain selection widgets, dialogs, and sheets. @orderly.network/ui-chain-selector npm version
@orderly.network/ui-connector Wallet connection UI, onboarding, and authentication guards. @orderly.network/ui-connector npm version
@orderly.network/ui-leverage Account and symbol leverage editors. @orderly.network/ui-leverage npm version
@orderly.network/ui-notification Notifications and announcement center components. @orderly.network/ui-notification npm version
@orderly.network/ui-order-entry Order entry forms, validation feedback, and confirmation dialogs. @orderly.network/ui-order-entry npm version
@orderly.network/ui-orders Order lists and order management components. @orderly.network/ui-orders npm version
@orderly.network/ui-positions Position lists, position actions, and funding fee history. @orderly.network/ui-positions npm version
@orderly.network/ui-scaffold Application shell, navigation, account menus, and subaccount UI. @orderly.network/ui-scaffold npm version
@orderly.network/ui-share PnL sharing dialogs and components. @orderly.network/ui-share npm version
@orderly.network/ui-tpsl Take-profit and stop-loss editors and position controls. @orderly.network/ui-tpsl npm version
@orderly.network/ui-tradingview TradingView chart integration and display controls. @orderly.network/ui-tradingview npm version
@orderly.network/ui-transfer Deposit, withdrawal, transfer, and asset conversion forms. @orderly.network/ui-transfer npm version
@orderly.network/utils Decimal arithmetic, date, formatting, and trading utilities. @orderly.network/utils npm version
@orderly.network/vaults Vault pages, components, and data access helpers. @orderly.network/vaults npm version
@orderly.network/wallet-connector EVM and Solana wallet connection provider. @orderly.network/wallet-connector npm version
@orderly.network/wallet-connector-privy Wallet connection and user center with Privy integration. @orderly.network/wallet-connector-privy npm version
@orderly.network/web3-provider-ethers Ethers-backed Web3 provider for EVM integration. @orderly.network/web3-provider-ethers npm version

About

A JS SDK for interactions with Orderly Network

Resources

Stars

19 stars

Watchers

2 watching

Forks

Releases

Packages

Used by

Contributors

Languages