@gainsnetwork/sdk 1.4.2-rc2 → 1.4.2-rc4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/constants.js +1 -0
- package/lib/contracts/types/generated/GFarmTradingStorageV5.d.ts +1911 -0
- package/lib/contracts/types/generated/GFarmTradingStorageV5.js +2 -0
- package/lib/contracts/types/generated/GNSBorrowingFees.d.ts +1067 -0
- package/lib/contracts/types/generated/GNSBorrowingFees.js +2 -0
- package/lib/contracts/types/generated/GNSBorrowingFeesV6_3_2.d.ts +979 -0
- package/lib/contracts/types/generated/GNSBorrowingFeesV6_3_2.js +2 -0
- package/lib/contracts/types/generated/GNSBorrowingFeesV6_4.d.ts +1058 -0
- package/lib/contracts/types/generated/GNSBorrowingFeesV6_4.js +2 -0
- package/lib/contracts/types/generated/GNSNftRewardsV6.d.ts +533 -0
- package/lib/contracts/types/generated/GNSNftRewardsV6.js +2 -0
- package/lib/contracts/types/generated/GNSNftRewardsV6_3_1.d.ts +613 -0
- package/lib/contracts/types/generated/GNSNftRewardsV6_3_1.js +2 -0
- package/lib/contracts/types/generated/GNSPairInfosV6_1.d.ts +911 -0
- package/lib/contracts/types/generated/GNSPairInfosV6_1.js +2 -0
- package/lib/contracts/types/generated/GNSPairsStorageV6.d.ts +660 -0
- package/lib/contracts/types/generated/GNSPairsStorageV6.js +2 -0
- package/lib/contracts/types/generated/GNSTrading.d.ts +758 -0
- package/lib/contracts/types/generated/GNSTrading.js +2 -0
- package/lib/contracts/types/generated/GNSTradingCallbacks.d.ts +875 -0
- package/lib/contracts/types/generated/GNSTradingCallbacks.js +2 -0
- package/lib/contracts/types/generated/GNSTradingCallbacksV6_3_2.d.ts +806 -0
- package/lib/contracts/types/generated/GNSTradingCallbacksV6_3_2.js +2 -0
- package/lib/contracts/types/generated/GNSTradingCallbacksV6_4.d.ts +821 -0
- package/lib/contracts/types/generated/GNSTradingCallbacksV6_4.js +2 -0
- package/lib/contracts/types/generated/GNSTradingStorage.d.ts +1387 -0
- package/lib/contracts/types/generated/GNSTradingStorage.js +2 -0
- package/lib/contracts/types/generated/GTokenV6_3_2.d.ts +1838 -0
- package/lib/contracts/types/generated/GTokenV6_3_2.js +2 -0
- package/lib/contracts/types/generated/factories/GFarmTradingStorageV5__factory.d.ts +83 -0
- package/lib/contracts/types/generated/factories/GFarmTradingStorageV5__factory.js +2691 -0
- package/lib/contracts/types/generated/factories/GNSBorrowingFeesV6_3_2__factory.d.ts +88 -0
- package/lib/contracts/types/generated/factories/GNSBorrowingFeesV6_3_2__factory.js +1654 -0
- package/lib/contracts/types/generated/factories/GNSBorrowingFeesV6_4__factory.d.ts +113 -0
- package/lib/contracts/types/generated/factories/GNSBorrowingFeesV6_4__factory.js +1742 -0
- package/lib/contracts/types/generated/factories/GNSBorrowingFees__factory.d.ts +124 -0
- package/lib/contracts/types/generated/factories/GNSBorrowingFees__factory.js +1784 -0
- package/lib/contracts/types/generated/factories/GNSNftRewardsV6_3_1__factory.d.ts +100 -0
- package/lib/contracts/types/generated/factories/GNSNftRewardsV6_3_1__factory.js +1116 -0
- package/lib/contracts/types/generated/factories/GNSNftRewardsV6__factory.d.ts +100 -0
- package/lib/contracts/types/generated/factories/GNSNftRewardsV6__factory.js +1003 -0
- package/lib/contracts/types/generated/factories/GNSPairInfosV6_1__factory.d.ts +98 -0
- package/lib/contracts/types/generated/factories/GNSPairInfosV6_1__factory.js +1485 -0
- package/lib/contracts/types/generated/factories/GNSPairsStorageV6__factory.d.ts +117 -0
- package/lib/contracts/types/generated/factories/GNSPairsStorageV6__factory.js +1265 -0
- package/lib/contracts/types/generated/factories/GNSTradingCallbacksV6_3_2__factory.d.ts +82 -0
- package/lib/contracts/types/generated/factories/GNSTradingCallbacksV6_3_2__factory.js +1273 -0
- package/lib/contracts/types/generated/factories/GNSTradingCallbacksV6_4__factory.d.ts +82 -0
- package/lib/contracts/types/generated/factories/GNSTradingCallbacksV6_4__factory.js +1326 -0
- package/lib/contracts/types/generated/factories/GNSTradingCallbacks__factory.d.ts +113 -0
- package/lib/contracts/types/generated/factories/GNSTradingCallbacks__factory.js +1428 -0
- package/lib/contracts/types/generated/factories/GNSTradingStorage__factory.d.ts +96 -0
- package/lib/contracts/types/generated/factories/GNSTradingStorage__factory.js +2241 -0
- package/lib/contracts/types/generated/factories/GNSTrading__factory.d.ts +95 -0
- package/lib/contracts/types/generated/factories/GNSTrading__factory.js +1071 -0
- package/lib/contracts/types/generated/factories/GTokenV6_3_2__factory.d.ts +110 -0
- package/lib/contracts/types/generated/factories/GTokenV6_3_2__factory.js +2682 -0
- package/lib/markets/oi/fetcher.d.ts +58 -0
- package/lib/markets/oi/fetcher.js +181 -0
- package/lib/markets/oi/validation.d.ts +80 -0
- package/lib/markets/oi/validation.js +172 -0
- package/lib/pricing/depthBands/converter.d.ts +65 -0
- package/lib/pricing/depthBands/converter.js +155 -0
- package/lib/pricing/depthBands/decoder.d.ts +32 -0
- package/lib/pricing/depthBands/decoder.js +109 -0
- package/lib/pricing/depthBands/encoder.d.ts +19 -0
- package/lib/pricing/depthBands/encoder.js +105 -0
- package/lib/pricing/depthBands/index.d.ts +8 -0
- package/lib/pricing/depthBands/index.js +26 -0
- package/lib/pricing/depthBands/types.d.ts +49 -0
- package/lib/pricing/depthBands/types.js +10 -0
- package/lib/pricing/depthBands/validator.d.ts +22 -0
- package/lib/pricing/depthBands/validator.js +113 -0
- package/lib/pricing/depthBands.d.ts +39 -0
- package/lib/pricing/depthBands.js +94 -0
- package/lib/pricing/index.d.ts +4 -0
- package/lib/pricing/index.js +20 -0
- package/lib/trade/effectiveLeverage/builder.d.ts +23 -0
- package/lib/trade/effectiveLeverage/builder.js +30 -0
- package/lib/trade/fees/holdingFees/index.d.ts +46 -0
- package/lib/trade/fees/holdingFees/index.js +105 -0
- package/lib/trade/fees/holdingFees/types.d.ts +23 -0
- package/lib/trade/fees/holdingFees/types.js +5 -0
- package/lib/trade/fees/trading/holdingFees.d.ts +28 -0
- package/lib/trade/fees/trading/holdingFees.js +66 -0
- package/lib/trade/fees/trading/holdingFeesStructured.d.ts +28 -0
- package/lib/trade/fees/trading/holdingFeesStructured.js +66 -0
- package/lib/trade/priceImpact/cumulVol/types.d.ts +11 -0
- package/lib/trade/priceImpact/cumulVol/types.js +2 -0
- package/package.json +1 -1
- package/lib/trade/liquidation.d.ts +0 -12
- package/lib/trade/liquidation.js +0 -55
- package/lib/trade/pnl.d.ts +0 -10
- package/lib/trade/pnl.js +0 -33
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @dev Depth bands encoding/decoding functions
|
|
3
|
+
*/
|
|
4
|
+
/**
|
|
5
|
+
* Encode depth bands data into two uint256 slots
|
|
6
|
+
* @param totalDepthUsd Total depth in USD (must fit in uint32)
|
|
7
|
+
* @param bandPercentagesBps Array of 30 band percentages in basis points
|
|
8
|
+
* @returns Two slots as bigints
|
|
9
|
+
*/
|
|
10
|
+
export declare function encodeDepthBands(totalDepthUsd: number, bandPercentagesBps: number[]): {
|
|
11
|
+
slot1: bigint;
|
|
12
|
+
slot2: bigint;
|
|
13
|
+
};
|
|
14
|
+
/**
|
|
15
|
+
* Decode depth bands from two uint256 slots
|
|
16
|
+
* @param slot1 First slot containing totalDepthUsd and bands 0-13
|
|
17
|
+
* @param slot2 Second slot containing bands 14-29
|
|
18
|
+
* @returns Total depth and array of band percentages
|
|
19
|
+
*/
|
|
20
|
+
export declare function decodeDepthBands(slot1: bigint, slot2: bigint): {
|
|
21
|
+
totalDepthUsd: number;
|
|
22
|
+
bands: number[];
|
|
23
|
+
};
|
|
24
|
+
/**
|
|
25
|
+
* Encode depth bands mapping (global offsets for all pairs)
|
|
26
|
+
* @param bands Array of 30 band offset values in ppm
|
|
27
|
+
* @returns Two slots as bigints
|
|
28
|
+
*/
|
|
29
|
+
export declare function encodeDepthBandsMapping(bands: number[]): {
|
|
30
|
+
slot1: bigint;
|
|
31
|
+
slot2: bigint;
|
|
32
|
+
};
|
|
33
|
+
/**
|
|
34
|
+
* Decode depth bands mapping from two uint256 slots
|
|
35
|
+
* @param slot1 First slot containing bands 0-13 (starting at bit 32, first 32 bits unused)
|
|
36
|
+
* @param slot2 Second slot containing bands 14-29
|
|
37
|
+
* @returns Array of band offset values in ppm
|
|
38
|
+
*/
|
|
39
|
+
export declare function decodeDepthBandsMapping(slot1: bigint, slot2: bigint): number[];
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* @dev Depth bands encoding/decoding functions
|
|
4
|
+
*/
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.decodeDepthBandsMapping = exports.encodeDepthBandsMapping = exports.decodeDepthBands = exports.encodeDepthBands = void 0;
|
|
7
|
+
const DEPTH_BANDS_COUNT = 30;
|
|
8
|
+
const DEPTH_BANDS_PER_SLOT1 = 14;
|
|
9
|
+
/**
|
|
10
|
+
* Encode depth bands data into two uint256 slots
|
|
11
|
+
* @param totalDepthUsd Total depth in USD (must fit in uint32)
|
|
12
|
+
* @param bandPercentagesBps Array of 30 band percentages in basis points
|
|
13
|
+
* @returns Two slots as bigints
|
|
14
|
+
*/
|
|
15
|
+
function encodeDepthBands(totalDepthUsd, bandPercentagesBps) {
|
|
16
|
+
// Pack slot1: totalDepthUsd (32 bits) + bands 0-13 (14 * 16 bits)
|
|
17
|
+
let slot1 = BigInt(totalDepthUsd);
|
|
18
|
+
for (let i = 0; i < DEPTH_BANDS_PER_SLOT1; i++) {
|
|
19
|
+
const shift = 32 + i * 16;
|
|
20
|
+
slot1 |= BigInt(bandPercentagesBps[i]) << BigInt(shift);
|
|
21
|
+
}
|
|
22
|
+
// Pack slot2: bands 14-29 (16 * 16 bits)
|
|
23
|
+
let slot2 = BigInt(0);
|
|
24
|
+
for (let i = DEPTH_BANDS_PER_SLOT1; i < DEPTH_BANDS_COUNT; i++) {
|
|
25
|
+
const shift = (i - DEPTH_BANDS_PER_SLOT1) * 16;
|
|
26
|
+
slot2 |= BigInt(bandPercentagesBps[i]) << BigInt(shift);
|
|
27
|
+
}
|
|
28
|
+
return { slot1, slot2 };
|
|
29
|
+
}
|
|
30
|
+
exports.encodeDepthBands = encodeDepthBands;
|
|
31
|
+
/**
|
|
32
|
+
* Decode depth bands from two uint256 slots
|
|
33
|
+
* @param slot1 First slot containing totalDepthUsd and bands 0-13
|
|
34
|
+
* @param slot2 Second slot containing bands 14-29
|
|
35
|
+
* @returns Total depth and array of band percentages
|
|
36
|
+
*/
|
|
37
|
+
function decodeDepthBands(slot1, slot2) {
|
|
38
|
+
const totalDepthUsd = Number(slot1 & BigInt(0xffffffff));
|
|
39
|
+
const bands = [];
|
|
40
|
+
// Extract bands 0-13 from slot1
|
|
41
|
+
for (let i = 0; i < DEPTH_BANDS_PER_SLOT1; i++) {
|
|
42
|
+
const shift = 32 + i * 16;
|
|
43
|
+
bands.push(Number((slot1 >> BigInt(shift)) & BigInt(0xffff)));
|
|
44
|
+
}
|
|
45
|
+
// Extract bands 14-29 from slot2
|
|
46
|
+
for (let i = DEPTH_BANDS_PER_SLOT1; i < DEPTH_BANDS_COUNT; i++) {
|
|
47
|
+
const shift = (i - DEPTH_BANDS_PER_SLOT1) * 16;
|
|
48
|
+
bands.push(Number((slot2 >> BigInt(shift)) & BigInt(0xffff)));
|
|
49
|
+
}
|
|
50
|
+
return { totalDepthUsd, bands };
|
|
51
|
+
}
|
|
52
|
+
exports.decodeDepthBands = decodeDepthBands;
|
|
53
|
+
/**
|
|
54
|
+
* Encode depth bands mapping (global offsets for all pairs)
|
|
55
|
+
* @param bands Array of 30 band offset values in ppm
|
|
56
|
+
* @returns Two slots as bigints
|
|
57
|
+
*/
|
|
58
|
+
function encodeDepthBandsMapping(bands) {
|
|
59
|
+
// Pack slot1: bands 0-13 (starting at bit 32, first 32 bits unused)
|
|
60
|
+
let slot1 = BigInt(0);
|
|
61
|
+
for (let i = 0; i < DEPTH_BANDS_PER_SLOT1; i++) {
|
|
62
|
+
const shift = 32 + i * 16; // Start at bit 32 to match contract
|
|
63
|
+
slot1 |= BigInt(bands[i]) << BigInt(shift);
|
|
64
|
+
}
|
|
65
|
+
// Pack slot2: bands 14-29 (16 * 16 bits)
|
|
66
|
+
let slot2 = BigInt(0);
|
|
67
|
+
for (let i = DEPTH_BANDS_PER_SLOT1; i < DEPTH_BANDS_COUNT; i++) {
|
|
68
|
+
const shift = (i - DEPTH_BANDS_PER_SLOT1) * 16;
|
|
69
|
+
slot2 |= BigInt(bands[i]) << BigInt(shift);
|
|
70
|
+
}
|
|
71
|
+
return { slot1, slot2 };
|
|
72
|
+
}
|
|
73
|
+
exports.encodeDepthBandsMapping = encodeDepthBandsMapping;
|
|
74
|
+
/**
|
|
75
|
+
* Decode depth bands mapping from two uint256 slots
|
|
76
|
+
* @param slot1 First slot containing bands 0-13 (starting at bit 32, first 32 bits unused)
|
|
77
|
+
* @param slot2 Second slot containing bands 14-29
|
|
78
|
+
* @returns Array of band offset values in ppm
|
|
79
|
+
*/
|
|
80
|
+
function decodeDepthBandsMapping(slot1, slot2) {
|
|
81
|
+
const bands = [];
|
|
82
|
+
// Extract bands 0-13 from slot1 (skip first 32 bits which are unused for mappings)
|
|
83
|
+
for (let i = 0; i < DEPTH_BANDS_PER_SLOT1; i++) {
|
|
84
|
+
const shift = 32 + i * 16; // Start at bit 32, not bit 0
|
|
85
|
+
bands.push(Number((slot1 >> BigInt(shift)) & BigInt(0xffff)));
|
|
86
|
+
}
|
|
87
|
+
// Extract bands 14-29 from slot2
|
|
88
|
+
for (let i = DEPTH_BANDS_PER_SLOT1; i < DEPTH_BANDS_COUNT; i++) {
|
|
89
|
+
const shift = (i - DEPTH_BANDS_PER_SLOT1) * 16;
|
|
90
|
+
bands.push(Number((slot2 >> BigInt(shift)) & BigInt(0xffff)));
|
|
91
|
+
}
|
|
92
|
+
return bands;
|
|
93
|
+
}
|
|
94
|
+
exports.decodeDepthBandsMapping = decodeDepthBandsMapping;
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* @dev Pricing module exports
|
|
4
|
+
*/
|
|
5
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
6
|
+
if (k2 === undefined) k2 = k;
|
|
7
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
8
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
9
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
10
|
+
}
|
|
11
|
+
Object.defineProperty(o, k2, desc);
|
|
12
|
+
}) : (function(o, m, k, k2) {
|
|
13
|
+
if (k2 === undefined) k2 = k;
|
|
14
|
+
o[k2] = m[k];
|
|
15
|
+
}));
|
|
16
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
17
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
18
|
+
};
|
|
19
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
20
|
+
__exportStar(require("./depthBands"), exports);
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import { GlobalTradingVariablesType } from "../../backend/tradingVariables/types";
|
|
2
|
+
import { TradeInfo } from "..";
|
|
3
|
+
import { TradeEffectiveLeverageContext } from "./types";
|
|
4
|
+
/**
|
|
5
|
+
* @dev Builds a complete context for effective leverage calculations
|
|
6
|
+
* @dev Uses the closing price impact context builder as a sub-context
|
|
7
|
+
* @param globalTradingVariables The transformed global trading variables from backend
|
|
8
|
+
* @param collateralIndex The collateral index (1-based)
|
|
9
|
+
* @param pairIndex The pair index
|
|
10
|
+
* @param tradeInfo Trade information including createdBlock
|
|
11
|
+
* @param additionalParams Additional parameters for price impact calculations
|
|
12
|
+
* @returns Complete context ready for getTradeNewEffectiveLeverage
|
|
13
|
+
*/
|
|
14
|
+
export declare const buildTradeEffectiveLeverageContext: (globalTradingVariables: GlobalTradingVariablesType, collateralIndex: number, pairIndex: number, tradeInfo: TradeInfo, additionalParams: {
|
|
15
|
+
currentBlock: number;
|
|
16
|
+
contractsVersion?: number;
|
|
17
|
+
isPnlPositive?: boolean;
|
|
18
|
+
userPriceImpact?: {
|
|
19
|
+
cumulVolPriceImpactMultiplier: number;
|
|
20
|
+
fixedSpreadP: number;
|
|
21
|
+
};
|
|
22
|
+
protectionCloseFactorWhitelist?: boolean;
|
|
23
|
+
}) => TradeEffectiveLeverageContext | undefined;
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.buildTradeEffectiveLeverageContext = void 0;
|
|
4
|
+
const __1 = require("..");
|
|
5
|
+
/**
|
|
6
|
+
* @dev Builds a complete context for effective leverage calculations
|
|
7
|
+
* @dev Uses the closing price impact context builder as a sub-context
|
|
8
|
+
* @param globalTradingVariables The transformed global trading variables from backend
|
|
9
|
+
* @param collateralIndex The collateral index (1-based)
|
|
10
|
+
* @param pairIndex The pair index
|
|
11
|
+
* @param tradeInfo Trade information including createdBlock
|
|
12
|
+
* @param additionalParams Additional parameters for price impact calculations
|
|
13
|
+
* @returns Complete context ready for getTradeNewEffectiveLeverage
|
|
14
|
+
*/
|
|
15
|
+
const buildTradeEffectiveLeverageContext = (globalTradingVariables, collateralIndex, pairIndex, tradeInfo, additionalParams) => {
|
|
16
|
+
var _a;
|
|
17
|
+
// Build the closing price impact context which we'll use for PnL calculations
|
|
18
|
+
const closingPriceImpactContext = (0, __1.buildTradeClosingPriceImpactContext)(globalTradingVariables, collateralIndex, pairIndex, tradeInfo, additionalParams);
|
|
19
|
+
if (!closingPriceImpactContext) {
|
|
20
|
+
return undefined;
|
|
21
|
+
}
|
|
22
|
+
// Extract base spread from pairs data
|
|
23
|
+
const pairs = globalTradingVariables.pairs;
|
|
24
|
+
const baseSpreadP = ((_a = pairs === null || pairs === void 0 ? void 0 : pairs[pairIndex]) === null || _a === void 0 ? void 0 : _a.spreadP) || 0;
|
|
25
|
+
return {
|
|
26
|
+
closingPriceImpactContext,
|
|
27
|
+
baseSpreadP,
|
|
28
|
+
};
|
|
29
|
+
};
|
|
30
|
+
exports.buildTradeEffectiveLeverageContext = buildTradeEffectiveLeverageContext;
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @dev Holding fees calculation utilities for v10+ markets
|
|
3
|
+
* @dev Combines funding fees and borrowing v2 fees
|
|
4
|
+
*/
|
|
5
|
+
import { FundingFeeParams, PairFundingFeeData, PairOiAfterV10 } from "../fundingFees/types";
|
|
6
|
+
import { BorrowingFeeParams, PairBorrowingFeeData } from "../borrowingV2/types";
|
|
7
|
+
export type HoldingFeeRates = {
|
|
8
|
+
longHourlyRate: number;
|
|
9
|
+
shortHourlyRate: number;
|
|
10
|
+
fundingFeeLongHourlyRate: number;
|
|
11
|
+
fundingFeeShortHourlyRate: number;
|
|
12
|
+
borrowingFeeHourlyRate: number;
|
|
13
|
+
currentFundingRatePerSecondP: number;
|
|
14
|
+
currentBorrowingRatePerSecondP: number;
|
|
15
|
+
};
|
|
16
|
+
export type GetPairHoldingFeeRatesInput = {
|
|
17
|
+
fundingParams: FundingFeeParams;
|
|
18
|
+
fundingData: PairFundingFeeData;
|
|
19
|
+
pairOiToken: PairOiAfterV10;
|
|
20
|
+
netExposureToken: number;
|
|
21
|
+
netExposureUsd: number;
|
|
22
|
+
borrowingParams: BorrowingFeeParams | null;
|
|
23
|
+
borrowingData: PairBorrowingFeeData | null;
|
|
24
|
+
currentPairPrice: number;
|
|
25
|
+
currentTimestamp: number;
|
|
26
|
+
};
|
|
27
|
+
/**
|
|
28
|
+
* @dev Calculates current holding fee rates per hour for display
|
|
29
|
+
* @param input Input parameters for calculation
|
|
30
|
+
* @returns Holding fee rates per hour with breakdown
|
|
31
|
+
*/
|
|
32
|
+
export declare const getPairHoldingFeeRates: (input: GetPairHoldingFeeRatesInput) => HoldingFeeRates;
|
|
33
|
+
/**
|
|
34
|
+
* @dev Converts a per-second rate to annual percentage rate (APR)
|
|
35
|
+
* @param ratePerSecond Rate per second
|
|
36
|
+
* @returns Annual percentage rate
|
|
37
|
+
*/
|
|
38
|
+
export declare const convertRatePerSecondToAPR: (ratePerSecond: number) => number;
|
|
39
|
+
/**
|
|
40
|
+
* @dev Formats a holding fee rate for display
|
|
41
|
+
* @param rate Hourly rate (can be negative)
|
|
42
|
+
* @param decimals Number of decimal places
|
|
43
|
+
* @returns Formatted string with sign
|
|
44
|
+
*/
|
|
45
|
+
export declare const formatHoldingFeeRate: (rate: number, decimals?: number) => string;
|
|
46
|
+
export * as HoldingFees from "./types";
|
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* @dev Holding fees calculation utilities for v10+ markets
|
|
4
|
+
* @dev Combines funding fees and borrowing v2 fees
|
|
5
|
+
*/
|
|
6
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
7
|
+
if (k2 === undefined) k2 = k;
|
|
8
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
9
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
10
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
11
|
+
}
|
|
12
|
+
Object.defineProperty(o, k2, desc);
|
|
13
|
+
}) : (function(o, m, k, k2) {
|
|
14
|
+
if (k2 === undefined) k2 = k;
|
|
15
|
+
o[k2] = m[k];
|
|
16
|
+
}));
|
|
17
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
18
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
19
|
+
}) : function(o, v) {
|
|
20
|
+
o["default"] = v;
|
|
21
|
+
});
|
|
22
|
+
var __importStar = (this && this.__importStar) || function (mod) {
|
|
23
|
+
if (mod && mod.__esModule) return mod;
|
|
24
|
+
var result = {};
|
|
25
|
+
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
|
|
26
|
+
__setModuleDefault(result, mod);
|
|
27
|
+
return result;
|
|
28
|
+
};
|
|
29
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
30
|
+
exports.HoldingFees = exports.formatHoldingFeeRate = exports.convertRatePerSecondToAPR = exports.getPairHoldingFeeRates = void 0;
|
|
31
|
+
const fundingFees_1 = require("../fundingFees");
|
|
32
|
+
const SECONDS_PER_HOUR = 3600;
|
|
33
|
+
const SECONDS_PER_YEAR = 365 * 24 * 60 * 60;
|
|
34
|
+
const PERCENTAGE_PRECISION = 100;
|
|
35
|
+
/**
|
|
36
|
+
* @dev Calculates current holding fee rates per hour for display
|
|
37
|
+
* @param input Input parameters for calculation
|
|
38
|
+
* @returns Holding fee rates per hour with breakdown
|
|
39
|
+
*/
|
|
40
|
+
const getPairHoldingFeeRates = (input) => {
|
|
41
|
+
const { fundingParams, fundingData, pairOiToken, netExposureToken, netExposureUsd, borrowingParams, borrowingData, currentPairPrice, currentTimestamp, } = input;
|
|
42
|
+
// Calculate funding fee rates
|
|
43
|
+
let fundingFeeLongHourlyRate = 0;
|
|
44
|
+
let fundingFeeShortHourlyRate = 0;
|
|
45
|
+
let currentFundingRatePerSecondP = 0;
|
|
46
|
+
if (fundingParams.fundingFeesEnabled) {
|
|
47
|
+
// Get current funding rate
|
|
48
|
+
const pendingFunding = (0, fundingFees_1.getPairPendingAccFundingFees)(fundingParams, fundingData, currentPairPrice, pairOiToken, netExposureToken, netExposureUsd, currentTimestamp);
|
|
49
|
+
currentFundingRatePerSecondP = pendingFunding.currentFundingRatePerSecondP;
|
|
50
|
+
// Get APR multipliers
|
|
51
|
+
const { longAprMultiplier, shortAprMultiplier } = (0, fundingFees_1.getLongShortAprMultiplier)(currentFundingRatePerSecondP, pairOiToken.oiLongToken, pairOiToken.oiShortToken, fundingParams.aprMultiplierEnabled);
|
|
52
|
+
// Calculate hourly rates
|
|
53
|
+
// Funding rate * seconds per hour * current price * APR multiplier / 100
|
|
54
|
+
const baseHourlyRate = (currentFundingRatePerSecondP * SECONDS_PER_HOUR * currentPairPrice) /
|
|
55
|
+
PERCENTAGE_PRECISION;
|
|
56
|
+
// Long side pays when rate is positive, earns when negative
|
|
57
|
+
fundingFeeLongHourlyRate = baseHourlyRate * longAprMultiplier;
|
|
58
|
+
// Short side is opposite
|
|
59
|
+
fundingFeeShortHourlyRate = -baseHourlyRate * shortAprMultiplier;
|
|
60
|
+
}
|
|
61
|
+
// Calculate borrowing v2 rates
|
|
62
|
+
let borrowingFeeHourlyRate = 0;
|
|
63
|
+
let currentBorrowingRatePerSecondP = 0;
|
|
64
|
+
if (borrowingParams && borrowingData) {
|
|
65
|
+
currentBorrowingRatePerSecondP = borrowingParams.borrowingRatePerSecondP;
|
|
66
|
+
// Borrowing rate * seconds per hour * current price / 100
|
|
67
|
+
borrowingFeeHourlyRate =
|
|
68
|
+
(currentBorrowingRatePerSecondP * SECONDS_PER_HOUR * currentPairPrice) /
|
|
69
|
+
PERCENTAGE_PRECISION;
|
|
70
|
+
}
|
|
71
|
+
// Total holding fees (funding can be negative/positive, borrowing always positive cost)
|
|
72
|
+
const longHourlyRate = fundingFeeLongHourlyRate + borrowingFeeHourlyRate;
|
|
73
|
+
const shortHourlyRate = fundingFeeShortHourlyRate + borrowingFeeHourlyRate;
|
|
74
|
+
return {
|
|
75
|
+
longHourlyRate,
|
|
76
|
+
shortHourlyRate,
|
|
77
|
+
fundingFeeLongHourlyRate,
|
|
78
|
+
fundingFeeShortHourlyRate,
|
|
79
|
+
borrowingFeeHourlyRate,
|
|
80
|
+
currentFundingRatePerSecondP,
|
|
81
|
+
currentBorrowingRatePerSecondP,
|
|
82
|
+
};
|
|
83
|
+
};
|
|
84
|
+
exports.getPairHoldingFeeRates = getPairHoldingFeeRates;
|
|
85
|
+
/**
|
|
86
|
+
* @dev Converts a per-second rate to annual percentage rate (APR)
|
|
87
|
+
* @param ratePerSecond Rate per second
|
|
88
|
+
* @returns Annual percentage rate
|
|
89
|
+
*/
|
|
90
|
+
const convertRatePerSecondToAPR = (ratePerSecond) => {
|
|
91
|
+
return ratePerSecond * SECONDS_PER_YEAR * PERCENTAGE_PRECISION;
|
|
92
|
+
};
|
|
93
|
+
exports.convertRatePerSecondToAPR = convertRatePerSecondToAPR;
|
|
94
|
+
/**
|
|
95
|
+
* @dev Formats a holding fee rate for display
|
|
96
|
+
* @param rate Hourly rate (can be negative)
|
|
97
|
+
* @param decimals Number of decimal places
|
|
98
|
+
* @returns Formatted string with sign
|
|
99
|
+
*/
|
|
100
|
+
const formatHoldingFeeRate = (rate, decimals = 4) => {
|
|
101
|
+
const sign = rate > 0 ? "+" : "";
|
|
102
|
+
return `${sign}${rate.toFixed(decimals)}%`;
|
|
103
|
+
};
|
|
104
|
+
exports.formatHoldingFeeRate = formatHoldingFeeRate;
|
|
105
|
+
exports.HoldingFees = __importStar(require("./types"));
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @dev Type definitions for holding fees (funding + borrowing v2)
|
|
3
|
+
*/
|
|
4
|
+
export interface HoldingFeeRates {
|
|
5
|
+
longHourlyRate: number;
|
|
6
|
+
shortHourlyRate: number;
|
|
7
|
+
fundingFeeLongHourlyRate: number;
|
|
8
|
+
fundingFeeShortHourlyRate: number;
|
|
9
|
+
borrowingFeeHourlyRate: number;
|
|
10
|
+
currentFundingRatePerSecondP: number;
|
|
11
|
+
currentBorrowingRatePerSecondP: number;
|
|
12
|
+
}
|
|
13
|
+
export interface GetPairHoldingFeeRatesInput {
|
|
14
|
+
fundingParams: import("../fundingFees/types").FundingFeeParams;
|
|
15
|
+
fundingData: import("../fundingFees/types").PairFundingFeeData;
|
|
16
|
+
pairOiToken: import("../fundingFees/types").PairOiAfterV10;
|
|
17
|
+
netExposureToken: number;
|
|
18
|
+
netExposureUsd: number;
|
|
19
|
+
borrowingParams: import("../borrowingV2/types").BorrowingFeeParams | null;
|
|
20
|
+
borrowingData: import("../borrowingV2/types").PairBorrowingFeeData | null;
|
|
21
|
+
currentPairPrice: number;
|
|
22
|
+
currentTimestamp: number;
|
|
23
|
+
}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @dev Holding fees calculation for structured contexts
|
|
3
|
+
*/
|
|
4
|
+
import { Trade, TradeInfo, TradeFeesData } from "../../types";
|
|
5
|
+
import { TradeHoldingFees } from "./types";
|
|
6
|
+
import { ContractsVersion } from "../../../contracts/types";
|
|
7
|
+
import type { BorrowingV1SubContext, BorrowingV2SubContext, FundingFeesSubContext } from "../../pnl";
|
|
8
|
+
/**
|
|
9
|
+
* @dev Context for holding fees calculation with structured sub-contexts
|
|
10
|
+
*/
|
|
11
|
+
export type GetStructuredHoldingFeesContext = {
|
|
12
|
+
contractsVersion: ContractsVersion;
|
|
13
|
+
currentTimestamp: number;
|
|
14
|
+
collateralPriceUsd: number;
|
|
15
|
+
borrowingV1?: BorrowingV1SubContext;
|
|
16
|
+
borrowingV2?: BorrowingV2SubContext;
|
|
17
|
+
funding?: FundingFeesSubContext;
|
|
18
|
+
};
|
|
19
|
+
/**
|
|
20
|
+
* @dev Calculates total holding fees using structured context
|
|
21
|
+
* @param trade The trade to calculate fees for
|
|
22
|
+
* @param tradeInfo Trade info containing contracts version
|
|
23
|
+
* @param tradeFeesData Trade fees data containing initial acc fees
|
|
24
|
+
* @param currentPairPrice Current pair price
|
|
25
|
+
* @param context Structured context with sub-contexts for each fee type
|
|
26
|
+
* @returns Object containing all holding fee components
|
|
27
|
+
*/
|
|
28
|
+
export declare const getTradePendingHoldingFeesCollateralStructured: (trade: Trade, tradeInfo: TradeInfo, tradeFeesData: TradeFeesData, currentPairPrice: number, context: GetStructuredHoldingFeesContext) => TradeHoldingFees;
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* @dev Holding fees calculation for structured contexts
|
|
4
|
+
*/
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.getTradePendingHoldingFeesCollateralStructured = void 0;
|
|
7
|
+
const types_1 = require("../../../contracts/types");
|
|
8
|
+
const borrowing_1 = require("../borrowing");
|
|
9
|
+
const borrowingV2_1 = require("../borrowingV2");
|
|
10
|
+
const pairContext_1 = require("../fundingFees/pairContext");
|
|
11
|
+
/**
|
|
12
|
+
* @dev Calculates total holding fees using structured context
|
|
13
|
+
* @param trade The trade to calculate fees for
|
|
14
|
+
* @param tradeInfo Trade info containing contracts version
|
|
15
|
+
* @param tradeFeesData Trade fees data containing initial acc fees
|
|
16
|
+
* @param currentPairPrice Current pair price
|
|
17
|
+
* @param context Structured context with sub-contexts for each fee type
|
|
18
|
+
* @returns Object containing all holding fee components
|
|
19
|
+
*/
|
|
20
|
+
const getTradePendingHoldingFeesCollateralStructured = (trade, tradeInfo, tradeFeesData, currentPairPrice, context) => {
|
|
21
|
+
const positionSizeCollateral = trade.collateralAmount * trade.leverage;
|
|
22
|
+
// Calculate funding fees (v10+ only)
|
|
23
|
+
let fundingFeeCollateral = 0;
|
|
24
|
+
if (context.contractsVersion >= types_1.ContractsVersion.V10 &&
|
|
25
|
+
context.funding &&
|
|
26
|
+
tradeFeesData.initialAccFundingFeeP !== undefined) {
|
|
27
|
+
fundingFeeCollateral = (0, pairContext_1.getPairTradeFundingFeesCollateral)({
|
|
28
|
+
positionSizeCollateral,
|
|
29
|
+
openPrice: trade.openPrice,
|
|
30
|
+
long: trade.long,
|
|
31
|
+
currentPairPrice,
|
|
32
|
+
initialAccFundingFeeP: tradeFeesData.initialAccFundingFeeP,
|
|
33
|
+
}, context.funding // TODO: Fix types once funding types are properly imported
|
|
34
|
+
);
|
|
35
|
+
}
|
|
36
|
+
// Calculate borrowing fees v2
|
|
37
|
+
let borrowingFeeCollateral = 0;
|
|
38
|
+
if (context.borrowingV2 && tradeFeesData.initialAccBorrowingFeeP !== undefined) {
|
|
39
|
+
borrowingFeeCollateral = (0, borrowingV2_1.getPairTradeBorrowingFeesCollateral)({
|
|
40
|
+
positionSizeCollateral,
|
|
41
|
+
openPrice: trade.openPrice,
|
|
42
|
+
currentPairPrice,
|
|
43
|
+
initialAccBorrowingFeeP: tradeFeesData.initialAccBorrowingFeeP,
|
|
44
|
+
currentTimestamp: context.currentTimestamp,
|
|
45
|
+
}, context.borrowingV2);
|
|
46
|
+
}
|
|
47
|
+
// Calculate v1 borrowing fees (some markets use v1 indefinitely)
|
|
48
|
+
let borrowingFeeCollateral_old = 0;
|
|
49
|
+
if (context.borrowingV1) {
|
|
50
|
+
borrowingFeeCollateral_old = (0, borrowing_1.getPairBorrowingFee)(positionSizeCollateral, trade.long, context.borrowingV1.initialAccFees || { accPairFee: 0, accGroupFee: 0, block: 0 }, {
|
|
51
|
+
currentBlock: context.borrowingV1.currentBlock,
|
|
52
|
+
group: context.borrowingV1.group,
|
|
53
|
+
pair: context.borrowingV1.pair,
|
|
54
|
+
collateralPriceUsd: context.collateralPriceUsd,
|
|
55
|
+
});
|
|
56
|
+
}
|
|
57
|
+
return {
|
|
58
|
+
fundingFeeCollateral,
|
|
59
|
+
borrowingFeeCollateral,
|
|
60
|
+
borrowingFeeCollateral_old,
|
|
61
|
+
totalFeeCollateral: fundingFeeCollateral +
|
|
62
|
+
borrowingFeeCollateral +
|
|
63
|
+
borrowingFeeCollateral_old,
|
|
64
|
+
};
|
|
65
|
+
};
|
|
66
|
+
exports.getTradePendingHoldingFeesCollateralStructured = getTradePendingHoldingFeesCollateralStructured;
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @dev Holding fees calculation for structured contexts
|
|
3
|
+
*/
|
|
4
|
+
import { Trade, TradeInfo, TradeFeesData } from "../../types";
|
|
5
|
+
import { TradeHoldingFees } from "./types";
|
|
6
|
+
import { ContractsVersion } from "../../../contracts/types";
|
|
7
|
+
import type { BorrowingV1SubContext, BorrowingV2SubContext, FundingFeesSubContext } from "../../pnl";
|
|
8
|
+
/**
|
|
9
|
+
* @dev Context for holding fees calculation with structured sub-contexts
|
|
10
|
+
*/
|
|
11
|
+
export type GetStructuredHoldingFeesContext = {
|
|
12
|
+
contractsVersion: ContractsVersion;
|
|
13
|
+
currentTimestamp: number;
|
|
14
|
+
collateralPriceUsd: number;
|
|
15
|
+
borrowingV1?: BorrowingV1SubContext;
|
|
16
|
+
borrowingV2?: BorrowingV2SubContext;
|
|
17
|
+
funding?: FundingFeesSubContext;
|
|
18
|
+
};
|
|
19
|
+
/**
|
|
20
|
+
* @dev Calculates total holding fees using structured context
|
|
21
|
+
* @param trade The trade to calculate fees for
|
|
22
|
+
* @param tradeInfo Trade info containing contracts version
|
|
23
|
+
* @param tradeFeesData Trade fees data containing initial acc fees
|
|
24
|
+
* @param currentPairPrice Current pair price
|
|
25
|
+
* @param context Structured context with sub-contexts for each fee type
|
|
26
|
+
* @returns Object containing all holding fee components
|
|
27
|
+
*/
|
|
28
|
+
export declare const getTradePendingHoldingFeesCollateralStructured: (trade: Trade, tradeInfo: TradeInfo, tradeFeesData: TradeFeesData, currentPairPrice: number, context: GetStructuredHoldingFeesContext) => TradeHoldingFees;
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* @dev Holding fees calculation for structured contexts
|
|
4
|
+
*/
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.getTradePendingHoldingFeesCollateralStructured = void 0;
|
|
7
|
+
const types_1 = require("../../../contracts/types");
|
|
8
|
+
const borrowing_1 = require("../borrowing");
|
|
9
|
+
const borrowingV2_1 = require("../borrowingV2");
|
|
10
|
+
const fundingFees_1 = require("../fundingFees");
|
|
11
|
+
/**
|
|
12
|
+
* @dev Calculates total holding fees using structured context
|
|
13
|
+
* @param trade The trade to calculate fees for
|
|
14
|
+
* @param tradeInfo Trade info containing contracts version
|
|
15
|
+
* @param tradeFeesData Trade fees data containing initial acc fees
|
|
16
|
+
* @param currentPairPrice Current pair price
|
|
17
|
+
* @param context Structured context with sub-contexts for each fee type
|
|
18
|
+
* @returns Object containing all holding fee components
|
|
19
|
+
*/
|
|
20
|
+
const getTradePendingHoldingFeesCollateralStructured = (trade, tradeInfo, tradeFeesData, currentPairPrice, context) => {
|
|
21
|
+
const positionSizeCollateral = trade.collateralAmount * trade.leverage;
|
|
22
|
+
// Calculate funding fees (v10+ only)
|
|
23
|
+
let fundingFeeCollateral = 0;
|
|
24
|
+
if (context.contractsVersion >= types_1.ContractsVersion.V10 &&
|
|
25
|
+
context.funding &&
|
|
26
|
+
tradeFeesData.initialAccFundingFeeP !== undefined) {
|
|
27
|
+
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
|
|
28
|
+
);
|
|
29
|
+
}
|
|
30
|
+
// Calculate borrowing fees v2
|
|
31
|
+
let borrowingFeeCollateral = 0;
|
|
32
|
+
if (context.borrowingV2 &&
|
|
33
|
+
tradeFeesData.initialAccBorrowingFeeP !== undefined) {
|
|
34
|
+
borrowingFeeCollateral = (0, borrowingV2_1.getTradeBorrowingFeesCollateral)({
|
|
35
|
+
positionSizeCollateral,
|
|
36
|
+
openPrice: trade.openPrice,
|
|
37
|
+
currentPairPrice,
|
|
38
|
+
initialAccBorrowingFeeP: tradeFeesData.initialAccBorrowingFeeP,
|
|
39
|
+
currentTimestamp: context.currentTimestamp,
|
|
40
|
+
}, context.borrowingV2);
|
|
41
|
+
}
|
|
42
|
+
// Calculate v1 borrowing fees (some markets use v1 indefinitely)
|
|
43
|
+
let borrowingFeeCollateral_old = 0;
|
|
44
|
+
if (context.borrowingV1) {
|
|
45
|
+
borrowingFeeCollateral_old = (0, borrowing_1.getBorrowingFee)(positionSizeCollateral, undefined, // pairIndex not needed for pair-specific context
|
|
46
|
+
trade.long, context.borrowingV1.initialAccFees || {
|
|
47
|
+
accPairFee: 0,
|
|
48
|
+
accGroupFee: 0,
|
|
49
|
+
block: 0,
|
|
50
|
+
}, {
|
|
51
|
+
currentBlock: context.borrowingV1.currentBlock,
|
|
52
|
+
group: context.borrowingV1.group,
|
|
53
|
+
pair: context.borrowingV1.pair,
|
|
54
|
+
collateralPriceUsd: context.collateralPriceUsd,
|
|
55
|
+
});
|
|
56
|
+
}
|
|
57
|
+
return {
|
|
58
|
+
fundingFeeCollateral,
|
|
59
|
+
borrowingFeeCollateral,
|
|
60
|
+
borrowingFeeCollateral_old,
|
|
61
|
+
totalFeeCollateral: fundingFeeCollateral +
|
|
62
|
+
borrowingFeeCollateral +
|
|
63
|
+
borrowingFeeCollateral_old,
|
|
64
|
+
};
|
|
65
|
+
};
|
|
66
|
+
exports.getTradePendingHoldingFeesCollateralStructured = getTradePendingHoldingFeesCollateralStructured;
|
package/package.json
CHANGED
|
@@ -1,12 +0,0 @@
|
|
|
1
|
-
import { GetBorrowingFeeContext, BorrowingFee } from "./fees";
|
|
2
|
-
import { Fee, LiquidationParams, Trade, UserPriceImpact } from "./types";
|
|
3
|
-
import { ContractsVersion } from "../contracts/types";
|
|
4
|
-
export type GetLiquidationPriceContext = GetBorrowingFeeContext & {
|
|
5
|
-
liquidationParams: LiquidationParams | undefined;
|
|
6
|
-
pairSpreadP: number | undefined;
|
|
7
|
-
collateralPriceUsd: number | undefined;
|
|
8
|
-
contractsVersion: ContractsVersion | undefined;
|
|
9
|
-
userPriceImpact?: UserPriceImpact | undefined;
|
|
10
|
-
};
|
|
11
|
-
export declare const getLiquidationPrice: (trade: Trade, fee: Fee, initialAccFees: BorrowingFee.InitialAccFees, context: GetLiquidationPriceContext) => number;
|
|
12
|
-
export declare const getLiqPnlThresholdP: (liquidationParams: LiquidationParams | undefined, leverage: number | undefined) => number;
|