@gainsnetwork/sdk 0.0.0-me-rc1

package/lib/contracts/types/generated/factories/index.d.ts

@@ -0,0 +1,3 @@
+export { GNSMultiCollatDiamond__factory } from "./GNSMultiCollatDiamond__factory";
+export { GToken__factory } from "./GToken__factory";
+export { GTokenOpenPnlFeed__factory } from "./GTokenOpenPnlFeed__factory";

package/lib/contracts/types/generated/factories/index.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GTokenOpenPnlFeed__factory = exports.GToken__factory = exports.GNSMultiCollatDiamond__factory = void 0;
+/* Autogenerated file. Do not edit manually. */
+/* tslint:disable */
+/* eslint-disable */
+var GNSMultiCollatDiamond__factory_1 = require("./GNSMultiCollatDiamond__factory");
+Object.defineProperty(exports, "GNSMultiCollatDiamond__factory", { enumerable: true, get: function () { return GNSMultiCollatDiamond__factory_1.GNSMultiCollatDiamond__factory; } });
+var GToken__factory_1 = require("./GToken__factory");
+Object.defineProperty(exports, "GToken__factory", { enumerable: true, get: function () { return GToken__factory_1.GToken__factory; } });
+var GTokenOpenPnlFeed__factory_1 = require("./GTokenOpenPnlFeed__factory");
+Object.defineProperty(exports, "GTokenOpenPnlFeed__factory", { enumerable: true, get: function () { return GTokenOpenPnlFeed__factory_1.GTokenOpenPnlFeed__factory; } });

package/lib/contracts/types/generated/index.d.ts

@@ -0,0 +1,7 @@
+export type { GNSMultiCollatDiamond } from "./GNSMultiCollatDiamond";
+export type { GToken } from "./GToken";
+export type { GTokenOpenPnlFeed } from "./GTokenOpenPnlFeed";
+export * as factories from "./factories";
+export { GNSMultiCollatDiamond__factory } from "./factories/GNSMultiCollatDiamond__factory";
+export { GToken__factory } from "./factories/GToken__factory";
+export { GTokenOpenPnlFeed__factory } from "./factories/GTokenOpenPnlFeed__factory";

package/lib/contracts/types/generated/index.js

@@ -0,0 +1,33 @@
+"use strict";
+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.GTokenOpenPnlFeed__factory = exports.GToken__factory = exports.GNSMultiCollatDiamond__factory = exports.factories = void 0;
+exports.factories = __importStar(require("./factories"));
+var GNSMultiCollatDiamond__factory_1 = require("./factories/GNSMultiCollatDiamond__factory");
+Object.defineProperty(exports, "GNSMultiCollatDiamond__factory", { enumerable: true, get: function () { return GNSMultiCollatDiamond__factory_1.GNSMultiCollatDiamond__factory; } });
+var GToken__factory_1 = require("./factories/GToken__factory");
+Object.defineProperty(exports, "GToken__factory", { enumerable: true, get: function () { return GToken__factory_1.GToken__factory; } });
+var GTokenOpenPnlFeed__factory_1 = require("./factories/GTokenOpenPnlFeed__factory");
+Object.defineProperty(exports, "GTokenOpenPnlFeed__factory", { enumerable: true, get: function () { return GTokenOpenPnlFeed__factory_1.GTokenOpenPnlFeed__factory; } });

package/lib/contracts/types/index.d.ts

@@ -0,0 +1,37 @@
+import { GTokenOpenPnlFeed, GToken, GNSMultiCollatDiamond } from "./generated";
+export type Contracts = {
+    gnsMultiCollatDiamond: GNSMultiCollatDiamond;
+    gTokenOpenPnlFeed: GTokenOpenPnlFeed;
+    gToken: GToken;
+};
+export type ContractAddresses = {
+    gnsMultiCollatDiamond: string;
+    gTokenOpenPnlFeed: string;
+    gToken: string;
+};
+export type BlockTag = number | "latest" | "pending";
+export declare enum CollateralTypes {
+    DAI = "DAI",
+    ETH = "ETH",
+    ARB = "ARB",
+    USDC = "USDC",
+    APE = "APE",
+    GNS = "GNS",
+    BTCUSD = "BTCUSD",
+    USDM = "USDM"
+}
+export declare enum ContractsVersion {
+    BEFORE_V9_2 = 0,
+    V9_2 = 1,
+    V10 = 2
+}
+export type ContractAddressList = Record<string, Partial<Record<CollateralTypes | "global", Partial<ContractAddresses>>>>;
+export declare enum ChainId {
+    POLYGON = 137,
+    ARBITRUM = 42161,
+    ARBITRUM_SEPOLIA = 421614,
+    BASE = 8453,
+    APECHAIN = 33139,
+    MEGAETH = 4326,
+    MEGAETH_TESTNET = 6343
+}

package/lib/contracts/types/index.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChainId = exports.ContractsVersion = exports.CollateralTypes = void 0;
+var CollateralTypes;
+(function (CollateralTypes) {
+    CollateralTypes["DAI"] = "DAI";
+    CollateralTypes["ETH"] = "ETH";
+    CollateralTypes["ARB"] = "ARB";
+    CollateralTypes["USDC"] = "USDC";
+    CollateralTypes["APE"] = "APE";
+    CollateralTypes["GNS"] = "GNS";
+    CollateralTypes["BTCUSD"] = "BTCUSD";
+    CollateralTypes["USDM"] = "USDM";
+})(CollateralTypes = exports.CollateralTypes || (exports.CollateralTypes = {}));
+var ContractsVersion;
+(function (ContractsVersion) {
+    ContractsVersion[ContractsVersion["BEFORE_V9_2"] = 0] = "BEFORE_V9_2";
+    ContractsVersion[ContractsVersion["V9_2"] = 1] = "V9_2";
+    ContractsVersion[ContractsVersion["V10"] = 2] = "V10";
+})(ContractsVersion = exports.ContractsVersion || (exports.ContractsVersion = {}));
+var ChainId;
+(function (ChainId) {
+    ChainId[ChainId["POLYGON"] = 137] = "POLYGON";
+    ChainId[ChainId["ARBITRUM"] = 42161] = "ARBITRUM";
+    ChainId[ChainId["ARBITRUM_SEPOLIA"] = 421614] = "ARBITRUM_SEPOLIA";
+    ChainId[ChainId["BASE"] = 8453] = "BASE";
+    ChainId[ChainId["APECHAIN"] = 33139] = "APECHAIN";
+    ChainId[ChainId["MEGAETH"] = 4326] = "MEGAETH";
+    ChainId[ChainId["MEGAETH_TESTNET"] = 6343] = "MEGAETH_TESTNET";
+})(ChainId = exports.ChainId || (exports.ChainId = {}));

package/lib/contracts/utils/borrowingFees.d.ts

@@ -0,0 +1,9 @@
+import { GNSMultiCollatDiamond } from "../types/generated";
+import { BorrowingFee } from "../../trade";
+export declare const getBorrowingGroupName: (groupIndex: number) => string;
+export declare const fetchAllPairBorrowingFees: (contract: GNSMultiCollatDiamond, collateralIndex: number) => Promise<BorrowingFee.Pair[]>;
+export declare const fetchGroupBorrowingFees: (contract: GNSMultiCollatDiamond, collateralIndex: number, groupIxs: number[]) => Promise<BorrowingFee.Group[]>;
+export declare const fetchAllPairAndGroupBorrowingFees: (contract: GNSMultiCollatDiamond, collateralIndex: number) => Promise<{
+    pairs: BorrowingFee.Pair[];
+    groups: BorrowingFee.Group[];
+}>;

package/lib/contracts/utils/borrowingFees.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchAllPairAndGroupBorrowingFees = exports.fetchGroupBorrowingFees = exports.fetchAllPairBorrowingFees = exports.getBorrowingGroupName = void 0;
+const trade_1 = require("../../trade");
+const getBorrowingGroupName = (groupIndex) => {
+    const groupNamesByIndex = [
+        "Crypto Core",
+        "Crypto Altcoins",
+        "Forex USD Majors",
+        "Forex USD-Quoted Majors",
+        "Forex EUR Majors",
+        "Indices",
+        "Stocks",
+        "Commodities",
+        "Forex USD Minors",
+        "Forex Nordic",
+        "Forex GBP Majors",
+        "Forex AUD",
+        "Forex NZD",
+        "Crypto Degen",
+    ];
+    return groupNamesByIndex[groupIndex - 1] || "Unknown";
+};
+exports.getBorrowingGroupName = getBorrowingGroupName;
+const fetchAllPairBorrowingFees = async (contract, collateralIndex) => {
+    const [pairs, pairOi, pairGroups] = await contract.getAllBorrowingPairs(collateralIndex);
+    const feeCaps = await contract.getBorrowingPairFeePerBlockCaps(collateralIndex, [...Array(pairs.length).keys()]);
+    return (0, trade_1.convertPairBorrowingFees)([pairs, pairOi, pairGroups, feeCaps]);
+};
+exports.fetchAllPairBorrowingFees = fetchAllPairBorrowingFees;
+const fetchGroupBorrowingFees = async (contract, collateralIndex, groupIxs) => (0, trade_1.convertGroupBorrowingFees)(await contract.getBorrowingGroups(collateralIndex, groupIxs));
+exports.fetchGroupBorrowingFees = fetchGroupBorrowingFees;
+const fetchAllPairAndGroupBorrowingFees = async (contract, collateralIndex) => {
+    const pairs = await (0, exports.fetchAllPairBorrowingFees)(contract, collateralIndex);
+    const groupIxs = [
+        ...new Set(pairs
+            .map(value => value.groups.map(value => value.groupIndex))
+            .reduce((acc, value) => acc.concat(value), [])),
+    ].sort((a, b) => a - b);
+    const groups = await (0, exports.fetchGroupBorrowingFees)(contract, collateralIndex, groupIxs);
+    return { pairs, groups };
+};
+exports.fetchAllPairAndGroupBorrowingFees = fetchAllPairAndGroupBorrowingFees;

package/lib/contracts/utils/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./openTrades";
+export * from "./pairs";
+export * from "./borrowingFees";

package/lib/contracts/utils/index.js

@@ -0,0 +1,19 @@
+"use strict";
+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 __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 });
+__exportStar(require("./openTrades"), exports);
+__exportStar(require("./pairs"), exports);
+__exportStar(require("./borrowingFees"), exports);

package/lib/contracts/utils/openTrades.d.ts

@@ -0,0 +1,12 @@
+import { TradeContainer, TradeContainerRaw } from "../../trade/types";
+import { Contracts, BlockTag } from "../../contracts/types";
+export type FetchOpenPairTradesOverrides = {
+    traders?: string[];
+    batchSize?: number;
+    useMulticall?: boolean;
+    includeLimits?: boolean;
+    blockTag?: BlockTag;
+    includeUIRealizedPnlData?: boolean;
+};
+export declare const fetchOpenPairTrades: (contracts: Contracts, overrides?: FetchOpenPairTradesOverrides) => Promise<TradeContainer[]>;
+export declare const fetchOpenPairTradesRaw: (contracts: Contracts, overrides?: FetchOpenPairTradesOverrides) => Promise<TradeContainerRaw[]>;

package/lib/contracts/utils/openTrades.js

@@ -0,0 +1,172 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchOpenPairTradesRaw = exports.fetchOpenPairTrades = void 0;
+const ethcall_1 = require("ethcall");
+const ethers_1 = require("ethers");
+const trade_1 = require("../../trade");
+const fetchOpenPairTrades = async (contracts, overrides = {}) => {
+    const rawTrades = await (0, exports.fetchOpenPairTradesRaw)(contracts, overrides);
+    const collaterals = await contracts.gnsMultiCollatDiamond.getCollaterals();
+    const collateralConfigs = collaterals.map(c => ({
+        collateral: c.collateral,
+        isActive: c.isActive,
+        precision: parseFloat(c.precision.toString()),
+        precisionDelta: parseFloat(c.precisionDelta.toString()),
+    }));
+    return rawTrades.map(rawTrade => _prepareTradeContainer(rawTrade.trade, rawTrade.tradeInfo, rawTrade.liquidationParams, rawTrade.initialAccFees, rawTrade.tradeFeesData, rawTrade.uiRealizedPnlData, collateralConfigs[parseInt(rawTrade.trade.collateralIndex.toString()) - 1]));
+};
+exports.fetchOpenPairTrades = fetchOpenPairTrades;
+const fetchOpenPairTradesRaw = async (contracts, overrides = {}) => {
+    if (!contracts) {
+        return [];
+    }
+    const { batchSize = 50, includeLimits = true, useMulticall = false, includeUIRealizedPnlData = true, traders = [], } = overrides;
+    const { gnsMultiCollatDiamond: multiCollatDiamondContract } = contracts;
+    try {
+        const multicallCtx = {
+            provider: new ethcall_1.Provider(),
+            diamond: new ethcall_1.Contract(multiCollatDiamondContract.address, [
+                ...multiCollatDiamondContract.interface.fragments,
+            ]),
+        };
+        const validatedAddresses = _validateAddresses(traders || []);
+        const forTraders = validatedAddresses.length > 0;
+        if (useMulticall) {
+            await multicallCtx.provider.init(multiCollatDiamondContract.provider);
+        }
+        let allOpenPairTrades = [];
+        let running = true;
+        let offset = 0;
+        while (running) {
+            const [trades, tradeInfos, tradeLiquidationParams] = await Promise.all(forTraders
+                ? [
+                    multiCollatDiamondContract.getAllTradesForTraders(validatedAddresses, offset, offset + batchSize),
+                    multiCollatDiamondContract.getAllTradeInfosForTraders(validatedAddresses, offset, offset + batchSize),
+                    multiCollatDiamondContract.getAllTradesLiquidationParamsForTraders(validatedAddresses, offset, offset + batchSize),
+                ]
+                : [
+                    multiCollatDiamondContract.getAllTrades(offset, offset + batchSize),
+                    multiCollatDiamondContract.getAllTradeInfos(offset, offset + batchSize),
+                    multiCollatDiamondContract.getAllTradesLiquidationParams(offset, offset + batchSize),
+                ]);
+            const fundingFeesCallParams = [
+                [],
+                [], // indices
+            ];
+            // Array is always of length `batchSize`
+            // so we need to filter out the empty trades, indexes are reliable
+            const openTrades = trades
+                .filter(t => t.collateralIndex > 0 &&
+                (includeLimits || (!includeLimits && t.tradeType === 0)))
+                .map((trade, ix) => {
+                fundingFeesCallParams[0].push(trade.user);
+                fundingFeesCallParams[1].push(trade.index);
+                return {
+                    trade,
+                    tradeInfo: tradeInfos[ix],
+                    liquidationParams: tradeLiquidationParams[ix],
+                    initialAccFees: {
+                        accPairFee: 0,
+                        accGroupFee: 0,
+                        block: 0,
+                        __placeholder: 0,
+                    },
+                    tradeFeesData: {
+                        realizedTradingFeesCollateral: 0,
+                        realizedPnlCollateral: 0,
+                        manuallyRealizedNegativePnlCollateral: 0,
+                        alreadyTransferredNegativePnlCollateral: 0,
+                        virtualAvailableCollateralInDiamond: 0,
+                        initialAccFundingFeeP: 0,
+                        initialAccBorrowingFeeP: 0,
+                        __placeholder: 0,
+                    },
+                    uiRealizedPnlData: undefined,
+                };
+            });
+            const [tradeFeesData, uiRealizedPnlData] = await Promise.all([
+                multiCollatDiamondContract.getTradeFeesDataArray(...fundingFeesCallParams),
+                includeUIRealizedPnlData
+                    ? multiCollatDiamondContract.getTradeUiRealizedPnlDataArray(...fundingFeesCallParams)
+                    : [],
+            ]);
+            const initialAccFeesPromises = openTrades
+                .map(({ trade }) => ({
+                collateralIndex: trade.collateralIndex,
+                user: trade.user,
+                index: trade.index,
+            }))
+                .map(({ collateralIndex, user, index }) => (useMulticall
+                ? multicallCtx.diamond
+                : multiCollatDiamondContract).getBorrowingInitialAccFees(collateralIndex, user, index));
+            const initialAccFees = await (useMulticall
+                ? multicallCtx.provider.all(initialAccFeesPromises)
+                : Promise.all(initialAccFeesPromises));
+            initialAccFees.forEach((accFees, ix) => {
+                openTrades[ix].initialAccFees = accFees;
+                openTrades[ix].tradeFeesData = tradeFeesData[ix];
+                openTrades[ix].uiRealizedPnlData = uiRealizedPnlData?.[ix];
+            });
+            allOpenPairTrades = allOpenPairTrades.concat(openTrades);
+            offset += batchSize + 1;
+            running =
+                parseInt(trades[trades.length - 1].collateralIndex.toString()) > 0;
+        }
+        return allOpenPairTrades;
+    }
+    catch (error) {
+        console.error(`Unexpected error while fetching open pair trades!`);
+        throw error;
+    }
+};
+exports.fetchOpenPairTradesRaw = fetchOpenPairTradesRaw;
+const _prepareTradeContainer = (trade, tradeInfo, tradeLiquidationParams, tradeInitialAccFees, tradeFeesData, uiRealizedPnlData, collateralConfig) => {
+    const precision = collateralConfig.precision;
+    return {
+        trade: {
+            user: trade.user,
+            index: parseInt(trade.index.toString()),
+            pairIndex: parseInt(trade.pairIndex.toString()),
+            leverage: parseFloat(trade.leverage.toString()) / 1e3,
+            long: trade.long.toString() === "true",
+            isOpen: trade.isOpen.toString() === "true",
+            collateralIndex: parseInt(trade.collateralIndex.toString()),
+            tradeType: trade.tradeType,
+            collateralAmount: parseFloat(trade.collateralAmount.toString()) / precision,
+            openPrice: parseFloat(trade.openPrice.toString()) / 1e10,
+            tp: parseFloat(trade.tp.toString()) / 1e10,
+            sl: parseFloat(trade.sl.toString()) / 1e10,
+            isCounterTrade: trade.isCounterTrade,
+            positionSizeToken: parseFloat(trade.positionSizeToken.toString()) / 1e18,
+        },
+        tradeInfo: {
+            createdBlock: parseInt(tradeInfo.createdBlock.toString()),
+            tpLastUpdatedBlock: parseInt(tradeInfo.tpLastUpdatedBlock.toString()),
+            slLastUpdatedBlock: parseInt(tradeInfo.slLastUpdatedBlock.toString()),
+            maxSlippageP: parseFloat(tradeInfo.maxSlippageP.toString()) / 1e3,
+            lastOiUpdateTs: parseFloat(tradeInfo.lastOiUpdateTs),
+            collateralPriceUsd: parseFloat(tradeInfo.collateralPriceUsd.toString()) / 1e8,
+            contractsVersion: parseInt(tradeInfo.contractsVersion.toString()),
+            lastPosIncreaseBlock: parseInt(tradeInfo.lastPosIncreaseBlock.toString()),
+        },
+        liquidationParams: (0, trade_1.convertLiquidationParams)(tradeLiquidationParams),
+        initialAccFees: {
+            accPairFee: parseFloat(tradeInitialAccFees.accPairFee.toString()) / 1e10,
+            accGroupFee: parseFloat(tradeInitialAccFees.accGroupFee.toString()) / 1e10,
+            block: parseFloat(tradeInitialAccFees.block.toString()),
+        },
+        tradeFeesData: (0, trade_1.convertTradeFeesData)(tradeFeesData, collateralConfig),
+        uiRealizedPnlData: uiRealizedPnlData
+            ? (0, trade_1.convertUiRealizedPnlData)(uiRealizedPnlData, collateralConfig)
+            : undefined,
+    };
+};
+/**
+ * Filters out duplicate addresses. Throws error if an invalid address is provided.
+ * @param addresses
+ */
+const _validateAddresses = (addresses) => {
+    return [
+        ...new Set(addresses.map(address => ethers_1.ethers.utils.getAddress(address))),
+    ];
+};

package/lib/contracts/utils/pairs.d.ts

@@ -0,0 +1,18 @@
+import { Fee, OpenInterest, Pair, PairIndex } from "../../trade/types";
+import { Contracts } from "../../contracts/types";
+export declare const fetchPairs: (contracts: Contracts, pairIxs: PairIndex[]) => Promise<Pair[]>;
+export declare const fetchPairDepthBands: (contracts: Contracts, pairIxs: number[]) => Promise<any[]>;
+export declare const fetchPairDepthBandsDecoded: (contracts: Contracts, pairIxs: number[]) => Promise<{
+    totalDepthAboveUsd: number[];
+    totalDepthBelowUsd: number[];
+    bandsAbove: number[][];
+    bandsBelow: number[][];
+}>;
+export declare const fetchDepthBandsMapping: (contracts: Contracts) => Promise<{
+    slot1: string;
+    slot2: string;
+}>;
+export declare const fetchDepthBandsMappingDecoded: (contracts: Contracts) => Promise<number[]>;
+export declare const fetchFees: (contracts: Contracts, feeIxs: PairIndex[]) => Promise<Fee[]>;
+export declare const fetchOpenInterest: (contracts: Contracts, collateralIndex: number, pairIxs: number[]) => Promise<OpenInterest[]>;
+export declare const getPairDescription: (pairIndex: PairIndex) => string;