thunder-bridge 1.5.0 → 2.2.0

package/dist/index.d.cts

@@ -1,16 +1,17 @@
 export { R as Resolved } from './qr-CF-YeXU1.cjs';
-import { T as ThunderBridge, b as ThunderBridgeOptions, W as WaitOptions } from './client-CzGZcByI.cjs';
-export { B as BankRailConfig, c as BlindLightningRailConfig, C as CreateOptions, F as FollowOptions, H as Handler, L as Leg, d as LightningRailConfig, e as LightningVerifyConfig, M as Minted, O as Order, P as PaymentRequest, f as PaymentRequestInit, g as PaymentRequestOptions, h as Provable, i as Proven, a as Rail, R as RailConfig, j as Rails, k as Range, l as Relayed, S as Send, m as Serve, n as TicketOptions, o as TriggerConfig, p as WatchTicketConfig, q as WebhookCredential, r as WebhookHandlers, s as WebhookOptions, t as WrapAllowance, u as answerVerifyChallenge, v as carriesProof, w as invoiceFrom, x as proveOrigin, y as proveSettlement, z as proveWrapped, A as relayedVerifyUrl, D as wrapFeeCeiling } from './client-CzGZcByI.cjs';
-import { H as Handover, P as Payment } from './types-BNPmVnA7.cjs';
-export { A as Amount, C as Charge, F as FiatOptions, e as MintedPayment, f as Msat, g as PaymentStatus, h as Priced, Q as Quote, S as Settlement, i as SocketTicket, W as WalletFailure, j as WalletReason, l as WatchedPayment, n as fiat, o as msat, s as sats } from './types-BNPmVnA7.cjs';
-export { b as BankVerifyConfig } from './bank-B3mHISn1.cjs';
-export { A as AmountError, a as AmountFault, G as GatewayCheatCode, b as GatewayCheatError, I as IdempotencyConflict, c as IdempotencyConflictError, N as NoWalletAvailableError, P as ProblemError, U as UnverifiedRecipientError, W as WrapRefusalCode, d as WrapRefusedError } from './errors-Dmh-Uoh8.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 { 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';
+export { A as AmountError, a as AmountFault, b as GatewayCheatCode, I as IdempotencyConflict, c as IdempotencyConflictError, N as NoWalletAvailableError, P as ProblemError, U as UnverifiedRecipientError, W as WrapRefusalCode, d as WrapRefusedError } from './errors-DJmsalYZ.cjs';
 
 /** What a BOLT11 invoice says about itself, every field null when it does not carry one */
 interface Invoice {
     paymentHash: string | null;
     descriptionHash: string | null;
     amountMsat: number | null;
+    issuedAt: number | null;
     expiresAt: number | null;
 }
 /**
@@ -26,13 +27,13 @@ declare function preimageMatchesHash(preimage: string, paymentHash: string): boo
  * stores the result and hands it back untouched, so anything readable you put
  * in `sealed` is something you told it, which is what blind mode exists to avoid
  */
-declare function seal(secret: string, plaintext: string): Promise<string>;
+declare function seal(secret: string, plaintext: string, paymentHash?: string): Promise<string>;
 /**
  * Read a sealed blob back, null when it was sealed with another secret, edited
  * on the way, or is not one of ours. A secret too short to be a key throws,
  * because that is your bug rather than someone else's input
  */
-declare function unseal(secret: string, sealed: string): Promise<string | null>;
+declare function unseal(secret: string, sealed: string, paymentHash?: string): Promise<string | null>;
 
 /** The client's own options, plus what to do about a gateway that will not take the watch */
 interface GatewaysOptions extends ThunderBridgeOptions {
@@ -43,6 +44,13 @@ interface GatewaysOptions extends ThunderBridgeOptions {
      * than finding out when the one that took it goes away
      */
     onRefused?: (baseUrl: string, refusal: unknown) => void;
+    /**
+     * Called for a gateway caught lying about the payment while you waited on it,
+     * with its url and what gave it away. The wait goes on at the others, because
+     * one gateway that lies is what watching at several is for, so this is how you
+     * learn which one to stop trusting rather than never hearing of it
+     */
+    onCaught?: (baseUrl: string, cheat: GatewayCheatError) => void;
 }
 /**
  * The same payment watched at several gateways at once, which is what makes any
@@ -57,6 +65,7 @@ declare class Gateways {
     readonly each: readonly ThunderBridge[];
     private readonly urls;
     private readonly onRefused;
+    private readonly onCaught;
     constructor(baseUrls: string[], options?: GatewaysOptions);
     /** What this payment is called, which every gateway here will agree on */
     nameFor(paymentHash: string): Promise<string | null>;
@@ -72,7 +81,7 @@ declare class Gateways {
      * saying so. When they all end without a payment, the first ending is the answer,
      * and when they all fail, the first failure is thrown
      */
-    settled(id: string, options?: WaitOptions): Promise<Payment>;
+    settled(held: Held, options?: WaitOptions): Promise<Payment>;
 }
 
-export { Gateways, type GatewaysOptions, Handover, type Invoice, Payment, ThunderBridge, ThunderBridgeOptions, WaitOptions, decodeInvoice, preimageMatchesHash, seal, unseal };
+export { GatewayCheatError, Gateways, type GatewaysOptions, Handover, Held, type Invoice, Payment, ThunderBridge, ThunderBridgeOptions, WaitOptions, decodeInvoice, preimageMatchesHash, seal, unseal };

package/dist/index.d.ts

@@ -1,16 +1,17 @@
 export { R as Resolved } from './qr-CF-YeXU1.js';
-import { T as ThunderBridge, b as ThunderBridgeOptions, W as WaitOptions } from './client-Cc5gtjGV.js';
-export { B as BankRailConfig, c as BlindLightningRailConfig, C as CreateOptions, F as FollowOptions, H as Handler, L as Leg, d as LightningRailConfig, e as LightningVerifyConfig, M as Minted, O as Order, P as PaymentRequest, f as PaymentRequestInit, g as PaymentRequestOptions, h as Provable, i as Proven, a as Rail, R as RailConfig, j as Rails, k as Range, l as Relayed, S as Send, m as Serve, n as TicketOptions, o as TriggerConfig, p as WatchTicketConfig, q as WebhookCredential, r as WebhookHandlers, s as WebhookOptions, t as WrapAllowance, u as answerVerifyChallenge, v as carriesProof, w as invoiceFrom, x as proveOrigin, y as proveSettlement, z as proveWrapped, A as relayedVerifyUrl, D as wrapFeeCeiling } from './client-Cc5gtjGV.js';
-import { H as Handover, P as Payment } from './types-BNPmVnA7.js';
-export { A as Amount, C as Charge, F as FiatOptions, e as MintedPayment, f as Msat, g as PaymentStatus, h as Priced, Q as Quote, S as Settlement, i as SocketTicket, W as WalletFailure, j as WalletReason, l as WatchedPayment, n as fiat, o as msat, s as sats } from './types-BNPmVnA7.js';
-export { b as BankVerifyConfig } from './bank-B3mHISn1.js';
-export { A as AmountError, a as AmountFault, G as GatewayCheatCode, b as GatewayCheatError, I as IdempotencyConflict, c as IdempotencyConflictError, N as NoWalletAvailableError, P as ProblemError, U as UnverifiedRecipientError, W as WrapRefusalCode, d as WrapRefusedError } from './errors-0vbVoISA.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 { 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';
+export { A as AmountError, a as AmountFault, b as GatewayCheatCode, I as IdempotencyConflict, c as IdempotencyConflictError, N as NoWalletAvailableError, P as ProblemError, U as UnverifiedRecipientError, W as WrapRefusalCode, d as WrapRefusedError } from './errors-VX0R18oE.js';
 
 /** What a BOLT11 invoice says about itself, every field null when it does not carry one */
 interface Invoice {
     paymentHash: string | null;
     descriptionHash: string | null;
     amountMsat: number | null;
+    issuedAt: number | null;
     expiresAt: number | null;
 }
 /**
@@ -26,13 +27,13 @@ declare function preimageMatchesHash(preimage: string, paymentHash: string): boo
  * stores the result and hands it back untouched, so anything readable you put
  * in `sealed` is something you told it, which is what blind mode exists to avoid
  */
-declare function seal(secret: string, plaintext: string): Promise<string>;
+declare function seal(secret: string, plaintext: string, paymentHash?: string): Promise<string>;
 /**
  * Read a sealed blob back, null when it was sealed with another secret, edited
  * on the way, or is not one of ours. A secret too short to be a key throws,
  * because that is your bug rather than someone else's input
  */
-declare function unseal(secret: string, sealed: string): Promise<string | null>;
+declare function unseal(secret: string, sealed: string, paymentHash?: string): Promise<string | null>;
 
 /** The client's own options, plus what to do about a gateway that will not take the watch */
 interface GatewaysOptions extends ThunderBridgeOptions {
@@ -43,6 +44,13 @@ interface GatewaysOptions extends ThunderBridgeOptions {
      * than finding out when the one that took it goes away
      */
     onRefused?: (baseUrl: string, refusal: unknown) => void;
+    /**
+     * Called for a gateway caught lying about the payment while you waited on it,
+     * with its url and what gave it away. The wait goes on at the others, because
+     * one gateway that lies is what watching at several is for, so this is how you
+     * learn which one to stop trusting rather than never hearing of it
+     */
+    onCaught?: (baseUrl: string, cheat: GatewayCheatError) => void;
 }
 /**
  * The same payment watched at several gateways at once, which is what makes any
@@ -57,6 +65,7 @@ declare class Gateways {
     readonly each: readonly ThunderBridge[];
     private readonly urls;
     private readonly onRefused;
+    private readonly onCaught;
     constructor(baseUrls: string[], options?: GatewaysOptions);
     /** What this payment is called, which every gateway here will agree on */
     nameFor(paymentHash: string): Promise<string | null>;
@@ -72,7 +81,7 @@ declare class Gateways {
      * saying so. When they all end without a payment, the first ending is the answer,
      * and when they all fail, the first failure is thrown
      */
-    settled(id: string, options?: WaitOptions): Promise<Payment>;
+    settled(held: Held, options?: WaitOptions): Promise<Payment>;
 }
 
-export { Gateways, type GatewaysOptions, Handover, type Invoice, Payment, ThunderBridge, ThunderBridgeOptions, WaitOptions, decodeInvoice, preimageMatchesHash, seal, unseal };
+export { GatewayCheatError, Gateways, type GatewaysOptions, Handover, Held, type Invoice, Payment, ThunderBridge, ThunderBridgeOptions, WaitOptions, decodeInvoice, preimageMatchesHash, seal, unseal };