@gainsnetwork/sdk 0.0.1
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/README.md +11 -0
- package/lib/contracts/index.d.ts +1 -0
- package/lib/contracts/index.js +17 -0
- package/lib/contracts/types/GFarmTradingStorageV5.d.ts +1911 -0
- package/lib/contracts/types/GFarmTradingStorageV5.js +2 -0
- package/lib/contracts/types/GNSPairInfosV6_1.d.ts +911 -0
- package/lib/contracts/types/GNSPairInfosV6_1.js +2 -0
- package/lib/contracts/types/GNSPairsStorageV6.d.ts +660 -0
- package/lib/contracts/types/GNSPairsStorageV6.js +2 -0
- package/lib/contracts/types/common.d.ts +22 -0
- package/lib/contracts/types/common.js +2 -0
- package/lib/contracts/types/factories/GFarmTradingStorageV5__factory.d.ts +83 -0
- package/lib/contracts/types/factories/GFarmTradingStorageV5__factory.js +2691 -0
- package/lib/contracts/types/factories/GNSPairInfosV6_1__factory.d.ts +98 -0
- package/lib/contracts/types/factories/GNSPairInfosV6_1__factory.js +1485 -0
- package/lib/contracts/types/factories/GNSPairsStorageV6__factory.d.ts +117 -0
- package/lib/contracts/types/factories/GNSPairsStorageV6__factory.js +1265 -0
- package/lib/contracts/types/factories/index.d.ts +3 -0
- package/lib/contracts/types/factories/index.js +12 -0
- package/lib/contracts/types/index.d.ts +7 -0
- package/lib/contracts/types/index.js +33 -0
- package/lib/contracts/utils/index.d.ts +1 -0
- package/lib/contracts/utils/index.js +17 -0
- package/lib/contracts/utils/openTrades.d.ts +8 -0
- package/lib/contracts/utils/openTrades.js +110 -0
- package/lib/index.d.ts +2 -0
- package/lib/index.js +18 -0
- package/lib/trade/fees.d.ts +15 -0
- package/lib/trade/fees.js +45 -0
- package/lib/trade/index.d.ts +2 -0
- package/lib/trade/index.js +18 -0
- package/lib/trade/pnl.d.ts +7 -0
- package/lib/trade/pnl.js +43 -0
- package/lib/trade/types.d.ts +143 -0
- package/lib/trade/types.js +8 -0
- package/package.json +102 -0
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.GNSPairsStorageV6__factory = exports.GNSPairInfosV6_1__factory = exports.GFarmTradingStorageV5__factory = void 0;
|
|
4
|
+
/* Autogenerated file. Do not edit manually. */
|
|
5
|
+
/* tslint:disable */
|
|
6
|
+
/* eslint-disable */
|
|
7
|
+
var GFarmTradingStorageV5__factory_1 = require("./GFarmTradingStorageV5__factory");
|
|
8
|
+
Object.defineProperty(exports, "GFarmTradingStorageV5__factory", { enumerable: true, get: function () { return GFarmTradingStorageV5__factory_1.GFarmTradingStorageV5__factory; } });
|
|
9
|
+
var GNSPairInfosV6_1__factory_1 = require("./GNSPairInfosV6_1__factory");
|
|
10
|
+
Object.defineProperty(exports, "GNSPairInfosV6_1__factory", { enumerable: true, get: function () { return GNSPairInfosV6_1__factory_1.GNSPairInfosV6_1__factory; } });
|
|
11
|
+
var GNSPairsStorageV6__factory_1 = require("./GNSPairsStorageV6__factory");
|
|
12
|
+
Object.defineProperty(exports, "GNSPairsStorageV6__factory", { enumerable: true, get: function () { return GNSPairsStorageV6__factory_1.GNSPairsStorageV6__factory; } });
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
export type { GFarmTradingStorageV5 } from "./GFarmTradingStorageV5";
|
|
2
|
+
export type { GNSPairInfosV6_1 } from "./GNSPairInfosV6_1";
|
|
3
|
+
export type { GNSPairsStorageV6 } from "./GNSPairsStorageV6";
|
|
4
|
+
export * as factories from "./factories";
|
|
5
|
+
export { GFarmTradingStorageV5__factory } from "./factories/GFarmTradingStorageV5__factory";
|
|
6
|
+
export { GNSPairInfosV6_1__factory } from "./factories/GNSPairInfosV6_1__factory";
|
|
7
|
+
export { GNSPairsStorageV6__factory } from "./factories/GNSPairsStorageV6__factory";
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
14
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
15
|
+
}) : function(o, v) {
|
|
16
|
+
o["default"] = v;
|
|
17
|
+
});
|
|
18
|
+
var __importStar = (this && this.__importStar) || function (mod) {
|
|
19
|
+
if (mod && mod.__esModule) return mod;
|
|
20
|
+
var result = {};
|
|
21
|
+
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
|
|
22
|
+
__setModuleDefault(result, mod);
|
|
23
|
+
return result;
|
|
24
|
+
};
|
|
25
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
26
|
+
exports.GNSPairsStorageV6__factory = exports.GNSPairInfosV6_1__factory = exports.GFarmTradingStorageV5__factory = exports.factories = void 0;
|
|
27
|
+
exports.factories = __importStar(require("./factories"));
|
|
28
|
+
var GFarmTradingStorageV5__factory_1 = require("./factories/GFarmTradingStorageV5__factory");
|
|
29
|
+
Object.defineProperty(exports, "GFarmTradingStorageV5__factory", { enumerable: true, get: function () { return GFarmTradingStorageV5__factory_1.GFarmTradingStorageV5__factory; } });
|
|
30
|
+
var GNSPairInfosV6_1__factory_1 = require("./factories/GNSPairInfosV6_1__factory");
|
|
31
|
+
Object.defineProperty(exports, "GNSPairInfosV6_1__factory", { enumerable: true, get: function () { return GNSPairInfosV6_1__factory_1.GNSPairInfosV6_1__factory; } });
|
|
32
|
+
var GNSPairsStorageV6__factory_1 = require("./factories/GNSPairsStorageV6__factory");
|
|
33
|
+
Object.defineProperty(exports, "GNSPairsStorageV6__factory", { enumerable: true, get: function () { return GNSPairsStorageV6__factory_1.GNSPairsStorageV6__factory; } });
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "./openTrades";
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
__exportStar(require("./openTrades"), exports);
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { TradeContainer } from "@/trade/types";
|
|
2
|
+
import { GFarmTradingStorageV5, GNSPairInfosV6_1, GNSPairsStorageV6 } from "../types";
|
|
3
|
+
export type FetchTradesTradingContracts = {
|
|
4
|
+
storage: GFarmTradingStorageV5;
|
|
5
|
+
pairInfos: GNSPairInfosV6_1;
|
|
6
|
+
pairsStorage: GNSPairsStorageV6;
|
|
7
|
+
};
|
|
8
|
+
export declare const fetchOpenPairTrades: (contracts: FetchTradesTradingContracts, pairBatchSize?: number) => Promise<TradeContainer[]>;
|
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
3
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
4
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
5
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
6
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
7
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
8
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
9
|
+
});
|
|
10
|
+
};
|
|
11
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
12
|
+
exports.fetchOpenPairTrades = void 0;
|
|
13
|
+
const fetchOpenPairTrades = (contracts, pairBatchSize = 10) => __awaiter(void 0, void 0, void 0, function* () {
|
|
14
|
+
if (!contracts) {
|
|
15
|
+
return [];
|
|
16
|
+
}
|
|
17
|
+
const { pairsStorage: pairsStorageContract } = contracts;
|
|
18
|
+
try {
|
|
19
|
+
const totalPairIndexes = (yield pairsStorageContract.pairsCount()).toNumber() - 1;
|
|
20
|
+
let allOpenPairTrades = [];
|
|
21
|
+
for (let batchStartPairIndex = 0; batchStartPairIndex < totalPairIndexes; batchStartPairIndex += pairBatchSize) {
|
|
22
|
+
const batchEndPairIndex = Math.min(batchStartPairIndex + pairBatchSize - 1, totalPairIndexes);
|
|
23
|
+
const openPairTradesBatch = yield fetchOpenPairTradesBatch(contracts, batchStartPairIndex, batchEndPairIndex);
|
|
24
|
+
allOpenPairTrades = allOpenPairTrades.concat(openPairTradesBatch);
|
|
25
|
+
}
|
|
26
|
+
console.info(`Fetched ${allOpenPairTrades.length} total open pair trade(s).`);
|
|
27
|
+
return allOpenPairTrades;
|
|
28
|
+
}
|
|
29
|
+
catch (error) {
|
|
30
|
+
console.error(`Unexpected error while fetching open pair trades!`);
|
|
31
|
+
throw error;
|
|
32
|
+
}
|
|
33
|
+
});
|
|
34
|
+
exports.fetchOpenPairTrades = fetchOpenPairTrades;
|
|
35
|
+
const fetchOpenPairTradesBatch = (contracts, startPairIndex, endPairIndex) => __awaiter(void 0, void 0, void 0, function* () {
|
|
36
|
+
const { storage: storageContract, pairInfos: pairInfosContract } = contracts;
|
|
37
|
+
const maxTradesPerPair = (yield storageContract.maxTradesPerPair()).toNumber();
|
|
38
|
+
const pairIndexesToFetch = Array.from({ length: endPairIndex - startPairIndex + 1 }, (_, i) => i + startPairIndex);
|
|
39
|
+
const rawTrades = yield Promise.all(pairIndexesToFetch.map((pairIndex) => __awaiter(void 0, void 0, void 0, function* () {
|
|
40
|
+
console.debug(`Fetching pair traders for pairIndex ${pairIndex}...`);
|
|
41
|
+
const pairTradersCallStartTime = performance.now();
|
|
42
|
+
const pairTraderAddresses = yield storageContract.pairTradersArray(pairIndex);
|
|
43
|
+
if (pairTraderAddresses.length === 0) {
|
|
44
|
+
console.debug(`No pair traders found for pairIndex ${pairIndex}; no processing left to do!`);
|
|
45
|
+
return [];
|
|
46
|
+
}
|
|
47
|
+
console.debug(`Fetched ${pairTraderAddresses.length} pair traders for pairIndex ${pairIndex} in ${performance.now() - pairTradersCallStartTime}ms; now fetching all open trades...`);
|
|
48
|
+
const openTradesForPairTraders = yield Promise.all(pairTraderAddresses.map((pairTraderAddress) => __awaiter(void 0, void 0, void 0, function* () {
|
|
49
|
+
const openTradesCalls = new Array(maxTradesPerPair);
|
|
50
|
+
const traderOpenTradesCallsStartTime = performance.now();
|
|
51
|
+
for (let pairTradeIndex = 0; pairTradeIndex < maxTradesPerPair; pairTradeIndex++) {
|
|
52
|
+
openTradesCalls[pairTradeIndex] = storageContract.openTrades(pairTraderAddress, pairIndex, pairTradeIndex);
|
|
53
|
+
}
|
|
54
|
+
console.debug(`Waiting on ${openTradesCalls.length} StorageContract::openTrades calls for trader ${pairTraderAddress}...`);
|
|
55
|
+
const openTradesForTraderAddress = yield Promise.all(openTradesCalls);
|
|
56
|
+
console.debug(`Received all trades for trader ${pairTraderAddress} and pair ${pairIndex} in ${performance.now() - traderOpenTradesCallsStartTime}ms.`);
|
|
57
|
+
// Filter out any of the trades that aren't *really* open (NOTE: these will have an empty trader address, so just test against that)
|
|
58
|
+
const actualOpenTradesForTrader = openTradesForTraderAddress.filter(openTrade => openTrade.trader === pairTraderAddress);
|
|
59
|
+
console.debug(`Filtered down to ${actualOpenTradesForTrader.length} actual open trades for trader ${pairTraderAddress} and pair ${pairIndex}; fetching corresponding trade info and initial fees...`);
|
|
60
|
+
const [actualOpenTradesTradeInfos, actualOpenTradesInitialAccFees] = yield Promise.all([
|
|
61
|
+
Promise.all(actualOpenTradesForTrader.map(aot => storageContract.openTradesInfo(aot.trader, aot.pairIndex, aot.index))),
|
|
62
|
+
Promise.all(actualOpenTradesForTrader.map(aot => pairInfosContract.tradeInitialAccFees(aot.trader, aot.pairIndex, aot.index))),
|
|
63
|
+
]);
|
|
64
|
+
const finalOpenTradesForTrader = new Array(actualOpenTradesForTrader.length);
|
|
65
|
+
for (let tradeIndex = 0; tradeIndex < actualOpenTradesForTrader.length; tradeIndex++) {
|
|
66
|
+
const tradeInfo = actualOpenTradesTradeInfos[tradeIndex];
|
|
67
|
+
if (tradeInfo === undefined) {
|
|
68
|
+
console.error("No trade info found for open trade while fetching open trades!", { trade: actualOpenTradesForTrader[tradeIndex] });
|
|
69
|
+
continue;
|
|
70
|
+
}
|
|
71
|
+
const tradeInitialAccFees = actualOpenTradesInitialAccFees[tradeIndex];
|
|
72
|
+
if (tradeInitialAccFees === undefined) {
|
|
73
|
+
console.error("No initial fees found for open trade while fetching open trades!", { trade: actualOpenTradesForTrader[tradeIndex] });
|
|
74
|
+
continue;
|
|
75
|
+
}
|
|
76
|
+
const trade = actualOpenTradesForTrader[tradeIndex];
|
|
77
|
+
finalOpenTradesForTrader[tradeIndex] = {
|
|
78
|
+
trade: {
|
|
79
|
+
trader: trade.trader,
|
|
80
|
+
pairIndex: trade.pairIndex,
|
|
81
|
+
index: trade.index,
|
|
82
|
+
initialPosToken: trade.initialPosToken,
|
|
83
|
+
openPrice: trade.openPrice,
|
|
84
|
+
buy: trade.buy,
|
|
85
|
+
leverage: trade.leverage,
|
|
86
|
+
tp: trade.tp,
|
|
87
|
+
sl: trade.sl,
|
|
88
|
+
},
|
|
89
|
+
tradeInfo: {
|
|
90
|
+
beingMarketClosed: tradeInfo.beingMarketClosed,
|
|
91
|
+
tokenPriceDai: tradeInfo.tokenPriceDai,
|
|
92
|
+
openInterestDai: tradeInfo.openInterestDai,
|
|
93
|
+
tpLastUpdated: tradeInfo.tpLastUpdated,
|
|
94
|
+
slLastUpdated: tradeInfo.slLastUpdated,
|
|
95
|
+
},
|
|
96
|
+
initialAccFees: {
|
|
97
|
+
rollover: tradeInitialAccFees.rollover,
|
|
98
|
+
funding: tradeInitialAccFees.funding,
|
|
99
|
+
openedAfterUpdate: tradeInitialAccFees.openedAfterUpdate,
|
|
100
|
+
},
|
|
101
|
+
};
|
|
102
|
+
}
|
|
103
|
+
console.debug(`Trade info and initial fees fetched for ${finalOpenTradesForTrader.length} trades for trader ${pairTraderAddress} and pair ${pairIndex}; done!`);
|
|
104
|
+
return finalOpenTradesForTrader;
|
|
105
|
+
})));
|
|
106
|
+
return openTradesForPairTraders;
|
|
107
|
+
})));
|
|
108
|
+
const perPairTrades = rawTrades.reduce((a, b) => a.concat(b), []);
|
|
109
|
+
return perPairTrades.reduce((a, b) => a.concat(b), []);
|
|
110
|
+
});
|
package/lib/index.d.ts
ADDED
package/lib/index.js
ADDED
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
__exportStar(require("./trade"), exports);
|
|
18
|
+
__exportStar(require("./contracts"), exports);
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { Fee, OpenInterest, PairFundingFees, PairParams, PairRolloverFees } from "./types";
|
|
2
|
+
export declare const getClosingFee: (posDai: number, leverage: number, pairIndex: number, pairFee: Fee | undefined) => number;
|
|
3
|
+
export type GetFundingFeeContext = {
|
|
4
|
+
currentBlock?: number;
|
|
5
|
+
pairParams?: PairParams;
|
|
6
|
+
pairFundingFees?: PairFundingFees;
|
|
7
|
+
openInterest?: OpenInterest;
|
|
8
|
+
};
|
|
9
|
+
export declare const getFundingFee: (leveragedPosDai: number, initialAccFundingFees: number, buy: boolean, openedAfterUpdate: boolean, context: GetFundingFeeContext) => number;
|
|
10
|
+
export type GetRolloverFeeContext = {
|
|
11
|
+
currentBlock?: number;
|
|
12
|
+
pairParams?: PairParams;
|
|
13
|
+
pairRolloverFees?: PairRolloverFees;
|
|
14
|
+
};
|
|
15
|
+
export declare const getRolloverFee: (posDai: number, initialAccRolloverFees: number, openedAfterUpdate: boolean, context: GetRolloverFeeContext) => number;
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.getRolloverFee = exports.getFundingFee = exports.getClosingFee = void 0;
|
|
4
|
+
const getClosingFee = (posDai, leverage, pairIndex, pairFee) => {
|
|
5
|
+
if (posDai === undefined ||
|
|
6
|
+
leverage === undefined ||
|
|
7
|
+
pairIndex === undefined ||
|
|
8
|
+
pairFee === undefined) {
|
|
9
|
+
return 0;
|
|
10
|
+
}
|
|
11
|
+
const { closeFeeP, nftLimitOrderFeeP } = pairFee;
|
|
12
|
+
return (closeFeeP + nftLimitOrderFeeP) * posDai * leverage;
|
|
13
|
+
};
|
|
14
|
+
exports.getClosingFee = getClosingFee;
|
|
15
|
+
const getFundingFee = (leveragedPosDai, initialAccFundingFees, buy, openedAfterUpdate, context) => {
|
|
16
|
+
const { pairParams, pairFundingFees, openInterest, currentBlock } = context;
|
|
17
|
+
if (!currentBlock ||
|
|
18
|
+
!openedAfterUpdate ||
|
|
19
|
+
pairParams === undefined ||
|
|
20
|
+
pairFundingFees === undefined ||
|
|
21
|
+
openInterest === undefined)
|
|
22
|
+
return 0;
|
|
23
|
+
const { accPerOiLong, accPerOiShort, lastUpdateBlock } = pairFundingFees;
|
|
24
|
+
const { fundingFeePerBlockP } = pairParams;
|
|
25
|
+
const { long: longOi, short: shortOi } = openInterest;
|
|
26
|
+
const fundingFeesPaidByLongs = (longOi - shortOi) * fundingFeePerBlockP * (currentBlock - lastUpdateBlock);
|
|
27
|
+
const pendingAccFundingFees = buy
|
|
28
|
+
? accPerOiLong + fundingFeesPaidByLongs / longOi
|
|
29
|
+
: accPerOiShort + (fundingFeesPaidByLongs * -1) / shortOi;
|
|
30
|
+
return leveragedPosDai * (pendingAccFundingFees - initialAccFundingFees);
|
|
31
|
+
};
|
|
32
|
+
exports.getFundingFee = getFundingFee;
|
|
33
|
+
const getRolloverFee = (posDai, initialAccRolloverFees, openedAfterUpdate, context) => {
|
|
34
|
+
const { pairParams, pairRolloverFees, currentBlock } = context;
|
|
35
|
+
if (!currentBlock ||
|
|
36
|
+
!openedAfterUpdate ||
|
|
37
|
+
pairParams === undefined ||
|
|
38
|
+
pairRolloverFees === undefined)
|
|
39
|
+
return 0;
|
|
40
|
+
const { accPerCollateral, lastUpdateBlock } = pairRolloverFees;
|
|
41
|
+
const { rolloverFeePerBlockP } = pairParams;
|
|
42
|
+
const pendingAccRolloverFees = accPerCollateral + (currentBlock - lastUpdateBlock) * rolloverFeePerBlockP;
|
|
43
|
+
return posDai * (pendingAccRolloverFees - initialAccRolloverFees);
|
|
44
|
+
};
|
|
45
|
+
exports.getRolloverFee = getRolloverFee;
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
__exportStar(require("./fees"), exports);
|
|
18
|
+
__exportStar(require("./pnl"), exports);
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { GetFundingFeeContext, GetRolloverFeeContext } from "./fees";
|
|
2
|
+
import { Fee, Trade, TradeInfo, TradeInitialAccFees } from "./types";
|
|
3
|
+
export type GetPnlContext = {
|
|
4
|
+
fee: Fee | undefined;
|
|
5
|
+
maxGainP: number | undefined;
|
|
6
|
+
} & GetRolloverFeeContext & GetFundingFeeContext;
|
|
7
|
+
export declare const getPnl: (price: number | undefined, trade: Trade, tradeInfo: TradeInfo, initialAccFees: TradeInitialAccFees, useFees: boolean, context: GetPnlContext) => number[] | undefined;
|
package/lib/trade/pnl.js
ADDED
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.getPnl = void 0;
|
|
4
|
+
const fees_1 = require("./fees");
|
|
5
|
+
const getPnl = (price, trade, tradeInfo, initialAccFees, useFees, context) => {
|
|
6
|
+
if (!price) {
|
|
7
|
+
return;
|
|
8
|
+
}
|
|
9
|
+
const posDai = trade.initialPosToken * tradeInfo.tokenPriceDai;
|
|
10
|
+
const { openPrice, leverage } = trade;
|
|
11
|
+
const { maxGainP, currentBlock, pairParams, pairRolloverFees, pairFundingFees, openInterest, fee, } = context;
|
|
12
|
+
const maxGain = maxGainP === undefined ? Infinity : (maxGainP / 100) * posDai;
|
|
13
|
+
let pnlDai = trade.buy
|
|
14
|
+
? ((price - openPrice) / openPrice) * leverage * posDai
|
|
15
|
+
: ((openPrice - price) / openPrice) * leverage * posDai;
|
|
16
|
+
pnlDai = pnlDai > maxGain ? maxGain : pnlDai;
|
|
17
|
+
if (useFees) {
|
|
18
|
+
pnlDai -= (0, fees_1.getRolloverFee)(posDai, initialAccFees.rollover, initialAccFees.openedAfterUpdate, {
|
|
19
|
+
currentBlock,
|
|
20
|
+
pairParams,
|
|
21
|
+
pairRolloverFees,
|
|
22
|
+
});
|
|
23
|
+
pnlDai -= (0, fees_1.getFundingFee)(posDai * trade.leverage, initialAccFees.funding, trade.buy, initialAccFees.openedAfterUpdate, {
|
|
24
|
+
currentBlock,
|
|
25
|
+
pairParams,
|
|
26
|
+
pairFundingFees,
|
|
27
|
+
openInterest,
|
|
28
|
+
});
|
|
29
|
+
}
|
|
30
|
+
let pnlPercentage = (pnlDai / posDai) * 100;
|
|
31
|
+
// Can be liquidated
|
|
32
|
+
if (pnlPercentage <= -90) {
|
|
33
|
+
pnlPercentage = -100;
|
|
34
|
+
}
|
|
35
|
+
else {
|
|
36
|
+
pnlDai -= (0, fees_1.getClosingFee)(posDai, trade.leverage, trade.pairIndex, fee);
|
|
37
|
+
pnlPercentage = (pnlDai / posDai) * 100;
|
|
38
|
+
}
|
|
39
|
+
pnlPercentage = pnlPercentage < -100 ? -100 : pnlPercentage;
|
|
40
|
+
pnlDai = (posDai * pnlPercentage) / 100;
|
|
41
|
+
return [pnlDai, pnlPercentage];
|
|
42
|
+
};
|
|
43
|
+
exports.getPnl = getPnl;
|
|
@@ -0,0 +1,143 @@
|
|
|
1
|
+
export type PairIndexes = {
|
|
2
|
+
[key: string]: number;
|
|
3
|
+
};
|
|
4
|
+
export type TradeContainer = {
|
|
5
|
+
trade: Trade;
|
|
6
|
+
tradeInfo: TradeInfo;
|
|
7
|
+
initialAccFees: TradeInitialAccFees;
|
|
8
|
+
};
|
|
9
|
+
export type Trade = {
|
|
10
|
+
buy: boolean;
|
|
11
|
+
index: number;
|
|
12
|
+
initialPosToken: number;
|
|
13
|
+
leverage: number;
|
|
14
|
+
openPrice: number;
|
|
15
|
+
pairIndex: number;
|
|
16
|
+
sl: number;
|
|
17
|
+
tp: number;
|
|
18
|
+
trader: string;
|
|
19
|
+
};
|
|
20
|
+
export type TradeInfo = {
|
|
21
|
+
openInterestDai: number;
|
|
22
|
+
slLastUpdated: number;
|
|
23
|
+
tokenPriceDai: number;
|
|
24
|
+
tpLastUpdated: number;
|
|
25
|
+
};
|
|
26
|
+
export type TradeInitialAccFees = {
|
|
27
|
+
rollover: number;
|
|
28
|
+
funding: number;
|
|
29
|
+
openedAfterUpdate: boolean;
|
|
30
|
+
};
|
|
31
|
+
export type TradingGroup = {
|
|
32
|
+
maxCollateralP: number;
|
|
33
|
+
maxLeverage: number;
|
|
34
|
+
minLeverage: number;
|
|
35
|
+
name: string;
|
|
36
|
+
};
|
|
37
|
+
export type LimitOrder = {
|
|
38
|
+
block: number;
|
|
39
|
+
buy: boolean;
|
|
40
|
+
index: number;
|
|
41
|
+
leverage: number;
|
|
42
|
+
maxPrice: number;
|
|
43
|
+
minPrice: number;
|
|
44
|
+
pairIndex: number;
|
|
45
|
+
positionSize: number;
|
|
46
|
+
sl: number;
|
|
47
|
+
spreadReductionP: number;
|
|
48
|
+
tp: number;
|
|
49
|
+
trader: string;
|
|
50
|
+
type: number;
|
|
51
|
+
};
|
|
52
|
+
export type Fee = {
|
|
53
|
+
closeFeeP: number;
|
|
54
|
+
minLevPosDai: number;
|
|
55
|
+
nftLimitOrderFeeP: number;
|
|
56
|
+
openFeeP: number;
|
|
57
|
+
referralFeeP: number;
|
|
58
|
+
};
|
|
59
|
+
export type OpenInterest = {
|
|
60
|
+
long: number;
|
|
61
|
+
max: number;
|
|
62
|
+
short: number;
|
|
63
|
+
};
|
|
64
|
+
export type OpenCollateral = {
|
|
65
|
+
long: number;
|
|
66
|
+
short: number;
|
|
67
|
+
};
|
|
68
|
+
export type PairParams = {
|
|
69
|
+
onePercentDepthAbove: number;
|
|
70
|
+
onePercentDepthBelow: number;
|
|
71
|
+
rolloverFeePerBlockP: number;
|
|
72
|
+
fundingFeePerBlockP: number;
|
|
73
|
+
};
|
|
74
|
+
export type PairRolloverFees = {
|
|
75
|
+
accPerCollateral: number;
|
|
76
|
+
lastUpdateBlock: number;
|
|
77
|
+
};
|
|
78
|
+
export type PairFundingFees = {
|
|
79
|
+
accPerOiLong: number;
|
|
80
|
+
accPerOiShort: number;
|
|
81
|
+
lastUpdateBlock: number;
|
|
82
|
+
};
|
|
83
|
+
export type Pair = {
|
|
84
|
+
name: string;
|
|
85
|
+
from: string;
|
|
86
|
+
to: string;
|
|
87
|
+
feeIndex: number;
|
|
88
|
+
groupIndex: number;
|
|
89
|
+
pairIndex: number;
|
|
90
|
+
spreadP: number;
|
|
91
|
+
};
|
|
92
|
+
export type TradeHistoryRecord = {
|
|
93
|
+
action: string;
|
|
94
|
+
address: string;
|
|
95
|
+
buy: number;
|
|
96
|
+
date: string;
|
|
97
|
+
leverage: number;
|
|
98
|
+
pair: string;
|
|
99
|
+
pnl_net: number;
|
|
100
|
+
price: number;
|
|
101
|
+
size: number;
|
|
102
|
+
tx: string;
|
|
103
|
+
};
|
|
104
|
+
export type MarketOrder = {
|
|
105
|
+
trader: string;
|
|
106
|
+
pairIndex: number;
|
|
107
|
+
index: number;
|
|
108
|
+
block: number;
|
|
109
|
+
open: boolean;
|
|
110
|
+
};
|
|
111
|
+
export type ChartBar = {
|
|
112
|
+
close: number;
|
|
113
|
+
high: number;
|
|
114
|
+
isBarClosed: boolean;
|
|
115
|
+
isLastBar: boolean;
|
|
116
|
+
low: number;
|
|
117
|
+
open: number;
|
|
118
|
+
time: number;
|
|
119
|
+
};
|
|
120
|
+
export type LeaderboardTrader = {
|
|
121
|
+
address: string;
|
|
122
|
+
tradesCount: number;
|
|
123
|
+
winrate: number;
|
|
124
|
+
pnl: number;
|
|
125
|
+
volume: number;
|
|
126
|
+
score: number;
|
|
127
|
+
};
|
|
128
|
+
export type OpenTradeParams = [
|
|
129
|
+
address: string,
|
|
130
|
+
pairIndex: number,
|
|
131
|
+
x1: number,
|
|
132
|
+
x2: number,
|
|
133
|
+
wei: number,
|
|
134
|
+
price: string,
|
|
135
|
+
buy: boolean,
|
|
136
|
+
leverage: number,
|
|
137
|
+
takeProfit: string,
|
|
138
|
+
stopLoss: string
|
|
139
|
+
];
|
|
140
|
+
export declare enum PositionType {
|
|
141
|
+
LONG = "LONG",
|
|
142
|
+
SHORT = "SHORT"
|
|
143
|
+
}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.PositionType = void 0;
|
|
4
|
+
var PositionType;
|
|
5
|
+
(function (PositionType) {
|
|
6
|
+
PositionType["LONG"] = "LONG";
|
|
7
|
+
PositionType["SHORT"] = "SHORT";
|
|
8
|
+
})(PositionType = exports.PositionType || (exports.PositionType = {}));
|
package/package.json
ADDED
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@gainsnetwork/sdk",
|
|
3
|
+
"version": "0.0.1",
|
|
4
|
+
"description": "Gains Network SDK",
|
|
5
|
+
"main": "./lib/index.js",
|
|
6
|
+
"files": [
|
|
7
|
+
"lib/**/*"
|
|
8
|
+
],
|
|
9
|
+
"scripts": {
|
|
10
|
+
"build": "tsc --project tsconfig.build.json",
|
|
11
|
+
"clean": "rm -rf ./lib/",
|
|
12
|
+
"cm": "cz",
|
|
13
|
+
"lint": "eslint ./src/ --fix",
|
|
14
|
+
"prepare": "husky install",
|
|
15
|
+
"semantic-release": "semantic-release",
|
|
16
|
+
"test:watch": "jest --watch",
|
|
17
|
+
"test": "jest --coverage",
|
|
18
|
+
"typecheck": "tsc --noEmit",
|
|
19
|
+
"generate-types": "typechain --target=ethers-v5 --out-dir ./src/contracts/types ./abi/*.json",
|
|
20
|
+
"postinstall": "npm run generate-types"
|
|
21
|
+
},
|
|
22
|
+
"repository": {
|
|
23
|
+
"type": "git",
|
|
24
|
+
"url": "git+git@github.com:GainsNetwork-org/sdk.git"
|
|
25
|
+
},
|
|
26
|
+
"engines": {
|
|
27
|
+
"node": ">=12.0"
|
|
28
|
+
},
|
|
29
|
+
"devDependencies": {
|
|
30
|
+
"@typechain/ethers-v5": "^10.1.1",
|
|
31
|
+
"@types/jest": "^27.5.2",
|
|
32
|
+
"@types/node": "^12.20.11",
|
|
33
|
+
"@typescript-eslint/eslint-plugin": "^4.22.0",
|
|
34
|
+
"@typescript-eslint/parser": "^4.22.0",
|
|
35
|
+
"conventional-changelog-conventionalcommits": "^5.0.0",
|
|
36
|
+
"eslint": "^7.25.0",
|
|
37
|
+
"eslint-config-prettier": "^8.3.0",
|
|
38
|
+
"eslint-plugin-node": "^11.1.0",
|
|
39
|
+
"eslint-plugin-prettier": "^3.4.0",
|
|
40
|
+
"husky": "^6.0.0",
|
|
41
|
+
"jest": "^27.2.0",
|
|
42
|
+
"lint-staged": "^10.5.4",
|
|
43
|
+
"prettier": "^2.2.1",
|
|
44
|
+
"semantic-release": "^19.0.2",
|
|
45
|
+
"ts-jest": "^27.0.5",
|
|
46
|
+
"ts-node": "^10.2.1",
|
|
47
|
+
"typechain": "^8.1.1",
|
|
48
|
+
"typescript": "^4.2.4"
|
|
49
|
+
},
|
|
50
|
+
"lint-staged": {
|
|
51
|
+
"*.ts": "eslint --cache --cache-location .eslintcache --fix"
|
|
52
|
+
},
|
|
53
|
+
"release": {
|
|
54
|
+
"branches": [
|
|
55
|
+
"main"
|
|
56
|
+
],
|
|
57
|
+
"plugins": [
|
|
58
|
+
[
|
|
59
|
+
"@semantic-release/commit-analyzer",
|
|
60
|
+
{
|
|
61
|
+
"preset": "conventionalcommits",
|
|
62
|
+
"releaseRules": [
|
|
63
|
+
{
|
|
64
|
+
"type": "build",
|
|
65
|
+
"scope": "deps",
|
|
66
|
+
"release": "patch"
|
|
67
|
+
}
|
|
68
|
+
]
|
|
69
|
+
}
|
|
70
|
+
],
|
|
71
|
+
[
|
|
72
|
+
"@semantic-release/release-notes-generator",
|
|
73
|
+
{
|
|
74
|
+
"preset": "conventionalcommits",
|
|
75
|
+
"presetConfig": {
|
|
76
|
+
"types": [
|
|
77
|
+
{
|
|
78
|
+
"type": "feat",
|
|
79
|
+
"section": "Features"
|
|
80
|
+
},
|
|
81
|
+
{
|
|
82
|
+
"type": "fix",
|
|
83
|
+
"section": "Bug Fixes"
|
|
84
|
+
},
|
|
85
|
+
{
|
|
86
|
+
"type": "build",
|
|
87
|
+
"section": "Dependencies and Other Build Updates",
|
|
88
|
+
"hidden": false
|
|
89
|
+
}
|
|
90
|
+
]
|
|
91
|
+
}
|
|
92
|
+
}
|
|
93
|
+
],
|
|
94
|
+
"@semantic-release/npm",
|
|
95
|
+
"@semantic-release/github"
|
|
96
|
+
]
|
|
97
|
+
},
|
|
98
|
+
"dependencies": {
|
|
99
|
+
"@ethersproject/providers": "^5.7.2",
|
|
100
|
+
"ethers": "^5.7.2"
|
|
101
|
+
}
|
|
102
|
+
}
|