阿尔比 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 文档。 。 。 .
更多文档
读取 自动生成的文档
需要帮忙吗?
我们乐于提供帮助,请与我们联系或制造问题.
- 推特: @getAlby
- 电讯社区聊天
- 电子邮件 支持@ getalby.com
- 比特币. 设计 黑社会 点亮-浏览器-扩展
- 读取 Alby 开发者指南 要更好地了解 Alby 软件包和 API 如何用来为您的应用程序提供动力.
谢谢
客户端和设置 灵感和基于 推特-api-typescript-sdk。 。 。 .
许可证
麻省理工学院