@getalby/sdk

中文文档
9.0.0发布于 2026/10/27MITTypeScriptESM + CJS构建来源已验证近 30 天下载 9.5万

与 Nostr 钱包连接和 Alby API 集成的 SDK

中文使用文档
文档目录12 节
  1. 导言
  2. QQ 用于使用代理 / LLM/ Vibe 编码的开发者
  3. 手动安装
  4. 闪电网络客户端( LN) 文档
  5. 鼻孔钱包连接文档
  6. Alby 钱包 API 文档
  7. 节点JS
  8. WebLN 文档
  9. 更多文档
  10. 需要帮忙吗?
  11. 谢谢
  12. 许可证

阿尔比 JS SDK

导言

将零监护比特币支付制成有几行代码的应用程序.

这个JavaScript SDK是用于通过诺斯特钱包连接或Alby钱包API与比特币闪电钱包进行互动.

在开始编码之前,看看我们中的例子 开发者沙盒

QQ 用于使用代理 / LLM/ Vibe 编码的开发者

跳过此读取的其余部分并使用 阿尔比比特币构建器技能 来构建比特币应用程序或 阿尔比比特币支付技能 给您的代理支付能力。 剩下的就交给它了!

手动安装

npm install @getalby/sdk

或者说

yarn add @getalby/sdk

或无任何构建工具的使用:

<script type="module">
  import {
    LN /* or NWCClient, or NostrWebLNProvider */,
  } from "https://esm.sh/@getalby/[email protected]"; // jsdelivr.net, skypack.dev also work

  // ... then use the SDK as normal (see below)
</script>

闪电网络客户端( LN) 文档

快把闪电费加进你的应用程序.

提供全权证书的最简单方法是 NWC 连接秘密连接到 阿尔比枢纽, (中文(简体) ), 硬币, (中文(简体) ), 初级, (中文(简体) ), inwallet. app (英语), (中文(简体) ), 亚基翁, (中文(简体) ), 或其他由NWC驱动的钱包。 。 。 .

例如,支付:

import { LN, USD } from "@getalby/sdk/lnclient";
const credentials = "nostr+walletconnect://..."; // the NWC connection credentials
await new LN(credentials).pay("lnbc..."); // pay a lightning invoice
await new LN(credentials).pay("[email protected]", USD(1)); // or pay $1 USD to a lightning address

或要求收到付款:

const request = await new LN(credentials).requestPayment(USD(1.0));
// give request.invoice to someone...
request.onPaid(giveAccess);

更多信息

为了更加灵活,您可以直接访问 NWC 钱包。 继续阅读下面的"诺斯特钱包连接"文档.

鼻孔钱包连接文档

鼻孔钱包连接 是一个允许应用程序与比特币闪电钱包交互的开放协议. 它允许用户将其现有的钱包与您的应用程序相连接,使开发者能够轻松地整合比特币闪电功能.

关于应用程序,见 NWC客户和NWA客户文件

钱包服务请见 NWC 钱包服务文档

Alby 钱包 API 文档

这个 阿尔比 OAuth API 允许您将Alby钱包提供的比特币闪电功能与Alby钱包 API整合到您的应用程序中。 发送并接收支付, 创建发票, 设置支付网点, 访问 Podcasting 2.0 及更多 !

更多信息

节点JS

需要22个或以上的节点(对于当地人) fetch 财务报告和审定财务报表 WebSocket 支持)。 在旧版本上可以安装并导入 [email protected] 在使用 SDK(不推荐) 之前.

WebLN 文档

JS SDK 也有一些执行 网络LN。 。 。 . 见 诺斯特-WebLN 文档 财务报告和审定财务报表 OAuthWebLN 文档。 。 。 .

更多文档

读取 自动生成的文档

需要帮忙吗?

我们乐于提供帮助,请与我们联系或制造问题.

谢谢

客户端和设置 灵感和基于 推特-api-typescript-sdk。 。 。 .

许可证

麻省理工学院

版本与发布记录

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

版本发布日期距今
9.0.0latest2026/10/2720 天前
8.1.12026/10/2125 天前
8.1.02026/10/2026 天前
8.0.32026/05/205 个月前
8.0.12026/05/156 个月前
7.0.02025/11/071 年前

其他发布通道:beta → 6.1.0-beta.0。

关于 @getalby/sdk 的常见问题

@getalby/sdk 是什么?

与 Nostr 钱包连接和 Alby API 集成的 SDK

如何安装 @getalby/sdk?

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

@getalby/sdk 支持 TypeScript 吗?

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

@getalby/sdk 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@getalby/sdk 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=22。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@getalby/sdk 可以商用吗?

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

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

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

@getalby/sdk 还在维护吗?

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