@d8x/perpetuals-sdk 0.1.12 → 0.2.0

package/dist/esm/liquidatorTool.d.ts

@@ -0,0 +1,158 @@
+import WriteAccessHandler from "./writeAccessHandler";
+import { NodeSDKConfig, PriceFeedSubmission } from "./nodeSDKTypes";
+import { ethers } from "ethers";
+/**
+ * Functions to liquidate traders. This class requires a private key
+ * and executes smart-contract interactions that require gas-payments.
+ * @extends WriteAccessHandler
+ */
+export default class LiquidatorTool extends WriteAccessHandler {
+    /**
+     * Constructs a LiquidatorTool instance for a given configuration and private key.
+     * @param {NodeSDKConfig} config Configuration object, see PerpetualDataHandler.
+     * readSDKConfig.
+     * @example
+     * import { LiquidatorTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
+     * async function main() {
+     *   console.log(LiquidatorTool);
+     *   // load configuration for testnet
+     *   const config = PerpetualDataHandler.readSDKConfig("testnet");
+     *   // LiquidatorTool (authentication required, PK is an environment variable with a private key)
+     *   const pk: string = <string>process.env.PK;
+     *   let lqudtrTool = new LiquidatorTool(config, pk);
+     *   // Create a proxy instance to access the blockchain
+     *   await lqudtrTool.createProxyInstance();
+     * }
+     * main();
+     *
+     * @param {string} privateKey Private key of account that liquidates.
+     */
+    constructor(config: NodeSDKConfig, privateKey: string);
+    /**
+     * Liquidate a trader.
+     * @param {string} symbol Symbol of the form ETH-USD-MATIC.
+     * @param {string} traderAddr Address of the trader to be liquidated.
+     * @param {string=} liquidatorAddr Address to be credited if the liquidation succeeds.
+     * @param {PriceFeedSubmission} priceFeedData optional. VAA and timestamps for oracle. If not provided will query from REST API.
+     * Defaults to the wallet used to execute the liquidation.
+     * @example
+     * import { LiquidatorTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
+     * async function main() {
+     *   console.log(LiquidatorTool);
+     *   // Setup (authentication required, PK is an environment variable with a private key)
+     *   const config = PerpetualDataHandler.readSDKConfig("testnet");
+     *   const pk: string = <string>process.env.PK;
+     *   let lqudtrTool = new LiquidatorTool(config, pk);
+     *   await lqudtrTool.createProxyInstance();
+     *   // liquidate trader
+     *   let liqAmount = await lqudtrTool.liquidateTrader("ETH-USD-MATIC",
+     *       "0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B");
+     *   console.log(liqAmount);
+     * }
+     * main();
+     *
+     * @returns Transaction object.
+     */
+    liquidateTrader(symbol: string, traderAddr: string, liquidatorAddr?: string, priceFeedData?: PriceFeedSubmission): Promise<ethers.ContractTransaction>;
+    /**
+     * Check if the collateral of a trader is above the maintenance margin ("maintenance margin safe").
+     * If not, the position can be liquidated.
+     * @param {string} symbol Symbol of the form ETH-USD-MATIC.
+     * @param {string} traderAddr Address of the trader whose position you want to assess.
+     * @param {number[]} indexPrices optional, index price S2/S3 for which we test
+     * @example
+     * import { LiquidatorTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
+     * async function main() {
+     *   console.log(LiquidatorTool);
+     *   // Setup (authentication required, PK is an environment variable with a private key)
+     *   const config = PerpetualDataHandler.readSDKConfig("testnet");
+     *   const pk: string = <string>process.env.PK;
+     *   let lqudtrTool = new LiquidatorTool(config, pk);
+     *   await lqudtrTool.createProxyInstance();
+     *   // check if trader can be liquidated
+     *   let safe = await lqudtrTool.isMaintenanceMarginSafe("ETH-USD-MATIC",
+     *       "0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B");
+     *   console.log(safe);
+     * }
+     * main();
+     *
+     * @returns {boolean} True if the trader is maintenance margin safe in the perpetual.
+     * False means that the trader's position can be liquidated.
+     */
+    isMaintenanceMarginSafe(symbol: string, traderAddr: string, indexPrices?: [number, number]): Promise<boolean>;
+    /**
+     *
+     * @param perpetualId Perpetual id.
+     * @param liquidatorAddr Address to be credited for the liquidation.
+     * @param traderAddr Address of the trader to be liquidated.
+     * @param priceFeedData contains VAA and timestamps required
+     * @param options E.g., Gas limit, fee.
+     * @ignore
+     */
+    _liquidateByAMM(perpetualId: number, liquidatorAddr: string, traderAddr: string, priceFeedData: PriceFeedSubmission, options: object): Promise<any>;
+    /**
+     * 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.
+     * @example
+     * import { LiquidatorTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
+     * async function main() {
+     *   console.log(LiquidatorTool);
+     *   // Setup (authentication required, PK is an environment variable with a private key)
+     *   const config = PerpetualDataHandler.readSDKConfig("testnet");
+     *   const pk: string = <string>process.env.PK;
+     *   let lqudtrTool = new LiquidatorTool(config, pk);
+     *   await lqudtrTool.createProxyInstance();
+     *   // get number of active accounts
+     *   let accounts = await lqudtrTool.countActivePerpAccounts("ETH-USD-MATIC");
+     *   console.log(accounts);
+     * }
+     * main();
+     *
+     * @returns {number} Number of active accounts.
+     */
+    countActivePerpAccounts(symbol: string): Promise<number>;
+    /**
+     * Get addresses of active accounts by chunks.
+     * @param {string} symbol Symbol of the form ETH-USD-MATIC.
+     * @param {number} from From which account we start counting (0-indexed).
+     * @param {number} to Until which account we count, non inclusive.
+     * @example
+     * import { LiquidatorTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
+     * async function main() {
+     *   console.log(LiquidatorTool);
+     *   // Setup (authentication required, PK is an environment variable with a private key)
+     *   const config = PerpetualDataHandler.readSDKConfig("testnet");
+     *   const pk: string = <string>process.env.PK;
+     *   let lqudtrTool = new LiquidatorTool(config, pk);
+     *   await lqudtrTool.createProxyInstance();
+     *   // get all active accounts in chunks
+     *   let accounts = await lqudtrTool.getActiveAccountsByChunks("ETH-USD-MATIC", 0, 4);
+     *   console.log(accounts);
+     * }
+     * main();
+     *
+     * @returns {string[]} Array of addresses at locations 'from', 'from'+1 ,..., 'to'-1.
+     */
+    getActiveAccountsByChunks(symbol: string, from: number, to: number): Promise<string[]>;
+    /**
+     * Addresses for all the active accounts in this perpetual symbol.
+     * @param {string} symbol Symbol of the form ETH-USD-MATIC.
+     * @example
+     * import { LiquidatorTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
+     * async function main() {
+     *   console.log(LiquidatorTool);
+     *   // Setup (authentication required, PK is an environment variable with a private key)
+     *   const config = PerpetualDataHandler.readSDKConfig("testnet");
+     *   const pk: string = <string>process.env.PK;
+     *   let lqudtrTool = new LiquidatorTool(config, pk);
+     *   await lqudtrTool.createProxyInstance();
+     *   // get all active accounts
+     *   let accounts = await lqudtrTool.getAllActiveAccounts("ETH-USD-MATIC");
+     *   console.log(accounts);
+     * }
+     * main();
+     *
+     * @returns {string[]} Array of addresses.
+     */
+    getAllActiveAccounts(symbol: string): Promise<string[]>;
+}

package/dist/{src → esm}/liquidatorTool.js

@@ -1,61 +1,6 @@
-"use strict";
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = function (d, b) {
-        extendStatics = Object.setPrototypeOf ||
-            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
-        return extendStatics(d, b);
-    };
-    return function (d, b) {
-        if (typeof b !== "function" && b !== null)
-            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
-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());
-    });
-};
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (g && (g = 0, op[0] && (_ = 0)), _) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-var writeAccessHandler_1 = __importDefault(require("./writeAccessHandler"));
-var d8XMath_1 = require("./d8XMath");
+import { __awaiter, __extends, __generator } from "tslib";
+import WriteAccessHandler from "./writeAccessHandler";
+import { ABK64x64ToFloat, floatToABK64x64 } from "./d8XMath";
 /**
  * Functions to liquidate traders. This class requires a private key
  * and executes smart-contract interactions that require gas-payments.
@@ -183,7 +128,7 @@ var LiquidatorTool = /** @class */ (function (_super) {
                         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 (0, d8XMath_1.floatToABK64x64)(x); }))];
+                    case 2: return [4 /*yield*/, this.proxyContract.getTraderState(perpID, traderAddr, indexPrices.map(function (x) { return floatToABK64x64(x); }))];
                     case 3:
                         traderState = _a.sent();
                         if (traderState[idx_notional] == 0) {
@@ -194,10 +139,10 @@ var LiquidatorTool = /** @class */ (function (_super) {
                         idx_marginAccountPositionBC = 4;
                         idx_collateralToQuoteConversion = 9;
                         idx_marginBalance = 0;
-                        maintMgnRate = (0, d8XMath_1.ABK64x64ToFloat)(traderState[idx_maintenanceMgnRate]);
-                        pos = (0, d8XMath_1.ABK64x64ToFloat)(traderState[idx_marginAccountPositionBC]);
-                        marginbalance = (0, d8XMath_1.ABK64x64ToFloat)(traderState[idx_marginBalance]);
-                        coll2quote = (0, d8XMath_1.ABK64x64ToFloat)(traderState[idx_collateralToQuoteConversion]);
+                        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];
@@ -335,6 +280,6 @@ var LiquidatorTool = /** @class */ (function (_super) {
         });
     };
     return LiquidatorTool;
-}(writeAccessHandler_1.default));
-exports.default = LiquidatorTool;
+}(WriteAccessHandler));
+export default LiquidatorTool;
 //# sourceMappingURL=liquidatorTool.js.map

package/dist/esm/liquidatorTool.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"liquidatorTool.js","sourceRoot":"","sources":["../../src/liquidatorTool.ts"],"names":[],"mappings":";AAAA,OAAO,kBAAkB,MAAM,sBAAsB,CAAC;AAGtD,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAE7D;;;;GAIG;AACH;IAA4C,kCAAkB;IAC5D;;;;;;;;;;;;;;;;;;;OAmBG;IACH,wBAAmB,MAAqB,EAAE,UAAkB;eAC1D,kBAAM,MAAM,EAAE,UAAU,CAAC;IAC3B,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACU,wCAAe,GAA5B,UACE,MAAc,EACd,UAAkB,EAClB,cAA2B,EAC3B,aAAmC;QADnC,+BAAA,EAAA,mBAA2B;;;;;;wBAG3B,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;;4BAEvD,qBAAM,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,aAAa,EAAE;4BACnF,QAAQ,EAAE,IAAI,CAAC,QAAQ;4BACvB,KAAK,EAAE,IAAI,CAAC,qBAAqB,GAAG,aAAa,CAAC,aAAa,CAAC,MAAM;yBACvE,CAAC,EAAA;4BAHF,sBAAO,SAGL,EAAC;;;;KACJ;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACU,gDAAuB,GAApC,UACE,MAAc,EACd,UAAkB,EAClB,WAA8B;;;;;;wBAE9B,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,CAAC,CAC3C,EAAA;;wBAJG,WAAW,GAAG,SAIjB;wBACD,IAAI,WAAW,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE;4BAClC,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,OAAe;;;;4BAER,qBAAM,IAAI,CAAC,aAAc,CAAC,cAAc,CAC7C,WAAW,EACX,cAAc,EACd,UAAU,EACV,aAAa,CAAC,aAAa,EAC3B,aAAa,CAAC,UAAU,EACxB,OAAO,CACR,EAAA;4BAPD,sBAAO,SAON,EAAC;;;;KACH;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACU,gDAAuB,GAApC,UAAqC,MAAc;;;;;;wBACjD,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,CAAC,EAAA;;wBAAtE,WAAW,GAAG,SAAwD;wBAC1E,sBAAO,MAAM,CAAC,WAAW,CAAC,EAAC;;;;KAC5B;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACU,kDAAyB,GAAtC,UAAuC,MAAc,EAAE,IAAY,EAAE,EAAU;;;;;;wBAC7E,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,CAAC,EAAA;4BAA/E,sBAAO,SAAwE,EAAC;;;;KACjF;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACU,6CAAoB,GAAjC,UAAkC,MAAc;;;;;4BAE1B,qBAAM,IAAI,CAAC,uBAAuB,CAAC,MAAM,CAAC,EAAA;;wBAA1D,aAAa,GAAG,SAA0C;wBACvD,qBAAM,IAAI,CAAC,yBAAyB,CAAC,MAAM,EAAE,CAAC,EAAE,aAAa,CAAC,EAAA;4BAArE,sBAAO,SAA8D,EAAC;;;;KACvE;IACH,qBAAC;AAAD,CAAC,AAvPD,CAA4C,kBAAkB,GAuP7D"}

package/dist/esm/liquidityProviderTool.d.ts

@@ -0,0 +1,126 @@
+import { ethers } from "ethers";
+import { NodeSDKConfig } from "./nodeSDKTypes";
+import WriteAccessHandler from "./writeAccessHandler";
+/**
+ * Functions to provide liquidity. This class requires a private key and executes
+ * smart-contract interactions that require gas-payments.
+ * @extends WriteAccessHandler
+ */
+export default class LiquidityProviderTool extends WriteAccessHandler {
+    /**
+     * Constructor
+     * @param {NodeSDKConfig} config Configuration object, see PerpetualDataHandler.
+     * readSDKConfig.
+     * @example
+     * import { LiquidityProviderTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
+     * async function main() {
+     *   console.log(LiquidityProviderTool);
+     *   // load configuration for testnet
+     *   const config = PerpetualDataHandler.readSDKConfig("testnet");
+     *   // LiquidityProviderTool (authentication required, PK is an environment variable with a private key)
+     *   const pk: string = <string>process.env.PK;
+     *   let lqudtProviderTool = new LiquidityProviderTool(config, pk);
+     *   // Create a proxy instance to access the blockchain
+     *   await lqudtProviderTool.createProxyInstance();
+     * }
+     * main();
+     *
+     * @param privateKey private key of account that trades
+     */
+    constructor(config: NodeSDKConfig, privateKey: string);
+    /**
+     * Value of the pool share tokens for this liquidity provider
+     * in poolSymbol-currency (e.g. MATIC, USDC).
+     * @param {string} poolSymbolName Pool symbol name (e.g. MATIC).
+     * @example
+     * import { LiquidityProviderTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
+     * async function main() {
+     *   console.log(LiquidityProviderTool);
+     *   // setup (authentication required, PK is an environment variable with a private key)
+     *   const config = PerpetualDataHandler.readSDKConfig("testnet");
+     *   const pk: string = <string>process.env.PK;
+     *   let lqudtProviderTool = new LiquidityProviderTool(config, pk);
+     *   await lqudtProviderTool.createProxyInstance();
+     *   // get value of pool share token
+     *   let shareToken = await lqudtProviderTool.getParticipationValue("MATIC");
+     *   console.log(shareToken);
+     * }
+     * main();
+     *
+     * @return Value in poolSymbol-currency (e.g. MATIC, USDC), balance of pool share tokens, and share token symbol.
+     */
+    getParticipationValue(poolSymbolName: string): Promise<{
+        value: number;
+        shareTokenBalance: number;
+        poolShareToken: string;
+    }>;
+    /**
+     *  Add liquidity to the PnL participant fund. The address gets pool shares in return.
+     * @param {string} poolSymbolName  Name of pool symbol (e.g. MATIC)
+     * @param {number} amountCC  Amount in pool-collateral currency
+     * @example
+     * import { LiquidityProviderTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
+     * async function main() {
+     *   console.log(LiquidityProviderTool);
+     *   // setup (authentication required, PK is an environment variable with a private key)
+     *   const config = PerpetualDataHandler.readSDKConfig("testnet");
+     *   const pk: string = <string>process.env.PK;
+     *   let lqudtProviderTool = new LiquidityProviderTool(config, pk);
+     *   await lqudtProviderTool.createProxyInstance();
+     *   // add liquidity
+     *   await lqudtProviderTool.setAllowance("MATIC");
+     *   let respAddLiquidity = await lqudtProviderTool.addLiquidity("MATIC", 0.1);
+     *   console.log(respAddLiquidity);
+     * }
+     * main();
+     *
+     * @return Transaction object
+     */
+    addLiquidity(poolSymbolName: string, amountCC: number): Promise<ethers.ContractTransaction>;
+    /**
+     * Initiates a liquidity withdrawal from the pool
+     * It triggers a time-delayed unlocking of the given number of pool shares.
+     * The amount of pool shares to be unlocked is fixed by this call, but not their value in pool currency.
+     * @param {string} poolSymbolName Name of pool symbol (e.g. MATIC).
+     * @param {string} amountPoolShares Amount in pool-shares, removes everything if > available amount.
+     * @example
+     * import { LiquidityProviderTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
+     * async function main() {
+     *   console.log(LiquidityProviderTool);
+     *   // setup (authentication required, PK is an environment variable with a private key)
+     *   const config = PerpetualDataHandler.readSDKConfig("testnet");
+     *   const pk: string = <string>process.env.PK;
+     *   let lqudtProviderTool = new LiquidityProviderTool(config, pk);
+     *   await lqudtProviderTool.createProxyInstance();
+     *   // initiate withdrawal
+     *   let respRemoveLiquidity = await lqudtProviderTool.initiateLiquidityWithdrawal("MATIC", 0.1);
+     *   console.log(respRemoveLiquidity);
+     * }
+     * main();
+     *
+     * @return Transaction object.
+     */
+    initiateLiquidityWithdrawal(poolSymbolName: string, amountPoolShares: number): Promise<ethers.providers.TransactionResponse>;
+    /**
+     * Withdraws as much liquidity as there is available after a call to initiateLiquidityWithdrawal.
+     * The address loses pool shares in return.
+     * @param poolSymbolName
+     * @example
+     * import { LiquidityProviderTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
+     * async function main() {
+     *   console.log(LiquidityProviderTool);
+     *   // setup (authentication required, PK is an environment variable with a private key)
+     *   const config = PerpetualDataHandler.readSDKConfig("testnet");
+     *   const pk: string = <string>process.env.PK;
+     *   let lqudtProviderTool = new LiquidityProviderTool(config, pk);
+     *   await lqudtProviderTool.createProxyInstance();
+     *   // remove liquidity
+     *   let respRemoveLiquidity = await lqudtProviderTool.executeLiquidityWithdrawal("MATIC", 0.1);
+     *   console.log(respRemoveLiquidity);
+     * }
+     * main();
+     *
+     * @returns Transaction object.
+     */
+    executeLiquidityWithdrawal(poolSymbolName: string): Promise<ethers.providers.TransactionResponse>;
+}

package/dist/esm/liquidityProviderTool.js

@@ -0,0 +1,218 @@
+import { __awaiter, __extends, __generator } from "tslib";
+import { ethers } from "ethers";
+import { dec18ToFloat, floatToDec18 } from "./d8XMath";
+import { ERC20_ABI } from "./nodeSDKTypes";
+import PerpetualDataHandler from "./perpetualDataHandler";
+import WriteAccessHandler from "./writeAccessHandler";
+/**
+ * Functions to provide liquidity. This class requires a private key and executes
+ * smart-contract interactions that require gas-payments.
+ * @extends WriteAccessHandler
+ */
+var LiquidityProviderTool = /** @class */ (function (_super) {
+    __extends(LiquidityProviderTool, _super);
+    /**
+     * Constructor
+     * @param {NodeSDKConfig} config Configuration object, see PerpetualDataHandler.
+     * readSDKConfig.
+     * @example
+     * import { LiquidityProviderTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
+     * async function main() {
+     *   console.log(LiquidityProviderTool);
+     *   // load configuration for testnet
+     *   const config = PerpetualDataHandler.readSDKConfig("testnet");
+     *   // LiquidityProviderTool (authentication required, PK is an environment variable with a private key)
+     *   const pk: string = <string>process.env.PK;
+     *   let lqudtProviderTool = new LiquidityProviderTool(config, pk);
+     *   // Create a proxy instance to access the blockchain
+     *   await lqudtProviderTool.createProxyInstance();
+     * }
+     * main();
+     *
+     * @param privateKey private key of account that trades
+     */
+    function LiquidityProviderTool(config, privateKey) {
+        return _super.call(this, config, privateKey) || this;
+    }
+    /**
+     * Value of the pool share tokens for this liquidity provider
+     * in poolSymbol-currency (e.g. MATIC, USDC).
+     * @param {string} poolSymbolName Pool symbol name (e.g. MATIC).
+     * @example
+     * import { LiquidityProviderTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
+     * async function main() {
+     *   console.log(LiquidityProviderTool);
+     *   // setup (authentication required, PK is an environment variable with a private key)
+     *   const config = PerpetualDataHandler.readSDKConfig("testnet");
+     *   const pk: string = <string>process.env.PK;
+     *   let lqudtProviderTool = new LiquidityProviderTool(config, pk);
+     *   await lqudtProviderTool.createProxyInstance();
+     *   // get value of pool share token
+     *   let shareToken = await lqudtProviderTool.getParticipationValue("MATIC");
+     *   console.log(shareToken);
+     * }
+     * main();
+     *
+     * @return Value in poolSymbol-currency (e.g. MATIC, USDC), balance of pool share tokens, and share token symbol.
+     */
+    LiquidityProviderTool.prototype.getParticipationValue = function (poolSymbolName) {
+        return __awaiter(this, void 0, void 0, function () {
+            var poolId, shareTokenAddr, shareToken, dShareTokenBalanceOfAddr, valueCCDec18, shareTokenBalanceOfAddr;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (this.proxyContract == null ||
+                            this.signer == null ||
+                            this.poolStaticInfos.length == 0 ||
+                            this.provider == null) {
+                            throw Error("no proxy contract or wallet or data initialized. Use createProxyInstance().");
+                        }
+                        poolId = PerpetualDataHandler._getPoolIdFromSymbol(poolSymbolName, this.poolStaticInfos);
+                        shareTokenAddr = this.poolStaticInfos[poolId - 1].shareTokenAddr;
+                        shareToken = new ethers.Contract(shareTokenAddr, ERC20_ABI, this.signer);
+                        return [4 /*yield*/, shareToken.balanceOf(this.traderAddr)];
+                    case 1:
+                        dShareTokenBalanceOfAddr = _a.sent();
+                        return [4 /*yield*/, this.proxyContract.getTokenAmountToReturn(poolId, dShareTokenBalanceOfAddr)];
+                    case 2:
+                        valueCCDec18 = _a.sent();
+                        shareTokenBalanceOfAddr = dec18ToFloat(dShareTokenBalanceOfAddr);
+                        return [2 /*return*/, {
+                                value: dec18ToFloat(valueCCDec18),
+                                shareTokenBalance: shareTokenBalanceOfAddr,
+                                poolShareToken: shareTokenAddr,
+                            }];
+                }
+            });
+        });
+    };
+    /**
+     *  Add liquidity to the PnL participant fund. The address gets pool shares in return.
+     * @param {string} poolSymbolName  Name of pool symbol (e.g. MATIC)
+     * @param {number} amountCC  Amount in pool-collateral currency
+     * @example
+     * import { LiquidityProviderTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
+     * async function main() {
+     *   console.log(LiquidityProviderTool);
+     *   // setup (authentication required, PK is an environment variable with a private key)
+     *   const config = PerpetualDataHandler.readSDKConfig("testnet");
+     *   const pk: string = <string>process.env.PK;
+     *   let lqudtProviderTool = new LiquidityProviderTool(config, pk);
+     *   await lqudtProviderTool.createProxyInstance();
+     *   // add liquidity
+     *   await lqudtProviderTool.setAllowance("MATIC");
+     *   let respAddLiquidity = await lqudtProviderTool.addLiquidity("MATIC", 0.1);
+     *   console.log(respAddLiquidity);
+     * }
+     * main();
+     *
+     * @return Transaction object
+     */
+    LiquidityProviderTool.prototype.addLiquidity = function (poolSymbolName, amountCC) {
+        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), {
+                                gasLimit: this.gasLimit,
+                            })];
+                    case 1:
+                        tx = _a.sent();
+                        return [2 /*return*/, tx];
+                }
+            });
+        });
+    };
+    /**
+     * Initiates a liquidity withdrawal from the pool
+     * It triggers a time-delayed unlocking of the given number of pool shares.
+     * The amount of pool shares to be unlocked is fixed by this call, but not their value in pool currency.
+     * @param {string} poolSymbolName Name of pool symbol (e.g. MATIC).
+     * @param {string} amountPoolShares Amount in pool-shares, removes everything if > available amount.
+     * @example
+     * import { LiquidityProviderTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
+     * async function main() {
+     *   console.log(LiquidityProviderTool);
+     *   // setup (authentication required, PK is an environment variable with a private key)
+     *   const config = PerpetualDataHandler.readSDKConfig("testnet");
+     *   const pk: string = <string>process.env.PK;
+     *   let lqudtProviderTool = new LiquidityProviderTool(config, pk);
+     *   await lqudtProviderTool.createProxyInstance();
+     *   // initiate withdrawal
+     *   let respRemoveLiquidity = await lqudtProviderTool.initiateLiquidityWithdrawal("MATIC", 0.1);
+     *   console.log(respRemoveLiquidity);
+     * }
+     * main();
+     *
+     * @return Transaction object.
+     */
+    LiquidityProviderTool.prototype.initiateLiquidityWithdrawal = function (poolSymbolName, amountPoolShares) {
+        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), {
+                                gasLimit: this.gasLimit,
+                            })];
+                    case 1:
+                        tx = _a.sent();
+                        return [2 /*return*/, tx];
+                }
+            });
+        });
+    };
+    /**
+     * Withdraws as much liquidity as there is available after a call to initiateLiquidityWithdrawal.
+     * The address loses pool shares in return.
+     * @param poolSymbolName
+     * @example
+     * import { LiquidityProviderTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
+     * async function main() {
+     *   console.log(LiquidityProviderTool);
+     *   // setup (authentication required, PK is an environment variable with a private key)
+     *   const config = PerpetualDataHandler.readSDKConfig("testnet");
+     *   const pk: string = <string>process.env.PK;
+     *   let lqudtProviderTool = new LiquidityProviderTool(config, pk);
+     *   await lqudtProviderTool.createProxyInstance();
+     *   // remove liquidity
+     *   let respRemoveLiquidity = await lqudtProviderTool.executeLiquidityWithdrawal("MATIC", 0.1);
+     *   console.log(respRemoveLiquidity);
+     * }
+     * main();
+     *
+     * @returns Transaction object.
+     */
+    LiquidityProviderTool.prototype.executeLiquidityWithdrawal = function (poolSymbolName) {
+        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, {
+                                gasLimit: this.gasLimit,
+                            })];
+                    case 1:
+                        tx = _a.sent();
+                        return [2 /*return*/, tx];
+                }
+            });
+        });
+    };
+    return LiquidityProviderTool;
+}(WriteAccessHandler));
+export default LiquidityProviderTool;
+//# sourceMappingURL=liquidityProviderTool.js.map

package/dist/esm/liquidityProviderTool.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"liquidityProviderTool.js","sourceRoot":"","sources":["../../src/liquidityProviderTool.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AACvD,OAAO,EAAE,SAAS,EAAiB,MAAM,gBAAgB,CAAC;AAC1D,OAAO,oBAAoB,MAAM,wBAAwB,CAAC;AAC1D,OAAO,kBAAkB,MAAM,sBAAsB,CAAC;AACtD;;;;GAIG;AACH;IAAmD,yCAAkB;IACnE;;;;;;;;;;;;;;;;;;;OAmBG;IACH,+BAAmB,MAAqB,EAAE,UAAkB;eAC1D,kBAAM,MAAM,EAAE,UAAU,CAAC;IAC3B,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACU,qDAAqB,GAAlC,UACE,cAAsB;;;;;;wBAEtB,IACE,IAAI,CAAC,aAAa,IAAI,IAAI;4BAC1B,IAAI,CAAC,MAAM,IAAI,IAAI;4BACnB,IAAI,CAAC,eAAe,CAAC,MAAM,IAAI,CAAC;4BAChC,IAAI,CAAC,QAAQ,IAAI,IAAI,EACrB;4BACA,MAAM,KAAK,CAAC,6EAA6E,CAAC,CAAC;yBAC5F;wBACG,MAAM,GAAG,oBAAoB,CAAC,oBAAoB,CAAC,cAAc,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;wBAEzF,cAAc,GAAG,IAAI,CAAC,eAAe,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,cAAc,CAAC;wBACjE,UAAU,GAAG,IAAI,MAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;wBAC9C,qBAAM,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,EAAA;;wBAAtE,wBAAwB,GAAG,SAA2C;wBAEvD,qBAAM,IAAI,CAAC,aAAa,CAAC,sBAAsB,CAAC,MAAM,EAAE,wBAAwB,CAAC,EAAA;;wBAAhG,YAAY,GAAG,SAAiF;wBAEhG,uBAAuB,GAAG,YAAY,CAAC,wBAAwB,CAAC,CAAC;wBAErE,sBAAO;gCACL,KAAK,EAAE,YAAY,CAAC,YAAY,CAAC;gCACjC,iBAAiB,EAAE,uBAAuB;gCAC1C,cAAc,EAAE,cAAc;6BAC/B,EAAC;;;;KACH;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACU,4CAAY,GAAzB,UAA0B,cAAsB,EAAE,QAAgB;;;;;;wBAChE,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,CAAC,MAAM,EAAE,YAAY,CAAC,QAAQ,CAAC,EAAE;gCAC7E,QAAQ,EAAE,IAAI,CAAC,QAAQ;6BACxB,CAAC,EAAA;;wBAFE,EAAE,GAAG,SAEP;wBACF,sBAAO,EAAE,EAAC;;;;KACX;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACU,2DAA2B,GAAxC,UACE,cAAsB,EACtB,gBAAwB;;;;;;wBAExB,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,CAAC,MAAM,EAAE,YAAY,CAAC,gBAAgB,CAAC,EAAE;gCAC1F,QAAQ,EAAE,IAAI,CAAC,QAAQ;6BACxB,CAAC,EAAA;;wBAFE,EAAE,GAAG,SAEP;wBACF,sBAAO,EAAE,EAAC;;;;KACX;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACU,0DAA0B,GAAvC,UAAwC,cAAsB;;;;;;wBAC5D,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,CAAC,MAAM,EAAE;gCACnE,QAAQ,EAAE,IAAI,CAAC,QAAQ;6BACxB,CAAC,EAAA;;wBAFE,EAAE,GAAG,SAEP;wBACF,sBAAO,EAAE,EAAC;;;;KACX;IACH,4BAAC;AAAD,CAAC,AA/KD,CAAmD,kBAAkB,GA+KpE"}