thunder-bridge 2.2.0 → 2.2.1

package/README.md

@@ -152,12 +152,12 @@ preimage, and which side does the checking.
 
 | `rails.bank` | nobody, there is no invoice |
 |---|---|
-| the gateway is told | a hash and your URL, which names the amount and the reference |
+| the gateway is told | a hash and your URL, whose query is one sealed blob naming neither the amount, the reference nor the account |
 | the invoice is checked by | nobody, there is no invoice to check |
 | the gateway probes first | the same GET and signed nonce |
 | the gateway polls | your `serve.bankVerify` endpoint |
 | `settled` comes from | a `Statement` credit matching amount and currency exactly, with the reference anywhere in the payer's text |
-| the pace is set by | you, `pollEverySecs` |
+| the pace is set by | the statement: `fioStatement` reads every thirty seconds divided by its tokens, and `pollEverySecs` overrides it |
 
 Two things are worth reading off those blocks rather than inferring.
 

package/dist/{bank-B5MxT_6u.d.ts → bank-BgA45yOU.d.ts}

@@ -108,7 +108,7 @@ interface NwcRailConfig extends RailConfig {
     amount?: (order: Order) => Amount;
     /** Where the default conversion gets its rate, the median of four venues by default */
     rate?: Ticker;
-    /** Where `nwcVerifyEndpoint` is mounted, and the secret the hash is sealed with */
+    /** Where `serve.nwcVerify` is mounted, and the secret the hash is sealed with */
     verifyThrough: {
         endpoint: string;
         secret: string;
@@ -931,9 +931,13 @@ interface Credit {
 /**
  * Recent credits on one account, oldest or newest first, it makes no difference.
  * This is the whole plugin seam: a bank is a function of this shape, and
- * `fioStatement` is one implementation of it
+ * `fioStatement` is one implementation of it. One that knows how often it can
+ * have anything new says so in `freshEverySecs`, and `bankVerify` then asks the
+ * gateway to poll exactly that often
  */
-type Statement = (sinceUnix: number) => Promise<Credit[]>;
+type Statement = ((sinceUnix: number) => Promise<Credit[]>) & {
+    readonly freshEverySecs?: number;
+};
 /** One transfer to ask for: what is owed, where it lands, and where its arrival is read back from */
 interface BankTransferParams {
     /**
@@ -1018,7 +1022,9 @@ interface BankVerifyConfig {
      * How often you want the gateway to ask, in seconds. It goes out as
      * `Cache-Control: max-age`, so the pace is yours to set rather than the
      * gateway's, and a bank that updates once a minute should say so instead of
-     * being polled every few seconds. Thirty by default, clamped to an hour
+     * being polled every few seconds. By default as often as the statement can have
+     * anything new, which for `fioStatement` is thirty seconds divided by its tokens,
+     * and thirty for a statement that does not say
      */
     pollEverySecs?: number;
 }

package/dist/{bank-Bg6RjuO-.d.cts → bank-DvcV85sa.d.cts}

@@ -108,7 +108,7 @@ interface NwcRailConfig extends RailConfig {
     amount?: (order: Order) => Amount;
     /** Where the default conversion gets its rate, the median of four venues by default */
     rate?: Ticker;
-    /** Where `nwcVerifyEndpoint` is mounted, and the secret the hash is sealed with */
+    /** Where `serve.nwcVerify` is mounted, and the secret the hash is sealed with */
     verifyThrough: {
         endpoint: string;
         secret: string;
@@ -931,9 +931,13 @@ interface Credit {
 /**
  * Recent credits on one account, oldest or newest first, it makes no difference.
  * This is the whole plugin seam: a bank is a function of this shape, and
- * `fioStatement` is one implementation of it
+ * `fioStatement` is one implementation of it. One that knows how often it can
+ * have anything new says so in `freshEverySecs`, and `bankVerify` then asks the
+ * gateway to poll exactly that often
  */
-type Statement = (sinceUnix: number) => Promise<Credit[]>;
+type Statement = ((sinceUnix: number) => Promise<Credit[]>) & {
+    readonly freshEverySecs?: number;
+};
 /** One transfer to ask for: what is owed, where it lands, and where its arrival is read back from */
 interface BankTransferParams {
     /**
@@ -1018,7 +1022,9 @@ interface BankVerifyConfig {
      * How often you want the gateway to ask, in seconds. It goes out as
      * `Cache-Control: max-age`, so the pace is yours to set rather than the
      * gateway's, and a bank that updates once a minute should say so instead of
-     * being polled every few seconds. Thirty by default, clamped to an hour
+     * being polled every few seconds. By default as often as the statement can have
+     * anything new, which for `fioStatement` is thirty seconds divided by its tokens,
+     * and thirty for a statement that does not say
      */
     pollEverySecs?: number;
 }

package/dist/bank.cjs

@@ -250,7 +250,7 @@ function fioStatement(config) {
   const paceMs = tokenWindowMs / usedAt.size;
   let lastRead = Number.NEGATIVE_INFINITY;
   let credits = [];
-  return async (sinceUnix) => {
+  const read = async (sinceUnix) => {
     const now = Date.now();
     if (now - lastRead < paceMs) {
       return credits;
@@ -276,10 +276,17 @@ function fioStatement(config) {
     if (!answer.ok) {
       throw new Error(`fio answered ${answer.status} reading the statement`);
     }
-    const read = await answer.json();
-    credits = (read.accountStatement?.transactionList?.transaction ?? []).filter(isCredit).map(asCredit);
+    const statement = await answer.json();
+    const reads = statement.accountStatement?.info?.iban;
+    if (config.iban !== void 0 && accountOf(reads ?? "") !== accountOf(config.iban)) {
+      throw new Error(
+        `a fio token reads ${reads ?? "an account it does not name"}, not ${config.iban}`
+      );
+    }
+    credits = (statement.accountStatement?.transactionList?.transaction ?? []).filter(isCredit).map(asCredit);
     return credits;
   };
+  return Object.assign(read, { freshEverySecs: Math.ceil(paceMs / MILLIS) });
 }
 function longestUnused(usedAt) {
   let token = "";

package/dist/bank.d.cts

@@ -1,5 +1,5 @@
-import { S as Statement } from './bank-Bg6RjuO-.cjs';
-export { B as BankAgentConfig, a as BankOrder, b as BankTransfer, c as BankTransferParams, d as BankVerifyConfig, C as Credit, e as bankAgent } from './bank-Bg6RjuO-.cjs';
+import { S as Statement } from './bank-DvcV85sa.cjs';
+export { B as BankAgentConfig, a as BankOrder, b as BankTransfer, c as BankTransferParams, d as BankVerifyConfig, C as Credit, e as bankAgent } from './bank-DvcV85sa.cjs';
 import './qr-CF-YeXU1.cjs';
 import './types-DYZ9EkmJ.cjs';
 
@@ -23,6 +23,12 @@ interface FioConfig {
      * stays up
      */
     minIntervalSecs?: number;
+    /**
+     * The account every token has to read. Given, a read by a token that belongs to
+     * another account throws instead of lending that account's credits to this one,
+     * which is the mistake several tokens make easy
+     */
+    iban?: string;
     /** Override to point at a mock */
     baseUrl?: string;
 }

package/dist/bank.d.ts

@@ -1,5 +1,5 @@
-import { S as Statement } from './bank-B5MxT_6u.js';
-export { B as BankAgentConfig, a as BankOrder, b as BankTransfer, c as BankTransferParams, d as BankVerifyConfig, C as Credit, e as bankAgent } from './bank-B5MxT_6u.js';
+import { S as Statement } from './bank-BgA45yOU.js';
+export { B as BankAgentConfig, a as BankOrder, b as BankTransfer, c as BankTransferParams, d as BankVerifyConfig, C as Credit, e as bankAgent } from './bank-BgA45yOU.js';
 import './qr-CF-YeXU1.js';
 import './types-DYZ9EkmJ.js';
 
@@ -23,6 +23,12 @@ interface FioConfig {
      * stays up
      */
     minIntervalSecs?: number;
+    /**
+     * The account every token has to read. Given, a read by a token that belongs to
+     * another account throws instead of lending that account's credits to this one,
+     * which is the mistake several tokens make easy
+     */
+    iban?: string;
     /** Override to point at a mock */
     baseUrl?: string;
 }

package/dist/bank.js

@@ -223,7 +223,7 @@ function fioStatement(config) {
   const paceMs = tokenWindowMs / usedAt.size;
   let lastRead = Number.NEGATIVE_INFINITY;
   let credits = [];
-  return async (sinceUnix) => {
+  const read = async (sinceUnix) => {
     const now = Date.now();
     if (now - lastRead < paceMs) {
       return credits;
@@ -249,10 +249,17 @@ function fioStatement(config) {
     if (!answer.ok) {
       throw new Error(`fio answered ${answer.status} reading the statement`);
     }
-    const read = await answer.json();
-    credits = (read.accountStatement?.transactionList?.transaction ?? []).filter(isCredit).map(asCredit);
+    const statement = await answer.json();
+    const reads = statement.accountStatement?.info?.iban;
+    if (config.iban !== void 0 && accountOf(reads ?? "") !== accountOf(config.iban)) {
+      throw new Error(
+        `a fio token reads ${reads ?? "an account it does not name"}, not ${config.iban}`
+      );
+    }
+    credits = (statement.accountStatement?.transactionList?.transaction ?? []).filter(isCredit).map(asCredit);
     return credits;
   };
+  return Object.assign(read, { freshEverySecs: Math.ceil(paceMs / MILLIS) });
 }
 function longestUnused(usedAt) {
   let token = "";

package/dist/index.cjs

@@ -2049,7 +2049,7 @@ function bankVerifyEndpoint(config) {
     throw new Error(`${config.iban} is not an IBAN, so this endpoint answers for no account`);
   }
   const paced = {
-    "cache-control": `max-age=${config.pollEverySecs ?? DEFAULT_POLL_EVERY_SECS}`
+    "cache-control": `max-age=${config.pollEverySecs ?? config.statement.freshEverySecs ?? DEFAULT_POLL_EVERY_SECS}`
   };
   return async (request) => {
     const consented = await answerVerifyChallenge(request);

package/dist/index.d.cts

@@ -1,6 +1,6 @@
 export { R as Resolved } from './qr-CF-YeXU1.cjs';
-import { T as ThunderBridge, r as ThunderBridgeOptions, W as WaitOptions } from './bank-Bg6RjuO-.cjs';
-export { A as AttendOptions, s as BankRailConfig, d as BankVerifyConfig, t as BlindLightningRailConfig, u as CreateOptions, F as FollowOptions, H as Handler, L as Leg, v as LightningRailConfig, w as LightningVerifyConfig, M as Minted, N as NwcConnection, h as NwcRailConfig, i as NwcVerifyConfig, O as Order, P as PaymentRequest, x as PaymentRequestInit, y as PaymentRequestOptions, z as Provable, D as Proven, R as Rail, E as RailConfig, G as Rails, I as Range, J as Relayed, K as SelfConsistent, Q as Send, U as Serve, V as TicketOptions, X as TriggerConfig, Y as WatchTicketConfig, Z as WebhookCredential, _ as WebhookHandlers, $ as WebhookOptions, a0 as WrapAllowance, a1 as agreesWithItself, a2 as answerVerifyChallenge, a3 as carriesProof, a4 as invoiceFrom, a5 as proveOrigin, a6 as proveSettlement, a7 as proveWrapped, a8 as relayedVerifyUrl, a9 as wrapFeeCeiling } from './bank-Bg6RjuO-.cjs';
+import { T as ThunderBridge, r as ThunderBridgeOptions, W as WaitOptions } from './bank-DvcV85sa.cjs';
+export { A as AttendOptions, s as BankRailConfig, d as BankVerifyConfig, t as BlindLightningRailConfig, u as CreateOptions, F as FollowOptions, H as Handler, L as Leg, v as LightningRailConfig, w as LightningVerifyConfig, M as Minted, N as NwcConnection, h as NwcRailConfig, i as NwcVerifyConfig, O as Order, P as PaymentRequest, x as PaymentRequestInit, y as PaymentRequestOptions, z as Provable, D as Proven, R as Rail, E as RailConfig, G as Rails, I as Range, J as Relayed, K as SelfConsistent, Q as Send, U as Serve, V as TicketOptions, X as TriggerConfig, Y as WatchTicketConfig, Z as WebhookCredential, _ as WebhookHandlers, $ as WebhookOptions, a0 as WrapAllowance, a1 as agreesWithItself, a2 as answerVerifyChallenge, a3 as carriesProof, a4 as invoiceFrom, a5 as proveOrigin, a6 as proveSettlement, a7 as proveWrapped, a8 as relayedVerifyUrl, a9 as wrapFeeCeiling } from './bank-DvcV85sa.cjs';
 import { H as Handover, P as Payment, e as Held } from './types-DYZ9EkmJ.cjs';
 export { A as Amount, C as Charge, F as FiatOptions, f as MintedPayment, g as Msat, h as PaymentStatus, i as Priced, Q as Quote, S as Settlement, j as SocketTicket, W as WalletFailure, l as WalletReason, n as WatchedPayment, o as fiat, p as msat, s as sats } from './types-DYZ9EkmJ.cjs';
 import { G as GatewayCheatError } from './errors-DJmsalYZ.cjs';

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 export { R as Resolved } from './qr-CF-YeXU1.js';
-import { T as ThunderBridge, r as ThunderBridgeOptions, W as WaitOptions } from './bank-B5MxT_6u.js';
-export { A as AttendOptions, s as BankRailConfig, d as BankVerifyConfig, t as BlindLightningRailConfig, u as CreateOptions, F as FollowOptions, H as Handler, L as Leg, v as LightningRailConfig, w as LightningVerifyConfig, M as Minted, N as NwcConnection, h as NwcRailConfig, i as NwcVerifyConfig, O as Order, P as PaymentRequest, x as PaymentRequestInit, y as PaymentRequestOptions, z as Provable, D as Proven, R as Rail, E as RailConfig, G as Rails, I as Range, J as Relayed, K as SelfConsistent, Q as Send, U as Serve, V as TicketOptions, X as TriggerConfig, Y as WatchTicketConfig, Z as WebhookCredential, _ as WebhookHandlers, $ as WebhookOptions, a0 as WrapAllowance, a1 as agreesWithItself, a2 as answerVerifyChallenge, a3 as carriesProof, a4 as invoiceFrom, a5 as proveOrigin, a6 as proveSettlement, a7 as proveWrapped, a8 as relayedVerifyUrl, a9 as wrapFeeCeiling } from './bank-B5MxT_6u.js';
+import { T as ThunderBridge, r as ThunderBridgeOptions, W as WaitOptions } from './bank-BgA45yOU.js';
+export { A as AttendOptions, s as BankRailConfig, d as BankVerifyConfig, t as BlindLightningRailConfig, u as CreateOptions, F as FollowOptions, H as Handler, L as Leg, v as LightningRailConfig, w as LightningVerifyConfig, M as Minted, N as NwcConnection, h as NwcRailConfig, i as NwcVerifyConfig, O as Order, P as PaymentRequest, x as PaymentRequestInit, y as PaymentRequestOptions, z as Provable, D as Proven, R as Rail, E as RailConfig, G as Rails, I as Range, J as Relayed, K as SelfConsistent, Q as Send, U as Serve, V as TicketOptions, X as TriggerConfig, Y as WatchTicketConfig, Z as WebhookCredential, _ as WebhookHandlers, $ as WebhookOptions, a0 as WrapAllowance, a1 as agreesWithItself, a2 as answerVerifyChallenge, a3 as carriesProof, a4 as invoiceFrom, a5 as proveOrigin, a6 as proveSettlement, a7 as proveWrapped, a8 as relayedVerifyUrl, a9 as wrapFeeCeiling } from './bank-BgA45yOU.js';
 import { H as Handover, P as Payment, e as Held } from './types-DYZ9EkmJ.js';
 export { A as Amount, C as Charge, F as FiatOptions, f as MintedPayment, g as Msat, h as PaymentStatus, i as Priced, Q as Quote, S as Settlement, j as SocketTicket, W as WalletFailure, l as WalletReason, n as WatchedPayment, o as fiat, p as msat, s as sats } from './types-DYZ9EkmJ.js';
 import { G as GatewayCheatError } from './errors-VX0R18oE.js';

package/dist/index.js

@@ -1989,7 +1989,7 @@ function bankVerifyEndpoint(config) {
     throw new Error(`${config.iban} is not an IBAN, so this endpoint answers for no account`);
   }
   const paced = {
-    "cache-control": `max-age=${config.pollEverySecs ?? DEFAULT_POLL_EVERY_SECS}`
+    "cache-control": `max-age=${config.pollEverySecs ?? config.statement.freshEverySecs ?? DEFAULT_POLL_EVERY_SECS}`
   };
   return async (request) => {
     const consented = await answerVerifyChallenge(request);

package/dist/nwc.d.cts

@@ -1,5 +1,5 @@
-import { n as nwcRail$1, f as nwcVerifyEndpoint$1 } from './bank-Bg6RjuO-.cjs';
-export { N as NwcConnection, g as NwcInvoice, h as NwcRailConfig, i as NwcVerifyConfig, j as askWallet, k as nwcConnection, l as nwcHoldInvoice, m as nwcInvoice, o as nwcPay, p as nwcSettlement, q as nwcVerifyUrl } from './bank-Bg6RjuO-.cjs';
+import { n as nwcRail$1, f as nwcVerifyEndpoint$1 } from './bank-DvcV85sa.cjs';
+export { N as NwcConnection, g as NwcInvoice, h as NwcRailConfig, i as NwcVerifyConfig, j as askWallet, k as nwcConnection, l as nwcHoldInvoice, m as nwcInvoice, o as nwcPay, p as nwcSettlement, q as nwcVerifyUrl } from './bank-DvcV85sa.cjs';
 import './qr-CF-YeXU1.cjs';
 import './types-DYZ9EkmJ.cjs';
 

package/dist/nwc.d.ts

@@ -1,5 +1,5 @@
-import { n as nwcRail$1, f as nwcVerifyEndpoint$1 } from './bank-B5MxT_6u.js';
-export { N as NwcConnection, g as NwcInvoice, h as NwcRailConfig, i as NwcVerifyConfig, j as askWallet, k as nwcConnection, l as nwcHoldInvoice, m as nwcInvoice, o as nwcPay, p as nwcSettlement, q as nwcVerifyUrl } from './bank-B5MxT_6u.js';
+import { n as nwcRail$1, f as nwcVerifyEndpoint$1 } from './bank-BgA45yOU.js';
+export { N as NwcConnection, g as NwcInvoice, h as NwcRailConfig, i as NwcVerifyConfig, j as askWallet, k as nwcConnection, l as nwcHoldInvoice, m as nwcInvoice, o as nwcPay, p as nwcSettlement, q as nwcVerifyUrl } from './bank-BgA45yOU.js';
 import './qr-CF-YeXU1.js';
 import './types-DYZ9EkmJ.js';
 

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: 2.2.1
   license:
     name: MIT
     identifier: MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "thunder-bridge",
-  "version": "2.2.0",
+  "version": "2.2.1",
   "description": "Trustless JavaScript client for the Thunder Bridge Lightning payment gateway. Proves the invoice came from your own wallet before the payer sees it.",
   "author": "i-am-fatik",
   "homepage": "https://agora.gripe/en/tools/thunder-bridge",