突触 SDK
用于与Filecoin Synapse互动的JavaScript/TypeScript SDK - 一个基于智能合同的市场,用于Filecoin生态系统中的存储和其他服务.
概览
Synapse SDK提供了Filecoin分散服务生态系统的接口:
- 建议使用: 使用高级
Synapse 类别,用于在合理默认情况下进行精简的经验
- *+* 可编译组件: 进口和使用单个组件,以精细控制特定功能
SDK处理区块链交互,提供者选择和数据管理的所有复杂问题,因此可以专注于构建你的应用程序.
关键概念
- 服务合同:管理特定服务的智能合同(如存储). 目前, 温暖存储 是处理存储业务和付款验证的主要服务合同.
- 付款铁路:客户与服务提供者之间的自动支付流程,由支付合同管理。 当在"温暖存储"中创建数据集时,它会自动创建相应的支付道.
- 数据集: 由温暖存储管理存储数据的收集. 每个数据集都有一条相关的支付铁路,负责处理正在进行的存储支付.
- 块: 由PiectCID(内容识别符)识别的单个数据单位。 多个块可以被添加到一个存储的数据集.
- PDP( 数据拥有证明):验证存储提供者的加密协议实际上是存储他们声称存储的数据. 提供者必须定期证明他们拥有数据.
- 验证器:服务合同(如暖存储)是付款结算的验证人,确保在付款发放前提供服务.
安装
pnpm install @filoz/synapse-sdk viem
说明: viem 是一个同伴依赖,必须单独安装.
在浏览器中,PiectCID散列使用WebAssembly. 如果您的页面设置了 script-src,添加 'wasm-unsafe-eval' (例如 script-src 'self' 'wasm-unsafe-eval') (中文(简体) ). 没有它,包仍然会加载,但散列会丢出一个错误来命名缺失的指令.
文档
检查文档 网站
捐款
读取贡献 准则。 。 。 .
许可证
双重许可证: 麻省理工学院, (中文(简体) ), Apache 软件许可证 v2 通过方式
允许的许可证堆栈。 。 。 .
关于 @filoz/synapse-sdk 的常见问题
@filoz/synapse-sdk 是什么？
用于 Filecoin 链云的 JavaScript SDK
如何安装 @filoz/synapse-sdk？
在项目目录运行 npm install @filoz/synapse-sdk，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：viem（2.x）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。
@filoz/synapse-sdk 支持 TypeScript 吗？
支持。包内自带 TypeScript 类型声明（package.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。
@filoz/synapse-sdk 支持 ESM 还是 CommonJS？
以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module，更早的版本需要改用动态 import()。
@filoz/synapse-sdk 可以商用吗？
@filoz/synapse-sdk 使用 Apache-2.0 OR MIT 许可。可在 Apache-2.0、MIT 中任选其一遵守。选择 Apache-2.0 时，宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。
@filoz/synapse-sdk 的下载量有多少？
根据 npm 官方下载统计，@filoz/synapse-sdk 在 2026/10/15 – 2026/11/13 这 30 天内被下载 14,400 次，日均约 480 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。
@filoz/synapse-sdk 还在维护吗？
最新版本 3.0.0 发布于 2026/11/14（1 天前）；至今共发布 91 个版本，其中过去 12 个月发布了 21 个；首次发布于 2025/06/05。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。