@d8x/perpetuals-sdk 0.0.1 → 0.0.2

package/dist/liquidatorTool.d.ts

@@ -0,0 +1,38 @@
+import WriteAccessHandler from "./writeAccessHandler";
+import { NodeSDKConfig } from "./nodeSDKTypes";
+/**
+ * Methods to liquidate traders.
+ */
+export default class LiquidatorTool extends WriteAccessHandler {
+    /**
+     * Constructs a LiquidatorTool instance for a given configuration and private key.
+     * @param {NodeSDKConfig} config Configuration object.
+     * @param {string} privateKey Private key of account that liquidates.
+     */
+    constructor(config: NodeSDKConfig, privateKey: string);
+    /**
+     *
+     * @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.
+     * Defaults to the wallet used to execute the liquidation.
+     * @returns {number} Liquidated amount.
+     */
+    liquidateTrader(symbol: string, traderAddr: string, liquidatorAddr?: string): Promise<number>;
+    /**
+     * Check if a trader is maintenance margin safe - if not, it can be liquidated.
+     * @param {string} symbol Symbol of the form ETH-USD-MATIC.
+     * @param {string} traderAddr Address of the trader whose position we want to assess.
+     * @returns {boolean} True if the trader is maintenance margin safe in the perpetual.
+     */
+    isMaintenanceMarginSafe(symbol: string, traderAddr: string): 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 gasLimit Gas limit.
+     * @ignore
+     */
+    _liquidateByAMM(perpetualId: number, liquidatorAddr: string, traderAddr: string, gasLimit: number): Promise<number>;
+}

package/dist/liquidatorTool.js

@@ -0,0 +1,83 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const writeAccessHandler_1 = __importDefault(require("./writeAccessHandler"));
+const d8XMath_1 = require("./d8XMath");
+/**
+ * Methods to liquidate traders.
+ */
+class LiquidatorTool extends writeAccessHandler_1.default {
+    /**
+     * Constructs a LiquidatorTool instance for a given configuration and private key.
+     * @param {NodeSDKConfig} config Configuration object.
+     * @param {string} privateKey Private key of account that liquidates.
+     */
+    constructor(config, privateKey) {
+        super(config, privateKey);
+    }
+    /**
+     *
+     * @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.
+     * Defaults to the wallet used to execute the liquidation.
+     * @returns {number} Liquidated amount.
+     */
+    liquidateTrader(symbol, traderAddr, liquidatorAddr = "") {
+        return __awaiter(this, void 0, void 0, function* () {
+            // 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);
+            return yield this._liquidateByAMM(perpID, liquidatorAddr, traderAddr, this.gasLimit);
+        });
+    }
+    /**
+     * Check if a trader is maintenance margin safe - if not, it can be liquidated.
+     * @param {string} symbol Symbol of the form ETH-USD-MATIC.
+     * @param {string} traderAddr Address of the trader whose position we want to assess.
+     * @returns {boolean} True if the trader is maintenance margin safe in the perpetual.
+     */
+    isMaintenanceMarginSafe(symbol, traderAddr) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.proxyContract == null) {
+                throw Error("no proxy contract initialized. Use createProxyInstance().");
+            }
+            let perpID = LiquidatorTool.symbolToPerpetualId(symbol, this.symbolToPerpStaticInfo);
+            return yield this.proxyContract.isMaintenanceMarginSafe(perpID, traderAddr);
+        });
+    }
+    /**
+     *
+     * @param perpetualId Perpetual id.
+     * @param liquidatorAddr Address to be credited for the liquidation.
+     * @param traderAddr Address of the trader to be liquidated.
+     * @param gasLimit Gas limit.
+     * @ignore
+     */
+    _liquidateByAMM(perpetualId, liquidatorAddr, traderAddr, gasLimit) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let fAmount = yield this.proxyContract.liquidateByAMM(perpetualId, liquidatorAddr, traderAddr, {
+                gasLimit: gasLimit,
+            });
+            return (0, d8XMath_1.ABK64x64ToFloat)(fAmount);
+        });
+    }
+}
+exports.default = LiquidatorTool;

package/dist/liquidityProviderTool.d.ts

@@ -2,7 +2,6 @@ import { ethers } from "ethers";
 import WriteAccessHandler from "./writeAccessHandler";
 import { NodeSDKConfig } from "./nodeSDKTypes";
 /**
- * LiquidityProviderTool
  * Methods to provide liquidity
  */
 export default class LiquidityProviderTool extends WriteAccessHandler {
@@ -13,9 +12,10 @@ export default class LiquidityProviderTool extends WriteAccessHandler {
      */
     constructor(config: NodeSDKConfig, privateKey: string);
     /**
-     * Returns the value of the share tokens for this liquidity provider
-     * in poolSymbol-currency (e.g. MATIC, USDC)
-     * @param poolSymbolName pool symbol name (e.g. MATIC)
+     * Value of the share tokens for this liquidity provider
+     * in poolSymbol-currency (e.g. MATIC, USDC).
+     * @param {string} poolSymbolName Pool symbol name (e.g. MATIC).
+     * @return Value in poolSymbol-currency (e.g. MATIC, USDC), balabce of share tokens, and share token symbol.
      */
     getParticipationValue(poolSymbolName: string): Promise<{
         value: number;
@@ -24,16 +24,16 @@ export default class LiquidityProviderTool extends WriteAccessHandler {
     }>;
     /**
      *  Add liquidity to the PnL participant fund. The address gets pool shares in return.
-     * @param poolname  name of pool symbol (e.g. MATIC)
-     * @param amountCC  amount in pool-collateral currency
-     * @return transaction object
+     * @param {string} poolname  Name of pool symbol (e.g. MATIC)
+     * @param {number} amountCC  Amount in pool-collateral currency
+     * @return Transaction object
      */
     addLiquidity(poolSymbolName: string, amountCC: number): Promise<ethers.providers.TransactionResponse>;
     /**
-     * Remove liquidity from the pool
-     * @param poolSymbolName name of pool symbol (e.g. MATIC)
-     * @param amountPoolShares amount in pool-tokens, removes everything if > available amount
-     * @return transaction object
+     * Remove liquidity from the pool.
+     * @param {string} poolSymbolName Name of pool symbol (e.g. MATIC).
+     * @param {string} amountPoolShares Amount in pool-tokens, removes everything if > available amount.
+     * @return Transaction object.
      */
     removeLiquidity(poolSymbolName: string, amountPoolShares: number): Promise<ethers.providers.TransactionResponse>;
 }

package/dist/liquidityProviderTool.js

@@ -18,7 +18,6 @@ const nodeSDKTypes_1 = require("./nodeSDKTypes");
 const perpetualDataHandler_1 = __importDefault(require("./perpetualDataHandler"));
 const d8XMath_1 = require("./d8XMath");
 /**
- * LiquidityProviderTool
  * Methods to provide liquidity
  */
 class LiquidityProviderTool extends writeAccessHandler_1.default {
@@ -31,9 +30,10 @@ class LiquidityProviderTool extends writeAccessHandler_1.default {
         super(config, privateKey);
     }
     /**
-     * Returns the value of the share tokens for this liquidity provider
-     * in poolSymbol-currency (e.g. MATIC, USDC)
-     * @param poolSymbolName pool symbol name (e.g. MATIC)
+     * Value of the share tokens for this liquidity provider
+     * in poolSymbol-currency (e.g. MATIC, USDC).
+     * @param {string} poolSymbolName Pool symbol name (e.g. MATIC).
+     * @return Value in poolSymbol-currency (e.g. MATIC, USDC), balabce of share tokens, and share token symbol.
      */
     getParticipationValue(poolSymbolName) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -62,9 +62,9 @@ class LiquidityProviderTool extends writeAccessHandler_1.default {
     }
     /**
      *  Add liquidity to the PnL participant fund. The address gets pool shares in return.
-     * @param poolname  name of pool symbol (e.g. MATIC)
-     * @param amountCC  amount in pool-collateral currency
-     * @return transaction object
+     * @param {string} poolname  Name of pool symbol (e.g. MATIC)
+     * @param {number} amountCC  Amount in pool-collateral currency
+     * @return Transaction object
      */
     addLiquidity(poolSymbolName, amountCC) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -79,10 +79,10 @@ class LiquidityProviderTool extends writeAccessHandler_1.default {
         });
     }
     /**
-     * Remove liquidity from the pool
-     * @param poolSymbolName name of pool symbol (e.g. MATIC)
-     * @param amountPoolShares amount in pool-tokens, removes everything if > available amount
-     * @return transaction object
+     * Remove liquidity from the pool.
+     * @param {string} poolSymbolName Name of pool symbol (e.g. MATIC).
+     * @param {string} amountPoolShares Amount in pool-tokens, removes everything if > available amount.
+     * @return Transaction object.
      */
     removeLiquidity(poolSymbolName, amountPoolShares) {
         return __awaiter(this, void 0, void 0, function* () {

package/dist/marketData.d.ts

@@ -9,23 +9,34 @@ import { Order } from "./nodeSDKTypes";
 export default class MarketData extends PerpetualDataHandler {
     constructor(config: NodeSDKConfig);
     createProxyInstance(): Promise<void>;
+    /**
+     * Information about the products traded in the exchange.
+     * @returns {ExchangeInfo} Array of static data for all the pools and perpetuals in the system.
+     */
     exchangeInfo(): Promise<ExchangeInfo>;
     /**
-     * Get all open orders for a trader-address and a symbol
-     * @param traderAddr address of the trader for which we get the open order
-     * @param symbol symbol of the form ETH-USD-MATIC
-     * @returns array of open orders and corresponding order-ids
+     * All open orders for a trader-address and a symbol.
+     * @param {string} traderAddr Address of the trader for which we get the open orders.
+     * @param {string} symbol Symbol of the form ETH-USD-MATIC.
+     * @returns {Array<Array<Order>, Array<string>>} Array of open orders and corresponding order-ids.
      */
     openOrders(traderAddr: string, symbol: string): Promise<{
         orders: Order[];
         orderIds: string[];
     }>;
+    /**
+     * Information about the position open by a given trader in a given perpetual contract.
+     * @param {string} traderAddr Address of the trader for which we get the position risk.
+     * @param {string} symbol Symbol of the form ETH-USD-MATIC.
+     * @returns {MarginAccount}
+     */
     positionRisk(traderAddr: string, symbol: string): Promise<MarginAccount>;
     /**
-     * Query smart contract to get user orders and convert to user friendly order format
-     * @param traderAddr address of trader
-     * @param orderBookContract instance of order book
-     * @returns array of user friendly order struct
+     * Query smart contract to get user orders and convert to user friendly order format.
+     * @param {string} traderAddr Address of trader.
+     * @param {ethers.Contract} orderBookContract Instance of order book.
+     * @returns {Order[]} Array of user friendly order struct.
+     * @ignore
      */
     protected openOrdersOnOrderBook(traderAddr: string, orderBookContract: ethers.Contract): Promise<Order[]>;
     /**
@@ -33,6 +44,7 @@ export default class MarketData extends PerpetualDataHandler {
      * @param traderAddr address of the trader
      * @param orderBookContract instance of order book contract
      * @returns array of order-id's
+     * @ignore
      */
     protected orderIdsOfTrader(traderAddr: string, orderBookContract: ethers.Contract): Promise<string[]>;
     static _exchangeInfo(_proxyContract: ethers.Contract): Promise<ExchangeInfo>;

package/dist/marketData.js

@@ -31,6 +31,10 @@ class MarketData extends perpetualDataHandler_1.default {
             yield this.initContractsAndData(this.provider);
         });
     }
+    /**
+     * Information about the products traded in the exchange.
+     * @returns {ExchangeInfo} Array of static data for all the pools and perpetuals in the system.
+     */
     exchangeInfo() {
         return __awaiter(this, void 0, void 0, function* () {
             if (this.proxyContract == null) {
@@ -40,10 +44,10 @@ class MarketData extends perpetualDataHandler_1.default {
         });
     }
     /**
-     * Get all open orders for a trader-address and a symbol
-     * @param traderAddr address of the trader for which we get the open order
-     * @param symbol symbol of the form ETH-USD-MATIC
-     * @returns array of open orders and corresponding order-ids
+     * All open orders for a trader-address and a symbol.
+     * @param {string} traderAddr Address of the trader for which we get the open orders.
+     * @param {string} symbol Symbol of the form ETH-USD-MATIC.
+     * @returns {Array<Array<Order>, Array<string>>} Array of open orders and corresponding order-ids.
      */
     openOrders(traderAddr, symbol) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -56,6 +60,12 @@ class MarketData extends perpetualDataHandler_1.default {
             return { orders: orders, orderIds: digests };
         });
     }
+    /**
+     * Information about the position open by a given trader in a given perpetual contract.
+     * @param {string} traderAddr Address of the trader for which we get the position risk.
+     * @param {string} symbol Symbol of the form ETH-USD-MATIC.
+     * @returns {MarginAccount}
+     */
     positionRisk(traderAddr, symbol) {
         return __awaiter(this, void 0, void 0, function* () {
             if (this.proxyContract == null) {
@@ -66,10 +76,11 @@ class MarketData extends perpetualDataHandler_1.default {
         });
     }
     /**
-     * Query smart contract to get user orders and convert to user friendly order format
-     * @param traderAddr address of trader
-     * @param orderBookContract instance of order book
-     * @returns array of user friendly order struct
+     * Query smart contract to get user orders and convert to user friendly order format.
+     * @param {string} traderAddr Address of trader.
+     * @param {ethers.Contract} orderBookContract Instance of order book.
+     * @returns {Order[]} Array of user friendly order struct.
+     * @ignore
      */
     openOrdersOnOrderBook(traderAddr, orderBookContract) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -89,6 +100,7 @@ class MarketData extends perpetualDataHandler_1.default {
      * @param traderAddr address of the trader
      * @param orderBookContract instance of order book contract
      * @returns array of order-id's
+     * @ignore
      */
     orderIdsOfTrader(traderAddr, orderBookContract) {
         return __awaiter(this, void 0, void 0, function* () {

package/dist/orderReferrerTool.d.ts

@@ -1,14 +1,33 @@
 import WriteAccessHandler from "./writeAccessHandler";
-import { NodeSDKConfig } from "./nodeSDKTypes";
+import { NodeSDKConfig, Order } from "./nodeSDKTypes";
+import { ethers } from "ethers";
 /**
- * OrderReferrerTool
- * Methods to refer orders from the limit order book
+ * Methods to execute existing orders from the limit order book.
  */
 export default class OrderReferrerTool extends WriteAccessHandler {
     /**
-     * Constructor
-     * @param config configuration
-     * @param privateKey private key of account that trades
+     * Constructor.
+     * @param {NodeSDKConfig} config Configuration object.
+     * @param {string} privateKey Private key of the wallet that executes the conditional orders.
      */
     constructor(config: NodeSDKConfig, privateKey: string);
+    /**
+     * Executes an order by symbol and ID. This action interacts with the blockchain and incurs in gas costs.
+     * @param {string} symbol Symbol of the form ETH-USD-MATIC.
+     * @param {string} orderId ID of the order to be executed.
+     * @param {string=} referrerAddr Address of the wallet to be credited for executing the order,
+     * if different from the one submitting this transaction.
+     * @returns Transaction object.
+     */
+    executeOrder(symbol: string, orderId: string, referrerAddr?: string): Promise<ethers.providers.TransactionResponse>;
+    /**
+     * Get a list of active conditional orders in the order book.
+     * This a read-only action and does not incur in gas costs.
+     * @param {string} symbol Symbol of the form ETH-USD-MATIC.
+     * @param {number} numElements Maximum number of orders to poll.
+     * @param {string} startAfter Optional order ID from where to start polling. Defaults to the first order.
+     * @returns Array of orders and corresponding order IDs
+     */
+    pollLimitOrders(symbol: string, numElements: number, startAfter?: string): Promise<[Order[], string[]]>;
+    isTradeable(order: Order): Promise<boolean>;
 }

package/dist/orderReferrerTool.js

@@ -1,21 +1,110 @@
 "use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const writeAccessHandler_1 = __importDefault(require("./writeAccessHandler"));
+const nodeSDKTypes_1 = require("./nodeSDKTypes");
 /**
- * OrderReferrerTool
- * Methods to refer orders from the limit order book
+ * Methods to execute existing orders from the limit order book.
  */
 class OrderReferrerTool extends writeAccessHandler_1.default {
     /**
-     * Constructor
-     * @param config configuration
-     * @param privateKey private key of account that trades
+     * Constructor.
+     * @param {NodeSDKConfig} config Configuration object.
+     * @param {string} privateKey Private key of the wallet that executes the conditional orders.
      */
     constructor(config, privateKey) {
         super(config, privateKey);
     }
+    /**
+     * Executes an order by symbol and ID. This action interacts with the blockchain and incurs in gas costs.
+     * @param {string} symbol Symbol of the form ETH-USD-MATIC.
+     * @param {string} orderId ID of the order to be executed.
+     * @param {string=} referrerAddr Address of the wallet to be credited for executing the order,
+     * if different from the one submitting this transaction.
+     * @returns Transaction object.
+     */
+    executeOrder(symbol, orderId, referrerAddr) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.proxyContract == null || this.signer == null) {
+                throw Error("no proxy contract or wallet initialized. Use createProxyInstance().");
+            }
+            const orderBookSC = this.getOrderBookContract(symbol);
+            if (typeof referrerAddr == "undefined") {
+                referrerAddr = this.traderAddr;
+            }
+            return yield orderBookSC.executeLimitOrderByDigest(orderId, referrerAddr);
+        });
+    }
+    /**
+     * Get a list of active conditional orders in the order book.
+     * This a read-only action and does not incur in gas costs.
+     * @param {string} symbol Symbol of the form ETH-USD-MATIC.
+     * @param {number} numElements Maximum number of orders to poll.
+     * @param {string} startAfter Optional order ID from where to start polling. Defaults to the first order.
+     * @returns Array of orders and corresponding order IDs
+     */
+    pollLimitOrders(symbol, numElements, startAfter) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.proxyContract == null) {
+                throw Error("no proxy contract initialized. Use createProxyInstance().");
+            }
+            if (typeof startAfter == "undefined") {
+                startAfter = nodeSDKTypes_1.ZERO_ADDRESS;
+            }
+            const orderBookSC = this.getOrderBookContract(symbol);
+            let [orders, orderIds] = yield orderBookSC.pollLimitOrders(startAfter, numElements);
+            let userFriendlyOrders = new Array();
+            let k = 0;
+            while (k < orders.length && orders[k].traderAddr != nodeSDKTypes_1.ZERO_ADDRESS) {
+                userFriendlyOrders.push(writeAccessHandler_1.default.fromSmartContractOrder(orders[k], this.symbolToPerpStaticInfo));
+                k++;
+            }
+            return [userFriendlyOrders, orderIds];
+        });
+    }
+    isTradeable(order) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.proxyContract == null) {
+                throw Error("no proxy contract initialized. Use createProxyInstance().");
+            }
+            if (order.limitPrice == undefined) {
+                throw Error("order does not have a limit price");
+            }
+            // check expiration date
+            if (order.deadline != undefined && order.deadline < Date.now()) {
+                return false;
+            }
+            // check limit price
+            let orderPrice = yield writeAccessHandler_1.default._queryPerpetualPrice(order.symbol, order.quantity, this.symbolToPerpStaticInfo, this.proxyContract);
+            if ((order.side == nodeSDKTypes_1.BUY_SIDE && orderPrice > order.limitPrice) ||
+                (order.side == nodeSDKTypes_1.SELL_SIDE && orderPrice < order.limitPrice)) {
+                return false;
+            }
+            // do we need to check trigger/stop?
+            if (order.stopPrice == undefined) {
+                // nothing to check, order is tradeable
+                return true;
+            }
+            // we need the mark price to check
+            let markPrice = yield writeAccessHandler_1.default._queryPerpetualMarkPrice(order.symbol, this.symbolToPerpStaticInfo, this.proxyContract);
+            if ((order.side == nodeSDKTypes_1.BUY_SIDE && markPrice < order.stopPrice) ||
+                (order.side == nodeSDKTypes_1.SELL_SIDE && markPrice > order.stopPrice)) {
+                return false;
+            }
+            // all checks passed -> order is tradeable
+            return true;
+        });
+    }
 }
 exports.default = OrderReferrerTool;

package/dist/perpetualDataHandler.d.ts

@@ -39,6 +39,8 @@ export default class PerpetualDataHandler {
     protected static _getPoolIdFromSymbol(symbol: string, staticInfos: PoolStaticInfo[]): number;
     static getNestedPerpetualIds(_proxyContract: ethers.Contract): Promise<number[][]>;
     static getMarginAccount(traderAddr: string, symbol: string, symbolToPerpStaticInfo: Map<string, PerpetualStaticInfo>, _proxyContract: ethers.Contract): Promise<MarginAccount>;
+    protected static _queryPerpetualPrice(symbol: string, tradeAmount: number, symbolToPerpStaticInfo: Map<string, PerpetualStaticInfo>, _proxyContract: ethers.Contract): Promise<number>;
+    protected static _queryPerpetualMarkPrice(symbol: string, symbolToPerpStaticInfo: Map<string, PerpetualStaticInfo>, _proxyContract: ethers.Contract): Promise<number>;
     /**
      * Liquidation price
      * @param cleanSymbol symbol after calling symbolToBytes4Symbol

package/dist/perpetualDataHandler.js

@@ -218,6 +218,20 @@ class PerpetualDataHandler {
             return mgn;
         });
     }
+    static _queryPerpetualPrice(symbol, tradeAmount, symbolToPerpStaticInfo, _proxyContract) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let perpId = PerpetualDataHandler.symbolToPerpetualId(symbol, symbolToPerpStaticInfo);
+            let fPrice = yield _proxyContract.queryPerpetualPrice(perpId, (0, d8XMath_1.floatToABK64x64)(tradeAmount));
+            return (0, d8XMath_1.ABK64x64ToFloat)(fPrice);
+        });
+    }
+    static _queryPerpetualMarkPrice(symbol, symbolToPerpStaticInfo, _proxyContract) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let perpId = PerpetualDataHandler.symbolToPerpetualId(symbol, symbolToPerpStaticInfo);
+            let ammState = yield _proxyContract.getAMMState(perpId);
+            return (0, d8XMath_1.ABK64x64ToFloat)(ammState[6].mul(nodeSDKTypes_1.ONE_64x64.add(ammState[8])));
+        });
+    }
     /**
      * Liquidation price
      * @param cleanSymbol symbol after calling symbolToBytes4Symbol

package/dist/utils.d.ts

@@ -2,8 +2,8 @@
 import { BigNumber } from "ethers";
 /**
  *
- * @param   s string to shorten/extend to 4 characters
- * @returns string with 4 characters (or characters + null chars)
+ * @param {string} s String to shorten/extend to 4 characters
+ * @returns {string} String with 4 characters (or characters + null chars)
  */
 export declare function to4Chars(s: string): string;
 /**
@@ -12,23 +12,23 @@ export declare function to4Chars(s: string): string;
  * 4 characters.
  * Resulting buffer can be used with smart contract to
  * identify tokens (BTC, USDC, MATIC etc.)
- * @param s string to encode into bytes4
- * @returns buffer
+ * @param {string} s String to encode into bytes4
+ * @returns {Buffer} 4-character bytes4.
  */
 export declare function toBytes4(s: string): Buffer;
 /**
  * Decodes a buffer encoded with toBytes4 into
  * a string. The string is the result of to4Chars of the
  * originally encoded string stripped from null-chars
- * @param b correctly encoded bytes4 buffer using toBytes4
- * @returns string decoded into to4Chars-type string without null characters
+ * @param {Buffer} b Correctly encoded bytes4 buffer using toBytes4
+ * @returns {string} String decoded into to4Chars-type string without null characters
  */
 export declare function fromBytes4(b: Buffer): string;
 /**
  * Decodes the bytes4 encoded string received from the
  * smart contract as a hex-number in string-format
- * @param s string representing a hex-number ("0x...")
- * @returns x of to4Chars(x) stripped from null-chars,
+ * @param {string} s string representing a hex-number ("0x...")
+ * @returns {string} x of to4Chars(x) stripped from null-chars,
  * where x was originally encoded and
  * returned by the smart contract as bytes4
  */

package/dist/utils.js

@@ -2,15 +2,17 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.containsFlag = exports.combineFlags = exports.fromBytes4HexString = exports.fromBytes4 = exports.toBytes4 = exports.to4Chars = void 0;
 const ethers_1 = require("ethers");
-const ethers = require("ethers");
+/**
+ * @module utils
+ */
 function _isVocal(char) {
     char = char.toLowerCase();
     return char == "a" || char == "e" || char == "i" || char == "o" || char == "u";
 }
 /**
  *
- * @param   s string to shorten/extend to 4 characters
- * @returns string with 4 characters (or characters + null chars)
+ * @param {string} s String to shorten/extend to 4 characters
+ * @returns {string} String with 4 characters (or characters + null chars)
  */
 function to4Chars(s) {
     while (s.length < 4) {
@@ -35,8 +37,8 @@ exports.to4Chars = to4Chars;
  * 4 characters.
  * Resulting buffer can be used with smart contract to
  * identify tokens (BTC, USDC, MATIC etc.)
- * @param s string to encode into bytes4
- * @returns buffer
+ * @param {string} s String to encode into bytes4
+ * @returns {Buffer} 4-character bytes4.
  */
 function toBytes4(s) {
     s = to4Chars(s);
@@ -48,8 +50,8 @@ exports.toBytes4 = toBytes4;
  * Decodes a buffer encoded with toBytes4 into
  * a string. The string is the result of to4Chars of the
  * originally encoded string stripped from null-chars
- * @param b correctly encoded bytes4 buffer using toBytes4
- * @returns string decoded into to4Chars-type string without null characters
+ * @param {Buffer} b Correctly encoded bytes4 buffer using toBytes4
+ * @returns {string} String decoded into to4Chars-type string without null characters
  */
 function fromBytes4(b) {
     let val = b.toString("ascii");
@@ -60,8 +62,8 @@ exports.fromBytes4 = fromBytes4;
 /**
  * Decodes the bytes4 encoded string received from the
  * smart contract as a hex-number in string-format
- * @param s string representing a hex-number ("0x...")
- * @returns x of to4Chars(x) stripped from null-chars,
+ * @param {string} s string representing a hex-number ("0x...")
+ * @returns {string} x of to4Chars(x) stripped from null-chars,
  * where x was originally encoded and
  * returned by the smart contract as bytes4
  */

package/package.json

@@ -12,7 +12,7 @@
   },
   "scripts": {
     "build": "tsc",
-    "build:doc": "jsdoc2md --files ./src/accountTrade.ts --configure ./jsdoc2md.json > ./doc/accountTrade.md",
+    "build:doc": "jsdoc2md --files ./src/accountTrade.ts --configure ./jsdoc2md.json > ./doc/accountTrade.md && jsdoc2md --files ./src/marketData.ts --configure ./jsdoc2md.json > ./doc/marketData.md && jsdoc2md --files ./src/liquidatorTool.ts --configure ./jsdoc2md.json > ./doc/liquidatorTool.md && jsdoc2md --files ./src/liquidityProviderTool.ts --configure ./jsdoc2md.json > ./doc/liquidityProviderTool.md && jsdoc2md --files ./src/brokerTool.ts --configure ./jsdoc2md.json > ./doc/brokerTool.md && jsdoc2md --files ./src/orderReferrerTool.ts --configure ./jsdoc2md.json > ./doc/orderReferrerTool.md",
     "test": "jest",
     "coverage": "nyc -r lcov -e .ts -x \"*.test.ts\" npm run test"
   },
@@ -27,7 +27,7 @@
   },
   "name": "@d8x/perpetuals-sdk",
   "description": "Node TypeScript SDK for D8X Perpetual Futures",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "directories": {