# filecoin-pin - Doramagic AI Context Pack

> 定位：安装前体验与判断资产。它帮助宿主 AI 有一个好的开始，但不代表已经安装、执行或验证目标项目。

## 充分原则

- **充分原则，不是压缩原则**：AI Context Pack 应该充分到让宿主 AI 在开工前理解项目价值、能力边界、使用入口、风险和证据来源；它可以分层组织，但不以最短摘要为目标。
- **压缩策略**：只压缩噪声和重复内容，不压缩会影响判断和开工质量的上下文。

## 给宿主 AI 的使用方式

你正在读取 Doramagic 为 filecoin-pin 编译的 AI Context Pack。请把它当作开工前上下文：帮助用户理解适合谁、能做什么、如何开始、哪些必须安装后验证、风险在哪里。不要声称你已经安装、运行或执行了目标项目。

## Claim 消费规则

- **事实来源**：Repo Evidence + Claim/Evidence Graph；Human Wiki 只提供显著性、术语和叙事结构。
- **事实最低状态**：`supported`
- `supported`：可以作为项目事实使用，但回答中必须引用 claim_id 和证据路径。
- `weak`：只能作为低置信度线索，必须要求用户继续核实。
- `inferred`：只能用于风险提示或待确认问题，不能包装成项目事实。
- `unverified`：不得作为事实使用，应明确说证据不足。
- `contradicted`：必须展示冲突来源，不得替用户强行选择一个版本。

## 它最适合谁

- **想在安装前理解开源项目价值和边界的用户**：当前证据主要来自项目文档。 证据：`README.md` Claim：`clm_0002` supported 0.86

## 它能做什么

- **命令行启动或安装流程**（需要安装后验证）：项目文档中存在可执行命令，真实使用需要在本地或宿主环境中运行这些命令。 证据：`README.md` Claim：`clm_0001` supported 0.86

## 怎么开始

- `npm install -g filecoin-pin` 证据：`README.md` Claim：`clm_0003` supported 0.86

## 继续前判断卡

- **当前建议**：需要管理员/安全审批
- **为什么**：继续前可能涉及密钥、账号、外部服务或敏感上下文，建议先经过管理员或安全审批。

### 30 秒判断

- **现在怎么做**：需要管理员/安全审批
- **最小安全下一步**：先跑 Prompt Preview；若涉及凭证或企业环境，先审批再试装
- **先别相信**：真实输出质量不能在安装前相信。
- **继续会触碰**：命令执行、宿主 AI 配置、本地环境或项目文件

### 现在可以相信

- **适合人群线索：想在安装前理解开源项目价值和边界的用户**（supported）：有 supported claim 或项目证据支撑，但仍不等于真实安装效果。 证据：`README.md` Claim：`clm_0002` supported 0.86
- **能力存在：命令行启动或安装流程**（supported）：可以相信项目包含这类能力线索；是否适合你的具体任务仍要试用或安装后验证。 证据：`README.md` Claim：`clm_0001` supported 0.86
- **存在 Quick Start / 安装命令线索**（supported）：可以相信项目文档出现过启动或安装入口；不要因此直接在主力环境运行。 证据：`README.md` Claim：`clm_0003` supported 0.86

### 现在还不能相信

- **真实输出质量不能在安装前相信。**（unverified）：Prompt Preview 只能展示引导方式，不能证明真实项目中的结果质量。
- **宿主 AI 版本兼容性不能在安装前相信。**（unverified）：Claude、Cursor、Codex、Gemini 等宿主加载规则和版本差异必须在真实环境验证。
- **不会污染现有宿主 AI 行为，不能直接相信。**（inferred）：Skill、plugin、AGENTS/CLAUDE/GEMINI 指令可能改变宿主 AI 的默认行为。 证据：`AGENTS.md`
- **可安全回滚不能默认相信。**（unverified）：除非项目明确提供卸载和恢复说明，否则必须先在隔离环境验证。
- **真实安装后是否与用户当前宿主 AI 版本兼容？**（unverified）：兼容性只能通过实际宿主环境验证。
- **项目输出质量是否满足用户具体任务？**（unverified）：安装前预览只能展示流程和边界，不能替代真实评测。
- **安装命令是否需要网络、权限或全局写入？**（unverified）：这影响企业环境和个人环境的安装风险。 证据：`README.md`

### 继续会触碰什么

- **命令执行**：包管理器、网络下载、本地插件目录、项目配置或用户主目录。 原因：运行第一条命令就可能产生环境改动；必须先判断是否值得跑。 证据：`README.md`
- **宿主 AI 配置**：Claude/Codex/Cursor/Gemini/OpenCode 等宿主的 plugin、Skill 或规则加载配置。 原因：宿主配置会改变 AI 后续工作方式，可能和用户已有规则冲突。 证据：`AGENTS.md`
- **本地环境或项目文件**：安装结果、插件缓存、项目配置或本地依赖目录。 原因：安装前无法证明写入范围和回滚方式，需要隔离验证。 证据：`README.md`
- **环境变量 / API Key**：项目入口文档明确出现 API key、token、secret 或账号凭证配置。 原因：如果真实安装需要凭证，应先使用测试凭证并经过权限/合规判断。 证据：`AGENTS.md`, `DEVELOPMENT.md`, `README.md`, `src/core/payments/README.md` 等
- **宿主 AI 上下文**：AI Context Pack、Prompt Preview、Skill 路由、风险规则和项目事实。 原因：导入上下文会影响宿主 AI 后续判断，必须避免把未验证项包装成事实。

### 最小安全下一步

- **先跑 Prompt Preview**：用安装前交互式试用判断工作方式是否匹配，不需要授权或改环境。（适用：任何项目都适用，尤其是输出质量未知时。）
- **只在隔离目录或测试账号试装**：避免安装命令污染主力宿主 AI、真实项目或用户主目录。（适用：存在命令执行、插件配置或本地写入线索时。）
- **先备份宿主 AI 配置**：Skill、plugin、规则文件可能改变 Claude/Cursor/Codex 的默认行为。（适用：存在插件 manifest、Skill 或宿主规则入口时。）
- **不要使用真实生产凭证**：环境变量/API key 一旦进入宿主或工具链，可能产生账号和合规风险。（适用：出现 API、TOKEN、KEY、SECRET 等环境线索时。）
- **安装后只验证一个最小任务**：先验证加载、兼容、输出质量和回滚，再决定是否深用。（适用：准备从试用进入真实工作流时。）

### 退出方式

- **保留安装前状态**：记录原始宿主配置和项目状态，后续才能判断是否可恢复。
- **准备移除宿主 plugin / Skill / 规则入口**：如果试装后行为异常，可以把宿主 AI 恢复到试装前状态。
- **记录安装命令和写入路径**：没有明确卸载说明时，至少要知道哪些目录或配置需要手动清理。
- **准备撤销测试 API key 或 token**：测试凭证泄露或误用时，可以快速止损。
- **如果没有回滚路径，不进入主力环境**：不可回滚是继续前阻断项，不应靠信任或运气继续。

## 哪些只能预览

- 解释项目适合谁和能做什么
- 基于项目文档演示典型对话流程
- 帮助用户判断是否值得安装或继续研究

## 哪些必须安装后验证

- 真实安装 Skill、插件或 CLI
- 执行脚本、修改本地文件或访问外部服务
- 验证真实输出质量、性能和兼容性

## 边界与风险判断卡

- **把安装前预览误认为真实运行**：用户可能高估项目已经完成的配置、权限和兼容性验证。 处理方式：明确区分 prompt_preview_can_do 与 runtime_required。 Claim：`clm_0004` inferred 0.45
- **命令执行会修改本地环境**：安装命令可能写入用户主目录、宿主插件目录或项目配置。 处理方式：先在隔离环境或测试账号中运行。 证据：`README.md` Claim：`clm_0005` supported 0.86
- **待确认**：真实安装后是否与用户当前宿主 AI 版本兼容？。原因：兼容性只能通过实际宿主环境验证。
- **待确认**：项目输出质量是否满足用户具体任务？。原因：安装前预览只能展示流程和边界，不能替代真实评测。
- **待确认**：安装命令是否需要网络、权限或全局写入？。原因：这影响企业环境和个人环境的安装风险。

## 开工前工作上下文

### 加载顺序

- 先读取 how_to_use.host_ai_instruction，建立安装前判断资产的边界。
- 读取 claim_graph_summary，确认事实来自 Claim/Evidence Graph，而不是 Human Wiki 叙事。
- 再读取 intended_users、capabilities 和 quick_start_candidates，判断用户是否匹配。
- 需要执行具体任务时，优先查 role_skill_index，再查 evidence_index。
- 遇到真实安装、文件修改、网络访问、性能或兼容性问题时，转入 risk_card 和 boundaries.runtime_required。

### 任务路由

- **命令行启动或安装流程**：先说明这是安装后验证能力，再给出安装前检查清单。 边界：必须真实安装或运行后验证。 证据：`README.md` Claim：`clm_0001` supported 0.86

### 上下文规模

- 文件总数：240
- 重要文件覆盖：40/240
- 证据索引条目：68
- 角色 / Skill 条目：19

### 证据不足时的处理

- **missing_evidence**：说明证据不足，要求用户提供目标文件、README 段落或安装后验证记录；不要补全事实。
- **out_of_scope_request**：说明该任务超出当前 AI Context Pack 证据范围，并建议用户先查看 Human Manual 或真实安装后验证。
- **runtime_request**：给出安装前检查清单和命令来源，但不要替用户执行命令或声称已执行。
- **source_conflict**：同时展示冲突来源，标记为待核实，不要强行选择一个版本。

## Prompt Recipes

### 适配判断

- 目标：判断这个项目是否适合用户当前任务。
- 预期输出：适配结论、关键理由、证据引用、安装前可预览内容、必须安装后验证内容、下一步建议。

```text
请基于 filecoin-pin 的 AI Context Pack，先问我 3 个必要问题，然后判断它是否适合我的任务。回答必须包含：适合谁、能做什么、不能做什么、是否值得安装、证据来自哪里。所有项目事实必须引用 evidence_refs、source_paths 或 claim_id。
```

### 安装前体验

- 目标：让用户在安装前感受核心工作流，同时避免把预览包装成真实能力或营销承诺。
- 预期输出：一段带边界标签的体验剧本、安装后验证清单和谨慎建议；不含真实运行承诺或强营销表述。

```text
请把 filecoin-pin 当作安装前体验资产，而不是已安装工具或真实运行环境。

请严格输出四段：
1. 先问我 3 个必要问题。
2. 给出一段“体验剧本”：用 [安装前可预览]、[必须安装后验证]、[证据不足] 三种标签展示它可能如何引导工作流。
3. 给出安装后验证清单：列出哪些能力只有真实安装、真实宿主加载、真实项目运行后才能确认。
4. 给出谨慎建议：只能说“值得继续研究/试装”“先补充信息后再判断”或“不建议继续”，不得替项目背书。

硬性边界：
- 不要声称已经安装、运行、执行测试、修改文件或产生真实结果。
- 不要写“自动适配”“确保通过”“完美适配”“强烈建议安装”等承诺性表达。
- 如果描述安装后的工作方式，必须使用“如果安装成功且宿主正确加载 Skill，它可能会……”这种条件句。
- 体验剧本只能写成“示例台词/假设流程”：使用“可能会询问/可能会建议/可能会展示”，不要写“已写入、已生成、已通过、正在运行、正在生成”。
- Prompt Preview 不负责给安装命令；如用户准备试装，只能提示先阅读 Quick Start 和 Risk Card，并在隔离环境验证。
- 所有项目事实必须来自 supported claim、evidence_refs 或 source_paths；inferred/unverified 只能作风险或待确认项。

```

### 角色 / Skill 选择

- 目标：从项目里的角色或 Skill 中挑选最匹配的资产。
- 预期输出：候选角色或 Skill 列表，每项包含适用场景、证据路径、风险边界和是否需要安装后验证。

```text
请读取 role_skill_index，根据我的目标任务推荐 3-5 个最相关的角色或 Skill。每个推荐都要说明适用场景、可能输出、风险边界和 evidence_refs。
```

### 风险预检

- 目标：安装或引入前识别环境、权限、规则冲突和质量风险。
- 预期输出：环境、权限、依赖、许可、宿主冲突、质量风险和未知项的检查清单。

```text
请基于 risk_card、boundaries 和 quick_start_candidates，给我一份安装前风险预检清单。不要替我执行命令，只说明我应该检查什么、为什么检查、失败会有什么影响。
```

### 宿主 AI 开工指令

- 目标：把项目上下文转成一次对话开始前的宿主 AI 指令。
- 预期输出：一段边界明确、证据引用明确、适合复制给宿主 AI 的开工前指令。

```text
请基于 filecoin-pin 的 AI Context Pack，生成一段我可以粘贴给宿主 AI 的开工前指令。这段指令必须遵守 not_runtime=true，不能声称项目已经安装、运行或产生真实结果。
```

## 角色 / Skill 索引

- 共索引 19 个角色 / Skill / 项目文档条目。

- **Filecoin Pin**（project_doc）：! NPM https://nodei.co/npm/filecoin-pin.svg?style=flat&data=n,v https://nodei.co/npm/filecoin-pin/ 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`README.md`
- **Readme**（project_doc）：Builder Cookbook https://docs.filecoin.io/builder-cookbook/filecoin-pin - Step-by-step guides and examples for using the CLI, GitHub Action, JavaScript library, and dApp demo. Start here if you're looking for practical how-to content. Filecoin Pin glossary glossary.md - A unified place for the defining the plethora of terms for the various technologies coming together under Filecoin Pin e.g., existing Filecoin block… 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`documentation/README.md`
- **Filecoin Pin Upload Action**（project_doc）：The Filecoin Pin Upload Action is a composite GitHub Action that packs a file or directory into a UnixFS CAR, uploads it to Filecoin, and publishes artifacts and context for easy reuse. 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`upload-action/README.md`
- **Synapse SDK Integration Examples**（project_doc）：Filecoin Pin is first and foremost a reference implementation. The modules in src/core/ expose the API surface we reuse across the CLI, GitHub Action, and sample integrations so that the business logic stays in one place while the surrounding UX layers remain easy to follow, fork, and remix. 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`src/core/payments/README.md`
- **Workflow Examples**（project_doc）：Ready-to-use GitHub workflow files for the Filecoin Pin Upload Action. 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`upload-action/examples/README.md`
- **Recipe: drive the filecoin-pin CLI directly**（project_doc）：Recipe: drive the filecoin-pin CLI directly 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`upload-action/examples/cli-recipe/README.md`
- **Filecoin Pin**（project_doc）：IPFS persistence layer for Filecoin with verifiable storage proofs. TypeScript library + CLI + GitHub Action. 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`AGENTS.md`
- **Contributing to filecoin-pin**（project_doc）：Thank you for your interest in contributing! Please follow these guidelines when submitting changes. 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`CONTRIBUTING.md`
- **Developing Filecoin Pin**（project_doc）：Tips and workflows for hacking on filecoin-pin itself. For user-facing docs see the top-level README ./README.md and documentation/ ./documentation/README.md . 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`DEVELOPMENT.md`
- **Purpose**（project_doc）：The steps outlined below are taken to "add a file with Filecoin Pin". This document is intended to provide more info about what happens "behind the scenes" as it uses underlying libraries like synapse glossary.md synapse and the Filecoin Onchain Cloud glossary.md filecoin-onchain-cloud offering. 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`documentation/behind-the-scenes-of-adding-a-file.md`
- **Filecoin Pin Events & Metrics**（project_doc）：This document is the intended source of truth for the events emitted by Filecoin Pin and the metrics computed from them. It is intended for Filecoin Pin dashboard consumers and maintainers who need to understand what each metric means and where it comes from. 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`documentation/events-and-metrics.md`
- **Calibration Network**（project_doc）：Filecoin Pin brings multiple technologies together i.e., existing Filecoin blockchain and storage providers, new Filecoin initiatives including Filecoin Onchain Cloud, IPFS . As a result, terminology from all these areas is used for describing Filecoin Pin. This glossary serves as a primer of the key terminology. Rather than seeking to be the comprehensive source of truth, it seeks to point to where to find authorit… 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`documentation/glossary.md`
- **Progress Events**（project_doc）：Public functions in the filecoin-pin JavaScript library report progress through a single onProgress handler that receives a discriminated union of typed events. This document describes the event shape, the naming convention, and the rules for adding new events. 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`documentation/progress-events.md`
- **Retrieving Your Data**（project_doc）：Each filecoin-pin add reports two CIDs, and they fetch different things: 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`documentation/retrieval.md`
- **Changelog**（project_doc）：1.1.0 https://github.com/filecoin-project/filecoin-pin/compare/v1.0.1...v1.1.0 2026-06-25 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`CHANGELOG.md`
- **License**（project_doc）：The contents of this repository are Copyright c corresponding authors and contributors, licensed under the Permissive License Stack meaning either of: 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`LICENSE.md`
- **Security Policy**（project_doc）：If you discover a security vulnerability in Filecoin Pin, please report it responsibly. Do not open a public issue. 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`SECURITY.md`
- **Content Routing FAQ**（project_doc）：Content Routing glossary.md content-routing is essential for making the data stored with Filecoin Pin actually retrievable by standard IPFS tooling glossary.md standard-ipfs-tooling . This document answers questions about the content routing systems Filecoin Pin relies on. 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`documentation/content-routing-faq.md`
- **Internal Flow**（project_doc）：This document explains how the action works internally and why each step exists. 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`upload-action/FLOW.md`

## 证据索引

- 共索引 68 条证据。

- **Filecoin Pin**（documentation）：! NPM https://nodei.co/npm/filecoin-pin.svg?style=flat&data=n,v https://nodei.co/npm/filecoin-pin/ 证据：`README.md`
- **Readme**（documentation）：Builder Cookbook https://docs.filecoin.io/builder-cookbook/filecoin-pin - Step-by-step guides and examples for using the CLI, GitHub Action, JavaScript library, and dApp demo. Start here if you're looking for practical how-to content. Filecoin Pin glossary glossary.md - A unified place for the defining the plethora of terms for the various technologies coming together under Filecoin Pin e.g., existing Filecoin blockchain and storage providers, new Filecoin initiatives including Filecoin Onchain Cloud, IPFS . Explainer: behind the scenes of adding a file behind-the-scenes-of-adding-a-file.md - Provides more technical info about what happens for a Filecoin Pin add as it uses the underlying Sy… 证据：`documentation/README.md`
- **Filecoin Pin Upload Action**（documentation）：The Filecoin Pin Upload Action is a composite GitHub Action that packs a file or directory into a UnixFS CAR, uploads it to Filecoin, and publishes artifacts and context for easy reuse. 证据：`upload-action/README.md`
- **Synapse SDK Integration Examples**（documentation）：Filecoin Pin is first and foremost a reference implementation. The modules in src/core/ expose the API surface we reuse across the CLI, GitHub Action, and sample integrations so that the business logic stays in one place while the surrounding UX layers remain easy to follow, fork, and remix. 证据：`src/core/payments/README.md`
- **Workflow Examples**（documentation）：Ready-to-use GitHub workflow files for the Filecoin Pin Upload Action. 证据：`upload-action/examples/README.md`
- **Recipe: drive the filecoin-pin CLI directly**（documentation）：Recipe: drive the filecoin-pin CLI directly 证据：`upload-action/examples/cli-recipe/README.md`
- **Package**（package_manifest）：{ "name": "filecoin-pin", "version": "1.1.0", "description": "Bridge IPFS content to Filecoin Onchain Cloud using familiar tools", "type": "module", "packageManager": "pnpm@10.32.1", "main": "dist/index.js", "types": "dist/index.d.ts", "browser": { "./dist/common/devnet-config.js": "./dist/common/devnet-config.browser.js" }, "exports": { ".": { "browser": { "types": "./dist/index.browser.d.ts", "default": "./dist/index.browser.js" }, "types": "./dist/index.d.ts", "default": "./dist/index.js" }, "./core": { "browser": { "types": "./dist/core/browser.d.ts", "default": "./dist/core/browser.js" }, "types": "./dist/core/index.d.ts", "default": "./dist/core/index.js" }, "./core/car": { "browser":… 证据：`package.json`
- **Package**（package_manifest）：{ "name": "filecoin-pin-upload-action-helper", "private": true, "type": "module", "version": "1.0.16", "description": "Helper runner for Filecoin Pin Upload GitHub Action", "dependencies": { "@actions/core": "^3.0.0", "@octokit/rest": "^22.0.1", "filecoin-pin": "../", "picocolors": "^1.1.1", "pino": "^10.3.1" }, "devDependencies": { "@biomejs/biome": "^2.4.4", "typescript": "^6.0.3" }, "scripts": { "lint": "pnpm run typecheck && biome check --no-errors-on-unmatched --files-ignore-unknown=true .", "lint:fix": "biome check --no-errors-on-unmatched --files-ignore-unknown=true --fix .", "typecheck": "tsc --noEmit" } } 证据：`upload-action/package.json`
- **Filecoin Pin**（documentation）：IPFS persistence layer for Filecoin with verifiable storage proofs. TypeScript library + CLI + GitHub Action. 证据：`AGENTS.md`
- **Contributing to filecoin-pin**（documentation）：Thank you for your interest in contributing! Please follow these guidelines when submitting changes. 证据：`CONTRIBUTING.md`
- **Developing Filecoin Pin**（documentation）：Tips and workflows for hacking on filecoin-pin itself. For user-facing docs see the top-level README ./README.md and documentation/ ./documentation/README.md . 证据：`DEVELOPMENT.md`
- **Purpose**（documentation）：The steps outlined below are taken to "add a file with Filecoin Pin". This document is intended to provide more info about what happens "behind the scenes" as it uses underlying libraries like synapse glossary.md synapse and the Filecoin Onchain Cloud glossary.md filecoin-onchain-cloud offering. 证据：`documentation/behind-the-scenes-of-adding-a-file.md`
- **Filecoin Pin Events & Metrics**（documentation）：This document is the intended source of truth for the events emitted by Filecoin Pin and the metrics computed from them. It is intended for Filecoin Pin dashboard consumers and maintainers who need to understand what each metric means and where it comes from. 证据：`documentation/events-and-metrics.md`
- **Calibration Network**（documentation）：Filecoin Pin brings multiple technologies together i.e., existing Filecoin blockchain and storage providers, new Filecoin initiatives including Filecoin Onchain Cloud, IPFS . As a result, terminology from all these areas is used for describing Filecoin Pin. This glossary serves as a primer of the key terminology. Rather than seeking to be the comprehensive source of truth, it seeks to point to where to find authoritative and more in depth information. Many additional IPFS-related terms can be found in https://docs.ipfs.tech/concepts/glossary. 证据：`documentation/glossary.md`
- **Progress Events**（documentation）：Public functions in the filecoin-pin JavaScript library report progress through a single onProgress handler that receives a discriminated union of typed events. This document describes the event shape, the naming convention, and the rules for adding new events. 证据：`documentation/progress-events.md`
- **Retrieving Your Data**（documentation）：Each filecoin-pin add reports two CIDs, and they fetch different things: 证据：`documentation/retrieval.md`
- **Index Types**（source_file）：import type { getDataSetPieces, getDetailedDataSet, listDataSets } from './core/data-set/index.js' import type { getPaymentStatus, setMaxAllowances, validatePaymentCapacity } from './core/payments/index.js' import type { initializeSynapse } from './core/synapse/index.js' import type { createCarFromFile, createCarFromFiles } from './core/unixfs/browser-car-builder.js' import type { createCarFromPath } from './core/unixfs/car-builder.js' import type { checkUploadReadiness, executeUpload } from './core/upload/index.js' export interface FilecoinPinAPI { getDataSetPieces: typeof getDataSetPieces getDetailedDataSet: typeof getDetailedDataSet listDataSets: typeof listDataSets getPaymentStatus: typ… 证据：`src/index-types.ts`
- **Index**（source_file）：import { createCarFromPath as createCarFromPathCore } from './core/unixfs/car-builder.js' ⋮---- import type { FilecoinPinAPI } from './index-types.js' 证据：`src/index.ts`
- **Types**（source_file）：import type { CopyResult, FailedAttempt } from '@filoz/synapse-sdk' import type { CLIAuthOptions } from '../utils/cli-auth.js' import type { CLIAutoFundOptions } from '../utils/cli-options.js' import type { EgressProvider } from '../utils/cli-options-egress.js' export interface AddOptions extends CLIAuthOptions, CLIAutoFundOptions { filePath: string copies?: number pieceMetadata?: Record dataSetMetadata?: Record skipIpniVerification?: boolean includeHidden?: boolean egressProvider?: EgressProvider } export interface AddResult { filePath: string fileSize: number isDirectory?: boolean rootCid: string pieceCid: string size: number requestedCopies: number copies: CopyResult failedAttempts: Fail… 证据：`src/add/types.ts`
- **Index**（source_file）：import type { Command } from 'commander' import { addCommand } from './add.js' import { dataSetCommand } from './data-set.js' import { importCommand } from './import.js' import { paymentsCommand } from './payments.js' import { providerCommand } from './provider.js' import { removeCommand } from './remove.js' import { serverCommand } from './server.js' import { sessionCommand } from './session.js' ⋮---- interface CliCommandGroup { heading: string commands: readonly Command } 证据：`src/commands/index.ts`
- **Car Storage Backend**（source_file）：import type { CID } from 'multiformats/cid' export interface BlockOffset { blockStart: number blockLength: number } export interface InitializeResult { headerSize: number } export interface CARStorageBackend { initialize rootCID: CID : Promise writeBlock cid: CID, block: Uint8Array, offset: BlockOffset : Promise readBlock? cid: CID, offset: BlockOffset : AsyncGenerator finalize : Promise cleanup : Promise } ⋮---- initialize rootCID: CID : Promise writeBlock cid: CID, block: Uint8Array, offset: BlockOffset : Promise readBlock? cid: CID, offset: BlockOffset : AsyncGenerator finalize : Promise cleanup : Promise 证据：`src/core/car/car-storage-backend.ts`
- **List Data Sets**（source_file）：import type { Synapse } from '@filoz/synapse-sdk' import { DEFAULT DATA SET METADATA } from '../synapse/constants.js' import { getClientAddress } from '../synapse/index.js' import type { DataSetSummary, ListDataSetsOptions } from './types.js' export async function listDataSets synapse: Synapse, options?: ListDataSetsOptions : Promise 证据：`src/core/data-set/list-data-sets.ts`
- **Types**（source_file）：import type { EnhancedDataSetInfo, PDPProvider } from '@filoz/synapse-sdk' import type { Logger } from 'pino' import type { Hex } from 'viem' import type { Warning } from '../utils/types.js' export enum PieceStatus { ACTIVE = 'ACTIVE', PENDING REMOVAL = 'PENDING REMOVAL', ONCHAIN ORPHANED = 'ONCHAIN ORPHANED', OFFCHAIN ORPHANED = 'OFFCHAIN ORPHANED', } export interface PieceInfo { pieceId: bigint pieceCid: string status: PieceStatus rootIpfsCid?: string size?: number metadata?: Record } export interface DataSetPiecesResult { pieces: PieceInfo dataSetId: bigint totalSizeBytes?: bigint warnings?: Warning } export interface DataSetSummary extends EnhancedDataSetInfo { dataSetId: bigint provide… 证据：`src/core/data-set/types.ts`
- **Index**（source_file）：export type ERC8004Type = typeof ERC8004 TYPES number ⋮---- export interface MetadataConfigInput { pieceMetadata?: Record undefined dataSetMetadata?: Record undefined erc8004Type?: ERC8004Type erc8004Agent?: string } export interface MetadataConfigResult { pieceMetadata?: Record undefined dataSetMetadata?: Record undefined } export function normalizeMetadataConfig input: MetadataConfigInput : MetadataConfigResult export function withDerivedNameMetadata pieceMetadata: Record undefined, derivedName: string null : Record undefined function sanitizeRecord record: Record undefined : Record function mergeRecord record: Record , key: string, value: string, sourceLabel: string, conflictLabel: strin… 证据：`src/core/metadata/index.ts`
- **Constants**（source_file）：import { TIME CONSTANTS } from '@filoz/synapse-core/utils' import { maxUint256, parseEther } from 'viem' 证据：`src/core/payments/constants.ts`
- **Funding**（source_file）：import { calculateUploadFees, type getPriceList } from '@filoz/synapse-core/warm-storage' import { calibration, type Synapse } from '@filoz/synapse-sdk' import { USDFC DECIMALS } from './constants.js' import { checkAndSetAllowances, computeAdjustmentForExactDays, computeAdjustmentForExactDaysWithPiece, computeAdjustmentForExactDeposit, depositUSDFC, getPaymentStatus, validatePaymentRequirements, withdrawUSDFC, } from './index.js' import { toStorageRunwaySummary } from './runway.js' import type { AccountSummary, FilecoinPayFundingExecution, FilecoinPayFundingInsights, FilecoinPayFundingPlan, FilecoinPayFundingPlanOptions, FundingMode, FundingReasonCode, PaymentStatus, ServiceApprovalStatus,… 证据：`src/core/payments/funding.ts`
- **Index**（source_file）：import { isFwssMaxApproved } from '@filoz/synapse-core/pay' import { DEFAULT BUFFER EPOCHS } from '@filoz/synapse-core/utils' import { calculateAdditionalLockupRequired, calculateBufferAmount, calculateRunwayAmount, type getPriceList, } from '@filoz/synapse-core/warm-storage' import { calibration, SIZE CONSTANTS, type Synapse, TIME CONSTANTS, TOKENS } from '@filoz/synapse-sdk' import { formatUnits, type Hash } from 'viem' import { getClientAddress, isSessionKeyMode } from '../synapse/index.js' import { formatFIL } from '../utils/format.js' import { assertPriceNonZero } from '../utils/validate-pricing.js' import { DEFAULT LOCKUP DAYS, MAX LOCKUP ALLOWANCE, MAX RATE ALLOWANCE, MIN FIL FOR GAS… 证据：`src/core/payments/index.ts`
- **Top Up**（source_file）：import type { Synapse } from '@filoz/synapse-sdk' import type { Logger } from 'pino' import { formatUSDFC } from '../utils/index.js' import { depositUSDFC, getPaymentStatus } from './index.js' import type { TopUpResult } from './types.js' export interface ClampDepositResult { deposit: bigint reason: 'passthrough' 'already-at-limit' 'clamped' message?: string } export function clampDepositToLimit currentBalance: bigint, requested: bigint, limit?: bigint : ClampDepositResult export async function executeTopUp synapse: Synapse, topUpAmount: bigint, options: { balanceLimit?: bigint undefined logger?: Logger undefined } = {} : Promise 证据：`src/core/payments/top-up.ts`
- **Types**（source_file）：import type { operatorApprovals } from '@filoz/synapse-core/pay' import type { getPriceList } from '@filoz/synapse-core/warm-storage' export type ServiceApprovalStatus = operatorApprovals.OutputType export interface PaymentStatus { network: string chainId: number address: string filBalance: bigint walletUsdfcBalance: bigint filecoinPayBalance: bigint currentAllowances: ServiceApprovalStatus } export interface StorageAllowances { rateAllowance: bigint lockupAllowance: bigint storageCapacityTiB: number } export type StorageRunwayState = 'no-spend' 'active' export interface StorageRunwaySummary { state: StorageRunwayState rateUsed: bigint perDay: bigint lockupUsed: bigint availableFunds: bigin… 证据：`src/core/payments/types.ts`
- **Types**（source_file）：import type { Permission } from '@filoz/synapse-core/session-key' import type { Address, Hash, Hex } from 'viem' import type { ProgressEvent } from '../utils/types.js' export type AuthorizeSessionProgressEvents = ProgressEvent ProgressEvent ProgressEvent export type CreateSessionKeyProgressEvents = AuthorizeSessionProgressEvents ProgressEvent ProgressEvent export type RevokeSessionProgressEvents = ProgressEvent ProgressEvent ProgressEvent export interface SessionKeypair { privateKey: Hex address: Address } export interface AuthorizeSessionResult { ownerAddress: Address sessionAddress: Address registryAddress: Address permissions: readonly Permission expiry: number validityDays: number txHas… 证据：`src/core/session/types.ts`
- **Constants**（source_file）：import { METADATA KEYS } from '@filoz/synapse-sdk' ⋮---- METADATA KEYS.WITH IPFS INDEXING : '', // Enable IPFS indexing for all data sets METADATA KEYS.SOURCE : APPLICATION SOURCE, // Identify the source application ⋮---- / Default number of copies replication factor used when the caller doesn't specify --copies. Mirrors synapse-sdk's internal DEFAULT COPY COUNT @filoz/synapse-sdk/src/storage/manager.ts , which is not exported. Keep in sync if upstream changes. / 证据：`src/core/synapse/constants.ts`
- **Index**（source_file）：import { type Chain, calibration, mainnet, Synapse, type SynapseOptions } from '@filoz/synapse-sdk' ⋮---- import type { SessionKey } from '@filoz/synapse-core/session-key' import { AddPiecesPermission, CreateDataSetPermission, DefaultFwssPermissions, fromSecp256k1, SchedulePieceRemovalsPermission, TerminateServicePermission, } from '@filoz/synapse-core/session-key' import type { Logger } from 'pino' import { type Account, type Address, custom, getAddress, type Hex, type HttpTransport, type WebSocketTransport, } from 'viem' import { privateKeyToAccount } from 'viem/accounts' import { APPLICATION SOURCE } from './constants.js' import { createTransport } from './create-transport.js' import { r… 证据：`src/core/synapse/index.ts`
- **Index**（source_file）：import type { UploadResult } from '@filoz/synapse-sdk' import { METRIC UPLOAD COPY BYTES, METRIC UPLOAD COPY STATUS, METRICS ENDPOINT, METRICS TOKEN } from './constants.js' ⋮---- export type Affordance = typeof AFFORDANCES number ⋮---- export interface TelemetryConfiguration { disabled: boolean affordance: Affordance } interface MetricPoint { name: string type: 'counter' 'gauge' value: number tags: Record } ⋮---- export function configureTelemetry overrides: Partial : void function classifyFailure error: string : string async function post points: MetricPoint : Promise export function recordUploadResult result: Pick , network: string : void ⋮---- const pushPair = tags: Record = ⋮---- export… 证据：`src/core/telemetry/index.ts`
- **Index**（source_file）：import { stat } from 'node:fs/promises' import type { Logger } from 'pino' import { type CreateCarOptions, type CreateCarResult, cleanupTempCar, createCarFromPath } from './car-builder.js' ⋮---- export interface CarBuildResult { carPath: string rootCid: string name: string size?: number } export interface FileBuilder { buildCar sourcePath: string, options?: CreateCarOptions : Promise cleanup carPath: string, logger?: Logger : Promise } ⋮---- buildCar sourcePath: string, options?: CreateCarOptions : Promise cleanup carPath: string, logger?: Logger : Promise ⋮---- export function createUnixfsCarBuilder : FileBuilder ⋮---- async buildCar sourcePath: string, options: CreateCarOptions = async cl… 证据：`src/core/unixfs/index.ts`
- **Index**（source_file）：import type { Chain, PDPProvider, Synapse } from '@filoz/synapse-sdk' import { calibration, mainnet } from '@filoz/synapse-sdk' import type { StorageContext } from '@filoz/synapse-sdk/storage' import type { CID } from 'multiformats/cid' import type { Logger } from 'pino' import { DEVNET CHAIN ID } from '../../common/constants.js' import { checkAllowances, checkFILBalance, checkUSDFCBalance, type PaymentCapacityCheck, setMaxAllowances, validatePaymentCapacity, validatePaymentRequirements, } from '../payments/index.js' import { isSessionKeyMode } from '../synapse/index.js' import { recordUploadResult } from '../telemetry/index.js' import type { ProgressEvent, ProgressEventHandler } from '../u… 证据：`src/core/upload/index.ts`
- **Format**（source_file）：import { formatEther, formatUnits } from 'viem' import { USDFC DECIMALS } from '../payments/constants.js' import type { StorageRunwaySummary } from '../payments/types.js' ⋮---- export function formatUSDFC amount: bigint, decimals = 4 : string export function formatFIL amount: bigint, isTestnet: boolean, decimals = 4 : string export function formatRunwayDuration days: number, hoursRemainder: number = 0 : string ⋮---- // Medium durations: months + days ⋮---- // Large durations: years + months + days ⋮---- / Coverage and runway strings for CLI/action output. - coverage : total time the deposit covers including currently-locked funds. - runway : time until top-up is required to keep paying ongo… 证据：`src/core/utils/format.ts`
- **Types**（source_file）：export type AnyProgressEvent = { type: string; data?: unknown } export type ProgressEvent = D extends undefined ? { type: T } : { type: T; data: D } export type ProgressEventHandler = event: E = void export interface Warning { code: string message: string context?: Record } 证据：`src/core/utils/types.ts`
- **Types**（source_file）：import type { CLIAuthOptions } from '../utils/cli-auth.js' export interface DataSetCommandOptions extends CLIAuthOptions { wait?: boolean } export interface DataSetListCommandOptions extends CLIAuthOptions { all?: boolean undefined dataSetMetadata?: Record } 证据：`src/data-set/types.ts`
- **Types**（source_file）：import type { CopyResult, FailedAttempt } from '@filoz/synapse-sdk' import type { CLIAuthOptions } from '../utils/cli-auth.js' import type { CLIAutoFundOptions } from '../utils/cli-options.js' import type { EgressProvider } from '../utils/cli-options-egress.js' export interface ImportOptions extends CLIAuthOptions, CLIAutoFundOptions { filePath: string copies?: number pieceMetadata?: Record dataSetMetadata?: Record skipIpniVerification?: boolean egressProvider?: EgressProvider } export interface ImportResult { filePath: string fileSize: number rootCid: string pieceCid: string size: number requestedCopies: number copies: CopyResult failedAttempts: FailedAttempt } 证据：`src/import/types.ts`
- **Types**（source_file）：import type { Synapse } from '@filoz/synapse-sdk' import type { FundingMode } from '../core/payments/types.js' import type { CLIAuthOptions } from '../utils/cli-auth.js' import type { Spinner } from '../utils/cli-helpers.js' ⋮---- export interface PaymentSetupOptions extends CLIAuthOptions { auto: boolean deposit?: string rateAllowance: string } export interface AutoFundOptions { synapse: Synapse fileSize: number copies?: number providerIds?: bigint dataSetIds?: bigint metadata?: Record withCDN?: boolean spinner?: Spinner minRunwayDays?: number maxBalance?: bigint } export interface FundingAdjustmentResult { adjusted: boolean delta: bigint transactionHash?: string undefined newDepositedAmou… 证据：`src/payments/types.ts`
- **Types**（source_file）：import type { CLIAuthOptions } from '../utils/cli-auth.js' export interface ProviderListOptions extends CLIAuthOptions { all?: boolean endorsed?: boolean } export interface ProviderShowOptions extends CLIAuthOptions { } export interface ProviderPingOptions extends CLIAuthOptions { all?: boolean } 证据：`src/provider/types.ts`
- **Types**（source_file）：import type { PieceRemovalResult } from '../core/piece/remove-all-pieces.js' import type { CLIAuthOptions } from '../utils/cli-auth.js' export interface RmPieceOptions extends CLIAuthOptions { piece: string dataSet: string waitForConfirmation?: boolean } export interface RmPieceResult { pieceCid: string dataSetId: number transactionHash: string confirmed: boolean } export interface RmAllPiecesOptions extends CLIAuthOptions { dataSet: string all: true force?: boolean waitForConfirmation?: boolean } export interface RmAllPiecesResult { dataSetId: number totalPieces: number removedCount: number failedCount: number transactions: PieceRemovalResult } 证据：`src/rm/types.ts`
- **Format**（source_file）：import type { AuthorizeSessionResult, CreateSessionKeyResult, RevokeSessionResult, SessionKeypair, } from '../core/session/index.js' function formatExpiry epochSeconds: number : string export function formatCreateSessionKeyOutput result: CreateSessionKeyResult : string export function formatAuthorizeSessionOutput result: AuthorizeSessionResult : string export function formatRevokeSessionOutput result: RevokeSessionResult : string export function formatSessionKeypairOutput keypair: SessionKeypair : string 证据：`src/session/format.ts`
- **Types**（source_file）：export interface SessionCreateOptions { privateKey?: string network?: string rpcUrl?: string sessionKey?: string validityDays?: string } export interface SessionAuthorizeOptions { privateKey?: string network?: string rpcUrl?: string validityDays?: string sessionAddress: string } export interface SessionRevokeOptions { privateKey?: string network?: string rpcUrl?: string sessionAddress: string } 证据：`src/session/types.ts`
- **Cli Auth**（source_file）：import type { Chain, Synapse } from '@filoz/synapse-sdk' import { getRpcUrl, NETWORK CHAINS, resolveDevnetConfig } from '../common/get-rpc-url.js' import type { SynapseSetupConfig } from '../core/synapse/index.js' import { initializeSynapse } from '../core/synapse/index.js' import { createLogger } from '../logger.js' export interface CLIAuthOptions { privateKey?: string undefined walletAddress?: string undefined sessionKey?: string undefined viewAddress?: string undefined network?: string undefined rpcUrl?: string undefined providerIds?: string undefined dataSetIds?: string undefined } export function parseCLIAuth options: CLIAuthOptions : SynapseSetupConfig ⋮---- // For devnet, fall back t… 证据：`src/utils/cli-auth.ts`
- **Cli Helpers**（source_file）：import { cancel as clackCancel, intro as clackIntro, outro as clackOutro, spinner as clackSpinner, } from '@clack/prompts' import { isTTY, log } from './cli-logger.js' export type Spinner = { start: msg: string = void message: msg: string = void stop: msg?: string = void clear: = void } export function createSpinner : Spinner ⋮---- start msg: string message msg: string stop msg?: string clear ⋮---- export function intro message: string : void export function cancel message: string : void export function outro message: string : void ⋮---- export function formatFileSize bytes: number bigint : string function formatFileSizeBigInt bytes: bigint : string export function isInteractive : boolean 证据：`src/utils/cli-helpers.ts`
- **Cli Logger**（source_file）：import { log as clackLog } from '@clack/prompts' import pc from 'picocolors' function isTTY : boolean export function applyVerboseLogLevel verbose: boolean undefined, env: NodeJS.ProcessEnv = process.env : void ⋮---- message message: string : void line message: string : void flush : void info message: string : void success message: string : void warn message: string : void section title: string, content: string string : void spinnerSection title: string, content: string string , options: { indentLevel?: number } = { indentLevel: 1 } : void indent message: string, level: number = 1 : void newline : void 证据：`src/utils/cli-logger.ts`
- **Cli Options Metadata**（source_file）：import { type Command, Option } from 'commander' import { ERC8004 TYPES, normalizeMetadataConfig } from '../core/metadata/index.js' function collectKeyValue value: string, previous: string = : string function parseKeyValuePairs pairs: string , flagLabel: string : Record export interface MetadataOptionConfig { includePieceMetadata?: boolean includeDataSetMetadata?: boolean includeErc8004?: boolean } / Registers metadata-related Commander flags on a CLI command. Adds piece-level metadata flags by default, dataset metadata flags with alias support , and optionally ERC-8004 artifact options depending on the provided configuration. @param command Commander command to augment mutated in place @pa… 证据：`src/utils/cli-options-metadata.ts`
- **Cli Options**（source_file）：import { type Command, InvalidArgumentError, Option } from 'commander' import { parseUnits } from 'viem' import { MIN RUNWAY DAYS } from '../common/constants.js' import { normalizeNetworkName } from '../common/get-rpc-url.js' import { USDFC DECIMALS } from '../core/payments/constants.js' import { log } from './cli-logger.js' export function privateKeyOption description: string : Option export function sessionKeyOption description: string : Option export function rpcUrlOption description: string : Option export function addSigningAuthOptions command: Command : Command export function addAuthOptions command: Command : Command function collectId value: string, previous: string = : string funct… 证据：`src/utils/cli-options.ts`
- **Github**（source_file）：export async function readEventPayload export function evaluateUploadProvenance event, eventName = process.env.GITHUB EVENT NAME '' function toNumber value / Normalize PR metadata into CombinedContext.pr shape @param {any} pr @param {string} fallbackSha @returns {Partial undefined} / function normalizePr pr, fallbackSha = '' / Try to resolve PR metadata directly from a workflow run payload @param {any} workflowRun @returns {Partial undefined} / function resolveFromWorkflowRunPayload workflowRun ⋮---- / @type {any} / ⋮---- / Use the GitHub API to resolve a PR from workflow run context @param {Octokit undefined} octokit @param {any} event @returns {Promise undefined } / async function resolve… 证据：`upload-action/src/github.js`
- **Types**（source_file）：import type { CopyResult, FailedAttempt } from '@filoz/synapse-sdk' import type { PaymentStatus as FilecoinPinPaymentStatus } from 'filecoin-pin/core/payments' import type { initializeSynapse } from 'filecoin-pin/core/synapse' import type { Logger as PinoLogger } from 'pino' ⋮---- export type Synapse = Awaited export type Logger = PinoLogger export interface UploadResult { pieceCid: string pieceId: string dataSetId: string provider: { id?: string name?: string } previewUrl: string network: string ipniValidated: boolean requestedCopies: number complete: boolean copies: CopyResult failedAttempts: FailedAttempt } export interface BuildResult { contentPath: string carPath: string ipfsRootCid: s… 证据：`upload-action/src/types.ts`
- **Changelog**（documentation）：1.1.0 https://github.com/filecoin-project/filecoin-pin/compare/v1.0.1...v1.1.0 2026-06-25 证据：`CHANGELOG.md`
- **License**（documentation）：The contents of this repository are Copyright c corresponding authors and contributors, licensed under the Permissive License Stack meaning either of: 证据：`LICENSE.md`
- **Security Policy**（documentation）：If you discover a security vulnerability in Filecoin Pin, please report it responsibly. Do not open a public issue. 证据：`SECURITY.md`
- **Content Routing FAQ**（documentation）：Content Routing glossary.md content-routing is essential for making the data stored with Filecoin Pin actually retrievable by standard IPFS tooling glossary.md standard-ipfs-tooling . This document answers questions about the content routing systems Filecoin Pin relies on. 证据：`documentation/content-routing-faq.md`
- **Internal Flow**（documentation）：This document explains how the action works internally and why each step exists. 证据：`upload-action/FLOW.md`
- **.Release Please Manifest**（structured_config）：{ ".": "1.1.0" } 证据：`.release-please-manifest.json`
- **Biome**（structured_config）：{ "$schema": "./node modules/@biomejs/biome/configuration schema.json", "files": { "includes": " ", "! /node modules", "! /dist", "! /package-lock.json", "! /yarn.lock", "! /pnpm-lock.yaml", "! /bun.lockb", "! /output", "! /coverage", "! /temp", "! /.temp", "! /tmp", "! /.tmp", "! /.history", "! /.vitepress/cache", "! /.nuxt", "! /.next", "! /.vercel", "! /.changeset", "! /.idea", "! /.cache", "! /.output", "! /.vite-inspect", "! /.yarn", "! /CHANGELOG .md", "! / .min. ", "! /LICENSE ", "! / snapshots ", "! /components.d.ts", "! /mockServiceWorker.js", "! /cars", "!docs" }, "vcs": { "clientKind": "git", "enabled": true, "useIgnoreFile": true, "defaultBranch": "master" }, "formatter": { "ena… 证据：`biome.json`
- **Release Please Config**（structured_config）：{ "packages": { ".": { "release-type": "node", "changelog-path": "CHANGELOG.md", "bump-minor-pre-major": false, "bump-patch-for-minor-pre-major": false, "draft": false, "prerelease": false, "include-v-in-tag": true, "include-component-in-tag": false, "pull-request-header": "📦 Release Preparation", "pull-request-footer": "\n\n 🚀 How to Release\n\n1. Review the changelog and version bump in this PR\n2. Merge this PR to trigger the release\n3. After merging, the workflow will:\n - Create a GitHub release with tag {{version}} \n - Publish to npm automatically\n\n⚠️ Note : The release has NOT been created yet. It will only be created after you merge this PR.", "bootstrap-sha": "70e3c175e69c54fe5… 证据：`release-please-config.json`
- **Tsconfig**（structured_config）：{ "compilerOptions": { "target": "ES2022", "module": "NodeNext", "moduleResolution": "NodeNext", "lib": "ES2022", "ESNext.Collection", "DOM" , "outDir": "./dist", "rootDir": "./src", "strict": true, "esModuleInterop": true, "allowSyntheticDefaultImports": true, "skipLibCheck": true, "forceConsistentCasingInFileNames": true, "declaration": true, "declarationMap": true, "sourceMap": true, "removeComments": false, "noUnusedLocals": true, "noUnusedParameters": true, "exactOptionalPropertyTypes": true, "noImplicitReturns": true, "noFallthroughCasesInSwitch": true, "noUncheckedIndexedAccess": true, "noImplicitOverride": true, "allowUnusedLabels": false, "allowUnreachableCode": false, "resolveJson… 证据：`tsconfig.json`
- 其余 8 条证据见 `AI_CONTEXT_PACK.json` 或 `EVIDENCE_INDEX.json`。

## 宿主 AI 必须遵守的规则

- **把本资产当作开工前上下文，而不是运行环境。**：AI Context Pack 只包含证据化项目理解，不包含目标项目的可执行状态。 证据：`README.md`, `documentation/README.md`, `upload-action/README.md`
- **回答用户时区分可预览内容与必须安装后才能验证的内容。**：安装前体验的消费者价值来自降低误装和误判，而不是伪装成真实运行。 证据：`README.md`, `documentation/README.md`, `upload-action/README.md`

## 用户开工前应该回答的问题

- 你准备在哪个宿主 AI 或本地环境中使用它？
- 你只是想先体验工作流，还是准备真实安装？
- 你最在意的是安装成本、输出质量、还是和现有规则的冲突？

## 验收标准

- 所有能力声明都能回指到 evidence_refs 中的文件路径。
- AI_CONTEXT_PACK.md 没有把预览包装成真实运行。
- 用户能在 3 分钟内看懂适合谁、能做什么、如何开始和风险边界。

---

## Doramagic Context Augmentation

下面内容用于强化 Repomix/AI Context Pack 主体。Human Manual 只提供阅读骨架；踩坑日志会被转成宿主 AI 必须遵守的工作约束。

## Human Manual 骨架

使用规则：这里只是项目阅读路线和显著性信号，不是事实权威。具体事实仍必须回到 repo evidence / Claim Graph。

宿主 AI 硬性规则：
- 不得把页标题、章节顺序、摘要或 importance 当作项目事实证据。
- 解释 Human Manual 骨架时，必须明确说它只是阅读路线/显著性信号。
- 能力、安装、兼容性、运行状态和风险判断必须引用 repo evidence、source path 或 Claim Graph。

- **Project Overview & Architecture**：importance `high`
  - source_paths: README.md, documentation/README.md, documentation/behind-the-scenes-of-adding-a-file.md, documentation/glossary.md, src/cli.ts
- **CLI Commands Reference**：importance `high`
  - source_paths: src/cli.ts, src/commands/index.ts, src/commands/add.ts, src/commands/import.ts, src/commands/data-set.ts
- **JavaScript Library & Core API**：importance `high`
  - source_paths: src/index.ts, src/index-types.ts, src/index.browser.ts, src/core/index.ts, src/core/synapse/index.ts
- **Configuration, Deployment & Operations**：importance `high`
  - source_paths: README.md, DEVELOPMENT.md, src/config.ts, src/common/devnet-config.ts, src/common/get-rpc-url.ts

## Repo Inspection Evidence / 源码检查证据

- repo_clone_verified: true
- repo_inspection_verified: true
- repo_commit: `29652e43332533fa8c37684c67796d3b01a0caf4`
- inspected_files: `README.md`, `package.json`, `pnpm-lock.yaml`, `src/add/add.ts`, `src/add/types.ts`, `src/cli.ts`, `src/commands/add.ts`, `src/commands/data-set.ts`, `src/commands/import.ts`, `src/commands/index.ts`, `src/commands/payments.ts`, `src/commands/provider.ts`, `src/commands/remove.ts`, `src/commands/server.ts`, `src/commands/session.ts`, `src/common/cli-errors.ts`, `src/common/constants.ts`, `src/common/devnet-config.browser.ts`, `src/common/devnet-config.ts`, `src/common/get-rpc-url.ts`

宿主 AI 硬性规则：
- 没有 repo_clone_verified=true 时，不得声称已经读过源码。
- 没有 repo_inspection_verified=true 时，不得把 README/docs/package 文件判断写成事实。
- 没有 quick_start_verified=true 时，不得声称 Quick Start 已跑通。

## Doramagic Pitfall Constraints / 踩坑约束

这些规则来自 Doramagic 发现、验证或编译过程中的项目专属坑点。宿主 AI 必须把它们当作工作约束，而不是普通说明文字。

### Constraint 1: 来源证据：feat: add `filecoin-pin get` retrieval command

- Trigger: GitHub 社区证据显示该项目存在一个安装相关的待验证问题：feat: add `filecoin-pin get` retrieval command
- Why it matters: 可能增加新用户试用和生产接入成本。
- Evidence: community_evidence:github | https://github.com/filecoin-project/filecoin-pin/issues/575 | 来源类型 github_issue 暴露的待验证使用条件。
- Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。

### Constraint 2: 来源证据：feat: add pagination to `piece-status`

- Trigger: GitHub 社区证据显示该项目存在一个运行相关的待验证问题：feat: add pagination to `piece-status`
- Why it matters: 可能增加新用户试用和生产接入成本。
- Evidence: community_evidence:github | https://github.com/filecoin-project/filecoin-pin/issues/579 | 来源类型 github_issue 暴露的待验证使用条件。
- Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。

### Constraint 3: 失败模式：security_permissions: Add CLI error-scenario smoke test matrix for devs

- Trigger: Developers should check this security_permissions risk before relying on the project: Add CLI error-scenario smoke test matrix for devs
- Host AI rule: Before packaging this project, run the relevant install/config/quickstart check for: Add CLI error-scenario smoke test matrix for devs. Context: Observed when using node
- Why it matters: Developers may expose sensitive permissions or credentials: Add CLI error-scenario smoke test matrix for devs
- Evidence: failure_mode_cluster:github_issue | https://github.com/filecoin-project/filecoin-pin/issues/470 | Add CLI error-scenario smoke test matrix for devs
- Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。

### Constraint 4: 来源证据：Add CLI error-scenario smoke test matrix for devs

- Trigger: GitHub 社区证据显示该项目存在一个安全/权限相关的待验证问题：Add CLI error-scenario smoke test matrix for devs
- Why it matters: 可能影响升级、迁移或版本选择。
- Evidence: community_evidence:github | https://github.com/filecoin-project/filecoin-pin/issues/470 | 来源讨论提到 npm 相关条件，需在安装/试用前复核。
- Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。

### Constraint 5: 来源证据：Extract upload-action into a standalone repository for independent versioning

- Trigger: GitHub 社区证据显示该项目存在一个安全/权限相关的待验证问题：Extract upload-action into a standalone repository for independent versioning
- Why it matters: 可能影响授权、密钥配置或安全边界。
- Evidence: community_evidence:github | https://github.com/filecoin-project/filecoin-pin/issues/527 | 来源讨论提到 npm 相关条件，需在安装/试用前复核。
- Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。

### Constraint 6: 失败模式：installation: Extract upload-action into a standalone repository for independent versioning

- Trigger: Developers should check this installation risk before relying on the project: Extract upload-action into a standalone repository for independent versioning
- Host AI rule: Before packaging this project, run the relevant install/config/quickstart check for: Extract upload-action into a standalone repository for independent versioning. Context: Observed when using node
- Why it matters: Developers may fail before the first successful local run: Extract upload-action into a standalone repository for independent versioning
- Evidence: failure_mode_cluster:github_issue | https://github.com/filecoin-project/filecoin-pin/issues/527 | Extract upload-action into a standalone repository for independent versioning
- Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。

### Constraint 7: 失败模式：installation: feat: add compact summary view to `data-set list`

- Trigger: Developers should check this installation risk before relying on the project: feat: add compact summary view to `data-set list`
- Host AI rule: Before packaging this project, run the relevant install/config/quickstart check for: feat: add compact summary view to `data-set list`. Context: Observed when using node
- Why it matters: Developers may fail before the first successful local run: feat: add compact summary view to `data-set list`
- Evidence: failure_mode_cluster:github_issue | https://github.com/filecoin-project/filecoin-pin/issues/578 | feat: add compact summary view to `data-set list`
- Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。

### Constraint 8: 失败模式：installation: v0.22.1

- Trigger: Developers should check this installation risk before relying on the project: v0.22.1
- Host AI rule: Before packaging this project, run the relevant install/config/quickstart check for: v0.22.1. Context: Observed when using node
- Why it matters: Upgrade or migration may change expected behavior: v0.22.1
- Evidence: failure_mode_cluster:github_release | https://github.com/filecoin-project/filecoin-pin/releases/tag/v0.22.1 | v0.22.1
- Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。

### Constraint 9: 失败模式：installation: v0.23.2

- Trigger: Developers should check this installation risk before relying on the project: v0.23.2
- Host AI rule: Before packaging this project, run the relevant install/config/quickstart check for: v0.23.2. Context: Observed when using node
- Why it matters: Upgrade or migration may change expected behavior: v0.23.2
- Evidence: failure_mode_cluster:github_release | https://github.com/filecoin-project/filecoin-pin/releases/tag/v0.23.2 | v0.23.2
- Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。

### Constraint 10: 来源证据：feat: add compact summary view to `data-set list`

- Trigger: GitHub 社区证据显示该项目存在一个安装相关的待验证问题：feat: add compact summary view to `data-set list`
- Host AI rule: 来源显示可能已有修复、规避或版本变化，说明书中必须标注适用版本。
- Why it matters: 可能阻塞安装或首次运行。
- Evidence: community_evidence:github | https://github.com/filecoin-project/filecoin-pin/issues/578 | 来源讨论提到 npm 相关条件，需在安装/试用前复核。
- Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。