@gainsnetwork/sdk 1.5.0-rc6 → 1.6.0-rc1

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

@@ -4,7 +4,7 @@
  * @dev All BigNumber values are normalized to floats with appropriate precision
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.convertTraderFeeTiersData = exports.convertFeeTiersConfig = exports.convertTraderEnrollment = exports.convertTraderInfo = exports.convertFeeTierArray = exports.convertFeeTier = void 0;
+exports.convertTraderFeeTiersData = exports.convertFeeTiersConfig = exports.convertStakingInfo = exports.convertTraderEnrollment = exports.convertTraderInfo = exports.convertFeeTierArray = exports.convertFeeTier = void 0;
 /**
  * @dev Converts contract fee tier data to SDK format
  * @param contractData Contract FeeTier struct
@@ -13,7 +13,7 @@ exports.convertTraderFeeTiersData = exports.convertFeeTiersConfig = exports.conv
 const convertFeeTier = (contractData) => {
     return {
         feeMultiplier: Number(contractData.feeMultiplier) / 1e3,
-        pointsThreshold: Number(contractData.pointsThreshold) / 1e18, // Points in 1e18 precision
+        pointsThreshold: Number(contractData.pointsThreshold), // 0 precision
     };
 };
 exports.convertFeeTier = convertFeeTier;
@@ -49,33 +49,52 @@ const convertTraderEnrollment = (contractData) => {
     };
 };
 exports.convertTraderEnrollment = convertTraderEnrollment;
+/**
+ * @dev Converts contract gns staking info to SDK format
+ * @param contractData Contract GnsStakingInfo struct
+ * @returns Normalized gns staking info
+ */
+const convertStakingInfo = (contractData) => {
+    return {
+        stakedGns: Number(contractData.stakedGns) / 1e18,
+        stakedVaultGns: Number(contractData.stakedVaultGns) / 1e18,
+        bonusAmount: Number(contractData.bonusAmount),
+        stakeTimestamp: Number(contractData.stakeTimestamp),
+        feeMultiplierCache: Number(contractData.feeMultiplierCache) / 1e3,
+    };
+};
+exports.convertStakingInfo = convertStakingInfo;
 /**
  * @dev Converts the complete fee tiers configuration from contract format
- * @param tiers Array of fee tiers from contract
+ * @param tiers Array of volume fee tiers from contract
  * @param groupVolumeMultipliers Array of group volume multipliers
  * @param currentDay Current day from contract
+ * @param stakingTiers Array of staking fee tiers from contract
  * @returns Complete fee tiers configuration
  */
-const convertFeeTiersConfig = (tiers, groupVolumeMultipliers, currentDay) => {
+const convertFeeTiersConfig = (tiers, groupVolumeMultipliers, currentDay, stakingTiers) => {
     return {
         tiers: (0, exports.convertFeeTierArray)(tiers),
         groupVolumeMultipliers: groupVolumeMultipliers.map(m => Number(m) / 1e3),
         currentDay: Number(currentDay),
+        stakingTiers: (0, exports.convertFeeTierArray)(stakingTiers),
     };
 };
 exports.convertFeeTiersConfig = convertFeeTiersConfig;
 /**
- * @dev Converts trader's fee tier data from contract format
+ * @dev Converts trader's volume and staking fee tier data from contract format
  * @param traderInfo Trader info from contract
  * @param traderDailyInfo Array of daily points info
  * @param traderEnrollment Enrollment status from contract
- * @returns Complete trader fee tier data
+ * @param stakingInfo Staking info from contract
+ * @returns Complete trader volume and staking fee tier data
  */
-const convertTraderFeeTiersData = (traderInfo, traderDailyInfo, traderEnrollment) => {
+const convertTraderFeeTiersData = (traderInfo, traderDailyInfo, traderEnrollment, stakingInfo) => {
     return {
         traderInfo: (0, exports.convertTraderInfo)(traderInfo),
         dailyPoints: traderDailyInfo.map(points => Number(points) / 1e18),
         traderEnrollment: (0, exports.convertTraderEnrollment)(traderEnrollment),
+        stakingInfo: (0, exports.convertStakingInfo)(stakingInfo),
     };
 };
 exports.convertTraderFeeTiersData = convertTraderFeeTiersData;

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

@@ -5,12 +5,15 @@ export * from "./converter";
 export declare const TRAILING_PERIOD_DAYS = 30;
 export declare const FEE_MULTIPLIER_SCALE = 1;
 export declare const MAX_FEE_TIERS = 8;
+export declare const GNS_STAKING_COOLDOWN_SECONDS = 86400;
 export declare const getCurrentDay: () => number;
 export declare const getFeeTiersCount: (feeTiers: FeeTier[]) => number;
 export declare const getFeeMultiplier: (trailingPoints: number, tiers: FeeTier[]) => number;
 export declare const computeFeeMultiplier: (feeTiers: FeeTiers, traderFeeTiers: TraderFeeTiers) => {
     feeMultiplier: number;
+    volumeFeeMultiplier: number;
     trailingPoints: number;
+    stakingFeeMultiplier: number;
 };
 /**
  * @dev Calculates the final fee amount after applying the trader's fee tier discount
@@ -22,9 +25,13 @@ export declare const computeFeeMultiplier: (feeTiers: FeeTiers, traderFeeTiers:
  */
 export declare const calculateFeeAmount: (trader: string, normalFeeAmountCollateral: number, feeMultiplier?: number) => number;
 /**
- * @dev Helper function to get trader's fee multiplier from fee tiers data
+ * @dev Helper function to get trader's fee multiplier from volume and staking fee tiers data
  * @param feeTiers System fee tiers configuration
  * @param traderFeeTiers Trader's fee tier data
  * @returns Fee multiplier (1e3 precision)
  */
 export declare const getTraderFeeMultiplier: (feeTiers: FeeTiers, traderFeeTiers: TraderFeeTiers) => number;
+export declare const isGnsStakingCooldownActive: (traderFeeTiers: TraderFeeTiers) => {
+    isActive: boolean;
+    expiryTs: number;
+};

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

@@ -14,13 +14,14 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getTraderFeeMultiplier = exports.calculateFeeAmount = exports.computeFeeMultiplier = exports.getFeeMultiplier = exports.getFeeTiersCount = exports.getCurrentDay = exports.MAX_FEE_TIERS = exports.FEE_MULTIPLIER_SCALE = exports.TRAILING_PERIOD_DAYS = void 0;
+exports.isGnsStakingCooldownActive = exports.getTraderFeeMultiplier = exports.calculateFeeAmount = exports.computeFeeMultiplier = exports.getFeeMultiplier = exports.getFeeTiersCount = exports.getCurrentDay = exports.GNS_STAKING_COOLDOWN_SECONDS = exports.MAX_FEE_TIERS = exports.FEE_MULTIPLIER_SCALE = exports.TRAILING_PERIOD_DAYS = void 0;
 const types_1 = require("./types");
 __exportStar(require("./types"), exports);
 __exportStar(require("./converter"), exports);
 exports.TRAILING_PERIOD_DAYS = 30;
 exports.FEE_MULTIPLIER_SCALE = 1;
 exports.MAX_FEE_TIERS = 8;
+exports.GNS_STAKING_COOLDOWN_SECONDS = 86400; // 1 day in seconds
 const getCurrentDay = () => Math.floor(Date.now() / 1000 / 60 / 60 / 24);
 exports.getCurrentDay = getCurrentDay;
 const getFeeTiersCount = (feeTiers) => {
@@ -46,7 +47,7 @@ const getFeeMultiplier = (trailingPoints, tiers) => {
 exports.getFeeMultiplier = getFeeMultiplier;
 const computeFeeMultiplier = (feeTiers, traderFeeTiers) => {
     const { currentDay, tiers } = feeTiers;
-    const { traderInfo, expiredPoints, lastDayUpdatedPoints, traderEnrollment } = traderFeeTiers;
+    const { traderInfo, expiredPoints, lastDayUpdatedPoints, traderEnrollment, stakingInfo, } = traderFeeTiers;
     const { lastDayUpdated, trailingPoints } = traderInfo;
     let curTrailingPoints = trailingPoints;
     if (currentDay > lastDayUpdated) {
@@ -58,12 +59,22 @@ const computeFeeMultiplier = (feeTiers, traderFeeTiers) => {
             curTrailingPoints -= expiredTrailingPoints;
         }
     }
-    const feeMultiplier = traderEnrollment.status === types_1.TraderEnrollmentStatus.EXCLUDED
+    const isTraderExcluded = traderEnrollment.status === types_1.TraderEnrollmentStatus.EXCLUDED;
+    // Fee multiplier from volume tiers
+    const volumeFeeMultiplier = isTraderExcluded
         ? exports.FEE_MULTIPLIER_SCALE
         : (0, exports.getFeeMultiplier)(curTrailingPoints, tiers);
+    // Fee multiplier from staking tiers
+    const stakingFeeMultiplier = isTraderExcluded || stakingInfo.feeMultiplierCache === 0
+        ? exports.FEE_MULTIPLIER_SCALE
+        : stakingInfo.feeMultiplierCache;
+    // Total fee multiplier is the product of both multipliers
+    const totalFeeMultiplier = volumeFeeMultiplier * stakingFeeMultiplier;
     return {
-        feeMultiplier,
+        feeMultiplier: totalFeeMultiplier,
+        volumeFeeMultiplier: volumeFeeMultiplier,
         trailingPoints: curTrailingPoints,
+        stakingFeeMultiplier: stakingFeeMultiplier,
     };
 };
 exports.computeFeeMultiplier = computeFeeMultiplier;
@@ -85,7 +96,7 @@ const calculateFeeAmount = (trader, normalFeeAmountCollateral, feeMultiplier) =>
 };
 exports.calculateFeeAmount = calculateFeeAmount;
 /**
- * @dev Helper function to get trader's fee multiplier from fee tiers data
+ * @dev Helper function to get trader's fee multiplier from volume and staking fee tiers data
  * @param feeTiers System fee tiers configuration
  * @param traderFeeTiers Trader's fee tier data
  * @returns Fee multiplier (1e3 precision)
@@ -95,3 +106,9 @@ const getTraderFeeMultiplier = (feeTiers, traderFeeTiers) => {
     return feeMultiplier;
 };
 exports.getTraderFeeMultiplier = getTraderFeeMultiplier;
+const isGnsStakingCooldownActive = (traderFeeTiers) => {
+    const now = Math.floor(Date.now() / 1000);
+    const expiryTs = traderFeeTiers.stakingInfo.stakeTimestamp + exports.GNS_STAKING_COOLDOWN_SECONDS;
+    return { isActive: now < expiryTs, expiryTs };
+};
+exports.isGnsStakingCooldownActive = isGnsStakingCooldownActive;

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

@@ -13,3 +13,10 @@ export declare enum TraderEnrollmentStatus {
 export type TraderEnrollment = {
     status: TraderEnrollmentStatus;
 };
+export type StakingInfo = {
+    stakedGns: number;
+    stakedVaultGns: number;
+    bonusAmount: number;
+    stakeTimestamp: number;
+    feeMultiplierCache: number;
+};

package/lib/trade/types.d.ts

@@ -1,6 +1,6 @@
 import { ITradingStorage, IBorrowingFees, IPairsStorage, IFundingFees } from "../contracts/types/generated/GNSMultiCollatDiamond";
 import { BorrowingFee } from "./fees/borrowing";
-import { FeeTier, TraderEnrollment, TraderInfo } from "./fees/tiers/types";
+import { FeeTier, TraderEnrollment, TraderInfo, StakingInfo } from "./fees/tiers/types";
 export type PairIndexes = {
     [key: string]: PairIndex;
 };
@@ -269,10 +269,14 @@ export type FeeTiers = {
     tiers: FeeTier[];
     multipliers: number[];
     currentDay: number;
+    stakingTiers: FeeTier[];
+    gnsVaultAddress?: string;
+    useGnsVaultBalance?: boolean;
 };
 export type TraderFeeTiers = {
     traderEnrollment: TraderEnrollment;
     traderInfo: TraderInfo;
+    stakingInfo: StakingInfo;
     inboundPoints: number;
     outboundPoints: number;
     lastDayUpdatedPoints: number;

package/package.json

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