Back to Details

okx-trading

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

OKX Provider Broker Skill

OKX Provider Broker Skill

Use this workflow when editing 
src/providers/okx/*
.
在编辑
src/providers/okx/*
文件时使用本工作流。

1. Load only needed references

1. 仅加载所需参考资料

  • For SDK usage patterns and method names, read 
    references/okx-sdk-usage.md
    .
  • For error-to-action mapping, read 
    references/okx-error-map.md
    .
  • For full source context, consult 
    .trae/okx-api-llm.txt
    only for missing details.
  • 如需了解SDK使用模式和方法名称，请阅读
    references/okx-sdk-usage.md
    。
  • 如需错误与操作的映射关系，请阅读
    references/okx-error-map.md
    。
  • 如需完整源码上下文，仅在缺少细节时参考
    .trae/okx-api-llm.txt
    。

2. Keep architecture compatibility

2. 保持架构兼容性

  • Preserve compatibility with 
    src/providers/types.ts
    (
    BrokerProvider
    , 
    MarketDataProvider
    , 
    OptionsProvider
    ).
  • Put OKX-specific expanded APIs behind OKX provider interfaces (for example 
    OkxTradingProvider
    ) while keeping generic provider methods working.
  • Ensure 
    src/providers/broker-factory.ts
    can return OKX providers without adapter breakage.
  • 保持与
    src/providers/types.ts
    中定义的
    BrokerProvider
    、
    MarketDataProvider
    、
    OptionsProvider
    兼容。
  • 将OKX特有的扩展API置于OKX提供商接口（例如
    OkxTradingProvider
    ）之下，同时确保通用提供商方法可正常工作。
  • 确保
    src/providers/broker-factory.ts
    可返回OKX提供商，且不会导致适配器崩溃。

3. Enforce auth and signing rules

3. 强制执行认证与签名规则

  • Require all three credentials: API key, secret, passphrase.
  • Use OKX signing prehash: 
    timestamp + UPPERCASE_METHOD + requestPathWithQuery + rawBody
    .
  • Use HMAC SHA256 base64 signing for both REST and private websocket auth via 
    customSignMessageFn
    .
  • Pass 
    demoTrading: true
    for simulated trading.
  • 要求提供全部三种凭证：API密钥、Secret、Passphrase。
  • 使用OKX签名预哈希规则：
    timestamp + UPPERCASE_METHOD + requestPathWithQuery + rawBody
    。
  • 通过
    customSignMessageFn
    对REST和私有WebSocket认证采用HMAC SHA256 base64签名。
  • 模拟交易时传入
    demoTrading: true
    。

4. Trading and market coverage minimums

4. 交易与市场覆盖要求

  • Trading: spot, margin, swap/futures, options order placement + cancel/query + list.
  • Account: balances, positions, bills/transactions, fills.
  • Market data: ticker(s), order book, trades, candles, instruments.
  • Websocket: ticker, orderbook, trades, candles, account/orders/positions subscriptions.
  • 交易：支持现货、杠杆、永续合约/期货、期权的下单 + 撤单/查询 + 订单列表。
  • 账户：支持余额、持仓、账单/交易记录、成交记录查询。
  • 市场数据：支持行情报价、订单簿、交易记录、K线、交易品种查询。
  • WebSocket：支持行情报价、订单簿、交易记录、K线、账户/订单/持仓订阅。

5. Error and rate-limit behavior

5. 错误与速率限制处理

  • Parse and map OKX 
    code
    + 
    msg
    errors into internal error categories.
  • Handle known auth/order/risk/rate-limit codes explicitly.
  • Apply request throttling + retry with exponential backoff and jitter for retryable failures.
  • Avoid retrying invalid input/auth failures.
  • 解析并将OKX的
    code
    + 
    msg
    错误映射到内部错误分类。
  • 显式处理已知的认证/订单/风险/速率限制错误码。
  • 对可重试失败应用请求限流 + 带指数退避和抖动的重试机制。
  • 避免重试无效输入/认证失败。

6. Documentation requirements for code changes

6. 代码变更的文档要求

  • Update 
    src/providers/okx/README.md
    with examples that match current method names.
  • Include one example each for: spot order, futures order, option order, account history, websocket subscription.
  • Keep examples SDK-realistic and aligned with 
    references/okx-sdk-usage.md
    .
  • 更新
    src/providers/okx/README.md
    ，添加与当前方法名称匹配的示例。
  • 每种类型至少包含一个示例：现货订单、期货订单、期权订单、账户历史、WebSocket订阅。
  • 确保示例符合SDK实际使用场景，并与
    references/okx-sdk-usage.md
    保持一致。