Skip to content

docs: publish strategy entrypoint release line #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Pigbibi merged 1 commit into from
Apr 6, 2026
Merged

docs: publish strategy entrypoint release line #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,17 @@ Standalone crypto strategy repository for QuantStrategyLab platforms.

This repository owns pure strategy logic and strategy metadata. The downstream execution repo still owns exchange access, market-data fetches, runtime state, circuit breakers, Flexible Earn handling, notifications, and order placement.

### Contract boundary

The supported downstream surface is now the manifest-backed unified entrypoint for each live profile.

- `CryptoStrategies` owns pure decision logic and manifest metadata
- `BinancePlatform` loads that entrypoint through `QuantPlatformKit`
- shared outputs stay inside `StrategyDecision`
- exchange-specific safety checks, order sequencing, and artifact freshness handling stay in the execution repo

Legacy `core` / `rotation` modules may still exist as internal implementation details, but downstream runtimes should not bind to those component names anymore.

### Strategy index

| Profile | Downstream runtime today | Core idea |
Expand Down Expand Up @@ -95,6 +106,17 @@ These strategies are consumed by platform repositories through `QuantPlatformKit

这个仓库负责纯策略逻辑和策略元数据。下游执行仓库继续负责交易所接入、行情获取、运行时状态、熔断、Flexible Earn、通知和实际下单。

### 契约边界

当前正式对下游开放的是每个 live profile 的 manifest 驱动统一 entrypoint。

- `CryptoStrategies` 负责纯决策逻辑和 manifest 元数据
- `BinancePlatform` 通过 `QuantPlatformKit` 加载这个 entrypoint
- 共享输出保持在 `StrategyDecision` 契约内
- 交易所专属安全检查、下单顺序和 artifact 新鲜度校验继续放在执行仓库

旧的 `core` / `rotation` 模块可以继续作为仓库内部实现细节存在，但下游运行时不应再绑定这些组件名。

### 策略索引

| 策略档位 | 当前下游运行仓库 | 核心思路 |
Expand Down
4 changes: 2 additions & 2 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ build-backend = "setuptools.build_meta"

[project]
name = "crypto-strategies"
version = "0.3.0"
version = "0.4.0"
description = "Shared crypto strategy catalog and implementations"
readme = "README.md"
requires-python = ">=3.11"
dependencies = [
"quant-platform-kit @ git+https://github.com/QuantStrategyLab/QuantPlatformKit.git@5174d9e40f79fffae47450a42e26434145d28b31",
"quant-platform-kit @ git+https://github.com/QuantStrategyLab/QuantPlatformKit.git@v0.7.0",
]

[tool.setuptools]
Expand Down