@atomiqlabs/lp-lib 17.0.3 → 17.1.0

package/dist/swaps/escrow/frombtcln_abstract/FromBtcLnAbs.d.ts

@@ -17,6 +17,7 @@ export type FromBtcLnRequestType = {
     paymentHash: string;
     amount: bigint;
     token: string;
+    description?: string;
     descriptionHash?: string;
     exactOut?: boolean;
 };
@@ -50,6 +51,13 @@ export declare class FromBtcLnAbs extends FromBtcBaseSwapHandler<FromBtcLnSwapAb
      * @param invoice
      */
     private htlcReceived;
+    /**
+     * Checks invoice description
+     *
+     * @param description
+     * @throws {DefinedRuntimeError} will throw an error if the description is invalid
+     */
+    private checkDescription;
     /**
      * Checks invoice description hash
      *

package/dist/swaps/escrow/frombtcln_abstract/FromBtcLnAbs.js

@@ -314,6 +314,20 @@ class FromBtcLnAbs extends FromBtcBaseSwapHandler_1.FromBtcBaseSwapHandler {
             return;
         }
     }
+    /**
+     * Checks invoice description
+     *
+     * @param description
+     * @throws {DefinedRuntimeError} will throw an error if the description is invalid
+     */
+    checkDescription(description) {
+        if (description != null && Buffer.byteLength(description, "utf8") > 500) {
+            throw {
+                code: 20100,
+                msg: "Invalid request body (description)"
+            };
+        }
+    }
     /**
      * Checks invoice description hash
      *
@@ -430,22 +444,6 @@ class FromBtcLnAbs extends FromBtcBaseSwapHandler_1.FromBtcBaseSwapHandler {
                 code: 10001,
                 msg: "Invoice expired/canceled"
             };
-        const arr = invoice.description.split("-");
-        if (arr.length < 2)
-            throw {
-                _httpStatus: 200,
-                code: 10001,
-                msg: "Invoice expired/canceled"
-            };
-        const chainIdentifier = arr[0];
-        const address = arr[1];
-        const { chainInterface } = this.getChain(chainIdentifier);
-        if (!chainInterface.isValidAddress(address, true))
-            throw {
-                _httpStatus: 200,
-                code: 10001,
-                msg: "Invoice expired/canceled"
-            };
         switch (invoice.status) {
             case "canceled":
                 throw {
@@ -484,6 +482,7 @@ class FromBtcLnAbs extends FromBtcBaseSwapHandler_1.FromBtcBaseSwapHandler {
              * amount: string               amount (in sats) of the invoice
              * token: string                Desired token to swap
              * exactOut: boolean            Whether the swap should be an exact out instead of exact in swap
+             * description: string          Description of the invoice (max 500 bytes)
              * descriptionHash: string      Description hash of the invoice
              *
              *Sent later:
@@ -501,6 +500,7 @@ class FromBtcLnAbs extends FromBtcBaseSwapHandler_1.FromBtcBaseSwapHandler {
                 token: (val) => val != null &&
                     typeof (val) === "string" &&
                     this.isTokenSupported(chainIdentifier, val) ? val : null,
+                description: SchemaVerifier_1.FieldTypeEnum.StringOptional,
                 descriptionHash: SchemaVerifier_1.FieldTypeEnum.StringOptional,
                 exactOut: SchemaVerifier_1.FieldTypeEnum.BooleanOptional
             });
@@ -520,6 +520,7 @@ class FromBtcLnAbs extends FromBtcBaseSwapHandler_1.FromBtcBaseSwapHandler {
             const useToken = parsedBody.token;
             //Check request params
             this.checkTooManyInflightSwaps();
+            this.checkDescription(parsedBody.description);
             this.checkDescriptionHash(parsedBody.descriptionHash);
             const fees = await this.AmountAssertions.preCheckFromBtcAmounts(this.type, request, requestedAmount);
             metadata.times.requestChecked = Date.now();
@@ -550,7 +551,7 @@ class FromBtcLnAbs extends FromBtcBaseSwapHandler_1.FromBtcBaseSwapHandler {
             metadata.times.balanceChecked = Date.now();
             //Create swap
             const hodlInvoiceObj = {
-                description: chainIdentifier + "-" + parsedBody.address,
+                description: parsedBody.description ?? (chainIdentifier + "-" + parsedBody.address),
                 cltvDelta: Number(this.config.minCltv) + 5,
                 expiresAt: Date.now() + (this.config.invoiceTimeoutSeconds * 1000),
                 id: parsedBody.paymentHash,

package/dist/swaps/escrow/frombtcln_autoinit/FromBtcLnAuto.d.ts

@@ -23,6 +23,7 @@ export type FromBtcLnAutoRequestType = {
     gasToken: string;
     gasAmount: bigint;
     claimerBounty: bigint;
+    description?: string;
     descriptionHash?: string;
     exactOut?: boolean;
 };
@@ -63,6 +64,13 @@ export declare class FromBtcLnAuto extends FromBtcBaseSwapHandler<FromBtcLnAutoS
      */
     private htlcReceived;
     private offerHtlc;
+    /**
+     * Checks invoice description
+     *
+     * @param description
+     * @throws {DefinedRuntimeError} will throw an error if the description is invalid
+     */
+    private checkDescription;
     /**
      * Checks invoice description hash
      *

package/dist/swaps/escrow/frombtcln_autoinit/FromBtcLnAuto.js

@@ -360,6 +360,20 @@ class FromBtcLnAuto extends FromBtcBaseSwapHandler_1.FromBtcBaseSwapHandler {
         }
         return true;
     }
+    /**
+     * Checks invoice description
+     *
+     * @param description
+     * @throws {DefinedRuntimeError} will throw an error if the description is invalid
+     */
+    checkDescription(description) {
+        if (description != null && Buffer.byteLength(description, "utf8") > 500) {
+            throw {
+                code: 20100,
+                msg: "Invalid request body (description)"
+            };
+        }
+    }
     /**
      * Checks invoice description hash
      *
@@ -454,22 +468,6 @@ class FromBtcLnAuto extends FromBtcBaseSwapHandler_1.FromBtcBaseSwapHandler {
                 code: 10001,
                 msg: "Invoice expired/canceled"
             };
-        const arr = invoice.description.split("-");
-        if (arr.length < 2)
-            throw {
-                _httpStatus: 200,
-                code: 10001,
-                msg: "Invoice expired/canceled"
-            };
-        const chainIdentifier = arr[0];
-        const address = arr[1];
-        const { chainInterface } = this.getChain(chainIdentifier);
-        if (!chainInterface.isValidAddress(address, true))
-            throw {
-                _httpStatus: 200,
-                code: 10001,
-                msg: "Invoice expired/canceled"
-            };
         switch (invoice.status) {
             case "canceled":
                 throw {
@@ -511,6 +509,7 @@ class FromBtcLnAuto extends FromBtcBaseSwapHandler_1.FromBtcBaseSwapHandler {
              * amount: string               amount (in sats) of the invoice
              * token: string                Desired token to swap
              * exactOut: boolean            Whether the swap should be an exact out instead of exact in swap
+             * description: string          Description of the invoice (max 500 bytes)
              * descriptionHash: string      Description hash of the invoice
              * gasAmount: string            Desired amount in gas token to also get
              * gasToken: string
@@ -528,6 +527,7 @@ class FromBtcLnAuto extends FromBtcBaseSwapHandler_1.FromBtcBaseSwapHandler {
                 token: (val) => val != null &&
                     typeof (val) === "string" &&
                     this.isTokenSupported(chainIdentifier, val) ? val : null,
+                description: SchemaVerifier_1.FieldTypeEnum.StringOptional,
                 descriptionHash: SchemaVerifier_1.FieldTypeEnum.StringOptional,
                 exactOut: SchemaVerifier_1.FieldTypeEnum.BooleanOptional,
                 gasToken: (val) => val != null &&
@@ -572,6 +572,7 @@ class FromBtcLnAuto extends FromBtcBaseSwapHandler_1.FromBtcBaseSwapHandler {
             const useToken = parsedBody.token;
             const gasToken = parsedBody.gasToken;
             //Check request params
+            this.checkDescription(parsedBody.description);
             this.checkDescriptionHash(parsedBody.descriptionHash);
             this.checkTooManyInflightSwaps();
             const fees = await this.AmountAssertions.preCheckFromBtcAmounts(this.type, request, requestedAmount, gasTokenAmount);
@@ -606,7 +607,7 @@ class FromBtcLnAuto extends FromBtcBaseSwapHandler_1.FromBtcBaseSwapHandler {
             metadata.times.balanceChecked = Date.now();
             //Create swap
             const hodlInvoiceObj = {
-                description: chainIdentifier + "-" + parsedBody.address,
+                description: parsedBody.description ?? (chainIdentifier + "-" + parsedBody.address),
                 cltvDelta: Number(this.config.minCltv) + 5,
                 expiresAt: Date.now() + (this.config.invoiceTimeoutSeconds * 1000),
                 id: parsedBody.paymentHash,

package/dist/swaps/spv_vault_swap/SpvVaults.js

@@ -511,9 +511,9 @@ class SpvVaults {
             const btcTxOutput = btcTx.outs[parseInt(voutStr)];
             const vaultAddress = this.bitcoin.fromOutputScript(Buffer.from(btcTxOutput.scriptPubKey.hex, "hex"));
             const vault = new SpvVault_1.SpvVault(chainId, vaultData, vaultAddress);
-            vault.state = SpvVault_1.SpvVaultState.OPENED;
+            vault.state = vaultData.isOpened() ? SpvVault_1.SpvVaultState.OPENED : SpvVault_1.SpvVaultState.CLOSED;
             recoveredVaults.push(vault);
-            if (await this.bitcoinRpc.isSpent(vaultData.getUtxo())) {
+            if (vaultData.isOpened() && await this.bitcoinRpc.isSpent(vaultData.getUtxo())) {
                 if (!this.bitcoin.isReady())
                     throw new Error("Bitcoin wallet is not ready, but is required to check wallet transactions!");
                 //The latest smart chain UTXO is spent, we need to check if we have some further transactions

package/package.json

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

package/src/swaps/escrow/frombtcln_abstract/FromBtcLnAbs.ts

@@ -40,6 +40,7 @@ export type FromBtcLnRequestType = {
     paymentHash: string,
     amount: bigint,
     token: string,
+    description?: string,
     descriptionHash?: string,
     exactOut?: boolean
 }
@@ -399,6 +400,21 @@ export class FromBtcLnAbs extends FromBtcBaseSwapHandler<FromBtcLnSwapAbs, FromB
         }
     }
 
+    /**
+     * Checks invoice description
+     *
+     * @param description
+     * @throws {DefinedRuntimeError} will throw an error if the description is invalid
+     */
+    private checkDescription(description: string) {
+        if(description!=null && Buffer.byteLength(description, "utf8") > 500) {
+            throw {
+                code: 20100,
+                msg: "Invalid request body (description)"
+            };
+        }
+    }
+
     /**
      * Checks invoice description hash
      *
@@ -535,22 +551,6 @@ export class FromBtcLnAbs extends FromBtcBaseSwapHandler<FromBtcLnSwapAbs, FromB
             msg: "Invoice expired/canceled"
         };
 
-        const arr = invoice.description.split("-");
-        if(arr.length<2) throw {
-            _httpStatus: 200,
-            code: 10001,
-            msg: "Invoice expired/canceled"
-        };
-        const chainIdentifier = arr[0];
-        const address = arr[1];
-
-        const {chainInterface} = this.getChain(chainIdentifier);
-        if(!chainInterface.isValidAddress(address, true)) throw {
-            _httpStatus: 200,
-            code: 10001,
-            msg: "Invoice expired/canceled"
-        };
-
         switch(invoice.status) {
             case "canceled":
                 throw {
@@ -600,6 +600,7 @@ export class FromBtcLnAbs extends FromBtcBaseSwapHandler<FromBtcLnSwapAbs, FromB
              * amount: string               amount (in sats) of the invoice
              * token: string                Desired token to swap
              * exactOut: boolean            Whether the swap should be an exact out instead of exact in swap
+             * description: string          Description of the invoice (max 500 bytes)
              * descriptionHash: string      Description hash of the invoice
              *
              *Sent later:
@@ -617,6 +618,7 @@ export class FromBtcLnAbs extends FromBtcBaseSwapHandler<FromBtcLnSwapAbs, FromB
                 token: (val: string) => val!=null &&
                         typeof(val)==="string" &&
                         this.isTokenSupported(chainIdentifier, val) ? val : null,
+                description: FieldTypeEnum.StringOptional,
                 descriptionHash: FieldTypeEnum.StringOptional,
                 exactOut: FieldTypeEnum.BooleanOptional
             });
@@ -637,6 +639,7 @@ export class FromBtcLnAbs extends FromBtcBaseSwapHandler<FromBtcLnSwapAbs, FromB
 
             //Check request params
             this.checkTooManyInflightSwaps();
+            this.checkDescription(parsedBody.description);
             this.checkDescriptionHash(parsedBody.descriptionHash);
             const fees = await this.AmountAssertions.preCheckFromBtcAmounts(this.type, request, requestedAmount);
             metadata.times.requestChecked = Date.now();
@@ -689,7 +692,7 @@ export class FromBtcLnAbs extends FromBtcBaseSwapHandler<FromBtcLnSwapAbs, FromB
 
             //Create swap
             const hodlInvoiceObj: HodlInvoiceInit = {
-                description: chainIdentifier+"-"+parsedBody.address,
+                description: parsedBody.description ?? (chainIdentifier+"-"+parsedBody.address),
                 cltvDelta:  Number(this.config.minCltv) + 5,
                 expiresAt: Date.now()+(this.config.invoiceTimeoutSeconds*1000),
                 id: parsedBody.paymentHash,

package/src/swaps/escrow/frombtcln_autoinit/FromBtcLnAuto.ts

@@ -35,6 +35,7 @@ export type FromBtcLnAutoRequestType = {
     gasToken: string,
     gasAmount: bigint,
     claimerBounty: bigint,
+    description?: string,
     descriptionHash?: string,
     exactOut?: boolean
 }
@@ -439,6 +440,21 @@ export class FromBtcLnAuto extends FromBtcBaseSwapHandler<FromBtcLnAutoSwap, Fro
         return true;
     }
 
+    /**
+     * Checks invoice description
+     *
+     * @param description
+     * @throws {DefinedRuntimeError} will throw an error if the description is invalid
+     */
+    private checkDescription(description: string) {
+        if(description!=null && Buffer.byteLength(description, "utf8") > 500) {
+            throw {
+                code: 20100,
+                msg: "Invalid request body (description)"
+            };
+        }
+    }
+
     /**
      * Checks invoice description hash
      *
@@ -539,22 +555,6 @@ export class FromBtcLnAuto extends FromBtcBaseSwapHandler<FromBtcLnAutoSwap, Fro
             msg: "Invoice expired/canceled"
         };
 
-        const arr = invoice.description.split("-");
-        if(arr.length<2) throw {
-            _httpStatus: 200,
-            code: 10001,
-            msg: "Invoice expired/canceled"
-        };
-        const chainIdentifier = arr[0];
-        const address = arr[1];
-
-        const {chainInterface} = this.getChain(chainIdentifier);
-        if(!chainInterface.isValidAddress(address, true)) throw {
-            _httpStatus: 200,
-            code: 10001,
-            msg: "Invoice expired/canceled"
-        };
-
         switch(invoice.status) {
             case "canceled":
                 throw {
@@ -605,6 +605,7 @@ export class FromBtcLnAuto extends FromBtcBaseSwapHandler<FromBtcLnAutoSwap, Fro
              * amount: string               amount (in sats) of the invoice
              * token: string                Desired token to swap
              * exactOut: boolean            Whether the swap should be an exact out instead of exact in swap
+             * description: string          Description of the invoice (max 500 bytes)
              * descriptionHash: string      Description hash of the invoice
              * gasAmount: string            Desired amount in gas token to also get
              * gasToken: string
@@ -622,6 +623,7 @@ export class FromBtcLnAuto extends FromBtcBaseSwapHandler<FromBtcLnAutoSwap, Fro
                 token: (val: string) => val!=null &&
                         typeof(val)==="string" &&
                         this.isTokenSupported(chainIdentifier, val) ? val : null,
+                description: FieldTypeEnum.StringOptional,
                 descriptionHash: FieldTypeEnum.StringOptional,
                 exactOut: FieldTypeEnum.BooleanOptional,
                 gasToken: (val: string) => val!=null &&
@@ -666,6 +668,7 @@ export class FromBtcLnAuto extends FromBtcBaseSwapHandler<FromBtcLnAutoSwap, Fro
             const gasToken = parsedBody.gasToken;
 
             //Check request params
+            this.checkDescription(parsedBody.description);
             this.checkDescriptionHash(parsedBody.descriptionHash);
             this.checkTooManyInflightSwaps();
             const fees = await this.AmountAssertions.preCheckFromBtcAmounts(this.type, request, requestedAmount, gasTokenAmount);
@@ -724,7 +727,7 @@ export class FromBtcLnAuto extends FromBtcBaseSwapHandler<FromBtcLnAutoSwap, Fro
 
             //Create swap
             const hodlInvoiceObj: HodlInvoiceInit = {
-                description: chainIdentifier+"-"+parsedBody.address,
+                description: parsedBody.description ?? (chainIdentifier+"-"+parsedBody.address),
                 cltvDelta:  Number(this.config.minCltv) + 5,
                 expiresAt: Date.now()+(this.config.invoiceTimeoutSeconds*1000),
                 id: parsedBody.paymentHash,

package/src/swaps/spv_vault_swap/SpvVaults.ts

@@ -1,6 +1,8 @@
 import {SpvVault, SpvVaultState} from "./SpvVault";
 import {
-    BitcoinRpc, BtcBlock, BtcTx,
+    BitcoinRpc,
+    BtcBlock,
+    BtcTx,
     IStorageManager,
     SpvVaultClaimEvent,
     SpvVaultCloseEvent,
@@ -591,9 +593,9 @@ export class SpvVaults {
             const btcTxOutput = btcTx.outs[parseInt(voutStr)];
             const vaultAddress = this.bitcoin.fromOutputScript(Buffer.from(btcTxOutput.scriptPubKey.hex, "hex"));
             const vault = new SpvVault(chainId, vaultData, vaultAddress);
-            vault.state = SpvVaultState.OPENED;
+            vault.state = vaultData.isOpened() ? SpvVaultState.OPENED : SpvVaultState.CLOSED;
             recoveredVaults.push(vault);
-            if(await this.bitcoinRpc.isSpent(vaultData.getUtxo())) {
+            if(vaultData.isOpened() && await this.bitcoinRpc.isSpent(vaultData.getUtxo())) {
                 if(!this.bitcoin.isReady())
                     throw new Error("Bitcoin wallet is not ready, but is required to check wallet transactions!");