@ghostlytools/sdk

中文文档
1.12.0发布于 2026/11/15MITTypeScriptES Module构建来源已验证近 30 天下载 7238

Build a wallet source, an identity proof, a mini-app or a client for Ghostly without reading its internals: the adapter contracts, their fakes and contract test suites, the plugin registry, and the mini-app API types (Apps run in Ghostly 1.2 and later).

原始使用文档

@ghostlytools/sdk

Build a wallet source (Lightning or on-chain), an identity proof, a mini-app or a minimal client for Ghostly without reading its internals. The adapter contracts, the fakes and contract test suites the app tests itself with, the plugin registry, the protocol library, and the mini-app API types (@ghostlytools/sdk/app, which imports nothing at run time). Apps run in Ghostly from release 1.2: an earlier client does not open them.

Read docs/SDK.md: the rules about money and secrets, the trust model (an adapter runs with the app's privileges), how a plugin gets into the app, and how the package is versioned. A complete example lives in packages/sdk/examples/adapter, and a mini-app typed with @ghostlytools/sdk/app in packages/sdk/examples/mini-app.

Not on npm yet: npm pack --workspace @ghostlytools/sdk from a checkout builds and packs it.

版本与发布记录

@ghostlytools/sdk 共发布 49 个版本,首次发布于 2026/10/13;过去 12 个月发布了 49 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
1.12.0latest2026/11/15今天
1.11.42026/11/141 天前
1.11.32026/11/132 天前
1.11.22026/11/133 天前
1.11.12026/11/115 天前
1.11.02026/11/115 天前

关于 @ghostlytools/sdk 的常见问题

@ghostlytools/sdk 是什么?

Build a wallet source, an identity proof, a mini-app or a client for Ghostly without reading its internals: the adapter contracts, their fakes and contract test suites, the plugin registry, and the mini-app API types (Apps run in Ghostly 1.2 and later).

如何安装 @ghostlytools/sdk?

在项目目录运行 npm install @ghostlytools/sdk,或使用 pnpm add / yarn add / bun add。

@ghostlytools/sdk 支持 TypeScript 吗?

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

@ghostlytools/sdk 支持 ESM 还是 CommonJS?

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

@ghostlytools/sdk 可以商用吗?

@ghostlytools/sdk 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@ghostlytools/sdk 的下载量有多少?

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

@ghostlytools/sdk 还在维护吗?

最新版本 1.12.0 发布于 2026/11/15(今天);至今共发布 49 个版本,其中过去 12 个月发布了 49 个;首次发布于 2026/10/13。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。