指南

概述

本指南帮助用户了解如何使用 OneKey 闪电网络 Provider API 构建比特币闪电网络应用。

构建 Web 应用的使用场景

• 接受闪电网络支付
• 去中心化身份应用

安装

1. 下载 OneKey 钱包

下载 OneKey 钱包 。安装 OneKey 浏览器扩展。

2. API 注入说明

• OneKey 浏览器扩展会将 Provider API 注入到访问的网站中。
• 提供两种类型的 API：window.webln 和 window.$onekey.webln。
• 推荐使用 window.$onekey.webln。

使用 window.$onekey.webln 明确选择 OneKey。安装多个扩展时，全局 window.webln 可能属于其他钱包。

检测 Provider API 支持

发起请求前，请检查 provider 是否存在：

const provider = (window.$onekey && window.$onekey.webln) || window.webln;
 
if (!provider) {
  throw new Error("No provider is available.");
}

连接到 OneKey

在使用以下 API 之前，首先需要使用 provider.enable 方法请求用户授权访问相关账户。

const provider = (window.$onekey && window.$onekey.webln) || window.webln;
 
await provider.enable();

只有在用户授权后才能调用其他 API。

API

根据应用需要执行的操作，选择对应 API。

• 获取用户的比特币闪电网络节点信息：provider.getInfo
• 发送支付：provider.sendPayment
• 请求发票以接收付款：provider.makeInvoice
• 请求签名任意消息：provider.signMessage

更多接口：查看详情

事件

• 关键操作：如账户切换
• 更多信息：查看更多

请求处理

在 async 函数或 ES 模块中发起钱包请求。捕获 Promise 拒绝，并在应用中显示错误。连接、签名和付款请求应由用户操作触发；等待请求完成期间，禁用触发按钮。