thunder-bridge 2.2.0 → 3.0.0

package/dist/nwc.js

@@ -349,8 +349,6 @@ function asBuffer(bytes) {
 }
 
 // ../core/sealed.ts
-var VERSION = "v2";
-var UNPADDED_VERSION = "v1";
 var PURPOSE_VERSION = "v3";
 var IV_BYTES = 12;
 var MIN_SECRET_CHARS = 32;
@@ -358,15 +356,6 @@ var MAX_PLAIN_BYTES = 3e3;
 var SIZE_CLASSES = [256, 1024, MAX_PLAIN_BYTES];
 var END_OF_TEXT = 128;
 var INFO = "thunder-bridge/sealed";
-async function seal(secret, plaintext, paymentHash) {
-  return await sealUnder(
-    await keyFor(secret, INFO),
-    plaintext,
-    crypto.getRandomValues(new Uint8Array(IV_BYTES)),
-    VERSION,
-    boundTo(paymentHash)
-  );
-}
 async function sealFor(purpose, secret, plaintext, { stable = false } = {}) {
   return await sealUnder(
     await keyFor(secret, `${INFO}/${purpose}`),
@@ -376,16 +365,6 @@ async function sealFor(purpose, secret, plaintext, { stable = false } = {}) {
     new TextEncoder().encode(PURPOSE_VERSION)
   );
 }
-async function unsealFor(purpose, secret, sealed) {
-  if (!sealed.startsWith(`${PURPOSE_VERSION}.`)) {
-    return await unseal(secret, sealed);
-  }
-  return await opened(
-    await keyFor(secret, `${INFO}/${purpose}`),
-    sealed.slice(PURPOSE_VERSION.length + 1),
-    new TextEncoder().encode(PURPOSE_VERSION)
-  );
-}
 async function nonceOf(secret, plaintext) {
   const derived = await hmacHex(secret, `sealed-nonce|${plaintext}`);
   const nonce = new Uint8Array(IV_BYTES);
@@ -404,48 +383,11 @@ async function sealUnder(key, plaintext, iv, version, additionalData) {
   joined2.set(cipher, iv.length);
   return `${version}.${toBase64Url(joined2)}`;
 }
-async function unseal(secret, sealed, paymentHash) {
-  const key = await keyFor(secret, INFO);
-  const padded2 = sealed.startsWith(`${VERSION}.`);
-  const unbound = !padded2 && sealed.startsWith(`${UNPADDED_VERSION}.`);
-  if (!padded2 && (!unbound || paymentHash !== void 0)) {
-    return null;
-  }
-  return await opened(
-    key,
-    sealed.slice(VERSION.length + 1),
-    padded2 ? boundTo(paymentHash) : void 0
-  );
-}
-async function opened(key, encoded, additionalData) {
-  const joined2 = fromBase64Url(encoded);
-  if (joined2 === null || joined2.length <= IV_BYTES) {
-    return null;
-  }
-  try {
-    const body = new Uint8Array(
-      await crypto.subtle.decrypt(
-        { name: "AES-GCM", iv: joined2.slice(0, IV_BYTES), additionalData },
-        key,
-        joined2.slice(IV_BYTES)
-      )
-    );
-    const text = additionalData === void 0 ? body : unpad(body);
-    return text === null ? null : new TextDecoder().decode(text);
-  } catch {
-    return null;
-  }
-}
 function refuseAWeakSecret(secret) {
   if (secret.length < MIN_SECRET_CHARS) {
     throw new Error(`the sealing secret needs ${MIN_SECRET_CHARS} characters of randomness`);
   }
 }
-function boundTo(paymentHash) {
-  return new TextEncoder().encode(
-    paymentHash === void 0 ? VERSION : `${VERSION}|${paymentHash.toLowerCase()}`
-  );
-}
 function padToClass(plaintext) {
   const text = new TextEncoder().encode(plaintext);
   const size = SIZE_CLASSES.find((limit) => text.length <= limit);
@@ -457,10 +399,6 @@ function padToClass(plaintext) {
   body[text.length] = END_OF_TEXT;
   return body;
 }
-function unpad(body) {
-  const end = body.lastIndexOf(END_OF_TEXT);
-  return end === -1 ? null : body.subarray(0, end);
-}
 async function keyFor(secret, info) {
   refuseAWeakSecret(secret);
   const material = await crypto.subtle.importKey(
@@ -490,21 +428,6 @@ function toBase64Url(bytes) {
   }
   return btoa(binary).replace(/\+/g, "-").replace(/\//g, "_").replace(/=+$/, "");
 }
-function fromBase64Url(text) {
-  if (text.length === 0 || !/^[A-Za-z0-9_-]+$/.test(text)) {
-    return null;
-  }
-  try {
-    const binary = atob(text.replace(/-/g, "+").replace(/_/g, "/"));
-    const bytes = new Uint8Array(binary.length);
-    for (let at = 0; at < bytes.length; at++) {
-      bytes[at] = binary.charCodeAt(at);
-    }
-    return bytes;
-  } catch {
-    return null;
-  }
-}
 
 // src/nostr.ts
 import { chacha20 } from "@noble/ciphers/chacha.js";
@@ -661,274 +584,6 @@ function fromBase64(text) {
   return bytes;
 }
 
-// src/qr.ts
-import { encode } from "uqr";
-function toLightningUri(destination) {
-  const scanned = isLnAddress(destination) ? destination : destination.toUpperCase();
-  return `LIGHTNING:${scanned}`;
-}
-function isLnAddress(destination) {
-  const at = destination.indexOf("@");
-  return at > 0 && destination.slice(at + 1).includes(".");
-}
-
-// 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_BTC2 = 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_BTC2) * BigInt(BASIS_POINTS + spreadBps);
-  const per = BigInt(Math.round(priceMinorPerBtc)) * BigInt(BASIS_POINTS);
-  const msat2 = (wanted + per - 1n) / per;
-  if (msat2 > BigInt(Number.MAX_SAFE_INTEGER)) {
-    throw new Error(`${amountMinor} at ${priceMinorPerBtc} is more millisatoshi than exist`);
-  }
-  return Number(msat2);
-}
-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("; ");
-}
-
-// src/amount.ts
-var MSAT_PER_SAT = 1e3;
-var MAX_SATS = Math.floor(Number.MAX_SAFE_INTEGER / MSAT_PER_SAT);
-function msat(exact) {
-  if (!Number.isSafeInteger(exact) || exact < 1) {
-    throw new AmountError(
-      "not-whole-millisatoshi",
-      `${exact} is not a payable count of millisatoshi`
-    );
-  }
-  return exact;
-}
-async function amountNow(amount) {
-  return typeof amount === "function" ? msat(await amount()) : msat(amount);
-}
-
-// ../core/ed25519.ts
-var PKCS8_HEADER = hexToBytes("302e020100300506032b657004220420");
-var SMALL_ORDER = [
-  "00".repeat(32),
-  `01${"00".repeat(31)}`,
-  "26e8958fc2b227b045c3f489f2ef98f0d5dfac05d3c63339b13802886d53fc05",
-  "c7176a703d4dd84fba3c0b760d10670f2a2053fa2c39ccc64ec7fd7792ac037a",
-  `ec${"ff".repeat(30)}7f`,
-  `ed${"ff".repeat(30)}7f`,
-  `ee${"ff".repeat(30)}7f`
-];
-
-// src/webhook.ts
-var VERIFY_CHALLENGE = "verify-challenge";
-async function answerVerifyChallenge(request) {
-  if (request.method !== "POST") {
-    return null;
-  }
-  const nonce = nonceOf2(await request.clone().text(), VERIFY_CHALLENGE);
-  return nonce === null ? null : answered(nonce);
-}
-function answered(nonce) {
-  return new Response(JSON.stringify({ nonce }), {
-    headers: { "content-type": "application/json" }
-  });
-}
-function nonceOf2(text, type) {
-  try {
-    const said = JSON.parse(text);
-    if (said["type"] !== type || typeof said["nonce"] !== "string") {
-      return null;
-    }
-    return said["nonce"];
-  } catch {
-    return null;
-  }
-}
-
-// src/rail.ts
-async function msatForOrder(order, amount, rate) {
-  if (amount !== void 0) {
-    return await amountNow(amount(order));
-  }
-  return msat(msatFor(order.amountMinor, await (rate ?? medianOf())(order.currency)));
-}
-
 // src/nwc.ts
 var REQUEST_KIND = 23194;
 var RESPONSE_KIND = 23195;
@@ -937,7 +592,6 @@ var SCHEME = "nostr+walletconnect:";
 var HEX_32_BYTES = /^[0-9a-f]{64}$/i;
 var DEFAULT_ASK_TIMEOUT_MS = 1e4;
 var PAY_TIMEOUT_MS = 9e4;
-var DEFAULT_POLL_EVERY_SECS = 5;
 var HASH = "h";
 var REFUSAL_BY_CODE = {
   INSUFFICIENT_BALANCE: "amount-not-accepted",
@@ -963,13 +617,13 @@ function nwcConnection(uri) {
   return { walletPubkey: walletPubkey.toLowerCase(), relays, secret: secret.toLowerCase() };
 }
 async function nwcInvoice(connection, amountMsat, description, timeoutMs = DEFAULT_ASK_TIMEOUT_MS) {
-  const answered2 = await askWallet(
+  const answered = await askWallet(
     connection,
     "make_invoice",
     { amount: amountMsat, description },
     timeoutMs
   );
-  const bolt11 = String(answered2.invoice ?? "");
+  const bolt11 = String(answered.invoice ?? "");
   const issued = decodeInvoice(bolt11);
   if (issued.paymentHash === null || issued.expiresAt === null) {
     throw new WalletRefused("invoice-refused", "the nwc wallet issued an invoice we cannot decode");
@@ -983,7 +637,7 @@ async function nwcInvoice(connection, amountMsat, description, timeoutMs = DEFAU
   return { bolt11, paymentHash: issued.paymentHash, expiresAt: issued.expiresAt };
 }
 async function nwcHoldInvoice(connection, held, timeoutMs = DEFAULT_ASK_TIMEOUT_MS) {
-  const answered2 = await askWallet(
+  const answered = await askWallet(
     connection,
     "make_hold_invoice",
     {
@@ -995,7 +649,7 @@ async function nwcHoldInvoice(connection, held, timeoutMs = DEFAULT_ASK_TIMEOUT_
     },
     timeoutMs
   );
-  const bolt11 = String(answered2.invoice ?? "");
+  const bolt11 = String(answered.invoice ?? "");
   const issued = decodeInvoice(bolt11);
   if (issued.paymentHash === null || issued.expiresAt === null) {
     throw new WalletRefused("invoice-refused", "the nwc wallet held an invoice we cannot decode");
@@ -1015,13 +669,13 @@ async function nwcHoldInvoice(connection, held, timeoutMs = DEFAULT_ASK_TIMEOUT_
   return { bolt11, paymentHash: issued.paymentHash, expiresAt: issued.expiresAt };
 }
 async function nwcSettlement(connection, paymentHash, timeoutMs = DEFAULT_ASK_TIMEOUT_MS) {
-  const answered2 = await askWallet(
+  const answered = await askWallet(
     connection,
     "lookup_invoice",
     { payment_hash: paymentHash },
     timeoutMs
   );
-  const preimage = answered2.preimage;
+  const preimage = answered.preimage;
   if (typeof preimage !== "string" || preimage.length === 0) {
     return null;
   }
@@ -1035,39 +689,13 @@ async function nwcPay(connection, bolt11, timeoutMs = PAY_TIMEOUT_MS) {
   if (owed.paymentHash === null) {
     throw new WalletRefused("invoice-refused", "the invoice to pay carries no payment hash");
   }
-  const answered2 = await askWallet(connection, "pay_invoice", { invoice: bolt11 }, timeoutMs);
-  const preimage = answered2.preimage;
+  const answered = await askWallet(connection, "pay_invoice", { invoice: bolt11 }, timeoutMs);
+  const preimage = answered.preimage;
   if (typeof preimage !== "string" || !preimageMatchesHash(preimage, owed.paymentHash)) {
     throw new Error(`the nwc wallet paid and returned no preimage hashing to ${owed.paymentHash}`);
   }
   return preimage;
 }
-function nwcVerifyEndpoint(config) {
-  const paced = {
-    "cache-control": `max-age=${config.pollEverySecs ?? DEFAULT_POLL_EVERY_SECS}`
-  };
-  return async (request) => {
-    const consented = await answerVerifyChallenge(request);
-    if (consented !== null) {
-      return consented;
-    }
-    const sealed = new URL(request.url).searchParams.get(HASH);
-    if (sealed === null) {
-      return Response.json({ settled: false }, { status: 400 });
-    }
-    const paymentHash = await unsealFor("nwc-verify", config.secret, sealed);
-    if (paymentHash === null) {
-      return Response.json({ settled: false }, { status: 403 });
-    }
-    const preimage = await nwcSettlement(config.connection, paymentHash, config.askTimeoutMs).catch(
-      () => void 0
-    );
-    if (preimage === void 0) {
-      return Response.json({ settled: false }, { status: 502 });
-    }
-    return Response.json({ settled: preimage !== null, preimage }, { headers: paced });
-  };
-}
 async function nwcVerifyUrl(endpoint, paymentHash, secret) {
   const sealed = new URL(endpoint);
   sealed.searchParams.set(HASH, await sealFor("nwc-verify", secret, paymentHash));
@@ -1117,7 +745,7 @@ async function overFirstRelayThatAnswers(connection, request, timeoutMs) {
   throw new WalletRefused("unreachable", `no nwc relay answered: ${String(lastFailure)}`);
 }
 function overRelay(relay, connection, request, deadline) {
-  return new Promise((resolve2, reject) => {
+  return new Promise((resolve, reject) => {
     const socket = new WebSocket(relay);
     const subscription = request.id.slice(0, 16);
     const expired = () => {
@@ -1161,7 +789,7 @@ function overRelay(relay, connection, request, deadline) {
         return;
       }
       close();
-      resolve2(answer);
+      resolve(answer);
     });
   });
 }
@@ -1207,52 +835,12 @@ function isSecureRelay(relay) {
     return false;
   }
 }
-function nwcRail(gateway, config) {
-  return async (order) => {
-    const invoice = await nwcInvoice(
-      config.connection,
-      await msatForOrder(order, config.amount, config.rate),
-      config.description?.(order) ?? order.reference
-    );
-    const watched = await gateway.watch({
-      paymentHash: invoice.paymentHash,
-      verifyUrl: await nwcVerifyUrl(
-        config.verifyThrough.endpoint,
-        invoice.paymentHash,
-        config.verifyThrough.secret
-      ),
-      expiresAt: invoice.expiresAt,
-      trigger: config.trigger,
-      replay: config.replay,
-      sealed: config.sealed ? await seal(
-        config.sealed.secret,
-        JSON.stringify(config.sealed.data(order)),
-        invoice.paymentHash
-      ) : void 0,
-      webhookUrl: config.webhookUrl
-    });
-    return {
-      id: watched.id,
-      paymentHash: invoice.paymentHash,
-      rail: config.name ?? "lightning",
-      scan: invoice.bolt11,
-      qr: toLightningUri(invoice.bolt11),
-      expiresAt: invoice.expiresAt
-    };
-  };
-}
-
-// src/entry/nwc.ts
-var nwcRail2 = nwcRail;
-var nwcVerifyEndpoint2 = nwcVerifyEndpoint;
 export {
   askWallet,
   nwcConnection,
   nwcHoldInvoice,
   nwcInvoice,
   nwcPay,
-  nwcRail2 as nwcRail,
   nwcSettlement,
-  nwcVerifyEndpoint2 as nwcVerifyEndpoint,
   nwcVerifyUrl
 };

package/openapi.yaml

@@ -2,7 +2,7 @@ openapi: 3.1.0
 
 info:
   title: thunder-bridge, the endpoint your own service serves
-  version: 2.2.0
+  version: 3.0.0
   license:
     name: MIT
     identifier: MIT

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "thunder-bridge",
-  "version": "2.2.0",
-  "description": "Trustless JavaScript client for the Thunder Bridge Lightning payment gateway. Proves the invoice came from your own wallet before the payer sees it.",
+  "version": "3.0.0",
+  "description": "Take Bitcoin Lightning and bank payments in JavaScript, paid straight into your own wallet or account. No node to run, no custodian, and every payment proven rather than taken on the gateway's word.",
   "author": "i-am-fatik",
   "homepage": "https://agora.gripe/en/tools/thunder-bridge",
   "repository": {
@@ -111,6 +111,11 @@
     "bitcoin",
     "lnurl",
     "lud-21",
+    "lightning-address",
+    "nwc",
+    "bank-transfer",
+    "non-custodial",
+    "payment-gateway",
     "trustless",
     "payments",
     "websocket"
@@ -120,6 +125,7 @@
     "@noble/ciphers": "2.4.0",
     "@noble/curves": "2.4.0",
     "@noble/hashes": "2.4.0",
+    "structured-headers": "2.1.0",
     "uqr": "^0.1.3"
   },
   "overrides": {