diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c68f1c0..747f74c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,12 +3,12 @@ ## 中文摘要 -- 用途：本文档围绕 `Contributing`，用于理解 `CryptoSnapshotPipelines` 的配置、运行、部署、研究或验收边界。 +- 用途：本文档围绕 `Contributing`，用于理解 `CryptoLivePoolPipelines` 的配置、运行、部署、研究或验收边界。 - 主要覆盖：`Ground Rules`、`Branching and Pull Requests`、`Local Verification`。 - 阅读顺序：先确认边界、输入输出和权限要求，再执行文档里的命令、CI、dry-run、发布或切换步骤。 - 风险提示：涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更，必须先在测试环境或 dry-run 验证；不要只凭示例直接修改生产。 - 英文正文保留更完整的命令、字段名和配置键；如果摘要和正文不一致，以正文中的实际命令和配置为准。 -Thanks for contributing to `CryptoSnapshotPipelines`. +Thanks for contributing to `CryptoLivePoolPipelines`. ## Ground Rules diff --git a/README.md b/README.md index eed11cb..9e19156 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# CryptoSnapshotPipelines +# CryptoLivePoolPipelines [Chinese README](README.zh-CN.md) @@ -6,7 +6,7 @@ ## What this repository is -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. +CryptoLivePoolPipelines is the QuantStrategyLab crypto live-pool and release pipeline. It is the authority for monthly crypto live-pool membership, ordering, rankings, shadow candidate tracks, and release artifacts used by CryptoStrategies. It is an evidence-producing repository. It does not place trades and should not be treated as an execution platform. @@ -28,7 +28,7 @@ CryptoStrategies and BinancePlatform should consume only release artifacts that ## What the artifacts are for -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. +Live-pool 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. ## Repository layout diff --git a/README.zh-CN.md b/README.zh-CN.md index 60f7375..012ee8b 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -1,4 +1,4 @@ -# CryptoSnapshotPipelines +# CryptoLivePoolPipelines [English README](README.md) @@ -6,7 +6,7 @@ ## 这个仓库是什么 -CryptoSnapshotPipelines 是 QuantStrategyLab 的加密货币 snapshot 与发布流水线。它是月度加密 live-pool 成员、顺序、ranking、shadow candidate tracks 和发布产物的权威来源，供 CryptoStrategies 使用。 +CryptoLivePoolPipelines 是 QuantStrategyLab 的加密货币 live-pool 与发布流水线。它是月度加密 live-pool 成员、顺序、ranking、shadow candidate tracks 和发布产物的权威来源，供 CryptoStrategies 使用。 这是一个产出证据的仓库，不直接下单，也不应该被当作执行平台。 @@ -28,7 +28,7 @@ CryptoStrategies 和 BinancePlatform 应只消费通过 contract 检查的发布 ## 这些产物用来做什么 -Snapshot artifact 的作用是让策略判断可复现：包括 ranking 输入、live-pool snapshot、manifest、validation summary 和提升证据。`live_pool.json` 和 `artifact_manifest.json` 是稳定的下游执行合约；ranking 文件和研究输出默认留在上游作为证据，除非合约明确提升它们。它们不是宣传式收益承诺。下游仓库提升 profile 前，应在适用场景下检查最新短、中、长周期产物。 +Live-pool artifact 的作用是让策略判断可复现：包括 ranking 输入、live-pool snapshot、manifest、validation summary 和提升证据。`live_pool.json` 和 `artifact_manifest.json` 是稳定的下游执行合约；ranking 文件和研究输出默认留在上游作为证据，除非合约明确提升它们。它们不是宣传式收益承诺。下游仓库提升 profile 前，应在适用场景下检查最新短、中、长周期产物。 ## 月度 review 自动化 diff --git a/SECURITY.md b/SECURITY.md index abd7421..1120518 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -3,12 +3,12 @@ ## 中文摘要 -- 用途：本文档围绕 `Security Policy`，用于理解 `CryptoSnapshotPipelines` 的配置、运行、部署、研究或验收边界。 +- 用途：本文档围绕 `Security Policy`，用于理解 `CryptoLivePoolPipelines` 的配置、运行、部署、研究或验收边界。 - 主要覆盖：`Reporting a Vulnerability`、`Secret and Credential Exposure`、`Scope Notes`。 - 阅读顺序：先确认边界、输入输出和权限要求，再执行文档里的命令、CI、dry-run、发布或切换步骤。 - 风险提示：涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更，必须先在测试环境或 dry-run 验证；不要只凭示例直接修改生产。 - 英文正文保留更完整的命令、字段名和配置键；如果摘要和正文不一致，以正文中的实际命令和配置为准。 -Thanks for helping keep `CryptoSnapshotPipelines` safe. +Thanks for helping keep `CryptoLivePoolPipelines` safe. This repository is part of a research and release pipeline. Please do **not** open a public issue for vulnerabilities involving credentials, broker access, cloud resources, order execution, or secret material. diff --git a/docs/external_data_roadmap.md b/docs/external_data_roadmap.md index a440e8a..18a663d 100644 --- a/docs/external_data_roadmap.md +++ b/docs/external_data_roadmap.md @@ -3,7 +3,7 @@ ## 中文摘要 -- 用途：本文档围绕 `External Data Roadmap`，用于理解 `CryptoSnapshotPipelines` 的配置、运行、部署、研究或验收边界。 +- 用途：本文档围绕 `External Data Roadmap`，用于理解 `CryptoLivePoolPipelines` 的配置、运行、部署、研究或验收边界。 - 主要覆盖：`Why Binance-Only Is Not Enough`、`First-Priority External Enhancements`、`Current Preparation Implemented`、`Merge Rules`、`Validation Needed Before Production Enablement`。 - 阅读顺序：先确认边界、输入输出和权限要求，再执行文档里的命令、CI、dry-run、发布或切换步骤。 - 风险提示：涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更，必须先在测试环境或 dry-run 验证；不要只凭示例直接修改生产。 diff --git a/docs/external_data_validation.md b/docs/external_data_validation.md index 1545c79..6030ddd 100644 --- a/docs/external_data_validation.md +++ b/docs/external_data_validation.md @@ -3,7 +3,7 @@ ## 中文摘要 -- 用途：本文档围绕 `External Data Validation`，用于理解 `CryptoSnapshotPipelines` 的配置、运行、部署、研究或验收边界。 +- 用途：本文档围绕 `External Data Validation`，用于理解 `CryptoLivePoolPipelines` 的配置、运行、部署、研究或验收边界。 - 主要覆盖：`Current External-Data Policy`、`Why DOGEUSDT Is Now A Cautious Holdout`、`Providers Used`、`Quality Gate`、`Current Quality Report`。 - 阅读顺序：先确认边界、输入输出和权限要求，再执行文档里的命令、CI、dry-run、发布或切换步骤。 - 风险提示：涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更，必须先在测试环境或 dry-run 验证；不要只凭示例直接修改生产。 diff --git a/docs/integration_contract.md b/docs/integration_contract.md index c62d259..d46ec2e 100644 --- a/docs/integration_contract.md +++ b/docs/integration_contract.md @@ -3,12 +3,12 @@ ## 中文摘要 -- 用途：本文档围绕 `Integration Contract`，用于理解 `CryptoSnapshotPipelines` 的配置、运行、部署、研究或验收边界。 +- 用途：本文档围绕 `Integration Contract`，用于理解 `CryptoLivePoolPipelines` 的配置、运行、部署、研究或验收边界。 - 主要覆盖：`Canonical Downstream Files`、``artifact_manifest.json``、``live_pool_legacy.json``、``live_pool.json``、`Firestore Contract`。 - 阅读顺序：先确认边界、输入输出和权限要求，再执行文档里的命令、CI、dry-run、发布或切换步骤。 - 风险提示：涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更，必须先在测试环境或 dry-run 验证；不要只凭示例直接修改生产。 - 英文正文保留更完整的命令、字段名和配置键；如果摘要和正文不一致，以正文中的实际命令和配置为准。 -This document defines the production contract exposed by `CryptoSnapshotPipelines` to downstream strategy systems. +This document defines the production contract exposed by `CryptoLivePoolPipelines` to downstream strategy systems. The current v1 artifact namespace remains `crypto-leader-rotation` for compatibility with existing published objects and downstream readers. The upstream project publishes a monthly `core_major` live pool and exposes it through: @@ -19,7 +19,7 @@ The upstream project publishes a monthly `core_major` live pool and exposes it t ## Authority Boundary -`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. +`CryptoLivePoolPipelines` 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. 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. @@ -29,7 +29,7 @@ Downstream systems may apply runtime execution gates, sell rules, top-N selectio This profile-aware manifest is the canonical contract wrapper for downstream runtimes. It lets the execution platform validate the artifact family without -binding to `CryptoSnapshotPipelines` internals. +binding to `CryptoLivePoolPipelines` internals. Required stable fields: diff --git a/docs/operator_runbook.md b/docs/operator_runbook.md index 5e8430a..07b7bba 100644 --- a/docs/operator_runbook.md +++ b/docs/operator_runbook.md @@ -3,7 +3,7 @@ ## 中文摘要 -- 用途：本文档围绕 `Operator Runbook`，用于理解 `CryptoSnapshotPipelines` 的配置、运行、部署、研究或验收边界。 +- 用途：本文档围绕 `Operator Runbook`，用于理解 `CryptoLivePoolPipelines` 的配置、运行、部署、研究或验收边界。 - 主要覆盖：`Scope`、`Research Path Vs Production Path`、`Upstream Reporting Responsibilities`、`Monthly Codex Remediation`、`Standard Monthly Flow`。 - 阅读顺序：先确认边界、输入输出和权限要求，再执行文档里的命令、CI、dry-run、发布或切换步骤。 - 风险提示：涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更，必须先在测试环境或 dry-run 验证；不要只凭示例直接修改生产。 @@ -11,7 +11,7 @@ ## Scope -This runbook covers the production release path for `CryptoSnapshotPipelines`. +This runbook covers the production release path for `CryptoLivePoolPipelines`. Primary production outputs: diff --git a/docs/validation_status.md b/docs/validation_status.md index 9d77b62..04b1e2b 100644 --- a/docs/validation_status.md +++ b/docs/validation_status.md @@ -3,7 +3,7 @@ ## 中文摘要 -- 用途：本文档围绕 `Validation Status`，用于理解 `CryptoSnapshotPipelines` 的配置、运行、部署、研究或验收边界。 +- 用途：本文档围绕 `Validation Status`，用于理解 `CryptoLivePoolPipelines` 的配置、运行、部署、研究或验收边界。 - 主要覆盖：`Frozen Default`、`Current Strategy Validation Snapshot`、`Publish Chain Validation Completed`、`External Data Preparation Validation Completed`、`Not Finished Yet`。 - 阅读顺序：先确认边界、输入输出和权限要求，再执行文档里的命令、CI、dry-run、发布或切换步骤。 - 风险提示：涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更，必须先在测试环境或 dry-run 验证；不要只凭示例直接修改生产。 diff --git a/scripts/run_monthly_build_telegram.py b/scripts/run_monthly_build_telegram.py index 11e52e4..8feaa90 100644 --- a/scripts/run_monthly_build_telegram.py +++ b/scripts/run_monthly_build_telegram.py @@ -161,7 +161,7 @@ def format_message(payload: dict[str, Any]) -> str: else "shadow: not_generated_in_this_run" ) lines = [ - "CryptoSnapshotPipelines monthly release", + "CryptoLivePoolPipelines monthly release", f"status: {payload['status']}", f"as_of_date: {payload['as_of_date']}", ( diff --git a/scripts/run_monthly_report_bundle.py b/scripts/run_monthly_report_bundle.py index 812e3c5..2e0d821 100644 --- a/scripts/run_monthly_report_bundle.py +++ b/scripts/run_monthly_report_bundle.py @@ -141,7 +141,7 @@ def render_ai_review_input(bundle: dict[str, Any], release_status_md: str, month ## Review intent -- This is an upstream selector review for CryptoSnapshotPipelines, not a downstream execution report. +- This is an upstream selector review for CryptoLivePoolPipelines, not a downstream execution report. - The main question is whether the current monthly 5-symbol pool still looks like a sound production selector output, and what additional research evidence is still missing. - Shadow / challenger coverage should be used for strategy-optimization judgment when available. If missing, treat optimization evidence as incomplete rather than forcing a strong conclusion. - Downstream BinancePlatform consumes this pool monthly and then applies its own execution logic on top. diff --git a/tests/test_monthly_report_bundle.py b/tests/test_monthly_report_bundle.py index 4838869..0454a36 100644 --- a/tests/test_monthly_report_bundle.py +++ b/tests/test_monthly_report_bundle.py @@ -48,7 +48,7 @@ def write_fixture_files(self, root: Path) -> Path: encoding="utf-8", ) (output_dir / "monthly_review_prompt.md").write_text("Monthly release review prompt\n", encoding="utf-8") - (output_dir / "monthly_telegram.txt").write_text("CryptoSnapshotPipelines monthly release\n", encoding="utf-8") + (output_dir / "monthly_telegram.txt").write_text("CryptoLivePoolPipelines monthly release\n", encoding="utf-8") return output_dir def test_write_bundle_copies_files_and_writes_manifest(self) -> None: