orderly-one-dex

Create and manage a custom DEX using Orderly One API - deployment, custom domains, graduation, and theming

Safety Notice

This listing is imported from skills.sh public index metadata. Review upstream SKILL.md and repository scripts before running.

Copy this and send it to your AI assistant to learn

Install skill "orderly-one-dex" with this command: npx skills add orderlynetwork/skills/orderlynetwork-skills-orderly-one-dex

Orderly Network: Orderly One DEX

Orderly One is a white-label DEX platform. Users configure a DEX (name, branding, chains), the API forks a GitHub template repo, and GitHub Actions deploys to GitHub Pages. Graduated DEXs earn fee splits.

When to Use

  • Creating a custom perpetuals DEX
  • Managing DEX deployment, domains, or themes
  • Handling graduation for fee sharing

API Base URLs

EnvironmentBase URL
Mainnethttps://dex-api.orderly.network
Testnethttps://testnet-dex-api.orderly.network

API Categories

Use get_orderly_one_api_info MCP tool for full endpoint details.

CategoryDescriptionKey Endpoints
authWallet signature authentication/api/auth/nonce, /api/auth/verify, /api/auth/validate
dexDEX CRUD, domains, deployment/api/dex, /api/dex/{id}, /api/dex/{id}/custom-domain, /api/dex/{id}/workflow-status
themeAI theme generation/api/theme/modify, /api/theme/fine-tune
graduationDemo → full DEX with fee sharing/api/graduation/status, /api/graduation/fee-options, /api/graduation/verify-tx
leaderboardCross-DEX rankings/api/leaderboard, /api/leaderboard/broker/{brokerId}
statsPlatform statistics/api/stats, /api/stats/swap-fee-config

Create/Update DEX

Both POST /api/dex (create) and PUT /api/dex/{id} (update) use multipart/form-data.

Required Fields

FieldTypeConstraints
brokerNamestring3-30 chars, alphanumeric/space/dot/hyphen

Optional Fields

Chains:

FieldTypeNotes
chainIdsnumber[] (JSON)e.g. [42161, 10, 8453]
defaultChainnumberDefault chain ID

Branding (files):

FieldTypeMax Size
primaryLogoFile250KB
secondaryLogoFile100KB
faviconFile50KB
pnlPoster0..NFile250KB ea

Theming:

FieldTypeNotes
themeCSSstringCSS variables to override default theme
tradingViewColorConfigstringJSON for chart colors

Social:

FieldTypeNotes
telegramLinkstringURL
discordLinkstringURL
xLinkstringURL

Auth/Wallet:

FieldTypeNotes
walletConnectProjectIdstringWalletConnect project ID
privyAppIdstringPrivy app ID
privyTermsOfUsestringURL to terms
privyLoginMethodsstringComma-separated
enableAbstractWalletbooleanEnable Abstract wallet
disableEvmWalletsbooleanDisable EVM wallets
disableSolanaWalletsbooleanDisable Solana wallets

Network:

FieldTypeNotes
disableMainnetbooleanDisable mainnet
disableTestnetbooleanDisable testnet

Trading:

FieldTypeNotes
swapFeeBpsnumber (0-100)Swap fee in basis points (requires "Swap" in enabledMenus)
symbolListstringComma-separated (PERP_ETH_USDC)

Menus:

FieldTypeNotes
enabledMenusstringComma-separated. Options: Trading, Portfolio, Markets, Leaderboard (defaults), Swap, Rewards, Vaults, Points
customMenusstringFormat: "Name,URL;Name2,URL2"

SEO:

FieldTypeConstraints
seoSiteNamestringmax 100 chars
seoSiteDescriptionstringmax 300 chars
seoSiteLanguagestring"en" or "en-US"
seoSiteLocalestring"en_US"
seoTwitterHandlestring"@handle"
seoThemeColorstring"#1a1b23"
seoKeywordsstringmax 500 chars

Other:

FieldTypeNotes
availableLanguagesstringJSON array. Options: en, zh, tc, ja, es, ko, vi, de, fr, ru, id, tr, it, pt, uk, pl, nl
analyticsScriptstringBase64 encoded
enableServiceDisclaimerDialogbooleanShow disclaimer
enableCampaignsbooleanEnable ORDER token campaigns and Points menu
restrictedRegionsstringComma-separated country names (e.g., "United States,China")
whitelistedIpsstringIP whitelist

Response

Create (201): { id, brokerId, brokerName, repoUrl, userId, createdAt }

Update (200): Full DEX object with all fields

Key Workflows

Authentication

  1. POST /api/auth/nonce with { address } → get message to sign
  2. Sign: "Sign this message to authenticate with Orderly One: {nonce}"
  3. POST /api/auth/verify with { address, signature } → get JWT
  4. Use Authorization: Bearer {token} for all requests

Create DEX Flow

  1. Build multipart/form-data with fields above
  2. POST /api/dex → returns { id, brokerId, repoUrl }
  3. Poll GET /api/dex/{id}/workflow-status until conclusion: "success"

Graduation (Fee Sharing)

  1. GET /api/graduation/fee-options → USDC/ORDER amounts + receiverAddress
  2. Transfer tokens on Ethereum, Arbitrum, or Base to receiverAddress
  3. POST /api/graduation/verify-tx with { txHash, chain, chainId, chainType: "EVM", brokerId, makerFee, takerFee, rwaMakerFee, rwaTakerFee, paymentType } → creates broker ID

After broker ID created, finalize admin wallet:

EVM Wallet: 4. Register with Orderly Network API:

  • GET https://api.orderly.org/v1/registration_nonce
  • Sign EIP-712 typed data: { brokerId, chainId, timestamp, registrationNonce }
  • POST https://api.orderly.org/v1/register_account with { message, signature, userAddress, chainType: "EVM" }
  1. POST /api/graduation/finalize-admin-wallet (empty body)

Solana Wallet: 4. Register with Orderly Network API:

  • GET https://api.orderly.org/v1/registration_nonce
  • Sign message with Solana wallet: { brokerId, chainId: 900900900, timestamp, registrationNonce }
  • POST https://api.orderly.org/v1/register_account with { message, signature, userAddress, chainType: "SOL" }
  1. POST /api/graduation/finalize-admin-wallet (empty body)

EVM Multisig/Gnosis Safe: 4. In Safe Wallet → Transaction Builder → create batch:

  • To: Orderly Vault contract (chain-specific)
  • Method: delegateSigner
  • Data: [keccak256(brokerId), userAddress]
  1. Execute on Safe with required signer approvals
  2. POST /api/graduation/finalize-admin-wallet with { multisigAddress, multisigChainId }

Orderly MCP

This skill references the Orderly MCP server. If not installed, see orderly-onboarding skill for setup.

Tool: get_orderly_one_api_info

  • { endpoint: "/api/dex" } - Specific endpoint details
  • { category: "graduation" } - All endpoints in a category
  • {} - Full API overview

Common Issues

IssueSolution
DEX stuck deployingCheck /api/dex/{id}/workflow-runs/{runId} for job failures
Domain not workingCNAME to {org}.github.io, wait for DNS propagation
Graduation verify failsConfirm tx to receiverAddress, wait for confirmations
Logo upload failsCheck file size limits (250KB primary, 100KB secondary)
Invalid CSSValidate themeCSS syntax before submitting

Related Skills

  • orderly-onboarding - Account setup
  • orderly-trading-orders - Trading functionality

Source Transparency

This detail page is rendered from real SKILL.md content. Trust labels are metadata-based hints, not a safety guarantee.

Open in GitHubOpen in ClawHub

Related Skills

Related by shared tags or category signals.

General

orderly-api-authentication

No summary provided by upstream source.

Repository SourceNeeds Review
-25
orderlynetwork
General

orderly-deposit-withdraw

No summary provided by upstream source.

Repository SourceNeeds Review
-24
orderlynetwork
General

orderly-trading-orders

No summary provided by upstream source.

Repository SourceNeeds Review
-23
orderlynetwork