thunder-bridge 1.4.1 → 1.5.0

package/dist/price.cjs

@@ -0,0 +1,240 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/entry/price.ts
+var price_exports = {};
+__export(price_exports, {
+  AmountError: () => AmountError,
+  bitstamp: () => bitstamp,
+  coinbase: () => coinbase,
+  coinmate: () => coinmate,
+  kraken: () => kraken,
+  medianOf: () => medianOf,
+  minorScaleOf: () => minorScaleOf,
+  minorUnitsOf: () => minorUnitsOf,
+  msatFor: () => msatFor
+});
+module.exports = __toCommonJS(price_exports);
+
+// src/errors.ts
+var AmountError = class extends Error {
+  /**
+   * Whether a failure is one of these, without asking whether it is this exact
+   * class. Every entry point carries its own copy of the class, so a price
+   * refused inside `thunder-bridge/price` is not `instanceof` the `AmountError`
+   * imported from `thunder-bridge`. The name and the code are the same in every
+   * copy, so this holds where `instanceof` does not
+   */
+  static is(failure) {
+    return failure instanceof Error && failure.name === "AmountError" && "code" in failure;
+  }
+  code;
+  constructor(code, detail) {
+    super(`${code}: ${detail}`);
+    this.name = "AmountError";
+    this.code = code;
+  }
+};
+
+// src/currency.ts
+var ISO_4217_MINOR_UNITS = {
+  BHD: 3,
+  BIF: 0,
+  CLP: 0,
+  CZK: 2,
+  DJF: 0,
+  EUR: 2,
+  GBP: 2,
+  ISK: 0,
+  IQD: 3,
+  JOD: 3,
+  JPY: 0,
+  KRW: 0,
+  KWD: 3,
+  LYD: 3,
+  OMR: 3,
+  PLN: 2,
+  PYG: 0,
+  RWF: 0,
+  TND: 3,
+  UGX: 0,
+  USD: 2,
+  VND: 0,
+  VUV: 0,
+  XAF: 0,
+  XOF: 0,
+  XPF: 0
+};
+function minorUnitsOf(currency) {
+  const digits = ISO_4217_MINOR_UNITS[currency.toUpperCase()];
+  if (digits === void 0) {
+    throw new AmountError(
+      "unknown-currency",
+      `${currency.toUpperCase()} is not a currency this knows the ISO 4217 minor unit of`
+    );
+  }
+  return digits;
+}
+function minorScaleOf(currency) {
+  return 10 ** minorUnitsOf(currency);
+}
+
+// src/price.ts
+var MSAT_PER_BTC = 1e11;
+var BASIS_POINTS = 1e4;
+var DEFAULT_HOLD_SECS = 60;
+var DEFAULT_MIN_VENUES = 2;
+var DEFAULT_MAX_SPREAD_BPS = 200;
+var MILLIS = 1e3;
+function coinbase(baseUrl = "https://api.coinbase.com") {
+  return async (currency) => {
+    const asked = currency.toUpperCase();
+    const answer = await asJson(`${baseUrl}/v2/prices/BTC-${asked}/spot`, "coinbase");
+    const quoted = answer.data;
+    if (quoted?.currency !== asked) {
+      throw new Error(`coinbase quoted ${quoted?.currency} when asked for ${asked}`);
+    }
+    return asMinor(quoted.amount, "coinbase", asked);
+  };
+}
+function kraken(baseUrl = "https://api.kraken.com") {
+  return async (currency) => {
+    const asked = currency.toUpperCase();
+    const answer = await asJson(`${baseUrl}/0/public/Ticker?pair=XBT${asked}`, "kraken");
+    if (answer.error?.length) {
+      throw new Error(`kraken refused XBT${asked}: ${answer.error[0]}`);
+    }
+    const pairs = Object.values(answer.result ?? {});
+    if (pairs.length !== 1) {
+      throw new Error(`kraken answered ${pairs.length} pairs for XBT${asked}`);
+    }
+    return asMinor(pairs[0]?.c?.[0], "kraken", asked);
+  };
+}
+function bitstamp(baseUrl = "https://www.bitstamp.net") {
+  return async (currency) => {
+    const pair = `btc${currency.toLowerCase()}`;
+    const answer = await asJson(`${baseUrl}/api/v2/ticker/${pair}/`, "bitstamp");
+    if (Array.isArray(answer)) {
+      throw new Error(`bitstamp has no ${pair} pair`);
+    }
+    return asMinor(answer.last, "bitstamp", currency);
+  };
+}
+function coinmate(baseUrl = "https://coinmate.io") {
+  return async (currency) => {
+    const pair = `BTC_${currency.toUpperCase()}`;
+    const answer = await asJson(`${baseUrl}/api/ticker?currencyPair=${pair}`, "coinmate");
+    if (answer.error !== false) {
+      throw new Error(`coinmate refused ${pair}: ${answer.errorMessage ?? "no reason"}`);
+    }
+    return asMinor(answer.data?.last, "coinmate", currency);
+  };
+}
+function medianOf(tickers = [coinbase(), kraken(), bitstamp(), coinmate()], options = {}) {
+  const holdFor = (options.holdForSecs ?? DEFAULT_HOLD_SECS) * MILLIS;
+  const minVenues = options.minVenues ?? DEFAULT_MIN_VENUES;
+  const maxSpread = options.maxSpreadBps ?? DEFAULT_MAX_SPREAD_BPS;
+  const held = /* @__PURE__ */ new Map();
+  return async (currency) => {
+    const asked = currency.toUpperCase();
+    const remembered = held.get(asked);
+    if (remembered && Date.now() - remembered.at < holdFor) {
+      return remembered.price;
+    }
+    const answers = await Promise.allSettled(tickers.map((ticker) => ticker(asked)));
+    const quoted = answers.filter((answer) => answer.status === "fulfilled").map((answer) => answer.value).sort((one, other) => one - other);
+    if (quoted.length < minVenues) {
+      throw new Error(
+        `${quoted.length} of ${tickers.length} venues quoted ${asked}, ${minVenues} wanted: ${refusals(answers)}`
+      );
+    }
+    const spread = spreadBpsOf(quoted);
+    if (spread > maxSpread) {
+      throw new Error(
+        `venues disagree on ${asked} by ${Math.round(spread)} bps, more than the ${maxSpread} allowed: ${quoted.join(", ")}`
+      );
+    }
+    const price = middleOf(quoted);
+    held.set(asked, { at: Date.now(), price });
+    return price;
+  };
+}
+function msatFor(amountMinor, priceMinorPerBtc, options = {}) {
+  if (!Number.isInteger(amountMinor) || amountMinor <= 0) {
+    throw new Error("amountMinor must be a whole number of minor units above zero");
+  }
+  if (!Number.isFinite(priceMinorPerBtc) || priceMinorPerBtc <= 0) {
+    throw new Error(`${priceMinorPerBtc} is not a usable price`);
+  }
+  const spreadBps = options.spreadBps ?? 0;
+  if (!Number.isInteger(spreadBps) || spreadBps < 0) {
+    throw new Error("spreadBps must be a whole number of basis points, none or more");
+  }
+  const wanted = BigInt(amountMinor) * BigInt(MSAT_PER_BTC) * BigInt(BASIS_POINTS + spreadBps);
+  const per = BigInt(Math.round(priceMinorPerBtc)) * BigInt(BASIS_POINTS);
+  const msat = (wanted + per - 1n) / per;
+  if (msat > BigInt(Number.MAX_SAFE_INTEGER)) {
+    throw new Error(`${amountMinor} at ${priceMinorPerBtc} is more millisatoshi than exist`);
+  }
+  return Number(msat);
+}
+async function asJson(url, venue) {
+  const answer = await fetch(url, { headers: { accept: "application/json" } });
+  if (!answer.ok) {
+    throw new Error(`${venue} answered ${answer.status}`);
+  }
+  return answer.json();
+}
+function asMinor(quoted, venue, currency) {
+  const major = Number(quoted);
+  if (!Number.isFinite(major) || major <= 0) {
+    throw new Error(`${venue} quoted ${String(quoted)} for ${currency.toUpperCase()}`);
+  }
+  return Math.round(major * minorScaleOf(currency));
+}
+function spreadBpsOf(sorted) {
+  const lowest = sorted[0] ?? 0;
+  const highest = sorted[sorted.length - 1] ?? 0;
+  return lowest === 0 ? Number.POSITIVE_INFINITY : (highest - lowest) / lowest * BASIS_POINTS;
+}
+function middleOf(sorted) {
+  const middle = Math.floor(sorted.length / 2);
+  if (sorted.length % 2 === 1) {
+    return sorted[middle] ?? 0;
+  }
+  return Math.round(((sorted[middle - 1] ?? 0) + (sorted[middle] ?? 0)) / 2);
+}
+function refusals(answers) {
+  return answers.filter((answer) => answer.status === "rejected").map(
+    (answer) => answer.reason instanceof Error ? answer.reason.message : String(answer.reason)
+  ).join("; ");
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  AmountError,
+  bitstamp,
+  coinbase,
+  coinmate,
+  kraken,
+  medianOf,
+  minorScaleOf,
+  minorUnitsOf,
+  msatFor
+});

package/dist/price.d.cts

@@ -0,0 +1,17 @@
+export { A as AmountError, a as AmountFault } from './errors-Dmh-Uoh8.cjs';
+export { M as MedianOptions, T as Ticker, b as bitstamp, c as coinbase, a as coinmate, k as kraken, m as medianOf, d as msatFor } from './types-BNPmVnA7.cjs';
+
+/**
+ * How many digits ISO 4217 gives the currency's minor unit, so 2 for a crown and a
+ * euro, 0 for a yen and 3 for a dinar.
+ *
+ * There is no sane default here, which is why an unlisted code throws rather than
+ * being treated as two. Assuming two turns 1000 yen into 10 and a dinar into a
+ * tenth of itself, and a payment library that guesses at this is a payment library
+ * that moves the wrong amount.
+ */
+declare function minorUnitsOf(currency: string): number;
+/** The scale that minor unit implies, so 100 for a crown, 1 for a yen, 1000 for a dinar */
+declare function minorScaleOf(currency: string): number;
+
+export { minorScaleOf, minorUnitsOf };

package/dist/price.d.ts

@@ -0,0 +1,17 @@
+export { A as AmountError, a as AmountFault } from './errors-0vbVoISA.js';
+export { M as MedianOptions, T as Ticker, b as bitstamp, c as coinbase, a as coinmate, k as kraken, m as medianOf, d as msatFor } from './types-BNPmVnA7.js';
+
+/**
+ * How many digits ISO 4217 gives the currency's minor unit, so 2 for a crown and a
+ * euro, 0 for a yen and 3 for a dinar.
+ *
+ * There is no sane default here, which is why an unlisted code throws rather than
+ * being treated as two. Assuming two turns 1000 yen into 10 and a dinar into a
+ * tenth of itself, and a payment library that guesses at this is a payment library
+ * that moves the wrong amount.
+ */
+declare function minorUnitsOf(currency: string): number;
+/** The scale that minor unit implies, so 100 for a crown, 1 for a yen, 1000 for a dinar */
+declare function minorScaleOf(currency: string): number;
+
+export { minorScaleOf, minorUnitsOf };

package/dist/price.js

@@ -0,0 +1,205 @@
+// src/errors.ts
+var AmountError = class extends Error {
+  /**
+   * Whether a failure is one of these, without asking whether it is this exact
+   * class. Every entry point carries its own copy of the class, so a price
+   * refused inside `thunder-bridge/price` is not `instanceof` the `AmountError`
+   * imported from `thunder-bridge`. The name and the code are the same in every
+   * copy, so this holds where `instanceof` does not
+   */
+  static is(failure) {
+    return failure instanceof Error && failure.name === "AmountError" && "code" in failure;
+  }
+  code;
+  constructor(code, detail) {
+    super(`${code}: ${detail}`);
+    this.name = "AmountError";
+    this.code = code;
+  }
+};
+
+// src/currency.ts
+var ISO_4217_MINOR_UNITS = {
+  BHD: 3,
+  BIF: 0,
+  CLP: 0,
+  CZK: 2,
+  DJF: 0,
+  EUR: 2,
+  GBP: 2,
+  ISK: 0,
+  IQD: 3,
+  JOD: 3,
+  JPY: 0,
+  KRW: 0,
+  KWD: 3,
+  LYD: 3,
+  OMR: 3,
+  PLN: 2,
+  PYG: 0,
+  RWF: 0,
+  TND: 3,
+  UGX: 0,
+  USD: 2,
+  VND: 0,
+  VUV: 0,
+  XAF: 0,
+  XOF: 0,
+  XPF: 0
+};
+function minorUnitsOf(currency) {
+  const digits = ISO_4217_MINOR_UNITS[currency.toUpperCase()];
+  if (digits === void 0) {
+    throw new AmountError(
+      "unknown-currency",
+      `${currency.toUpperCase()} is not a currency this knows the ISO 4217 minor unit of`
+    );
+  }
+  return digits;
+}
+function minorScaleOf(currency) {
+  return 10 ** minorUnitsOf(currency);
+}
+
+// src/price.ts
+var MSAT_PER_BTC = 1e11;
+var BASIS_POINTS = 1e4;
+var DEFAULT_HOLD_SECS = 60;
+var DEFAULT_MIN_VENUES = 2;
+var DEFAULT_MAX_SPREAD_BPS = 200;
+var MILLIS = 1e3;
+function coinbase(baseUrl = "https://api.coinbase.com") {
+  return async (currency) => {
+    const asked = currency.toUpperCase();
+    const answer = await asJson(`${baseUrl}/v2/prices/BTC-${asked}/spot`, "coinbase");
+    const quoted = answer.data;
+    if (quoted?.currency !== asked) {
+      throw new Error(`coinbase quoted ${quoted?.currency} when asked for ${asked}`);
+    }
+    return asMinor(quoted.amount, "coinbase", asked);
+  };
+}
+function kraken(baseUrl = "https://api.kraken.com") {
+  return async (currency) => {
+    const asked = currency.toUpperCase();
+    const answer = await asJson(`${baseUrl}/0/public/Ticker?pair=XBT${asked}`, "kraken");
+    if (answer.error?.length) {
+      throw new Error(`kraken refused XBT${asked}: ${answer.error[0]}`);
+    }
+    const pairs = Object.values(answer.result ?? {});
+    if (pairs.length !== 1) {
+      throw new Error(`kraken answered ${pairs.length} pairs for XBT${asked}`);
+    }
+    return asMinor(pairs[0]?.c?.[0], "kraken", asked);
+  };
+}
+function bitstamp(baseUrl = "https://www.bitstamp.net") {
+  return async (currency) => {
+    const pair = `btc${currency.toLowerCase()}`;
+    const answer = await asJson(`${baseUrl}/api/v2/ticker/${pair}/`, "bitstamp");
+    if (Array.isArray(answer)) {
+      throw new Error(`bitstamp has no ${pair} pair`);
+    }
+    return asMinor(answer.last, "bitstamp", currency);
+  };
+}
+function coinmate(baseUrl = "https://coinmate.io") {
+  return async (currency) => {
+    const pair = `BTC_${currency.toUpperCase()}`;
+    const answer = await asJson(`${baseUrl}/api/ticker?currencyPair=${pair}`, "coinmate");
+    if (answer.error !== false) {
+      throw new Error(`coinmate refused ${pair}: ${answer.errorMessage ?? "no reason"}`);
+    }
+    return asMinor(answer.data?.last, "coinmate", currency);
+  };
+}
+function medianOf(tickers = [coinbase(), kraken(), bitstamp(), coinmate()], options = {}) {
+  const holdFor = (options.holdForSecs ?? DEFAULT_HOLD_SECS) * MILLIS;
+  const minVenues = options.minVenues ?? DEFAULT_MIN_VENUES;
+  const maxSpread = options.maxSpreadBps ?? DEFAULT_MAX_SPREAD_BPS;
+  const held = /* @__PURE__ */ new Map();
+  return async (currency) => {
+    const asked = currency.toUpperCase();
+    const remembered = held.get(asked);
+    if (remembered && Date.now() - remembered.at < holdFor) {
+      return remembered.price;
+    }
+    const answers = await Promise.allSettled(tickers.map((ticker) => ticker(asked)));
+    const quoted = answers.filter((answer) => answer.status === "fulfilled").map((answer) => answer.value).sort((one, other) => one - other);
+    if (quoted.length < minVenues) {
+      throw new Error(
+        `${quoted.length} of ${tickers.length} venues quoted ${asked}, ${minVenues} wanted: ${refusals(answers)}`
+      );
+    }
+    const spread = spreadBpsOf(quoted);
+    if (spread > maxSpread) {
+      throw new Error(
+        `venues disagree on ${asked} by ${Math.round(spread)} bps, more than the ${maxSpread} allowed: ${quoted.join(", ")}`
+      );
+    }
+    const price = middleOf(quoted);
+    held.set(asked, { at: Date.now(), price });
+    return price;
+  };
+}
+function msatFor(amountMinor, priceMinorPerBtc, options = {}) {
+  if (!Number.isInteger(amountMinor) || amountMinor <= 0) {
+    throw new Error("amountMinor must be a whole number of minor units above zero");
+  }
+  if (!Number.isFinite(priceMinorPerBtc) || priceMinorPerBtc <= 0) {
+    throw new Error(`${priceMinorPerBtc} is not a usable price`);
+  }
+  const spreadBps = options.spreadBps ?? 0;
+  if (!Number.isInteger(spreadBps) || spreadBps < 0) {
+    throw new Error("spreadBps must be a whole number of basis points, none or more");
+  }
+  const wanted = BigInt(amountMinor) * BigInt(MSAT_PER_BTC) * BigInt(BASIS_POINTS + spreadBps);
+  const per = BigInt(Math.round(priceMinorPerBtc)) * BigInt(BASIS_POINTS);
+  const msat = (wanted + per - 1n) / per;
+  if (msat > BigInt(Number.MAX_SAFE_INTEGER)) {
+    throw new Error(`${amountMinor} at ${priceMinorPerBtc} is more millisatoshi than exist`);
+  }
+  return Number(msat);
+}
+async function asJson(url, venue) {
+  const answer = await fetch(url, { headers: { accept: "application/json" } });
+  if (!answer.ok) {
+    throw new Error(`${venue} answered ${answer.status}`);
+  }
+  return answer.json();
+}
+function asMinor(quoted, venue, currency) {
+  const major = Number(quoted);
+  if (!Number.isFinite(major) || major <= 0) {
+    throw new Error(`${venue} quoted ${String(quoted)} for ${currency.toUpperCase()}`);
+  }
+  return Math.round(major * minorScaleOf(currency));
+}
+function spreadBpsOf(sorted) {
+  const lowest = sorted[0] ?? 0;
+  const highest = sorted[sorted.length - 1] ?? 0;
+  return lowest === 0 ? Number.POSITIVE_INFINITY : (highest - lowest) / lowest * BASIS_POINTS;
+}
+function middleOf(sorted) {
+  const middle = Math.floor(sorted.length / 2);
+  if (sorted.length % 2 === 1) {
+    return sorted[middle] ?? 0;
+  }
+  return Math.round(((sorted[middle - 1] ?? 0) + (sorted[middle] ?? 0)) / 2);
+}
+function refusals(answers) {
+  return answers.filter((answer) => answer.status === "rejected").map(
+    (answer) => answer.reason instanceof Error ? answer.reason.message : String(answer.reason)
+  ).join("; ");
+}
+export {
+  AmountError,
+  bitstamp,
+  coinbase,
+  coinmate,
+  kraken,
+  medianOf,
+  minorScaleOf,
+  minorUnitsOf,
+  msatFor
+};

package/dist/qr-CF-YeXU1.d.cts

@@ -0,0 +1,55 @@
+/** An invoice a lightning address issued, with everything needed to watch and to prove it */
+type Resolved = {
+    address: string;
+    bolt11: string;
+    verifyUrl: string;
+    paymentHash: string;
+    expiresAt: number;
+};
+/**
+ * Bech32-encode a pay endpoint as the `LNURL1` string LUD-01 defines, uppercase
+ * because that is the form it asks a QR to carry. An onion endpoint is http
+ * rather than https, which LUD-17 spells out, so both are taken here
+ */
+declare function toLnurl(endpoint: string): string;
+
+/** How the QR is drawn, which is the only thing about it worth configuring */
+interface QrOptions {
+    /** SVG width and height in pixels, defaults to 256 */
+    size?: number;
+    /** Dark module color, defaults to `#000` */
+    color?: string;
+}
+/** Render a BOLT11 invoice or a lightning address as an SVG QR code */
+declare function invoiceToSvg(destination: string, options?: QrOptions): string;
+/** SVG data URL for an `<img>` `src` */
+declare function invoiceToDataUrl(destination: string, options?: QrOptions): string;
+/**
+ * Render your own LNURL-pay endpoint, the URL `serve.lnurlPay` is mounted on, as
+ * the QR a payer scans. It takes the endpoint URL and does the bech32 itself, so
+ * do not hand it the output of `toLnurl` - that is what this calls for you.
+ *
+ * Nothing is minted and nothing expires, so this is the code a tip jar prints
+ * once and an overlay shows all stream
+ */
+declare function lnurlEndpointToSvg(endpoint: string, options?: QrOptions): string;
+/** SVG data URL of the endpoint's QR, for an `<img>` `src` */
+declare function lnurlEndpointToDataUrl(endpoint: string, options?: QrOptions): string;
+/**
+ * Render the `spd` from `bankTransfer` as the QR a Czech banking app scans. The
+ * payload is a Short Payment Descriptor, so it carries the account, the amount
+ * and the reference the payer must leave on the transfer
+ */
+declare function spdToSvg(spd: string, options?: QrOptions): string;
+/** SVG data URL of the bank transfer's QR, for an `<img>` `src` */
+declare function spdToDataUrl(spd: string, options?: QrOptions): string;
+/**
+ * Render any rail's `Leg.qr` as an SVG QR code. Each rail states its own payload,
+ * a BOLT11 invoice under the `LIGHTNING` scheme or a Short Payment Descriptor as
+ * it stands, so this draws a leg without being told which rail made it
+ */
+declare function qrToSvg(payload: string, options?: QrOptions): string;
+/** SVG data URL of a leg's QR, for an `<img>` `src` */
+declare function qrToDataUrl(payload: string, options?: QrOptions): string;
+
+export { type QrOptions as Q, type Resolved as R, invoiceToSvg as a, lnurlEndpointToSvg as b, qrToSvg as c, spdToSvg as d, invoiceToDataUrl as i, lnurlEndpointToDataUrl as l, qrToDataUrl as q, spdToDataUrl as s, toLnurl as t };

package/dist/qr-CF-YeXU1.d.ts

@@ -0,0 +1,55 @@
+/** An invoice a lightning address issued, with everything needed to watch and to prove it */
+type Resolved = {
+    address: string;
+    bolt11: string;
+    verifyUrl: string;
+    paymentHash: string;
+    expiresAt: number;
+};
+/**
+ * Bech32-encode a pay endpoint as the `LNURL1` string LUD-01 defines, uppercase
+ * because that is the form it asks a QR to carry. An onion endpoint is http
+ * rather than https, which LUD-17 spells out, so both are taken here
+ */
+declare function toLnurl(endpoint: string): string;
+
+/** How the QR is drawn, which is the only thing about it worth configuring */
+interface QrOptions {
+    /** SVG width and height in pixels, defaults to 256 */
+    size?: number;
+    /** Dark module color, defaults to `#000` */
+    color?: string;
+}
+/** Render a BOLT11 invoice or a lightning address as an SVG QR code */
+declare function invoiceToSvg(destination: string, options?: QrOptions): string;
+/** SVG data URL for an `<img>` `src` */
+declare function invoiceToDataUrl(destination: string, options?: QrOptions): string;
+/**
+ * Render your own LNURL-pay endpoint, the URL `serve.lnurlPay` is mounted on, as
+ * the QR a payer scans. It takes the endpoint URL and does the bech32 itself, so
+ * do not hand it the output of `toLnurl` - that is what this calls for you.
+ *
+ * Nothing is minted and nothing expires, so this is the code a tip jar prints
+ * once and an overlay shows all stream
+ */
+declare function lnurlEndpointToSvg(endpoint: string, options?: QrOptions): string;
+/** SVG data URL of the endpoint's QR, for an `<img>` `src` */
+declare function lnurlEndpointToDataUrl(endpoint: string, options?: QrOptions): string;
+/**
+ * Render the `spd` from `bankTransfer` as the QR a Czech banking app scans. The
+ * payload is a Short Payment Descriptor, so it carries the account, the amount
+ * and the reference the payer must leave on the transfer
+ */
+declare function spdToSvg(spd: string, options?: QrOptions): string;
+/** SVG data URL of the bank transfer's QR, for an `<img>` `src` */
+declare function spdToDataUrl(spd: string, options?: QrOptions): string;
+/**
+ * Render any rail's `Leg.qr` as an SVG QR code. Each rail states its own payload,
+ * a BOLT11 invoice under the `LIGHTNING` scheme or a Short Payment Descriptor as
+ * it stands, so this draws a leg without being told which rail made it
+ */
+declare function qrToSvg(payload: string, options?: QrOptions): string;
+/** SVG data URL of a leg's QR, for an `<img>` `src` */
+declare function qrToDataUrl(payload: string, options?: QrOptions): string;
+
+export { type QrOptions as Q, type Resolved as R, invoiceToSvg as a, lnurlEndpointToSvg as b, qrToSvg as c, spdToSvg as d, invoiceToDataUrl as i, lnurlEndpointToDataUrl as l, qrToDataUrl as q, spdToDataUrl as s, toLnurl as t };