@atomiqlabs/lp-lib 17.5.2 → 17.6.0

package/dist/swaps/trusted/frombtcln_trusted/FromBtcLnTrustedSwap.d.ts

@@ -1,35 +1,35 @@
-import { SwapHandlerSwap } from "../../SwapHandlerSwap";
-export declare enum FromBtcLnTrustedSwapState {
-    REFUNDED = -2,
-    CANCELED = -1,
-    CREATED = 0,
-    RECEIVED = 1,
-    SENT = 2,
-    CONFIRMED = 3,
-    SETTLED = 4
-}
-export declare class FromBtcLnTrustedSwap extends SwapHandlerSwap<FromBtcLnTrustedSwapState> {
-    readonly pr: string;
-    amount: bigint;
-    readonly output: bigint;
-    readonly dstAddress: string;
-    readonly secret: string;
-    readonly token: string;
-    scRawTx: string;
-    constructor(chainIdentifier: string, pr: string, inputMtokens: bigint, swapFee: bigint, swapFeeInToken: bigint, output: bigint, secret: string, dstAddress: string, token: string);
-    constructor(obj: any);
-    getToken(): string;
-    getOutputAmount(): bigint;
-    getSwapFee(): {
-        inInputToken: bigint;
-        inOutputToken: bigint;
-    };
-    getTotalInputAmount(): bigint;
-    getSequence(): bigint;
-    serialize(): any;
-    isFailed(): boolean;
-    isInitiated(): boolean;
-    isSuccess(): boolean;
-    getIdentifierHash(): string;
-    getDestinationAddress(): string;
-}
+import { SwapHandlerSwap } from "../../SwapHandlerSwap";
+export declare enum FromBtcLnTrustedSwapState {
+    REFUNDED = -2,
+    CANCELED = -1,
+    CREATED = 0,
+    RECEIVED = 1,
+    SENT = 2,
+    CONFIRMED = 3,
+    SETTLED = 4
+}
+export declare class FromBtcLnTrustedSwap extends SwapHandlerSwap<FromBtcLnTrustedSwapState> {
+    readonly pr: string;
+    amount: bigint;
+    readonly output: bigint;
+    readonly dstAddress: string;
+    readonly secret: string;
+    readonly token: string;
+    scRawTx: string;
+    constructor(chainIdentifier: string, pr: string, inputMtokens: bigint, swapFee: bigint, swapFeeInToken: bigint, output: bigint, secret: string, dstAddress: string, token: string);
+    constructor(obj: any);
+    getToken(): string;
+    getOutputAmount(): bigint;
+    getSwapFee(): {
+        inInputToken: bigint;
+        inOutputToken: bigint;
+    };
+    getTotalInputAmount(): bigint;
+    getSequence(): bigint;
+    serialize(): any;
+    isFailed(): boolean;
+    isInitiated(): boolean;
+    isSuccess(): boolean;
+    getIdentifierHash(): string;
+    getDestinationAddress(): string;
+}

package/dist/swaps/trusted/frombtcln_trusted/FromBtcLnTrustedSwap.js

@@ -1,84 +1,84 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FromBtcLnTrustedSwap = exports.FromBtcLnTrustedSwapState = void 0;
-const crypto_1 = require("crypto");
-const Utils_1 = require("../../../utils/Utils");
-const SwapHandlerSwap_1 = require("../../SwapHandlerSwap");
-const SwapHandler_1 = require("../../SwapHandler");
-var FromBtcLnTrustedSwapState;
-(function (FromBtcLnTrustedSwapState) {
-    FromBtcLnTrustedSwapState[FromBtcLnTrustedSwapState["REFUNDED"] = -2] = "REFUNDED";
-    FromBtcLnTrustedSwapState[FromBtcLnTrustedSwapState["CANCELED"] = -1] = "CANCELED";
-    FromBtcLnTrustedSwapState[FromBtcLnTrustedSwapState["CREATED"] = 0] = "CREATED";
-    FromBtcLnTrustedSwapState[FromBtcLnTrustedSwapState["RECEIVED"] = 1] = "RECEIVED";
-    FromBtcLnTrustedSwapState[FromBtcLnTrustedSwapState["SENT"] = 2] = "SENT";
-    FromBtcLnTrustedSwapState[FromBtcLnTrustedSwapState["CONFIRMED"] = 3] = "CONFIRMED";
-    FromBtcLnTrustedSwapState[FromBtcLnTrustedSwapState["SETTLED"] = 4] = "SETTLED";
-})(FromBtcLnTrustedSwapState = exports.FromBtcLnTrustedSwapState || (exports.FromBtcLnTrustedSwapState = {}));
-class FromBtcLnTrustedSwap extends SwapHandlerSwap_1.SwapHandlerSwap {
-    constructor(chainIdOrObj, pr, inputMtokens, swapFee, swapFeeInToken, output, secret, dstAddress, token) {
-        if (typeof (chainIdOrObj) === "string") {
-            super(chainIdOrObj, swapFee, swapFeeInToken);
-            this.state = FromBtcLnTrustedSwapState.CREATED;
-            this.pr = pr;
-            this.amount = (inputMtokens + 999n) / 1000n;
-            this.output = output;
-            this.secret = secret;
-            this.dstAddress = dstAddress;
-            this.token = token;
-        }
-        else {
-            super(chainIdOrObj);
-            this.pr = chainIdOrObj.pr;
-            this.amount = (0, Utils_1.deserializeBN)(chainIdOrObj.amount);
-            this.output = (0, Utils_1.deserializeBN)(chainIdOrObj.output);
-            this.secret = chainIdOrObj.secret;
-            this.dstAddress = chainIdOrObj.dstAddress;
-            this.token = chainIdOrObj.token;
-            this.scRawTx = chainIdOrObj.scRawTx;
-        }
-        this.type = SwapHandler_1.SwapHandlerType.FROM_BTCLN_TRUSTED;
-    }
-    getToken() {
-        return this.token;
-    }
-    getOutputAmount() {
-        return this.output;
-    }
-    getSwapFee() {
-        return { inInputToken: this.swapFee, inOutputToken: this.swapFeeInToken };
-    }
-    getTotalInputAmount() {
-        return this.amount;
-    }
-    getSequence() {
-        return 0n;
-    }
-    serialize() {
-        const partialSerialized = super.serialize();
-        partialSerialized.pr = this.pr;
-        partialSerialized.amount = (0, Utils_1.serializeBN)(this.amount);
-        partialSerialized.output = (0, Utils_1.serializeBN)(this.output);
-        partialSerialized.secret = this.secret;
-        partialSerialized.dstAddress = this.dstAddress;
-        partialSerialized.token = this.token;
-        partialSerialized.scRawTx = this.scRawTx;
-        return partialSerialized;
-    }
-    isFailed() {
-        return this.state === FromBtcLnTrustedSwapState.CANCELED || this.state === FromBtcLnTrustedSwapState.REFUNDED;
-    }
-    isInitiated() {
-        return this.state !== FromBtcLnTrustedSwapState.CREATED;
-    }
-    isSuccess() {
-        return this.state === FromBtcLnTrustedSwapState.SETTLED;
-    }
-    getIdentifierHash() {
-        return (0, crypto_1.createHash)("sha256").update(Buffer.from(this.secret, "hex")).digest().toString("hex");
-    }
-    getDestinationAddress() {
-        return this.dstAddress;
-    }
-}
-exports.FromBtcLnTrustedSwap = FromBtcLnTrustedSwap;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FromBtcLnTrustedSwap = exports.FromBtcLnTrustedSwapState = void 0;
+const crypto_1 = require("crypto");
+const Utils_1 = require("../../../utils/Utils");
+const SwapHandlerSwap_1 = require("../../SwapHandlerSwap");
+const SwapHandler_1 = require("../../SwapHandler");
+var FromBtcLnTrustedSwapState;
+(function (FromBtcLnTrustedSwapState) {
+    FromBtcLnTrustedSwapState[FromBtcLnTrustedSwapState["REFUNDED"] = -2] = "REFUNDED";
+    FromBtcLnTrustedSwapState[FromBtcLnTrustedSwapState["CANCELED"] = -1] = "CANCELED";
+    FromBtcLnTrustedSwapState[FromBtcLnTrustedSwapState["CREATED"] = 0] = "CREATED";
+    FromBtcLnTrustedSwapState[FromBtcLnTrustedSwapState["RECEIVED"] = 1] = "RECEIVED";
+    FromBtcLnTrustedSwapState[FromBtcLnTrustedSwapState["SENT"] = 2] = "SENT";
+    FromBtcLnTrustedSwapState[FromBtcLnTrustedSwapState["CONFIRMED"] = 3] = "CONFIRMED";
+    FromBtcLnTrustedSwapState[FromBtcLnTrustedSwapState["SETTLED"] = 4] = "SETTLED";
+})(FromBtcLnTrustedSwapState = exports.FromBtcLnTrustedSwapState || (exports.FromBtcLnTrustedSwapState = {}));
+class FromBtcLnTrustedSwap extends SwapHandlerSwap_1.SwapHandlerSwap {
+    constructor(chainIdOrObj, pr, inputMtokens, swapFee, swapFeeInToken, output, secret, dstAddress, token) {
+        if (typeof (chainIdOrObj) === "string") {
+            super(chainIdOrObj, swapFee, swapFeeInToken);
+            this.state = FromBtcLnTrustedSwapState.CREATED;
+            this.pr = pr;
+            this.amount = (inputMtokens + 999n) / 1000n;
+            this.output = output;
+            this.secret = secret;
+            this.dstAddress = dstAddress;
+            this.token = token;
+        }
+        else {
+            super(chainIdOrObj);
+            this.pr = chainIdOrObj.pr;
+            this.amount = (0, Utils_1.deserializeBN)(chainIdOrObj.amount);
+            this.output = (0, Utils_1.deserializeBN)(chainIdOrObj.output);
+            this.secret = chainIdOrObj.secret;
+            this.dstAddress = chainIdOrObj.dstAddress;
+            this.token = chainIdOrObj.token;
+            this.scRawTx = chainIdOrObj.scRawTx;
+        }
+        this.type = SwapHandler_1.SwapHandlerType.FROM_BTCLN_TRUSTED;
+    }
+    getToken() {
+        return this.token;
+    }
+    getOutputAmount() {
+        return this.output;
+    }
+    getSwapFee() {
+        return { inInputToken: this.swapFee, inOutputToken: this.swapFeeInToken };
+    }
+    getTotalInputAmount() {
+        return this.amount;
+    }
+    getSequence() {
+        return 0n;
+    }
+    serialize() {
+        const partialSerialized = super.serialize();
+        partialSerialized.pr = this.pr;
+        partialSerialized.amount = (0, Utils_1.serializeBN)(this.amount);
+        partialSerialized.output = (0, Utils_1.serializeBN)(this.output);
+        partialSerialized.secret = this.secret;
+        partialSerialized.dstAddress = this.dstAddress;
+        partialSerialized.token = this.token;
+        partialSerialized.scRawTx = this.scRawTx;
+        return partialSerialized;
+    }
+    isFailed() {
+        return this.state === FromBtcLnTrustedSwapState.CANCELED || this.state === FromBtcLnTrustedSwapState.REFUNDED;
+    }
+    isInitiated() {
+        return this.state !== FromBtcLnTrustedSwapState.CREATED;
+    }
+    isSuccess() {
+        return this.state === FromBtcLnTrustedSwapState.SETTLED;
+    }
+    getIdentifierHash() {
+        return (0, crypto_1.createHash)("sha256").update(Buffer.from(this.secret, "hex")).digest().toString("hex");
+    }
+    getDestinationAddress() {
+        return this.dstAddress;
+    }
+}
+exports.FromBtcLnTrustedSwap = FromBtcLnTrustedSwap;

package/dist/utils/BitcoinUtils.d.ts

@@ -1,4 +1,4 @@
-import { TransactionInput } from "@scure/btc-signer/psbt";
-import { BitcoinRpc, BtcTx } from "@atomiqlabs/base";
-export declare function isLegacyInput(input: TransactionInput): boolean;
-export declare function checkTransactionReplaced(txId: string, txRaw: string, bitcoin: BitcoinRpc<any>): Promise<BtcTx>;
+import { TransactionInput } from "@scure/btc-signer/psbt";
+import { BitcoinRpc, BtcTx } from "@atomiqlabs/base";
+export declare function isLegacyInput(input: TransactionInput): boolean;
+export declare function checkTransactionReplaced(txId: string, txRaw: string, bitcoin: BitcoinRpc<any>): Promise<BtcTx>;

package/dist/utils/BitcoinUtils.js

@@ -1,61 +1,61 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.checkTransactionReplaced = exports.isLegacyInput = void 0;
-const utxo_1 = require("@scure/btc-signer/utxo");
-const btc_signer_1 = require("@scure/btc-signer");
-const Utils_1 = require("./Utils");
-const logger = (0, Utils_1.getLogger)("BitcoinUtils: ");
-function parsePushOpcode(script) {
-    if (script[0] === 0x00) {
-        return Uint8Array.from([]);
-    }
-    if (script[0] <= 0x4b) {
-        return script.slice(1, 1 + script[0]);
-    }
-    if (script[0] === 0x4c) {
-        return script.slice(2, 2 + script[1]);
-    }
-    if (script[0] === 0x4d) {
-        const length = Buffer.from(script.slice(1, 3)).readUInt16LE();
-        return script.slice(3, 3 + length);
-    }
-    if (script[0] === 0x4e) {
-        const length = Buffer.from(script.slice(1, 5)).readUInt32LE();
-        return script.slice(5, 5 + length);
-    }
-    if (script[0] === 0x4f) {
-        return Uint8Array.from([0x81]);
-    }
-    if (script[0] >= 0x51 && script[0] <= 0x60) {
-        return Uint8Array.from([script[0] - 0x50]);
-    }
-    throw new Error("No push opcode detected");
-}
-function isLegacyInput(input) {
-    const prevOut = (0, utxo_1.getPrevOut)(input);
-    const first = btc_signer_1.OutScript.decode(prevOut.script);
-    if (first.type === "tr" || first.type === "wsh" || first.type === "wpkh")
-        return false;
-    if (first.type === "sh") {
-        const redeemScript = input.redeemScript ?? parsePushOpcode(input.finalScriptSig);
-        const second = btc_signer_1.OutScript.decode(redeemScript);
-        if (second.type === "wsh" || second.type === "wpkh")
-            return false;
-    }
-    return true;
-}
-exports.isLegacyInput = isLegacyInput;
-async function checkTransactionReplaced(txId, txRaw, bitcoin) {
-    const existingTx = await bitcoin.getTransaction(txId);
-    if (existingTx != null)
-        return existingTx;
-    //Try to re-broadcast
-    try {
-        await bitcoin.sendRawTransaction(txRaw);
-    }
-    catch (e) {
-        logger.error("checkTransactionReplaced(" + txId + "): Error when trying to re-broadcast raw transaction: ", e);
-    }
-    return await bitcoin.getTransaction(txId);
-}
-exports.checkTransactionReplaced = checkTransactionReplaced;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkTransactionReplaced = exports.isLegacyInput = void 0;
+const utxo_1 = require("@scure/btc-signer/utxo");
+const btc_signer_1 = require("@scure/btc-signer");
+const Utils_1 = require("./Utils");
+const logger = (0, Utils_1.getLogger)("BitcoinUtils: ");
+function parsePushOpcode(script) {
+    if (script[0] === 0x00) {
+        return Uint8Array.from([]);
+    }
+    if (script[0] <= 0x4b) {
+        return script.slice(1, 1 + script[0]);
+    }
+    if (script[0] === 0x4c) {
+        return script.slice(2, 2 + script[1]);
+    }
+    if (script[0] === 0x4d) {
+        const length = Buffer.from(script.slice(1, 3)).readUInt16LE();
+        return script.slice(3, 3 + length);
+    }
+    if (script[0] === 0x4e) {
+        const length = Buffer.from(script.slice(1, 5)).readUInt32LE();
+        return script.slice(5, 5 + length);
+    }
+    if (script[0] === 0x4f) {
+        return Uint8Array.from([0x81]);
+    }
+    if (script[0] >= 0x51 && script[0] <= 0x60) {
+        return Uint8Array.from([script[0] - 0x50]);
+    }
+    throw new Error("No push opcode detected");
+}
+function isLegacyInput(input) {
+    const prevOut = (0, utxo_1.getPrevOut)(input);
+    const first = btc_signer_1.OutScript.decode(prevOut.script);
+    if (first.type === "tr" || first.type === "wsh" || first.type === "wpkh")
+        return false;
+    if (first.type === "sh") {
+        const redeemScript = input.redeemScript ?? parsePushOpcode(input.finalScriptSig);
+        const second = btc_signer_1.OutScript.decode(redeemScript);
+        if (second.type === "wsh" || second.type === "wpkh")
+            return false;
+    }
+    return true;
+}
+exports.isLegacyInput = isLegacyInput;
+async function checkTransactionReplaced(txId, txRaw, bitcoin) {
+    const existingTx = await bitcoin.getTransaction(txId);
+    if (existingTx != null)
+        return existingTx;
+    //Try to re-broadcast
+    try {
+        await bitcoin.sendRawTransaction(txRaw);
+    }
+    catch (e) {
+        logger.error("checkTransactionReplaced(" + txId + "): Error when trying to re-broadcast raw transaction: ", e);
+    }
+    return await bitcoin.getTransaction(txId);
+}
+exports.checkTransactionReplaced = checkTransactionReplaced;

package/dist/utils/Utils.d.ts

@@ -1,32 +1,65 @@
-import { Request, Response } from "express";
-import { ServerParamEncoder } from "./paramcoders/server/ServerParamEncoder";
-import { Transaction } from "@scure/btc-signer";
-import { BtcTx } from "@atomiqlabs/base";
-export type LoggerType = {
-    debug: (msg: string, ...args: any[]) => void;
-    info: (msg: string, ...args: any[]) => void;
-    warn: (msg: string, ...args: any[]) => void;
-    error: (msg: string, ...args: any[]) => void;
-};
-export declare function getLogger(prefix: string | (() => string)): LoggerType;
-export type DefinedRuntimeError = {
-    code: number;
-    msg?: string;
-    _httpStatus?: number;
-    data?: any;
-};
-export declare function isDefinedRuntimeError(obj: any): obj is DefinedRuntimeError;
-export declare function expressHandlerWrapper(func: (req: Request, res: Response) => Promise<void>): ((req: Request, res: Response & {
-    responseStream: ServerParamEncoder;
-}) => void);
-export declare const HEX_REGEX: RegExp;
-export declare function serializeBN(bn: bigint | null): string | null;
-export declare function deserializeBN(str: string | null): bigint | null;
-export declare function bigIntSorter(a: bigint, b: bigint): -1 | 0 | 1;
-/**
- * Creates an abort controller that extends the responseStream's abort signal
- *
- * @param responseStream
- */
-export declare function getAbortController(responseStream: ServerParamEncoder): AbortController;
-export declare function parsePsbt(btcTx: Transaction): BtcTx;
+import { Request, Response } from "express";
+import { ServerParamEncoder } from "./paramcoders/server/ServerParamEncoder";
+import { Transaction } from "@scure/btc-signer";
+import { BtcTx } from "@atomiqlabs/base";
+export type LoggerType = {
+    debug: (msg: string, ...args: any[]) => void;
+    info: (msg: string, ...args: any[]) => void;
+    warn: (msg: string, ...args: any[]) => void;
+    error: (msg: string, ...args: any[]) => void;
+};
+export declare function getLogger(prefix: string | (() => string)): LoggerType;
+export type DefinedRuntimeError = {
+    code: number;
+    msg?: string;
+    _httpStatus?: number;
+    data?: any;
+};
+export declare function isDefinedRuntimeError(obj: any): obj is DefinedRuntimeError;
+export declare function expressHandlerWrapper(func: (req: Request, res: Response) => Promise<void>): ((req: Request, res: Response & {
+    responseStream: ServerParamEncoder;
+}) => void);
+export declare const HEX_REGEX: RegExp;
+export declare function serializeBN(bn: bigint | null): string | null;
+export declare function deserializeBN(str: string | null): bigint | null;
+export declare function bigIntSorter(a: bigint, b: bigint): -1 | 0 | 1;
+/**
+ * Creates an abort controller that extends the responseStream's abort signal
+ *
+ * @param responseStream
+ */
+export declare function getAbortController(responseStream: ServerParamEncoder): AbortController;
+export declare function parsePsbt(btcTx: Transaction): BtcTx;
+/**
+ * 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
+ */
+export declare function getMinSafeBlockWindowFast(safetyFactor: number | bigint, probability?: number): bigint;
+/**
+ * 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
+ */
+export declare function getMinSafeBlockWindowSlow(safetyFactor: bigint | number, probability?: number): bigint;
+export declare function bigIntMax(a: bigint, b: bigint): bigint;