このページの内容
ガイド
概要
このガイドでは、OneKey Lightning Network Provider API で Bitcoin Lightning Network アプリケーションを構築する方法を説明します。
Web アプリの構築 ユースケース
- Lightning Network の支払いの受け付け
- 分散型アイデンティティアプリケーション
インストール
1. OneKey ウォレットをダウンロード
次をダウンロードします: OneKey ウォレット 。OneKey ブラウザー拡張機能をインストールしてください。
2. API の注入について
- OneKey ブラウザー拡張機能は、アクセスした Web サイトに
Provider APIを注入します。 - 2 種類の API が提供されています:
window.weblnおよびwindow.$onekey.webln. window.$onekey.weblnの使用を推奨します。
次を優先してください:
window.$onekey.weblnを使うと OneKey を明示的に選択できます。グローバルのwindow.weblnは、複数の拡張機能がインストールされている場合、別のウォレットに属していることがあります。
Provider API 対応の検出
リクエスト前にプロバイダーが利用可能か確認してください:
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 を選択します。
- ユーザーの Bitcoin Lightning ノード情報を取得:
provider.getInfo - 支払いを送信:
provider.sendPayment - 支払いを受け取るインボイスを要求:
provider.makeInvoice - 任意のメッセージへの署名を要求:
provider.signMessage
その他のインターフェース: 詳細を表示
イベント
- 主な操作: アカウントの切り替えなど
- 詳細情報: さらに表示
リクエストの処理
ウォレットへのリクエストは async 関数または ES モジュールから実行してください。Promise の拒否をキャッチし、アプリケーションにエラーを表示します。接続、署名、支払いはユーザー操作から要求し、リクエストの処理中は起点となったボタンを無効にしてください。
最終更新日