@gainsnetwork/sdk 1.0.2-rc1 → 1.0.2-rc3

package/lib/trade/fees/holdingFees/index.js

@@ -1,105 +0,0 @@
-"use strict";
-/**
- * @dev Holding fees calculation utilities for v10+ markets
- * @dev Combines funding fees and borrowing v2 fees
- */
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.HoldingFees = exports.formatHoldingFeeRate = exports.convertRatePerSecondToAPR = exports.getPairHoldingFeeRates = void 0;
-const fundingFees_1 = require("../fundingFees");
-const SECONDS_PER_HOUR = 3600;
-const SECONDS_PER_YEAR = 365 * 24 * 60 * 60;
-const PERCENTAGE_PRECISION = 100;
-/**
- * @dev Calculates current holding fee rates per hour for display
- * @param input Input parameters for calculation
- * @returns Holding fee rates per hour with breakdown
- */
-const getPairHoldingFeeRates = (input) => {
-    const { fundingParams, fundingData, pairOiToken, netExposureToken, netExposureUsd, borrowingParams, borrowingData, currentPairPrice, currentTimestamp, } = input;
-    // Calculate funding fee rates
-    let fundingFeeLongHourlyRate = 0;
-    let fundingFeeShortHourlyRate = 0;
-    let currentFundingRatePerSecondP = 0;
-    if (fundingParams.fundingFeesEnabled) {
-        // Get current funding rate
-        const pendingFunding = (0, fundingFees_1.getPairPendingAccFundingFees)(fundingParams, fundingData, currentPairPrice, pairOiToken, netExposureToken, netExposureUsd, currentTimestamp);
-        currentFundingRatePerSecondP = pendingFunding.currentFundingRatePerSecondP;
-        // Get APR multipliers
-        const { longAprMultiplier, shortAprMultiplier } = (0, fundingFees_1.getLongShortAprMultiplier)(currentFundingRatePerSecondP, pairOiToken.oiLongToken, pairOiToken.oiShortToken, fundingParams.aprMultiplierEnabled);
-        // Calculate hourly rates
-        // Funding rate * seconds per hour * current price * APR multiplier / 100
-        const baseHourlyRate = (currentFundingRatePerSecondP * SECONDS_PER_HOUR * currentPairPrice) /
-            PERCENTAGE_PRECISION;
-        // Long side pays when rate is positive, earns when negative
-        fundingFeeLongHourlyRate = baseHourlyRate * longAprMultiplier;
-        // Short side is opposite
-        fundingFeeShortHourlyRate = -baseHourlyRate * shortAprMultiplier;
-    }
-    // Calculate borrowing v2 rates
-    let borrowingFeeHourlyRate = 0;
-    let currentBorrowingRatePerSecondP = 0;
-    if (borrowingParams && borrowingData) {
-        currentBorrowingRatePerSecondP = borrowingParams.borrowingRatePerSecondP;
-        // Borrowing rate * seconds per hour * current price / 100
-        borrowingFeeHourlyRate =
-            (currentBorrowingRatePerSecondP * SECONDS_PER_HOUR * currentPairPrice) /
-                PERCENTAGE_PRECISION;
-    }
-    // Total holding fees (funding can be negative/positive, borrowing always positive cost)
-    const longHourlyRate = fundingFeeLongHourlyRate + borrowingFeeHourlyRate;
-    const shortHourlyRate = fundingFeeShortHourlyRate + borrowingFeeHourlyRate;
-    return {
-        longHourlyRate,
-        shortHourlyRate,
-        fundingFeeLongHourlyRate,
-        fundingFeeShortHourlyRate,
-        borrowingFeeHourlyRate,
-        currentFundingRatePerSecondP,
-        currentBorrowingRatePerSecondP,
-    };
-};
-exports.getPairHoldingFeeRates = getPairHoldingFeeRates;
-/**
- * @dev Converts a per-second rate to annual percentage rate (APR)
- * @param ratePerSecond Rate per second
- * @returns Annual percentage rate
- */
-const convertRatePerSecondToAPR = (ratePerSecond) => {
-    return ratePerSecond * SECONDS_PER_YEAR * PERCENTAGE_PRECISION;
-};
-exports.convertRatePerSecondToAPR = convertRatePerSecondToAPR;
-/**
- * @dev Formats a holding fee rate for display
- * @param rate Hourly rate (can be negative)
- * @param decimals Number of decimal places
- * @returns Formatted string with sign
- */
-const formatHoldingFeeRate = (rate, decimals = 4) => {
-    const sign = rate > 0 ? "+" : "";
-    return `${sign}${rate.toFixed(decimals)}%`;
-};
-exports.formatHoldingFeeRate = formatHoldingFeeRate;
-exports.HoldingFees = __importStar(require("./types"));

package/lib/trade/fees/holdingFees/types.d.ts

@@ -1,23 +0,0 @@
-/**
- * @dev Type definitions for holding fees (funding + borrowing v2)
- */
-export interface HoldingFeeRates {
-    longHourlyRate: number;
-    shortHourlyRate: number;
-    fundingFeeLongHourlyRate: number;
-    fundingFeeShortHourlyRate: number;
-    borrowingFeeHourlyRate: number;
-    currentFundingRatePerSecondP: number;
-    currentBorrowingRatePerSecondP: number;
-}
-export interface GetPairHoldingFeeRatesInput {
-    fundingParams: import("../fundingFees/types").FundingFeeParams;
-    fundingData: import("../fundingFees/types").PairFundingFeeData;
-    pairOiToken: import("../fundingFees/types").PairOiAfterV10;
-    netExposureToken: number;
-    netExposureUsd: number;
-    borrowingParams: import("../borrowingV2/types").BorrowingFeeParams | null;
-    borrowingData: import("../borrowingV2/types").PairBorrowingFeeData | null;
-    currentPairPrice: number;
-    currentTimestamp: number;
-}

package/lib/trade/fees/holdingFees/types.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * @dev Type definitions for holding fees (funding + borrowing v2)
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/lib/trade/fees/trading/holdingFees.d.ts

@@ -1,28 +0,0 @@
-/**
- * @dev Holding fees calculation for structured contexts
- */
-import { Trade, TradeInfo, TradeFeesData } from "../../types";
-import { TradeHoldingFees } from "./types";
-import { ContractsVersion } from "../../../contracts/types";
-import type { BorrowingV1SubContext, BorrowingV2SubContext, FundingFeesSubContext } from "../../pnl";
-/**
- * @dev Context for holding fees calculation with structured sub-contexts
- */
-export type GetStructuredHoldingFeesContext = {
-    contractsVersion: ContractsVersion;
-    currentTimestamp: number;
-    collateralPriceUsd: number;
-    borrowingV1?: BorrowingV1SubContext;
-    borrowingV2?: BorrowingV2SubContext;
-    funding?: FundingFeesSubContext;
-};
-/**
- * @dev Calculates total holding fees using structured context
- * @param trade The trade to calculate fees for
- * @param tradeInfo Trade info containing contracts version
- * @param tradeFeesData Trade fees data containing initial acc fees
- * @param currentPairPrice Current pair price
- * @param context Structured context with sub-contexts for each fee type
- * @returns Object containing all holding fee components
- */
-export declare const getTradePendingHoldingFeesCollateralStructured: (trade: Trade, tradeInfo: TradeInfo, tradeFeesData: TradeFeesData, currentPairPrice: number, context: GetStructuredHoldingFeesContext) => TradeHoldingFees;

package/lib/trade/fees/trading/holdingFees.js

@@ -1,66 +0,0 @@
-"use strict";
-/**
- * @dev Holding fees calculation for structured contexts
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getTradePendingHoldingFeesCollateralStructured = void 0;
-const types_1 = require("../../../contracts/types");
-const borrowing_1 = require("../borrowing");
-const borrowingV2_1 = require("../borrowingV2");
-const pairContext_1 = require("../fundingFees/pairContext");
-/**
- * @dev Calculates total holding fees using structured context
- * @param trade The trade to calculate fees for
- * @param tradeInfo Trade info containing contracts version
- * @param tradeFeesData Trade fees data containing initial acc fees
- * @param currentPairPrice Current pair price
- * @param context Structured context with sub-contexts for each fee type
- * @returns Object containing all holding fee components
- */
-const getTradePendingHoldingFeesCollateralStructured = (trade, tradeInfo, tradeFeesData, currentPairPrice, context) => {
-    const positionSizeCollateral = trade.collateralAmount * trade.leverage;
-    // Calculate funding fees (v10+ only)
-    let fundingFeeCollateral = 0;
-    if (context.contractsVersion >= types_1.ContractsVersion.V10 &&
-        context.funding &&
-        tradeFeesData.initialAccFundingFeeP !== undefined) {
-        fundingFeeCollateral = (0, pairContext_1.getPairTradeFundingFeesCollateral)({
-            positionSizeCollateral,
-            openPrice: trade.openPrice,
-            long: trade.long,
-            currentPairPrice,
-            initialAccFundingFeeP: tradeFeesData.initialAccFundingFeeP,
-        }, context.funding // TODO: Fix types once funding types are properly imported
-        );
-    }
-    // Calculate borrowing fees v2
-    let borrowingFeeCollateral = 0;
-    if (context.borrowingV2 && tradeFeesData.initialAccBorrowingFeeP !== undefined) {
-        borrowingFeeCollateral = (0, borrowingV2_1.getPairTradeBorrowingFeesCollateral)({
-            positionSizeCollateral,
-            openPrice: trade.openPrice,
-            currentPairPrice,
-            initialAccBorrowingFeeP: tradeFeesData.initialAccBorrowingFeeP,
-            currentTimestamp: context.currentTimestamp,
-        }, context.borrowingV2);
-    }
-    // Calculate v1 borrowing fees (some markets use v1 indefinitely)
-    let borrowingFeeCollateral_old = 0;
-    if (context.borrowingV1) {
-        borrowingFeeCollateral_old = (0, borrowing_1.getPairBorrowingFee)(positionSizeCollateral, trade.long, context.borrowingV1.initialAccFees || { accPairFee: 0, accGroupFee: 0, block: 0 }, {
-            currentBlock: context.borrowingV1.currentBlock,
-            group: context.borrowingV1.group,
-            pair: context.borrowingV1.pair,
-            collateralPriceUsd: context.collateralPriceUsd,
-        });
-    }
-    return {
-        fundingFeeCollateral,
-        borrowingFeeCollateral,
-        borrowingFeeCollateral_old,
-        totalFeeCollateral: fundingFeeCollateral +
-            borrowingFeeCollateral +
-            borrowingFeeCollateral_old,
-    };
-};
-exports.getTradePendingHoldingFeesCollateralStructured = getTradePendingHoldingFeesCollateralStructured;

package/lib/trade/fees/trading/holdingFeesStructured.d.ts

@@ -1,28 +0,0 @@
-/**
- * @dev Holding fees calculation for structured contexts
- */
-import { Trade, TradeInfo, TradeFeesData } from "../../types";
-import { TradeHoldingFees } from "./types";
-import { ContractsVersion } from "../../../contracts/types";
-import type { BorrowingV1SubContext, BorrowingV2SubContext, FundingFeesSubContext } from "../../pnl";
-/**
- * @dev Context for holding fees calculation with structured sub-contexts
- */
-export type GetStructuredHoldingFeesContext = {
-    contractsVersion: ContractsVersion;
-    currentTimestamp: number;
-    collateralPriceUsd: number;
-    borrowingV1?: BorrowingV1SubContext;
-    borrowingV2?: BorrowingV2SubContext;
-    funding?: FundingFeesSubContext;
-};
-/**
- * @dev Calculates total holding fees using structured context
- * @param trade The trade to calculate fees for
- * @param tradeInfo Trade info containing contracts version
- * @param tradeFeesData Trade fees data containing initial acc fees
- * @param currentPairPrice Current pair price
- * @param context Structured context with sub-contexts for each fee type
- * @returns Object containing all holding fee components
- */
-export declare const getTradePendingHoldingFeesCollateralStructured: (trade: Trade, tradeInfo: TradeInfo, tradeFeesData: TradeFeesData, currentPairPrice: number, context: GetStructuredHoldingFeesContext) => TradeHoldingFees;

package/lib/trade/fees/trading/holdingFeesStructured.js

@@ -1,66 +0,0 @@
-"use strict";
-/**
- * @dev Holding fees calculation for structured contexts
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getTradePendingHoldingFeesCollateralStructured = void 0;
-const types_1 = require("../../../contracts/types");
-const borrowing_1 = require("../borrowing");
-const borrowingV2_1 = require("../borrowingV2");
-const fundingFees_1 = require("../fundingFees");
-/**
- * @dev Calculates total holding fees using structured context
- * @param trade The trade to calculate fees for
- * @param tradeInfo Trade info containing contracts version
- * @param tradeFeesData Trade fees data containing initial acc fees
- * @param currentPairPrice Current pair price
- * @param context Structured context with sub-contexts for each fee type
- * @returns Object containing all holding fee components
- */
-const getTradePendingHoldingFeesCollateralStructured = (trade, tradeInfo, tradeFeesData, currentPairPrice, context) => {
-    const positionSizeCollateral = trade.collateralAmount * trade.leverage;
-    // Calculate funding fees (v10+ only)
-    let fundingFeeCollateral = 0;
-    if (context.contractsVersion >= types_1.ContractsVersion.V10 &&
-        context.funding &&
-        tradeFeesData.initialAccFundingFeeP !== undefined) {
-        fundingFeeCollateral = (0, fundingFees_1.getTradeFundingFeesCollateral)(trade, tradeInfo, tradeFeesData, currentPairPrice, Object.assign(Object.assign({}, context.funding), { currentTimestamp: context.currentTimestamp }) // TODO: Fix types once funding types are properly imported
-        );
-    }
-    // Calculate borrowing fees v2
-    let borrowingFeeCollateral = 0;
-    if (context.borrowingV2 &&
-        tradeFeesData.initialAccBorrowingFeeP !== undefined) {
-        borrowingFeeCollateral = (0, borrowingV2_1.getTradeBorrowingFeesCollateral)({
-            positionSizeCollateral,
-            openPrice: trade.openPrice,
-            currentPairPrice,
-            initialAccBorrowingFeeP: tradeFeesData.initialAccBorrowingFeeP,
-            currentTimestamp: context.currentTimestamp,
-        }, context.borrowingV2);
-    }
-    // Calculate v1 borrowing fees (some markets use v1 indefinitely)
-    let borrowingFeeCollateral_old = 0;
-    if (context.borrowingV1) {
-        borrowingFeeCollateral_old = (0, borrowing_1.getBorrowingFee)(positionSizeCollateral, undefined, // pairIndex not needed for pair-specific context
-        trade.long, context.borrowingV1.initialAccFees || {
-            accPairFee: 0,
-            accGroupFee: 0,
-            block: 0,
-        }, {
-            currentBlock: context.borrowingV1.currentBlock,
-            group: context.borrowingV1.group,
-            pair: context.borrowingV1.pair,
-            collateralPriceUsd: context.collateralPriceUsd,
-        });
-    }
-    return {
-        fundingFeeCollateral,
-        borrowingFeeCollateral,
-        borrowingFeeCollateral_old,
-        totalFeeCollateral: fundingFeeCollateral +
-            borrowingFeeCollateral +
-            borrowingFeeCollateral_old,
-    };
-};
-exports.getTradePendingHoldingFeesCollateralStructured = getTradePendingHoldingFeesCollateralStructured;