@atomiqlabs/lp-lib 17.5.2 → 17.6.0

package/dist/utils/Utils.js

@@ -1,130 +1,180 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.parsePsbt = exports.getAbortController = exports.bigIntSorter = exports.deserializeBN = exports.serializeBN = exports.HEX_REGEX = exports.expressHandlerWrapper = exports.isDefinedRuntimeError = exports.getLogger = void 0;
-const crypto_1 = require("crypto");
-const btc_signer_1 = require("@scure/btc-signer");
-function getLogger(prefix) {
-    return {
-        debug: (msg, ...args) => global.atomiqLogLevel >= 3 && console.debug((typeof (prefix) === "function" ? prefix() : prefix) + msg, ...args),
-        info: (msg, ...args) => global.atomiqLogLevel >= 2 && console.info((typeof (prefix) === "function" ? prefix() : prefix) + msg, ...args),
-        warn: (msg, ...args) => (global.atomiqLogLevel == null || global.atomiqLogLevel >= 1) && console.warn((typeof (prefix) === "function" ? prefix() : prefix) + msg, ...args),
-        error: (msg, ...args) => (global.atomiqLogLevel == null || global.atomiqLogLevel >= 0) && console.error((typeof (prefix) === "function" ? prefix() : prefix) + msg, ...args)
-    };
-}
-exports.getLogger = getLogger;
-function isDefinedRuntimeError(obj) {
-    if (obj.code != null && typeof (obj.code) === "number") {
-        if (obj.msg != null && typeof (obj.msg) !== "string")
-            return false;
-        if (obj._httpStatus != null && typeof (obj._httpStatus) !== "number")
-            return false;
-        return true;
-    }
-    return false;
-}
-exports.isDefinedRuntimeError = isDefinedRuntimeError;
-const expressHandlerWrapperLogger = getLogger("ExpressHandlerWrapper: ");
-function expressHandlerWrapper(func) {
-    return (req, res) => {
-        (async () => {
-            try {
-                await func(req, res);
-            }
-            catch (e) {
-                if (!isDefinedRuntimeError(e) || e._httpStatus !== 200)
-                    expressHandlerWrapperLogger.error("Error in called function " + req.path + ": ", e);
-                let statusCode = 500;
-                const obj = {
-                    code: 0,
-                    msg: "Internal server error"
-                };
-                if (isDefinedRuntimeError(e)) {
-                    obj.msg = e.msg;
-                    obj.code = e.code;
-                    obj.data = e.data;
-                    statusCode = 400;
-                    if (e._httpStatus != null)
-                        statusCode = e._httpStatus;
-                }
-                if (res.responseStream != null) {
-                    if (res.responseStream.getAbortSignal().aborted)
-                        return;
-                    res.responseStream.writeParamsAndEnd(obj).catch(e => null);
-                }
-                else {
-                    res.status(statusCode).json(obj);
-                }
-            }
-        })();
-    };
-}
-exports.expressHandlerWrapper = expressHandlerWrapper;
-exports.HEX_REGEX = /[0-9a-fA-F]+/;
-function serializeBN(bn) {
-    return bn == null ? null : bn.toString(10);
-}
-exports.serializeBN = serializeBN;
-function deserializeBN(str) {
-    return str == null ? null : BigInt(str);
-}
-exports.deserializeBN = deserializeBN;
-function bigIntSorter(a, b) {
-    if (a < b)
-        return -1;
-    if (a > b)
-        return 1;
-    return 0;
-}
-exports.bigIntSorter = bigIntSorter;
-/**
- * Creates an abort controller that extends the responseStream's abort signal
- *
- * @param responseStream
- */
-function getAbortController(responseStream) {
-    const abortController = new AbortController();
-    if (responseStream == null || responseStream.getAbortSignal == null)
-        return abortController;
-    const responseStreamAbortController = responseStream.getAbortSignal();
-    responseStreamAbortController.addEventListener("abort", () => abortController.abort(responseStreamAbortController.reason));
-    return abortController;
-}
-exports.getAbortController = getAbortController;
-function parsePsbt(btcTx) {
-    const txWithoutWitness = btcTx.toBytes(true, false);
-    return {
-        locktime: btcTx.lockTime,
-        version: btcTx.version,
-        blockhash: null,
-        confirmations: 0,
-        txid: (0, crypto_1.createHash)("sha256").update((0, crypto_1.createHash)("sha256").update(txWithoutWitness).digest()).digest().reverse().toString("hex"),
-        hex: Buffer.from(txWithoutWitness).toString("hex"),
-        raw: Buffer.from(btcTx.toBytes(true, true)).toString("hex"),
-        vsize: btcTx.isFinal ? btcTx.vsize : null,
-        outs: Array.from({ length: btcTx.outputsLength }, (_, i) => i).map((index) => {
-            const output = btcTx.getOutput(index);
-            return {
-                value: Number(output.amount),
-                n: index,
-                scriptPubKey: {
-                    asm: btc_signer_1.Script.decode(output.script).map(val => typeof (val) === "object" ? Buffer.from(val).toString("hex") : val.toString()).join(" "),
-                    hex: Buffer.from(output.script).toString("hex")
-                }
-            };
-        }),
-        ins: Array.from({ length: btcTx.inputsLength }, (_, i) => i).map(index => {
-            const input = btcTx.getInput(index);
-            return {
-                txid: Buffer.from(input.txid).toString("hex"),
-                vout: input.index,
-                scriptSig: {
-                    asm: btc_signer_1.Script.decode(input.finalScriptSig).map(val => typeof (val) === "object" ? Buffer.from(val).toString("hex") : val.toString()).join(" "),
-                    hex: Buffer.from(input.finalScriptSig).toString("hex")
-                },
-                sequence: input.sequence,
-                txinwitness: input.finalScriptWitness == null ? [] : input.finalScriptWitness.map(witness => Buffer.from(witness).toString("hex"))
-            };
-        })
-    };
-}
-exports.parsePsbt = parsePsbt;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.bigIntMax = exports.getMinSafeBlockWindowSlow = exports.getMinSafeBlockWindowFast = exports.parsePsbt = exports.getAbortController = exports.bigIntSorter = exports.deserializeBN = exports.serializeBN = exports.HEX_REGEX = exports.expressHandlerWrapper = exports.isDefinedRuntimeError = exports.getLogger = void 0;
+const crypto_1 = require("crypto");
+const btc_signer_1 = require("@scure/btc-signer");
+function getLogger(prefix) {
+    return {
+        debug: (msg, ...args) => global.atomiqLogLevel >= 3 && console.debug((typeof (prefix) === "function" ? prefix() : prefix) + msg, ...args),
+        info: (msg, ...args) => global.atomiqLogLevel >= 2 && console.info((typeof (prefix) === "function" ? prefix() : prefix) + msg, ...args),
+        warn: (msg, ...args) => (global.atomiqLogLevel == null || global.atomiqLogLevel >= 1) && console.warn((typeof (prefix) === "function" ? prefix() : prefix) + msg, ...args),
+        error: (msg, ...args) => (global.atomiqLogLevel == null || global.atomiqLogLevel >= 0) && console.error((typeof (prefix) === "function" ? prefix() : prefix) + msg, ...args)
+    };
+}
+exports.getLogger = getLogger;
+function isDefinedRuntimeError(obj) {
+    if (obj.code != null && typeof (obj.code) === "number") {
+        if (obj.msg != null && typeof (obj.msg) !== "string")
+            return false;
+        if (obj._httpStatus != null && typeof (obj._httpStatus) !== "number")
+            return false;
+        return true;
+    }
+    return false;
+}
+exports.isDefinedRuntimeError = isDefinedRuntimeError;
+const expressHandlerWrapperLogger = getLogger("ExpressHandlerWrapper: ");
+function expressHandlerWrapper(func) {
+    return (req, res) => {
+        (async () => {
+            try {
+                await func(req, res);
+            }
+            catch (e) {
+                if (!isDefinedRuntimeError(e) || e._httpStatus !== 200)
+                    expressHandlerWrapperLogger.error("Error in called function " + req.path + ": ", e);
+                let statusCode = 500;
+                const obj = {
+                    code: 0,
+                    msg: "Internal server error"
+                };
+                if (isDefinedRuntimeError(e)) {
+                    obj.msg = e.msg;
+                    obj.code = e.code;
+                    obj.data = e.data;
+                    statusCode = 400;
+                    if (e._httpStatus != null)
+                        statusCode = e._httpStatus;
+                }
+                if (res.responseStream != null) {
+                    if (res.responseStream.getAbortSignal().aborted)
+                        return;
+                    res.responseStream.writeParamsAndEnd(obj).catch(e => null);
+                }
+                else {
+                    res.status(statusCode).json(obj);
+                }
+            }
+        })();
+    };
+}
+exports.expressHandlerWrapper = expressHandlerWrapper;
+exports.HEX_REGEX = /[0-9a-fA-F]+/;
+function serializeBN(bn) {
+    return bn == null ? null : bn.toString(10);
+}
+exports.serializeBN = serializeBN;
+function deserializeBN(str) {
+    return str == null ? null : BigInt(str);
+}
+exports.deserializeBN = deserializeBN;
+function bigIntSorter(a, b) {
+    if (a < b)
+        return -1;
+    if (a > b)
+        return 1;
+    return 0;
+}
+exports.bigIntSorter = bigIntSorter;
+/**
+ * Creates an abort controller that extends the responseStream's abort signal
+ *
+ * @param responseStream
+ */
+function getAbortController(responseStream) {
+    const abortController = new AbortController();
+    if (responseStream == null || responseStream.getAbortSignal == null)
+        return abortController;
+    const responseStreamAbortController = responseStream.getAbortSignal();
+    responseStreamAbortController.addEventListener("abort", () => abortController.abort(responseStreamAbortController.reason));
+    return abortController;
+}
+exports.getAbortController = getAbortController;
+function parsePsbt(btcTx) {
+    const txWithoutWitness = btcTx.toBytes(true, false);
+    return {
+        locktime: btcTx.lockTime,
+        version: btcTx.version,
+        blockhash: null,
+        confirmations: 0,
+        txid: (0, crypto_1.createHash)("sha256").update((0, crypto_1.createHash)("sha256").update(txWithoutWitness).digest()).digest().reverse().toString("hex"),
+        hex: Buffer.from(txWithoutWitness).toString("hex"),
+        raw: Buffer.from(btcTx.toBytes(true, true)).toString("hex"),
+        vsize: btcTx.isFinal ? btcTx.vsize : null,
+        outs: Array.from({ length: btcTx.outputsLength }, (_, i) => i).map((index) => {
+            const output = btcTx.getOutput(index);
+            return {
+                value: Number(output.amount),
+                n: index,
+                scriptPubKey: {
+                    asm: btc_signer_1.Script.decode(output.script).map(val => typeof (val) === "object" ? Buffer.from(val).toString("hex") : val.toString()).join(" "),
+                    hex: Buffer.from(output.script).toString("hex")
+                }
+            };
+        }),
+        ins: Array.from({ length: btcTx.inputsLength }, (_, i) => i).map(index => {
+            const input = btcTx.getInput(index);
+            return {
+                txid: Buffer.from(input.txid).toString("hex"),
+                vout: input.index,
+                scriptSig: {
+                    asm: btc_signer_1.Script.decode(input.finalScriptSig).map(val => typeof (val) === "object" ? Buffer.from(val).toString("hex") : val.toString()).join(" "),
+                    hex: Buffer.from(input.finalScriptSig).toString("hex")
+                },
+                sequence: input.sequence,
+                txinwitness: input.finalScriptWitness == null ? [] : input.finalScriptWitness.map(witness => Buffer.from(witness).toString("hex"))
+            };
+        })
+    };
+}
+exports.parsePsbt = parsePsbt;
+/**
+ * Returns the minimum Bitcoin block window (in blocks) for which a "fast blocks" safety
+ * factor is genuinely usable: the probability that N consecutive blocks are produced
+ * with an average interval below (blocktime / safetyFactor) is less than `probability`.
+ *
+ * Model: block arrivals are a Poisson process (i.i.d. exponential intervals), so the
+ * production time of N blocks is Erlang/Gamma(shape=N). A Chernoff (Cramer) bound on
+ * the lower tail gives the per-block large-deviation rate I(S) = ln(S) + 1/S - 1, i.e.
+ *     P(N blocks faster than blocktime/S on average) <= exp(-N * I(S))
+ * which this function inverts for N. Conservative: the exact Erlang CDF already
+ * satisfies the bound ~25% earlier. Use for the fast-block tail (e.g. incoming LN
+ * HTLC expiry racing an escrow claim window).
+ *
+ * @param {number|bigint} safetyFactor Assumed max block-speed multiplier (must be > 1)
+ * @param {number} [probability=0.0001] Tolerated failure probability (default 0.01%)
+ * @returns {number} Minimum safe block window in blocks
+ */
+function getMinSafeBlockWindowFast(safetyFactor, probability = 0.0001) {
+    const S = Number(safetyFactor);
+    const rate = Math.log(S) + 1 / S - 1;
+    if (!(rate > 0))
+        throw new RangeError("safetyFactor must be > 1");
+    return BigInt(Math.ceil(Math.log(1 / probability) / rate));
+}
+exports.getMinSafeBlockWindowFast = getMinSafeBlockWindowFast;
+/**
+ * Slow-tail mirror of getMinSafeBlockWindowFast(): returns the minimum block window
+ * (in blocks) for which a "slow blocks" safety factor is genuinely usable: the
+ * probability that N consecutive blocks take LONGER than N * blocktime * safetyFactor
+ * is less than `probability`. Chernoff bound on the upper Erlang tail gives the rate
+ * I(S) = S - 1 - ln(S). Use when converting a wall-clock deadline into a block count
+ * (e.g. payout/claim timeouts that must expire before some real-world time even if
+ * blocks come slowly).
+ *
+ * @param {number|bigint} safetyFactor Assumed max block-slowness multiplier (must be > 1)
+ * @param {number} [probability=0.0001] Tolerated failure probability (default 0.01%)
+ * @returns {number} Minimum safe block window in blocks
+ */
+function getMinSafeBlockWindowSlow(safetyFactor, probability = 0.0001) {
+    const S = Number(safetyFactor);
+    const rate = S - 1 - Math.log(S);
+    if (!(rate > 0))
+        throw new RangeError("safetyFactor must be > 1");
+    return BigInt(Math.ceil(Math.log(1 / probability) / rate));
+}
+exports.getMinSafeBlockWindowSlow = getMinSafeBlockWindowSlow;
+function bigIntMax(a, b) {
+    return a > b ? a : b;
+}
+exports.bigIntMax = bigIntMax;

package/dist/utils/paramcoders/IParamReader.d.ts

@@ -1,5 +1,5 @@
-import { RequestSchema, RequestSchemaResult } from "./SchemaVerifier";
-export interface IParamReader {
-    getParams<T extends RequestSchema>(schema: T): Promise<RequestSchemaResult<T>>;
-    getExistingParamsOrNull<T extends RequestSchema>(schema: T): RequestSchemaResult<T>;
-}
+import { RequestSchema, RequestSchemaResult } from "./SchemaVerifier";
+export interface IParamReader {
+    getParams<T extends RequestSchema>(schema: T): Promise<RequestSchemaResult<T>>;
+    getExistingParamsOrNull<T extends RequestSchema>(schema: T): RequestSchemaResult<T>;
+}

package/dist/utils/paramcoders/IParamReader.js

@@ -1,2 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/utils/paramcoders/IParamWriter.d.ts

@@ -1,4 +1,4 @@
-export interface IParamWriter {
-    end(): Promise<void>;
-    writeParams(data: any): Promise<void>;
-}
+export interface IParamWriter {
+    end(): Promise<void>;
+    writeParams(data: any): Promise<void>;
+}

package/dist/utils/paramcoders/IParamWriter.js

@@ -1,2 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/utils/paramcoders/LegacyParamEncoder.d.ts

@@ -1,10 +1,10 @@
-/// <reference types="node" />
-import { IParamWriter } from "./IParamWriter";
-export declare class LegacyParamEncoder implements IParamWriter {
-    private readonly writeFN;
-    private readonly endFN;
-    private obj;
-    constructor(write: (data: Buffer) => Promise<void>, end: () => Promise<void>);
-    writeParams(data: any): Promise<void>;
-    end(): Promise<void>;
-}
+/// <reference types="node" />
+import { IParamWriter } from "./IParamWriter";
+export declare class LegacyParamEncoder implements IParamWriter {
+    private readonly writeFN;
+    private readonly endFN;
+    private obj;
+    constructor(write: (data: Buffer) => Promise<void>, end: () => Promise<void>);
+    writeParams(data: any): Promise<void>;
+    end(): Promise<void>;
+}

package/dist/utils/paramcoders/LegacyParamEncoder.js

@@ -1,22 +1,22 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.LegacyParamEncoder = void 0;
-class LegacyParamEncoder {
-    constructor(write, end) {
-        this.obj = {};
-        this.writeFN = write;
-        this.endFN = end;
-    }
-    writeParams(data) {
-        for (let key in data) {
-            if (this.obj[key] == null)
-                this.obj[key] = data[key];
-        }
-        return Promise.resolve();
-    }
-    async end() {
-        await this.writeFN(Buffer.from(JSON.stringify(this.obj)));
-        await this.endFN();
-    }
-}
-exports.LegacyParamEncoder = LegacyParamEncoder;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LegacyParamEncoder = void 0;
+class LegacyParamEncoder {
+    constructor(write, end) {
+        this.obj = {};
+        this.writeFN = write;
+        this.endFN = end;
+    }
+    writeParams(data) {
+        for (let key in data) {
+            if (this.obj[key] == null)
+                this.obj[key] = data[key];
+        }
+        return Promise.resolve();
+    }
+    async end() {
+        await this.writeFN(Buffer.from(JSON.stringify(this.obj)));
+        await this.endFN();
+    }
+}
+exports.LegacyParamEncoder = LegacyParamEncoder;

package/dist/utils/paramcoders/ParamDecoder.d.ts

@@ -1,25 +1,25 @@
-/// <reference types="node" />
-import { RequestSchema, RequestSchemaResult } from "./SchemaVerifier";
-import { IParamReader } from "./IParamReader";
-export declare class ParamDecoder implements IParamReader {
-    frameHeader: Buffer;
-    frameData: Buffer[];
-    frameDataLength: number;
-    closed: boolean;
-    params: {
-        [key: string]: {
-            promise: Promise<any>;
-            resolve: (data: any) => void;
-            reject: (err: any) => void;
-            value: any;
-        };
-    };
-    constructor();
-    private onFrameRead;
-    onData(data: Buffer): void;
-    onEnd(): void;
-    onError(e: any): void;
-    getParam(key: string): Promise<any>;
-    getParams<T extends RequestSchema>(schema: T): Promise<RequestSchemaResult<T>>;
-    getExistingParamsOrNull<T extends RequestSchema>(schema: T): RequestSchemaResult<T>;
-}
+/// <reference types="node" />
+import { RequestSchema, RequestSchemaResult } from "./SchemaVerifier";
+import { IParamReader } from "./IParamReader";
+export declare class ParamDecoder implements IParamReader {
+    frameHeader: Buffer;
+    frameData: Buffer[];
+    frameDataLength: number;
+    closed: boolean;
+    params: {
+        [key: string]: {
+            promise: Promise<any>;
+            resolve: (data: any) => void;
+            reject: (err: any) => void;
+            value: any;
+        };
+    };
+    constructor();
+    private onFrameRead;
+    onData(data: Buffer): void;
+    onEnd(): void;
+    onError(e: any): void;
+    getParam(key: string): Promise<any>;
+    getParams<T extends RequestSchema>(schema: T): Promise<RequestSchemaResult<T>>;
+    getExistingParamsOrNull<T extends RequestSchema>(schema: T): RequestSchemaResult<T>;
+}