@gainsnetwork/sdk 0.0.0-v10.rc1 → 0.0.0-v10.rc10

package/lib/trade/priceImpact/cumulVol/index.js

@@ -0,0 +1,231 @@
+"use strict";
+/**
+ * @dev Cumulative volume price impact calculations
+ * @dev Mirrors contract's getTradeCumulVolPriceImpactP functionality
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildCumulVolContext = exports.convertOiWindowsSettingsArray = exports.convertOiWindows = exports.convertOiWindow = exports.convertOiWindowsSettings = exports.getSpreadWithPriceImpactP = exports.getCumulVolPriceImpact = exports.getSpreadWithCumulVolPriceImpactP = exports.getSpreadP = exports.getFixedSpreadP = exports.getTradeCumulVolPriceImpactP = 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");
+/**
+ * @dev Gets the protection close factor with user multiplier
+ * @param context Cumulative volume context
+ * @returns Protection close factor (1 = 100%)
+ */
+const getProtectionCloseFactor = (context) => {
+    var _a;
+    const protectionCloseFactor = context === undefined ||
+        context.contractsVersion === types_1.ContractsVersion.BEFORE_V9_2 ||
+        context.isOpen === undefined ||
+        context.isPnlPositive === undefined ||
+        context.protectionCloseFactor === undefined ||
+        (0, exports.isProtectionCloseFactorActive)(context) !== true
+        ? constants_1.DEFAULT_PROTECTION_CLOSE_FACTOR
+        : context.protectionCloseFactor;
+    const protectionCloseFactorMultiplier = ((_a = context === null || context === void 0 ? void 0 : context.userPriceImpact) === null || _a === void 0 ? void 0 : _a.cumulVolPriceImpactMultiplier) !== undefined &&
+        context.userPriceImpact.cumulVolPriceImpactMultiplier > 0
+        ? context.userPriceImpact.cumulVolPriceImpactMultiplier
+        : 1;
+    return protectionCloseFactor * protectionCloseFactorMultiplier;
+};
+exports.getProtectionCloseFactor = getProtectionCloseFactor;
+/**
+ * @dev Checks if protection close factor is active
+ * @param context Cumulative volume context
+ * @returns True if protection close factor should be applied
+ */
+const isProtectionCloseFactorActive = (context) => {
+    if (context === undefined ||
+        context.currentBlock === undefined ||
+        context.createdBlock === undefined ||
+        context.protectionCloseFactorBlocks === undefined ||
+        context.protectionCloseFactor === undefined) {
+        return undefined;
+    }
+    return (context.isPnlPositive === true &&
+        context.isOpen === false &&
+        context.protectionCloseFactor > 0 &&
+        context.currentBlock <=
+            context.createdBlock + context.protectionCloseFactorBlocks &&
+        context.protectionCloseFactorWhitelist !== true);
+};
+exports.isProtectionCloseFactorActive = isProtectionCloseFactorActive;
+/**
+ * @dev Gets the cumulative factor for price impact calculation
+ * @param context Cumulative volume context
+ * @returns Cumulative factor (default 1)
+ */
+const getCumulativeFactor = (context) => {
+    if (context === undefined ||
+        context.cumulativeFactor === undefined ||
+        context.cumulativeFactor === 0) {
+        return constants_1.DEFAULT_CUMULATIVE_FACTOR;
+    }
+    return context.cumulativeFactor;
+};
+exports.getCumulativeFactor = getCumulativeFactor;
+/**
+ * @dev Gets the legacy factor for v9.2 compatibility
+ * @param context Cumulative volume context
+ * @returns 1 for pre-v9.2, 2 for v9.2+
+ */
+const getLegacyFactor = (context) => {
+    return (context === null || context === void 0 ? void 0 : context.contractsVersion) === types_1.ContractsVersion.BEFORE_V9_2 ? 1 : 2;
+};
+exports.getLegacyFactor = getLegacyFactor;
+/**
+ * @dev Calculates cumulative volume price impact percentage
+ * @dev Mirrors contract's getTradeCumulVolPriceImpactP function
+ * @param trader Trader address
+ * @param pairIndex Trading pair index
+ * @param long True for long, false for short
+ * @param tradeOpenInterestUsd Position size in USD
+ * @param isPnlPositive Whether PnL is positive (only relevant when closing)
+ * @param open True for opening, false for closing
+ * @param lastPosIncreaseBlock Last block when position was increased (only relevant when closing)
+ * @param context Additional context with depths, OI data, and factors
+ * @returns Cumulative volume price impact percentage (not including spread)
+ */
+const getTradeCumulVolPriceImpactP = (trader, pairIndex, long, tradeOpenInterestUsd, isPnlPositive, open, lastPosIncreaseBlock, context) => {
+    var _a, _b, _c, _d;
+    // Update context with passed parameters
+    const updatedContext = Object.assign(Object.assign({}, context), { isOpen: open, isPnlPositive: isPnlPositive, createdBlock: context.createdBlock || lastPosIncreaseBlock });
+    if (
+    // No price impact when closing pre-v9.2 trades
+    (!open && (context === null || context === void 0 ? void 0 : context.contractsVersion) === types_1.ContractsVersion.BEFORE_V9_2) ||
+        // No price impact for opens when `pair.exemptOnOpen` is true
+        (open && (context === null || context === void 0 ? void 0 : context.exemptOnOpen) === true) ||
+        // No price impact for closes after `protectionCloseFactor` has expired
+        // when `pair.exemptAfterProtectionCloseFactor` is true
+        (!open &&
+            (context === null || context === void 0 ? void 0 : context.exemptAfterProtectionCloseFactor) === true &&
+            (0, exports.isProtectionCloseFactorActive)(updatedContext) !== true)) {
+        return 0;
+    }
+    const onePercentDepth = long
+        ? // if `long`
+            open
+                ? (_a = context.pairDepth) === null || _a === void 0 ? void 0 : _a.onePercentDepthAboveUsd
+                : (_b = context.pairDepth) === null || _b === void 0 ? void 0 : _b.onePercentDepthBelowUsd
+        : // if `short`
+            open
+                ? (_c = context.pairDepth) === null || _c === void 0 ? void 0 : _c.onePercentDepthBelowUsd
+                : (_d = context.pairDepth) === null || _d === void 0 ? void 0 : _d.onePercentDepthAboveUsd;
+    let activeOi = undefined;
+    if (context.oiWindowsSettings !== undefined) {
+        activeOi = (0, oiWindows_1.getActiveOi)((0, oiWindows_1.getCurrentOiWindowId)(context.oiWindowsSettings), context.oiWindowsSettings.windowsCount, context.oiWindows, open ? long : !long);
+    }
+    if (!onePercentDepth || activeOi === undefined) {
+        return 0;
+    }
+    const finalPriceImpactP = ((activeOi * (0, exports.getCumulativeFactor)(updatedContext) +
+        tradeOpenInterestUsd / 2) /
+        onePercentDepth /
+        (0, exports.getLegacyFactor)(updatedContext)) *
+        (0, exports.getProtectionCloseFactor)(updatedContext);
+    return finalPriceImpactP;
+};
+exports.getTradeCumulVolPriceImpactP = getTradeCumulVolPriceImpactP;
+/**
+ * @dev Gets the fixed spread percentage with direction
+ * @dev Mirrors contract's getFixedSpreadP function
+ * @param spreadP Total spread percentage (includes base + user spread)
+ * @param long True for long position
+ * @param open True for opening, false for closing
+ * @returns Signed spread percentage (positive or negative based on direction)
+ */
+const getFixedSpreadP = (spreadP, long, open) => {
+    // Reverse spread direction on close
+    const effectiveLong = open ? long : !long;
+    // Calculate half spread
+    const fixedSpreadP = spreadP / 2;
+    // Apply direction
+    return effectiveLong ? fixedSpreadP : -fixedSpreadP;
+};
+exports.getFixedSpreadP = getFixedSpreadP;
+/**
+ * @dev Gets the base spread percentage
+ * @param pairSpreadP Pair spread percentage
+ * @param isLiquidation True if liquidation
+ * @param liquidationParams Liquidation parameters
+ * @param userPriceImpact User-specific price impact settings
+ * @returns Base spread percentage
+ * @todo Review if this function still makes sense or should use getFixedSpreadP pattern
+ *       Currently it may double-count user fixed spread if pairSpreadP already includes it
+ */
+const getSpreadP = (pairSpreadP, isLiquidation, liquidationParams, userPriceImpact) => {
+    var _a;
+    const fixedSpreadP = (_a = userPriceImpact === null || userPriceImpact === void 0 ? void 0 : userPriceImpact.fixedSpreadP) !== null && _a !== void 0 ? _a : 0;
+    if (pairSpreadP === undefined || (pairSpreadP === 0 && fixedSpreadP === 0)) {
+        return 0;
+    }
+    const spreadP = pairSpreadP / 2 + fixedSpreadP;
+    return isLiquidation === true &&
+        liquidationParams !== undefined &&
+        liquidationParams.maxLiqSpreadP > 0 &&
+        spreadP > liquidationParams.maxLiqSpreadP
+        ? liquidationParams.maxLiqSpreadP
+        : spreadP;
+};
+exports.getSpreadP = getSpreadP;
+/**
+ * @dev Gets spread with cumulative volume price impact
+ * @dev This combines base spread + cumulative volume impact
+ * @param pairSpreadP Base pair spread percentage
+ * @param buy True for long, false for short
+ * @param collateral Collateral amount
+ * @param leverage Position leverage
+ * @param pairDepth 1% depth values for the pair
+ * @param oiWindowsSettings OI windows configuration
+ * @param oiWindows Current OI windows data
+ * @param context Additional context for the calculation
+ * @returns Total spread + cumulative volume price impact percentage
+ */
+const getSpreadWithCumulVolPriceImpactP = (pairSpreadP, buy, collateral, leverage, pairDepth, oiWindowsSettings, oiWindows, context) => {
+    if (pairSpreadP === undefined) {
+        return 0;
+    }
+    const baseSpread = (0, exports.getSpreadP)(pairSpreadP, undefined, undefined, context === null || context === void 0 ? void 0 : context.userPriceImpact);
+    // Calculate position size in USD
+    const positionSizeUsd = collateral * leverage * ((context === null || context === void 0 ? void 0 : context.collateralPriceUsd) || 1);
+    const cumulVolImpact = (0, exports.getTradeCumulVolPriceImpactP)("", // trader - not used in calculation
+    0, // pairIndex - not used in calculation
+    buy, positionSizeUsd, (context === null || context === void 0 ? void 0 : context.isPnlPositive) || false, (context === null || context === void 0 ? void 0 : context.isOpen) !== false, (context === null || context === void 0 ? void 0 : context.createdBlock) || 0, Object.assign(Object.assign({}, context), { pairDepth,
+        oiWindowsSettings,
+        oiWindows }));
+    // If no depth or OI data, return just half spread
+    if (cumulVolImpact === 0 && (!pairDepth || !oiWindowsSettings)) {
+        return pairSpreadP / 2;
+    }
+    return baseSpread + cumulVolImpact;
+};
+exports.getSpreadWithCumulVolPriceImpactP = getSpreadWithCumulVolPriceImpactP;
+/**
+ * @dev Convenience function for calculating cumulative volume price impact
+ * @dev Uses collateral and leverage instead of USD position size
+ * @param buy True for long, false for short
+ * @param collateral Collateral amount
+ * @param leverage Position leverage
+ * @param open True for opening, false for closing
+ * @param context Full context including depths, OI data, and collateral price
+ * @returns Cumulative volume price impact percentage
+ */
+const getCumulVolPriceImpact = (buy, collateral, leverage, open, context) => {
+    const positionSizeUsd = collateral * leverage * context.collateralPriceUsd;
+    return (0, exports.getTradeCumulVolPriceImpactP)("", // trader - not used in calculation
+    0, // pairIndex - not used in calculation
+    buy, positionSizeUsd, context.isPnlPositive || false, open, context.createdBlock || 0, context);
+};
+exports.getCumulVolPriceImpact = getCumulVolPriceImpact;
+// Legacy export for backward compatibility
+exports.getSpreadWithPriceImpactP = exports.getSpreadWithCumulVolPriceImpactP;
+// Export converters
+var converter_1 = require("./converter");
+Object.defineProperty(exports, "convertOiWindowsSettings", { enumerable: true, get: function () { return converter_1.convertOiWindowsSettings; } });
+Object.defineProperty(exports, "convertOiWindow", { enumerable: true, get: function () { return converter_1.convertOiWindow; } });
+Object.defineProperty(exports, "convertOiWindows", { enumerable: true, get: function () { return converter_1.convertOiWindows; } });
+Object.defineProperty(exports, "convertOiWindowsSettingsArray", { enumerable: true, get: function () { return converter_1.convertOiWindowsSettingsArray; } });
+// Export builder
+var builder_1 = require("./builder");
+Object.defineProperty(exports, "buildCumulVolContext", { enumerable: true, get: function () { return builder_1.buildCumulVolContext; } });

package/lib/trade/priceImpact/index.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @dev Main price impact module
+ * @dev Exports cumulative volume, skew, and combined opening/closing price impact functionality
+ */
+export { getTradeOpeningPriceImpact, getTradeOpeningPriceImpactAtMarket, buildTradeOpeningPriceImpactContext, TradeOpeningPriceImpactInput, TradeOpeningPriceImpactContext, TradeOpeningPriceImpactResult, } from "./open";
+export { getTradeClosingPriceImpact, getTradeClosingPriceImpactAtOracle, buildTradeClosingPriceImpactContext, TradeClosingPriceImpactInput, TradeClosingPriceImpactContext, TradeClosingPriceImpactResult, } from "./close";
+export { getTradeCumulVolPriceImpactP, getCumulVolPriceImpact, // Convenience function
+getSpreadWithCumulVolPriceImpactP, getSpreadWithPriceImpactP, // Legacy alias
+getProtectionCloseFactor, isProtectionCloseFactorActive, getCumulativeFactor, getLegacyFactor, getFixedSpreadP, getSpreadP, convertOiWindowsSettings, convertOiWindow, convertOiWindows, convertOiWindowsSettingsArray, buildCumulVolContext, CumulVolContext, } from "./cumulVol";
+export { getNetSkewToken, getNetSkewCollateral, getTradeSkewDirection, calculateSkewPriceImpactP, getTradeSkewPriceImpact, getTradeSkewPriceImpactWithChecks, calculatePartialSizeToken, SkewPriceImpact, } from "./skew";
+export { convertPairOiToken, convertPairOiTokenArray, convertPairOiCollateral, convertPairOiCollateralArray, convertSkewDepth, convertPairSkewDepths, } from "./skew/converter";
+export { buildSkewPriceImpactContext } from "./skew/builder";
+export type { PairOiToken, PairOiCollateral, SkewPriceImpactInput, SkewPriceImpactResult, SkewPriceImpactContext, TradeSkewParams, PositionSizeResult, } from "./skew/types";

package/lib/trade/priceImpact/index.js

@@ -0,0 +1,64 @@
+"use strict";
+/**
+ * @dev Main price impact module
+ * @dev Exports cumulative volume, skew, and combined opening/closing price impact functionality
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildSkewPriceImpactContext = exports.convertPairSkewDepths = exports.convertSkewDepth = exports.convertPairOiCollateralArray = exports.convertPairOiCollateral = exports.convertPairOiTokenArray = exports.convertPairOiToken = exports.SkewPriceImpact = exports.calculatePartialSizeToken = exports.getTradeSkewPriceImpactWithChecks = exports.getTradeSkewPriceImpact = exports.calculateSkewPriceImpactP = exports.getTradeSkewDirection = exports.getNetSkewCollateral = exports.getNetSkewToken = exports.buildCumulVolContext = exports.convertOiWindowsSettingsArray = exports.convertOiWindows = exports.convertOiWindow = exports.convertOiWindowsSettings = exports.getSpreadP = exports.getFixedSpreadP = exports.getLegacyFactor = exports.getCumulativeFactor = exports.isProtectionCloseFactorActive = exports.getProtectionCloseFactor = exports.getSpreadWithPriceImpactP = exports.getSpreadWithCumulVolPriceImpactP = exports.getCumulVolPriceImpact = exports.getTradeCumulVolPriceImpactP = exports.buildTradeClosingPriceImpactContext = exports.getTradeClosingPriceImpactAtOracle = exports.getTradeClosingPriceImpact = exports.buildTradeOpeningPriceImpactContext = exports.getTradeOpeningPriceImpactAtMarket = exports.getTradeOpeningPriceImpact = void 0;
+// Export trade opening price impact functionality
+var open_1 = require("./open");
+// Core functions
+Object.defineProperty(exports, "getTradeOpeningPriceImpact", { enumerable: true, get: function () { return open_1.getTradeOpeningPriceImpact; } });
+Object.defineProperty(exports, "getTradeOpeningPriceImpactAtMarket", { enumerable: true, get: function () { return open_1.getTradeOpeningPriceImpactAtMarket; } });
+// Builder
+Object.defineProperty(exports, "buildTradeOpeningPriceImpactContext", { enumerable: true, get: function () { return open_1.buildTradeOpeningPriceImpactContext; } });
+// Export trade closing price impact functionality
+var close_1 = require("./close");
+// Core functions
+Object.defineProperty(exports, "getTradeClosingPriceImpact", { enumerable: true, get: function () { return close_1.getTradeClosingPriceImpact; } });
+Object.defineProperty(exports, "getTradeClosingPriceImpactAtOracle", { enumerable: true, get: function () { return close_1.getTradeClosingPriceImpactAtOracle; } });
+// Builder
+Object.defineProperty(exports, "buildTradeClosingPriceImpactContext", { enumerable: true, get: function () { return close_1.buildTradeClosingPriceImpactContext; } });
+// Export cumulative volume price impact functionality
+var cumulVol_1 = require("./cumulVol");
+// Core functions
+Object.defineProperty(exports, "getTradeCumulVolPriceImpactP", { enumerable: true, get: function () { return cumulVol_1.getTradeCumulVolPriceImpactP; } });
+Object.defineProperty(exports, "getCumulVolPriceImpact", { enumerable: true, get: function () { return cumulVol_1.getCumulVolPriceImpact; } });
+Object.defineProperty(exports, "getSpreadWithCumulVolPriceImpactP", { enumerable: true, get: function () { return cumulVol_1.getSpreadWithCumulVolPriceImpactP; } });
+Object.defineProperty(exports, "getSpreadWithPriceImpactP", { enumerable: true, get: function () { return cumulVol_1.getSpreadWithPriceImpactP; } });
+Object.defineProperty(exports, "getProtectionCloseFactor", { enumerable: true, get: function () { return cumulVol_1.getProtectionCloseFactor; } });
+Object.defineProperty(exports, "isProtectionCloseFactorActive", { enumerable: true, get: function () { return cumulVol_1.isProtectionCloseFactorActive; } });
+Object.defineProperty(exports, "getCumulativeFactor", { enumerable: true, get: function () { return cumulVol_1.getCumulativeFactor; } });
+Object.defineProperty(exports, "getLegacyFactor", { enumerable: true, get: function () { return cumulVol_1.getLegacyFactor; } });
+Object.defineProperty(exports, "getFixedSpreadP", { enumerable: true, get: function () { return cumulVol_1.getFixedSpreadP; } });
+Object.defineProperty(exports, "getSpreadP", { enumerable: true, get: function () { return cumulVol_1.getSpreadP; } });
+// Converters
+Object.defineProperty(exports, "convertOiWindowsSettings", { enumerable: true, get: function () { return cumulVol_1.convertOiWindowsSettings; } });
+Object.defineProperty(exports, "convertOiWindow", { enumerable: true, get: function () { return cumulVol_1.convertOiWindow; } });
+Object.defineProperty(exports, "convertOiWindows", { enumerable: true, get: function () { return cumulVol_1.convertOiWindows; } });
+Object.defineProperty(exports, "convertOiWindowsSettingsArray", { enumerable: true, get: function () { return cumulVol_1.convertOiWindowsSettingsArray; } });
+// Builder
+Object.defineProperty(exports, "buildCumulVolContext", { enumerable: true, get: function () { return cumulVol_1.buildCumulVolContext; } });
+// Export skew price impact functionality
+var skew_1 = require("./skew");
+// Core functions
+Object.defineProperty(exports, "getNetSkewToken", { enumerable: true, get: function () { return skew_1.getNetSkewToken; } });
+Object.defineProperty(exports, "getNetSkewCollateral", { enumerable: true, get: function () { return skew_1.getNetSkewCollateral; } });
+Object.defineProperty(exports, "getTradeSkewDirection", { enumerable: true, get: function () { return skew_1.getTradeSkewDirection; } });
+Object.defineProperty(exports, "calculateSkewPriceImpactP", { enumerable: true, get: function () { return skew_1.calculateSkewPriceImpactP; } });
+Object.defineProperty(exports, "getTradeSkewPriceImpact", { enumerable: true, get: function () { return skew_1.getTradeSkewPriceImpact; } });
+Object.defineProperty(exports, "getTradeSkewPriceImpactWithChecks", { enumerable: true, get: function () { return skew_1.getTradeSkewPriceImpactWithChecks; } });
+Object.defineProperty(exports, "calculatePartialSizeToken", { enumerable: true, get: function () { return skew_1.calculatePartialSizeToken; } });
+// Types namespace
+Object.defineProperty(exports, "SkewPriceImpact", { enumerable: true, get: function () { return skew_1.SkewPriceImpact; } });
+// Export converters
+var converter_1 = require("./skew/converter");
+Object.defineProperty(exports, "convertPairOiToken", { enumerable: true, get: function () { return converter_1.convertPairOiToken; } });
+Object.defineProperty(exports, "convertPairOiTokenArray", { enumerable: true, get: function () { return converter_1.convertPairOiTokenArray; } });
+Object.defineProperty(exports, "convertPairOiCollateral", { enumerable: true, get: function () { return converter_1.convertPairOiCollateral; } });
+Object.defineProperty(exports, "convertPairOiCollateralArray", { enumerable: true, get: function () { return converter_1.convertPairOiCollateralArray; } });
+Object.defineProperty(exports, "convertSkewDepth", { enumerable: true, get: function () { return converter_1.convertSkewDepth; } });
+Object.defineProperty(exports, "convertPairSkewDepths", { enumerable: true, get: function () { return converter_1.convertPairSkewDepths; } });
+// Export builders
+var builder_1 = require("./skew/builder");
+Object.defineProperty(exports, "buildSkewPriceImpactContext", { enumerable: true, get: function () { return builder_1.buildSkewPriceImpactContext; } });

package/lib/trade/priceImpact/open/builder.d.ts

@@ -0,0 +1,21 @@
+import { GlobalTradingVariablesType } from "../../../backend/tradingVariables/types";
+import { TradeOpeningPriceImpactContext } from "./types";
+/**
+ * @dev Builds a complete context for trade opening price impact calculations
+ * @dev Uses sub-context builders to create properly scoped contexts
+ * @param globalTradingVariables The transformed global trading variables from backend
+ * @param collateralIndex The collateral index (1-based)
+ * @param pairIndex The pair index
+ * @param additionalParams Additional parameters not available in trading variables
+ * @returns Complete context ready for getTradeOpeningPriceImpact
+ */
+export declare const buildTradeOpeningPriceImpactContext: (globalTradingVariables: GlobalTradingVariablesType, collateralIndex: number, pairIndex: number, additionalParams: {
+    currentBlock: number;
+    contractsVersion?: number;
+    trader?: string;
+    userPriceImpact?: {
+        cumulVolPriceImpactMultiplier: number;
+        fixedSpreadP: number;
+    };
+    protectionCloseFactorWhitelist?: boolean;
+}) => TradeOpeningPriceImpactContext | undefined;

package/lib/trade/priceImpact/open/builder.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildTradeOpeningPriceImpactContext = void 0;
+const builder_1 = require("../cumulVol/builder");
+const builder_2 = require("../skew/builder");
+/**
+ * @dev Builds a complete context for trade opening price impact calculations
+ * @dev Uses sub-context builders to create properly scoped contexts
+ * @param globalTradingVariables The transformed global trading variables from backend
+ * @param collateralIndex The collateral index (1-based)
+ * @param pairIndex The pair index
+ * @param additionalParams Additional parameters not available in trading variables
+ * @returns Complete context ready for getTradeOpeningPriceImpact
+ */
+const buildTradeOpeningPriceImpactContext = (globalTradingVariables, collateralIndex, pairIndex, additionalParams) => {
+    var _a;
+    const collateral = globalTradingVariables.collaterals[collateralIndex - 1];
+    if (!collateral) {
+        return undefined;
+    }
+    // Build cumulative volume subcontext
+    const cumulVolContext = (0, builder_1.buildCumulVolContext)(globalTradingVariables, collateralIndex, pairIndex, {
+        currentBlock: additionalParams.currentBlock,
+        contractsVersion: additionalParams.contractsVersion,
+        isPnlPositive: false,
+        isOpen: true,
+        createdBlock: undefined,
+        userPriceImpact: additionalParams.userPriceImpact,
+        protectionCloseFactorWhitelist: additionalParams.protectionCloseFactorWhitelist,
+    });
+    // Build skew price impact subcontext
+    const skewContext = (0, builder_2.buildSkewPriceImpactContext)(collateral, pairIndex);
+    if (!cumulVolContext || !skewContext) {
+        return undefined;
+    }
+    // Return structured context with proper subcontexts
+    return {
+        collateralPriceUsd: ((_a = collateral.prices) === null || _a === void 0 ? void 0 : _a.collateralPriceUsd) || 1,
+        cumulVolContext,
+        skewContext,
+    };
+};
+exports.buildTradeOpeningPriceImpactContext = buildTradeOpeningPriceImpactContext;

package/lib/trade/priceImpact/open/index.d.ts

@@ -0,0 +1,23 @@
+/**
+ * @dev Trade opening price impact calculations
+ * @dev Mirrors contract's TradingCommonUtils.getTradeOpeningPriceImpact
+ */
+import { TradeOpeningPriceImpactInput, TradeOpeningPriceImpactContext, TradeOpeningPriceImpactResult } from "./types";
+export type { TradeOpeningPriceImpactInput, TradeOpeningPriceImpactContext, TradeOpeningPriceImpactResult, };
+export { buildTradeOpeningPriceImpactContext } from "./builder";
+/**
+ * @dev Calculates all price impacts for trade opening
+ * @dev Mirrors contract's getTradeOpeningPriceImpact function
+ * @param input Trade parameters
+ * @param context Combined context for calculations
+ * @returns Price impact breakdown and final price
+ */
+export declare const getTradeOpeningPriceImpact: (input: TradeOpeningPriceImpactInput, context: TradeOpeningPriceImpactContext) => TradeOpeningPriceImpactResult;
+/**
+ * @dev Simplified version using current market price
+ * @param input Trade parameters
+ * @param context Combined context
+ * @param currentMarketPrice Current market price to use as open price
+ * @returns Price impact breakdown and final price
+ */
+export declare const getTradeOpeningPriceImpactAtMarket: (input: Omit<TradeOpeningPriceImpactInput, "openPrice">, context: TradeOpeningPriceImpactContext, currentMarketPrice: number) => TradeOpeningPriceImpactResult;

package/lib/trade/priceImpact/open/index.js

@@ -0,0 +1,79 @@
+"use strict";
+/**
+ * @dev Trade opening price impact calculations
+ * @dev Mirrors contract's TradingCommonUtils.getTradeOpeningPriceImpact
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getTradeOpeningPriceImpactAtMarket = exports.getTradeOpeningPriceImpact = exports.buildTradeOpeningPriceImpactContext = void 0;
+const cumulVol_1 = require("../cumulVol");
+const skew_1 = require("../skew");
+// Export builder
+var builder_1 = require("./builder");
+Object.defineProperty(exports, "buildTradeOpeningPriceImpactContext", { enumerable: true, get: function () { return builder_1.buildTradeOpeningPriceImpactContext; } });
+/**
+ * @dev Calculates all price impacts for trade opening
+ * @dev Mirrors contract's getTradeOpeningPriceImpact function
+ * @param input Trade parameters
+ * @param context Combined context for calculations
+ * @returns Price impact breakdown and final price
+ */
+const getTradeOpeningPriceImpact = (input, context) => {
+    const positionSizeCollateral = input.collateralAmount * input.leverage;
+    // Calculate fixed spread
+    const spreadP = (0, cumulVol_1.getFixedSpreadP)(input.pairSpreadP, input.long, true // opening
+    );
+    // Calculate position size in USD
+    const positionSizeUsd = positionSizeCollateral * context.collateralPriceUsd;
+    // Calculate cumulative volume price impact
+    const cumulVolPriceImpactP = (0, cumulVol_1.getTradeCumulVolPriceImpactP)("", // trader - not needed for calculation
+    input.pairIndex, input.long, positionSizeUsd, false, // isPnlPositive - not relevant for opening
+    true, // open
+    0, // lastPosIncreaseBlock - not relevant for opening
+    context.cumulVolContext);
+    // Calculate skew price impact (v10+ only)
+    const skewPriceImpactP = (0, skew_1.getTradeSkewPriceImpactWithChecks)({
+        collateralIndex: input.collateralIndex,
+        pairIndex: input.pairIndex,
+        long: input.long,
+        open: true,
+        positionSizeCollateral,
+        currentPrice: input.openPrice,
+        contractsVersion: input.contractsVersion,
+        isCounterTrade: input.isCounterTrade,
+    }, context.skewContext);
+    // Total price impact (signed - can be positive or negative)
+    // Spread is always positive, impacts can be negative
+    const totalPriceImpactP = spreadP + cumulVolPriceImpactP + skewPriceImpactP;
+    // Calculate final price after impact
+    // For longs: price increases with positive impact
+    // For shorts: price decreases with positive impact
+    const priceImpactFactor = 1 + totalPriceImpactP / 100;
+    const priceAfterImpact = input.long
+        ? input.openPrice * priceImpactFactor
+        : input.openPrice / priceImpactFactor;
+    // Calculate percent profit from impact
+    // Positive when trader benefits, negative when trader loses
+    const percentProfitP = input.long
+        ? -totalPriceImpactP // Long loses when price goes up
+        : totalPriceImpactP; // Short gains when price goes up
+    return {
+        priceAfterImpact,
+        priceImpactP: Math.abs(totalPriceImpactP),
+        percentProfitP,
+        cumulVolPriceImpactP,
+        skewPriceImpactP,
+        totalPriceImpactP,
+    };
+};
+exports.getTradeOpeningPriceImpact = getTradeOpeningPriceImpact;
+/**
+ * @dev Simplified version using current market price
+ * @param input Trade parameters
+ * @param context Combined context
+ * @param currentMarketPrice Current market price to use as open price
+ * @returns Price impact breakdown and final price
+ */
+const getTradeOpeningPriceImpactAtMarket = (input, context, currentMarketPrice) => {
+    return (0, exports.getTradeOpeningPriceImpact)(Object.assign(Object.assign({}, input), { openPrice: currentMarketPrice }), context);
+};
+exports.getTradeOpeningPriceImpactAtMarket = getTradeOpeningPriceImpactAtMarket;

package/lib/trade/priceImpact/open/types.d.ts

@@ -0,0 +1,42 @@
+/**
+ * @dev Types for trade opening price impact calculations
+ */
+import { CumulVolContext } from "../cumulVol";
+import { SkewPriceImpactContext } from "../skew/types";
+import { Fee, PairIndex } from "../../types";
+/**
+ * @dev Input parameters for trade opening price impact
+ */
+export type TradeOpeningPriceImpactInput = {
+    collateralIndex: number;
+    pairIndex: PairIndex;
+    long: boolean;
+    collateralAmount: number;
+    leverage: number;
+    openPrice: number;
+    pairSpreadP: number;
+    fee: Fee;
+    contractsVersion: number;
+    isCounterTrade?: boolean;
+};
+/**
+ * @dev Context for trade opening price impact calculation
+ * Combines contexts from spread, cumul vol, and skew
+ */
+export type TradeOpeningPriceImpactContext = {
+    collateralPriceUsd: number;
+    cumulVolContext: CumulVolContext;
+    skewContext: SkewPriceImpactContext;
+};
+/**
+ * @dev Result of trade opening price impact calculation
+ * Mirrors contract's PriceImpact struct
+ */
+export type TradeOpeningPriceImpactResult = {
+    priceAfterImpact: number;
+    priceImpactP: number;
+    percentProfitP: number;
+    cumulVolPriceImpactP: number;
+    skewPriceImpactP: number;
+    totalPriceImpactP: number;
+};

package/lib/trade/priceImpact/open/types.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * @dev Types for trade opening price impact calculations
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/trade/priceImpact/skew/builder.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @dev Builders for skew price impact contexts
+ */
+import { TradingVariablesCollateral } from "../../../backend/tradingVariables/types";
+import { SkewPriceImpactContext } from "./types";
+/**
+ * @dev Builds skew price impact context from trading variables for a specific pair
+ * @param tradingVariables Trading variables containing collateral data
+ * @param pairIndex Index of the pair to build context for
+ * @returns Skew price impact context for the pair
+ */
+export declare const buildSkewPriceImpactContext: (tradingVariables: TradingVariablesCollateral, pairIndex: number) => SkewPriceImpactContext;

package/lib/trade/priceImpact/skew/builder.js

@@ -0,0 +1,28 @@
+"use strict";
+/**
+ * @dev Builders for skew price impact contexts
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildSkewPriceImpactContext = void 0;
+/**
+ * @dev Builds skew price impact context from trading variables for a specific pair
+ * @param tradingVariables Trading variables containing collateral data
+ * @param pairIndex Index of the pair to build context for
+ * @returns Skew price impact context for the pair
+ */
+const buildSkewPriceImpactContext = (tradingVariables, pairIndex) => {
+    var _a, _b, _c;
+    const skewDepth = (_b = (_a = tradingVariables.pairSkewDepths) === null || _a === void 0 ? void 0 : _a[pairIndex]) !== null && _b !== void 0 ? _b : 0;
+    const pairOi = (_c = tradingVariables.pairOis) === null || _c === void 0 ? void 0 : _c[pairIndex];
+    if (!pairOi) {
+        throw new Error(`Pair OI data not found for pair index ${pairIndex}`);
+    }
+    return {
+        skewDepth,
+        pairOiToken: {
+            oiLongToken: pairOi.token.long,
+            oiShortToken: pairOi.token.short,
+        },
+    };
+};
+exports.buildSkewPriceImpactContext = buildSkewPriceImpactContext;

package/lib/trade/priceImpact/skew/converter.d.ts

@@ -0,0 +1,46 @@
+/**
+ * @dev Converters for skew price impact data between contract and SDK formats
+ * @dev All BigNumber values are normalized to floats with appropriate precision
+ */
+import { IPriceImpact } from "../../../contracts/types/generated/GNSMultiCollatDiamond";
+import { PairOiToken, PairOiCollateral } from "./types";
+/**
+ * @dev Converts contract pair OI token data to SDK format
+ * @param contractData Contract pair OI token struct
+ * @returns Normalized pair OI token data
+ */
+export declare const convertPairOiToken: (contractData: IPriceImpact.PairOiTokenStruct) => PairOiToken;
+/**
+ * @dev Converts array of contract pair OI token data to SDK format
+ * @param contractDataArray Array of contract pair OI token data
+ * @returns Array of normalized pair OI token data
+ */
+export declare const convertPairOiTokenArray: (contractDataArray: IPriceImpact.PairOiTokenStruct[]) => PairOiToken[];
+/**
+ * @dev Converts contract pair OI collateral data to SDK format
+ * @param contractData Contract pair OI collateral struct
+ * @param collateralDecimals Number of decimals for the collateral (e.g., 18 for DAI, 6 for USDC)
+ * @returns Normalized pair OI collateral data
+ */
+export declare const convertPairOiCollateral: (contractData: IPriceImpact.PairOiCollateralStruct, collateralDecimals: number) => PairOiCollateral;
+/**
+ * @dev Converts array of contract pair OI collateral data to SDK format
+ * @param contractDataArray Array of contract pair OI collateral data
+ * @param collateralDecimals Array of collateral decimals for each entry
+ * @returns Array of normalized pair OI collateral data
+ */
+export declare const convertPairOiCollateralArray: (contractDataArray: IPriceImpact.PairOiCollateralStruct[], collateralDecimals: number[]) => PairOiCollateral[];
+/**
+ * @dev Converts skew depth from contract format to SDK format
+ * @param depth Skew depth from contract (in token units with 1e18 precision)
+ * @returns Normalized skew depth in tokens
+ */
+export declare const convertSkewDepth: (depth: string) => number;
+/**
+ * @dev Converts array of skew depths from contract format to SDK format
+ * @param depths Array of skew depths from contract (in token units with 1e18 precision)
+ * @returns Object mapping pair index to normalized depth
+ */
+export declare const convertPairSkewDepths: (depths: string[]) => {
+    [pairIndex: number]: number;
+};