thunder-bridge 0.8.2 → 0.8.3

package/dist/server.d.cts

@@ -0,0 +1,64 @@
+import { T as ThunderBridge } from './rail-Cyc5zTtA.cjs';
+export { k as BlindLightningRailConfig, m as blindLightningRail } from './rail-Cyc5zTtA.cjs';
+
+interface TriggerConfig {
+    /** The gateway that quotes the addresses and mints the invoice */
+    gateway: ThunderBridge;
+    /** Priority list, quoted at payRequest and then pinned for the callback */
+    lnAddresses: string[];
+    /**
+     * What this trigger costs right now, called once per payRequest. A plain
+     * function, so a fiat peg or a time of day rule is just code you write
+     */
+    amountMsat: () => number | Promise<number>;
+    /**
+     * Signs the callback URL. Without it anyone could call the callback and make
+     * this endpoint mint invoices on wallets of their choosing
+     */
+    secret: string;
+    /** Groups every payment here so `followTrigger` can watch the place, keep it off the QR */
+    watchSecret?: string;
+    /** Override when a proxy hides the public URL from the request, no trailing slash */
+    baseUrl?: string;
+    /**
+     * Resolve the address here and hand the gateway only a hash and a URL to poll,
+     * instead of asking it to mint. It then cannot tell who is being paid beyond
+     * the domain in the verify URL, nor how much at all, so the only refusal left
+     * to it is refusing everyone. Costs one more round trip and gives up the
+     * gateway's CORS proxying, which a server does not need anyway
+     */
+    blind?: boolean;
+    /**
+     * What the watcher needs and the gateway must not have. `data` returns it and
+     * `secret` encrypts it, so there is no way to hand the gateway something it
+     * can read. Needs 32 characters of randomness, not a passphrase, and every
+     * watcher of this trigger holds the same one
+     */
+    sealed?: {
+        secret: string;
+        data: (minted: Minted) => unknown;
+    };
+}
+interface Minted {
+    lnAddress: string;
+    amountMsat: number;
+    bolt11: string;
+    paymentHash: string;
+    verifyUrl: string;
+    expiresAt: number;
+}
+/**
+ * An LNURL-pay endpoint standing in front of a priority list of addresses, as a
+ * Fetch handler so it runs on Deno Deploy, Workers, Hono, Next and Node alike.
+ *
+ * It answers both halves of the flow on one path. A bare request is the
+ * payRequest and quotes the list, and a signed one is the callback and mints.
+ * The winner is chosen at payRequest and pinned into the callback URL because
+ * LUD-06 binds the invoice to the metadata already served: if the callback
+ * picked a different address the payer's wallet would refuse the invoice.
+ *
+ * Nothing is stored between the two, so this holds no state of its own.
+ */
+declare function lnurlPayEndpoint(config: TriggerConfig): (request: Request) => Promise<Response>;
+
+export { type Minted, type TriggerConfig, lnurlPayEndpoint };

package/dist/server.d.ts

@@ -0,0 +1,64 @@
+import { T as ThunderBridge } from './rail-Cyc5zTtA.js';
+export { k as BlindLightningRailConfig, m as blindLightningRail } from './rail-Cyc5zTtA.js';
+
+interface TriggerConfig {
+    /** The gateway that quotes the addresses and mints the invoice */
+    gateway: ThunderBridge;
+    /** Priority list, quoted at payRequest and then pinned for the callback */
+    lnAddresses: string[];
+    /**
+     * What this trigger costs right now, called once per payRequest. A plain
+     * function, so a fiat peg or a time of day rule is just code you write
+     */
+    amountMsat: () => number | Promise<number>;
+    /**
+     * Signs the callback URL. Without it anyone could call the callback and make
+     * this endpoint mint invoices on wallets of their choosing
+     */
+    secret: string;
+    /** Groups every payment here so `followTrigger` can watch the place, keep it off the QR */
+    watchSecret?: string;
+    /** Override when a proxy hides the public URL from the request, no trailing slash */
+    baseUrl?: string;
+    /**
+     * Resolve the address here and hand the gateway only a hash and a URL to poll,
+     * instead of asking it to mint. It then cannot tell who is being paid beyond
+     * the domain in the verify URL, nor how much at all, so the only refusal left
+     * to it is refusing everyone. Costs one more round trip and gives up the
+     * gateway's CORS proxying, which a server does not need anyway
+     */
+    blind?: boolean;
+    /**
+     * What the watcher needs and the gateway must not have. `data` returns it and
+     * `secret` encrypts it, so there is no way to hand the gateway something it
+     * can read. Needs 32 characters of randomness, not a passphrase, and every
+     * watcher of this trigger holds the same one
+     */
+    sealed?: {
+        secret: string;
+        data: (minted: Minted) => unknown;
+    };
+}
+interface Minted {
+    lnAddress: string;
+    amountMsat: number;
+    bolt11: string;
+    paymentHash: string;
+    verifyUrl: string;
+    expiresAt: number;
+}
+/**
+ * An LNURL-pay endpoint standing in front of a priority list of addresses, as a
+ * Fetch handler so it runs on Deno Deploy, Workers, Hono, Next and Node alike.
+ *
+ * It answers both halves of the flow on one path. A bare request is the
+ * payRequest and quotes the list, and a signed one is the callback and mints.
+ * The winner is chosen at payRequest and pinned into the callback URL because
+ * LUD-06 binds the invoice to the metadata already served: if the callback
+ * picked a different address the payer's wallet would refuse the invoice.
+ *
+ * Nothing is stored between the two, so this holds no state of its own.
+ */
+declare function lnurlPayEndpoint(config: TriggerConfig): (request: Request) => Promise<Response>;
+
+export { type Minted, type TriggerConfig, lnurlPayEndpoint };