makeInvoice

Den Nutzer auffordern, eine Rechnung zur Verwendung durch die Web-App zu erstellen. Dies gibt eine BOLT-11  -Rechnung zurück. Rechnungen können in mehreren Formen angefordert werden:

• Durch Angabe eines ausdrücklichen amount sollte der Provider des Nutzers sicherstellen, dass der Nutzer eine Rechnung mit einem bestimmten Betrag erstellt
• Durch Angabe eines minimumAmount und / oder maximumAmount sollte der Provider des Nutzers sicherstellen, dass der Nutzer eine Rechnung erstellt, deren Betragsfeld durch diesen Betrag begrenzt ist
• Wenn kein ausdrücklicher amount gesetzt ist, kann der Nutzer einen Betrag innerhalb der angeforderten Grenzen wählen.

Beträge werden in Satoshis angegeben. JavaScript-Zahlen stellen Ganzzahlen nur exakt dar bis Number.MAX_SAFE_INTEGER (2^53 - 1). Verwenden Sie für Werte darüber eine dezimale Zeichenfolge; die API akzeptiert Zeichenfolgen und Zahlen.

Methode

declare function makeInvoice(args: RequestInvoiceArgs): Promise<RequestInvoiceResponse>;

Parameter

• args — erforderlich object
  • amount — optional string|number die zu sendenden Satoshis
  • defaultAmount — optional string|number
  • minimumAmount — optional string|number
  • maximumAmount — optional string|number
  • defaultMemo — optional string

interface RequestInvoiceArgs {
  amount?: string | number; // unit is sats
  defaultAmount?: string | number; // unit is sats
  minimumAmount?: string | number; // unit is sats
  maximumAmount?: string | number; // unit is sats
  defaultMemo?: string;
}

Antwort

interface RequestInvoiceResponse {
  paymentRequest: string;
  paymentHash: string;
  rHash: string;
}

Beispiel

const provider = (window.$onekey && window.$onekey.webln) || window.webln;
 
await provider.enable();
const invoice = await provider.makeInvoice({
  amount: 1000,
});

Demo

Beispiel öffnen