# @flapsdk/vault-runtime 中文文档

规范地址：https://npmcn.com/package/%40flapsdk/vault-runtime/

版本：0\.1\.42
npm 元数据更新时间：2026-11-10T07:18:28.513Z
中文译文更新时间：2026-11-14T21:31:03.678Z
软件包许可：未声明

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40flapsdk/vault-runtime
原文对照：https://npmcn.com/package/%40flapsdk/vault-runtime/?lang=original

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：2.7 MB，43 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：viem ^2\.39\.3，react 19\.2\.8，wagmi ^2\.12\.14，react-dom 19\.2\.8，@tanstack/react-query ^5\.37\.1，@rainbow-me/rainbowkit ^2\.1\.7
- 首次发布：2026-05-24T20:27:12.442Z
- 最新版本发布：2026-11-10T07:18:28.268Z
- 近 30 天下载量：3182（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：56（近 12 个月 56 个）

## 中文简介

共享 Flap Vault UI 主机的运行时间表面, Workbench 预览, 以及自定义 Vault 组件 .

## 安装

```sh
npm install @flapsdk/vault-runtime
```

也可以使用：`pnpm add @flapsdk/vault-runtime`、`yarn add @flapsdk/vault-runtime`、`bun add @flapsdk/vault-runtime`

## README

# @ flapsdk/ ault- runtime 时速

从 `flap-vault-ui-template`。 。 。 .

此软件包是本地预览的共享运行时间表面, Artifact Workbench, 以及 `flap.sh` 应该同意.

软件包版本 : `0.1.42`来源承诺: `686934578ec40aec418484e7c1dac1f6782d598e`。 。 。 .

## 出口

-   `./sdk`: 组件化的 SDK 钩子, 助手, 类型, 以及本地的读取器助手
-   `./ui`: 共享 UI 原始语
-   `./host`: 只提供主机、运行时间飞行前帮助器和浏览器安全同源演示文稿获取器
-   `./server`: 服务器侧演示文稿,运行时间 oracle-registry 助手,可控图像/文本上传处理器,以及 Vault V2 NFT 元数据/媒体解析器

见 `runtime-contract.json` 用于机器可读子路径合同.

## 迷你子程序

使用独立的小型应用程序 `useMiniAppRouter()` 从 `./sdk`返回时返回 相对 `pathname`解码 `segments`, (中文(简体) ), `search`,以及 `push(path)`, (中文(简体) ), `replace(path)`, (中文(简体) ), `back()`路径开始于 `/` 当前 App; 外部 URL、 traversal、 编码分隔符和散列 拒绝。 骑行不能让钱包或合同进入. `MINI_APP_ROUTING_VERSION = 1` 财务报告和审定财务报表 `sdkFeatures.miniAppRouting = 1` 识别特性。 主机注入 a `router` 输入 `MiniAppRuntimeProvider`· ; `./host` 出口 `parseMiniAppPath`, (中文(简体) ), `createMiniAppMemoryRouter` 财务报告和审定财务报表 `createMiniAppBrowserRouter`。旧Apps不需要适配器。 新钩子失败 明确,如果主机没有启用路由。 提前部署支持主机 (a) 接受新的依赖路线的文物.

## FSI 查询

宣布预定的FSI根在 `manifest.endpoints` 用于 `sdk.readFsi(relativePath, params)`。按选择顺序,支持的根 `https://fsi.taxed.fun/fsi/v1`, (中文(简体) ), `https://bsc-debug.butterfly.army/fsi/v1` bSC 测试网 `https://bsc-testnet-debug.butterfly.army/fsi/v1`。 。 。 . 当多个根被声明时, 无论数组顺序, 此顺序都适用 或者说 `chainId`。测试网包只应声明测试网FSI根. 失败的请求永远不会返回到另一个主机 。 确切地审查了根状, HTTPS的来源/路径边界、获取、认证和再定向限制依然存在. 主机和工作台必须部署包含所选终点政策的发布 在接受这些软件包之前同步 Workbench 源检查器.

## 交易确认

`waitForTx(hash)` 通过为这项行动选定的公共客户对原始交易进行投票。 它立即进行查询,然后每2秒钟在等待答复或瞬间反应后进行查询,每次查询的截止日期为8秒,总时限为180秒。 它返回原始成功/ 恢复状态; 应用程序必须检查 `status === "success"` 在显示成功或刷新为成功之前。 超时表示结果未知:保留散列并调节后再提供另一笔交易. 投票不跟随被加速或被取消的替换交易;原散列可以超时. 公共API和接收字段仍然兼容.

## 已征税. fun 源码检查兼容性

稳定的官方模板源 `0.1.40` 添加已审查的本地比对 查询每个 有效的严格 `taxed.fun` 子域,包括多级 子域. 主机和路径必须保持文字,查询值必须使用全局 `encodeURIComponent`,并明确宣布终点和安全获得选项 仍须如此。 顶端域名、动态主机/路径和不安全选项不会 获得许可。 现有 `sdk.readFsi` 路线和SDK出口没有变化.

此 npm 包中没有发送源检查器 。 部署匹配 模板和 Workbench 检查器政策分开; 仅更新此软件包 无法启用新的本地牵引政策或批准一个终点. 见 [0.1.40 发布指南](https://github.com/flap-sh/flap-vault-component-template/blob/main/docs/releases/0.1.40.md) 财务报告和审定财务报表 [请求策略](https://github.com/flap-sh/flap-vault-component-template/blob/main/docs/taxed-endpoints.md)。 。 。 .

## 共享 Vault 用户界面和 Mini App v2

此共享运行时间支持独立 App 钱包操作通过 `useFlapSdk({ chainId })` 和东道主 `CopyButton` 从 `./ui`。 。 。 . 默认 UI 保存 `useFlapSdk()` 及其象征性的上下文。 都用这个 软件包; 现有的符号绑定的 Mini Apps 仍然兼容 . 平稳开发使用官方主模板和npm最新. 共享的 CopyButton 复制最多可达 1 048 576 UTF-16 代码单元而无需截取.

## 森林小组动态内容

稳定运行时间 `0.1.37` 介绍 `sdk.readIpfsText(cid, path?)`返回时 UTF-8 文本或 JSON 作为字符串,以及 `IpfsText` 用于逃脱的纯文本显示. `IpfsImage` 接受来自FSI,合同状态或SDK上传的动态赤色CID. SDK的出口 `IPFS_CONTENT_VERSION = 1`;运行时间合同广告 `sdkFeatures.ipfsContent = 1`稳定 `0.1.36` 缺少文本 API/ 组件.

断层源保留 `@/src/sdk` 财务报告和审定财务报表 `@/src/ui` 写出别名。 获取 `sdk` 与 `useFlapSdk()`,然后从同步效应或事件给读者打电话 处理者。 独立微型 App v2 用途 `useFlapSdk({ chainId: 56 })`· ; 其链式SDK曝光同一读取器并被审查 `readFsi` API (英语). 导入 `IpfsText` 财务报告和审定财务报表 `IpfsImage` 用于渲染的UI别名:

```tsx
const body = await sdk.readIpfsText(textCid);
// Parse JSON only if the application expects JSON content.
const post = JSON.parse(await sdk.readIpfsText(jsonCid));
```

```tsx
<IpfsText cid={item.textCid} fallback={i18n.t("contentLoading")} />
<IpfsImage cid={item.imageCid} alt={i18n.t("postImageAlt")} />
```

使用安全相对 `path` 目录 CID 的值,从不设置网关 URL 或 `ipfs://` URI (英语). 运行时间控制了网关并验证了每一个CID/路径. 文本读取省略了证书/参考者,拒绝重定向和HTML回复, 执行UTF-8和256 KiB限制,并设定8秒网络/机体最后期限 获取活动槽后。 读取被复制、缓存和货币 有限. `IpfsText` 不解释 HTML 或 Markdown 。 装入/误入位置 和以物配主的文字,和精液. `IpfsBackground` 保持静态的CID.

动态内容来源需要人文审查. 更新 Workbench 和 Flap 主机 到已公布的运行时间, 并在 Workbench 之前部署匹配的静态检查器 接受新组件。 读取使用没有新主机路由的平台网关; 上传通过现有的主机拥有的上传服务继续进行. 自动 上传固定装置被嘲弄,不验证是否有直播网关.

资料来源:

-   [API 指南](https://github.com/flap-sh/flap-vault-component-template/blob/main/docs/ipfs-content.md)
-   [API \*\*](https://github.com/flap-sh/flap-vault-component-template/blob/main/docs/ipfs-content.zh-CN.md)
-   [发布和升级笔记](https://github.com/flap-sh/flap-vault-component-template/blob/main/docs/releases/0.1.37.md)

## 常见问题

### @flapsdk/vault-runtime 是什么？

共享 Flap Vault UI 主机的运行时间表面, Workbench 预览, 以及自定义 Vault 组件 \.

### 如何安装 @flapsdk/vault-runtime？

在项目目录运行 npm install @flapsdk/vault-runtime，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：viem（^2\.39\.3）、react（19\.2\.8）、wagmi（^2\.12\.14）、react-dom（19\.2\.8）、@tanstack/react-query（^5\.37\.1）、@rainbow-me/rainbowkit（^2\.1\.7）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @flapsdk/vault-runtime 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @flapsdk/vault-runtime 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @flapsdk/vault-runtime 可以商用吗？

@flapsdk/vault-runtime 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @flapsdk/vault-runtime 的下载量有多少？

根据 npm 官方下载统计，@flapsdk/vault-runtime 在 2026/10/15 – 2026/11/13 这 30 天内被下载 3,182 次，日均约 106 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @flapsdk/vault-runtime 还在维护吗？

最新版本 0\.1\.42 发布于 2026/11/10（5 天前）；至今共发布 56 个版本，其中过去 12 个月发布了 56 个；首次发布于 2026/05/25。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。