@atomiqlabs/lp-lib 16.0.4 → 16.0.6

package/dist/swaps/escrow/EscrowHandler.js

@@ -74,6 +74,8 @@ class EscrowHandler extends SwapHandler_1.SwapHandler {
         }
     }
     async removeSwapData(swap, ultimateState) {
+        this.inflightSwaps.delete(swap.getIdentifier());
+        this.logger.debug("removeSwapData(): Removing in-flight swap, current in-flight swaps: " + this.inflightSwaps.size);
         if (ultimateState != null)
             await swap.setState(ultimateState);
         if (swap != null)

package/dist/swaps/escrow/tobtc_abstract/ToBtcAbs.js

@@ -586,13 +586,13 @@ class ToBtcAbs extends ToBtcBaseSwapHandler_1.ToBtcBaseSwapHandler {
                 return resp;
             }, abortController.signal);
             metadata.times.priceCalculated = Date.now();
-            const paymentHash = this.getHash(chainIdentifier, parsedBody.address, parsedBody.confirmations, parsedBody.nonce, amountBD).toString("hex");
+            const claimHash = this.getHash(chainIdentifier, parsedBody.address, parsedBody.confirmations, parsedBody.nonce, amountBD).toString("hex");
             //Add grace period another time, so the user has 1 hour to commit
             const expirySeconds = this.getExpiryFromCLTV(parsedBody.confirmationTarget, parsedBody.confirmations) + this.config.gracePeriod;
             const currentTimestamp = BigInt(Math.floor(Date.now() / 1000));
             const minRequiredExpiry = currentTimestamp + expirySeconds;
             const sequence = base_1.BigIntBufferUtils.fromBuffer((0, crypto_1.randomBytes)(8));
-            const payObject = await swapContract.createSwapData(base_1.ChainSwapType.CHAIN_NONCED, parsedBody.offerer, signer.getAddress(), useToken, totalInToken, paymentHash, sequence, minRequiredExpiry, true, false, 0n, 0n);
+            const payObject = await swapContract.createSwapData(base_1.ChainSwapType.CHAIN_NONCED, parsedBody.offerer, signer.getAddress(), useToken, totalInToken, claimHash, sequence, minRequiredExpiry, true, false, 0n, 0n);
             abortController.signal.throwIfAborted();
             metadata.times.swapCreated = Date.now();
             const sigData = await this.getToBtcSignatureData(chainIdentifier, payObject, req, abortController.signal, signDataPrefetchPromise);

package/dist/swaps/escrow/tobtcln_abstract/ToBtcLnAbs.d.ts

@@ -15,6 +15,7 @@ export type ToBtcLnConfig = ToBtcBaseConfig & {
     minLnRoutingFeePPM?: bigint;
     minLnBaseFee?: bigint;
     exactInExpiry?: number;
+    lnSendBitcoinBlockTimeSafetyFactorPPM?: bigint;
 };
 type ExactInAuthorization = {
     chainIdentifier: string;

package/dist/swaps/escrow/tobtcln_abstract/ToBtcLnAbs.js

@@ -31,6 +31,10 @@ class ToBtcLnAbs extends ToBtcBaseSwapHandler_1.ToBtcBaseSwapHandler {
         this.config.minLnRoutingFeePPM = this.config.minLnRoutingFeePPM || 1000n;
         this.config.minLnBaseFee = this.config.minLnBaseFee || 5n;
         this.config.exactInExpiry = this.config.exactInExpiry || 10 * 1000;
+        this.config.lnSendBitcoinBlockTimeSafetyFactorPPM = this.config.lnSendBitcoinBlockTimeSafetyFactorPPM ?? (this.config.safetyFactor * 1000000n);
+        if (this.config.lnSendBitcoinBlockTimeSafetyFactorPPM <= 1100000n) {
+            throw new Error("Lightning network send block safety factor set below 1.1, this is insecure!");
+        }
     }
     /**
      * Cleans up exactIn authorization that are already past their expiry
@@ -226,7 +230,7 @@ class ToBtcLnAbs extends ToBtcBaseSwapHandler_1.ToBtcBaseSwapHandler {
         //Compute max cltv delta
         const maxFee = swap.quotedNetworkFee;
         const maxUsableCLTVdelta = (expiryTimestamp - currentTimestamp - this.config.gracePeriod)
-            / (this.config.bitcoinBlocktime * this.config.safetyFactor);
+            / (this.config.bitcoinBlocktime * this.config.lnSendBitcoinBlockTimeSafetyFactorPPM / 1000000n);
         //Initiate payment
         this.swapLogger.info(swap, "sendLightningPayment(): paying lightning network invoice," +
             " cltvDelta: " + maxUsableCLTVdelta.toString(10) +
@@ -442,10 +446,12 @@ class ToBtcLnAbs extends ToBtcBaseSwapHandler_1.ToBtcBaseSwapHandler {
      * @throws {DefinedRuntimeError} will throw an error if the destination is unreachable
      */
     async checkAndGetNetworkFee(amountBD, maxFee, expiryTimestamp, currentTimestamp, pr, metadata, abortSignal) {
-        const maxUsableCLTV = (expiryTimestamp - currentTimestamp - this.config.gracePeriod) / (this.config.bitcoinBlocktime * this.config.safetyFactor);
+        const maxUsableCLTV = (expiryTimestamp - currentTimestamp - this.config.gracePeriod)
+            / (this.config.bitcoinBlocktime * this.config.lnSendBitcoinBlockTimeSafetyFactorPPM / 1000000n);
         const blockHeight = await this.lightning.getBlockheight();
         abortSignal.throwIfAborted();
         metadata.times.blockheightFetched = Date.now();
+        metadata.probeAndRouteTimeoutDelta = maxUsableCLTV;
         const maxTimeoutBlockheight = BigInt(blockHeight) + maxUsableCLTV;
         const req = {
             request: pr,
@@ -453,6 +459,8 @@ class ToBtcLnAbs extends ToBtcBaseSwapHandler_1.ToBtcBaseSwapHandler {
             maxFeeMtokens: maxFee * 1000n,
             maxTimeoutHeight: Number(maxTimeoutBlockheight)
         };
+        this.logger.debug(`checkAndGetNetworkFee(): Attempting to probe/route the payment amount: ${amountBD.toString(10)}` +
+            `, maxFee: ${maxFee.toString(10)}, expiryDelta: ${maxUsableCLTV.toString(10)}, expiryHeight: ${maxTimeoutBlockheight.toString(10)}, pr: ${pr}`);
         let probeOrRouteResp = await this.lightning.probe(req);
         metadata.times.probeResult = Date.now();
         metadata.probeResponse = { ...probeOrRouteResp };

package/dist/swaps/spv_vault_swap/SpvVaultSwapHandler.d.ts

@@ -64,6 +64,5 @@ export declare class SpvVaultSwapHandler extends SwapHandler<SpvVaultSwap, SpvVa
     startRestServer(restServer: Express): void;
     getInfoData(): any;
     protected saveSwapData(swap: SpvVaultSwap): Promise<void>;
-    protected removeSwapData(hash: string, sequence: bigint): Promise<void>;
     protected removeSwapData(swap: SpvVaultSwap, ultimateState?: SpvVaultSwapState): Promise<void>;
 }

package/dist/swaps/spv_vault_swap/SpvVaultSwapHandler.js

@@ -518,22 +518,10 @@ class SpvVaultSwapHandler extends SwapHandler_1.SwapHandler {
             this.btcTxIdIndex.set(swap.btcTxId, swap);
         return super.saveSwapData(swap);
     }
-    async removeSwapData(hashOrSwap, sequenceOrUltimateState) {
-        let swap;
-        let state;
-        if (typeof (hashOrSwap) === "string") {
-            if (typeof (sequenceOrUltimateState) !== "bigint")
-                throw new Error("Sequence must be a BN instance!");
-            swap = await this.storageManager.getData(hashOrSwap, sequenceOrUltimateState);
-        }
-        else {
-            swap = hashOrSwap;
-            if (sequenceOrUltimateState != null && typeof (sequenceOrUltimateState) !== "bigint")
-                state = sequenceOrUltimateState;
-        }
+    async removeSwapData(swap, ultimateState) {
         if (swap.btcTxId != null)
             this.btcTxIdIndex.delete(swap.btcTxId);
-        return super.removeSwapData(swap, state);
+        return super.removeSwapData(swap, ultimateState);
     }
 }
 exports.SpvVaultSwapHandler = SpvVaultSwapHandler;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atomiqlabs/lp-lib",
-  "version": "16.0.4",
+  "version": "16.0.6",
   "description": "Main functionality implementation for atomiq LP node",
   "main": "./dist/index.js",
   "types:": "./dist/index.d.ts",

package/src/swaps/escrow/EscrowHandler.ts

@@ -89,8 +89,9 @@ export abstract class EscrowHandler<V extends EscrowHandlerSwap<SwapData, S>, S>
         }
     }
 
-    protected removeSwapData(swap: V, ultimateState?: S): Promise<void>;
     protected async removeSwapData(swap: V, ultimateState?: S) {
+        this.inflightSwaps.delete(swap.getIdentifier());
+        this.logger.debug("removeSwapData(): Removing in-flight swap, current in-flight swaps: "+this.inflightSwaps.size);
         if(ultimateState!=null) await swap.setState(ultimateState);
         if(swap!=null) await PluginManager.swapRemove(swap);
         this.swapLogger.debug(swap, "removeSwapData(): removing swap final state: "+swap.state);

package/src/swaps/escrow/tobtc_abstract/ToBtcAbs.ts

@@ -708,7 +708,7 @@ export class ToBtcAbs extends ToBtcBaseSwapHandler<ToBtcSwapAbs, ToBtcSwapState>
             }, abortController.signal);
             metadata.times.priceCalculated = Date.now();
 
-            const paymentHash = this.getHash(chainIdentifier, parsedBody.address, parsedBody.confirmations, parsedBody.nonce, amountBD).toString("hex");
+            const claimHash = this.getHash(chainIdentifier, parsedBody.address, parsedBody.confirmations, parsedBody.nonce, amountBD).toString("hex");
 
             //Add grace period another time, so the user has 1 hour to commit
             const expirySeconds = this.getExpiryFromCLTV(parsedBody.confirmationTarget, parsedBody.confirmations) + this.config.gracePeriod;
@@ -722,7 +722,7 @@ export class ToBtcAbs extends ToBtcBaseSwapHandler<ToBtcSwapAbs, ToBtcSwapState>
                 signer.getAddress(),
                 useToken,
                 totalInToken,
-                paymentHash,
+                claimHash,
                 sequence,
                 minRequiredExpiry,
                 true,

package/src/swaps/escrow/tobtcln_abstract/ToBtcLnAbs.ts

@@ -40,7 +40,9 @@ export type ToBtcLnConfig = ToBtcBaseConfig & {
     minLnRoutingFeePPM?: bigint,
     minLnBaseFee?: bigint,
 
-    exactInExpiry?: number
+    exactInExpiry?: number,
+
+    lnSendBitcoinBlockTimeSafetyFactorPPM?: bigint
 };
 
 type ExactInAuthorization = {
@@ -118,6 +120,10 @@ export class ToBtcLnAbs extends ToBtcBaseSwapHandler<ToBtcLnSwapAbs, ToBtcLnSwap
         this.config.minLnRoutingFeePPM = this.config.minLnRoutingFeePPM || 1000n;
         this.config.minLnBaseFee = this.config.minLnBaseFee || 5n;
         this.config.exactInExpiry = this.config.exactInExpiry || 10*1000;
+        this.config.lnSendBitcoinBlockTimeSafetyFactorPPM = this.config.lnSendBitcoinBlockTimeSafetyFactorPPM ?? (this.config.safetyFactor * 1_000_000n);
+        if(this.config.lnSendBitcoinBlockTimeSafetyFactorPPM <= 1_100_000n) {
+            throw new Error("Lightning network send block safety factor set below 1.1, this is insecure!");
+        }
     }
 
     /**
@@ -328,7 +334,7 @@ export class ToBtcLnAbs extends ToBtcBaseSwapHandler<ToBtcLnSwapAbs, ToBtcLnSwap
         //Compute max cltv delta
         const maxFee = swap.quotedNetworkFee;
         const maxUsableCLTVdelta = (expiryTimestamp - currentTimestamp - this.config.gracePeriod)
-            / (this.config.bitcoinBlocktime * this.config.safetyFactor);
+            / (this.config.bitcoinBlocktime * this.config.lnSendBitcoinBlockTimeSafetyFactorPPM / 1_000_000n);
 
         //Initiate payment
         this.swapLogger.info(swap, "sendLightningPayment(): paying lightning network invoice,"+
@@ -554,11 +560,13 @@ export class ToBtcLnAbs extends ToBtcBaseSwapHandler<ToBtcLnSwapAbs, ToBtcLnSwap
         confidence: number,
         networkFee: bigint
     }> {
-        const maxUsableCLTV: bigint = (expiryTimestamp - currentTimestamp - this.config.gracePeriod) / (this.config.bitcoinBlocktime * this.config.safetyFactor);
+        const maxUsableCLTV: bigint = (expiryTimestamp - currentTimestamp - this.config.gracePeriod)
+            / (this.config.bitcoinBlocktime * this.config.lnSendBitcoinBlockTimeSafetyFactorPPM / 1_000_000n);
 
         const blockHeight = await this.lightning.getBlockheight();
         abortSignal.throwIfAborted();
         metadata.times.blockheightFetched = Date.now();
+        metadata.probeAndRouteTimeoutDelta = maxUsableCLTV;
 
         const maxTimeoutBlockheight = BigInt(blockHeight) + maxUsableCLTV;
 
@@ -569,6 +577,9 @@ export class ToBtcLnAbs extends ToBtcBaseSwapHandler<ToBtcLnSwapAbs, ToBtcLnSwap
             maxTimeoutHeight: Number(maxTimeoutBlockheight)
         };
 
+        this.logger.debug(`checkAndGetNetworkFee(): Attempting to probe/route the payment amount: ${amountBD.toString(10)}`+
+            `, maxFee: ${maxFee.toString(10)}, expiryDelta: ${maxUsableCLTV.toString(10)}, expiryHeight: ${maxTimeoutBlockheight.toString(10)}, pr: ${pr}`);
+
         let probeOrRouteResp: ProbeAndRouteResponse = await this.lightning.probe(req);
         metadata.times.probeResult = Date.now();
         metadata.probeResponse = {...probeOrRouteResp};

package/src/swaps/spv_vault_swap/SpvVaultSwapHandler.ts

@@ -667,20 +667,9 @@ export class SpvVaultSwapHandler extends SwapHandler<SpvVaultSwap, SpvVaultSwapS
         return super.saveSwapData(swap);
     }
 
-    protected removeSwapData(hash: string, sequence: bigint): Promise<void>;
-    protected removeSwapData(swap: SpvVaultSwap, ultimateState?: SpvVaultSwapState): Promise<void>;
-    protected async removeSwapData(hashOrSwap: string | SpvVaultSwap, sequenceOrUltimateState?: bigint | SpvVaultSwapState): Promise<void> {
-        let swap: SpvVaultSwap;
-        let state: SpvVaultSwapState;
-        if(typeof(hashOrSwap)==="string") {
-            if(typeof(sequenceOrUltimateState)!=="bigint") throw new Error("Sequence must be a BN instance!");
-            swap = await this.storageManager.getData(hashOrSwap, sequenceOrUltimateState);
-        } else {
-            swap = hashOrSwap;
-            if(sequenceOrUltimateState!=null && typeof(sequenceOrUltimateState)!=="bigint") state = sequenceOrUltimateState;
-        }
+    protected async removeSwapData(swap: SpvVaultSwap, ultimateState?: SpvVaultSwapState): Promise<void> {
         if(swap.btcTxId!=null) this.btcTxIdIndex.delete(swap.btcTxId);
-        return super.removeSwapData(swap, state);
+        return super.removeSwapData(swap, ultimateState);
     }
 
 }