@gainsnetwork/sdk 0.2.34-rc1 → 0.2.36

package/lib/contracts/utils/pairs.js

@@ -69,10 +69,10 @@ const fetchFees = (contracts, feeIxs) => __awaiter(void 0, void 0, void 0, funct
         const fees = yield Promise.all(feeIxs.map(pairIndex => multiCollatContract.fees(pairIndex)));
         return fees.map(fee => {
             return {
-                openFeeP: parseFloat(fee.openFeeP.toString()) / 1e12,
-                closeFeeP: parseFloat(fee.closeFeeP.toString()) / 1e12,
-                triggerOrderFeeP: parseFloat(fee.triggerOrderFeeP.toString()) / 1e12,
-                minPositionSizeUsd: parseFloat(fee.minPositionSizeUsd.toString()) / 1e18,
+                totalPositionSizeFeeP: parseFloat(fee.totalPositionSizeFeeP.toString()) / 1e12,
+                totalLiqCollateralFeeP: parseFloat(fee.totalLiqCollateralFeeP.toString()) / 1e12,
+                oraclePositionSizeFeeP: parseFloat(fee.oraclePositionSizeFeeP.toString()) / 1e12,
+                minPositionSizeUsd: parseFloat(fee.minPositionSizeUsd.toString()) / 1e3,
             };
         });
     }

package/lib/trade/fees/index.js

@@ -22,8 +22,8 @@ const getClosingFee = (posDai, leverage, pairIndex, pairFee, collateralPriceUsd
         pairFee === undefined) {
         return 0;
     }
-    const { closeFeeP, triggerOrderFeeP, minPositionSizeUsd } = pairFee;
-    return ((closeFeeP + triggerOrderFeeP) *
+    const { totalPositionSizeFeeP, minPositionSizeUsd } = pairFee;
+    return (totalPositionSizeFeeP *
         feeMultiplier *
         Math.max(collateralPriceUsd && collateralPriceUsd > 0
             ? minPositionSizeUsd / collateralPriceUsd

package/lib/trade/spread.d.ts

@@ -1,17 +1,16 @@
-import { LiquidationParams, OiWindows, OiWindowsSettings, PairDepth } from "./types";
+import { LiquidationParams, OiWindows, OiWindowsSettings, PairDepth, PairFactor } from "./types";
 import { ContractsVersion } from "../contracts/types";
 export type SpreadContext = {
     isOpen?: boolean;
     isPnlPositive?: boolean;
-    protectionCloseFactor?: number;
-    protectionCloseFactorBlocks?: number;
-    cumulativeFactor?: number;
     createdBlock?: number;
     liquidationParams?: LiquidationParams | undefined;
     currentBlock?: number | undefined;
     contractsVersion?: ContractsVersion | undefined;
-};
+    protectionCloseFactorWhitelist?: boolean;
+} & Partial<PairFactor>;
 export declare const getProtectionCloseFactor: (spreadCtx: SpreadContext | undefined) => number;
+export declare const isProtectionCloseFactorActive: (spreadCtx: SpreadContext | undefined) => boolean | undefined;
 export declare const getCumulativeFactor: (spreadCtx: SpreadContext | undefined) => number;
 export declare const getLegacyFactor: (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;

package/lib/trade/spread.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getSpreadP = exports.getSpreadWithPriceImpactP = exports.getLegacyFactor = exports.getCumulativeFactor = exports.getProtectionCloseFactor = void 0;
+exports.getSpreadP = exports.getSpreadWithPriceImpactP = exports.getLegacyFactor = exports.getCumulativeFactor = exports.isProtectionCloseFactorActive = exports.getProtectionCloseFactor = void 0;
 const oiWindows_1 = require("./oiWindows");
 const constants_1 = require("../constants");
 const types_1 = require("../contracts/types");
@@ -9,23 +9,32 @@ const getProtectionCloseFactor = (spreadCtx) => {
         spreadCtx.contractsVersion === types_1.ContractsVersion.BEFORE_V9_2 ||
         spreadCtx.isOpen === undefined ||
         spreadCtx.isPnlPositive === undefined ||
-        spreadCtx.protectionCloseFactor === undefined ||
-        spreadCtx.protectionCloseFactorBlocks === undefined ||
-        spreadCtx.createdBlock === undefined ||
-        spreadCtx.currentBlock === undefined)
+        (0, exports.isProtectionCloseFactorActive)(spreadCtx) !== true)
         return constants_1.DEFAULT_PROTECTION_CLOSE_FACTOR;
-    if (spreadCtx.isPnlPositive &&
-        !spreadCtx.isOpen &&
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    return spreadCtx.protectionCloseFactor;
+};
+exports.getProtectionCloseFactor = getProtectionCloseFactor;
+const isProtectionCloseFactorActive = (spreadCtx) => {
+    if (spreadCtx === undefined ||
+        spreadCtx.currentBlock === undefined ||
+        spreadCtx.createdBlock === undefined ||
+        spreadCtx.protectionCloseFactorBlocks === undefined ||
+        spreadCtx.protectionCloseFactor === undefined) {
+        return undefined;
+    }
+    return (spreadCtx.isPnlPositive === true &&
+        spreadCtx.isOpen === false &&
         spreadCtx.protectionCloseFactor > 0 &&
         spreadCtx.currentBlock <=
-            spreadCtx.createdBlock + spreadCtx.protectionCloseFactorBlocks) {
-        return spreadCtx.protectionCloseFactor;
-    }
-    return constants_1.DEFAULT_PROTECTION_CLOSE_FACTOR;
+            spreadCtx.createdBlock + spreadCtx.protectionCloseFactorBlocks &&
+        spreadCtx.protectionCloseFactorWhitelist !== true);
 };
-exports.getProtectionCloseFactor = getProtectionCloseFactor;
+exports.isProtectionCloseFactorActive = isProtectionCloseFactorActive;
 const getCumulativeFactor = (spreadCtx) => {
-    if (spreadCtx === undefined || spreadCtx.cumulativeFactor === undefined || spreadCtx.cumulativeFactor === 0) {
+    if (spreadCtx === undefined ||
+        spreadCtx.cumulativeFactor === undefined ||
+        spreadCtx.cumulativeFactor === 0) {
         return constants_1.DEFAULT_CUMULATIVE_FACTOR;
     }
     return spreadCtx.cumulativeFactor;
@@ -39,9 +48,17 @@ const getSpreadWithPriceImpactP = (pairSpreadP, buy, collateral, leverage, pairD
     if (pairSpreadP === undefined) {
         return 0;
     }
+    if (
     // 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.contractsVersion) === types_1.ContractsVersion.BEFORE_V9_2) {
+    ((spreadCtx === null || spreadCtx === void 0 ? void 0 : spreadCtx.isOpen) === false &&
+        (spreadCtx === null || spreadCtx === void 0 ? void 0 : spreadCtx.contractsVersion) === types_1.ContractsVersion.BEFORE_V9_2) ||
+        // No spread or price impact for opens when `pair.exemptOnOpen` is true
+        ((spreadCtx === null || spreadCtx === void 0 ? void 0 : spreadCtx.isOpen) === true && (spreadCtx === null || spreadCtx === void 0 ? void 0 : spreadCtx.exemptOnOpen) === true) ||
+        // No spread or price impact for closes after `protectionCloseFactor` has expired
+        // when `pair.exemptAfterProtectionCloseFactor` is true
+        ((spreadCtx === null || spreadCtx === void 0 ? void 0 : spreadCtx.isOpen) === false &&
+            (spreadCtx === null || spreadCtx === void 0 ? void 0 : spreadCtx.exemptAfterProtectionCloseFactor) === true &&
+            (0, exports.isProtectionCloseFactorActive)(spreadCtx) !== true)) {
         return 0;
     }
     const onePercentDepth = buy

package/lib/trade/types.d.ts

@@ -48,10 +48,17 @@ export type TradingGroup = {
     name: string;
 };
 export type Fee = {
-    openFeeP: number;
-    closeFeeP: number;
+    totalPositionSizeFeeP: number;
+    totalLiqCollateralFeeP: number;
+    oraclePositionSizeFeeP: number;
     minPositionSizeUsd: number;
+};
+export type GlobalTradeFeeParams = {
+    referralFeeP: number;
+    govFeeP: number;
     triggerOrderFeeP: number;
+    gnsOtcFeeP: number;
+    gTokenFeeP: number;
 };
 export type PairDepth = {
     onePercentDepthAboveUsd: number;
@@ -169,11 +176,14 @@ export type TraderFeeTiers = {
     outboundPoints: number;
     lastDayUpdatedPoints: number;
     expiredPoints: number[];
+    unclaimedPoints: number;
 };
 export type PairFactor = {
     cumulativeFactor: number;
     protectionCloseFactor: number;
     protectionCloseFactorBlocks: number;
+    exemptOnOpen: boolean;
+    exemptAfterProtectionCloseFactor: boolean;
 };
 export declare enum PendingOrderType {
     MARKET_OPEN = 0,

package/package.json

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