@openfinclaw/openfinclaw-strategy 0.0.11 → 2026.3.14

package/README.md

@@ -1,23 +1,19 @@
 # @openfinclaw/openfinclaw-strategy
 
-FinClaw Commons - 量化策略开发平台插件。连接 hub.openfinclaw.ai 策略网络，支持策略创建、验证、发布、Fork。
+OpenFinClaw - 统一金融工具插件。一个 API Key，一站式服务：
+- **行情数据**: 价格查询、K线、加密市场数据、多资产对比、代码搜索
+- **策略工具**: 发布、验证、Fork、排行榜
 
 ## 安装
 
-```bash
-curl -fsSL https://raw.githubusercontent.com/cryptoSUN2049/openFinclaw/main/scripts/install-finclaw.sh | bash
-```
-
-或手动安装：
-
 ```bash
 openclaw plugins install @openfinclaw/openfinclaw-strategy
 ```
 
-## 快速开始（无需 API Key）
+## 快速开始
 
 ```bash
-# 查看排行榜
+# 查看策略排行榜（无需 API Key）
 openclaw strategy leaderboard
 
 # 查看收益榜 Top 10
@@ -27,29 +23,36 @@ openclaw strategy leaderboard returns --limit 10
 openclaw strategy show <strategy-id> --remote
 ```
 
+或者直接告诉 Agent 你想做什么：
+
+- "BTC 现在多少钱" → Agent 会使用 `fin_price`
+- "ETH 最近 7 天走势" → Agent 会使用 `fin_kline`
+- "DeFi 哪个协议 TVL 最高" → Agent 会使用 `fin_crypto`
+- "帮我看看排行榜有什么好策略" → Agent 会使用 `skill_leaderboard`
+
 ## 功能概览
 
-| 功能       | 工具                   | 需要 API Key |
-| ---------- | ---------------------- | ------------ |
-| 排行榜查询 | `skill_leaderboard`    | 否           |
-| 策略详情   | `skill_get_info`       | 否           |
-| 本地验证   | `skill_validate`       | 否           |
-| 本地列表   | `skill_list_local`     | 否           |
-| 策略 Fork  | `skill_fork`           | **是**       |
-| 策略发布   | `skill_publish`        | **是**       |
-| 发布查询   | `skill_publish_verify` | **是**       |
-
-### AI 工具列表
-
-| 工具                   | 说明                                   | API Key  |
-| ---------------------- | -------------------------------------- | -------- |
-| `skill_leaderboard`    | 查询排行榜（综合/收益/风控/人气/新星） | 不需要   |
-| `skill_get_info`       | 获取 Hub 策略公开详情                  | 不需要   |
-| `skill_validate`       | 本地验证策略包（FEP v1.2）             | 不需要   |
-| `skill_list_local`     | 列出本地策略                           | 不需要   |
-| `skill_fork`           | 从 Hub 下载策略到本地                  | **需要** |
-| `skill_publish`        | 发布策略 ZIP 到 Hub，自动触发回测      | **需要** |
-| `skill_publish_verify` | 查询发布状态和回测报告                 | **需要** |
+### 行情数据工具
+
+| 工具名            | 说明                         | API Key |
+| ----------------- | ---------------------------- | ------- |
+| `fin_price`       | 价格查询（股票/加密/指数）   | 需要    |
+| `fin_kline`       | K线/OHLCV 数据               | 需要    |
+| `fin_crypto`      | 加密市场数据（21个端点）     | 需要    |
+| `fin_compare`     | 多资产价格对比               | 需要    |
+| `fin_slim_search` | 代码/名称搜索                | 需要    |
+
+### 策略工具
+
+| 工具名                | 说明                       | API Key |
+| --------------------- | -------------------------- | ------- |
+| `skill_leaderboard`   | 查询排行榜                 | 不需要  |
+| `skill_get_info`      | 获取 Hub 策略公开详情      | 不需要  |
+| `skill_validate`      | 本地验证策略包（FEP v2.0） | 不需要  |
+| `skill_list_local`    | 列出本地策略               | 不需要  |
+| `skill_fork`          | 从 Hub 下载策略到本地      | **需要**|
+| `skill_publish`       | 发布策略 ZIP 到 Hub        | **需要**|
+| `skill_publish_verify`| 查询发布状态和回测报告     | **需要**|
 
 ## CLI 命令
 
@@ -71,92 +74,60 @@ openclaw strategy show <name-or-id> [--remote]
 openclaw strategy remove <name-or-id> --force
 ```
 
-### 排行榜类型
-
-| 榜单类型    | 说明           |
-| ----------- | -------------- |
-| `composite` | 综合榜（默认） |
-| `returns`   | 收益榜         |
-| `risk`      | 风控榜         |
-| `popular`   | 人气榜         |
-| `rising`    | 新星榜         |
-
 ## 配置
 
-Fork 和发布策略需要 API Key（从 https://hub.openfinclaw.ai 获取）：
+从 https://hub.openfinclaw.ai 获取 API Key（以 `fch_` 开头），一个 Key 即可使用所有功能：
 
 ```bash
-openclaw config set plugins.entries.openfinclaw.config.skillApiKey YOUR_API_KEY
+openclaw config set plugins.entries.openfinclaw.config.apiKey YOUR_API_KEY
 ```
 
 或使用环境变量：
 
 ```bash
-export SKILL_API_KEY=YOUR_API_KEY
-export SKILL_API_URL=https://hub.openfinclaw.ai
+export OPENFINCLAW_API_KEY=YOUR_API_KEY
 ```
 
+### 配置选项
+
+| 配置项              | 环境变量                   | 说明             | 默认值                       |
+| ------------------- | -------------------------- | ---------------- | ---------------------------- |
+| `apiKey`            | `OPENFINCLAW_API_KEY`      | 统一 API Key     | 必填                         |
+| `hubApiUrl`         | `HUB_API_URL`              | Hub 服务地址     | `https://hub.openfinclaw.ai` |
+| `datahubGatewayUrl` | `DATAHUB_GATEWAY_URL`      | DataHub 网关地址 | `http://43.134.61.136:9080`  |
+| `requestTimeoutMs`  | `REQUEST_TIMEOUT_MS`       | 请求超时（毫秒） | `60000`                      |
+
 ### ⚠️ API Key 安全提醒
 
-**重要：请勿泄露你的 Hub API Key！**
+**重要：请勿泄露你的 API Key！**
 
-- API Key 以 `fch_` 开头，**仅用于** hub.openfinclaw.ai 接口校验
+- API Key 以 `fch_` 开头，用于 Hub 和 DataHub 接口校验
 - **不要**将 API Key 提交到 Git 仓库或公开分享
 - **不要**在公开聊天、截图、代码示例中暴露真实的 API Key
 - 如果怀疑 Key 已泄露，请立即在 Hub 个人设置中重新生成
 
-### 配置选项
-
-| 配置项             | 环境变量                   | 说明                         | 默认值                       |
-| ------------------ | -------------------------- | ---------------------------- | ---------------------------- |
-| `skillApiKey`      | `SKILL_API_KEY`            | Hub API Key（Fork/发布需要） | 可选                         |
-| `skillApiUrl`      | `SKILL_API_URL`            | Hub 服务地址                 | `https://hub.openfinclaw.ai` |
-| `requestTimeoutMs` | `SKILL_REQUEST_TIMEOUT_MS` | 请求超时                     | `60000`                      |
-
 ## Skills
 
-### openfinclaw (入口)
-
-平台入口 skill，帮助用户了解 Hub 平台、安装插件、使用工具链。
-
-### skill-publish
-
-发布策略到 Hub：
-
-```
-用户: "发布我的策略到服务器"
-Agent:
-1. skill_validate(dirPath) → 本地验证
-2. [打包 ZIP]
-3. skill_publish(filePath) → 获取 submissionId
-4. skill_publish_verify(submissionId) → 轮询直到完成
-5. 返回回测报告
-```
+### 行情数据 Skills
 
-### strategy-builder
+| Skill                     | 说明                     |
+| ------------------------- | ------------------------ |
+| `price-check`             | 快速查价                 |
+| `quick-quote`             | 加密市场快照             |
+| `crypto-stablecoin-flow`  | 稳定币资金流分析         |
+| `crypto-funding-arb`      | 资金费率套利分析         |
+| `crypto-altseason`        | 山寨季择时分析           |
+| `cross-asset-lite`        | 跨资产价格对比           |
 
-自然语言生成策略：
+### 策略 Skills
 
-```
-用户: "帮我创建一个 BTC 定投策略，每周买入 100 美元"
-Agent:
-1. 生成 fep.yaml 配置
-2. 生成 scripts/strategy.py 代码
-3. 可选：验证并打包
-```
-
-### strategy-fork
-
-从 Hub 下载策略：
-
-```
-用户: "帮我下载那个收益 453% 的 BTC 策略"
-Agent:
-1. skill_leaderboard() → 查看排行榜
-2. skill_get_info(strategyId) → 查看详情
-3. skill_fork(strategyId) → 下载到本地
-4. 返回本地路径供编辑
-```
+| Skill              | 说明                       |
+| ------------------ | -------------------------- |
+| `openfinclaw`      | 平台入口                   |
+| `strategy-builder` | 自然语言生成策略           |
+| `skill-publish`    | 发布策略到 Hub             |
+| `strategy-fork`    | 从 Hub 下载策略            |
+| `strategy-pack`    | 创建回测策略包             |
 
 ## 本地存储
 
@@ -182,4 +153,4 @@ Agent:
 
 ## License
 
-MIT
+MIT

package/index.test.ts

@@ -97,8 +97,8 @@ describe("openfinclaw plugin", () => {
     vi.stubGlobal("fetch", fetchMock);
 
     const { api, tools } = createFakeApi({
-      skillApiUrl: "http://skill.example",
-      skillApiKey: "fch_test_key",
+      hubApiUrl: "http://skill.example",
+      apiKey: "fch_test_key",
     });
     plugin.register(api);
 
@@ -131,8 +131,8 @@ describe("openfinclaw plugin", () => {
     vi.stubGlobal("fetch", fetchMock);
 
     const { api, tools } = createFakeApi({
-      skillApiUrl: "http://skill.example",
-      skillApiKey: "fch_test_key",
+      hubApiUrl: "http://skill.example",
+      apiKey: "fch_test_key",
     });
     plugin.register(api);
 
@@ -159,7 +159,7 @@ describe("openfinclaw plugin", () => {
   });
 
   it("skill_publish returns error when apiKey is not configured", async () => {
-    const { api, tools } = createFakeApi({ skillApiUrl: "http://skill.example" });
+    const { api, tools } = createFakeApi({ hubApiUrl: "http://skill.example" });
     plugin.register(api);
 
     const result = parseResult(
@@ -190,8 +190,8 @@ describe("openfinclaw plugin", () => {
     vi.stubGlobal("fetch", fetchMock);
 
     const { api, tools } = createFakeApi({
-      skillApiUrl: "http://skill.example",
-      skillApiKey: "fch_test_key",
+      hubApiUrl: "http://skill.example",
+      apiKey: "fch_test_key",
     });
     plugin.register(api);
 
@@ -215,7 +215,7 @@ describe("openfinclaw plugin", () => {
   });
 
   it("returns error when submissionId and backtestTaskId both missing for verify", async () => {
-    const { api, tools } = createFakeApi({ skillApiKey: "fch_test" });
+    const { api, tools } = createFakeApi({ apiKey: "fch_test" });
     plugin.register(api);
 
     const result = parseResult(await tools.get("skill_publish_verify")!.execute("call-6", {}));
@@ -224,8 +224,8 @@ describe("openfinclaw plugin", () => {
     expect(String(result.error)).toContain("Either submissionId or backtestTaskId is required");
   });
 
-  it("uses env SKILL_API_KEY when plugin config has no skillApiKey", async () => {
-    vi.stubEnv("SKILL_API_KEY", "fch_env_key");
+  it("uses env OPENFINCLAW_API_KEY when plugin config has no apiKey", async () => {
+    vi.stubEnv("OPENFINCLAW_API_KEY", "fch_env_key");
 
     const fetchMock = vi.fn().mockResolvedValue({
       ok: true,
@@ -234,7 +234,7 @@ describe("openfinclaw plugin", () => {
     });
     vi.stubGlobal("fetch", fetchMock);
 
-    const { api, tools } = createFakeApi({ skillApiUrl: "http://skill.example" });
+    const { api, tools } = createFakeApi({ hubApiUrl: "http://skill.example" });
     plugin.register(api);
 
     await tools.get("skill_publish_verify")!.execute("call-7", { submissionId: "sub-1" });