@gainsnetwork/sdk 0.2.12-rc2 → 0.2.12-rc3

package/lib/trade/liquidation.d.ts

@@ -1,3 +1,8 @@
 import { GetBorrowingFeeContext, BorrowingFee } from "./fees";
-import { Fee, Trade } from "./types";
-export declare const getLiquidationPrice: (trade: Trade, fee: Fee, initialAccFees: BorrowingFee.InitialAccFees, context: GetBorrowingFeeContext) => number;
+import { Fee, LiquidationParams, Trade } from "./types";
+export type GetLiquidationPriceContext = GetBorrowingFeeContext & {
+    liquidationParams: LiquidationParams | undefined;
+    pairSpreadP: number | undefined;
+};
+export declare const getLiquidationPrice: (trade: Trade, fee: Fee, initialAccFees: BorrowingFee.InitialAccFees, context: GetLiquidationPriceContext) => number;
+export declare const getLiqPnlThresholdP: (liquidationParams: LiquidationParams | undefined, leverage: number | undefined) => number;

package/lib/trade/liquidation.js

@@ -1,16 +1,47 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getLiquidationPrice = void 0;
+exports.getLiqPnlThresholdP = exports.getLiquidationPrice = void 0;
 const fees_1 = require("./fees");
+const spread_1 = require("./spread");
 const getLiquidationPrice = (trade, fee, initialAccFees, context) => {
+    var _a;
     const closingFee = (0, fees_1.getClosingFee)(trade.collateralAmount, trade.leverage, trade.pairIndex, fee);
     const borrowingFee = (0, fees_1.getBorrowingFee)(trade.collateralAmount * trade.leverage, trade.pairIndex, trade.long, initialAccFees, context);
-    const liqPriceDistance = (trade.openPrice *
-        (trade.collateralAmount * 0.9 - (borrowingFee + closingFee))) /
+    const liqThresholdP = (0, exports.getLiqPnlThresholdP)(context.liquidationParams, trade.leverage);
+    let liqPriceDistance = (trade.openPrice *
+        (trade.collateralAmount * liqThresholdP - (borrowingFee + closingFee))) /
         trade.collateralAmount /
         trade.leverage;
+    if (((_a = context === null || context === void 0 ? void 0 : context.liquidationParams) === null || _a === void 0 ? void 0 : _a.maxLiqSpreadP) !== undefined &&
+        context.liquidationParams.maxLiqSpreadP > 0) {
+        const closingSpreadP = (0, spread_1.getSpreadP)(context.pairSpreadP, true, context.liquidationParams);
+        liqPriceDistance += trade.openPrice * closingSpreadP;
+    }
     return trade.long
         ? Math.max(trade.openPrice - liqPriceDistance, 0)
         : Math.max(trade.openPrice + liqPriceDistance, 0);
 };
 exports.getLiquidationPrice = getLiquidationPrice;
+const getLiqPnlThresholdP = (liquidationParams, leverage) => {
+    if (liquidationParams === undefined ||
+        leverage === undefined ||
+        liquidationParams.maxLiqSpreadP === 0 ||
+        liquidationParams.startLiqThresholdP === 0 ||
+        liquidationParams.endLiqThresholdP === 0 ||
+        liquidationParams.startLeverage === 0 ||
+        liquidationParams.endLeverage === 0) {
+        return 0.9;
+    }
+    if (leverage < liquidationParams.startLeverage) {
+        return liquidationParams.startLiqThresholdP;
+    }
+    if (leverage > liquidationParams.endLeverage) {
+        return liquidationParams.endLiqThresholdP;
+    }
+    return (liquidationParams.startLiqThresholdP -
+        ((leverage - liquidationParams.startLeverage) *
+            (liquidationParams.startLiqThresholdP -
+                liquidationParams.endLiqThresholdP)) /
+            (liquidationParams.endLeverage - liquidationParams.startLeverage));
+};
+exports.getLiqPnlThresholdP = getLiqPnlThresholdP;

package/lib/trade/pnl.d.ts

@@ -1,7 +1,7 @@
 import { GetBorrowingFeeContext } from "./fees";
-import { Fee, Trade, TradeInfo, TradeInitialAccFees } from "./types";
+import { Fee, LiquidationParams, Trade, TradeInfo, TradeInitialAccFees } from "./types";
 export type GetPnlContext = GetBorrowingFeeContext & {
     fee: Fee | undefined;
     maxGainP: number | undefined;
 };
-export declare const getPnl: (price: number | undefined, trade: Trade, tradeInfo: TradeInfo, initialAccFees: TradeInitialAccFees, useFees: boolean, context: GetPnlContext) => number[] | undefined;
+export declare const getPnl: (price: number | undefined, trade: Trade, tradeInfo: TradeInfo, initialAccFees: TradeInitialAccFees, liquidationParams: LiquidationParams, useFees: boolean, context: GetPnlContext) => number[] | undefined;

package/lib/trade/pnl.js

@@ -2,7 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getPnl = void 0;
 const fees_1 = require("./fees");
-const getPnl = (price, trade, tradeInfo, initialAccFees, useFees, context) => {
+const liquidation_1 = require("./liquidation");
+const getPnl = (price, trade, tradeInfo, initialAccFees, liquidationParams, useFees, context) => {
     if (!price) {
         return;
     }
@@ -19,7 +20,8 @@ const getPnl = (price, trade, tradeInfo, initialAccFees, useFees, context) => {
     }
     let pnlPercentage = (pnlCollat / posCollat) * 100;
     // Can be liquidated
-    if (pnlPercentage <= -90) {
+    if (pnlPercentage <=
+        (0, liquidation_1.getLiqPnlThresholdP)(liquidationParams, leverage) * -100) {
         pnlPercentage = -100;
     }
     else {

package/lib/trade/spread.d.ts

@@ -1,11 +1,13 @@
-import { OiWindows, OiWindowsSettings, PairDepth } from "./types";
+import { LiquidationParams, OiWindows, OiWindowsSettings, PairDepth } from "./types";
 export type SpreadContext = {
     isOpen?: boolean;
     isPnlPositive?: boolean;
     protectionCloseFactor?: number;
     protectionCloseFactorBlocks?: number;
     createdBlock?: number;
+    liquidationParams?: LiquidationParams | undefined;
     currentBlock: number | undefined;
 };
 export declare const getProtectionCloseFactor: (spreadCtx: SpreadContext | undefined) => number;
 export declare const getSpreadWithPriceImpactP: (pairSpreadP: number, buy: boolean, collateral: number, leverage: number, pairDepth: PairDepth | undefined, oiWindowsSettings?: OiWindowsSettings | undefined, oiWindows?: OiWindows | undefined, spreadCtx?: SpreadContext | undefined) => number;
+export declare const getSpreadP: (pairSpreadP: number | undefined, isLiquidation?: boolean | undefined, liquidationParams?: LiquidationParams | undefined) => number;

package/lib/trade/spread.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getSpreadWithPriceImpactP = exports.getProtectionCloseFactor = void 0;
+exports.getSpreadP = exports.getSpreadWithPriceImpactP = exports.getProtectionCloseFactor = void 0;
 const oiWindows_1 = require("./oiWindows");
 const constants_1 = require("../constants");
 const getProtectionCloseFactor = (spreadCtx) => {
@@ -26,6 +26,12 @@ const getSpreadWithPriceImpactP = (pairSpreadP, buy, collateral, leverage, pairD
     if (pairSpreadP === undefined) {
         return 0;
     }
+    // No spread or price impact when closing pre-v9.2 trades
+    if ((spreadCtx === null || spreadCtx === void 0 ? void 0 : spreadCtx.isOpen) === false &&
+        (spreadCtx === null || spreadCtx === void 0 ? void 0 : spreadCtx.liquidationParams) !== undefined &&
+        spreadCtx.liquidationParams.maxLiqSpreadP === 0) {
+        return 0;
+    }
     const onePercentDepth = buy
         ? // if `long`
             (spreadCtx === null || spreadCtx === void 0 ? void 0 : spreadCtx.isOpen) !== false // assumes it's an open unless it's explicitly false
@@ -42,8 +48,21 @@ const getSpreadWithPriceImpactP = (pairSpreadP, buy, collateral, leverage, pairD
     if (!onePercentDepth || activeOi === undefined || collateral === undefined) {
         return pairSpreadP / 2;
     }
-    return (pairSpreadP / 2 +
+    return ((0, exports.getSpreadP)(pairSpreadP) +
         ((activeOi + (collateral * leverage) / 2) / onePercentDepth / 100 / 2) *
             (0, exports.getProtectionCloseFactor)(spreadCtx));
 };
 exports.getSpreadWithPriceImpactP = getSpreadWithPriceImpactP;
+const getSpreadP = (pairSpreadP, isLiquidation, liquidationParams) => {
+    if (pairSpreadP === undefined || pairSpreadP === 0) {
+        return 0;
+    }
+    const spreadP = pairSpreadP / 2;
+    return isLiquidation === true &&
+        liquidationParams !== undefined &&
+        liquidationParams.maxLiqSpreadP > 0 &&
+        spreadP > liquidationParams.maxLiqSpreadP
+        ? liquidationParams.maxLiqSpreadP
+        : spreadP;
+};
+exports.getSpreadP = getSpreadP;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gainsnetwork/sdk",
-  "version": "0.2.12-rc2",
+  "version": "0.2.12-rc3",
   "description": "Gains Network SDK",
   "main": "./lib/index.js",
   "files": [