thunder-bridge 1.4.1 → 1.5.0

package/dist/server.d.cts

@@ -1,145 +0,0 @@
-import { T as ThunderBridge } from './rail-CqUfuYXJ.cjs';
-export { o as BlindLightningRailConfig, N as NwcConnection, p as NwcInvoice, q as NwcRailConfig, r as NwcVerifyConfig, s as Resolved, u as askWallet, v as blindLightningRail, w as invoiceFrom, x as nwcConnection, y as nwcHoldInvoice, z as nwcInvoice, A as nwcPay, D as nwcRail, E as nwcSettlement, G as nwcVerifyEndpoint, H as nwcVerifyUrl } from './rail-CqUfuYXJ.cjs';
-
-/** The wallet's own LUD-21 URL and the hash its preimage has to match */
-interface Relayed {
-    url: string;
-    hash: string;
-}
-interface LightningVerifyConfig {
-    /** The secret the sealed wallet URL was made with, and nothing else uses it */
-    secret: string;
-    /**
-     * How often you want the gateway to ask, in seconds. It goes out as
-     * `Cache-Control: max-age`, so the pace is yours rather than the operator's.
-     * Five by default, which is what a Lightning checkout wants
-     */
-    pollEverySecs?: number;
-}
-/**
- * A verify endpoint of your own that asks the recipient's wallet for you, so the
- * gateway polls you and never the wallet.
- *
- * `relayedVerifyUrl` seals the wallet's own LUD-21 URL into the query with your
- * secret, so what the gateway stores and replicates is opaque: not the wallet's
- * host, not which provider the recipient uses, nothing but a blob it cannot read.
- * This handler unseals it, asks the wallet, and answers the same LUD-21 shape.
- *
- * It relays rather than decides. The preimage still comes from the recipient's
- * own server and still has to hash to the payment hash, so standing between the
- * two buys privacy and pacing without becoming something anyone has to trust.
- *
- * A wallet it cannot reach answers `502` rather than "not settled", because those
- * are different claims and only one of them is true. The gateway logs a failed
- * poll and asks again, which is what a broken relay should look like.
- */
-declare function lightningVerifyEndpoint(config: LightningVerifyConfig): (request: Request) => Promise<Response>;
-/**
- * The URL to hand the gateway instead of the wallet's own, with the wallet's
- * sealed inside it. Point it at wherever `lightningVerifyEndpoint` is mounted
- */
-declare function relayedVerifyUrl(endpoint: string, wallet: Relayed, secret: string): Promise<string>;
-
-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;
-    /**
-     * How many settlements of this place the gateway keeps replayable past the hour
-     * it would otherwise forget them in, up to the ceiling its operator set. What a
-     * page that opens later still gets to see. Needs `watchSecret`
-     */
-    replay?: number;
-    /** 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;
-}
-/**
- * A trigger's live stream is opened with a ticket rather than with the watch
- * secret, so something has to hold the secret and trade it for tickets. That is
- * what these two endpoints are, and they are the only place the gateway's token
- * has to be
- */
-interface WatchTicketConfig {
-    /** The gateway that mints the ticket, holding the token this keeps off the wire */
-    gateway: ThunderBridge;
-    /** The trigger to open, the same secret `lnurlPayEndpoint` groups its payments under */
-    watchSecret: string;
-    /**
-     * How many of this trigger's settlements the socket replays on connect, so a
-     * page opened late still shows what it missed, up to the gateway's ceiling
-     */
-    replay?: 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>;
-/**
- * Trades the watch secret for a socket ticket, for a board that is not public.
- * The caller has to know the secret already, so all this adds is that the secret
- * stops travelling in socket URLs, where the gateway, every proxy in front of it
- * and the browser's own history all keep a copy. Anyone without it gets a 403.
- *
- * POST to it before every connect, because a ticket lives one minute.
- */
-declare function watchTicketEndpoint(config: WatchTicketConfig): (request: Request) => Promise<Response>;
-/**
- * Mints a socket ticket for anybody who asks, for a board meant to be read by
- * strangers. It reads no body and refuses nobody, which makes the trigger's
- * whole stream public: every viewer gets each settlement's preimage, verify url
- * and payment hash.
- *
- * Only for a trigger where that is the point. Gate anything on those preimages
- * and a viewer of the board is holding the unlock.
- */
-declare function publicWatchTicketEndpoint(config: WatchTicketConfig): (request: Request) => Promise<Response>;
-
-export { type LightningVerifyConfig, type Minted, type Relayed, type TriggerConfig, type WatchTicketConfig, lightningVerifyEndpoint, lnurlPayEndpoint, publicWatchTicketEndpoint, relayedVerifyUrl, watchTicketEndpoint };

package/dist/server.d.ts

@@ -1,145 +0,0 @@
-import { T as ThunderBridge } from './rail-CqUfuYXJ.js';
-export { o as BlindLightningRailConfig, N as NwcConnection, p as NwcInvoice, q as NwcRailConfig, r as NwcVerifyConfig, s as Resolved, u as askWallet, v as blindLightningRail, w as invoiceFrom, x as nwcConnection, y as nwcHoldInvoice, z as nwcInvoice, A as nwcPay, D as nwcRail, E as nwcSettlement, G as nwcVerifyEndpoint, H as nwcVerifyUrl } from './rail-CqUfuYXJ.js';
-
-/** The wallet's own LUD-21 URL and the hash its preimage has to match */
-interface Relayed {
-    url: string;
-    hash: string;
-}
-interface LightningVerifyConfig {
-    /** The secret the sealed wallet URL was made with, and nothing else uses it */
-    secret: string;
-    /**
-     * How often you want the gateway to ask, in seconds. It goes out as
-     * `Cache-Control: max-age`, so the pace is yours rather than the operator's.
-     * Five by default, which is what a Lightning checkout wants
-     */
-    pollEverySecs?: number;
-}
-/**
- * A verify endpoint of your own that asks the recipient's wallet for you, so the
- * gateway polls you and never the wallet.
- *
- * `relayedVerifyUrl` seals the wallet's own LUD-21 URL into the query with your
- * secret, so what the gateway stores and replicates is opaque: not the wallet's
- * host, not which provider the recipient uses, nothing but a blob it cannot read.
- * This handler unseals it, asks the wallet, and answers the same LUD-21 shape.
- *
- * It relays rather than decides. The preimage still comes from the recipient's
- * own server and still has to hash to the payment hash, so standing between the
- * two buys privacy and pacing without becoming something anyone has to trust.
- *
- * A wallet it cannot reach answers `502` rather than "not settled", because those
- * are different claims and only one of them is true. The gateway logs a failed
- * poll and asks again, which is what a broken relay should look like.
- */
-declare function lightningVerifyEndpoint(config: LightningVerifyConfig): (request: Request) => Promise<Response>;
-/**
- * The URL to hand the gateway instead of the wallet's own, with the wallet's
- * sealed inside it. Point it at wherever `lightningVerifyEndpoint` is mounted
- */
-declare function relayedVerifyUrl(endpoint: string, wallet: Relayed, secret: string): Promise<string>;
-
-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;
-    /**
-     * How many settlements of this place the gateway keeps replayable past the hour
-     * it would otherwise forget them in, up to the ceiling its operator set. What a
-     * page that opens later still gets to see. Needs `watchSecret`
-     */
-    replay?: number;
-    /** 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;
-}
-/**
- * A trigger's live stream is opened with a ticket rather than with the watch
- * secret, so something has to hold the secret and trade it for tickets. That is
- * what these two endpoints are, and they are the only place the gateway's token
- * has to be
- */
-interface WatchTicketConfig {
-    /** The gateway that mints the ticket, holding the token this keeps off the wire */
-    gateway: ThunderBridge;
-    /** The trigger to open, the same secret `lnurlPayEndpoint` groups its payments under */
-    watchSecret: string;
-    /**
-     * How many of this trigger's settlements the socket replays on connect, so a
-     * page opened late still shows what it missed, up to the gateway's ceiling
-     */
-    replay?: 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>;
-/**
- * Trades the watch secret for a socket ticket, for a board that is not public.
- * The caller has to know the secret already, so all this adds is that the secret
- * stops travelling in socket URLs, where the gateway, every proxy in front of it
- * and the browser's own history all keep a copy. Anyone without it gets a 403.
- *
- * POST to it before every connect, because a ticket lives one minute.
- */
-declare function watchTicketEndpoint(config: WatchTicketConfig): (request: Request) => Promise<Response>;
-/**
- * Mints a socket ticket for anybody who asks, for a board meant to be read by
- * strangers. It reads no body and refuses nobody, which makes the trigger's
- * whole stream public: every viewer gets each settlement's preimage, verify url
- * and payment hash.
- *
- * Only for a trigger where that is the point. Gate anything on those preimages
- * and a viewer of the board is holding the unlock.
- */
-declare function publicWatchTicketEndpoint(config: WatchTicketConfig): (request: Request) => Promise<Response>;
-
-export { type LightningVerifyConfig, type Minted, type Relayed, type TriggerConfig, type WatchTicketConfig, lightningVerifyEndpoint, lnurlPayEndpoint, publicWatchTicketEndpoint, relayedVerifyUrl, watchTicketEndpoint };