ek-ctp 0.12.4

//! CTP 数据行的内部规范形态(wire)。
//!
//! 来源:原稿 `enkeep_ctp/enkeep_ctp/gateway/ctp_gateway.py` 各回调**实际取用的
//! 字段子集**(TThostFtdc*Field 的窄面)。原生 FFI 镜像(native 特性,0.2.0)将
//! C++ 结构体逐字段搬进这些结构;mock 测试直接构造 wire 行。
//!
//! - 数值统一 `f64`/整数用 `i64`:ek-data 对象面如此,零损耗复制。
//! - 码值字符串(状态/方向/开平/条件)保持 CTP 原值(如 `'3'`),翻译发生在
//!   [`crate::map`]——wire 永远是"未解释"面。

/// CTP 响应错误行(`CThostFtdcRspInfoField` 窄面:ErrorID/ErrorMsg)。
#[derive(Debug, Clone, PartialEq, Eq, Default)]
pub struct ErrorField {
    /// 错误代码(0 = 成功)
    pub error_id: i32,
    /// 错误信息
    pub error_msg: String,
}

impl ErrorField {
    /// 空错误(成功语义,原稿 `if not error["ErrorID"]` 的对偶面)。
    pub fn ok() -> Self {
        Self {
            error_id: 0,
            error_msg: String::new(),
        }
    }
}

/// 深度行情行(`CThostFtdcDepthMarketDataField` 窄面;md `onRtnDepthMarketData`
/// 336 处实际取用字段)。
///
/// 原稿取用:InstrumentID/Volume/Turnover/OpenInterest/LastPrice/UpperLimitPrice/
/// LowerLimitPrice/OpenPrice/HighestPrice/LowestPrice/PreClosePrice/BidPrice1..5/
/// AskPrice1..5/BidVolume1..5/AskVolume1..5/UpdateTime/UpdateMillisec/ActionDay。
#[derive(Debug, Clone, PartialEq, Default)]
pub struct DepthMarketData {
    /// 合约代码(CTP InstrumentID,不带交易所)
    pub instrument_id: String,
    /// 交易所代码(0.12.0 `D-XFALLBACK` 新增的镜像字段)。
    ///
    /// 原稿**不读**这个字段(它用合约表查交易所),所以这是本数据面比原稿多的
    /// 一个字段 —— 记档偏差见 DESIGN `D-XFALLBACK`。
    ///
    /// 存在的唯一理由:合约不在册时,没有它就判不出交易所,只能把整条行情丢掉。
    /// 柜台的 `CThostFtdcDepthMarketDataField` 本来就带 `ExchangeID`,读它是
    /// **取用既有事实**,不是猜。
    pub exchange_id: String,
    /// 最新价(MAX_FLOAT 表全停板,原稿 331 行 `adjust_price` 归零处理)
    pub last_price: f64,
    /// 当日累计成交量
    pub volume: f64,
    /// 当日累计成交额
    pub turnover: f64,
    /// 持仓量
    pub open_interest: f64,
    /// 涨停价
    pub upper_limit_price: f64,
    /// 跌停价
    pub lower_limit_price: f64,
    /// 今开
    pub open_price: f64,
    /// 最高
    pub highest_price: f64,
    /// 最低
    pub lowest_price: f64,
    /// 昨收
    pub pre_close_price: f64,
    /// 买一价..买五价(MAX_FLOAT 时 `adjust_price` 归零)
    pub bid_price1: f64,
    /// 买二价
    pub bid_price2: f64,
    /// 买三价
    pub bid_price3: f64,
    /// 买四价
    pub bid_price4: f64,
    /// 买五价
    pub bid_price5: f64,
    /// 卖一价
    pub ask_price1: f64,
    /// 卖二价
    pub ask_price2: f64,
    /// 卖三价
    pub ask_price3: f64,
    /// 卖四价
    pub ask_price4: f64,
    /// 卖五价
    pub ask_price5: f64,
    /// 买一量
    pub bid_volume1: f64,
    /// 买二量
    pub bid_volume2: f64,
    /// 买三量
    pub bid_volume3: f64,
    /// 买四量
    pub bid_volume4: f64,
    /// 买五量
    pub bid_volume5: f64,
    /// 卖一量
    pub ask_volume1: f64,
    /// 卖二量
    pub ask_volume2: f64,
    /// 卖三量
    pub ask_volume3: f64,
    /// 卖四量
    pub ask_volume4: f64,
    /// 卖五量
    pub ask_volume5: f64,
    /// 更新时间("HH:MM:SS")
    pub update_time: String,
    /// 更新毫秒段
    pub update_millisec: i64,
    /// 交易日("YYYYMMDD";报文 `TradingDay` 原值,业务日的权威来源。记档偏差:
    /// 原稿不读该字段,这是从 DepthMarketData 上岸的唯一新字段,见 DESIGN D-TZ)
    pub trading_day: String,
    /// 行动日("YYYYMMDD")
    pub action_day: String,
}

/// 合约行(`CThostFtdcInstrumentField` 窄面;td `onRspQryInstrument` 632-654 行
/// 实际取用字段)。
///
/// 原稿注记(619-631 行样例):合约行的 `ExchangeID` 是交易所真源;`ProductClass`
/// 决定资产大类映射;`ProductID` 为品种代码。
#[derive(Debug, Clone, PartialEq, Default)]
pub struct InstrumentField {
    /// 合约代码
    pub instrument_id: String,
    /// 交易所代码("CFFEX"/"SHFE"/"CZCE"/"DCE"/"INE"/"GFEX")
    pub exchange_id: String,
    /// 合约名称
    pub instrument_name: String,
    /// 产品类码(`THOST_FTDC_PC_*`,map::asset_from 翻译)
    pub product_class: String,
    /// 合约乘数(VolumeMultiple)
    pub volume_multiple: f64,
    /// 最小价格变动(PriceTick)
    pub price_tick: f64,
    /// 限价单最大上量
    pub max_limit_order_volume: f64,
    /// 限价单最小上量
    pub min_limit_order_volume: f64,
    /// 市价单最大上量
    pub max_market_order_volume: f64,
    /// 市价单最小上量
    pub min_market_order_volume: f64,
    /// 交割年
    pub delivery_year: i64,
    /// 交割月
    pub delivery_month: i64,
    /// 品种代码
    pub product_id: String,
    /// 是否可交易(1/0)
    pub is_trading: i64,
    /// 上市日(`YYYYMMDD`,空 = 柜台未给)。
    ///
    /// 合约表**不提供**涨跌停价 —— 那两个只在行情 `DepthMarketData` 里,
    /// 已由 `TickData.limit_up/limit_down` 承担。
    pub open_date: String,
}

/// 委托/订单行(`CThostFtdcOrderField` 窄面;td `onRspOrderInsert` 494-511 与
/// `onRtnOrder` 669-718 行实际取用字段)。
#[derive(Debug, Clone, PartialEq, Default)]
pub struct OrderField {
    /// 合约代码
    pub instrument_id: String,
    /// 交易所代码(0.7.0 起回报自带;合约表查 exchange 的时序依赖退役 ——
    /// 委托回报不再要求合约在册,「按勾选丢弃」在回报侧也随之下线)
    pub exchange_id: String,
    /// 本地报单号(OrderRef,零起递增)
    pub order_ref: String,
    /// 前置编号
    pub front_id: i64,
    /// 会话编号
    pub session_id: i64,
    /// 交易所报单编号(OrderSysID)
    pub order_sys_id: String,
    /// 报单方向码(`'0'`买/`'1'`卖)
    pub direction: String,
    /// 组合开平标志码(OFEN_*;原稿 708 行读 `CombOffsetFlag`)
    pub comb_offset_flag: String,
    /// 报单价格类型码(OPT_*)
    pub order_price_type: String,
    /// 有效期类型码(TC_*)
    pub time_condition: String,
    /// 成交量类型码(VC_*)
    pub volume_condition: String,
    /// 委托价
    pub limit_price: f64,
    /// 报单中的委托总量
    pub volume_total_original: f64,
    /// 尚未成交量
    pub volume_total: f64,
    /// 已成交数量
    pub volume_traded: f64,
    /// 报单状态码(OST_*;map::status_of 翻译)
    pub order_status: String,
    /// 报单日期("YYYYMMDD")
    pub insert_date: String,
    /// 委托时间("HH:MM:SS")
    pub insert_time: String,
}

/// 成交行(`CThostFtdcTradeField` 窄面;td `onRtnTrade` 720-747 行实际取用字段)。
///
/// 注意(原稿 741 与 708 的差异):成交行读 `OffsetFlag`(单偏移),委托行读
/// `CombOffsetFlag`(组合偏移);wire 分列如实保留。
#[derive(Debug, Clone, PartialEq, Default)]
pub struct TradeField {
    /// 合约代码
    pub instrument_id: String,
    /// 交易所代码(0.7.0:同 OrderField)
    pub exchange_id: String,
    /// 交易所报单编号(与 OrderData 的映射键)
    pub order_sys_id: String,
    /// 成交编号(TradeID)
    pub trade_id: String,
    /// 报单方向码('0'/'1')
    pub direction: String,
    /// 单偏移开平标志码(OF_*;原稿 741 行)
    pub offset_flag: String,
    /// 成交价格
    pub price: f64,
    /// 成交数量
    pub volume: f64,
    /// 成交日期("YYYYMMDD")
    pub trade_date: String,
    /// 成交时间("HH:MM:SS")
    pub trade_time: String,
}

/// 持仓明细行(`CThostFtdcInvestorPositionField` 窄面;td `onRspQryInvestorPosition`
/// 543-586 行实际取用字段)。
///
/// CTP 语义候选源:同一 (InstrumentID, PosiDirection) 键可能多行(上期 Today/
/// Yesterday 分行),合并算法在驱动层(仓库 driver.rs 持仓合并块,546-595 行)。
#[derive(Debug, Clone, PartialEq, Default)]
pub struct InvestorPositionField {
    /// 合约代码
    pub instrument_id: String,
    /// 交易所代码(0.7.0:同 OrderField)
    pub exchange_id: String,
    /// 持仓方向码(PD_*:'1'净/'2'多/'3'空;map::direction_from 同表)
    pub posi_direction: String,
    /// 上日持仓(YdPosition)
    pub yd_position: f64,
    /// 总持仓(Position)
    pub position: f64,
    /// 今日持仓(TodayPosition)
    pub today_position: f64,
    /// 持仓成本(PositionCost)
    pub position_cost: f64,
    /// 持仓盈亏(PositionProfit)
    pub position_profit: f64,
    /// 空头冻结量(多向仓记其值)
    pub short_frozen: f64,
    /// 多头冻结量(空向仓记其值)
    pub long_frozen: f64,
}

/// 资金行(`CThostFtdcTradingAccountField` 窄面;td `onRspQryTradingAccount`
/// 604-610 行实际取用字段)。
#[derive(Debug, Clone, PartialEq, Default)]
pub struct TradingAccountField {
    /// 账户号
    pub account_id: String,
    /// 当前权益(Balance)
    pub balance: f64,
    /// 冻结的保证金(并进 frozen;原稿 607 三项求和)
    pub frozen_margin: f64,
    /// 冻结的现金
    pub frozen_cash: f64,
    /// 冻结的手续费
    pub frozen_commission: f64,
    /// 可用资金(⚠ 见 DESIGN.md D-AVAIL)
    pub available: f64,
}

/// 下单输入行(原稿 `send_order` 808-842 行 ctp_req 的字段面)。
#[derive(Debug, Clone, PartialEq, Default)]
pub struct InputOrder {
    /// 合约代码
    pub instrument_id: String,
    /// 交易所代码
    pub exchange_id: String,
    /// 委托价
    pub limit_price: f64,
    /// 委托总量(int(req.volume) 截断)
    pub volume_total_original: i64,
    /// 报单价格类型码
    pub order_price_type: String,
    /// 报单方向码
    pub direction: String,
    /// 组合开平标志码
    pub comb_offset_flag: String,
    /// 本地报单号(str(order_ref))
    pub order_ref: String,
    /// 投资者代码
    pub investor_id: String,
    /// 用户代码
    pub user_id: String,
    /// 经纪公司代码
    pub broker_id: String,
    /// 组合投机套保标志('1'=投机)
    pub comb_hedge_flag: String,
    /// 触发条件('1'=立即)
    pub contingent_condition: String,
    /// 强平原因('0'=非强平)
    pub force_close_reason: String,
    /// 自动挂起标志(0)
    pub is_auto_suspend: i32,
    /// 有效期类型码
    pub time_condition: String,
    /// 成交量类型码
    pub volume_condition: String,
    /// 最小成交量(原稿固定 1)
    pub min_volume: i64,
}

/// 撤单输入行(原稿 `cancel_order` 856-872 行 ctp_req 的字段面)。
#[derive(Debug, Clone, PartialEq, Default)]
pub struct InputOrderAction {
    /// 合约代码
    pub instrument_id: String,
    /// 交易所代码
    pub exchange_id: String,
    /// 本地报单号(req.orderid 三段中的第三段)
    pub order_ref: String,
    /// 前置编号
    pub front_id: i64,
    /// 会话编号
    pub session_id: i64,
    /// 报单操作标志('0'=删除,AF_Delete)
    pub action_flag: String,
    /// 经纪公司代码
    pub broker_id: String,
    /// 投资者代码
    pub investor_id: String,
}

// ---------------------------------------------------------------------------
// 附加接口面(超出原稿,2026-10-16 定):保证金率/手续费率/交易状态三件。
// 镜像策略与 InstrumentField 一致:保留字段 reserve1/2 不进窄面,字段顺序与
// CTP struct 声明序一致。输入 POD 面与 InputOrderAction 同规(写方向)。
// ---------------------------------------------------------------------------

/// 合约保证金率行(`CThostFtdcInstrumentMarginRateField` 窄面,reserve1 省略)。
///
/// SDK 源(6.7.7,ThostFtdcUserApiStruct.h:861-885):InvestorRange/BrokerID/
/// InvestorID/HedgeFlag/四比率/IsRelative/ExchangeID/InvestUnitID/InstrumentID。
/// 投机/套保档由 `hedge_flag` 区分('1'投机/'2'套利/'3'套保)。
#[derive(Debug, Clone, PartialEq, Default)]
pub struct InstrumentMarginRateField {
    /// 投资者范围码(IR_*:'0'所有/'1'投资者组/'2'投资者/'3'合约)
    pub investor_range: String,
    /// 经纪公司代码
    pub broker_id: String,
    /// 投资者代码
    pub investor_id: String,
    /// 投机套保标志码
    pub hedge_flag: String,
    /// 多头保证金率(按金额)
    pub long_margin_ratio_by_money: f64,
    /// 多头保证金费(按量)
    pub long_margin_ratio_by_volume: f64,
    /// 空头保证金率(按金额)
    pub short_margin_ratio_by_money: f64,
    /// 空头保证金费(按量)
    pub short_margin_ratio_by_volume: f64,
    /// 是否相对交易所收取(1/0)
    pub is_relative: i32,
    /// 交易所代码
    pub exchange_id: String,
    /// 投资单元代码
    pub invest_unit_id: String,
    /// 合约代码
    pub instrument_id: String,
}

/// 合约手续费率行(`CThostFtdcInstrumentCommissionRateField` 窄面,reserve1 省略)。
///
/// SDK 源(6.7.7,ThostFtdcUserApiStruct.h:892-920):六比率/ExchangeID/
/// BizType/InvestUnitID/InstrumentID。BizType '1'=期货(THOST_FTDC_BZTYP_All?)。
#[derive(Debug, Clone, PartialEq, Default)]
pub struct InstrumentCommissionRateField {
    /// 投资者范围码(IR_*)
    pub investor_range: String,
    /// 经纪公司代码
    pub broker_id: String,
    /// 投资者代码
    pub investor_id: String,
    /// 开仓手续费率(按金额)
    pub open_ratio_by_money: f64,
    /// 开仓手续费(按量,f64 承 RatioType)
    pub open_ratio_by_volume: f64,
    /// 平仓手续费率(按金额)
    pub close_ratio_by_money: f64,
    /// 平仓手续费(按量)
    pub close_ratio_by_volume: f64,
    /// 平今手续费率(按金额)
    pub close_today_ratio_by_money: f64,
    /// 平今手续费(按量)
    pub close_today_ratio_by_volume: f64,
    /// 交易所代码
    pub exchange_id: String,
    /// 业务类型码(BizType)
    pub biz_type: String,
    /// 投资单元代码
    pub invest_unit_id: String,
    /// 合约代码
    pub instrument_id: String,
}

/// 合约交易状态行(`CThostFtdcInstrumentStatusField` 窄面,reserve1/2 省略)。
///
/// SDK 源(6.7.7,ThostFtdcUserApiStruct.h:5666-5683)。**纯被动**:OnRtnInstrumentStatus
/// 推送(SDK 无 ReqQryInstrumentStatus,2026-10-16 源头核实);SimNow 实测 0 帧。
#[derive(Debug, Clone, PartialEq, Default)]
pub struct InstrumentStatusField {
    /// 交易所代码
    pub exchange_id: String,
    /// 结算组代码
    pub settlement_group_id: String,
    /// 合约交易状态码(IS_*:'0'开盘前/'1'非交易/'2'连续交易/'3'集合竞价报单/
    /// '4'集合竞价平衡/'5'集合竞价撮合/'6'收盘/'7'业务处理)
    pub instrument_status: String,
    /// 交易阶段编号
    pub trading_segment_sn: i32,
    /// 进入本状态时间("HH:MM:SS")
    pub enter_time: String,
    /// 进入本状态原因码(IER_*:'1'自动切换/'2'手动切换/'3'熔断)
    pub enter_reason: String,
    /// 合约在交易所的代码
    pub exchange_inst_id: String,
    /// 合约代码
    pub instrument_id: String,
}

/// 查询合约保证金率的输入(`CThostFtdcQryInstrumentMarginRateField` 窄面,
/// reserve1 省略;SDK ThostFtdcUserApiStruct.h:2594-2611)。
///
/// 有 HedgeFlag 过滤(投机档 '1' 常用;空则前行为不限?)——Live 验收取 '1'。
#[derive(Debug, Clone, PartialEq, Default)]
pub struct QryInstrumentMarginRate {
    /// 经纪公司代码
    pub broker_id: String,
    /// 投资者代码
    pub investor_id: String,
    /// 投机套保标志码(过滤档;'1'投机)
    pub hedge_flag: String,
    /// 交易所代码(过滤)
    pub exchange_id: String,
    /// 投资单元代码(过滤)
    pub invest_unit_id: String,
    /// 合约代码(过滤)
    pub instrument_id: String,
}

/// 查询合约手续费率的输入(`CThostFtdcQryInstrumentCommissionRateField` 窄面,
/// reserve1 省略;SDK ThostFtdcUserApiStruct.h:2613-2630)。
///
/// **没有 HedgeFlag**(与保证金率查询不同;省略保留字段)。
#[derive(Debug, Clone, PartialEq, Default)]
pub struct QryInstrumentCommissionRate {
    /// 经纪公司代码
    pub broker_id: String,
    /// 投资者代码
    pub investor_id: String,
    /// 交易所代码(过滤)
    pub exchange_id: String,
    /// 投资单元代码(过滤)
    pub invest_unit_id: String,
    /// 合约代码(过滤)
    pub instrument_id: String,
}