Guía

Descripción general

Esta guía explica cómo crear aplicaciones de Bitcoin Lightning Network con la API del proveedor de Lightning Network de OneKey.

Creación de aplicaciones web Casos de uso

• Aceptar pagos de Lightning Network
• aplicaciones de identidad descentralizada

Instalación

1. Descargar OneKey Wallet

Descarga OneKey Wallet . Instala la extensión de navegador OneKey.

2. Explicación de la inyección de API

• La extensión de navegador de OneKey inyecta Provider API en los sitios web visitados.
• Se ofrecen dos tipos de API: window.webln y window.$onekey.webln.
• Se recomienda usar window.$onekey.webln.

Usa preferentemente window.$onekey.webln para seleccionar OneKey específicamente. La variable global window.webln puede pertenecer a otra cartera cuando hay varias extensiones instaladas.

Detectar la compatibilidad con la API del proveedor

Comprueba que haya un proveedor disponible antes de realizar solicitudes:

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

Conectarse a OneKey

Antes de usar la siguiente API, debes usar primero el método provider.enable para solicitar al usuario acceso a la cuenta correspondiente.

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

Solo se puede llamar a otras API después de obtener la autorización del usuario.

API

Elige una API para la operación que necesite tu aplicación.

• Obtener información del nodo Bitcoin Lightning del usuario: provider.getInfo
• Enviar un pago: provider.sendPayment
• Solicitar una factura para recibir un pago: provider.makeInvoice
• Solicitar la firma de cualquier mensaje: provider.signMessage

Más interfaces: Ver detalles

Evento

• Operaciones principales: Por ejemplo, cambiar de cuenta
• Más información: Ver más

Gestión de solicitudes

Ejecuta las solicitudes de cartera desde una función asíncrona o un módulo ES. Captura las promesas rechazadas y muestra el error en tu aplicación. Solicita conexiones, firmas y pagos a partir de una acción del usuario, y desactiva el botón que los inicia mientras haya una solicitud pendiente.