Skip to content

Commit a6e2191

Browse files
committed
Document crypto live pool authority
1 parent eb1725b commit a6e2191

4 files changed

Lines changed: 21 additions & 8 deletions

File tree

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@
66
77
## What this repository is
88

9-
CryptoSnapshotPipelines is the QuantStrategyLab crypto snapshot and release pipeline. It builds the crypto live pool, rankings, shadow candidate tracks, and release artifacts used by CryptoStrategies.
9+
CryptoSnapshotPipelines is the QuantStrategyLab crypto snapshot and release pipeline. It is the authority for monthly crypto live-pool membership, ordering, rankings, shadow candidate tracks, and release artifacts used by CryptoStrategies.
1010

1111
It is an evidence-producing repository. It does not place trades and should not be treated as an execution platform.
1212

1313
## Strategy and evidence boundary
1414

1515
### Direct runtime strategies
1616

17-
The trading logic lives in CryptoStrategies. This repository produces the live-pool and validation artifacts that the strategy package reads.
17+
The trading logic lives in CryptoStrategies. This repository produces the live-pool and validation artifacts that the strategy package reads, and it owns the monthly selection and order of the published pool.
1818

1919
### Snapshot-backed work handled here
2020

@@ -24,11 +24,11 @@ The trading logic lives in CryptoStrategies. This repository produces the live-p
2424

2525
### Downstream use
2626

27-
CryptoStrategies and BinancePlatform should consume only release artifacts that pass the documented contract checks.
27+
CryptoStrategies and BinancePlatform should consume only release artifacts that pass the documented contract checks. Downstream systems should preserve `live_pool.json["symbols"]` order and should not rebuild the monthly pool from local indicators.
2828

2929
## What the artifacts are for
3030

31-
Snapshot artifacts are used to make strategy decisions reproducible: ranking inputs, feature snapshots, manifests, validation summaries, and promotion evidence. They are not marketing claims. Before a downstream repository promotes a profile, review the latest artifacts across short, medium, and long windows where applicable.
31+
Snapshot artifacts are used to make strategy decisions reproducible: ranking inputs, live-pool snapshots, manifests, validation summaries, and promotion evidence. `live_pool.json` and `artifact_manifest.json` are the stable downstream execution contract; ranking files and research outputs stay upstream evidence unless the contract explicitly promotes them. They are not marketing claims. Before a downstream repository promotes a profile, review the latest artifacts across short, medium, and long windows where applicable.
3232

3333
## Repository layout
3434

README.zh-CN.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@
66
77
## 这个仓库是什么
88

9-
CryptoSnapshotPipelines 是 QuantStrategyLab 的加密货币 snapshot 与发布流水线。为 CryptoStrategies 生成 live poolranking、shadow candidate tracks 和发布产物
9+
CryptoSnapshotPipelines 是 QuantStrategyLab 的加密货币 snapshot 与发布流水线。它是月度加密 live-pool 成员、顺序、ranking、shadow candidate tracks 和发布产物的权威来源,供 CryptoStrategies 使用
1010

1111
这是一个产出证据的仓库,不直接下单,也不应该被当作执行平台。
1212

1313
## 策略和证据边界
1414

1515
### 普通 runtime 策略
1616

17-
交易逻辑在 CryptoStrategies。本仓库生成策略包读取的 live-pool 和验证产物。
17+
交易逻辑在 CryptoStrategies。本仓库生成策略包读取的 live-pool 和验证产物,并负责已发布池的月度选择和顺序
1818

1919
### 本仓库处理的 Snapshot-backed 工作
2020

@@ -24,11 +24,11 @@ CryptoSnapshotPipelines 是 QuantStrategyLab 的加密货币 snapshot 与发布
2424

2525
### 下游如何使用
2626

27-
CryptoStrategies 和 BinancePlatform 应只消费通过 contract 检查的发布产物。
27+
CryptoStrategies 和 BinancePlatform 应只消费通过 contract 检查的发布产物。下游系统应保留 `live_pool.json["symbols"]` 的顺序,不应根据本地指标重建月度池。
2828

2929
## 这些产物用来做什么
3030

31-
Snapshot artifact 的作用是让策略判断可复现:包括 ranking 输入、feature snapshot、manifest、validation summary 和提升证据。它们不是宣传式收益承诺。下游仓库提升 profile 前,应在适用场景下检查最新短、中、长周期产物。
31+
Snapshot artifact 的作用是让策略判断可复现:包括 ranking 输入、live-pool snapshot、manifest、validation summary 和提升证据`live_pool.json``artifact_manifest.json` 是稳定的下游执行合约;ranking 文件和研究输出默认留在上游作为证据,除非合约明确提升它们。它们不是宣传式收益承诺。下游仓库提升 profile 前,应在适用场景下检查最新短、中、长周期产物。
3232

3333
## 仓库结构
3434

docs/integration_contract.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,12 @@ The upstream project publishes a monthly `core_major` live pool and exposes it t
1717
2. versioned and current objects in GCS
1818
3. a lightweight Firestore summary document
1919

20+
## Authority Boundary
21+
22+
`CryptoSnapshotPipelines` owns monthly live-pool membership, ranking, and order for `crypto_leader_rotation`. Downstream strategy and execution repositories should treat the ordered `symbols` list from `live_pool.json` or `artifact_manifest.json` as canonical.
23+
24+
Downstream systems may apply runtime execution gates, sell rules, top-N selection, sizing, and degraded-source policy after artifact validation. They should not recalculate monthly membership or replace the published order from local indicators. `latest_ranking.csv` and `selection_meta` are upstream evidence and diagnostics; `live_pool.json` plus `artifact_manifest.json` are the stable execution contract.
25+
2026
## Canonical Downstream Files
2127

2228
### `artifact_manifest.json`
@@ -130,6 +136,7 @@ Stable contract fields for downstream validation:
130136
Meaning:
131137

132138
- `pool_size` and `symbols` always describe the full official exported pool for that monthly snapshot
139+
- `symbols` order is the official upstream monthly order and should be preserved by downstream payload normalization
133140
- downstream display panels, local ranking previews, or final execution targets are separate downstream-layer concepts
134141

135142
Research/reporting extras are intentionally not part of the stable contract. Downstream consumers should not infer live readiness from local research CSVs or validation summaries.

docs/operator_runbook.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,11 @@ The GCS prefix, Firestore document, and `source_project` value intentionally
4040
remain in the `crypto-leader-rotation` v1 artifact namespace for downstream
4141
compatibility.
4242

43+
This repository owns the monthly live-pool membership, ranking, and published
44+
symbol order. Downstream runtime repositories should consume the validated
45+
artifact contract and preserve that order when passing the pool into strategy
46+
code.
47+
4348
## Research Path Vs Production Path
4449

4550
Production path:
@@ -81,6 +86,7 @@ Operator-facing summary entrypoints:
8186
Boundary rules:
8287

8388
- Downstream execution systems should consume the validated release artifacts, not recreate the monthly report layer.
89+
- Downstream systems should not rerank or rebuild the monthly live pool from local runtime indicators.
8490
- Research reports and shadow-track diagnostics stay upstream and are not part of the minimum downstream execution contract.
8591
- Telegram messages from this repository are operational release notifications, not trade execution alerts.
8692

0 commit comments

Comments
 (0)