@atomiqlabs/lp-lib 12.0.2 → 12.1.0

package/dist/plugins/IPlugin.d.ts

@@ -14,6 +14,8 @@ export type QuoteSetFees = {
     type: "fees";
     baseFee?: bigint;
     feePPM?: bigint;
+    securityDepositApyPPM?: bigint;
+    securityDepositBaseMultiplierPPM?: bigint;
 };
 export declare function isQuoteSetFees(obj: any): obj is QuoteSetFees;
 export type QuoteAmountTooLow = {

package/dist/plugins/IPlugin.js

@@ -8,7 +8,9 @@ exports.isQuoteThrow = isQuoteThrow;
 function isQuoteSetFees(obj) {
     return obj.type === "fees" &&
         (obj.baseFee == null || typeof (obj.baseFee) === "bigint") &&
-        (obj.feePPM == null || typeof (obj.feePPM) === "bigint");
+        (obj.feePPM == null || typeof (obj.feePPM) === "bigint") &&
+        (obj.securityDepositApyPPM == null || typeof (obj.securityDepositApyPPM) === "bigint") &&
+        (obj.securityDepositBaseMultiplierPPM == null || typeof (obj.securityDepositBaseMultiplierPPM) === "bigint");
 }
 exports.isQuoteSetFees = isQuoteSetFees;
 function isQuoteAmountTooLow(obj) {

package/dist/swaps/FromBtcBaseSwapHandler.d.ts

@@ -74,6 +74,8 @@ export declare abstract class FromBtcBaseSwapHandler<V extends SwapHandlerSwap<S
     }, useToken: string): Promise<{
         baseFee: bigint;
         feePPM: bigint;
+        securityDepositApyPPM?: bigint;
+        securityDepositBaseMultiplierPPM?: bigint;
     }>;
     /**
      * Checks minimums/maximums, calculates the fee & total amount
@@ -97,6 +99,8 @@ export declare abstract class FromBtcBaseSwapHandler<V extends SwapHandlerSwap<S
         swapFee: bigint;
         swapFeeInToken: bigint;
         totalInToken: bigint;
+        securityDepositApyPPM?: bigint;
+        securityDepositBaseMultiplierPPM?: bigint;
     }>;
     /**
      * Signs the created swap
@@ -125,8 +129,12 @@ export declare abstract class FromBtcBaseSwapHandler<V extends SwapHandlerSwap<S
      * @param baseSecurityDepositPromise
      * @param depositToken
      * @param depositTokenPricePrefetchPromise
+     * @param securityDepositData
      * @param signal
      * @param metadata
      */
-    protected getSecurityDeposit(chainIdentifier: string, amountBD: bigint, swapFee: bigint, expiryTimeout: bigint, baseSecurityDepositPromise: Promise<bigint>, depositToken: string, depositTokenPricePrefetchPromise: Promise<bigint>, signal: AbortSignal, metadata: any): Promise<bigint>;
+    protected getSecurityDeposit(chainIdentifier: string, amountBD: bigint, swapFee: bigint, expiryTimeout: bigint, baseSecurityDepositPromise: Promise<bigint>, depositToken: string, depositTokenPricePrefetchPromise: Promise<bigint>, securityDepositData: {
+        securityDepositApyPPM?: bigint;
+        securityDepositBaseMultiplierPPM?: bigint;
+    }, signal: AbortSignal, metadata: any): Promise<bigint>;
 }

package/dist/swaps/FromBtcBaseSwapHandler.js

@@ -155,7 +155,9 @@ class FromBtcBaseSwapHandler extends SwapHandler_1.SwapHandler {
             if ((0, IPlugin_1.isQuoteSetFees)(res)) {
                 return {
                     baseFee: res.baseFee || this.config.baseFee,
-                    feePPM: res.feePPM || this.config.feePPM
+                    feePPM: res.feePPM || this.config.feePPM,
+                    securityDepositApyPPM: res.securityDepositApyPPM,
+                    securityDepositBaseMultiplierPPM: res.securityDepositBaseMultiplierPPM
                 };
             }
         }
@@ -179,6 +181,8 @@ class FromBtcBaseSwapHandler extends SwapHandler_1.SwapHandler {
      */
     async checkFromBtcAmount(request, requestedAmount, fees, useToken, signal, pricePrefetchPromise = Promise.resolve(null)) {
         const chainIdentifier = request.chainIdentifier;
+        let securityDepositApyPPM;
+        let securityDepositBaseMultiplierPPM;
         const res = await PluginManager_1.PluginManager.onHandlePostFromBtcQuote(request, requestedAmount, chainIdentifier, useToken, { minInBtc: this.config.min, maxInBtc: this.config.max }, { baseFeeInBtc: fees.baseFee, feePPM: fees.feePPM }, pricePrefetchPromise);
         signal.throwIfAborted();
         if (res != null) {
@@ -188,6 +192,10 @@ class FromBtcBaseSwapHandler extends SwapHandler_1.SwapHandler {
                     fees.baseFee = res.baseFee;
                 if (res.feePPM != null)
                     fees.feePPM = res.feePPM;
+                if (res.securityDepositApyPPM != null)
+                    securityDepositApyPPM = res.securityDepositApyPPM;
+                if (res.securityDepositBaseMultiplierPPM != null)
+                    securityDepositBaseMultiplierPPM = res.securityDepositBaseMultiplierPPM;
             }
             if ((0, IPlugin_1.isPluginQuote)(res)) {
                 if (!requestedAmount.input) {
@@ -251,7 +259,9 @@ class FromBtcBaseSwapHandler extends SwapHandler_1.SwapHandler {
             amountBD,
             swapFee,
             swapFeeInToken,
-            totalInToken
+            totalInToken,
+            securityDepositApyPPM,
+            securityDepositBaseMultiplierPPM
         };
     }
     /**
@@ -292,16 +302,19 @@ class FromBtcBaseSwapHandler extends SwapHandler_1.SwapHandler {
      * @param baseSecurityDepositPromise
      * @param depositToken
      * @param depositTokenPricePrefetchPromise
+     * @param securityDepositData
      * @param signal
      * @param metadata
      */
-    async getSecurityDeposit(chainIdentifier, amountBD, swapFee, expiryTimeout, baseSecurityDepositPromise, depositToken, depositTokenPricePrefetchPromise, signal, metadata) {
+    async getSecurityDeposit(chainIdentifier, amountBD, swapFee, expiryTimeout, baseSecurityDepositPromise, depositToken, depositTokenPricePrefetchPromise, securityDepositData, signal, metadata) {
         let baseSD = await baseSecurityDepositPromise;
+        if (securityDepositData.securityDepositBaseMultiplierPPM != null)
+            baseSD = baseSD * securityDepositData.securityDepositBaseMultiplierPPM / 1000000n;
         signal.throwIfAborted();
         metadata.times.refundFeeFetched = Date.now();
         const swapValueInDepositToken = await this.swapPricing.getFromBtcSwapAmount(amountBD - swapFee, depositToken, chainIdentifier, true, depositTokenPricePrefetchPromise);
         signal.throwIfAborted();
-        const apyPPM = BigInt(Math.floor(this.config.securityDepositAPY * 1000000));
+        const apyPPM = securityDepositData.securityDepositApyPPM ?? BigInt(Math.floor(this.config.securityDepositAPY * 1000000));
         const variableSD = swapValueInDepositToken * apyPPM * expiryTimeout / 1000000n / secondsInYear;
         this.logger.debug("getSecurityDeposit(): base security deposit: " + baseSD.toString(10) +
             " deposit token: " + depositToken +

package/dist/swaps/frombtc_abstract/FromBtcAbs.js

@@ -239,8 +239,12 @@ class FromBtcAbs extends FromBtcBaseSwapHandler_1.FromBtcBaseSwapHandler {
             abortController.signal.throwIfAborted();
             const baseSDPromise = this.getBaseSecurityDepositPrefetch(chainIdentifier, dummySwapData, depositToken, gasTokenPricePrefetchPromise, depositTokenPricePrefetchPromise, abortController);
             //Check valid amount specified (min/max)
-            const { amountBD, swapFee, swapFeeInToken, totalInToken } = await this.checkFromBtcAmount(request, requestedAmount, fees, useToken, abortController.signal, pricePrefetchPromise);
+            const { amountBD, swapFee, swapFeeInToken, totalInToken, securityDepositApyPPM, securityDepositBaseMultiplierPPM } = await this.checkFromBtcAmount(request, requestedAmount, fees, useToken, abortController.signal, pricePrefetchPromise);
             metadata.times.priceCalculated = Date.now();
+            if (securityDepositApyPPM != null)
+                fees.securityDepositApyPPM = securityDepositApyPPM;
+            if (securityDepositBaseMultiplierPPM != null)
+                fees.securityDepositBaseMultiplierPPM = securityDepositBaseMultiplierPPM;
             //Check if we have enough funds to honor the request
             await this.checkBalance(totalInToken, balancePrefetch, abortController.signal);
             metadata.times.balanceChecked = Date.now();
@@ -253,7 +257,7 @@ class FromBtcAbs extends FromBtcBaseSwapHandler_1.FromBtcBaseSwapHandler {
             const expiryTimeout = this.config.swapTsCsvDelta;
             const expiry = currentTimestamp + expiryTimeout;
             //Calculate security deposit
-            const totalSecurityDeposit = await this.getSecurityDeposit(chainIdentifier, amountBD, swapFee, expiryTimeout, baseSDPromise, depositToken, depositTokenPricePrefetchPromise, abortController.signal, metadata);
+            const totalSecurityDeposit = await this.getSecurityDeposit(chainIdentifier, amountBD, swapFee, expiryTimeout, baseSDPromise, depositToken, depositTokenPricePrefetchPromise, fees, abortController.signal, metadata);
             metadata.times.securityDepositCalculated = Date.now();
             //Calculate claimer bounty
             const totalClaimerBounty = await this.getClaimerBounty(req, expiry, abortController.signal);

package/dist/swaps/frombtcln_abstract/FromBtcLnAbs.js

@@ -488,8 +488,12 @@ class FromBtcLnAbs extends FromBtcLnBaseSwapHandler_1.FromBtcLnBaseSwapHandler {
             //Asynchronously send the node's public key to the client
             this.sendPublicKeyAsync(responseStream);
             //Check valid amount specified (min/max)
-            const { amountBD, swapFee, swapFeeInToken, totalInToken } = await this.checkFromBtcAmount(request, requestedAmount, fees, useToken, abortController.signal, pricePrefetchPromise);
+            const { amountBD, swapFee, swapFeeInToken, totalInToken, securityDepositApyPPM, securityDepositBaseMultiplierPPM } = await this.checkFromBtcAmount(request, requestedAmount, fees, useToken, abortController.signal, pricePrefetchPromise);
             metadata.times.priceCalculated = Date.now();
+            if (securityDepositApyPPM != null)
+                fees.securityDepositApyPPM = securityDepositApyPPM;
+            if (securityDepositBaseMultiplierPPM != null)
+                fees.securityDepositBaseMultiplierPPM = securityDepositBaseMultiplierPPM;
             //Check if we have enough funds to honor the request
             await this.checkBalance(totalInToken, balancePrefetch, abortController.signal);
             await this.checkInboundLiquidity(amountBD, channelsPrefetch, abortController.signal);
@@ -510,7 +514,7 @@ class FromBtcLnAbs extends FromBtcLnBaseSwapHandler_1.FromBtcLnBaseSwapHandler {
             metadata.invoiceResponse = { ...hodlInvoice };
             //Pre-compute the security deposit
             const expiryTimeout = (this.config.minCltv * this.config.bitcoinBlocktime / this.config.safetyFactor) - this.config.gracePeriod;
-            const totalSecurityDeposit = await this.getSecurityDeposit(chainIdentifier, amountBD, swapFee, expiryTimeout, baseSDPromise, depositToken, depositTokenPricePrefetchPromise, abortController.signal, metadata);
+            const totalSecurityDeposit = await this.getSecurityDeposit(chainIdentifier, amountBD, swapFee, expiryTimeout, baseSDPromise, depositToken, depositTokenPricePrefetchPromise, fees, abortController.signal, metadata);
             metadata.times.securityDepositCalculated = Date.now();
             const createdSwap = new FromBtcLnSwapAbs_1.FromBtcLnSwapAbs(chainIdentifier, hodlInvoice.request, parsedBody.paymentHash, hodlInvoice.mtokens, swapFee, swapFeeInToken, parsedBody.address, useToken, totalInToken, swapContract.getHashForHtlc(Buffer.from(parsedBody.paymentHash, "hex")).toString("hex"), totalSecurityDeposit, depositToken);
             metadata.times.swapCreated = Date.now();

package/package.json

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

package/src/plugins/IPlugin.ts

@@ -25,13 +25,17 @@ export function isQuoteThrow(obj: any): obj is QuoteThrow {
 export type QuoteSetFees = {
     type: "fees"
     baseFee?: bigint,
-    feePPM?: bigint
+    feePPM?: bigint,
+    securityDepositApyPPM?: bigint,
+    securityDepositBaseMultiplierPPM?: bigint
 };
 
 export function isQuoteSetFees(obj: any): obj is QuoteSetFees {
     return obj.type==="fees" &&
         (obj.baseFee==null || typeof(obj.baseFee) === "bigint") &&
-        (obj.feePPM==null || typeof(obj.feePPM) === "bigint");
+        (obj.feePPM==null || typeof(obj.feePPM) === "bigint") &&
+        (obj.securityDepositApyPPM==null || typeof(obj.securityDepositApyPPM) === "bigint") &&
+        (obj.securityDepositBaseMultiplierPPM==null || typeof(obj.securityDepositBaseMultiplierPPM) === "bigint");
 }
 
 export type QuoteAmountTooLow = {

package/src/swaps/FromBtcBaseSwapHandler.ts

@@ -174,7 +174,12 @@ export abstract class FromBtcBaseSwapHandler<V extends SwapHandlerSwap<SwapData,
         request: RequestData<FromBtcLnRequestType | FromBtcRequestType | FromBtcLnTrustedRequestType>,
         requestedAmount: {input: boolean, amount: bigint},
         useToken: string
-    ): Promise<{baseFee: bigint, feePPM: bigint}> {
+    ): Promise<{
+        baseFee: bigint,
+        feePPM: bigint,
+        securityDepositApyPPM?: bigint,
+        securityDepositBaseMultiplierPPM?: bigint,
+    }> {
         const res = await PluginManager.onHandlePreFromBtcQuote(
             request,
             requestedAmount,
@@ -188,7 +193,9 @@ export abstract class FromBtcBaseSwapHandler<V extends SwapHandlerSwap<SwapData,
             if(isQuoteSetFees(res)) {
                 return {
                     baseFee: res.baseFee || this.config.baseFee,
-                    feePPM: res.feePPM || this.config.feePPM
+                    feePPM: res.feePPM || this.config.feePPM,
+                    securityDepositApyPPM: res.securityDepositApyPPM,
+                    securityDepositBaseMultiplierPPM: res.securityDepositBaseMultiplierPPM
                 }
             }
         }
@@ -221,10 +228,15 @@ export abstract class FromBtcBaseSwapHandler<V extends SwapHandlerSwap<SwapData,
         amountBD: bigint,
         swapFee: bigint, //Swap fee in BTC
         swapFeeInToken: bigint, //Swap fee in token on top of what should be paid out to the user
-        totalInToken: bigint //Total to be paid out to the user
+        totalInToken: bigint, //Total to be paid out to the user
+        securityDepositApyPPM?: bigint,
+        securityDepositBaseMultiplierPPM?: bigint
     }> {
         const chainIdentifier = request.chainIdentifier;
 
+        let securityDepositApyPPM: bigint;
+        let securityDepositBaseMultiplierPPM: bigint;
+
         const res = await PluginManager.onHandlePostFromBtcQuote(
             request,
             requestedAmount,
@@ -240,6 +252,8 @@ export abstract class FromBtcBaseSwapHandler<V extends SwapHandlerSwap<SwapData,
             if(isQuoteSetFees(res)) {
                 if(res.baseFee!=null) fees.baseFee = res.baseFee;
                 if(res.feePPM!=null) fees.feePPM = res.feePPM;
+                if(res.securityDepositApyPPM!=null) securityDepositApyPPM = res.securityDepositApyPPM;
+                if(res.securityDepositBaseMultiplierPPM!=null) securityDepositBaseMultiplierPPM = res.securityDepositBaseMultiplierPPM;
             }
             if(isPluginQuote(res)) {
                 if(!requestedAmount.input) {
@@ -310,7 +324,9 @@ export abstract class FromBtcBaseSwapHandler<V extends SwapHandlerSwap<SwapData,
             amountBD,
             swapFee,
             swapFeeInToken,
-            totalInToken
+            totalInToken,
+            securityDepositApyPPM,
+            securityDepositBaseMultiplierPPM
         }
     }
 
@@ -373,6 +389,7 @@ export abstract class FromBtcBaseSwapHandler<V extends SwapHandlerSwap<SwapData,
      * @param baseSecurityDepositPromise
      * @param depositToken
      * @param depositTokenPricePrefetchPromise
+     * @param securityDepositData
      * @param signal
      * @param metadata
      */
@@ -384,10 +401,16 @@ export abstract class FromBtcBaseSwapHandler<V extends SwapHandlerSwap<SwapData,
         baseSecurityDepositPromise: Promise<bigint>,
         depositToken: string,
         depositTokenPricePrefetchPromise: Promise<bigint>,
+        securityDepositData: {
+            securityDepositApyPPM?: bigint,
+            securityDepositBaseMultiplierPPM?: bigint,
+        },
         signal: AbortSignal,
         metadata: any
     ): Promise<bigint> {
         let baseSD: bigint = await baseSecurityDepositPromise;
+        if(securityDepositData.securityDepositBaseMultiplierPPM!=null)
+            baseSD = baseSD * securityDepositData.securityDepositBaseMultiplierPPM / 1_000_000n;
 
         signal.throwIfAborted();
 
@@ -403,7 +426,7 @@ export abstract class FromBtcBaseSwapHandler<V extends SwapHandlerSwap<SwapData,
 
         signal.throwIfAborted();
 
-        const apyPPM = BigInt(Math.floor(this.config.securityDepositAPY*1000000));
+        const apyPPM = securityDepositData.securityDepositApyPPM ?? BigInt(Math.floor(this.config.securityDepositAPY*1000000));
         const variableSD = swapValueInDepositToken * apyPPM * expiryTimeout / 1000000n / secondsInYear;
 
         this.logger.debug(

package/src/swaps/frombtc_abstract/FromBtcAbs.ts

@@ -333,10 +333,15 @@ export class FromBtcAbs extends FromBtcBaseSwapHandler<FromBtcSwapAbs, FromBtcSw
                 amountBD,
                 swapFee,
                 swapFeeInToken,
-                totalInToken
+                totalInToken,
+                securityDepositApyPPM,
+                securityDepositBaseMultiplierPPM
             } = await this.checkFromBtcAmount(request, requestedAmount, fees, useToken, abortController.signal, pricePrefetchPromise);
             metadata.times.priceCalculated = Date.now();
 
+            if(securityDepositApyPPM!=null) fees.securityDepositApyPPM = securityDepositApyPPM;
+            if(securityDepositBaseMultiplierPPM!=null) fees.securityDepositBaseMultiplierPPM = securityDepositBaseMultiplierPPM;
+
             //Check if we have enough funds to honor the request
             await this.checkBalance(totalInToken, balancePrefetch, abortController.signal);
             metadata.times.balanceChecked = Date.now();
@@ -354,7 +359,7 @@ export class FromBtcAbs extends FromBtcBaseSwapHandler<FromBtcSwapAbs, FromBtcSw
             //Calculate security deposit
             const totalSecurityDeposit = await this.getSecurityDeposit(
                 chainIdentifier, amountBD, swapFee, expiryTimeout,
-                baseSDPromise, depositToken, depositTokenPricePrefetchPromise,
+                baseSDPromise, depositToken, depositTokenPricePrefetchPromise, fees,
                 abortController.signal, metadata
             );
             metadata.times.securityDepositCalculated = Date.now();

package/src/swaps/frombtcln_abstract/FromBtcLnAbs.ts

@@ -624,10 +624,15 @@ export class FromBtcLnAbs extends FromBtcLnBaseSwapHandler<FromBtcLnSwapAbs, Fro
                 amountBD,
                 swapFee,
                 swapFeeInToken,
-                totalInToken
+                totalInToken,
+                securityDepositApyPPM,
+                securityDepositBaseMultiplierPPM
             } = await this.checkFromBtcAmount(request, requestedAmount, fees, useToken, abortController.signal, pricePrefetchPromise);
             metadata.times.priceCalculated = Date.now();
 
+            if(securityDepositApyPPM!=null) fees.securityDepositApyPPM = securityDepositApyPPM;
+            if(securityDepositBaseMultiplierPPM!=null) fees.securityDepositBaseMultiplierPPM = securityDepositBaseMultiplierPPM;
+
             //Check if we have enough funds to honor the request
             await this.checkBalance(totalInToken, balancePrefetch, abortController.signal)
             await this.checkInboundLiquidity(amountBD, channelsPrefetch, abortController.signal);
@@ -653,7 +658,7 @@ export class FromBtcLnAbs extends FromBtcLnBaseSwapHandler<FromBtcLnSwapAbs, Fro
             const expiryTimeout = (this.config.minCltv * this.config.bitcoinBlocktime / this.config.safetyFactor) - this.config.gracePeriod;
             const totalSecurityDeposit = await this.getSecurityDeposit(
                 chainIdentifier, amountBD, swapFee, expiryTimeout,
-                baseSDPromise, depositToken, depositTokenPricePrefetchPromise,
+                baseSDPromise, depositToken, depositTokenPricePrefetchPromise, fees,
                 abortController.signal, metadata
             );
             metadata.times.securityDepositCalculated = Date.now();