@d8x/perpetuals-sdk 0.7.4 → 0.7.6

package/dist/esm/liquidatorTool.js

@@ -1,4 +1,3 @@
-import { __assign, __awaiter, __extends, __generator } from "tslib";
 import { ABK64x64ToFloat, floatToABK64x64 } from "./d8XMath";
 import WriteAccessHandler from "./writeAccessHandler";
 /**
@@ -6,8 +5,7 @@ import WriteAccessHandler from "./writeAccessHandler";
  * and executes smart-contract interactions that require gas-payments.
  * @extends WriteAccessHandler
  */
-var LiquidatorTool = /** @class */ (function (_super) {
-    __extends(LiquidatorTool, _super);
+export default class LiquidatorTool extends WriteAccessHandler {
     /**
      * Constructs a LiquidatorTool instance for a given configuration and private key.
      * @param {NodeSDKConfig} config Configuration object, see PerpetualDataHandler.
@@ -28,8 +26,8 @@ var LiquidatorTool = /** @class */ (function (_super) {
      *
      * @param {string | Signer} signer Private key or ethers Signer of the account
      */
-    function LiquidatorTool(config, signer) {
-        return _super.call(this, config, signer) || this;
+    constructor(config, signer) {
+        super(config, signer);
     }
     /**
      * Liquidate a trader.
@@ -56,37 +54,27 @@ var LiquidatorTool = /** @class */ (function (_super) {
      *
      * @returns Transaction object.
      */
-    LiquidatorTool.prototype.liquidateTrader = function (symbol, traderAddr, liquidatorAddr, priceFeedData, overrides) {
-        if (liquidatorAddr === void 0) { liquidatorAddr = ""; }
-        return __awaiter(this, void 0, void 0, function () {
-            var perpID;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        // this operation spends gas, so signer is required
-                        if (this.proxyContract == null || this.signer == null) {
-                            throw Error("no proxy contract or wallet initialized. Use createProxyInstance().");
-                        }
-                        // liquidator is signer unless specified otherwise
-                        if (liquidatorAddr == "") {
-                            liquidatorAddr = this.traderAddr;
-                        }
-                        perpID = LiquidatorTool.symbolToPerpetualId(symbol, this.symbolToPerpStaticInfo);
-                        if (!(priceFeedData == undefined)) return [3 /*break*/, 2];
-                        return [4 /*yield*/, this.fetchLatestFeedPriceInfo(symbol)];
-                    case 1:
-                        priceFeedData = _a.sent();
-                        _a.label = 2;
-                    case 2:
-                        if (!overrides || overrides.value == undefined) {
-                            overrides = __assign({ value: priceFeedData.timestamps.length * this.PRICE_UPDATE_FEE_GWEI }, overrides);
-                        }
-                        return [4 /*yield*/, this._liquidateByAMM(perpID, liquidatorAddr, traderAddr, priceFeedData, overrides)];
-                    case 3: return [2 /*return*/, _a.sent()];
-                }
-            });
-        });
-    };
+    async liquidateTrader(symbol, traderAddr, liquidatorAddr = "", priceFeedData, overrides) {
+        // this operation spends gas, so signer is required
+        if (this.proxyContract == null || this.signer == null) {
+            throw Error("no proxy contract or wallet initialized. Use createProxyInstance().");
+        }
+        // liquidator is signer unless specified otherwise
+        if (liquidatorAddr == "") {
+            liquidatorAddr = this.traderAddr;
+        }
+        let perpID = LiquidatorTool.symbolToPerpetualId(symbol, this.symbolToPerpStaticInfo);
+        if (priceFeedData == undefined) {
+            priceFeedData = await this.fetchLatestFeedPriceInfo(symbol);
+        }
+        if (!overrides || overrides.value == undefined) {
+            overrides = {
+                value: priceFeedData.timestamps.length * this.PRICE_UPDATE_FEE_GWEI,
+                ...overrides,
+            };
+        }
+        return await this._liquidateByAMM(perpID, liquidatorAddr, traderAddr, priceFeedData, overrides);
+    }
     /**
      * Check if the collateral of a trader is above the maintenance margin ("maintenance margin safe").
      * If not, the position can be liquidated.
@@ -112,45 +100,35 @@ var LiquidatorTool = /** @class */ (function (_super) {
      * @returns {boolean} True if the trader is maintenance margin safe in the perpetual.
      * False means that the trader's position can be liquidated.
      */
-    LiquidatorTool.prototype.isMaintenanceMarginSafe = function (symbol, traderAddr, indexPrices, overrides) {
-        return __awaiter(this, void 0, void 0, function () {
-            var idx_notional, perpID, obj, traderState, idx_maintenanceMgnRate, idx_marginAccountPositionBC, idx_collateralToQuoteConversion, idx_marginBalance, maintMgnRate, pos, marginbalance, coll2quote, base2collateral, threshold;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        if (this.proxyContract == null) {
-                            throw Error("no proxy contract initialized. Use createProxyInstance().");
-                        }
-                        idx_notional = 4;
-                        perpID = LiquidatorTool.symbolToPerpetualId(symbol, this.symbolToPerpStaticInfo);
-                        if (!(indexPrices == undefined)) return [3 /*break*/, 2];
-                        return [4 /*yield*/, this.priceFeedGetter.fetchPricesForPerpetual(symbol)];
-                    case 1:
-                        obj = _a.sent();
-                        indexPrices = [obj.idxPrices[0], obj.idxPrices[1]];
-                        _a.label = 2;
-                    case 2: return [4 /*yield*/, this.proxyContract.getTraderState(perpID, traderAddr, indexPrices.map(function (x) { return floatToABK64x64(x); }), overrides || {})];
-                    case 3:
-                        traderState = _a.sent();
-                        if (traderState[idx_notional].eq(0)) {
-                            // trader does not have open position
-                            return [2 /*return*/, true];
-                        }
-                        idx_maintenanceMgnRate = 10;
-                        idx_marginAccountPositionBC = 4;
-                        idx_collateralToQuoteConversion = 9;
-                        idx_marginBalance = 0;
-                        maintMgnRate = ABK64x64ToFloat(traderState[idx_maintenanceMgnRate]);
-                        pos = ABK64x64ToFloat(traderState[idx_marginAccountPositionBC]);
-                        marginbalance = ABK64x64ToFloat(traderState[idx_marginBalance]);
-                        coll2quote = ABK64x64ToFloat(traderState[idx_collateralToQuoteConversion]);
-                        base2collateral = indexPrices[0] / coll2quote;
-                        threshold = Math.abs(pos * base2collateral * maintMgnRate);
-                        return [2 /*return*/, marginbalance >= threshold];
-                }
-            });
-        });
-    };
+    async isMaintenanceMarginSafe(symbol, traderAddr, indexPrices, overrides) {
+        if (this.proxyContract == null) {
+            throw Error("no proxy contract initialized. Use createProxyInstance().");
+        }
+        const idx_notional = 4;
+        let perpID = LiquidatorTool.symbolToPerpetualId(symbol, this.symbolToPerpStaticInfo);
+        if (indexPrices == undefined) {
+            // fetch from API
+            let obj = await this.priceFeedGetter.fetchPricesForPerpetual(symbol);
+            indexPrices = [obj.idxPrices[0], obj.idxPrices[1]];
+        }
+        let traderState = await this.proxyContract.getTraderState(perpID, traderAddr, indexPrices.map((x) => floatToABK64x64(x)), overrides || {});
+        if (traderState[idx_notional].eq(0)) {
+            // trader does not have open position
+            return true;
+        }
+        // calculate margin from traderstate
+        const idx_maintenanceMgnRate = 10;
+        const idx_marginAccountPositionBC = 4;
+        const idx_collateralToQuoteConversion = 9;
+        const idx_marginBalance = 0;
+        const maintMgnRate = ABK64x64ToFloat(traderState[idx_maintenanceMgnRate]);
+        const pos = ABK64x64ToFloat(traderState[idx_marginAccountPositionBC]);
+        const marginbalance = ABK64x64ToFloat(traderState[idx_marginBalance]);
+        const coll2quote = ABK64x64ToFloat(traderState[idx_collateralToQuoteConversion]);
+        const base2collateral = indexPrices[0] / coll2quote;
+        const threshold = Math.abs(pos * base2collateral * maintMgnRate);
+        return marginbalance >= threshold;
+    }
     /**
      *
      * @param perpetualId Perpetual id.
@@ -160,16 +138,9 @@ var LiquidatorTool = /** @class */ (function (_super) {
      * @param options E.g., Gas limit, fee.
      * @ignore
      */
-    LiquidatorTool.prototype._liquidateByAMM = function (perpetualId, liquidatorAddr, traderAddr, priceFeedData, overrides) {
-        return __awaiter(this, void 0, void 0, function () {
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.proxyContract.liquidateByAMM(perpetualId, liquidatorAddr, traderAddr, priceFeedData.priceFeedVaas, priceFeedData.timestamps, overrides)];
-                    case 1: return [2 /*return*/, _a.sent()];
-                }
-            });
-        });
-    };
+    async _liquidateByAMM(perpetualId, liquidatorAddr, traderAddr, priceFeedData, overrides) {
+        return await this.proxyContract.liquidateByAMM(perpetualId, liquidatorAddr, traderAddr, priceFeedData.priceFeedVaas, priceFeedData.timestamps, overrides);
+    }
     /**
      * Total number of active accounts for this symbol, i.e. accounts with positions that are currently open.
      * @param {string} symbol Symbol of the form ETH-USD-MATIC.
@@ -190,24 +161,14 @@ var LiquidatorTool = /** @class */ (function (_super) {
      *
      * @returns {number} Number of active accounts.
      */
-    LiquidatorTool.prototype.countActivePerpAccounts = function (symbol, overrides) {
-        return __awaiter(this, void 0, void 0, function () {
-            var perpID, numAccounts;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        if (this.proxyContract == null) {
-                            throw Error("no proxy contract initialized. Use createProxyInstance().");
-                        }
-                        perpID = LiquidatorTool.symbolToPerpetualId(symbol, this.symbolToPerpStaticInfo);
-                        return [4 /*yield*/, this.proxyContract.countActivePerpAccounts(perpID, overrides || {})];
-                    case 1:
-                        numAccounts = _a.sent();
-                        return [2 /*return*/, Number(numAccounts)];
-                }
-            });
-        });
-    };
+    async countActivePerpAccounts(symbol, overrides) {
+        if (this.proxyContract == null) {
+            throw Error("no proxy contract initialized. Use createProxyInstance().");
+        }
+        let perpID = LiquidatorTool.symbolToPerpetualId(symbol, this.symbolToPerpStaticInfo);
+        let numAccounts = await this.proxyContract.countActivePerpAccounts(perpID, overrides || {});
+        return Number(numAccounts);
+    }
     /**
      * Get addresses of active accounts by chunks.
      * @param {string} symbol Symbol of the form ETH-USD-MATIC.
@@ -230,22 +191,13 @@ var LiquidatorTool = /** @class */ (function (_super) {
      *
      * @returns {string[]} Array of addresses at locations 'from', 'from'+1 ,..., 'to'-1.
      */
-    LiquidatorTool.prototype.getActiveAccountsByChunks = function (symbol, from, to, overrides) {
-        return __awaiter(this, void 0, void 0, function () {
-            var perpID;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        if (this.proxyContract == null) {
-                            throw Error("no proxy contract initialized. Use createProxyInstance().");
-                        }
-                        perpID = LiquidatorTool.symbolToPerpetualId(symbol, this.symbolToPerpStaticInfo);
-                        return [4 /*yield*/, this.proxyContract.getActivePerpAccountsByChunks(perpID, from, to, overrides || {})];
-                    case 1: return [2 /*return*/, _a.sent()];
-                }
-            });
-        });
-    };
+    async getActiveAccountsByChunks(symbol, from, to, overrides) {
+        if (this.proxyContract == null) {
+            throw Error("no proxy contract initialized. Use createProxyInstance().");
+        }
+        let perpID = LiquidatorTool.symbolToPerpetualId(symbol, this.symbolToPerpStaticInfo);
+        return await this.proxyContract.getActivePerpAccountsByChunks(perpID, from, to, overrides || {});
+    }
     /**
      * Addresses for all the active accounts in this perpetual symbol.
      * @param {string} symbol Symbol of the form ETH-USD-MATIC.
@@ -266,21 +218,10 @@ var LiquidatorTool = /** @class */ (function (_super) {
      *
      * @returns {string[]} Array of addresses.
      */
-    LiquidatorTool.prototype.getAllActiveAccounts = function (symbol, overrides) {
-        return __awaiter(this, void 0, void 0, function () {
-            var totalAccounts;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.countActivePerpAccounts(symbol)];
-                    case 1:
-                        totalAccounts = _a.sent();
-                        return [4 /*yield*/, this.getActiveAccountsByChunks(symbol, 0, totalAccounts, overrides)];
-                    case 2: return [2 /*return*/, _a.sent()];
-                }
-            });
-        });
-    };
-    return LiquidatorTool;
-}(WriteAccessHandler));
-export default LiquidatorTool;
+    async getAllActiveAccounts(symbol, overrides) {
+        // checks are done inside the intermediate functions
+        let totalAccounts = await this.countActivePerpAccounts(symbol);
+        return await this.getActiveAccountsByChunks(symbol, 0, totalAccounts, overrides);
+    }
+}
 //# sourceMappingURL=liquidatorTool.js.map

package/dist/esm/liquidatorTool.js.map

@@ -1 +1 @@
-{"version":3,"file":"liquidatorTool.js","sourceRoot":"","sources":["../../src/liquidatorTool.ts"],"names":[],"mappings":";AAGA,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAE7D,OAAO,kBAAkB,MAAM,sBAAsB,CAAC;AAEtD;;;;GAIG;AACH;IAA4C,kCAAkB;IAC5D;;;;;;;;;;;;;;;;;;;OAmBG;IACH,wBAAmB,MAAqB,EAAE,MAAuB;eAC/D,kBAAM,MAAM,EAAE,MAAM,CAAC;IACvB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACU,wCAAe,GAA5B,UACE,MAAc,EACd,UAAkB,EAClB,cAA2B,EAC3B,aAAmC,EACnC,SAA4B;QAF5B,+BAAA,EAAA,mBAA2B;;;;;;wBAI3B,mDAAmD;wBACnD,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,EAAE;4BACrD,MAAM,KAAK,CAAC,qEAAqE,CAAC,CAAC;yBACpF;wBACD,kDAAkD;wBAClD,IAAI,cAAc,IAAI,EAAE,EAAE;4BACxB,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC;yBAClC;wBACG,MAAM,GAAG,cAAc,CAAC,mBAAmB,CAAC,MAAM,EAAE,IAAI,CAAC,sBAAsB,CAAC,CAAC;6BACjF,CAAA,aAAa,IAAI,SAAS,CAAA,EAA1B,wBAA0B;wBACZ,qBAAM,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,EAAA;;wBAA3D,aAAa,GAAG,SAA2C,CAAC;;;wBAE9D,IAAI,CAAC,SAAS,IAAI,SAAS,CAAC,KAAK,IAAI,SAAS,EAAE;4BAC9C,SAAS,GAAG,WACV,KAAK,EAAE,aAAa,CAAC,UAAU,CAAC,MAAM,GAAG,IAAI,CAAC,qBAAqB,IAChE,SAAS,CACO,CAAC;yBACvB;wBACM,qBAAM,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,aAAa,EAAE,SAAS,CAAC,EAAA;4BAA/F,sBAAO,SAAwF,EAAC;;;;KACjG;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACU,gDAAuB,GAApC,UACE,MAAc,EACd,UAAkB,EAClB,WAA8B,EAC9B,SAAyB;;;;;;wBAEzB,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,EAAE;4BAC9B,MAAM,KAAK,CAAC,2DAA2D,CAAC,CAAC;yBAC1E;wBACK,YAAY,GAAG,CAAC,CAAC;wBACnB,MAAM,GAAG,cAAc,CAAC,mBAAmB,CAAC,MAAM,EAAE,IAAI,CAAC,sBAAsB,CAAC,CAAC;6BACjF,CAAA,WAAW,IAAI,SAAS,CAAA,EAAxB,wBAAwB;wBAEhB,qBAAM,IAAI,CAAC,eAAe,CAAC,uBAAuB,CAAC,MAAM,CAAC,EAAA;;wBAAhE,GAAG,GAAG,SAA0D;wBACpE,WAAW,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;;4BAEnC,qBAAM,IAAI,CAAC,aAAa,CAAC,cAAc,CACvD,MAAM,EACN,UAAU,EACV,WAAW,CAAC,GAAG,CAAC,UAAC,CAAC,IAAK,OAAA,eAAe,CAAC,CAAC,CAAC,EAAlB,CAAkB,CAA2B,EACpE,SAAS,IAAI,EAAE,CAChB,EAAA;;wBALG,WAAW,GAAG,SAKjB;wBACD,IAAI,WAAW,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE;4BACnC,qCAAqC;4BACrC,sBAAO,IAAI,EAAC;yBACb;wBAEK,sBAAsB,GAAG,EAAE,CAAC;wBAC5B,2BAA2B,GAAG,CAAC,CAAC;wBAChC,+BAA+B,GAAG,CAAC,CAAC;wBACpC,iBAAiB,GAAG,CAAC,CAAC;wBACtB,YAAY,GAAG,eAAe,CAAC,WAAW,CAAC,sBAAsB,CAAC,CAAC,CAAC;wBACpE,GAAG,GAAG,eAAe,CAAC,WAAW,CAAC,2BAA2B,CAAC,CAAC,CAAC;wBAChE,aAAa,GAAG,eAAe,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC,CAAC;wBAChE,UAAU,GAAG,eAAe,CAAC,WAAW,CAAC,+BAA+B,CAAC,CAAC,CAAC;wBAC3E,eAAe,GAAG,WAAW,CAAC,CAAC,CAAC,GAAG,UAAU,CAAC;wBAC9C,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,GAAG,eAAe,GAAG,YAAY,CAAC,CAAC;wBACjE,sBAAO,aAAa,IAAI,SAAS,EAAC;;;;KACnC;IAED;;;;;;;;OAQG;IACU,wCAAe,GAA5B,UACE,WAAmB,EACnB,cAAsB,EACtB,UAAkB,EAClB,aAAkC,EAClC,SAA4B;;;;4BAErB,qBAAM,IAAI,CAAC,aAAc,CAAC,cAAc,CAC7C,WAAW,EACX,cAAc,EACd,UAAU,EACV,aAAa,CAAC,aAAa,EAC3B,aAAa,CAAC,UAAU,EACxB,SAAS,CACV,EAAA;4BAPD,sBAAO,SAON,EAAC;;;;KACH;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACU,gDAAuB,GAApC,UAAqC,MAAc,EAAE,SAAyB;;;;;;wBAC5E,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,EAAE;4BAC9B,MAAM,KAAK,CAAC,2DAA2D,CAAC,CAAC;yBAC1E;wBACG,MAAM,GAAG,cAAc,CAAC,mBAAmB,CAAC,MAAM,EAAE,IAAI,CAAC,sBAAsB,CAAC,CAAC;wBACnE,qBAAM,IAAI,CAAC,aAAa,CAAC,uBAAuB,CAAC,MAAM,EAAE,SAAS,IAAI,EAAE,CAAC,EAAA;;wBAAvF,WAAW,GAAG,SAAyE;wBAC3F,sBAAO,MAAM,CAAC,WAAW,CAAC,EAAC;;;;KAC5B;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACU,kDAAyB,GAAtC,UACE,MAAc,EACd,IAAY,EACZ,EAAU,EACV,SAAyB;;;;;;wBAEzB,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,EAAE;4BAC9B,MAAM,KAAK,CAAC,2DAA2D,CAAC,CAAC;yBAC1E;wBACG,MAAM,GAAG,cAAc,CAAC,mBAAmB,CAAC,MAAM,EAAE,IAAI,CAAC,sBAAsB,CAAC,CAAC;wBAC9E,qBAAM,IAAI,CAAC,aAAa,CAAC,6BAA6B,CAAC,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,SAAS,IAAI,EAAE,CAAC,EAAA;4BAAhG,sBAAO,SAAyF,EAAC;;;;KAClG;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACU,6CAAoB,GAAjC,UAAkC,MAAc,EAAE,SAAyB;;;;;4BAErD,qBAAM,IAAI,CAAC,uBAAuB,CAAC,MAAM,CAAC,EAAA;;wBAA1D,aAAa,GAAG,SAA0C;wBACvD,qBAAM,IAAI,CAAC,yBAAyB,CAAC,MAAM,EAAE,CAAC,EAAE,aAAa,EAAE,SAAS,CAAC,EAAA;4BAAhF,sBAAO,SAAyE,EAAC;;;;KAClF;IACH,qBAAC;AAAD,CAAC,AAlQD,CAA4C,kBAAkB,GAkQ7D"}
+{"version":3,"file":"liquidatorTool.js","sourceRoot":"","sources":["../../src/liquidatorTool.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAE7D,OAAO,kBAAkB,MAAM,sBAAsB,CAAC;AAEtD;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,cAAe,SAAQ,kBAAkB;IAC5D;;;;;;;;;;;;;;;;;;;OAmBG;IACH,YAAmB,MAAqB,EAAE,MAAuB;QAC/D,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACxB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACI,KAAK,CAAC,eAAe,CAC1B,MAAc,EACd,UAAkB,EAClB,iBAAyB,EAAE,EAC3B,aAAmC,EACnC,SAA4B;QAE5B,mDAAmD;QACnD,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,EAAE;YACrD,MAAM,KAAK,CAAC,qEAAqE,CAAC,CAAC;SACpF;QACD,kDAAkD;QAClD,IAAI,cAAc,IAAI,EAAE,EAAE;YACxB,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC;SAClC;QACD,IAAI,MAAM,GAAG,cAAc,CAAC,mBAAmB,CAAC,MAAM,EAAE,IAAI,CAAC,sBAAsB,CAAC,CAAC;QACrF,IAAI,aAAa,IAAI,SAAS,EAAE;YAC9B,aAAa,GAAG,MAAM,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAC;SAC7D;QACD,IAAI,CAAC,SAAS,IAAI,SAAS,CAAC,KAAK,IAAI,SAAS,EAAE;YAC9C,SAAS,GAAG;gBACV,KAAK,EAAE,aAAa,CAAC,UAAU,CAAC,MAAM,GAAG,IAAI,CAAC,qBAAqB;gBACnE,GAAG,SAAS;aACO,CAAC;SACvB;QACD,OAAO,MAAM,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,aAAa,EAAE,SAAS,CAAC,CAAC;IAClG,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACI,KAAK,CAAC,uBAAuB,CAClC,MAAc,EACd,UAAkB,EAClB,WAA8B,EAC9B,SAAyB;QAEzB,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,EAAE;YAC9B,MAAM,KAAK,CAAC,2DAA2D,CAAC,CAAC;SAC1E;QACD,MAAM,YAAY,GAAG,CAAC,CAAC;QACvB,IAAI,MAAM,GAAG,cAAc,CAAC,mBAAmB,CAAC,MAAM,EAAE,IAAI,CAAC,sBAAsB,CAAC,CAAC;QACrF,IAAI,WAAW,IAAI,SAAS,EAAE;YAC5B,iBAAiB;YACjB,IAAI,GAAG,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,uBAAuB,CAAC,MAAM,CAAC,CAAC;YACrE,WAAW,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;SACpD;QACD,IAAI,WAAW,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,cAAc,CACvD,MAAM,EACN,UAAU,EACV,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,CAAC,CAAC,CAA2B,EACpE,SAAS,IAAI,EAAE,CAChB,CAAC;QACF,IAAI,WAAW,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE;YACnC,qCAAqC;YACrC,OAAO,IAAI,CAAC;SACb;QACD,oCAAoC;QACpC,MAAM,sBAAsB,GAAG,EAAE,CAAC;QAClC,MAAM,2BAA2B,GAAG,CAAC,CAAC;QACtC,MAAM,+BAA+B,GAAG,CAAC,CAAC;QAC1C,MAAM,iBAAiB,GAAG,CAAC,CAAC;QAC5B,MAAM,YAAY,GAAG,eAAe,CAAC,WAAW,CAAC,sBAAsB,CAAC,CAAC,CAAC;QAC1E,MAAM,GAAG,GAAG,eAAe,CAAC,WAAW,CAAC,2BAA2B,CAAC,CAAC,CAAC;QACtE,MAAM,aAAa,GAAG,eAAe,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC,CAAC;QACtE,MAAM,UAAU,GAAG,eAAe,CAAC,WAAW,CAAC,+BAA+B,CAAC,CAAC,CAAC;QACjF,MAAM,eAAe,GAAG,WAAW,CAAC,CAAC,CAAC,GAAG,UAAU,CAAC;QACpD,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,GAAG,eAAe,GAAG,YAAY,CAAC,CAAC;QACjE,OAAO,aAAa,IAAI,SAAS,CAAC;IACpC,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,eAAe,CAC1B,WAAmB,EACnB,cAAsB,EACtB,UAAkB,EAClB,aAAkC,EAClC,SAA4B;QAE5B,OAAO,MAAM,IAAI,CAAC,aAAc,CAAC,cAAc,CAC7C,WAAW,EACX,cAAc,EACd,UAAU,EACV,aAAa,CAAC,aAAa,EAC3B,aAAa,CAAC,UAAU,EACxB,SAAS,CACV,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACI,KAAK,CAAC,uBAAuB,CAAC,MAAc,EAAE,SAAyB;QAC5E,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,EAAE;YAC9B,MAAM,KAAK,CAAC,2DAA2D,CAAC,CAAC;SAC1E;QACD,IAAI,MAAM,GAAG,cAAc,CAAC,mBAAmB,CAAC,MAAM,EAAE,IAAI,CAAC,sBAAsB,CAAC,CAAC;QACrF,IAAI,WAAW,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,uBAAuB,CAAC,MAAM,EAAE,SAAS,IAAI,EAAE,CAAC,CAAC;QAC5F,OAAO,MAAM,CAAC,WAAW,CAAC,CAAC;IAC7B,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACI,KAAK,CAAC,yBAAyB,CACpC,MAAc,EACd,IAAY,EACZ,EAAU,EACV,SAAyB;QAEzB,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,EAAE;YAC9B,MAAM,KAAK,CAAC,2DAA2D,CAAC,CAAC;SAC1E;QACD,IAAI,MAAM,GAAG,cAAc,CAAC,mBAAmB,CAAC,MAAM,EAAE,IAAI,CAAC,sBAAsB,CAAC,CAAC;QACrF,OAAO,MAAM,IAAI,CAAC,aAAa,CAAC,6BAA6B,CAAC,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,SAAS,IAAI,EAAE,CAAC,CAAC;IACnG,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACI,KAAK,CAAC,oBAAoB,CAAC,MAAc,EAAE,SAAyB;QACzE,oDAAoD;QACpD,IAAI,aAAa,GAAG,MAAM,IAAI,CAAC,uBAAuB,CAAC,MAAM,CAAC,CAAC;QAC/D,OAAO,MAAM,IAAI,CAAC,yBAAyB,CAAC,MAAM,EAAE,CAAC,EAAE,aAAa,EAAE,SAAS,CAAC,CAAC;IACnF,CAAC;CACF"}

package/dist/esm/liquidityProviderTool.js

@@ -1,5 +1,4 @@
-import { __awaiter, __extends, __generator } from "tslib";
-import { floatToDec18 } from "./d8XMath";
+import { floatToDec18, floatToDecN } from "./d8XMath";
 import PerpetualDataHandler from "./perpetualDataHandler";
 import WriteAccessHandler from "./writeAccessHandler";
 /**
@@ -7,8 +6,7 @@ import WriteAccessHandler from "./writeAccessHandler";
  * smart-contract interactions that require gas-payments.
  * @extends WriteAccessHandler
  */
-var LiquidityProviderTool = /** @class */ (function (_super) {
-    __extends(LiquidityProviderTool, _super);
+export default class LiquidityProviderTool extends WriteAccessHandler {
     /**
      * Constructor
      * @param {NodeSDKConfig} config Configuration object, see PerpetualDataHandler.
@@ -29,8 +27,8 @@ var LiquidityProviderTool = /** @class */ (function (_super) {
      *
      * @param {string | Signer} signer Private key or ethers Signer of the account
      */
-    function LiquidityProviderTool(config, signer) {
-        return _super.call(this, config, signer) || this;
+    constructor(config, signer) {
+        super(config, signer);
     }
     /**
      *  Add liquidity to the PnL participant fund. The address gets pool shares in return.
@@ -54,24 +52,15 @@ var LiquidityProviderTool = /** @class */ (function (_super) {
      *
      * @return Transaction object
      */
-    LiquidityProviderTool.prototype.addLiquidity = function (poolSymbolName, amountCC, overrides) {
-        return __awaiter(this, void 0, void 0, function () {
-            var poolId, tx;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        if (this.proxyContract == null || this.signer == null) {
-                            throw Error("no proxy contract or wallet initialized. Use createProxyInstance().");
-                        }
-                        poolId = PerpetualDataHandler._getPoolIdFromSymbol(poolSymbolName, this.poolStaticInfos);
-                        return [4 /*yield*/, this.proxyContract.addLiquidity(poolId, floatToDec18(amountCC), overrides || { gasLimit: this.gasLimit })];
-                    case 1:
-                        tx = _a.sent();
-                        return [2 /*return*/, tx];
-                }
-            });
-        });
-    };
+    async addLiquidity(poolSymbolName, amountCC, overrides) {
+        if (this.proxyContract == null || this.signer == null) {
+            throw Error("no proxy contract or wallet initialized. Use createProxyInstance().");
+        }
+        let poolId = PerpetualDataHandler._getPoolIdFromSymbol(poolSymbolName, this.poolStaticInfos);
+        let decimals = this.getMarginTokenDecimalsFromSymbol(poolSymbolName);
+        let tx = await this.proxyContract.addLiquidity(poolId, floatToDecN(amountCC, decimals), overrides || { gasLimit: this.gasLimit });
+        return tx;
+    }
     /**
      * Initiates a liquidity withdrawal from the pool
      * It triggers a time-delayed unlocking of the given number of pool shares.
@@ -95,24 +84,14 @@ var LiquidityProviderTool = /** @class */ (function (_super) {
      *
      * @return Transaction object.
      */
-    LiquidityProviderTool.prototype.initiateLiquidityWithdrawal = function (poolSymbolName, amountPoolShares, overrides) {
-        return __awaiter(this, void 0, void 0, function () {
-            var poolId, tx;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        if (this.proxyContract == null || this.signer == null) {
-                            throw Error("no proxy contract or wallet initialized. Use createProxyInstance().");
-                        }
-                        poolId = PerpetualDataHandler._getPoolIdFromSymbol(poolSymbolName, this.poolStaticInfos);
-                        return [4 /*yield*/, this.proxyContract.withdrawLiquidity(poolId, floatToDec18(amountPoolShares), overrides || { gasLimit: this.gasLimit })];
-                    case 1:
-                        tx = _a.sent();
-                        return [2 /*return*/, tx];
-                }
-            });
-        });
-    };
+    async initiateLiquidityWithdrawal(poolSymbolName, amountPoolShares, overrides) {
+        if (this.proxyContract == null || this.signer == null) {
+            throw Error("no proxy contract or wallet initialized. Use createProxyInstance().");
+        }
+        let poolId = PerpetualDataHandler._getPoolIdFromSymbol(poolSymbolName, this.poolStaticInfos);
+        let tx = await this.proxyContract.withdrawLiquidity(poolId, floatToDec18(amountPoolShares), overrides || { gasLimit: this.gasLimit });
+        return tx;
+    }
     /**
      * Withdraws as much liquidity as there is available after a call to initiateLiquidityWithdrawal.
      * The address loses pool shares in return.
@@ -134,25 +113,13 @@ var LiquidityProviderTool = /** @class */ (function (_super) {
      *
      * @returns Transaction object.
      */
-    LiquidityProviderTool.prototype.executeLiquidityWithdrawal = function (poolSymbolName, overrides) {
-        return __awaiter(this, void 0, void 0, function () {
-            var poolId, tx;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        if (this.proxyContract == null || this.signer == null) {
-                            throw Error("no proxy contract or wallet initialized. Use createProxyInstance().");
-                        }
-                        poolId = PerpetualDataHandler._getPoolIdFromSymbol(poolSymbolName, this.poolStaticInfos);
-                        return [4 /*yield*/, this.proxyContract.executeLiquidityWithdrawal(poolId, this.traderAddr, overrides || { gasLimit: this.gasLimit })];
-                    case 1:
-                        tx = _a.sent();
-                        return [2 /*return*/, tx];
-                }
-            });
-        });
-    };
-    return LiquidityProviderTool;
-}(WriteAccessHandler));
-export default LiquidityProviderTool;
+    async executeLiquidityWithdrawal(poolSymbolName, overrides) {
+        if (this.proxyContract == null || this.signer == null) {
+            throw Error("no proxy contract or wallet initialized. Use createProxyInstance().");
+        }
+        let poolId = PerpetualDataHandler._getPoolIdFromSymbol(poolSymbolName, this.poolStaticInfos);
+        let tx = await this.proxyContract.executeLiquidityWithdrawal(poolId, this.traderAddr, overrides || { gasLimit: this.gasLimit });
+        return tx;
+    }
+}
 //# sourceMappingURL=liquidityProviderTool.js.map

package/dist/esm/liquidityProviderTool.js.map

@@ -1 +1 @@
-{"version":3,"file":"liquidityProviderTool.js","sourceRoot":"","sources":["../../src/liquidityProviderTool.ts"],"names":[],"mappings":";AAEA,OAAO,EAAgB,YAAY,EAAE,MAAM,WAAW,CAAC;AAEvD,OAAO,oBAAoB,MAAM,wBAAwB,CAAC;AAC1D,OAAO,kBAAkB,MAAM,sBAAsB,CAAC;AACtD;;;;GAIG;AACH;IAAmD,yCAAkB;IACnE;;;;;;;;;;;;;;;;;;;OAmBG;IACH,+BAAmB,MAAqB,EAAE,MAAuB;eAC/D,kBAAM,MAAM,EAAE,MAAM,CAAC;IACvB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACU,4CAAY,GAAzB,UACE,cAAsB,EACtB,QAAgB,EAChB,SAAqB;;;;;;wBAErB,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,EAAE;4BACrD,MAAM,KAAK,CAAC,qEAAqE,CAAC,CAAC;yBACpF;wBACG,MAAM,GAAG,oBAAoB,CAAC,oBAAoB,CAAC,cAAc,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;wBACpF,qBAAM,IAAI,CAAC,aAAa,CAAC,YAAY,CAC5C,MAAM,EACN,YAAY,CAAC,QAAQ,CAAC,EACtB,SAAS,IAAI,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CACzC,EAAA;;wBAJG,EAAE,GAAG,SAIR;wBACD,sBAAO,EAAE,EAAC;;;;KACX;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACU,2DAA2B,GAAxC,UACE,cAAsB,EACtB,gBAAwB,EACxB,SAAqB;;;;;;wBAErB,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,EAAE;4BACrD,MAAM,KAAK,CAAC,qEAAqE,CAAC,CAAC;yBACpF;wBACG,MAAM,GAAG,oBAAoB,CAAC,oBAAoB,CAAC,cAAc,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;wBACpF,qBAAM,IAAI,CAAC,aAAa,CAAC,iBAAiB,CACjD,MAAM,EACN,YAAY,CAAC,gBAAgB,CAAC,EAC9B,SAAS,IAAI,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CACzC,EAAA;;wBAJG,EAAE,GAAG,SAIR;wBACD,sBAAO,EAAE,EAAC;;;;KACX;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACU,0DAA0B,GAAvC,UAAwC,cAAsB,EAAE,SAAqB;;;;;;wBACnF,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,EAAE;4BACrD,MAAM,KAAK,CAAC,qEAAqE,CAAC,CAAC;yBACpF;wBACG,MAAM,GAAG,oBAAoB,CAAC,oBAAoB,CAAC,cAAc,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;wBACpF,qBAAM,IAAI,CAAC,aAAa,CAAC,0BAA0B,CAC1D,MAAM,EACN,IAAI,CAAC,UAAU,EACf,SAAS,IAAI,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CACzC,EAAA;;wBAJG,EAAE,GAAG,SAIR;wBACD,sBAAO,EAAE,EAAC;;;;KACX;IACH,4BAAC;AAAD,CAAC,AAzID,CAAmD,kBAAkB,GAyIpE"}
+{"version":3,"file":"liquidityProviderTool.js","sourceRoot":"","sources":["../../src/liquidityProviderTool.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAEtD,OAAO,oBAAoB,MAAM,wBAAwB,CAAC;AAC1D,OAAO,kBAAkB,MAAM,sBAAsB,CAAC;AACtD;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,qBAAsB,SAAQ,kBAAkB;IACnE;;;;;;;;;;;;;;;;;;;OAmBG;IACH,YAAmB,MAAqB,EAAE,MAAuB;QAC/D,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACxB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACI,KAAK,CAAC,YAAY,CACvB,cAAsB,EACtB,QAAgB,EAChB,SAAqB;QAErB,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,EAAE;YACrD,MAAM,KAAK,CAAC,qEAAqE,CAAC,CAAC;SACpF;QACD,IAAI,MAAM,GAAG,oBAAoB,CAAC,oBAAoB,CAAC,cAAc,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;QAC7F,IAAI,QAAQ,GAAG,IAAI,CAAC,gCAAgC,CAAC,cAAc,CAAC,CAAC;QACrE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,YAAY,CAC5C,MAAM,EACN,WAAW,CAAC,QAAQ,EAAE,QAAS,CAAC,EAChC,SAAS,IAAI,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CACzC,CAAC;QACF,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACI,KAAK,CAAC,2BAA2B,CACtC,cAAsB,EACtB,gBAAwB,EACxB,SAAqB;QAErB,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,EAAE;YACrD,MAAM,KAAK,CAAC,qEAAqE,CAAC,CAAC;SACpF;QACD,IAAI,MAAM,GAAG,oBAAoB,CAAC,oBAAoB,CAAC,cAAc,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;QAC7F,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,iBAAiB,CACjD,MAAM,EACN,YAAY,CAAC,gBAAgB,CAAC,EAC9B,SAAS,IAAI,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CACzC,CAAC;QACF,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACI,KAAK,CAAC,0BAA0B,CAAC,cAAsB,EAAE,SAAqB;QACnF,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,EAAE;YACrD,MAAM,KAAK,CAAC,qEAAqE,CAAC,CAAC;SACpF;QACD,IAAI,MAAM,GAAG,oBAAoB,CAAC,oBAAoB,CAAC,cAAc,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;QAC7F,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,0BAA0B,CAC1D,MAAM,EACN,IAAI,CAAC,UAAU,EACf,SAAS,IAAI,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CACzC,CAAC;QACF,OAAO,EAAE,CAAC;IACZ,CAAC;CACF"}

package/dist/esm/marketData.d.ts

@@ -1,7 +1,7 @@
 import { CallOverrides, Contract } from "@ethersproject/contracts";
 import { Provider } from "@ethersproject/providers";
 import { LimitOrderBook } from "./contracts";
-import { ExchangeInfo, MarginAccount, NodeSDKConfig, Order, PerpetualState, PerpetualStaticInfo, PoolStaticInfo, SmartContractOrder } from "./nodeSDKTypes";
+import { ExchangeInfo, MarginAccount, NodeSDKConfig, Order, PerpetualState, PerpetualStaticInfo, PoolState, PoolStaticInfo, SmartContractOrder } from "./nodeSDKTypes";
 import PerpetualDataHandler from "./perpetualDataHandler";
 import PriceFeeds from "./priceFeeds";
 /**
@@ -314,6 +314,13 @@ export default class MarketData extends PerpetualDataHandler {
      * @returns PerpetualState reference
      */
     getPerpetualState(symbol: string, indexPriceInfo?: [number, number, boolean, boolean], overrides?: CallOverrides): Promise<PerpetualState>;
+    /**
+     * Query recent pool state from blockchain, not including perpetual states
+     * @param symbol symbol of the form USDC
+     * @param indexPrices S2 and S3 prices/isMarketOpen if not provided fetch via REST API
+     * @returns PoolState reference
+     */
+    getPoolState(poolSymbol: string, overrides?: CallOverrides): Promise<PoolState>;
     /**
      * Query perpetual static info.
      * This information is queried once at createProxyInstance-time and remains static after that.