@gainsnetwork/sdk 0.2.56-rc1 → 0.2.56-rc3

package/lib/trade/fees/borrowing/converter.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.convertGroupBorrowingFees = exports.convertGroupBorrowingData = exports.convertGroupBorrowingFee = exports.convertPairBorrowingFees = exports.convertPairBorrowingFee = exports.convertPairGroupBorrowingFee = void 0;
+exports.convertFeePerBlockCap = exports.convertGroupBorrowingFees = exports.convertGroupBorrowingData = exports.convertGroupBorrowingFee = exports.convertPairBorrowingFees = exports.convertPairBorrowingFee = exports.convertPairGroupBorrowingFee = void 0;
 const borrowingFees_1 = require("../../../contracts/utils/borrowingFees");
 const convertPairGroupBorrowingFee = (pairGroup) => ({
     groupIndex: pairGroup.groupIndex,
@@ -14,9 +14,9 @@ const convertPairGroupBorrowingFee = (pairGroup) => ({
     block: pairGroup.block,
 });
 exports.convertPairGroupBorrowingFee = convertPairGroupBorrowingFee;
-const convertPairBorrowingFee = (pair, pairOi, pairGroup) => (Object.assign(Object.assign({}, (0, exports.convertGroupBorrowingData)(pair, pairOi)), { groups: pairGroup.map(value => (0, exports.convertPairGroupBorrowingFee)(value)) }));
+const convertPairBorrowingFee = (pair, pairOi, pairGroup, feeCap) => (Object.assign(Object.assign({}, (0, exports.convertGroupBorrowingData)(pair, pairOi)), { groups: pairGroup.map(value => (0, exports.convertPairGroupBorrowingFee)(value)), feePerBlockCap: (0, exports.convertFeePerBlockCap)(feeCap) }));
 exports.convertPairBorrowingFee = convertPairBorrowingFee;
-const convertPairBorrowingFees = ([pairs, pairOi, pairGroups]) => pairs.map((value, ix) => (0, exports.convertPairBorrowingFee)(value, pairOi[ix], pairGroups[ix]));
+const convertPairBorrowingFees = ([pairs, pairOi, pairGroups, feeCaps]) => pairs.map((value, ix) => (0, exports.convertPairBorrowingFee)(value, pairOi[ix], pairGroups[ix], feeCaps[ix]));
 exports.convertPairBorrowingFees = convertPairBorrowingFees;
 const convertGroupBorrowingFee = (group, groupOi) => (0, exports.convertGroupBorrowingData)(group, groupOi);
 exports.convertGroupBorrowingFee = convertGroupBorrowingFee;
@@ -35,3 +35,8 @@ const convertGroupBorrowingData = (obj, oi) => ({
 exports.convertGroupBorrowingData = convertGroupBorrowingData;
 const convertGroupBorrowingFees = ([groups, groupOis]) => groups.map((value, ix) => (0, exports.convertGroupBorrowingFee)(value, groupOis[ix]));
 exports.convertGroupBorrowingFees = convertGroupBorrowingFees;
+const convertFeePerBlockCap = (feeCap) => ({
+    minP: feeCap.minP ? parseFloat(feeCap.minP.toString()) / 1e3 / 100 : 0,
+    maxP: feeCap.maxP ? parseFloat(feeCap.maxP.toString()) / 1e3 / 100 : 1,
+});
+exports.convertFeePerBlockCap = convertFeePerBlockCap;

package/lib/trade/fees/borrowing/index.d.ts

@@ -22,7 +22,8 @@ export declare const borrowingFeeUtils: {
     }) => {
         accFeeLong: number;
         accFeeShort: number;
-        delta: number;
+        deltaLong: number;
+        deltaShort: number;
     };
     getPairPendingAccFee: (pairIndex: PairIndex, currentBlock: number, long: boolean, context: {
         pairs: BorrowingFee.Pair[];
@@ -33,21 +34,25 @@ export declare const borrowingFeeUtils: {
     }) => {
         accFeeLong: number;
         accFeeShort: number;
-        delta: number;
+        deltaLong: number;
+        deltaShort: number;
     };
     getGroupPendingAccFee: (groupIndex: number, currentBlock: number, long: boolean, context: {
         groups: BorrowingFee.Group[];
     }) => number;
-    getPendingAccFees: (accFeeLong: number, accFeeShort: number, oiLong: number, oiShort: number, feePerBlock: number, currentBlock: number, accLastUpdatedBlock: number, maxOi: number, feeExponent: number) => {
+    getPendingAccFees: (accFeeLong: number, accFeeShort: number, oiLong: number, oiShort: number, feePerBlock: number, currentBlock: number, accLastUpdatedBlock: number, maxOi: number, feeExponent: number, feeCaps?: BorrowingFee.BorrowingFeePerBlockCap) => {
         accFeeLong: number;
         accFeeShort: number;
-        delta: number;
+        deltaLong: number;
+        deltaShort: number;
     };
     getActiveFeePerBlock: (pair: BorrowingFee.Pair, group: BorrowingFee.Group | undefined) => number;
     getBorrowingDataActiveFeePerBlock: (val: BorrowingFee.Pair | BorrowingFee.Group) => number;
     getPairGroupIndex: (pairIndex: PairIndex, context: {
         pairs: BorrowingFee.Pair[];
     }) => number;
+    getPendingAccFeesDelta: (blockDistance: number, feePerBlock: number, netOi: number, maxOi: number, feeExponent: number) => number;
+    getFeePerBlockCaps: (cap?: BorrowingFee.BorrowingFeePerBlockCap) => BorrowingFee.BorrowingFeePerBlockCap;
 };
 export * as BorrowingFee from "./types";
 export * from "./converter";

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

@@ -77,7 +77,7 @@ const getPairGroupIndex = (pairIndex, context) => {
 const getPairPendingAccFees = (pairIndex, currentBlock, context) => {
     const { pairs, openInterest: { long, short }, } = context;
     const pair = pairs[pairIndex];
-    return getPendingAccFees(pair.accFeeLong, pair.accFeeShort, long, short, pair.feePerBlock, currentBlock, pair.accLastUpdatedBlock, pair.oi.max, pair.feeExponent);
+    return getPendingAccFees(pair.accFeeLong, pair.accFeeShort, long, short, pair.feePerBlock, currentBlock, pair.accLastUpdatedBlock, pair.oi.max, pair.feeExponent, pair.feePerBlockCap);
 };
 const getPairPendingAccFee = (pairIndex, currentBlock, long, context) => {
     const { accFeeLong, accFeeShort } = getPairPendingAccFees(pairIndex, currentBlock, context);
@@ -127,22 +127,62 @@ const getPairGroupAccFeesDeltas = (i, pairGroups, initialFees, pairIndex, long,
     }
     return { deltaGroup, deltaPair, beforeTradeOpen };
 };
-const getPendingAccFees = (accFeeLong, accFeeShort, oiLong, oiShort, feePerBlock, currentBlock, accLastUpdatedBlock, maxOi, feeExponent) => {
+const getPendingAccFees = (accFeeLong, accFeeShort, oiLong, oiShort, feePerBlock, currentBlock, accLastUpdatedBlock, maxOi, feeExponent, feeCaps // as percentage: eg minP: 0.1 = 10%, maxP: 0.5 = 50%
+) => {
     const moreShorts = oiLong < oiShort;
+    const blockDistance = currentBlock > accLastUpdatedBlock ? currentBlock - accLastUpdatedBlock : 0;
+    // If block distance is zero nothing changes
+    if (blockDistance === 0) {
+        return {
+            accFeeLong,
+            accFeeShort,
+            deltaLong: 0,
+            deltaShort: 0,
+        };
+    }
     const netOi = Math.abs(oiLong - oiShort);
-    const delta = maxOi > 0 && feeExponent > 0
-        ? feePerBlock *
-            (currentBlock - accLastUpdatedBlock) *
-            Math.pow((netOi / maxOi), feeExponent)
+    // Calculate minimum and maximum effective oi
+    const { minP, maxP } = getFeePerBlockCaps(feeCaps);
+    const minNetOi = maxOi * minP;
+    const maxNetOi = maxOi * maxP;
+    // Calculate the minimum acc fee delta (applies to both sides)
+    const minDelta = minNetOi > 0
+        ? getPendingAccFeesDelta(blockDistance, feePerBlock, netOi, maxOi, feeExponent)
+        : 0;
+    // Calculate the actual acc fee (using capped oi of 100% or less)
+    const delta = netOi > minNetOi
+        ? getPendingAccFeesDelta(blockDistance, feePerBlock, Math.min(netOi, maxNetOi), // if netOi > cap, use cap
+        maxOi, feeExponent)
+        : minDelta;
+    const [deltaLong, deltaShort] = moreShorts
+        ? [minDelta, delta]
+        : [delta, minDelta];
+    return {
+        accFeeLong: accFeeLong + deltaLong,
+        accFeeShort: accFeeShort + deltaShort,
+        deltaLong,
+        deltaShort,
+    };
+};
+const getPendingAccFeesDelta = (blockDistance, feePerBlock, netOi, maxOi, feeExponent) => {
+    return maxOi > 0 && feeExponent > 0
+        ? feePerBlock * blockDistance * Math.pow((netOi / maxOi), feeExponent)
         : 0;
-    const newAccFeeLong = moreShorts ? accFeeLong : accFeeLong + delta;
-    const newAccFeeShort = moreShorts ? accFeeShort + delta : accFeeShort;
-    return { accFeeLong: newAccFeeLong, accFeeShort: newAccFeeShort, delta };
+};
+const getFeePerBlockCaps = (cap) => {
+    return {
+        minP: (cap === null || cap === void 0 ? void 0 : cap.minP) || 0,
+        maxP: (cap === null || cap === void 0 ? void 0 : cap.maxP) && cap.maxP > 0 ? cap.maxP : 1,
+    };
 };
 const getBorrowingDataActiveFeePerBlock = (val) => {
     const { long, short, max } = val.oi;
-    const netOi = Math.abs(long - short);
-    return val.feePerBlock * Math.pow((netOi / max), val.feeExponent);
+    const { minP, maxP } = getFeePerBlockCaps("feePerBlockCap" in val ? val.feePerBlockCap : undefined);
+    // Calculate the effective open interest
+    // If minP > 0 then netOi has to be at least minP * maxOi
+    // If maxP > 0 then netOi cannot be more than maxP * maxOi
+    const effectiveOi = Math.min(Math.max(Math.abs(long - short), max * minP), max * maxP);
+    return val.feePerBlock * Math.pow((effectiveOi / max), val.feeExponent);
 };
 const getActiveFeePerBlock = (pair, group) => {
     const pairFeePerBlock = getBorrowingDataActiveFeePerBlock(pair);
@@ -162,6 +202,8 @@ exports.borrowingFeeUtils = {
     getActiveFeePerBlock,
     getBorrowingDataActiveFeePerBlock,
     getPairGroupIndex,
+    getPendingAccFeesDelta,
+    getFeePerBlockCaps,
 };
 exports.BorrowingFee = __importStar(require("./types"));
 __exportStar(require("./converter"), exports);

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

@@ -20,8 +20,13 @@ export type PairGroup = {
 export type BorrowingOi = {
     oi: OpenInterest;
 };
+export type BorrowingFeePerBlockCap = {
+    minP: number;
+    maxP: number;
+};
 export type Pair = BorrowingData & BorrowingOi & {
     groups: PairGroup[];
+    feePerBlockCap?: BorrowingFeePerBlockCap;
 };
 export type Group = BorrowingData & BorrowingOi;
 export type InitialAccFees = {

package/lib/trade/types.d.ts

@@ -561,5 +561,9 @@ export declare enum PairIndex {
     VVVUSD = 339,
     VINEUSD = 340,
     TOSHIUSD = 341,
-    BERAUSD = 342
+    BERAUSD = 342,
+    LAYERUSD = 343,
+    CHEEMSUSD = 344,
+    SOLVUSD = 345,
+    TSTUSD = 346
 }

package/lib/trade/types.js

@@ -372,4 +372,8 @@ var PairIndex;
     PairIndex[PairIndex["VINEUSD"] = 340] = "VINEUSD";
     PairIndex[PairIndex["TOSHIUSD"] = 341] = "TOSHIUSD";
     PairIndex[PairIndex["BERAUSD"] = 342] = "BERAUSD";
+    PairIndex[PairIndex["LAYERUSD"] = 343] = "LAYERUSD";
+    PairIndex[PairIndex["CHEEMSUSD"] = 344] = "CHEEMSUSD";
+    PairIndex[PairIndex["SOLVUSD"] = 345] = "SOLVUSD";
+    PairIndex[PairIndex["TSTUSD"] = 346] = "TSTUSD";
 })(PairIndex = exports.PairIndex || (exports.PairIndex = {}));

package/package.json

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