@eupi/taler 0.1.0

package/README.md

@@ -0,0 +1,62 @@
+# @eupi/taler
+
+Top up GNU Taler reserves with standard European payment QR codes.
+
+## How it works
+
+A Taler wallet is funded by wiring money to the exchange's bank account with the
+**reserve public key** as the transfer subject. The exchange watches its account
+(via LibEuFin/Nexus), finds the key in the subject of an incoming credit, and
+credits that reserve.
+
+This package encodes that flow as an **EPC069-12 QR code** (the "EPC QR" / GiroCode
+that many European banking apps scan natively). The QR carries the exchange's IBAN,
+an optional amount, and the reserve public key as remittance text. The payer scans
+it in their own banking app and confirms; since October 2025 the resulting SEPA
+Instant Credit Transfer reaches the exchange in seconds. No Taler-specific software
+is needed on the payer's side, and no payment service provider sits in between.
+
+```
+Taler wallet                    payer's own banking app            exchange bank account
+  reserve keypair  ──QR code──►  scan, confirm transfer  ──SCT──►  subject: <reserve pub>
+                                                                        │
+  coins withdrawn  ◄───────────  exchange credits reserve  ◄──────  LibEuFin/Nexus
+```
+
+## Usage
+
+```ts
+import { encodeTalerTopupQr, parseTalerTopupQr, findReservePub } from "@eupi/taler";
+import QRCode from "qrcode";
+
+// Wallet or exchange side: build the QR for a withdrawal
+const payload = encodeTalerTopupQr({
+  accountName: "Taler Exchange Demo",
+  iban: "DE71 1102 2033 0123 4567 89",
+  amount: 50,                      // omit for an open-amount QR
+  reservePub: "ABCDEFGHJKMNPQRSTVWXYZ0123456789ABCDEFGHJKMNPQRSTVWX",
+});
+await QRCode.toDataURL(payload, { errorCorrectionLevel: "M" });
+
+// Integration side: recognise top-up QR codes
+const topup = parseTalerTopupQr(scannedText);
+// topup.reservePub, topup.iban, topup.amount
+
+// Bank-watcher side: match incoming transfer subjects
+const pub = findReservePub("Taler ABCDEFGH... withdrawal");
+```
+
+Validation is inherited from [`@eupi/qr`](../qr) (IBAN check digits, amount range,
+payload limits) plus Taler reserve key checks (52-character Crockford base32 in
+Taler's alphabet: 0-9, A-Z without I, L, O, U). `findReservePub` tolerates
+surrounding text, since banks may decorate the subject line.
+
+## Roadmap
+
+A runnable end-to-end demonstration against libeufin-bank (create accounts, render
+the QR, execute the scanned transfer, observe the reserve credit) is planned as the
+next step, along with EN 18184 QR support offered upstream to the Taler wallets.
+
+## License
+
+Apache-2.0

package/dist/index.cjs

@@ -0,0 +1,97 @@
+"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/index.ts
+var index_exports = {};
+__export(index_exports, {
+  EpcQrError: () => import_qr.EpcQrError,
+  RESERVE_PUB_RE: () => RESERVE_PUB_RE,
+  TalerTopupError: () => TalerTopupError,
+  encodeTalerTopupQr: () => encodeTalerTopupQr,
+  findReservePub: () => findReservePub,
+  isValidReservePub: () => isValidReservePub,
+  parseTalerTopupQr: () => parseTalerTopupQr
+});
+module.exports = __toCommonJS(index_exports);
+var import_qr = require("@eupi/qr");
+var RESERVE_PUB_RE = /^[0-9A-HJKMNP-TV-Z]{52}$/;
+function isValidReservePub(input) {
+  return RESERVE_PUB_RE.test(input);
+}
+function findReservePub(subject) {
+  for (const token of subject.toUpperCase().split(/[^0-9A-Z]+/)) {
+    if (RESERVE_PUB_RE.test(token)) return token;
+  }
+  return void 0;
+}
+var TalerTopupError = class extends Error {
+  issues;
+  constructor(message, issues) {
+    super(message);
+    this.name = "TalerTopupError";
+    this.issues = issues;
+  }
+};
+function encodeTalerTopupQr(options) {
+  const reservePub = options.reservePub.toUpperCase();
+  if (!isValidReservePub(reservePub)) {
+    throw new TalerTopupError("invalid Taler reserve public key", [
+      {
+        field: "reservePub",
+        message: "must be 52 Crockford base32 characters (0-9, A-Z without I, L, O, U)"
+      }
+    ]);
+  }
+  return (0, import_qr.encodeEpcQr)({
+    name: options.accountName,
+    iban: options.iban,
+    text: reservePub,
+    ...options.bic !== void 0 ? { bic: options.bic } : {},
+    ...options.amount !== void 0 ? { amount: options.amount } : {},
+    ...options.crlf !== void 0 ? { crlf: options.crlf } : {}
+  });
+}
+function parseTalerTopupQr(payload) {
+  const { data } = (0, import_qr.decodeEpcQr)(payload);
+  const subject = data.text ?? data.reference ?? "";
+  const reservePub = findReservePub(subject);
+  if (reservePub === void 0) {
+    throw new TalerTopupError("no Taler reserve public key in remittance information", [
+      { field: "text", message: "expected a 52-character Crockford base32 reserve public key" }
+    ]);
+  }
+  return {
+    reservePub,
+    iban: data.iban,
+    accountName: data.name,
+    ...data.bic !== void 0 ? { bic: data.bic } : {},
+    ...data.amount !== void 0 ? { amount: data.amount } : {}
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  EpcQrError,
+  RESERVE_PUB_RE,
+  TalerTopupError,
+  encodeTalerTopupQr,
+  findReservePub,
+  isValidReservePub,
+  parseTalerTopupQr
+});
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["/**\n * Bridge between GNU Taler and the European payment QR standards.\n *\n * A Taler wallet is funded by wiring money to the exchange's bank account\n * with the reserve public key as the transfer subject: the exchange watches\n * its account (via LibEuFin/Nexus), finds the reserve public key in the\n * subject of an incoming credit, and credits that reserve.\n *\n * This package encodes that flow as a standard EPC069-12 QR code (the\n * \"EPC QR\" / GiroCode many European banking apps scan natively): the QR\n * carries the exchange's IBAN, an optional amount, and the reserve public\n * key as remittance text. Scanning it in a regular banking app produces a\n * correctly addressed SEPA (Instant) Credit Transfer that funds the\n * reserve, with no Taler-specific software on the payer's side.\n */\n\nimport { EpcQrError, decodeEpcQr, encodeEpcQr } from \"@eupi/qr\";\n\n/**\n * Taler encodes binary data in Crockford base32 using the alphabet\n * 0-9 A-Z without I, L, O, U. A reserve public key is a 32-byte EdDSA\n * public key, which encodes to 52 characters.\n */\nexport const RESERVE_PUB_RE = /^[0-9A-HJKMNP-TV-Z]{52}$/;\n\n/** True when the input is a well-formed Taler reserve public key. */\nexport function isValidReservePub(input: string): boolean {\n  return RESERVE_PUB_RE.test(input);\n}\n\n/**\n * Extracts the first well-formed reserve public key token from a transfer\n * subject. Exchanges tolerate surrounding text in the subject line, and\n * some banks prepend or append their own text; this scans token-wise.\n */\nexport function findReservePub(subject: string): string | undefined {\n  for (const token of subject.toUpperCase().split(/[^0-9A-Z]+/)) {\n    if (RESERVE_PUB_RE.test(token)) return token;\n  }\n  return undefined;\n}\n\nexport interface TalerTopupIssue {\n  field: string;\n  message: string;\n}\n\nexport class TalerTopupError extends Error {\n  readonly issues: TalerTopupIssue[];\n  constructor(message: string, issues: TalerTopupIssue[]) {\n    super(message);\n    this.name = \"TalerTopupError\";\n    this.issues = issues;\n  }\n}\n\nexport interface TalerTopupOptions {\n  /** Account holder name of the exchange's bank account, up to 70 characters. */\n  accountName: string;\n  /** IBAN of the exchange's bank account. */\n  iban: string;\n  /** BIC of the exchange's bank; optional within the EEA. */\n  bic?: string;\n  /**\n   * Amount in euro (number or numeric string). Omit for an open-amount QR\n   * where the payer chooses the top-up amount in their banking app.\n   */\n  amount?: number | string;\n  /** The Taler reserve public key to credit (52-character Crockford base32). */\n  reservePub: string;\n  /** Use CRLF as the payload element separator instead of LF. */\n  crlf?: boolean;\n}\n\n/**\n * Builds an EPC069-12 QR payload that tops up the given Taler reserve when\n * scanned and confirmed in the payer's own banking app. Render it with any\n * QR library at error correction level M.\n *\n * @throws TalerTopupError on a malformed reserve public key; EpcQrError on\n *         invalid bank data (propagated from @eupi/qr).\n */\nexport function encodeTalerTopupQr(options: TalerTopupOptions): string {\n  const reservePub = options.reservePub.toUpperCase();\n  if (!isValidReservePub(reservePub)) {\n    throw new TalerTopupError(\"invalid Taler reserve public key\", [\n      {\n        field: \"reservePub\",\n        message: \"must be 52 Crockford base32 characters (0-9, A-Z without I, L, O, U)\",\n      },\n    ]);\n  }\n  return encodeEpcQr({\n    name: options.accountName,\n    iban: options.iban,\n    text: reservePub,\n    ...(options.bic !== undefined ? { bic: options.bic } : {}),\n    ...(options.amount !== undefined ? { amount: options.amount } : {}),\n    ...(options.crlf !== undefined ? { crlf: options.crlf } : {}),\n  });\n}\n\nexport interface TalerTopup {\n  /** The reserve public key found in the remittance text. */\n  reservePub: string;\n  /** IBAN of the receiving (exchange) account. */\n  iban: string;\n  /** Account holder name of the receiving account. */\n  accountName: string;\n  bic?: string;\n  /** Amount in euro as a numeric string, when the QR fixes one. */\n  amount?: string;\n}\n\n/**\n * Parses an EPC069-12 payload and extracts the Taler top-up details.\n *\n * @throws EpcQrError when the payload is not a valid EPC QR;\n *         TalerTopupError when it contains no reserve public key.\n */\nexport function parseTalerTopupQr(payload: string): TalerTopup {\n  const { data } = decodeEpcQr(payload);\n  const subject = data.text ?? data.reference ?? \"\";\n  const reservePub = findReservePub(subject);\n  if (reservePub === undefined) {\n    throw new TalerTopupError(\"no Taler reserve public key in remittance information\", [\n      { field: \"text\", message: \"expected a 52-character Crockford base32 reserve public key\" },\n    ]);\n  }\n  return {\n    reservePub,\n    iban: data.iban,\n    accountName: data.name,\n    ...(data.bic !== undefined ? { bic: data.bic } : {}),\n    ...(data.amount !== undefined ? { amount: data.amount } : {}),\n  };\n}\n\nexport { EpcQrError };\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAgBA,gBAAqD;AAO9C,IAAM,iBAAiB;AAGvB,SAAS,kBAAkB,OAAwB;AACxD,SAAO,eAAe,KAAK,KAAK;AAClC;AAOO,SAAS,eAAe,SAAqC;AAClE,aAAW,SAAS,QAAQ,YAAY,EAAE,MAAM,YAAY,GAAG;AAC7D,QAAI,eAAe,KAAK,KAAK,EAAG,QAAO;AAAA,EACzC;AACA,SAAO;AACT;AAOO,IAAM,kBAAN,cAA8B,MAAM;AAAA,EAChC;AAAA,EACT,YAAY,SAAiB,QAA2B;AACtD,UAAM,OAAO;AACb,SAAK,OAAO;AACZ,SAAK,SAAS;AAAA,EAChB;AACF;AA4BO,SAAS,mBAAmB,SAAoC;AACrE,QAAM,aAAa,QAAQ,WAAW,YAAY;AAClD,MAAI,CAAC,kBAAkB,UAAU,GAAG;AAClC,UAAM,IAAI,gBAAgB,oCAAoC;AAAA,MAC5D;AAAA,QACE,OAAO;AAAA,QACP,SAAS;AAAA,MACX;AAAA,IACF,CAAC;AAAA,EACH;AACA,aAAO,uBAAY;AAAA,IACjB,MAAM,QAAQ;AAAA,IACd,MAAM,QAAQ;AAAA,IACd,MAAM;AAAA,IACN,GAAI,QAAQ,QAAQ,SAAY,EAAE,KAAK,QAAQ,IAAI,IAAI,CAAC;AAAA,IACxD,GAAI,QAAQ,WAAW,SAAY,EAAE,QAAQ,QAAQ,OAAO,IAAI,CAAC;AAAA,IACjE,GAAI,QAAQ,SAAS,SAAY,EAAE,MAAM,QAAQ,KAAK,IAAI,CAAC;AAAA,EAC7D,CAAC;AACH;AAoBO,SAAS,kBAAkB,SAA6B;AAC7D,QAAM,EAAE,KAAK,QAAI,uBAAY,OAAO;AACpC,QAAM,UAAU,KAAK,QAAQ,KAAK,aAAa;AAC/C,QAAM,aAAa,eAAe,OAAO;AACzC,MAAI,eAAe,QAAW;AAC5B,UAAM,IAAI,gBAAgB,yDAAyD;AAAA,MACjF,EAAE,OAAO,QAAQ,SAAS,8DAA8D;AAAA,IAC1F,CAAC;AAAA,EACH;AACA,SAAO;AAAA,IACL;AAAA,IACA,MAAM,KAAK;AAAA,IACX,aAAa,KAAK;AAAA,IAClB,GAAI,KAAK,QAAQ,SAAY,EAAE,KAAK,KAAK,IAAI,IAAI,CAAC;AAAA,IAClD,GAAI,KAAK,WAAW,SAAY,EAAE,QAAQ,KAAK,OAAO,IAAI,CAAC;AAAA,EAC7D;AACF;","names":[]}

package/dist/index.d.cts

@@ -0,0 +1,86 @@
+export { EpcQrError } from '@eupi/qr';
+
+/**
+ * Bridge between GNU Taler and the European payment QR standards.
+ *
+ * A Taler wallet is funded by wiring money to the exchange's bank account
+ * with the reserve public key as the transfer subject: the exchange watches
+ * its account (via LibEuFin/Nexus), finds the reserve public key in the
+ * subject of an incoming credit, and credits that reserve.
+ *
+ * This package encodes that flow as a standard EPC069-12 QR code (the
+ * "EPC QR" / GiroCode many European banking apps scan natively): the QR
+ * carries the exchange's IBAN, an optional amount, and the reserve public
+ * key as remittance text. Scanning it in a regular banking app produces a
+ * correctly addressed SEPA (Instant) Credit Transfer that funds the
+ * reserve, with no Taler-specific software on the payer's side.
+ */
+
+/**
+ * Taler encodes binary data in Crockford base32 using the alphabet
+ * 0-9 A-Z without I, L, O, U. A reserve public key is a 32-byte EdDSA
+ * public key, which encodes to 52 characters.
+ */
+declare const RESERVE_PUB_RE: RegExp;
+/** True when the input is a well-formed Taler reserve public key. */
+declare function isValidReservePub(input: string): boolean;
+/**
+ * Extracts the first well-formed reserve public key token from a transfer
+ * subject. Exchanges tolerate surrounding text in the subject line, and
+ * some banks prepend or append their own text; this scans token-wise.
+ */
+declare function findReservePub(subject: string): string | undefined;
+interface TalerTopupIssue {
+    field: string;
+    message: string;
+}
+declare class TalerTopupError extends Error {
+    readonly issues: TalerTopupIssue[];
+    constructor(message: string, issues: TalerTopupIssue[]);
+}
+interface TalerTopupOptions {
+    /** Account holder name of the exchange's bank account, up to 70 characters. */
+    accountName: string;
+    /** IBAN of the exchange's bank account. */
+    iban: string;
+    /** BIC of the exchange's bank; optional within the EEA. */
+    bic?: string;
+    /**
+     * Amount in euro (number or numeric string). Omit for an open-amount QR
+     * where the payer chooses the top-up amount in their banking app.
+     */
+    amount?: number | string;
+    /** The Taler reserve public key to credit (52-character Crockford base32). */
+    reservePub: string;
+    /** Use CRLF as the payload element separator instead of LF. */
+    crlf?: boolean;
+}
+/**
+ * Builds an EPC069-12 QR payload that tops up the given Taler reserve when
+ * scanned and confirmed in the payer's own banking app. Render it with any
+ * QR library at error correction level M.
+ *
+ * @throws TalerTopupError on a malformed reserve public key; EpcQrError on
+ *         invalid bank data (propagated from @eupi/qr).
+ */
+declare function encodeTalerTopupQr(options: TalerTopupOptions): string;
+interface TalerTopup {
+    /** The reserve public key found in the remittance text. */
+    reservePub: string;
+    /** IBAN of the receiving (exchange) account. */
+    iban: string;
+    /** Account holder name of the receiving account. */
+    accountName: string;
+    bic?: string;
+    /** Amount in euro as a numeric string, when the QR fixes one. */
+    amount?: string;
+}
+/**
+ * Parses an EPC069-12 payload and extracts the Taler top-up details.
+ *
+ * @throws EpcQrError when the payload is not a valid EPC QR;
+ *         TalerTopupError when it contains no reserve public key.
+ */
+declare function parseTalerTopupQr(payload: string): TalerTopup;
+
+export { RESERVE_PUB_RE, type TalerTopup, TalerTopupError, type TalerTopupIssue, type TalerTopupOptions, encodeTalerTopupQr, findReservePub, isValidReservePub, parseTalerTopupQr };

package/dist/index.d.ts

@@ -0,0 +1,86 @@
+export { EpcQrError } from '@eupi/qr';
+
+/**
+ * Bridge between GNU Taler and the European payment QR standards.
+ *
+ * A Taler wallet is funded by wiring money to the exchange's bank account
+ * with the reserve public key as the transfer subject: the exchange watches
+ * its account (via LibEuFin/Nexus), finds the reserve public key in the
+ * subject of an incoming credit, and credits that reserve.
+ *
+ * This package encodes that flow as a standard EPC069-12 QR code (the
+ * "EPC QR" / GiroCode many European banking apps scan natively): the QR
+ * carries the exchange's IBAN, an optional amount, and the reserve public
+ * key as remittance text. Scanning it in a regular banking app produces a
+ * correctly addressed SEPA (Instant) Credit Transfer that funds the
+ * reserve, with no Taler-specific software on the payer's side.
+ */
+
+/**
+ * Taler encodes binary data in Crockford base32 using the alphabet
+ * 0-9 A-Z without I, L, O, U. A reserve public key is a 32-byte EdDSA
+ * public key, which encodes to 52 characters.
+ */
+declare const RESERVE_PUB_RE: RegExp;
+/** True when the input is a well-formed Taler reserve public key. */
+declare function isValidReservePub(input: string): boolean;
+/**
+ * Extracts the first well-formed reserve public key token from a transfer
+ * subject. Exchanges tolerate surrounding text in the subject line, and
+ * some banks prepend or append their own text; this scans token-wise.
+ */
+declare function findReservePub(subject: string): string | undefined;
+interface TalerTopupIssue {
+    field: string;
+    message: string;
+}
+declare class TalerTopupError extends Error {
+    readonly issues: TalerTopupIssue[];
+    constructor(message: string, issues: TalerTopupIssue[]);
+}
+interface TalerTopupOptions {
+    /** Account holder name of the exchange's bank account, up to 70 characters. */
+    accountName: string;
+    /** IBAN of the exchange's bank account. */
+    iban: string;
+    /** BIC of the exchange's bank; optional within the EEA. */
+    bic?: string;
+    /**
+     * Amount in euro (number or numeric string). Omit for an open-amount QR
+     * where the payer chooses the top-up amount in their banking app.
+     */
+    amount?: number | string;
+    /** The Taler reserve public key to credit (52-character Crockford base32). */
+    reservePub: string;
+    /** Use CRLF as the payload element separator instead of LF. */
+    crlf?: boolean;
+}
+/**
+ * Builds an EPC069-12 QR payload that tops up the given Taler reserve when
+ * scanned and confirmed in the payer's own banking app. Render it with any
+ * QR library at error correction level M.
+ *
+ * @throws TalerTopupError on a malformed reserve public key; EpcQrError on
+ *         invalid bank data (propagated from @eupi/qr).
+ */
+declare function encodeTalerTopupQr(options: TalerTopupOptions): string;
+interface TalerTopup {
+    /** The reserve public key found in the remittance text. */
+    reservePub: string;
+    /** IBAN of the receiving (exchange) account. */
+    iban: string;
+    /** Account holder name of the receiving account. */
+    accountName: string;
+    bic?: string;
+    /** Amount in euro as a numeric string, when the QR fixes one. */
+    amount?: string;
+}
+/**
+ * Parses an EPC069-12 payload and extracts the Taler top-up details.
+ *
+ * @throws EpcQrError when the payload is not a valid EPC QR;
+ *         TalerTopupError when it contains no reserve public key.
+ */
+declare function parseTalerTopupQr(payload: string): TalerTopup;
+
+export { RESERVE_PUB_RE, type TalerTopup, TalerTopupError, type TalerTopupIssue, type TalerTopupOptions, encodeTalerTopupQr, findReservePub, isValidReservePub, parseTalerTopupQr };

package/dist/index.js

@@ -0,0 +1,66 @@
+// src/index.ts
+import { EpcQrError, decodeEpcQr, encodeEpcQr } from "@eupi/qr";
+var RESERVE_PUB_RE = /^[0-9A-HJKMNP-TV-Z]{52}$/;
+function isValidReservePub(input) {
+  return RESERVE_PUB_RE.test(input);
+}
+function findReservePub(subject) {
+  for (const token of subject.toUpperCase().split(/[^0-9A-Z]+/)) {
+    if (RESERVE_PUB_RE.test(token)) return token;
+  }
+  return void 0;
+}
+var TalerTopupError = class extends Error {
+  issues;
+  constructor(message, issues) {
+    super(message);
+    this.name = "TalerTopupError";
+    this.issues = issues;
+  }
+};
+function encodeTalerTopupQr(options) {
+  const reservePub = options.reservePub.toUpperCase();
+  if (!isValidReservePub(reservePub)) {
+    throw new TalerTopupError("invalid Taler reserve public key", [
+      {
+        field: "reservePub",
+        message: "must be 52 Crockford base32 characters (0-9, A-Z without I, L, O, U)"
+      }
+    ]);
+  }
+  return encodeEpcQr({
+    name: options.accountName,
+    iban: options.iban,
+    text: reservePub,
+    ...options.bic !== void 0 ? { bic: options.bic } : {},
+    ...options.amount !== void 0 ? { amount: options.amount } : {},
+    ...options.crlf !== void 0 ? { crlf: options.crlf } : {}
+  });
+}
+function parseTalerTopupQr(payload) {
+  const { data } = decodeEpcQr(payload);
+  const subject = data.text ?? data.reference ?? "";
+  const reservePub = findReservePub(subject);
+  if (reservePub === void 0) {
+    throw new TalerTopupError("no Taler reserve public key in remittance information", [
+      { field: "text", message: "expected a 52-character Crockford base32 reserve public key" }
+    ]);
+  }
+  return {
+    reservePub,
+    iban: data.iban,
+    accountName: data.name,
+    ...data.bic !== void 0 ? { bic: data.bic } : {},
+    ...data.amount !== void 0 ? { amount: data.amount } : {}
+  };
+}
+export {
+  EpcQrError,
+  RESERVE_PUB_RE,
+  TalerTopupError,
+  encodeTalerTopupQr,
+  findReservePub,
+  isValidReservePub,
+  parseTalerTopupQr
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["/**\n * Bridge between GNU Taler and the European payment QR standards.\n *\n * A Taler wallet is funded by wiring money to the exchange's bank account\n * with the reserve public key as the transfer subject: the exchange watches\n * its account (via LibEuFin/Nexus), finds the reserve public key in the\n * subject of an incoming credit, and credits that reserve.\n *\n * This package encodes that flow as a standard EPC069-12 QR code (the\n * \"EPC QR\" / GiroCode many European banking apps scan natively): the QR\n * carries the exchange's IBAN, an optional amount, and the reserve public\n * key as remittance text. Scanning it in a regular banking app produces a\n * correctly addressed SEPA (Instant) Credit Transfer that funds the\n * reserve, with no Taler-specific software on the payer's side.\n */\n\nimport { EpcQrError, decodeEpcQr, encodeEpcQr } from \"@eupi/qr\";\n\n/**\n * Taler encodes binary data in Crockford base32 using the alphabet\n * 0-9 A-Z without I, L, O, U. A reserve public key is a 32-byte EdDSA\n * public key, which encodes to 52 characters.\n */\nexport const RESERVE_PUB_RE = /^[0-9A-HJKMNP-TV-Z]{52}$/;\n\n/** True when the input is a well-formed Taler reserve public key. */\nexport function isValidReservePub(input: string): boolean {\n  return RESERVE_PUB_RE.test(input);\n}\n\n/**\n * Extracts the first well-formed reserve public key token from a transfer\n * subject. Exchanges tolerate surrounding text in the subject line, and\n * some banks prepend or append their own text; this scans token-wise.\n */\nexport function findReservePub(subject: string): string | undefined {\n  for (const token of subject.toUpperCase().split(/[^0-9A-Z]+/)) {\n    if (RESERVE_PUB_RE.test(token)) return token;\n  }\n  return undefined;\n}\n\nexport interface TalerTopupIssue {\n  field: string;\n  message: string;\n}\n\nexport class TalerTopupError extends Error {\n  readonly issues: TalerTopupIssue[];\n  constructor(message: string, issues: TalerTopupIssue[]) {\n    super(message);\n    this.name = \"TalerTopupError\";\n    this.issues = issues;\n  }\n}\n\nexport interface TalerTopupOptions {\n  /** Account holder name of the exchange's bank account, up to 70 characters. */\n  accountName: string;\n  /** IBAN of the exchange's bank account. */\n  iban: string;\n  /** BIC of the exchange's bank; optional within the EEA. */\n  bic?: string;\n  /**\n   * Amount in euro (number or numeric string). Omit for an open-amount QR\n   * where the payer chooses the top-up amount in their banking app.\n   */\n  amount?: number | string;\n  /** The Taler reserve public key to credit (52-character Crockford base32). */\n  reservePub: string;\n  /** Use CRLF as the payload element separator instead of LF. */\n  crlf?: boolean;\n}\n\n/**\n * Builds an EPC069-12 QR payload that tops up the given Taler reserve when\n * scanned and confirmed in the payer's own banking app. Render it with any\n * QR library at error correction level M.\n *\n * @throws TalerTopupError on a malformed reserve public key; EpcQrError on\n *         invalid bank data (propagated from @eupi/qr).\n */\nexport function encodeTalerTopupQr(options: TalerTopupOptions): string {\n  const reservePub = options.reservePub.toUpperCase();\n  if (!isValidReservePub(reservePub)) {\n    throw new TalerTopupError(\"invalid Taler reserve public key\", [\n      {\n        field: \"reservePub\",\n        message: \"must be 52 Crockford base32 characters (0-9, A-Z without I, L, O, U)\",\n      },\n    ]);\n  }\n  return encodeEpcQr({\n    name: options.accountName,\n    iban: options.iban,\n    text: reservePub,\n    ...(options.bic !== undefined ? { bic: options.bic } : {}),\n    ...(options.amount !== undefined ? { amount: options.amount } : {}),\n    ...(options.crlf !== undefined ? { crlf: options.crlf } : {}),\n  });\n}\n\nexport interface TalerTopup {\n  /** The reserve public key found in the remittance text. */\n  reservePub: string;\n  /** IBAN of the receiving (exchange) account. */\n  iban: string;\n  /** Account holder name of the receiving account. */\n  accountName: string;\n  bic?: string;\n  /** Amount in euro as a numeric string, when the QR fixes one. */\n  amount?: string;\n}\n\n/**\n * Parses an EPC069-12 payload and extracts the Taler top-up details.\n *\n * @throws EpcQrError when the payload is not a valid EPC QR;\n *         TalerTopupError when it contains no reserve public key.\n */\nexport function parseTalerTopupQr(payload: string): TalerTopup {\n  const { data } = decodeEpcQr(payload);\n  const subject = data.text ?? data.reference ?? \"\";\n  const reservePub = findReservePub(subject);\n  if (reservePub === undefined) {\n    throw new TalerTopupError(\"no Taler reserve public key in remittance information\", [\n      { field: \"text\", message: \"expected a 52-character Crockford base32 reserve public key\" },\n    ]);\n  }\n  return {\n    reservePub,\n    iban: data.iban,\n    accountName: data.name,\n    ...(data.bic !== undefined ? { bic: data.bic } : {}),\n    ...(data.amount !== undefined ? { amount: data.amount } : {}),\n  };\n}\n\nexport { EpcQrError };\n"],"mappings":";AAgBA,SAAS,YAAY,aAAa,mBAAmB;AAO9C,IAAM,iBAAiB;AAGvB,SAAS,kBAAkB,OAAwB;AACxD,SAAO,eAAe,KAAK,KAAK;AAClC;AAOO,SAAS,eAAe,SAAqC;AAClE,aAAW,SAAS,QAAQ,YAAY,EAAE,MAAM,YAAY,GAAG;AAC7D,QAAI,eAAe,KAAK,KAAK,EAAG,QAAO;AAAA,EACzC;AACA,SAAO;AACT;AAOO,IAAM,kBAAN,cAA8B,MAAM;AAAA,EAChC;AAAA,EACT,YAAY,SAAiB,QAA2B;AACtD,UAAM,OAAO;AACb,SAAK,OAAO;AACZ,SAAK,SAAS;AAAA,EAChB;AACF;AA4BO,SAAS,mBAAmB,SAAoC;AACrE,QAAM,aAAa,QAAQ,WAAW,YAAY;AAClD,MAAI,CAAC,kBAAkB,UAAU,GAAG;AAClC,UAAM,IAAI,gBAAgB,oCAAoC;AAAA,MAC5D;AAAA,QACE,OAAO;AAAA,QACP,SAAS;AAAA,MACX;AAAA,IACF,CAAC;AAAA,EACH;AACA,SAAO,YAAY;AAAA,IACjB,MAAM,QAAQ;AAAA,IACd,MAAM,QAAQ;AAAA,IACd,MAAM;AAAA,IACN,GAAI,QAAQ,QAAQ,SAAY,EAAE,KAAK,QAAQ,IAAI,IAAI,CAAC;AAAA,IACxD,GAAI,QAAQ,WAAW,SAAY,EAAE,QAAQ,QAAQ,OAAO,IAAI,CAAC;AAAA,IACjE,GAAI,QAAQ,SAAS,SAAY,EAAE,MAAM,QAAQ,KAAK,IAAI,CAAC;AAAA,EAC7D,CAAC;AACH;AAoBO,SAAS,kBAAkB,SAA6B;AAC7D,QAAM,EAAE,KAAK,IAAI,YAAY,OAAO;AACpC,QAAM,UAAU,KAAK,QAAQ,KAAK,aAAa;AAC/C,QAAM,aAAa,eAAe,OAAO;AACzC,MAAI,eAAe,QAAW;AAC5B,UAAM,IAAI,gBAAgB,yDAAyD;AAAA,MACjF,EAAE,OAAO,QAAQ,SAAS,8DAA8D;AAAA,IAC1F,CAAC;AAAA,EACH;AACA,SAAO;AAAA,IACL;AAAA,IACA,MAAM,KAAK;AAAA,IACX,aAAa,KAAK;AAAA,IAClB,GAAI,KAAK,QAAQ,SAAY,EAAE,KAAK,KAAK,IAAI,IAAI,CAAC;AAAA,IAClD,GAAI,KAAK,WAAW,SAAY,EAAE,QAAQ,KAAK,OAAO,IAAI,CAAC;AAAA,EAC7D;AACF;","names":[]}

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@eupi/taler",
+  "version": "0.1.0",
+  "description": "Top up GNU Taler reserves with standard European payment QR codes (EPC069-12 / EN 18184)",
+  "keywords": [
+    "taler",
+    "gnu-taler",
+    "sepa",
+    "sepa-instant",
+    "qr",
+    "girocode",
+    "epc-qr",
+    "payments",
+    "withdrawal",
+    "reserve"
+  ],
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/LedgerInnovation/eupi.git",
+    "directory": "packages/taler"
+  },
+  "type": "module",
+  "sideEffects": false,
+  "engines": {
+    "node": ">=18"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsup src/index.ts --format esm,cjs --dts --sourcemap --clean",
+    "test": "vitest run",
+    "typecheck": "tsc --noEmit"
+  },
+  "dependencies": {
+    "@eupi/qr": "workspace:^"
+  },
+  "devDependencies": {
+    "tsup": "^8.5.0",
+    "typescript": "^5.8.0",
+    "vitest": "^3.2.0"
+  }
+}