futu_core/

proto_id.rs

//! FutuOpenD API 协议 ID 常量
//!
//! 对应 C++ 中 `FTAPI_Define_ProtoID.h` 的定义。客户端与 OpenD 网关之间的
//! 通信协议标识。
//!
//! **Stable API** — 所有常量均为稳定 ABI，外部 binary 可依赖。新增常量不算
//! breaking；修改已有常量值 = breaking（C++ 对齐约束下不应发生）。

// ========== 连接管理 ==========
pub const INIT_CONNECT: u32 = 1001;
pub const GET_GLOBAL_STATE: u32 = 1002;
pub const NOTIFY: u32 = 1003;
pub const KEEP_ALIVE: u32 = 1004;

// ========== 额度查询 ==========
pub const GET_USED_QUOTA: u32 = 1010;

// ========== 行情协议 ==========
pub const QOT_SUB: u32 = 3001;
pub const QOT_REG_QOT_PUSH: u32 = 3002;
pub const QOT_GET_SUB_INFO: u32 = 3003;
pub const QOT_GET_BASIC_QOT: u32 = 3004;
pub const QOT_UPDATE_BASIC_QOT: u32 = 3005;
pub const QOT_GET_KL: u32 = 3006;
pub const QOT_UPDATE_KL: u32 = 3007;
pub const QOT_GET_RT: u32 = 3008;
pub const QOT_UPDATE_RT: u32 = 3009;
pub const QOT_GET_TICKER: u32 = 3010;
pub const QOT_UPDATE_TICKER: u32 = 3011;
pub const QOT_GET_ORDER_BOOK: u32 = 3012;
pub const QOT_UPDATE_ORDER_BOOK: u32 = 3013;
pub const QOT_GET_BROKER: u32 = 3014;
pub const QOT_UPDATE_BROKER: u32 = 3015;
pub const QOT_GET_ORDER_DETAIL: u32 = 3016;
pub const QOT_UPDATE_ORDER_DETAIL: u32 = 3017;

pub const QOT_GET_HISTORY_KL: u32 = 3100;
pub const QOT_GET_HISTORY_KL_POINTS: u32 = 3101;
pub const QOT_REQUEST_HISTORY_KL: u32 = 3103;

pub const QOT_GET_TRADE_DATE: u32 = 3200;
pub const QOT_GET_SUSPEND: u32 = 3201;
pub const QOT_GET_STATIC_INFO: u32 = 3202;
pub const QOT_GET_SECURITY_SNAPSHOT: u32 = 3203;
pub const QOT_GET_PLATE_SET: u32 = 3204;
pub const QOT_GET_PLATE_SECURITY: u32 = 3205;
pub const QOT_GET_REFERENCE: u32 = 3206;
pub const QOT_GET_OWNER_PLATE: u32 = 3207;
pub const QOT_GET_HOLDING_CHANGE_LIST: u32 = 3208;
pub const QOT_GET_OPTION_CHAIN: u32 = 3209;
pub const QOT_GET_REHAB: u32 = 3702;

// 新版 API
pub const QOT_GET_WARRANT: u32 = 3210;
pub const QOT_GET_CAPITAL_FLOW: u32 = 3211;
pub const QOT_GET_CAPITAL_DISTRIBUTION: u32 = 3212;
pub const QOT_GET_USER_SECURITY: u32 = 3213;
pub const QOT_MODIFY_USER_SECURITY: u32 = 3214;
pub const QOT_STOCK_FILTER: u32 = 3215;
pub const QOT_GET_CODE_CHANGE: u32 = 3216;
pub const QOT_GET_IPO_LIST: u32 = 3217;
pub const QOT_GET_FUTURE_INFO: u32 = 3218;
pub const QOT_REQUEST_TRADE_DATE: u32 = 3219;
pub const QOT_SET_PRICE_REMINDER: u32 = 3220;
pub const QOT_GET_PRICE_REMINDER: u32 = 3221;
pub const QOT_GET_USER_SECURITY_GROUP: u32 = 3222;
pub const QOT_GET_MARKET_STATE: u32 = 3223;
pub const QOT_GET_OPTION_EXPIRATION_DATE: u32 = 3224;
pub const QOT_UPDATE_PRICE_REMINDER: u32 = 3019;
pub const QOT_REQUEST_HISTORY_KL_QUOTA: u32 = 3104;
pub const QOT_REQUEST_REHAB: u32 = 3105;

// 交易新版 API
pub const TRD_GET_MARGIN_RATIO: u32 = 2223;
pub const TRD_GET_ORDER_FEE: u32 = 2225;
pub const TRD_FLOW_SUMMARY: u32 = 2226;

// v1.4.94 Tier M (mobile-driven extension): 资金明细 — daemon 自定义 FTAPI cmd
//
// FTAPI client→daemon proto_id (无 OpenD 对应). daemon 内部用 backend TCP cmd
// 3000/3001/3002 (mobile `clt_cmd_trade_cash_log` / `_cash_detail` /
// `_bussiness_type` 同号) 转发到 `realtime_asset_log` microservice.
//
// 见 `proto-internal/realtime_asset_log.proto` 头部注释.
pub const TRD_GET_CASH_LOG: u32 = 22701; // mobile clt_cmd 3000
pub const TRD_GET_CASH_DETAIL: u32 = 22702; // mobile clt_cmd 3001
pub const TRD_GET_BIZ_GROUP: u32 = 22703; // mobile clt_cmd 3002

// daemon→backend NN cmd_id (固定常量, mobile 用同 namespace)
pub const NN_CMD_GET_CASH_LOG: u16 = 3000;
pub const NN_CMD_GET_CASH_DETAIL: u16 = 3001;
pub const NN_CMD_GET_BIZ_GROUP: u16 = 3002;

// v1.4.95 U2-D Tier M (mobile-driven extension): margin account info per market
// FTAPI client→daemon proto_id (单一 endpoint, daemon 按 market 路由 cmd)
pub const TRD_GET_MARGIN_INFO: u32 = 22704;
// daemon→backend NN cmd_id (mobile clt_cmd_*_margin_info 同号, 按市场切)
pub const NN_CMD_HK_MARGIN_INFO: u16 = 3101;
pub const NN_CMD_US_MARGIN_INFO: u16 = 3102;
pub const NN_CMD_CN_AH_MARGIN_INFO: u16 = 3107;

// v1.4.95 U2-A Tier M (mobile-driven extension): account compliance flags
// 用于查询账户合规状态 (产品准入 / 风险评估 / opt-in 标志).
// 高级交易准入 (期权 / 衍生品 / OTC / CFD 等) 强制要求.
pub const TRD_GET_ACCOUNT_FLAG: u32 = 22705; // FTAPI client→daemon
pub const NN_CMD_PULL_ACCOUNT_FLAG: u16 = 5281; // backend NN cmd (NN_ProtoCmd_Pull_AccountFlag)

// v1.4.95 U2-B Tier M (mobile-driven extension): bond holdings + trade prep
// 5 endpoints — 债券 holdings (账户总持仓 / 单只 / 列表) + 交易 prep
// (是否需要答题 / 交易提醒). 仅 HK / US / SG 债券账户有数据, 其他账户优雅返空.
// FTAPI client→daemon proto_id (5 个独立 endpoint, 各自映射 mobile cmd):
pub const TRD_GET_BOND_TOTAL_ASSET: u32 = 22706; // 账户债券总持仓
pub const TRD_GET_BOND_SINGLE_ASSET: u32 = 22707; // 单只债券持仓
pub const TRD_GET_BOND_POSITION_LIST: u32 = 22708; // 账户债券持仓列表
pub const TRD_GET_BOND_ANSWER_STATE: u32 = 22709; // 是否需要答题
pub const TRD_GET_BOND_TRADE_REMINDER: u32 = 22710; // 交易提醒 (是否可买/复杂/高风险等)
// daemon→backend NN cmd_id (mobile clt_cmd_* 同号)
pub const NN_CMD_BOND_TOTAL_ASSET: u16 = 9373; // clt_cmd_cash_treasure_bond_total_asset
pub const NN_CMD_BOND_SINGLE_ASSET: u16 = 9374; // clt_cmd_cash_treasure_bond_single_asset
pub const NN_CMD_BOND_POSITION_LIST: u16 = 9375; // clt_cmd_cash_treasure_bond_account_position
pub const NN_CMD_BOND_ANSWER_STATE: u16 = 10043; // clt_cmd_bond_answer_state
pub const NN_CMD_BOND_TRADE_REMINDER: u16 = 10057; // clt_cmd_bond_trade_reminder

// 其他
pub const VERIFICATION: u32 = 1006;
pub const GET_USER_INFO: u32 = 1005;
pub const GET_DELAY_STATISTICS: u32 = 1007;
pub const TEST_CMD: u32 = 1008;
pub const REMOTE_CMD: u32 = 1009;

// v1.4.98 T2-8 (mobile-source-audit Phase 2): NN+MM token 启用/绑定状态查询.
// 来源: moomoo CFuTuToken.cpp:19 cmd 1326 CS_CMDID_NewToken_GetStateInfo +
// proto futu_token.proto::GetTokenListRequest/Response (4 字段: nn/mm × enable/bind).
// 用户 unlock-trade -20011 时第一线诊断 — 查双系 token 绑定情况.
pub const GET_TOKEN_STATE: u32 = 1326;

// v1.4.98 T2-2 (mobile-source-audit Phase 2): 无风险利率 (期权定价).
// 来源: ftcnnproto/.../risk_free_rate_service.proto cmd 20231 GetRiskFreeRate
// (注释明标"无加密"). 返 HK/US/JP 3 市场无风险利率 (放大 10^9 倍 uint64).
pub const QOT_GET_RISK_FREE_RATE: u32 = 20231;

// v1.4.98 T2-1 (mobile-source-audit Phase 2): 摆盘步长 (spread table).
// 来源: cmd 6503 OpenD baseline 已路由 (NNBase_Define_ProtoCmd.h), daemon 漏 cover.
pub const QOT_GET_SPREAD_TABLE: u32 = 6503;

// v1.4.98 T2-3 (mobile-source-audit Phase 2): 逐笔统计 (TickerStatistic).
// 来源: cmd 6365 (Info) + cmd 6366 (Detail) OpenD baseline +
// proto-internal/FTCmdTickerStatistic6365-6366.proto.
pub const QOT_GET_TICKER_STATISTIC: u32 = 6365;
// v1.4.106 codex 0500 ζ23-redo: cmd 6366 是 "Detail" (StatisticData 列表 +
// max_ratio + have_more), 不是 push. 之前 v1.4.98 误命名 `_PUSH` 0 caller,
// 本版整体重构为 `_DETAIL` 并补 full surface (proto / gateway / REST /
// MCP / CLI / docs / scope / strict-fields 7 层).
pub const QOT_GET_TICKER_STATISTIC_DETAIL: u32 = 6366;

// ========== 交易协议 ==========
pub const TRD_GET_ACC_LIST: u32 = 2001;
pub const TRD_UNLOCK_TRADE: u32 = 2005;
pub const TRD_SUB_ACC_PUSH: u32 = 2008;

/// v1.4.102 codex 44 F1 (P1): daemon-internal proto_id for `/api/unsub-acc-push`.
///
/// **不是真 backend cmd_id** — backend `Trd_SubAccPush` proto 只有
/// `acc_id_list`, 没有 sub/unsub 区分. daemon 用此 internal proto_id 路由到
/// `UnsubAccPushHandler` (调 `unsubscribe_trd_acc` 真撤订阅), 不发 backend.
///
/// **0x80000000 标记 bit**: 内部合成 ID, 不与真 backend cmd_id 冲突. 真
/// backend 看到此 ID 会 reject (但不会到达 backend, daemon-local handler
/// 直接处理). 之前 v1.4.74 直接 forward TRD_SUB_ACC_PUSH 到同一 handler →
/// 实际 silent re-subscribe (codex 44 F1 P1 bug). 现在: REST `/api/unsub-acc-push`
/// 改路由到本 ID, daemon 加 dedicated handler 调 `unsubscribe_trd_acc`.
pub const TRD_UNSUB_ACC_PUSH_INTERNAL: u32 = 0x8000_0000 | 2008;
pub const TRD_GET_FUNDS: u32 = 2101;
pub const TRD_GET_POSITION_LIST: u32 = 2102;
pub const TRD_GET_MAX_TRD_QTYS: u32 = 2111;
pub const TRD_GET_ORDER_LIST: u32 = 2201;
pub const TRD_PLACE_ORDER: u32 = 2202;
pub const TRD_MODIFY_ORDER: u32 = 2205;
pub const TRD_UPDATE_ORDER: u32 = 2208;
pub const TRD_GET_ORDER_FILL_LIST: u32 = 2211;
pub const TRD_UPDATE_ORDER_FILL: u32 = 2218;
pub const TRD_GET_HISTORY_ORDER_LIST: u32 = 2221;
pub const TRD_GET_HISTORY_ORDER_FILL_LIST: u32 = 2222;
pub const TRD_RECONFIRM_ORDER: u32 = 2237;
pub const TRD_NOTIFY: u32 = 2240;

/// **Stable API** — 判断协议 ID 是否为推送类型。
///
/// 跨 futu-net / futu-server 共享判定，避免两处独立 match 漂移。
#[must_use]
pub fn is_push_proto(proto_id: u32) -> bool {
    matches!(
        proto_id,
        NOTIFY
            | QOT_UPDATE_BASIC_QOT
            | QOT_UPDATE_KL
            | QOT_UPDATE_RT
            | QOT_UPDATE_TICKER
            | QOT_UPDATE_ORDER_BOOK
            | QOT_UPDATE_BROKER
            | QOT_UPDATE_ORDER_DETAIL
            | QOT_UPDATE_PRICE_REMINDER
            | TRD_UPDATE_ORDER
            | TRD_UPDATE_ORDER_FILL
            | TRD_NOTIFY
    )
}

#[cfg(test)]
mod tests;