lnurl

Request to execute a LNURL request. The application needs to pass a LNURL string which should be provided for example by the application's backend. The lnurl function can also accept a LUD-16 static identifier (e.g. [e-mail]) instead of a LNURL string.

The method returns a promise which resolves once the LNURL flow is completed. It returns the last response from the LNURL server. For LNURL-pay requests it also contains payment information (preimage, payment hash) and for LNURL-auth requests it contains auth information (message, signature)

Method

async function lnurl(lnurl: string): LNURLResponse;

Response

type LNURLResponse =
  | {
      status: "OK";
      data?: unknown
    }
  | { status: "ERROR"; reason: string };

LNURL-pay Response

type LNURLPayResponse =
  | {
      status: "OK";
      data: { 
        preimage: string, 
        paymentHash: string, 
        paymentRequest: string
      }
    }
  | { status: "ERROR"; reason: string };

LNURL-auth Response

type LNURLAuthResponse =
  | {
      status: "OK";
      data: { 
        message: string, 
        signature: string
      }
    }
  | { status: "ERROR"; reason: string };

Example

const lnurl = // Your LNURL
if (!webln.lnurl) { throw new Error('not supported lnurl method'); }

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

await provider.enable();
const result = await provider.lnurl(lnurl); // promise resolves once the LNURL process is finished (e.g. a payment is sent or the login is complete)