@atomiqlabs/lp-lib 17.0.4 → 17.1.1

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

@@ -50,6 +50,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:
@@ -510,6 +509,10 @@ class FromBtcLnAbs extends FromBtcBaseSwapHandler_1.FromBtcBaseSwapHandler {
                     msg: "Invalid request body"
                 };
             metadata.request = parsedBody;
+            const descriptionBodyPart = req.paramReader.getExistingParamsOrNull({
+                description: SchemaVerifier_1.FieldTypeEnum.StringOptional
+            });
+            const description = descriptionBodyPart?.description;
             const requestedAmount = { input: !parsedBody.exactOut, amount: parsedBody.amount, token: parsedBody.token };
             const request = {
                 chainIdentifier,
@@ -520,6 +523,7 @@ class FromBtcLnAbs extends FromBtcBaseSwapHandler_1.FromBtcBaseSwapHandler {
             const useToken = parsedBody.token;
             //Check request params
             this.checkTooManyInflightSwaps();
+            this.checkDescription(description);
             this.checkDescriptionHash(parsedBody.descriptionHash);
             const fees = await this.AmountAssertions.preCheckFromBtcAmounts(this.type, request, requestedAmount);
             metadata.times.requestChecked = Date.now();
@@ -550,7 +554,7 @@ class FromBtcLnAbs extends FromBtcBaseSwapHandler_1.FromBtcBaseSwapHandler {
             metadata.times.balanceChecked = Date.now();
             //Create swap
             const hodlInvoiceObj = {
-                description: chainIdentifier + "-" + parsedBody.address,
+                description: 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

@@ -63,6 +63,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
@@ -541,6 +540,10 @@ class FromBtcLnAuto extends FromBtcBaseSwapHandler_1.FromBtcBaseSwapHandler {
                     code: 20100,
                     msg: "Invalid request body"
                 };
+            const descriptionBodyPart = req.paramReader.getExistingParamsOrNull({
+                description: SchemaVerifier_1.FieldTypeEnum.StringOptional
+            });
+            const description = descriptionBodyPart?.description;
             if (parsedBody.gasToken !== chainInterface.getNativeCurrencyAddress())
                 throw {
                     code: 20290,
@@ -572,6 +575,7 @@ class FromBtcLnAuto extends FromBtcBaseSwapHandler_1.FromBtcBaseSwapHandler {
             const useToken = parsedBody.token;
             const gasToken = parsedBody.gasToken;
             //Check request params
+            this.checkDescription(description);
             this.checkDescriptionHash(parsedBody.descriptionHash);
             this.checkTooManyInflightSwaps();
             const fees = await this.AmountAssertions.preCheckFromBtcAmounts(this.type, request, requestedAmount, gasTokenAmount);
@@ -606,7 +610,7 @@ class FromBtcLnAuto extends FromBtcBaseSwapHandler_1.FromBtcBaseSwapHandler {
             metadata.times.balanceChecked = Date.now();
             //Create swap
             const hodlInvoiceObj = {
-                description: chainIdentifier + "-" + parsedBody.address,
+                description: description ?? (chainIdentifier + "-" + parsedBody.address),
                 cltvDelta: Number(this.config.minCltv) + 5,
                 expiresAt: Date.now() + (this.config.invoiceTimeoutSeconds * 1000),
                 id: parsedBody.paymentHash,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atomiqlabs/lp-lib",
-  "version": "17.0.4",
+  "version": "17.1.1",
   "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

@@ -27,7 +27,6 @@ import {
     LightningNetworkInvoice
 } from "../../../wallets/ILightningWallet";
 import {LightningAssertions} from "../../assertions/LightningAssertions";
-import {FromBtcLnAutoSwapState} from "../frombtcln_autoinit/FromBtcLnAutoSwap";
 
 export type FromBtcLnConfig = FromBtcBaseConfig & {
     invoiceTimeoutSeconds?: number,
@@ -399,6 +398,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 +549,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 +598,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:
@@ -626,6 +625,11 @@ export class FromBtcLnAbs extends FromBtcBaseSwapHandler<FromBtcLnSwapAbs, FromB
             };
             metadata.request = parsedBody;
 
+            const descriptionBodyPart = req.paramReader.getExistingParamsOrNull({
+                description: FieldTypeEnum.StringOptional
+            });
+            const description = descriptionBodyPart?.description;
+
             const requestedAmount = {input: !parsedBody.exactOut, amount: parsedBody.amount, token: parsedBody.token};
             const request = {
                 chainIdentifier,
@@ -637,6 +641,7 @@ export class FromBtcLnAbs extends FromBtcBaseSwapHandler<FromBtcLnSwapAbs, FromB
 
             //Check request params
             this.checkTooManyInflightSwaps();
+            this.checkDescription(description);
             this.checkDescriptionHash(parsedBody.descriptionHash);
             const fees = await this.AmountAssertions.preCheckFromBtcAmounts(this.type, request, requestedAmount);
             metadata.times.requestChecked = Date.now();
@@ -689,7 +694,7 @@ export class FromBtcLnAbs extends FromBtcBaseSwapHandler<FromBtcLnSwapAbs, FromB
 
             //Create swap
             const hodlInvoiceObj: HodlInvoiceInit = {
-                description: chainIdentifier+"-"+parsedBody.address,
+                description: 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

@@ -439,6 +439,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 +554,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 +604,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
@@ -635,6 +635,11 @@ export class FromBtcLnAuto extends FromBtcBaseSwapHandler<FromBtcLnAutoSwap, Fro
                 msg: "Invalid request body"
             };
 
+            const descriptionBodyPart = req.paramReader.getExistingParamsOrNull({
+                description: FieldTypeEnum.StringOptional
+            });
+            const description = descriptionBodyPart?.description;
+
             if(parsedBody.gasToken!==chainInterface.getNativeCurrencyAddress()) throw {
                 code: 20290,
                 msg: "Unsupported gas token"
@@ -666,6 +671,7 @@ export class FromBtcLnAuto extends FromBtcBaseSwapHandler<FromBtcLnAutoSwap, Fro
             const gasToken = parsedBody.gasToken;
 
             //Check request params
+            this.checkDescription(description);
             this.checkDescriptionHash(parsedBody.descriptionHash);
             this.checkTooManyInflightSwaps();
             const fees = await this.AmountAssertions.preCheckFromBtcAmounts(this.type, request, requestedAmount, gasTokenAmount);
@@ -724,7 +730,7 @@ export class FromBtcLnAuto extends FromBtcBaseSwapHandler<FromBtcLnAutoSwap, Fro
 
             //Create swap
             const hodlInvoiceObj: HodlInvoiceInit = {
-                description: chainIdentifier+"-"+parsedBody.address,
+                description: description ?? (chainIdentifier+"-"+parsedBody.address),
                 cltvDelta:  Number(this.config.minCltv) + 5,
                 expiresAt: Date.now()+(this.config.invoiceTimeoutSeconds*1000),
                 id: parsedBody.paymentHash,