@gainsnetwork/sdk 0.2.71-rc4 → 1.0.0-rc1

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

@@ -0,0 +1,22 @@
+import { GlobalTradingVariablesType } from "../../../backend/tradingVariables/types";
+import { CumulVolContext } from "./index";
+/**
+ * @dev Builds cumulative volume price impact sub-context for a specific pair
+ * @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 Cumulative volume context ready for getTradeCumulVolPriceImpactP
+ */
+export declare const buildCumulVolContext: (globalTradingVariables: GlobalTradingVariablesType, collateralIndex: number, pairIndex: number, additionalParams: {
+    currentBlock: number;
+    contractsVersion?: number;
+    isPnlPositive?: boolean;
+    isOpen?: boolean;
+    createdBlock?: number;
+    userPriceImpact?: {
+        cumulVolPriceImpactMultiplier: number;
+        fixedSpreadP: number;
+    };
+    protectionCloseFactorWhitelist?: boolean;
+}) => CumulVolContext | undefined;

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

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildCumulVolContext = void 0;
+/**
+ * @dev Builds cumulative volume price impact sub-context for a specific pair
+ * @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 Cumulative volume context ready for getTradeCumulVolPriceImpactP
+ */
+const buildCumulVolContext = (globalTradingVariables, collateralIndex, pairIndex, additionalParams) => {
+    var _a, _b, _c, _d, _e, _f, _g, _h;
+    const collateral = globalTradingVariables.collaterals[collateralIndex - 1];
+    if (!collateral) {
+        return undefined;
+    }
+    // Get pair-specific data from global variables
+    const pairDepth = (_a = globalTradingVariables.pairDepths) === null || _a === void 0 ? void 0 : _a[pairIndex];
+    const pairFactor = (_b = globalTradingVariables.pairFactors) === null || _b === void 0 ? void 0 : _b[pairIndex];
+    const oiWindows = (_c = globalTradingVariables.oiWindows) === null || _c === void 0 ? void 0 : _c[pairIndex];
+    // Get OI windows settings (same for all pairs)
+    // OI windows settings from global trading variables are already in SDK format
+    const oiWindowsSettings = globalTradingVariables.oiWindowsSettings;
+    // Get user-specific parameters from additionalParams
+    const userPriceImpact = additionalParams.userPriceImpact;
+    const protectionCloseFactorWhitelist = additionalParams.protectionCloseFactorWhitelist;
+    // Get liquidation params - check both pair and group level
+    const liquidationParams = ((_e = (_d = globalTradingVariables.liquidationParams) === null || _d === void 0 ? void 0 : _d.pairs) === null || _e === void 0 ? void 0 : _e[pairIndex]) ||
+        ((_g = (_f = globalTradingVariables.liquidationParams) === null || _f === void 0 ? void 0 : _f.groups) === null || _g === void 0 ? void 0 : _g[0]); // fallback to first group
+    return Object.assign({ 
+        // Trade state
+        isOpen: additionalParams.isOpen, isPnlPositive: additionalParams.isPnlPositive, createdBlock: additionalParams.createdBlock, 
+        // Protection factors
+        liquidationParams, currentBlock: additionalParams.currentBlock, contractsVersion: additionalParams.contractsVersion, protectionCloseFactorWhitelist,
+        // Price impact data
+        pairDepth,
+        oiWindowsSettings,
+        oiWindows,
+        // User/collateral specific
+        userPriceImpact, collateralPriceUsd: ((_h = collateral.prices) === null || _h === void 0 ? void 0 : _h.collateralPriceUsd) || 1 }, pairFactor);
+};
+exports.buildCumulVolContext = buildCumulVolContext;

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

@@ -0,0 +1,31 @@
+/**
+ * @dev Converters for cumulative volume 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 { OiWindowsSettings, OiWindow, OiWindows } from "../../types";
+/**
+ * @dev Converts contract OI windows settings to SDK format
+ * @param contractData Contract OiWindowsSettings struct
+ * @returns Normalized OI windows settings
+ */
+export declare const convertOiWindowsSettings: (contractData: IPriceImpact.OiWindowsSettingsStructOutput) => OiWindowsSettings;
+/**
+ * @dev Converts contract PairOi data to SDK OiWindow format
+ * @param contractData Contract PairOi struct with USD values
+ * @returns Normalized OI window data
+ */
+export declare const convertOiWindow: (contractData: IPriceImpact.PairOiStructOutput) => OiWindow;
+/**
+ * @dev Converts array of OI windows from contract format
+ * @param windowIds Array of window IDs (as strings for mapping)
+ * @param contractWindows Array of PairOi data from contract
+ * @returns Normalized OI windows mapping
+ */
+export declare const convertOiWindows: (windowIds: string[], contractWindows: IPriceImpact.PairOiStructOutput[]) => OiWindows;
+/**
+ * @dev Batch converter for multiple OI windows settings
+ * @param contractDataArray Array of contract OiWindowsSettings
+ * @returns Array of normalized OI windows settings
+ */
+export declare const convertOiWindowsSettingsArray: (contractDataArray: IPriceImpact.OiWindowsSettingsStructOutput[]) => OiWindowsSettings[];

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

@@ -0,0 +1,59 @@
+"use strict";
+/**
+ * @dev Converters for cumulative volume price impact data between contract and SDK formats
+ * @dev All BigNumber values are normalized to floats with appropriate precision
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.convertOiWindowsSettingsArray = exports.convertOiWindows = exports.convertOiWindow = exports.convertOiWindowsSettings = void 0;
+/**
+ * @dev Converts contract OI windows settings to SDK format
+ * @param contractData Contract OiWindowsSettings struct
+ * @returns Normalized OI windows settings
+ */
+const convertOiWindowsSettings = (contractData) => {
+    return {
+        startTs: Number(contractData.startTs),
+        windowsDuration: Number(contractData.windowsDuration),
+        windowsCount: Number(contractData.windowsCount),
+    };
+};
+exports.convertOiWindowsSettings = convertOiWindowsSettings;
+/**
+ * @dev Converts contract PairOi data to SDK OiWindow format
+ * @param contractData Contract PairOi struct with USD values
+ * @returns Normalized OI window data
+ */
+const convertOiWindow = (contractData) => {
+    // USD values are stored as 1e18 in contract
+    return {
+        oiLongUsd: Number(contractData.oiLongUsd) / 1e18,
+        oiShortUsd: Number(contractData.oiShortUsd) / 1e18,
+    };
+};
+exports.convertOiWindow = convertOiWindow;
+/**
+ * @dev Converts array of OI windows from contract format
+ * @param windowIds Array of window IDs (as strings for mapping)
+ * @param contractWindows Array of PairOi data from contract
+ * @returns Normalized OI windows mapping
+ */
+const convertOiWindows = (windowIds, contractWindows) => {
+    if (windowIds.length !== contractWindows.length) {
+        throw new Error("Window IDs and data arrays must have the same length");
+    }
+    const windows = {};
+    windowIds.forEach((id, index) => {
+        windows[id] = (0, exports.convertOiWindow)(contractWindows[index]);
+    });
+    return windows;
+};
+exports.convertOiWindows = convertOiWindows;
+/**
+ * @dev Batch converter for multiple OI windows settings
+ * @param contractDataArray Array of contract OiWindowsSettings
+ * @returns Array of normalized OI windows settings
+ */
+const convertOiWindowsSettingsArray = (contractDataArray) => {
+    return contractDataArray.map(exports.convertOiWindowsSettings);
+};
+exports.convertOiWindowsSettingsArray = convertOiWindowsSettingsArray;

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

@@ -0,0 +1,108 @@
+/**
+ * @dev Cumulative volume price impact calculations
+ * @dev Mirrors contract's getTradeCumulVolPriceImpactP functionality
+ */
+import { LiquidationParams, OiWindows, OiWindowsSettings, PairDepth, PairFactor, UserPriceImpact } from "../../types";
+import { ContractsVersion } from "../../../contracts/types";
+export type CumulVolContext = {
+    isOpen?: boolean;
+    isPnlPositive?: boolean;
+    createdBlock?: number;
+    liquidationParams?: LiquidationParams | undefined;
+    currentBlock?: number | undefined;
+    contractsVersion?: ContractsVersion | undefined;
+    protectionCloseFactorWhitelist?: boolean;
+    pairDepth?: PairDepth | undefined;
+    oiWindowsSettings?: OiWindowsSettings | undefined;
+    oiWindows?: OiWindows | undefined;
+    userPriceImpact?: UserPriceImpact | undefined;
+    collateralPriceUsd?: number;
+} & Partial<PairFactor>;
+/**
+ * @dev Gets the protection close factor with user multiplier
+ * @param context Cumulative volume context
+ * @returns Protection close factor (1 = 100%)
+ */
+export declare const getProtectionCloseFactor: (context: CumulVolContext | undefined) => number;
+/**
+ * @dev Checks if protection close factor is active
+ * @param context Cumulative volume context
+ * @returns True if protection close factor should be applied
+ */
+export declare const isProtectionCloseFactorActive: (context: CumulVolContext | undefined) => boolean | undefined;
+/**
+ * @dev Gets the cumulative factor for price impact calculation
+ * @param context Cumulative volume context
+ * @returns Cumulative factor (default 1)
+ */
+export declare const getCumulativeFactor: (context: CumulVolContext | undefined) => number;
+/**
+ * @dev Gets the legacy factor for v9.2 compatibility
+ * @param context Cumulative volume context
+ * @returns 1 for pre-v9.2, 2 for v9.2+
+ */
+export declare const getLegacyFactor: (context: CumulVolContext | undefined) => number;
+/**
+ * @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)
+ */
+export declare const getTradeCumulVolPriceImpactP: (trader: string, pairIndex: number, long: boolean, tradeOpenInterestUsd: number, isPnlPositive: boolean, open: boolean, lastPosIncreaseBlock: number, context: CumulVolContext) => number;
+/**
+ * @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)
+ */
+export declare const getFixedSpreadP: (spreadP: number, long: boolean, open: boolean) => number;
+/**
+ * @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
+ */
+export declare const getSpreadP: (pairSpreadP: number | undefined, isLiquidation?: boolean | undefined, liquidationParams?: LiquidationParams | undefined, userPriceImpact?: UserPriceImpact | undefined) => number;
+/**
+ * @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
+ */
+export declare const getSpreadWithCumulVolPriceImpactP: (pairSpreadP: number, buy: boolean, collateral: number, leverage: number, pairDepth: PairDepth | undefined, oiWindowsSettings?: OiWindowsSettings | undefined, oiWindows?: OiWindows | undefined, context?: CumulVolContext | undefined) => number;
+/**
+ * @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
+ */
+export declare const getCumulVolPriceImpact: (buy: boolean, collateral: number, leverage: number, open: boolean, context: CumulVolContext & {
+    collateralPriceUsd: number;
+}) => number;
+export declare const getSpreadWithPriceImpactP: (pairSpreadP: number, buy: boolean, collateral: number, leverage: number, pairDepth: PairDepth | undefined, oiWindowsSettings?: OiWindowsSettings | undefined, oiWindows?: OiWindows | undefined, context?: CumulVolContext | undefined) => number;
+export { convertOiWindowsSettings, convertOiWindow, convertOiWindows, convertOiWindowsSettingsArray, } from "./converter";
+export { buildCumulVolContext } from "./builder";

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

@@ -0,0 +1,235 @@
+"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;
+    // 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;
+    }
+    // Calculate trade skew direction (matches Solidity logic)
+    const tradePositiveSkew = (long && open) || (!long && !open);
+    const tradeSkewMultiplier = tradePositiveSkew ? 1 : -1;
+    // Select depth based on trade direction
+    // For positive skew (long open or short close), use depth above
+    // For negative skew (short open or long close), use depth below
+    const onePercentDepth = tradePositiveSkew
+        ? (_a = context.pairDepth) === null || _a === void 0 ? void 0 : _a.onePercentDepthAboveUsd
+        : (_b = context.pairDepth) === null || _b === void 0 ? void 0 : _b.onePercentDepthBelowUsd;
+    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;
+    }
+    // Apply trade skew multiplier to match Solidity's signed calculation
+    const signedActiveOi = activeOi * tradeSkewMultiplier;
+    const signedTradeOi = tradeOpenInterestUsd * tradeSkewMultiplier;
+    // Calculate impact with proper signs (matching Solidity's _getTradePriceImpactP)
+    const finalPriceImpactP = ((signedActiveOi * (0, exports.getCumulativeFactor)(updatedContext) +
+        signedTradeOi / 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,21 @@
+/**
+ * @dev Main price impact module
+ * @dev Exports cumulative volume, skew, and combined opening/closing price impact functionality
+ */
+/**
+ * @dev Calculates price after impact using the same formula as the Solidity contract
+ * @dev Mirrors contract's getPriceAfterImpact function
+ * @param oraclePrice Base oracle price (no decimals requirement)
+ * @param totalPriceImpactP Total price impact percentage (can be positive or negative)
+ * @returns Price after impact has been applied
+ */
+export declare const getPriceAfterImpact: (oraclePrice: number, totalPriceImpactP: number) => number;
+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, 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,79 @@
+"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.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 = exports.getPriceAfterImpact = void 0;
+/**
+ * @dev Calculates price after impact using the same formula as the Solidity contract
+ * @dev Mirrors contract's getPriceAfterImpact function
+ * @param oraclePrice Base oracle price (no decimals requirement)
+ * @param totalPriceImpactP Total price impact percentage (can be positive or negative)
+ * @returns Price after impact has been applied
+ */
+const getPriceAfterImpact = (oraclePrice, totalPriceImpactP) => {
+    // Match Solidity: price = oraclePrice + (oraclePrice * totalPriceImpactP / 100)
+    const priceAfterImpact = oraclePrice * (1 + totalPriceImpactP / 100);
+    if (priceAfterImpact <= 0) {
+        throw new Error("Price after impact must be positive");
+    }
+    return priceAfterImpact;
+};
+exports.getPriceAfterImpact = getPriceAfterImpact;
+// 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, "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;