@d8x/perpetuals-sdk

<a name="PerpetualDataHandler"></a> ## PerpetualDataHandler Parent class for MarketData and WriteAccessHandler that handles common data and chain operations. **Kind**: global class * [PerpetualDataHandler](#PerpetualDataHandler) * [new PerpetualDataHandler(config)](#new_PerpetualDataHandler_new) * _instance_ * [.fetchSymbolList()](#PerpetualDataHandler+fetchSymbolList) * [.getOrderBookContract(symbol)](#PerpetualDataHandler+getOrderBookContract) ⇒ * [.getOrderBookAddress(symbol)](#PerpetualDataHandler+getOrderBookAddress) ⇒ * [.getPerpetuals(ids, overrides)](#PerpetualDataHandler+getPerpetuals) ⇒ * [.getLiquidityPools(fromIdx, toIdx, overrides)](#PerpetualDataHandler+getLiquidityPools) ⇒ * [._fillSymbolMaps()](#PerpetualDataHandler+_fillSymbolMaps) * [.initSettlementToken(perpStaticInfos)](#PerpetualDataHandler+initSettlementToken) * [.getSymbolFromPoolId(poolId)](#PerpetualDataHandler+getSymbolFromPoolId) ⇒ <code>symbol</code> * [.getPoolIdFromSymbol(symbol)](#PerpetualDataHandler+getPoolIdFromSymbol) ⇒ <code>number</code> * [.getPerpIdFromSymbol(symbol)](#PerpetualDataHandler+getPerpIdFromSymbol) ⇒ <code>number</code> * [.getSymbolFromPerpId(perpId)](#PerpetualDataHandler+getSymbolFromPerpId) ⇒ <code>string</code> * [.symbol4BToLongSymbol(sym)](#PerpetualDataHandler+symbol4BToLongSymbol) ⇒ <code>string</code> * [.fetchPriceSubmissionInfoForPerpetual(symbol)](#PerpetualDataHandler+fetchPriceSubmissionInfoForPerpetual) ⇒ * [.getIndexSymbols(symbol)](#PerpetualDataHandler+getIndexSymbols) ⇒ * [.fetchLatestFeedPriceInfo(symbol)](#PerpetualDataHandler+fetchLatestFeedPriceInfo) ⇒ * [.fetchCollateralToSettlementConversion(symbol)](#PerpetualDataHandler+fetchCollateralToSettlementConversion) * [.getPriceIds(symbol)](#PerpetualDataHandler+getPriceIds) ⇒ * [.getPerpetualSymbolsInPool(poolSymbol)](#PerpetualDataHandler+getPerpetualSymbolsInPool) ⇒ * [.getAllOpenOrders(symbol)](#PerpetualDataHandler+getAllOpenOrders) ⇒ * [.numberOfOpenOrders(symbol)](#PerpetualDataHandler+numberOfOpenOrders) ⇒ <code>number</code> * [.pollLimitOrders(symbol, numElements, [startAfter])](#PerpetualDataHandler+pollLimitOrders) ⇒ * [.getPoolStaticInfoIndexFromSymbol(symbol)](#PerpetualDataHandler+getPoolStaticInfoIndexFromSymbol) ⇒ * [.getMarginTokenFromSymbol(symbol)](#PerpetualDataHandler+getMarginTokenFromSymbol) ⇒ * [.getSettlementTokenFromSymbol(symbol)](#PerpetualDataHandler+getSettlementTokenFromSymbol) ⇒ * [.getMarginTokenDecimalsFromSymbol(symbol)](#PerpetualDataHandler+getMarginTokenDecimalsFromSymbol) ⇒ * [.getSettlementTokenDecimalsFromSymbol(symbol)](#PerpetualDataHandler+getSettlementTokenDecimalsFromSymbol) ⇒ * [.getABI(contract)](#PerpetualDataHandler+getABI) ⇒ * [.isPredictionMarket(symbol)](#PerpetualDataHandler+isPredictionMarket) ⇒ * [.isLowLiquidityMarket(symbol)](#PerpetualDataHandler+isLowLiquidityMarket) ⇒ * [.isTradFiMarket(symbol)](#PerpetualDataHandler+isTradFiMarket) ⇒ * [.getMarketDayTradingOpenCloseSec(symbol)](#PerpetualDataHandler+getMarketDayTradingOpenCloseSec) ⇒ * [.getInitialMarginRate(symbol)](#PerpetualDataHandler+getInitialMarginRate) ⇒ * [.getMaintenanceMarginRate(symbol)](#PerpetualDataHandler+getMaintenanceMarginRate) ⇒ * _static_ * [.getPerpetualStaticInfo(_proxyContract, nestedPerpetualIDs, symbolList)](#PerpetualDataHandler.getPerpetualStaticInfo) ⇒ * [.nestedIDsToChunks(chunkSize, nestedIDs)](#PerpetualDataHandler.nestedIDsToChunks) ⇒ <code>Array.<Array.<number>></code> * [._getLiquidityPools(ids, _proxyContract, _symbolList, overrides)](#PerpetualDataHandler._getLiquidityPools) ⇒ * [._getPerpetuals(ids, _proxyContract, _symbolList, overrides)](#PerpetualDataHandler._getPerpetuals) ⇒ * [.getMarginAccount(traderAddr, symbol, symbolToPerpStaticInfo, _proxyContract, _pxInfo, overrides)](#PerpetualDataHandler.getMarginAccount) ⇒ * [.getMarginAccounts(traderAddrs, symbols, symbolToPerpStaticInfo, _multicall, _proxyContract, _pxInfo, overrides)](#PerpetualDataHandler.getMarginAccounts) ⇒ * [._queryPerpetualMarkPrice(symbol, symbolToPerpStaticInfo, _proxyContract, indexPrices, isPredMkt, overrides)](#PerpetualDataHandler._queryPerpetualMarkPrice) ⇒ * [._oiAndAmmPosToLongShort(oi, ammPos)](#PerpetualDataHandler._oiAndAmmPosToLongShort) ⇒ * [._calculateLiquidationPrice(symbol, traderState, S2, symbolToPerpStaticInfo)](#PerpetualDataHandler._calculateLiquidationPrice) ⇒ * [.symbolToPerpetualId(symbol, symbolToPerpStaticInfo)](#PerpetualDataHandler.symbolToPerpetualId) ⇒ * [.toSmartContractOrder(order, traderAddr, symbolToPerpetualMap)](#PerpetualDataHandler.toSmartContractOrder) ⇒ * [.fromSmartContratOrderToClientOrder(scOrder, parentChildIds)](#PerpetualDataHandler.fromSmartContratOrderToClientOrder) ⇒ * [.toClientOrder(order, parentChildIds)](#PerpetualDataHandler.toClientOrder) ⇒ * [.fromClientOrder(obOrder)](#PerpetualDataHandler.fromClientOrder) ⇒ * [._orderTypeToFlag(order)](#PerpetualDataHandler._orderTypeToFlag) ⇒ * [.readSDKConfig(configNameOrfileLocation, version)](#PerpetualDataHandler.readSDKConfig) ⇒ * [.getConfigByName(name, version)](#PerpetualDataHandler.getConfigByName) ⇒ * [.getConfigByLocation(filename, version)](#PerpetualDataHandler.getConfigByLocation) ⇒ * [.getConfigByChainId(chainId, version)](#PerpetualDataHandler.getConfigByChainId) ⇒ * [.getAvailableConfigs()](#PerpetualDataHandler.getAvailableConfigs) ⇒ * [._getABIFromContract(contract, functionName)](#PerpetualDataHandler._getABIFromContract) ⇒ * [.checkOrder(order, traderAccount, perpStaticInfo)](#PerpetualDataHandler.checkOrder) * [.fromClientOrderToTypeSafeOrder(order)](#PerpetualDataHandler.fromClientOrderToTypeSafeOrder) ⇒ * [.isTradFiMarketStatic(staticInfo)](#PerpetualDataHandler.isTradFiMarketStatic) ⇒ * [.isPredictionMarketStatic(staticInfo)](#PerpetualDataHandler.isPredictionMarketStatic) ⇒ * [.getInitialMarginRate(staticInfo)](#PerpetualDataHandler.getInitialMarginRate) ⇒ * [.getMaintenanceMarginRate(staticInfo)](#PerpetualDataHandler.getMaintenanceMarginRate) ⇒ * [.isMarketDayTime(fAMMTargetDD)](#PerpetualDataHandler.isMarketDayTime) ⇒ <a name="new_PerpetualDataHandler_new"></a> ### new PerpetualDataHandler(config) Constructor | Param | Type | Description | | --- | --- | --- | | config | <code>NodeSDKConfig</code> | Configuration object, see PerpetualDataHandler.readSDKConfig. | <a name="PerpetualDataHandler+fetchSymbolList"></a> ### perpetualDataHandler.fetchSymbolList() sets the symbollist if a remote config url is specified **Kind**: instance method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler) <a name="PerpetualDataHandler+getOrderBookContract"></a> ### perpetualDataHandler.getOrderBookContract(symbol) ⇒ Returns the order-book contract for the symbol if found or fails **Kind**: instance method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler) **Returns**: order book contract for the perpetual | Param | Description | | --- | --- | | symbol | symbol of the form ETH-USD-MATIC | <a name="PerpetualDataHandler+getOrderBookAddress"></a> ### perpetualDataHandler.getOrderBookAddress(symbol) ⇒ Returns the order-book contract for the symbol if found or fails **Kind**: instance method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler) **Returns**: order book contract for the perpetual | Param | Description | | --- | --- | | symbol | symbol of the form ETH-USD-MATIC | <a name="PerpetualDataHandler+getPerpetuals"></a> ### perpetualDataHandler.getPerpetuals(ids, overrides) ⇒ Get perpetuals for the given ids from onchain **Kind**: instance method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler) **Returns**: array of PerpetualData converted into decimals | Param | Description | | --- | --- | | ids | perpetual ids | | overrides | optional | <a name="PerpetualDataHandler+getLiquidityPools"></a> ### perpetualDataHandler.getLiquidityPools(fromIdx, toIdx, overrides) ⇒ Get liquidity pools data **Kind**: instance method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler) **Returns**: array of LiquidityPoolData converted into decimals | Param | Description | | --- | --- | | fromIdx | starting index (>=1) | | toIdx | to index (inclusive) | | overrides | optional | <a name="PerpetualDataHandler+_fillSymbolMaps"></a> ### perpetualDataHandler.\_fillSymbolMaps() Called when initializing. This function fills this.symbolToTokenAddrMap, and this.nestedPerpetualIDs and this.symbolToPerpStaticInfo **Kind**: instance method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler) <a name="PerpetualDataHandler+initSettlementToken"></a> ### perpetualDataHandler.initSettlementToken(perpStaticInfos) Initializes settlement currency for all pools by completing this.poolStaticInfos with settlement currency info **Kind**: instance method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler) | Param | Description | | --- | --- | | perpStaticInfos | PerpetualStaticInfo array from contract call | <a name="PerpetualDataHandler+getSymbolFromPoolId"></a> ### perpetualDataHandler.getSymbolFromPoolId(poolId) ⇒ <code>symbol</code> Get pool symbol given a pool Id. **Kind**: instance method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler) **Returns**: <code>symbol</code> - Pool symbol, e.g. "USDC". | Param | Type | Description | | --- | --- | --- | | poolId | <code>number</code> | Pool Id. | <a name="PerpetualDataHandler+getPoolIdFromSymbol"></a> ### perpetualDataHandler.getPoolIdFromSymbol(symbol) ⇒ <code>number</code> Get pool Id given a pool symbol. Pool IDs start at 1. **Kind**: instance method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler) **Returns**: <code>number</code> - Pool Id. | Param | Type | Description | | --- | --- | --- | | symbol | <code>string</code> | Pool symbol. | <a name="PerpetualDataHandler+getPerpIdFromSymbol"></a> ### perpetualDataHandler.getPerpIdFromSymbol(symbol) ⇒ <code>number</code> Get perpetual Id given a perpetual symbol. **Kind**: instance method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler) **Returns**: <code>number</code> - Perpetual Id. | Param | Type | Description | | --- | --- | --- | | symbol | <code>string</code> | Perpetual symbol, e.g. "BTC-USD-MATIC". | <a name="PerpetualDataHandler+getSymbolFromPerpId"></a> ### perpetualDataHandler.getSymbolFromPerpId(perpId) ⇒ <code>string</code> Get the symbol in long format of the perpetual id **Kind**: instance method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler) **Returns**: <code>string</code> - Symbol | Param | Type | Description | | --- | --- | --- | | perpId | <code>number</code> | perpetual id | <a name="PerpetualDataHandler+symbol4BToLongSymbol"></a> ### perpetualDataHandler.symbol4BToLongSymbol(sym) ⇒ <code>string</code> **Kind**: instance method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler) **Returns**: <code>string</code> - Long symbol | Param | Type | Description | | --- | --- | --- | | sym | <code>string</code> | Short symbol | <a name="PerpetualDataHandler+fetchPriceSubmissionInfoForPerpetual"></a> ### perpetualDataHandler.fetchPriceSubmissionInfoForPerpetual(symbol) ⇒ Get PriceFeedSubmission data required for blockchain queries that involve price data, and the corresponding triangulated prices for the indices S2 and S3 **Kind**: instance method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler) **Returns**: PriceFeedSubmission and prices for S2 and S3. [S2price, 0] if S3 not defined. | Param | Description | | --- | --- | | symbol | pool symbol of the form "ETH-USD-MATIC" | <a name="PerpetualDataHandler+getIndexSymbols"></a> ### perpetualDataHandler.getIndexSymbols(symbol) ⇒ Get the symbols required as indices for the given perpetual **Kind**: instance method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler) **Returns**: name of underlying index prices, e.g. ["MATIC-USD", ""] | Param | Description | | --- | --- | | symbol | of the form ETH-USD-MATIC, specifying the perpetual | <a name="PerpetualDataHandler+fetchLatestFeedPriceInfo"></a> ### perpetualDataHandler.fetchLatestFeedPriceInfo(symbol) ⇒ Get the latest prices for a given perpetual from the offchain oracle networks **Kind**: instance method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler) **Returns**: array of price feed updates that can be submitted to the smart contract and corresponding price information | Param | Description | | --- | --- | | symbol | perpetual symbol of the form BTC-USD-MATIC | <a name="PerpetualDataHandler+fetchCollateralToSettlementConversion"></a> ### perpetualDataHandler.fetchCollateralToSettlementConversion(symbol) fetchCollateralToSettlementConversion returns the price which converts the collateral currency into settlement currency. For example if BTC-USD-STUSD has settlement currency USDC, we get let px = fetchCollateralToSettlementConversion("BTC-USD-STUSD") valueInUSDC = collateralInSTUSD * px **Kind**: instance method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler) | Param | Description | | --- | --- | | symbol | either perpetual symbol of the form BTC-USD-MATIC or just collateral token | <a name="PerpetualDataHandler+getPriceIds"></a> ### perpetualDataHandler.getPriceIds(symbol) ⇒ Get list of required pyth price source IDs for given perpetual **Kind**: instance method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler) **Returns**: list of required pyth price sources for this perpetual | Param | Description | | --- | --- | | symbol | perpetual symbol, e.g., BTC-USD-MATIC | <a name="PerpetualDataHandler+getPerpetualSymbolsInPool"></a> ### perpetualDataHandler.getPerpetualSymbolsInPool(poolSymbol) ⇒ Get ('normal'-state) perpetual symbols for a given pool **Kind**: instance method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler) **Returns**: array of perpetual symbols in this pool | Param | Description | | --- | --- | | poolSymbol | pool symbol such as "MATIC" | <a name="PerpetualDataHandler+getAllOpenOrders"></a> ### perpetualDataHandler.getAllOpenOrders(symbol) ⇒ All the orders in the order book for a given symbol that are currently open. **Kind**: instance method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler) **Returns**: Array with all open orders and their IDs. | Param | Type | Description | | --- | --- | --- | | symbol | <code>string</code> | Symbol of the form ETH-USD-MATIC. | **Example** ```js import { OrderExecutorTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk'; async function main() { console.log(OrderExecutorTool); // setup (authentication required, PK is an environment variable with a private key) const config = PerpetualDataHandler.readSDKConfig("cardona"); const pk: string = <string>process.env.PK; let orderTool = new OrderExecutorTool(config, pk); await orderTool.createProxyInstance(); // get all open orders let openOrders = await orderTool.getAllOpenOrders("ETH-USD-MATIC"); console.log(openOrders); } main(); ``` <a name="PerpetualDataHandler+numberOfOpenOrders"></a> ### perpetualDataHandler.numberOfOpenOrders(symbol) ⇒ <code>number</code> Total number of limit orders for this symbol, excluding those that have been cancelled/removed. **Kind**: instance method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler) **Returns**: <code>number</code> - Number of open orders. | Param | Type | Description | | --- | --- | --- | | symbol | <code>string</code> | Symbol of the form ETH-USD-MATIC. | **Example** ```js import { OrderExecutorTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk'; async function main() { console.log(OrderExecutorTool); // setup (authentication required, PK is an environment variable with a private key) const config = PerpetualDataHandler.readSDKConfig("cardona"); const pk: string = <string>process.env.PK; let orderTool = new OrderExecutorTool(config, pk); await orderTool.createProxyInstance(); // get all open orders let numberOfOrders = await orderTool.numberOfOpenOrders("ETH-USD-MATIC"); console.log(numberOfOrders); } main(); ``` <a name="PerpetualDataHandler+pollLimitOrders"></a> ### perpetualDataHandler.pollLimitOrders(symbol, numElements, [startAfter]) ⇒ Get a list of active conditional orders in the order book. This a read-only action and does not incur in gas costs. **Kind**: instance method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler) **Returns**: Array of orders and corresponding order IDs | Param | Type | Description | | --- | --- | --- | | symbol | <code>string</code> | Symbol of the form ETH-USD-MATIC. | | numElements | <code>number</code> | Maximum number of orders to poll. | | [startAfter] | <code>string</code> | Optional order ID from where to start polling. Defaults to the first order. | **Example** ```js import { OrderExecutorTool, PerpetualDataHandler } from '@d8x/perpetuals-sdk'; async function main() { console.log(OrderExecutorTool); // setup (authentication required, PK is an environment variable with a private key) const config = PerpetualDataHandler.readSDKConfig("cardona"); const pk: string = <string>process.env.PK; let orderTool = new OrderExecutorTool(config, pk); await orderTool.createProxyInstance(); // get all open orders let activeOrders = await orderTool.pollLimitOrders("ETH-USD-MATIC", 2); console.log(activeOrders); } main(); ``` <a name="PerpetualDataHandler+getPoolStaticInfoIndexFromSymbol"></a> ### perpetualDataHandler.getPoolStaticInfoIndexFromSymbol(symbol) ⇒ Gets the pool index (starting at 0 in exchangeInfo, not ID!) corresponding to a given symbol. **Kind**: instance method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler) **Returns**: Pool index | Param | Description | | --- | --- | | symbol | Symbol of the form ETH-USD-MATIC | <a name="PerpetualDataHandler+getMarginTokenFromSymbol"></a> ### perpetualDataHandler.getMarginTokenFromSymbol(symbol) ⇒ **Kind**: instance method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler) **Returns**: Address of the corresponding margin token | Param | Description | | --- | --- | | symbol | Symbol of the form USDC | <a name="PerpetualDataHandler+getSettlementTokenFromSymbol"></a> ### perpetualDataHandler.getSettlementTokenFromSymbol(symbol) ⇒ **Kind**: instance method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler) **Returns**: Address of the corresponding settlement token | Param | Description | | --- | --- | | symbol | Symbol of the form ETH-USD-WEETH | <a name="PerpetualDataHandler+getMarginTokenDecimalsFromSymbol"></a> ### perpetualDataHandler.getMarginTokenDecimalsFromSymbol(symbol) ⇒ **Kind**: instance method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler) **Returns**: Decimals of the corresponding margin token | Param | Description | | --- | --- | | symbol | Symbol of the form USDC | <a name="PerpetualDataHandler+getSettlementTokenDecimalsFromSymbol"></a> ### perpetualDataHandler.getSettlementTokenDecimalsFromSymbol(symbol) ⇒ **Kind**: instance method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler) **Returns**: Decimals of the corresponding settlement token | Param | Description | | --- | --- | | symbol | Symbol of the form ETH-USD-WEETH | <a name="PerpetualDataHandler+getABI"></a> ### perpetualDataHandler.getABI(contract) ⇒ Get ABI for LimitOrderBook, Proxy, or Share Pool Token **Kind**: instance method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler) **Returns**: ABI for the requested contract | Param | Description | | --- | --- | | contract | name of contract: proxy|lob|sharetoken | <a name="PerpetualDataHandler+isPredictionMarket"></a> ### perpetualDataHandler.isPredictionMarket(symbol) ⇒ Determines whether a given perpetual represents a prediction market **Kind**: instance method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler) **Returns**: True if this is a prediction market | Param | Description | | --- | --- | | symbol | perpetual symbol of the form TRUMP24-USD-USDC | <a name="PerpetualDataHandler+isLowLiquidityMarket"></a> ### perpetualDataHandler.isLowLiquidityMarket(symbol) ⇒ Determines whether a given perpetual represents a low-liquidity market **Kind**: instance method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler) **Returns**: True if this is a low-liquidity market | Param | Description | | --- | --- | | symbol | perpetual symbol of the form DIRAC-HONEY-USDC | <a name="PerpetualDataHandler+isTradFiMarket"></a> ### perpetualDataHandler.isTradFiMarket(symbol) ⇒ Determines whether a given perpetual represents a tradfi market **Kind**: instance method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler) **Returns**: True if this is a tradfi market | Param | Description | | --- | --- | | symbol | perpetual symbol of the form MSTR-HONEY-BUSD | <a name="PerpetualDataHandler+getMarketDayTradingOpenCloseSec"></a> ### perpetualDataHandler.getMarketDayTradingOpenCloseSec(symbol) ⇒ Returns day trading times for tradfi markets **Kind**: instance method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler) **Returns**: open time in seconds within day, close time in seconds within day | Param | Description | | --- | --- | | symbol | perpetual symbol of the form MSTR-HONEY-BUSD | <a name="PerpetualDataHandler+getInitialMarginRate"></a> ### perpetualDataHandler.getInitialMarginRate(symbol) ⇒ getInitialMarginRate **Kind**: instance method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler) **Returns**: initial margin rate | Param | Description | | --- | --- | | symbol | perpetual symbol MSTR-USD-BUSD | <a name="PerpetualDataHandler+getMaintenanceMarginRate"></a> ### perpetualDataHandler.getMaintenanceMarginRate(symbol) ⇒ getMaintenanceMarginRate **Kind**: instance method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler) **Returns**: maintenance margin rate | Param | Description | | --- | --- | | symbol | perpetual symbol MSTR-USD-BUSD | <a name="PerpetualDataHandler.getPerpetualStaticInfo"></a> ### PerpetualDataHandler.getPerpetualStaticInfo(_proxyContract, nestedPerpetualIDs, symbolList) ⇒ Collect all perpetuals static info **Kind**: static method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler) **Returns**: array with PerpetualStaticInfo for each perpetual | Param | Type | Description | | --- | --- | --- | | _proxyContract | <code>ethers.Contract</code> | perpetuals contract with getter | | nestedPerpetualIDs | <code>Array.<Array.<number>></code> | perpetual id-array for each pool | | symbolList | <code>Map.<string, string></code> | mapping of symbols to convert long-format <-> blockchain-format | <a name="PerpetualDataHandler.nestedIDsToChunks"></a> ### PerpetualDataHandler.nestedIDsToChunks(chunkSize, nestedIDs) ⇒ <code>Array.<Array.<number>></code> Breaks up an array of nested arrays into chunks of a specified size. **Kind**: static method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler) **Returns**: <code>Array.<Array.<number>></code> - An array of subarrays, each containing <code>chunkSize</code> or fewer elements from <code>nestedIDs</code>. | Param | Type | Description | | --- | --- | --- | | chunkSize | <code>number</code> | The size of each chunk. | | nestedIDs | <code>Array.<Array.<number>></code> | The array of nested arrays to chunk. | <a name="PerpetualDataHandler._getLiquidityPools"></a> ### PerpetualDataHandler.\_getLiquidityPools(ids, _proxyContract, _symbolList, overrides) ⇒ Query perpetuals **Kind**: static method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler) **Returns**: array of PerpetualData converted into decimals | Param | Description | | --- | --- | | ids | perpetual ids | | _proxyContract | proxy contract instance | | _symbolList | symbol mappings to convert the bytes encoded symbol name to string | | overrides | optional | <a name="PerpetualDataHandler._getPerpetuals"></a> ### PerpetualDataHandler.\_getPerpetuals(ids, _proxyContract, _symbolList, overrides) ⇒ Query perpetuals **Kind**: static method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler) **Returns**: array of PerpetualData converted into decimals | Param | Description | | --- | --- | | ids | perpetual ids | | _proxyContract | proxy contract instance | | _symbolList | symbol mappings to convert the bytes encoded symbol name to string | | overrides | optional | <a name="PerpetualDataHandler.getMarginAccount"></a> ### PerpetualDataHandler.getMarginAccount(traderAddr, symbol, symbolToPerpStaticInfo, _proxyContract, _pxInfo, overrides) ⇒ Get trader state from the blockchain and parse into a human-readable margin account **Kind**: static method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler) **Returns**: A Margin account | Param | Description | | --- | --- | | traderAddr | Trader address | | symbol | Perpetual symbol | | symbolToPerpStaticInfo | Symbol to perp static info mapping | | _proxyContract | Proxy contract instance | | _pxInfo | index price info | | overrides | Optional overrides for eth_call | <a name="PerpetualDataHandler.getMarginAccounts"></a> ### PerpetualDataHandler.getMarginAccounts(traderAddrs, symbols, symbolToPerpStaticInfo, _multicall, _proxyContract, _pxInfo, overrides) ⇒ Get trader states from the blockchain and parse into a list of human-readable margin accounts **Kind**: static method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler) **Returns**: List of margin accounts | Param | Description | | --- | --- | | traderAddrs | List of trader addresses | | symbols | List of symbols | | symbolToPerpStaticInfo | Symbol to perp static info mapping | | _multicall | Multicall3 contract instance | | _proxyContract | Proxy contract instance | | _pxInfo | List of price info | | overrides | Optional eth_call overrides | <a name="PerpetualDataHandler._queryPerpetualMarkPrice"></a> ### PerpetualDataHandler.\_queryPerpetualMarkPrice(symbol, symbolToPerpStaticInfo, _proxyContract, indexPrices, isPredMkt, overrides) ⇒ **Kind**: static method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler) **Returns**: mark price | Param | Description | | --- | --- | | symbol | perpetual symbol of the form BTC-USDC-USDC | | symbolToPerpStaticInfo | mapping | | _proxyContract | contract instance | | indexPrices | IdxPriceInfo | | isPredMkt | true if prediction market perpetual | | overrides | | <a name="PerpetualDataHandler._oiAndAmmPosToLongShort"></a> ### PerpetualDataHandler.\_oiAndAmmPosToLongShort(oi, ammPos) ⇒ Calculate long and short exposures from open interest and long/short **Kind**: static method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler) **Returns**: long, short exposure | Param | Description | | --- | --- | | oi | open interest | | ammPos | amm net exposure | <a name="PerpetualDataHandler._calculateLiquidationPrice"></a> ### PerpetualDataHandler.\_calculateLiquidationPrice(symbol, traderState, S2, symbolToPerpStaticInfo) ⇒ Liquidation price **Kind**: static method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler) **Returns**: liquidation mark-price, corresponding collateral/quote conversion | Param | Description | | --- | --- | | symbol | symbol of the form BTC-USD-MATIC | | traderState | BigInt array according to smart contract | | S2 | number, index price S2 | | symbolToPerpStaticInfo | mapping symbol->PerpStaticInfo | <a name="PerpetualDataHandler.symbolToPerpetualId"></a> ### PerpetualDataHandler.symbolToPerpetualId(symbol, symbolToPerpStaticInfo) ⇒ Finds the perpetual id for a symbol of the form <base>-<quote>-<collateral>. The function first converts the token names into bytes4 representation **Kind**: static method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler) **Returns**: perpetual id or it fails | Param | Description | | --- | --- | | symbol | symbol (e.g., BTC-USD-MATC) | | symbolToPerpStaticInfo | map that contains the bytes4-symbol to PerpetualStaticInfo including id mapping | <a name="PerpetualDataHandler.toSmartContractOrder"></a> ### PerpetualDataHandler.toSmartContractOrder(order, traderAddr, symbolToPerpetualMap) ⇒ Transform the convenient form of the order into a smart-contract accepted type of order **Kind**: static method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler) **Returns**: SmartContractOrder | Param | Description | | --- | --- | | order | order type | | traderAddr | address of the trader | | symbolToPerpetualMap | mapping of symbol to perpetual Id | <a name="PerpetualDataHandler.fromSmartContratOrderToClientOrder"></a> ### PerpetualDataHandler.fromSmartContratOrderToClientOrder(scOrder, parentChildIds) ⇒ Converts a smart contract order to a client order **Kind**: static method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler) **Returns**: Client order that can be submitted to the corresponding LOB | Param | Description | | --- | --- | | scOrder | Smart contract order | | parentChildIds | Optional parent-child dependency | <a name="PerpetualDataHandler.toClientOrder"></a> ### PerpetualDataHandler.toClientOrder(order, parentChildIds) ⇒ Converts a user-friendly order to a client order **Kind**: static method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler) **Returns**: Client order that can be submitted to the corresponding LOB | Param | Description | | --- | --- | | order | Order | | parentChildIds | Optional parent-child dependency | <a name="PerpetualDataHandler.fromClientOrder"></a> ### PerpetualDataHandler.fromClientOrder(obOrder) ⇒ Converts an order as stored in the LOB smart contract into a user-friendly order type **Kind**: static method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler) **Returns**: User friendly order struct | Param | Description | | --- | --- | | obOrder | Order-book contract order type | <a name="PerpetualDataHandler._orderTypeToFlag"></a> ### PerpetualDataHandler.\_orderTypeToFlag(order) ⇒ Determine the correct order flags based on the order-properties. Checks for some misspecifications. **Kind**: static method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler) **Returns**: BigNumber flags | Param | Description | | --- | --- | | order | order type | <a name="PerpetualDataHandler.readSDKConfig"></a> ### PerpetualDataHandler.readSDKConfig(configNameOrfileLocation, version) ⇒ Get NodeSDKConfig from a chain ID, known config name, or custom file location.. **Kind**: static method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler) **Returns**: NodeSDKConfig | Param | Description | | --- | --- | | configNameOrfileLocation | Name of a known default config, or chain ID, or json-file with required variables for config | | version | Config version number. Defaults to highest version if name or chain ID are not unique | <a name="PerpetualDataHandler.getConfigByName"></a> ### PerpetualDataHandler.getConfigByName(name, version) ⇒ Get a NodeSDKConfig from its name **Kind**: static method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler) **Returns**: NodeSDKConfig | Param | Description | | --- | --- | | name | Name of the known config | | version | Version of the config. Defaults to highest available. | <a name="PerpetualDataHandler.getConfigByLocation"></a> ### PerpetualDataHandler.getConfigByLocation(filename, version) ⇒ Get a NodeSDKConfig from a json file. **Kind**: static method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler) **Returns**: NodeSDKConfig | Param | Description | | --- | --- | | filename | Location of the file | | version | Version of the config. Defaults to highest available. | <a name="PerpetualDataHandler.getConfigByChainId"></a> ### PerpetualDataHandler.getConfigByChainId(chainId, version) ⇒ Get a NodeSDKConfig from its chain Id **Kind**: static method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler) **Returns**: NodeSDKConfig | Param | Description | | --- | --- | | chainId | Chain Id | | version | Version of the config. Defaults to highest available. | <a name="PerpetualDataHandler.getAvailableConfigs"></a> ### PerpetualDataHandler.getAvailableConfigs() ⇒ Get available configurations in a Set. You can use the output to determine the config file that you get via 'let config = PerpetualDataHandler.readSDKConfig(196);' **Kind**: static method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler) **Returns**: set of chain-ids and name separated by ; **Example** ```js import { PerpetualDataHandler } from '@d8x/perpetuals-sdk'; async function main() { const configs = PerpetualDataHandler.getAvailableConfigs(); console.log(configs); // output of the form: // Set(2) { '1101; zkevm', `196; xlayer'} } main(); ``` <a name="PerpetualDataHandler._getABIFromContract"></a> ### PerpetualDataHandler.\_getABIFromContract(contract, functionName) ⇒ Get the ABI of a function in a given contract. Undefined if it doesn't exist. **Kind**: static method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler) **Returns**: Function ABI as a single JSON string | Param | Description | | --- | --- | | contract | A contract instance, e.g. this.proxyContract | | functionName | Name of the function whose ABI we want | <a name="PerpetualDataHandler.checkOrder"></a> ### PerpetualDataHandler.checkOrder(order, traderAccount, perpStaticInfo) Performs basic validity checks on a given order **Kind**: static method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler) | Param | Description | | --- | --- | | order | Order struct | | traderAccount | Trader account | | perpStaticInfo | Symbol to perpetual info map | <a name="PerpetualDataHandler.fromClientOrderToTypeSafeOrder"></a> ### PerpetualDataHandler.fromClientOrderToTypeSafeOrder(order) ⇒ Converts a client order (with BigNumberish types) to a type-safe order (with number/bigint types) **Kind**: static method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler) **Returns**: Order that can be submitted to the corresponding LOB via ethers v6 or viem | Param | Description | | --- | --- | | order | Client order | <a name="PerpetualDataHandler.isTradFiMarketStatic"></a> ### PerpetualDataHandler.isTradFiMarketStatic(staticInfo) ⇒ Determines whether a given perpetual represents a tradfi market which has open/close times **Kind**: static method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler) **Returns**: True if perp has tradfi market flag set | Param | Description | | --- | --- | | staticInfo | Perpetual static info | <a name="PerpetualDataHandler.isPredictionMarketStatic"></a> ### PerpetualDataHandler.isPredictionMarketStatic(staticInfo) ⇒ Determines whether a given perpetual represents a prediction market **Kind**: static method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler) **Returns**: True if this is a prediction market | Param | Description | | --- | --- | | staticInfo | Perpetual static info | <a name="PerpetualDataHandler.getInitialMarginRate"></a> ### PerpetualDataHandler.getInitialMarginRate(staticInfo) ⇒ Get initial margin rate from static data considering open/close of tradfi markets **Kind**: static method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler) **Returns**: initial margin rate in decimals | Param | Description | | --- | --- | | staticInfo | static info | <a name="PerpetualDataHandler.getMaintenanceMarginRate"></a> ### PerpetualDataHandler.getMaintenanceMarginRate(staticInfo) ⇒ Get maintenance margin rate from static data considering open/close of tradfi markets **Kind**: static method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler) **Returns**: maintenance margin rate in decimals | Param | Description | | --- | --- | | staticInfo | static info | <a name="PerpetualDataHandler.isMarketDayTime"></a> ### PerpetualDataHandler.isMarketDayTime(fAMMTargetDD) ⇒ Determine whether the market is in day trading, given the parameter fAMMTargetDD **Kind**: static method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler) **Returns**: true if currently the market is in day trading status | Param | Description | | --- | --- | | fAMMTargetDD | bigint that encodes market day trading times |