Integration Checklist

​

Phase 1: Planning & Setup

• Choose an integration path: Pick the stack that matches your product and team.
  • React Hooks
  • React UI components
  • Python connector
  • Direct API access through the EVM API docs
• Set up builder identity: Start from Builder Onboarding. If you are using Orderly One, go to https://dex.orderly.network/ to create your builder ID and continue onboarding.
• Review system design: Read the Building on Orderly, Smart Contract Overview, and Smart Contract Addresses pages.
• Define launch scope: Confirm your core user flows, testnet plan, support process, and go-to-market milestones before development starts.

​

Phase 2: Core Implementation

• Account registration: Let users create and activate their Orderly account.
• Wallet authentication and Orderly Keys: Set up authentication for signed API access and trading actions.
• Deposit and withdrawal: Support funding and withdrawal flows from supported chains.
• Order management: Implement order placement, cancellation, and order state handling.
• Market and symbol data: Integrate market metadata, prices, orderbook data, and trade updates from the WebSocket API and relevant REST endpoints such as available symbols.

​

Phase 3: Advanced Features & Optimization

• Settle PnL: Handle realized PnL settlement as part of the account lifecycle.
• Custom fees: Configure default builder fees and any user-level fee logic you need.
• User data surfaces: Display balances, positions, trade history, and account data using endpoints such as Get account information.
• Regulatory controls: Implement the geo-blocking and compliance checks required for your product and jurisdiction.

​

Phase 4: Testing & Launch Preparation

• Validate on testnet: Run through registration, authentication, deposits, withdrawals, trading, and settlement on testnet before launch.
• Prepare for maintenance: Use the system maintenance status endpoint, ask the Orderly team for builder Telegram channel access, and make sure your UI handles maintenance windows clearly, including any order actions that remain available.
• Review support and launch readiness: Make sure your team has clear ownership for user support, incident communication, and launch coordination with Orderly.

​

AI & API Quick Reference

​

Core Terms

• Builder ID (broker_id): The identifier assigned to your platform during onboarding. It is required in registration and Orderly Key setup flows.
• Orderly Key: An on-chain registered Ed25519 keypair. Use the private key only in the client or backend component that signs private REST and WebSocket requests.
• Strategy Vault vs. OmniVault: Strategy Vault is the underlying smart contract and clearing infrastructure. OmniVault is the official protocol-level vault implementation built on top of it.

​

REST Authentication

orderly-account-id: <account_id>
orderly-key: ed25519:<public_orderly_key>
orderly-timestamp: <current_epoch_ms>
orderly-signature: <computed_signature_base64url>

orderly-timestamp + METHOD + PATH_WITH_QUERY + BODY_STRING

​

Minimal Signing Examples

import { ed25519 } from "@noble/curves/ed25519";
import { base58 } from "@scure/base";

type SignParams = {
  method: "GET" | "POST" | "PUT" | "DELETE";
  path: string;
  body?: Record<string, unknown>;
  timestamp: number;
  orderlySecret: string;
};

export function generateOrderlySignature({
  method,
  path,
  body,
  timestamp,
  orderlySecret
}: SignParams): string {
  const bodyString = body ? JSON.stringify(body) : "";
  const message = `${timestamp}${method}${path}${bodyString}`;
  const privateKey = base58.decode(orderlySecret);
  const signatureBytes = ed25519.sign(new TextEncoder().encode(message), privateKey);

  return Buffer.from(signatureBytes).toString("base64url");
}

import json
from base58 import b58decode
from base64 import urlsafe_b64encode
from cryptography.hazmat.primitives.asymmetric.ed25519 import Ed25519PrivateKey


def generate_orderly_signature(method: str, path: str, body: dict | None, timestamp: int, orderly_secret: str) -> str:
    body_string = json.dumps(body) if body else ""
    message = f"{timestamp}{method}{path}{body_string}"
    private_key = Ed25519PrivateKey.from_private_bytes(b58decode(orderly_secret))
    signature = private_key.sign(message.encode("utf-8"))

    return urlsafe_b64encode(signature).decode("utf-8").rstrip("=")

​

Core REST Endpoints

​

WebSocket Authentication & Heartbeat

• Testnet: wss://testnet-ws-private-evm.orderly.org/v2/ws/private/stream/<account_id>
• Mainnet: wss://ws-private-evm.orderly.org/v2/ws/private/stream/<account_id>
• Signature message: the timestamp only, because method, path, and body are blank for WebSocket authentication.
• Heartbeat: send {"event":"ping"} regularly and expect a pong response.