@gainsnetwork/sdk 0.0.0-v10.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,32 @@
+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"
+}
+export declare enum ContractsVersion {
+    BEFORE_V9_2 = 0,
+    V9_2 = 1
+}
+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
+}

package/lib/contracts/types/index.js

@@ -0,0 +1,25 @@
+"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 = 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 = 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 = 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,54 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+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 = (contract, collateralIndex) => __awaiter(void 0, void 0, void 0, function* () {
+    const [pairs, pairOi, pairGroups] = yield contract.getAllBorrowingPairs(collateralIndex);
+    const feeCaps = yield contract.getBorrowingPairFeePerBlockCaps(collateralIndex, [...Array(pairs.length).keys()]);
+    return (0, trade_1.convertPairBorrowingFees)([pairs, pairOi, pairGroups, feeCaps]);
+});
+exports.fetchAllPairBorrowingFees = fetchAllPairBorrowingFees;
+const fetchGroupBorrowingFees = (contract, collateralIndex, groupIxs) => __awaiter(void 0, void 0, void 0, function* () {
+    return (0, trade_1.convertGroupBorrowingFees)(yield contract.getBorrowingGroups(collateralIndex, groupIxs));
+});
+exports.fetchGroupBorrowingFees = fetchGroupBorrowingFees;
+const fetchAllPairAndGroupBorrowingFees = (contract, collateralIndex) => __awaiter(void 0, void 0, void 0, function* () {
+    const pairs = yield (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 = yield (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,10 @@
+import { TradeContainer, TradeContainerRaw } from "../../trade/types";
+import { Contracts, BlockTag } from "../../contracts/types";
+export type FetchOpenPairTradesOverrides = {
+    batchSize?: number;
+    useMulticall?: boolean;
+    includeLimits?: boolean;
+    blockTag?: BlockTag;
+};
+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,126 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchOpenPairTradesRaw = exports.fetchOpenPairTrades = void 0;
+const ethcall_1 = require("ethcall");
+const fetchOpenPairTrades = (contracts, overrides = {}) => __awaiter(void 0, void 0, void 0, function* () {
+    const rawTrades = yield (0, exports.fetchOpenPairTradesRaw)(contracts, overrides);
+    const collateralPrecisions = (yield contracts.gnsMultiCollatDiamond.getCollaterals()).map(({ precision }) => precision);
+    return rawTrades.map(rawTrade => _prepareTradeContainer(rawTrade.trade, rawTrade.tradeInfo, rawTrade.liquidationParams, rawTrade.initialAccFees, collateralPrecisions[parseInt(rawTrade.trade.collateralIndex.toString()) - 1]));
+});
+exports.fetchOpenPairTrades = fetchOpenPairTrades;
+// @todo rename
+const fetchOpenPairTradesRaw = (contracts, overrides = {}) => __awaiter(void 0, void 0, void 0, function* () {
+    if (!contracts) {
+        return [];
+    }
+    const { batchSize = 50, includeLimits = true, useMulticall = false, } = overrides;
+    const { gnsMultiCollatDiamond: multiCollatDiamondContract } = contracts;
+    try {
+        const multicallCtx = {
+            provider: new ethcall_1.Provider(),
+            diamond: new ethcall_1.Contract(multiCollatDiamondContract.address, [
+                ...multiCollatDiamondContract.interface.fragments,
+            ]),
+        };
+        if (useMulticall) {
+            yield multicallCtx.provider.init(multiCollatDiamondContract.provider);
+        }
+        let allOpenPairTrades = [];
+        let running = true;
+        let offset = 0;
+        while (running) {
+            const trades = yield multiCollatDiamondContract.getAllTrades(offset, offset + batchSize);
+            const tradeInfos = yield multiCollatDiamondContract.getAllTradeInfos(offset, offset + batchSize);
+            const tradeLiquidationParams = yield multiCollatDiamondContract.getAllTradesLiquidationParams(offset, offset + batchSize);
+            // 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) => ({
+                trade,
+                tradeInfo: tradeInfos[ix],
+                liquidationParams: tradeLiquidationParams[ix],
+                initialAccFees: {
+                    accPairFee: 0,
+                    accGroupFee: 0,
+                    block: 0,
+                    __placeholder: 0,
+                },
+            }));
+            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 = yield (useMulticall
+                ? multicallCtx.provider.all(initialAccFeesPromises)
+                : Promise.all(initialAccFeesPromises));
+            initialAccFees.forEach((accFees, ix) => {
+                openTrades[ix].initialAccFees = accFees;
+            });
+            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, collateralPrecision) => ({
+    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()) /
+            parseFloat(collateralPrecision.toString()),
+        openPrice: parseFloat(trade.openPrice.toString()) / 1e10,
+        tp: parseFloat(trade.tp.toString()) / 1e10,
+        sl: parseFloat(trade.sl.toString()) / 1e10,
+    },
+    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: {
+        maxLiqSpreadP: parseFloat(tradeLiquidationParams.maxLiqSpreadP.toString()) / 1e12,
+        startLiqThresholdP: parseFloat(tradeLiquidationParams.startLiqThresholdP.toString()) / 1e12,
+        endLiqThresholdP: parseFloat(tradeLiquidationParams.endLiqThresholdP.toString()) / 1e12,
+        startLeverage: parseFloat(tradeLiquidationParams.startLeverage.toString()) / 1e3,
+        endLeverage: parseFloat(tradeLiquidationParams.endLeverage.toString()) / 1e3,
+    },
+    initialAccFees: {
+        accPairFee: parseFloat(tradeInitialAccFees.accPairFee.toString()) / 1e10,
+        accGroupFee: parseFloat(tradeInitialAccFees.accGroupFee.toString()) / 1e10,
+        block: parseFloat(tradeInitialAccFees.block.toString()),
+    },
+});

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

@@ -0,0 +1,7 @@
+import { Pair, Fee, OpenInterest, PairDepth, PairIndex } from "../../trade/types";
+import { Contracts } from "../../contracts/types";
+export declare const fetchPairs: (contracts: Contracts, pairIxs: PairIndex[]) => Promise<Pair[]>;
+export declare const fetchPairDepths: (contracts: Contracts, pairIxs: number[]) => Promise<PairDepth[]>;
+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;