Anleitung

Übersicht

Diese Anleitung zeigt, wie Sie Bitcoin-Lightning-Network-Anwendungen mit der OneKey-Lightning-Network-Provider-API erstellen.

Web-Apps entwickeln Anwendungsfälle

• Lightning-Network-Zahlungen annehmen
• Anwendungen für dezentrale Identitäten

Installieren

1. OneKey Wallet herunterladen

Laden Sie OneKey Wallet . Installieren Sie die OneKey-Browsererweiterung.

2. Erklärung der API-Injektion

• Die OneKey-Browsererweiterung injiziert Provider API in besuchte Websites.
• Es werden zwei API-Typen bereitgestellt: window.webln und window.$onekey.webln.
• Empfohlen wird window.$onekey.webln.

Bevorzugen Sie window.$onekey.webln, um gezielt OneKey auszuwählen. Die globale Variable window.webln kann zu einer anderen Wallet gehören, wenn mehrere Erweiterungen installiert sind.

Unterstützung der Provider-API erkennen

Prüfen Sie vor Anfragen, ob ein Provider verfügbar ist:

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

Mit OneKey verbinden

Bevor Sie die folgende API verwenden, müssen Sie beim Nutzer mit der Methode provider.enable Zugriff auf das entsprechende Konto anfordern.

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

Andere APIs können erst nach Autorisierung durch den Nutzer aufgerufen werden.

API

Wählen Sie die API für den Vorgang, den Ihre Anwendung benötigt.

• Informationen zum Bitcoin-Lightning-Knoten des Nutzers abrufen: provider.getInfo
• Zahlung senden: provider.sendPayment
• Eine Rechnung zum Empfangen einer Zahlung anfordern: provider.makeInvoice
• Signatur für eine beliebige Nachricht anfordern: provider.signMessage

Weitere Schnittstellen: Details anzeigen

Ereignis

• Wichtige Vorgänge: Zum Beispiel Kontowechsel
• Weitere Informationen: Mehr anzeigen

Anfragen behandeln

Führen Sie Wallet-Anfragen in einer asynchronen Funktion oder einem ES-Modul aus. Fangen Sie abgelehnte Promises ab und zeigen Sie den Fehler in Ihrer Anwendung an. Fordern Sie Verbindungen, Signaturen und Zahlungen über eine Nutzeraktion an und deaktivieren Sie die auslösende Schaltfläche, solange eine Anfrage aussteht.