跳到主要内容

说明

概述​

通过 UKey Wallet WebLN Provider，应用可以把闪电网络能力接到页面里；用户授权后即可读取节点信息、发起支付、生成收款发票或签名消息。

适用面​

  • 接受闪电网络支付。
  • 为内容、服务或账户登录生成支付请求。
  • 使用闪电网络相关身份或消息签名能力。

部署​

1. 安装 UKey Wallet​

安装 UKey Wallet 浏览器扩展，并确认钱包可用。

2. API 注入说明​

  • UKey Wallet 浏览器扩展会向页面注入 WebLN Provider。
  • 可用入口包括 window.$ukey.webln 和兼容入口 window.webln。
  • 新项目建议优先读取 window.$ukey.webln。

两个入口能力一致，window.$ukey.webln 更适合在多钱包环境中明确选择 UKey Wallet。

检测 Provider API 支持​

调用 WebLN 方法前，请先检查当前页面是否存在 Provider：

const provider = (window.$ukey && window.$ukey.webln) || window.webln;

if (!provider) {
  alert("Provider 不可用。");
}

连接到 UKey Wallet​

使用支付或签名能力前，先调用 provider.enable 请求用户授权。

const provider = (window.$ukey && window.$ukey.webln) || window.webln;

provider.enable();

授权完成后，再继续调用 getInfo、sendPayment、makeInvoice 等接口。

API​

按业务目标选择对应接口：

事件流​

  • 关键事件：账户或网络状态变化。
  • 更多信息：查看更多