You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,15 +6,15 @@
6
6
7
7
## What this repository is
8
8
9
-
CryptoSnapshotPipelines is the QuantStrategyLab crypto snapshot and release pipeline. It builds the crypto livepool, 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.
10
10
11
11
It is an evidence-producing repository. It does not place trades and should not be treated as an execution platform.
12
12
13
13
## Strategy and evidence boundary
14
14
15
15
### Direct runtime strategies
16
16
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.
18
18
19
19
### Snapshot-backed work handled here
20
20
@@ -24,11 +24,11 @@ The trading logic lives in CryptoStrategies. This repository produces the live-p
24
24
25
25
### Downstream use
26
26
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.
28
28
29
29
## What the artifacts are for
30
30
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.
Copy file name to clipboardExpand all lines: docs/integration_contract.md
+7Lines changed: 7 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,6 +17,12 @@ The upstream project publishes a monthly `core_major` live pool and exposes it t
17
17
2. versioned and current objects in GCS
18
18
3. a lightweight Firestore summary document
19
19
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
+
20
26
## Canonical Downstream Files
21
27
22
28
### `artifact_manifest.json`
@@ -130,6 +136,7 @@ Stable contract fields for downstream validation:
130
136
Meaning:
131
137
132
138
-`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
133
140
- downstream display panels, local ranking previews, or final execution targets are separate downstream-layer concepts
134
141
135
142
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.
0 commit comments