From d4eb6832b7d11fff05e5a8ac81ac5e32dd9ab9c3 Mon Sep 17 00:00:00 2001 From: dekun Date: Thu, 13 Aug 2026 20:06:23 +0800 Subject: [PATCH] Rewrite usage guide for current options and hedge flows. Remove obsolete strategy, key auto-order, and AI review sections. Co-authored-by: Cursor --- 使用说明.md | 269 ++++++++++++++++++++++++++++++---------------------- 1 file changed, 157 insertions(+), 112 deletions(-) diff --git a/使用说明.md b/使用说明.md index 31cf03b..474e3f3 100644 --- a/使用说明.md +++ b/使用说明.md @@ -1,142 +1,187 @@ # 使用说明 -**本文件对应独立仓库:** [https://git.bz121.com/dekun/crypto_okx.git](https://git.bz121.com/dekun/crypto_okx.git)(`crypto_okx`,OKX 期权 / 对冲). +**仓库:** [https://git.bz121.com/dekun/crypto_okx.git](https://git.bz121.com/dekun/crypto_okx.git) -**部署,代理,PM2**见本目录 **[部署文档.md](./部署文档.md)** 或一键: +基于 Flask 的 **OKX 期权 / 对冲** Web 控制台.与中控、其它交易所实例无关. + +**部署 / PM2 / SOCKS** 见 **[部署文档.md](./部署文档.md)**: ```bash curl -fsSL https://git.bz121.com/dekun/crypto_okx/raw/branch/main/deploy/manage.sh | bash ``` -当前主功能为期权、期权复盘、对冲计划与模拟资金;策略交易 / 关键位自动单 / AI 复盘 / 中控已从此独立项目移除.下文部分历史模块说明仅供对照,以实际页面为准. +默认访问: `http://<服务器IP>:5004` → 首页跳转 **期权** `/options`. --- -## 1. 它能做什么 +## 1. 能做什么 -面向个人盘面的 **Web 控制台**,主要能力包括: +| 模块 | 路由 | 说明 | +|------|------|------| +| **期权** | `/options` | 看期权链、开平仓、持仓监控(翻倍出场等) | +| **期权复盘** | `/options/review` | 期权成交记录 → 复盘表单 → 复盘列表与统计 | +| **对冲计划** | `/hedge-plan` | 永期对冲或期期对冲:测算、启动、进行中/历史/统计 | +| **模拟资金** | 系统设置 → 模拟资金 | 本地钱包撮合,吃公开买卖一,**不下真实交易所单** | +| **env 配置** | `/env_config` | 浏览器改 `.env`(API、交易模式、预算等) | +| **系统设置** | `/settings` | 导航显示、模拟/实盘、密码、划转、导出等 | -| 模块 | 说明 | +顶栏还可按需显示:关键位监控(提醒)、数据看板、账户流水、风控说明等(在 **系统设置 → 导航显示** 开关). + +**已移除:** 策略交易、关键位自动下单、永续实盘下单页、永续交易记录/复盘、AI 复盘、中控对接. + +--- + +## 2. 登录与顶栏 + +1. 打开站点 → 登录(`APP_USERNAME` / `APP_PASSWORD`,见 `.env`). +2. 顶栏标题区显示交易所名;若为模拟模式会标 **模拟**. +3. 资金条含:总资金、资金/交易账户(USDT)、期权资金/交易账户(USDC)、实时盈亏等(模拟/实盘数据源不同). + +--- + +## 3. 交易模式(必读) + +在 **env 配置** 或 `.env` 中设置 **`OKX_TRADE_MODE`**(多数可热更,启用类开关改后建议重启): + +| 值 | 含义 | +|----|------| +| `options` | **单独期权**:可单独开期权;隐藏对冲导航 | +| `perp_options` | **永期对冲**:不可单独开期权;对冲页显示「永期对冲」 | +| `options_options` | **期期对冲**:不可单独开期权;对冲页显示「期期对冲」 | + +对冲模式下期权页仍可查看/平仓已有仓,但不能单独新开期权. + +对冲与单独期权默认可互斥(`HEDGE_PLAN_OPTIONS_MUTUAL_EXCLUSIVE=true`):有对冲计划时不可单独开期权,有单独期权时不可启动对冲. + +--- + +## 4. 期权页(`/options`) + +### 4.1 前置 + +- `OKX_OPTIONS_ENABLED=true`(默认 true) +- 已配置 `OKX_API_KEY` / `OKX_API_SECRET` / `OKX_API_PASSPHRASE`(永续与期权共用) +- 实盘真下单需 `LIVE_TRADING_ENABLED=true`;否则多为本地流程/模拟(见第 7 节) +- 期权账户为 **USDC**;永续腿为 **USDT**,资金不互通 + +### 4.2 开仓流程 + +1. 选标的 **ETH / BTC**、到期日. +2. **列表** 或 **T 型** 看链;可筛看涨/看跌、实值/虚值;勾选「展开全部」看全部行权价. +3. 环境「链上仅显示有卖一」开启时,无真实卖一或深度不足 1 张的合约会隐藏. +4. 点某行 **买入** → 下单面板确认张数、权利金、到期平衡等. +5. 张数:「按可用余额打满」受单笔预算 `OKX_OPTIONS_TRADE_BUDGET_USDC` × 缓冲 `OKX_OPTIONS_BUDGET_BUFFER` 限制;「全仓复利」用交易户全部可用(可设全仓上限),且通常仅允许同时 1 笔持仓. +6. 可勾选 **翻倍出场**(盈利达权利金倍数后限价平). + +### 4.3 持仓与平仓 + +- 右侧/下方持仓卡可改翻倍倍数或关闭、执行平仓. +- 平仓默认买一限价;是否允许市价平见 `OKX_OPTIONS_ALLOW_MARKET_CLOSE`. +- 页面内「开仓规则说明」与 `/options/guide` 有更细规则. + +--- + +## 5. 期权复盘(`/options/review`) + +1. **交易记录**:筛选期权成交/平仓记录. +2. **复盘表单**:选中一笔填写复盘内容并保存. +3. **复盘记录 / 统计**:查看已复盘条目与汇总. + +该页只覆盖期权侧,不含已移除的永续交易日记账. + +--- + +## 6. 对冲计划(`/hedge-plan`) + +需将 `OKX_TRADE_MODE` 设为 `perp_options` 或 `options_options`. + +### 6.1 页签 + +| Tab | 说明 | +|-----|------| +| 永期对冲 | 期权腿 + 永续腿(仅 `perp_options`) | +| 期期对冲 | 双期权腿(仅 `options_options`) | +| 进行中的计划 | 盯盘 / 开仓中 / 半腿 / 持仓中 | +| 历史记录 | 已结束计划 | +| 统计分析 | 对冲结果汇总 | + +### 6.2 永期对冲要点 + +- **账户**:永续 → 合约账户(USDT);期权 → 期权账户(USDC). +- **以期权为主**(`HEDGE_PLAN_OPTION_PRIMARY=true`):填参后「策略启动」进入盯盘,条件达标后自动先开期权再市价永续. +- **保险模式**(`HEDGE_PLAN_OPTION_PRIMARY=false`):做多配 Put、做空配 Call;现场按开仓价与止盈止损执行,交易所 TP/SL 出场. +- 组数上限:`MAX_ACTIVE_HEDGE_PLANS`(默认 1). + +### 6.3 期期对冲要点 + +- 按预算或张数拆分主/次腿(见 `HEDGE_PLAN_OO_BIAS_*`). +- 平仓模式(到期平 / 全平等)受 `HEDGE_PLAN_OO_CLOSE_MODE_ENABLED` 控制. + +### 6.4 半腿 + +一侧成交、另一侧失败时,默认可挂 `partial` 在页面 **手动补开**(`HEDGE_PLAN_MANUAL_COMPLETE_ON_PARTIAL=true`),避免误自动平掉已成腿. + +真下单还需 `HEDGE_PLAN_LIVE_ORDER=true` 与 `LIVE_TRADING_ENABLED=true`(以 env 为准). + +--- + +## 7. 模拟资金 vs 实盘 + +**系统设置 → 模拟资金**: + +| 操作 | 说明 | |------|------| -| **关键位监控** | 录入上/下沿与类型,按 **5m 收线** 做硬条件过滤;符合条件后 **企业微信** 提醒,部分类型可 **自动市价开仓**(见第 4 节与专门文档). | -| **实盘下单监控** | 手工填止损/止盈,**以损定仓** 市价开单,挂上条件止盈止损,并在页面跟踪浮盈亏,保本逻辑等. | -| **交易记录 / 复盘** | 平仓结果,盈亏,错过的单等归档与导出;可选 **AI 复盘**(见仓库根 [AI复盘与模型配置说明.md](../AI复盘与模型配置说明.md)). | -| **策略交易** | 顶栏 `/strategy`:**趋势回调**(左)与 **顺势加仓**(右)左右并列;细则见 [策略交易说明.md](../策略交易说明.md). | +| 切换到模拟资金 | 本地 SQLite 钱包;用 OKX **公开行情** 吃买卖一结算,**不向交易所下真实单** | +| 切换到实盘 | 走真实 API(须密钥正确且允许实盘) | +| 重置权益 | 无仓时可重置;强制重置会清仓 | +| 划转 / USDT↔USDC | 仅作用于模拟钱包 | -后台按 **`MONITOR_POLL_SECONDS`**(默认几秒)轮询行情与监控逻辑.**切勿**在未理解规则时同时运行两套程序共用一个实盘账户. +启动默认模式:`SIM_DEFAULT_MODE=sim` 或 `live`.顶栏出现 **模拟** 徽章即表示当前为模拟. --- -## 2. 运行前必须配置(`.env`) +## 8. 系统设置与 env -首次在本目录执行 **`cp .env.example .env`**,再编辑 `.env`(`.env` 勿提交 Git;`git pull` 不会改你的 `.env`,升级前建议 `cp .env .env.backup.$(date +%Y%m%d)`). +### 系统设置(`/settings`) -至少检查以下项(具体键名以 **`.env.example`** 为准): +- **导航显示**:开关顶栏各入口 +- **模拟资金**:见上节 +- **账户密码**:改登录口令 +- **永续划转 / 期权划转 / 币种兑换**:实盘账户内资金操作(模拟模式有对应模拟划转) +- **数据导出**:导出相关 CSV -| 类别 | 说明 | -|------|------| -| **登录网页** | `APP_PASSWORD`:打开站点后的登录口令.`FLASK_SECRET_KEY`:Session 密钥,请勿使用默认值. | -| **企业微信** | `WECHAT_WEBHOOK`:告警与关键位推送机器人的 Webhook. | -| **是否真下单** | `LIVE_TRADING_ENABLED=false`:**不会**向交易所发送开仓指令(适合测试流程).改为 `true` 且密钥正确才会实盘. | -| **交易所 API** | **本仓库:** `OKX_API_KEY`,`OKX_API_SECRET`;永续相关见 `OKX_TD_MODE`,`OKX_POS_MODE`,`OKX_TRIGGER_WORKING_TYPE` 等.**勿**把 `.env` 提交到 Git. | -| **关键位 RR / 止损外扩** | `KEY_AUTO_MIN_PLANNED_RR`,`KEY_STOP_OUTSIDE_BREAKOUT_PCT`(详见 `关键位自动下单说明.md`). | -| **AI 复盘** | 默认 `AI_PROVIDER=openai`,`OPENAI_API_BASE=https://op.bz121.com/v1`,`OPENAI_API_KEY`,`OPENAI_MODEL=gemma4:e4b`;或 `AI_PROVIDER=ollama` + `OLLAMA_API` / `AI_MODEL`.详见 [AI复盘与模型配置说明.md](../AI复盘与模型配置说明.md). | +### env 配置(`/env_config`) -网络需要代理时可配置 **`OKX_SOCKS_PROXY` / `OKX_HTTP_PROXY`**(与 Gate 版 `GATE_*_PROXY` 用法类似). +常用项: + +| 类别 | 变量示例 | +|------|----------| +| 登录 | `APP_PASSWORD`,`FLASK_SECRET_KEY` | +| API | `OKX_API_*`,`OKX_TD_MODE`,`OKX_POS_MODE` | +| 代理 | `OKX_SOCKS_PROXY=socks5h://127.0.0.1:1080` | +| 实盘开关 | `LIVE_TRADING_ENABLED` | +| 模式 | `OKX_TRADE_MODE` | +| 期权预算 | `OKX_OPTIONS_TRADE_BUDGET_USDC`,`OKX_OPTIONS_COMPOUND_FULL_*` | +| 对冲 | `HEDGE_PLAN_*`,`MAX_ACTIVE_HEDGE_PLANS` | +| 企业微信 | `WECHAT_WEBHOOK` | + +完整注释见根目录 **`.env.example`**.`.env` 勿提交 Git;`git pull` 不会覆盖本地 `.env`. --- -## 3. 如何启动与登录 +## 9. 首次上手建议 -1. 准备 Python 虚拟环境并安装依赖(如 `flask`,`requests`,`ccxt`,按需 `Pillow`,`PySocks` 等),配置好 `.env`. -2. 启动 Flask 应用(可用 **`ecosystem.config.cjs`** 交给 PM2,或本地 `python app.py` / `flask run`,以你当前脚本为准). -3. 浏览器访问站点,打开 **`/login`**,使用 **`.env` 里的 `APP_PASSWORD`** 登录. - -登录后顶栏:**关键位监控** | **实盘下单**(默认首页)| **策略交易**(`/strategy`,趋势回调 + 顺势加仓双栏)| **策略交易记录**(`/strategy/records`)| **交易记录与复盘** | **统计分析**. +1. 部署并打开站点,登录后到 **系统设置 → 模拟资金**,确认处于 **模拟**. +2. **env 配置** 填 API(模拟下单可不真下交易所,但拉链/行情通常仍需可达 OKX;本机受限时配 SOCKS). +3. 设 `OKX_TRADE_MODE=options`,在 **期权** 页熟悉开平仓与持仓卡. +4. 需要复盘时用 **期权复盘**. +5. 再按需改成永期/期期对冲,先模拟跑通再切实盘. +6. 实盘前再开 `LIVE_TRADING_ENABLED` / `HEDGE_PLAN_LIVE_ORDER`,并确认 OKX 权限、持仓模式、IP 白名单. --- -## 4. 关键位监控(顶栏「关键位监控」→ `/key_monitor`) +## 10. 风险与合规 -### 4.1 添加一条关键位 - -1. **币种**:如 `BTC` 或 `BTC/USDT`(会规范成内部符号). -2. **类型**(必选其一): - - | 类型 | 行为摘要 | - |------|----------| - | **箱体突破** | 通过门控且计划 RR 达标 → **自动市价开仓**(需 `LIVE_TRADING_ENABLED=true` 且无其他持仓占位).结案后本条从列表消失并记入历史. | - | **收敛突破** | 同上(自动开仓类). | - | **关键阻力位** | **不自动开仓**;触发后 **发 1 次微信**,然后本条 **结案进历史**. | - | **关键支撑位** | 同上(仅提醒). | - | **回调触价开仓** | **不挂交易所限价**;标记价回调触达 E 后 **下一轮询市价开仓**(RR 门槛同 `KEY_AUTO_MIN_PLANNED_RR`);有效期 **24h** | - | **突破触价开仓** | **不挂交易所限价**;标记价 **穿越 E 立即市价开仓**;先触 SL/TP 侧失效;有效期 **24h** | - -3. **方向**:做多 / 做空(触价开仓 / 箱体 / 收敛 / 斐波必选;阻力/支撑不选). -4. **价位**:箱体/收敛/阻力/支撑填 **上沿 / 下沿**;触价开仓填 **入场 E / 止损 SL / 止盈 TP**. - -**限制:** -活跃持仓数达到 **`MAX_ACTIVE_POSITIONS`**(默认 1)时,**不允许**再添加「**箱体突破** / **收敛突破**」;仍可添加「**关键阻力位 / 支撑位**」. -若 **4h EMA55** 与你的方向逆势,页面会 **额外 Flash 提示**,**不阻挡**提交. - -### 4.2 触发后会发生什么(简版) - -- **箱体 / 收敛**:门控通过后算计划 SL/TP 与 RR;不达标 → 微信说明 + **`rr_insufficient`** 结案;达标 → **市价开仓**,成功 **`auto_opened`** / 失败 **`exchange_failed`**,均不重试同一关键位. -- **阻力 / 支撑**:仅 **单次推送** → **`key_level_alert_only`** 结案. - -详细公式与字段见 **`关键位自动下单说明.md`**. - -### 4.3 列表与历史 - -当前条目与历史记录的用法与 Gate 版相同;结案后可在历史区查阅 **`close_reason`**. - ---- - -## 5. 实盘下单(顶栏「实盘下单」→ `/trade`) - -- 持仓上限由 **`MAX_ACTIVE_POSITIONS`** 控制(默认 1). -- **人工开仓**计划盈亏比不得低于 **`MANUAL_MIN_PLANNED_RR`**(默认 1.4:1). -- 填写币种,方向,杠杆(可选),止损/止盈(价格或百分比按表单). -- 移动保本等选项按页面与 `.env` 默认. - -开仓成功后卡片 **「来源」**:手工一般为 **下单监控**;关键位自动为 **关键位监控**. - ---- - -## 6. 企业微信 - -推送逻辑与 Gate 版一致;未配置 **`WECHAT_WEBHOOK`** 时可能没有消息,请以 **交易所端** 核对持仓与挂单. - ---- - -## 7. 强烈建议的风险与运维习惯 - -1. **先用 `LIVE_TRADING_ENABLED=false`** 熟悉流程再实盘. -2. **API 权限**最小化,密钥勿泄露. -3. **同一账户避免多程序重复开仓**. -4. **自动备份**:服务器上执行 `bash scripts/install_backup_cron.sh`(每天北京时间 0:00 → `/root/backups`,保留 30 天);升级前也可 `bash scripts/backup_data.sh` 手动跑一次. -5. 升级代码后留意 **首轮启动**有无数据库迁移报错. - ---- - -## 8. 常见问题(简要) - -| 现象 | 可自查 | -|------|--------| -| 关键位永远不触发 | 门控五项,日成交量排名,`KLINE_TIMEFRAME`. | -| 有信号但不自动开仓 | `LIVE_TRADING_ENABLED`,RR 阈值,是否已有持仓,API/保证金错误信息. | -| 加不了箱体/收敛 | 是否已有持仓. | -| 推送收不到 | Webhook,网络. | - ---- - -## 9. 与币安版(`crypto_monitor_binance`)差异速查 - -| 项目 | OKX 本仓库 | 币安版 | -|------|------------|--------| -| API 变量 | `OKX_API_KEY`,`OKX_API_SECRET`,`OKX_API_PASSPHRASE` | `BINANCE_API_KEY`,`BINANCE_API_SECRET` | -| 代理 | `OKX_SOCKS_PROXY` | `BINANCE_SOCKS_PROXY` | -| 默认端口 | 常为 `5004` | 常为 `5001` | -| TP/SL 实现 | `_okx_place_tp_sl_orders`,页面 `/api/order/.../cancel_tpsl` | `_binance_place_tp_sl_orders` | - -业务流程,顶栏分栏,策略交易,风控参数名已与币安版对齐;仅需更换目录与 `.env`. +- 期权与永续杠杆风险高,实盘盈亏自负. +- 勿把 `.env`、API 密钥提交到仓库或发到公网. +- 请遵守当地法规与 OKX 用户协议;本说明仅描述产品用法,不构成投资建议.