@d8x/perpetuals-sdk 2.6.21 → 2.6.23

package/doc/d8x-perpetuals-sdk.md

@@ -158,6 +158,7 @@ on-chain</p></dd>
     * [~pmGetDepositAmtForLvgTrade(tradeAmt, targetLvg, price, S3, S2Mark)](#module_d8xMath..pmGetDepositAmtForLvgTrade) ⇒
     * [~pmExcessCashAtLvg(tradeAmt, lvg, walletBalCC, currentCashCC, currentPosition, currentLockedInValue, slippage, S2, Sm, S3, totLong, totShort)](#module_d8xMath..pmExcessCashAtLvg) ⇒
     * [~pmFindMaxPersonalTradeSizeAtLeverage(dir, lvg, walletBalCC, slippage, currentPosition, currentCashCC, currentLockedInValue, S2, Sm, S3, glblMaxTrade)](#module_d8xMath..pmFindMaxPersonalTradeSizeAtLeverage) ⇒
+    * [~pmMaxSignedOpenTradeSize(long, short, sm, isBuy, mr)](#module_d8xMath..pmMaxSignedOpenTradeSize)
 
 <a name="module_d8xMath..ABDK29ToFloat"></a>
 
@@ -635,6 +636,21 @@ Factors in lot size and global max short/long, factors in opening/closing positi
 | S3 | <p>current collateral to quote index price</p> |
 | glblMaxTrade | <p>global max short or long order size that we retreive, e.g., from position risk (sign irrelevant) based on  long: (<em>ℓ+n) * (1-p) - m (1-p) s = F → n = (F+m</em>(1-p)<em>s)/(1-p)-ℓ</em> short: (s+n)<em>p - m p <em>ℓ</em> = F →n = (F+m</em>p**ℓ*)/p-s</p> |
 
+<a name="module_d8xMath..pmMaxSignedOpenTradeSize"></a>
+
+### d8xMath~pmMaxSignedOpenTradeSize(long, short, sm, isBuy, mr)
+<p>See PerpetualTradeLogic::_getMaxSignedOpenPredMktTradeSize</p>
+
+**Kind**: inner method of [<code>d8xMath</code>](#module_d8xMath)  
+
+| Param | Description |
+| --- | --- |
+| long | <p>Long open OI</p> |
+| short | <p>Short open OI</p> |
+| sm | <p>Mark price (&gt;1)</p> |
+| isBuy | <p>True if trade is long</p> |
+| mr | <p>Maintenance margin rate</p> |
+
 <a name="module_utils"></a>
 
 ## utils
@@ -796,6 +812,9 @@ require gas-payments.</p>
     * [.getMaintenanceMarginRate(symbol)](#PerpetualDataHandler+getMaintenanceMarginRate) ⇒
     * [.getShortSymbol(symbol)](#PerpetualDataHandler+getShortSymbol) ⇒
     * [.refreshSymbols()](#PerpetualDataHandler+refreshSymbols)
+    * [.getLocalPerpetualStates()](#PerpetualDataHandler+getLocalPerpetualStates) ⇒
+    * [.fetchOnChainPerpetualStates()](#PerpetualDataHandler+fetchOnChainPerpetualStates) ⇒
+    * [.checkHeartbeat()](#PerpetualDataHandler+checkHeartbeat) ⇒
 
 <a name="new_AccountTrade_new"></a>
 
@@ -1571,6 +1590,30 @@ main();
 
 **Kind**: instance method of [<code>AccountTrade</code>](#AccountTrade)  
 **Overrides**: [<code>refreshSymbols</code>](#PerpetualDataHandler+refreshSymbols)  
+<a name="PerpetualDataHandler+getLocalPerpetualStates"></a>
+
+### accountTrade.getLocalPerpetualStates() ⇒
+<p>Get state of perpetuals as currently known locally</p>
+
+**Kind**: instance method of [<code>AccountTrade</code>](#AccountTrade)  
+**Overrides**: [<code>getLocalPerpetualStates</code>](#PerpetualDataHandler+getLocalPerpetualStates)  
+**Returns**: <p>Array of [perpetual Id, perpetual state (string)]</p>  
+<a name="PerpetualDataHandler+fetchOnChainPerpetualStates"></a>
+
+### accountTrade.fetchOnChainPerpetualStates() ⇒
+<p>Fetches on-chain state of local perpetual ids. Does not run if SDK is not ready.</p>
+
+**Kind**: instance method of [<code>AccountTrade</code>](#AccountTrade)  
+**Overrides**: [<code>fetchOnChainPerpetualStates</code>](#PerpetualDataHandler+fetchOnChainPerpetualStates)  
+**Returns**: <p>Array of [perpetual Id, perpetual state (string)]</p>  
+<a name="PerpetualDataHandler+checkHeartbeat"></a>
+
+### accountTrade.checkHeartbeat() ⇒
+<p>Check that states of all perps known locally match on-chain states</p>
+
+**Kind**: instance method of [<code>AccountTrade</code>](#AccountTrade)  
+**Overrides**: [<code>checkHeartbeat</code>](#PerpetualDataHandler+checkHeartbeat)  
+**Returns**: <p>True if all perp states are correct</p>  
 <a name="BrokerTool"></a>
 
 ## BrokerTool ⇐ [<code>WriteAccessHandler</code>](#WriteAccessHandler)
@@ -1634,6 +1677,9 @@ require gas-payments.</p>
     * [.getMaintenanceMarginRate(symbol)](#PerpetualDataHandler+getMaintenanceMarginRate) ⇒
     * [.getShortSymbol(symbol)](#PerpetualDataHandler+getShortSymbol) ⇒
     * [.refreshSymbols()](#PerpetualDataHandler+refreshSymbols)
+    * [.getLocalPerpetualStates()](#PerpetualDataHandler+getLocalPerpetualStates) ⇒
+    * [.fetchOnChainPerpetualStates()](#PerpetualDataHandler+fetchOnChainPerpetualStates) ⇒
+    * [.checkHeartbeat()](#PerpetualDataHandler+checkHeartbeat) ⇒
 
 <a name="new_BrokerTool_new"></a>
 
@@ -2593,6 +2639,30 @@ main();
 
 **Kind**: instance method of [<code>BrokerTool</code>](#BrokerTool)  
 **Overrides**: [<code>refreshSymbols</code>](#PerpetualDataHandler+refreshSymbols)  
+<a name="PerpetualDataHandler+getLocalPerpetualStates"></a>
+
+### brokerTool.getLocalPerpetualStates() ⇒
+<p>Get state of perpetuals as currently known locally</p>
+
+**Kind**: instance method of [<code>BrokerTool</code>](#BrokerTool)  
+**Overrides**: [<code>getLocalPerpetualStates</code>](#PerpetualDataHandler+getLocalPerpetualStates)  
+**Returns**: <p>Array of [perpetual Id, perpetual state (string)]</p>  
+<a name="PerpetualDataHandler+fetchOnChainPerpetualStates"></a>
+
+### brokerTool.fetchOnChainPerpetualStates() ⇒
+<p>Fetches on-chain state of local perpetual ids. Does not run if SDK is not ready.</p>
+
+**Kind**: instance method of [<code>BrokerTool</code>](#BrokerTool)  
+**Overrides**: [<code>fetchOnChainPerpetualStates</code>](#PerpetualDataHandler+fetchOnChainPerpetualStates)  
+**Returns**: <p>Array of [perpetual Id, perpetual state (string)]</p>  
+<a name="PerpetualDataHandler+checkHeartbeat"></a>
+
+### brokerTool.checkHeartbeat() ⇒
+<p>Check that states of all perps known locally match on-chain states</p>
+
+**Kind**: instance method of [<code>BrokerTool</code>](#BrokerTool)  
+**Overrides**: [<code>checkHeartbeat</code>](#PerpetualDataHandler+checkHeartbeat)  
+**Returns**: <p>True if all perp states are correct</p>  
 <a name="LiquidatorTool"></a>
 
 ## LiquidatorTool ⇐ [<code>WriteAccessHandler</code>](#WriteAccessHandler)
@@ -2648,6 +2718,9 @@ and executes smart-contract interactions that require gas-payments.</p>
     * [.getMaintenanceMarginRate(symbol)](#PerpetualDataHandler+getMaintenanceMarginRate) ⇒
     * [.getShortSymbol(symbol)](#PerpetualDataHandler+getShortSymbol) ⇒
     * [.refreshSymbols()](#PerpetualDataHandler+refreshSymbols)
+    * [.getLocalPerpetualStates()](#PerpetualDataHandler+getLocalPerpetualStates) ⇒
+    * [.fetchOnChainPerpetualStates()](#PerpetualDataHandler+fetchOnChainPerpetualStates) ⇒
+    * [.checkHeartbeat()](#PerpetualDataHandler+checkHeartbeat) ⇒
 
 <a name="new_LiquidatorTool_new"></a>
 
@@ -3365,6 +3438,30 @@ main();
 
 **Kind**: instance method of [<code>LiquidatorTool</code>](#LiquidatorTool)  
 **Overrides**: [<code>refreshSymbols</code>](#PerpetualDataHandler+refreshSymbols)  
+<a name="PerpetualDataHandler+getLocalPerpetualStates"></a>
+
+### liquidatorTool.getLocalPerpetualStates() ⇒
+<p>Get state of perpetuals as currently known locally</p>
+
+**Kind**: instance method of [<code>LiquidatorTool</code>](#LiquidatorTool)  
+**Overrides**: [<code>getLocalPerpetualStates</code>](#PerpetualDataHandler+getLocalPerpetualStates)  
+**Returns**: <p>Array of [perpetual Id, perpetual state (string)]</p>  
+<a name="PerpetualDataHandler+fetchOnChainPerpetualStates"></a>
+
+### liquidatorTool.fetchOnChainPerpetualStates() ⇒
+<p>Fetches on-chain state of local perpetual ids. Does not run if SDK is not ready.</p>
+
+**Kind**: instance method of [<code>LiquidatorTool</code>](#LiquidatorTool)  
+**Overrides**: [<code>fetchOnChainPerpetualStates</code>](#PerpetualDataHandler+fetchOnChainPerpetualStates)  
+**Returns**: <p>Array of [perpetual Id, perpetual state (string)]</p>  
+<a name="PerpetualDataHandler+checkHeartbeat"></a>
+
+### liquidatorTool.checkHeartbeat() ⇒
+<p>Check that states of all perps known locally match on-chain states</p>
+
+**Kind**: instance method of [<code>LiquidatorTool</code>](#LiquidatorTool)  
+**Overrides**: [<code>checkHeartbeat</code>](#PerpetualDataHandler+checkHeartbeat)  
+**Returns**: <p>True if all perp states are correct</p>  
 <a name="LiquidityProviderTool"></a>
 
 ## LiquidityProviderTool ⇐ [<code>WriteAccessHandler</code>](#WriteAccessHandler)
@@ -3418,6 +3515,9 @@ smart-contract interactions that require gas-payments.</p>
     * [.getMaintenanceMarginRate(symbol)](#PerpetualDataHandler+getMaintenanceMarginRate) ⇒
     * [.getShortSymbol(symbol)](#PerpetualDataHandler+getShortSymbol) ⇒
     * [.refreshSymbols()](#PerpetualDataHandler+refreshSymbols)
+    * [.getLocalPerpetualStates()](#PerpetualDataHandler+getLocalPerpetualStates) ⇒
+    * [.fetchOnChainPerpetualStates()](#PerpetualDataHandler+fetchOnChainPerpetualStates) ⇒
+    * [.checkHeartbeat()](#PerpetualDataHandler+checkHeartbeat) ⇒
 
 <a name="new_LiquidityProviderTool_new"></a>
 
@@ -4074,6 +4174,30 @@ main();
 
 **Kind**: instance method of [<code>LiquidityProviderTool</code>](#LiquidityProviderTool)  
 **Overrides**: [<code>refreshSymbols</code>](#PerpetualDataHandler+refreshSymbols)  
+<a name="PerpetualDataHandler+getLocalPerpetualStates"></a>
+
+### liquidityProviderTool.getLocalPerpetualStates() ⇒
+<p>Get state of perpetuals as currently known locally</p>
+
+**Kind**: instance method of [<code>LiquidityProviderTool</code>](#LiquidityProviderTool)  
+**Overrides**: [<code>getLocalPerpetualStates</code>](#PerpetualDataHandler+getLocalPerpetualStates)  
+**Returns**: <p>Array of [perpetual Id, perpetual state (string)]</p>  
+<a name="PerpetualDataHandler+fetchOnChainPerpetualStates"></a>
+
+### liquidityProviderTool.fetchOnChainPerpetualStates() ⇒
+<p>Fetches on-chain state of local perpetual ids. Does not run if SDK is not ready.</p>
+
+**Kind**: instance method of [<code>LiquidityProviderTool</code>](#LiquidityProviderTool)  
+**Overrides**: [<code>fetchOnChainPerpetualStates</code>](#PerpetualDataHandler+fetchOnChainPerpetualStates)  
+**Returns**: <p>Array of [perpetual Id, perpetual state (string)]</p>  
+<a name="PerpetualDataHandler+checkHeartbeat"></a>
+
+### liquidityProviderTool.checkHeartbeat() ⇒
+<p>Check that states of all perps known locally match on-chain states</p>
+
+**Kind**: instance method of [<code>LiquidityProviderTool</code>](#LiquidityProviderTool)  
+**Overrides**: [<code>checkHeartbeat</code>](#PerpetualDataHandler+checkHeartbeat)  
+**Returns**: <p>True if all perp states are correct</p>  
 <a name="MarketData"></a>
 
 ## MarketData ⇐ [<code>PerpetualDataHandler</code>](#PerpetualDataHandler)
@@ -4157,6 +4281,9 @@ No gas required for the queries here.</p>
         * [.getMaintenanceMarginRate(symbol)](#PerpetualDataHandler+getMaintenanceMarginRate) ⇒
         * [.getShortSymbol(symbol)](#PerpetualDataHandler+getShortSymbol) ⇒
         * [.refreshSymbols()](#PerpetualDataHandler+refreshSymbols)
+        * [.getLocalPerpetualStates()](#PerpetualDataHandler+getLocalPerpetualStates) ⇒
+        * [.fetchOnChainPerpetualStates()](#PerpetualDataHandler+fetchOnChainPerpetualStates) ⇒
+        * [.checkHeartbeat()](#PerpetualDataHandler+checkHeartbeat) ⇒
     * _static_
         * [.exchangeFeePrdMkts(maxMaintMgnRate, Sm, tradeAmtBC, tradeMgnRate)](#MarketData.exchangeFeePrdMkts) ⇒
 
@@ -5457,6 +5584,30 @@ main();
 
 **Kind**: instance method of [<code>MarketData</code>](#MarketData)  
 **Overrides**: [<code>refreshSymbols</code>](#PerpetualDataHandler+refreshSymbols)  
+<a name="PerpetualDataHandler+getLocalPerpetualStates"></a>
+
+### marketData.getLocalPerpetualStates() ⇒
+<p>Get state of perpetuals as currently known locally</p>
+
+**Kind**: instance method of [<code>MarketData</code>](#MarketData)  
+**Overrides**: [<code>getLocalPerpetualStates</code>](#PerpetualDataHandler+getLocalPerpetualStates)  
+**Returns**: <p>Array of [perpetual Id, perpetual state (string)]</p>  
+<a name="PerpetualDataHandler+fetchOnChainPerpetualStates"></a>
+
+### marketData.fetchOnChainPerpetualStates() ⇒
+<p>Fetches on-chain state of local perpetual ids. Does not run if SDK is not ready.</p>
+
+**Kind**: instance method of [<code>MarketData</code>](#MarketData)  
+**Overrides**: [<code>fetchOnChainPerpetualStates</code>](#PerpetualDataHandler+fetchOnChainPerpetualStates)  
+**Returns**: <p>Array of [perpetual Id, perpetual state (string)]</p>  
+<a name="PerpetualDataHandler+checkHeartbeat"></a>
+
+### marketData.checkHeartbeat() ⇒
+<p>Check that states of all perps known locally match on-chain states</p>
+
+**Kind**: instance method of [<code>MarketData</code>](#MarketData)  
+**Overrides**: [<code>checkHeartbeat</code>](#PerpetualDataHandler+checkHeartbeat)  
+**Returns**: <p>True if all perp states are correct</p>  
 <a name="MarketData.exchangeFeePrdMkts"></a>
 
 ### MarketData.exchangeFeePrdMkts(maxMaintMgnRate, Sm, tradeAmtBC, tradeMgnRate) ⇒
@@ -5548,6 +5699,9 @@ gas-payments.</p>
     * [.getMaintenanceMarginRate(symbol)](#PerpetualDataHandler+getMaintenanceMarginRate) ⇒
     * [.getShortSymbol(symbol)](#PerpetualDataHandler+getShortSymbol) ⇒
     * [.refreshSymbols()](#PerpetualDataHandler+refreshSymbols)
+    * [.getLocalPerpetualStates()](#PerpetualDataHandler+getLocalPerpetualStates) ⇒
+    * [.fetchOnChainPerpetualStates()](#PerpetualDataHandler+fetchOnChainPerpetualStates) ⇒
+    * [.checkHeartbeat()](#PerpetualDataHandler+checkHeartbeat) ⇒
 
 <a name="new_OrderExecutorTool_new"></a>
 
@@ -6311,6 +6465,30 @@ main();
 
 **Kind**: instance method of [<code>OrderExecutorTool</code>](#OrderExecutorTool)  
 **Overrides**: [<code>refreshSymbols</code>](#PerpetualDataHandler+refreshSymbols)  
+<a name="PerpetualDataHandler+getLocalPerpetualStates"></a>
+
+### orderExecutorTool.getLocalPerpetualStates() ⇒
+<p>Get state of perpetuals as currently known locally</p>
+
+**Kind**: instance method of [<code>OrderExecutorTool</code>](#OrderExecutorTool)  
+**Overrides**: [<code>getLocalPerpetualStates</code>](#PerpetualDataHandler+getLocalPerpetualStates)  
+**Returns**: <p>Array of [perpetual Id, perpetual state (string)]</p>  
+<a name="PerpetualDataHandler+fetchOnChainPerpetualStates"></a>
+
+### orderExecutorTool.fetchOnChainPerpetualStates() ⇒
+<p>Fetches on-chain state of local perpetual ids. Does not run if SDK is not ready.</p>
+
+**Kind**: instance method of [<code>OrderExecutorTool</code>](#OrderExecutorTool)  
+**Overrides**: [<code>fetchOnChainPerpetualStates</code>](#PerpetualDataHandler+fetchOnChainPerpetualStates)  
+**Returns**: <p>Array of [perpetual Id, perpetual state (string)]</p>  
+<a name="PerpetualDataHandler+checkHeartbeat"></a>
+
+### orderExecutorTool.checkHeartbeat() ⇒
+<p>Check that states of all perps known locally match on-chain states</p>
+
+**Kind**: instance method of [<code>OrderExecutorTool</code>](#OrderExecutorTool)  
+**Overrides**: [<code>checkHeartbeat</code>](#PerpetualDataHandler+checkHeartbeat)  
+**Returns**: <p>True if all perp states are correct</p>  
 <a name="PerpetualDataHandler"></a>
 
 ## PerpetualDataHandler
@@ -6357,6 +6535,9 @@ common data and chain operations.</p>
         * [.getMaintenanceMarginRate(symbol)](#PerpetualDataHandler+getMaintenanceMarginRate) ⇒
         * [.getShortSymbol(symbol)](#PerpetualDataHandler+getShortSymbol) ⇒
         * [.refreshSymbols()](#PerpetualDataHandler+refreshSymbols)
+        * [.getLocalPerpetualStates()](#PerpetualDataHandler+getLocalPerpetualStates) ⇒
+        * [.fetchOnChainPerpetualStates()](#PerpetualDataHandler+fetchOnChainPerpetualStates) ⇒
+        * [.checkHeartbeat()](#PerpetualDataHandler+checkHeartbeat) ⇒
     * _static_
         * [.fetchSlotsInfo(chainId, short)](#PerpetualDataHandler.fetchSlotsInfo) ⇒
         * [.getPerpetualStaticInfo(_proxyContract, nestedPerpetualIDs, symbolList)](#PerpetualDataHandler.getPerpetualStaticInfo) ⇒
@@ -6388,6 +6569,7 @@ common data and chain operations.</p>
         * [.getMaintenanceMarginRate(staticInfo)](#PerpetualDataHandler.getMaintenanceMarginRate) ⇒
         * [.isMarketDayTime(fAMMTargetDD)](#PerpetualDataHandler.isMarketDayTime) ⇒
         * [.getIndexSymbol(_symbolList, info)](#PerpetualDataHandler.getIndexSymbol) ⇒
+        * [.extractStatesFromStaticInfos(perpInfos)](#PerpetualDataHandler.extractStatesFromStaticInfos) ⇒
 
 <a name="new_PerpetualDataHandler_new"></a>
 
@@ -6852,6 +7034,27 @@ main();
 <p>Refreshes symbol mappings if at least one prediction market is expired</p>
 
 **Kind**: instance method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler)  
+<a name="PerpetualDataHandler+getLocalPerpetualStates"></a>
+
+### perpetualDataHandler.getLocalPerpetualStates() ⇒
+<p>Get state of perpetuals as currently known locally</p>
+
+**Kind**: instance method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler)  
+**Returns**: <p>Array of [perpetual Id, perpetual state (string)]</p>  
+<a name="PerpetualDataHandler+fetchOnChainPerpetualStates"></a>
+
+### perpetualDataHandler.fetchOnChainPerpetualStates() ⇒
+<p>Fetches on-chain state of local perpetual ids. Does not run if SDK is not ready.</p>
+
+**Kind**: instance method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler)  
+**Returns**: <p>Array of [perpetual Id, perpetual state (string)]</p>  
+<a name="PerpetualDataHandler+checkHeartbeat"></a>
+
+### perpetualDataHandler.checkHeartbeat() ⇒
+<p>Check that states of all perps known locally match on-chain states</p>
+
+**Kind**: instance method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler)  
+**Returns**: <p>True if all perp states are correct</p>  
 <a name="PerpetualDataHandler.fetchSlotsInfo"></a>
 
 ### PerpetualDataHandler.fetchSlotsInfo(chainId, short) ⇒
@@ -7265,6 +7468,18 @@ which has open/close times</p>
 | _symbolList | <p>Mapping from long symbol (e.g. NHL_TOR_DAL_251015) to price-feed API symbol (NHL0-USD:84532)</p> |
 | info | <p>Perpetual static info</p> |
 
+<a name="PerpetualDataHandler.extractStatesFromStaticInfos"></a>
+
+### PerpetualDataHandler.extractStatesFromStaticInfos(perpInfos) ⇒
+<p>Extract perpetual states from collection of static infos</p>
+
+**Kind**: static method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler)  
+**Returns**: <p>Array of [perpetual Id, perpetual state (string)]</p>  
+
+| Param | Description |
+| --- | --- |
+| perpInfos | <p>Perpetual static infos, either a symbol =&gt; PerpInfo mapping, or a PerpInfo array</p> |
+
 <a name="PerpetualEventHandler"></a>
 
 ## PerpetualEventHandler
@@ -8020,6 +8235,9 @@ so that signatures can be handled in frontend via wallet</p>
         * [.getMaintenanceMarginRate(symbol)](#PerpetualDataHandler+getMaintenanceMarginRate) ⇒
         * [.getShortSymbol(symbol)](#PerpetualDataHandler+getShortSymbol) ⇒
         * [.refreshSymbols()](#PerpetualDataHandler+refreshSymbols)
+        * [.getLocalPerpetualStates()](#PerpetualDataHandler+getLocalPerpetualStates) ⇒
+        * [.fetchOnChainPerpetualStates()](#PerpetualDataHandler+fetchOnChainPerpetualStates) ⇒
+        * [.checkHeartbeat()](#PerpetualDataHandler+checkHeartbeat) ⇒
     * _static_
         * [.chainOrders(orders, ids)](#TraderInterface.chainOrders) ⇒
 
@@ -9581,6 +9799,30 @@ main();
 
 **Kind**: instance method of [<code>TraderInterface</code>](#TraderInterface)  
 **Overrides**: [<code>refreshSymbols</code>](#PerpetualDataHandler+refreshSymbols)  
+<a name="PerpetualDataHandler+getLocalPerpetualStates"></a>
+
+### traderInterface.getLocalPerpetualStates() ⇒
+<p>Get state of perpetuals as currently known locally</p>
+
+**Kind**: instance method of [<code>TraderInterface</code>](#TraderInterface)  
+**Overrides**: [<code>getLocalPerpetualStates</code>](#PerpetualDataHandler+getLocalPerpetualStates)  
+**Returns**: <p>Array of [perpetual Id, perpetual state (string)]</p>  
+<a name="PerpetualDataHandler+fetchOnChainPerpetualStates"></a>
+
+### traderInterface.fetchOnChainPerpetualStates() ⇒
+<p>Fetches on-chain state of local perpetual ids. Does not run if SDK is not ready.</p>
+
+**Kind**: instance method of [<code>TraderInterface</code>](#TraderInterface)  
+**Overrides**: [<code>fetchOnChainPerpetualStates</code>](#PerpetualDataHandler+fetchOnChainPerpetualStates)  
+**Returns**: <p>Array of [perpetual Id, perpetual state (string)]</p>  
+<a name="PerpetualDataHandler+checkHeartbeat"></a>
+
+### traderInterface.checkHeartbeat() ⇒
+<p>Check that states of all perps known locally match on-chain states</p>
+
+**Kind**: instance method of [<code>TraderInterface</code>](#TraderInterface)  
+**Overrides**: [<code>checkHeartbeat</code>](#PerpetualDataHandler+checkHeartbeat)  
+**Returns**: <p>True if all perp states are correct</p>  
 <a name="TraderInterface.chainOrders"></a>
 
 ### TraderInterface.chainOrders(orders, ids) ⇒
@@ -9647,6 +9889,9 @@ require gas-payments.</p>
     * [.getMaintenanceMarginRate(symbol)](#PerpetualDataHandler+getMaintenanceMarginRate) ⇒
     * [.getShortSymbol(symbol)](#PerpetualDataHandler+getShortSymbol) ⇒
     * [.refreshSymbols()](#PerpetualDataHandler+refreshSymbols)
+    * [.getLocalPerpetualStates()](#PerpetualDataHandler+getLocalPerpetualStates) ⇒
+    * [.fetchOnChainPerpetualStates()](#PerpetualDataHandler+fetchOnChainPerpetualStates) ⇒
+    * [.checkHeartbeat()](#PerpetualDataHandler+checkHeartbeat) ⇒
 
 <a name="new_WriteAccessHandler_new"></a>
 
@@ -10193,6 +10438,30 @@ main();
 
 **Kind**: instance method of [<code>WriteAccessHandler</code>](#WriteAccessHandler)  
 **Overrides**: [<code>refreshSymbols</code>](#PerpetualDataHandler+refreshSymbols)  
+<a name="PerpetualDataHandler+getLocalPerpetualStates"></a>
+
+### writeAccessHandler.getLocalPerpetualStates() ⇒
+<p>Get state of perpetuals as currently known locally</p>
+
+**Kind**: instance method of [<code>WriteAccessHandler</code>](#WriteAccessHandler)  
+**Overrides**: [<code>getLocalPerpetualStates</code>](#PerpetualDataHandler+getLocalPerpetualStates)  
+**Returns**: <p>Array of [perpetual Id, perpetual state (string)]</p>  
+<a name="PerpetualDataHandler+fetchOnChainPerpetualStates"></a>
+
+### writeAccessHandler.fetchOnChainPerpetualStates() ⇒
+<p>Fetches on-chain state of local perpetual ids. Does not run if SDK is not ready.</p>
+
+**Kind**: instance method of [<code>WriteAccessHandler</code>](#WriteAccessHandler)  
+**Overrides**: [<code>fetchOnChainPerpetualStates</code>](#PerpetualDataHandler+fetchOnChainPerpetualStates)  
+**Returns**: <p>Array of [perpetual Id, perpetual state (string)]</p>  
+<a name="PerpetualDataHandler+checkHeartbeat"></a>
+
+### writeAccessHandler.checkHeartbeat() ⇒
+<p>Check that states of all perps known locally match on-chain states</p>
+
+**Kind**: instance method of [<code>WriteAccessHandler</code>](#WriteAccessHandler)  
+**Overrides**: [<code>checkHeartbeat</code>](#PerpetualDataHandler+checkHeartbeat)  
+**Returns**: <p>True if all perp states are correct</p>  
 <a name="default"></a>
 
 ## default ⇒

package/doc/perpetualDataHandler.md

@@ -44,6 +44,9 @@ common data and chain operations.</p>
         * [.getMaintenanceMarginRate(symbol)](#PerpetualDataHandler+getMaintenanceMarginRate) ⇒
         * [.getShortSymbol(symbol)](#PerpetualDataHandler+getShortSymbol) ⇒
         * [.refreshSymbols()](#PerpetualDataHandler+refreshSymbols)
+        * [.getLocalPerpetualStates()](#PerpetualDataHandler+getLocalPerpetualStates) ⇒
+        * [.fetchOnChainPerpetualStates()](#PerpetualDataHandler+fetchOnChainPerpetualStates) ⇒
+        * [.checkHeartbeat()](#PerpetualDataHandler+checkHeartbeat) ⇒
     * _static_
         * [.fetchSlotsInfo(chainId, short)](#PerpetualDataHandler.fetchSlotsInfo) ⇒
         * [.getPerpetualStaticInfo(_proxyContract, nestedPerpetualIDs, symbolList)](#PerpetualDataHandler.getPerpetualStaticInfo) ⇒
@@ -75,6 +78,7 @@ common data and chain operations.</p>
         * [.getMaintenanceMarginRate(staticInfo)](#PerpetualDataHandler.getMaintenanceMarginRate) ⇒
         * [.isMarketDayTime(fAMMTargetDD)](#PerpetualDataHandler.isMarketDayTime) ⇒
         * [.getIndexSymbol(_symbolList, info)](#PerpetualDataHandler.getIndexSymbol) ⇒
+        * [.extractStatesFromStaticInfos(perpInfos)](#PerpetualDataHandler.extractStatesFromStaticInfos) ⇒
 
 <a name="new_PerpetualDataHandler_new"></a>
 
@@ -539,6 +543,27 @@ main();
 <p>Refreshes symbol mappings if at least one prediction market is expired</p>
 
 **Kind**: instance method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler)  
+<a name="PerpetualDataHandler+getLocalPerpetualStates"></a>
+
+### perpetualDataHandler.getLocalPerpetualStates() ⇒
+<p>Get state of perpetuals as currently known locally</p>
+
+**Kind**: instance method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler)  
+**Returns**: <p>Array of [perpetual Id, perpetual state (string)]</p>  
+<a name="PerpetualDataHandler+fetchOnChainPerpetualStates"></a>
+
+### perpetualDataHandler.fetchOnChainPerpetualStates() ⇒
+<p>Fetches on-chain state of local perpetual ids. Does not run if SDK is not ready.</p>
+
+**Kind**: instance method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler)  
+**Returns**: <p>Array of [perpetual Id, perpetual state (string)]</p>  
+<a name="PerpetualDataHandler+checkHeartbeat"></a>
+
+### perpetualDataHandler.checkHeartbeat() ⇒
+<p>Check that states of all perps known locally match on-chain states</p>
+
+**Kind**: instance method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler)  
+**Returns**: <p>True if all perp states are correct</p>  
 <a name="PerpetualDataHandler.fetchSlotsInfo"></a>
 
 ### PerpetualDataHandler.fetchSlotsInfo(chainId, short) ⇒
@@ -952,3 +977,15 @@ which has open/close times</p>
 | _symbolList | <p>Mapping from long symbol (e.g. NHL_TOR_DAL_251015) to price-feed API symbol (NHL0-USD:84532)</p> |
 | info | <p>Perpetual static info</p> |
 
+<a name="PerpetualDataHandler.extractStatesFromStaticInfos"></a>
+
+### PerpetualDataHandler.extractStatesFromStaticInfos(perpInfos) ⇒
+<p>Extract perpetual states from collection of static infos</p>
+
+**Kind**: static method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler)  
+**Returns**: <p>Array of [perpetual Id, perpetual state (string)]</p>  
+
+| Param | Description |
+| --- | --- |
+| perpInfos | <p>Perpetual static infos, either a symbol =&gt; PerpInfo mapping, or a PerpInfo array</p> |
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@d8x/perpetuals-sdk",
-  "version": "2.6.21",
+  "version": "2.6.23",
   "description": "Node TypeScript SDK for D8X Perpetual Futures",
   "author": "D8X",
   "homepage": "https://github.com/D8-X/d8x-futures-node-sdk#readme",

package/src/d8XMath.ts

@@ -961,7 +961,7 @@ export function pmMaxSignedOpenTradeSize(
     return 0;
   }
   const m = pmMaintenanceMarginRate(isBuy ? 1 : -1, sm, mr);
-  let p = isBuy ? sm - 1 : 2 - sm;
+  let p = !isBuy ? sm - 1 : 2 - sm;
   p = p < 0.01 ? 0.01 : p > 0.99 ? 0.99 : p; // same cap as contract
   return isBuy ? (ammFundsQC + m * p * short) / p - long : -(ammFundsQC + m * p * long) / p + short;
 }

package/src/marketData.ts

@@ -991,10 +991,11 @@ export default class MarketData extends PerpetualDataHandler {
     markPrice: number,
     collToQuoteConversion: number,
     S2: number,
-    symbolToPerpStaticInfo: Map<string, PerpetualStaticInfo>
+    symbolToPerpStaticInfo: ReadonlyMap<string, PerpetualStaticInfo>
   ): [number, number | undefined, number] {
     let S2Liq: number, S3Liq: number | undefined;
     const staticInfo = symbolToPerpStaticInfo.get(symbol)!;
+
     let ccyType = staticInfo.collateralCurrencyType;
     const isPred = MarketData.isPredictionMarketStatic(staticInfo);
     const idx_availableCashCC = 2;
@@ -1819,7 +1820,7 @@ export default class MarketData extends PerpetualDataHandler {
   protected static async openOrdersOnOrderBook(
     traderAddr: string,
     orderBookContract: LimitOrderBook,
-    symbolToPerpStaticInfo: Map<string, PerpetualStaticInfo>,
+    symbolToPerpStaticInfo: ReadonlyMap<string, PerpetualStaticInfo>,
     overrides?: Overrides
   ): Promise<Order[]> {
     //eliminate empty orders and map to user friendly orders
@@ -1856,7 +1857,7 @@ export default class MarketData extends PerpetualDataHandler {
     traderAddr: string,
     orderBookContracts: LimitOrderBook[],
     multicall: Multicall3,
-    symbolToPerpStaticInfo: Map<string, PerpetualStaticInfo>,
+    symbolToPerpStaticInfo: ReadonlyMap<string, PerpetualStaticInfo>,
     overrides?: Overrides
   ): Promise<{ orders: Order[][]; digests: string[][] }> {
     // eliminate empty orders and map to user friendly orders
@@ -2044,9 +2045,9 @@ export default class MarketData extends PerpetualDataHandler {
    * @ignore
    */
   private static async _getAllActivePerpIndexPrices(
-    _symbolToPerpStaticInfo: Map<string, PerpetualStaticInfo>,
+    _symbolToPerpStaticInfo: ReadonlyMap<string, PerpetualStaticInfo>,
     _priceFeedGetter: PriceFeeds,
-    _symbolList: Map<string, string>
+    _symbolList: ReadonlyMap<string, string>
   ): Promise<Map<string, [number, boolean]>> {
     // get all prices from off-chain price-sources
     let allSym = new Set<string>();
@@ -2102,7 +2103,7 @@ export default class MarketData extends PerpetualDataHandler {
    */
   private static async _isMarketClosed(
     symbol: string,
-    _symbolToPerpStaticInfo: Map<string, PerpetualStaticInfo>,
+    _symbolToPerpStaticInfo: ReadonlyMap<string, PerpetualStaticInfo>,
     _priceFeedGetter: PriceFeeds
   ): Promise<boolean> {
     const sInfo: PerpetualStaticInfo | undefined = _symbolToPerpStaticInfo.get(symbol);
@@ -2133,13 +2134,13 @@ export default class MarketData extends PerpetualDataHandler {
    */
   private static async _queryMidPrices(
     _proxyContract: Contract,
-    _poolStaticInfos: Array<PoolStaticInfo>,
+    _poolStaticInfos: ReadonlyArray<PoolStaticInfo>,
     _multicall: Multicall3,
-    _nestedPerpetualIDs: Array<Array<number>>,
-    _symbolToPerpStaticInfo: Map<string, PerpetualStaticInfo>,
-    _perpetualIdToSymbol: Map<number, string>,
-    _idxPriceMap: Map<string, [number, boolean]>,
-    _symbolList: Map<string, string>,
+    _nestedPerpetualIDs: ReadonlyArray<ReadonlyArray<number>>,
+    _symbolToPerpStaticInfo: ReadonlyMap<string, PerpetualStaticInfo>,
+    _perpetualIdToSymbol: ReadonlyMap<number, string>,
+    _idxPriceMap: ReadonlyMap<string, [number, boolean]>,
+    _symbolList: ReadonlyMap<string, string>,
     overrides?: Overrides
   ): Promise<Map<string, number>> {
     // what is the maximal number of queries at once?
@@ -2218,9 +2219,9 @@ export default class MarketData extends PerpetualDataHandler {
   private static async _queryPoolAndPerpetualStates(
     _proxyContract: Contract,
     _multicall: Multicall3,
-    _poolStaticInfos: PoolStaticInfo[],
-    _symbolList: Map<string, string>,
-    _nestedPerpetualIDs: Array<Array<number>>,
+    _poolStaticInfos: readonly PoolStaticInfo[],
+    _symbolList: ReadonlyMap<string, string>,
+    _nestedPerpetualIDs: ReadonlyArray<ReadonlyArray<number>>,
     overrides?: Overrides
   ): Promise<{ pools: Array<PoolState>; perpetuals: Array<PerpetualState> }> {
     const chunkSize = 5;
@@ -2298,7 +2299,7 @@ export default class MarketData extends PerpetualDataHandler {
    */
   protected static _poolDataToPoolState(
     _liquidityPools: Partial<PerpStorage.LiquidityPoolDataStructOutput>[],
-    _poolStaticInfos: PoolStaticInfo[]
+    _poolStaticInfos: readonly PoolStaticInfo[]
   ): PoolState[] {
     const poolStates = _liquidityPools.map(
       (pool, k) =>
@@ -2326,9 +2327,9 @@ export default class MarketData extends PerpetualDataHandler {
    * @ignore
    */
   protected static _perpetualDataToPerpetualState(
-    _perpetuals: any[],
-    _longShortBC: [bigint, bigint][],
-    _symbolList: Map<string, string>
+    _perpetuals: readonly any[],
+    _longShortBC: readonly [bigint, bigint][],
+    _symbolList: ReadonlyMap<string, string>
   ): PerpetualState[] {
     const perpStates = new Array<PerpetualState>();
     for (let k = 0; k < _perpetuals.length; k++) {
@@ -2427,9 +2428,13 @@ export default class MarketData extends PerpetualDataHandler {
       ) {
         perp.isMarketClosed = true;
       } else {
-        const idxPriceS2Pair = idxPriceMap.get(MarketData.getIndexSymbol(_symbolList, info))!;
+        const indexSymbol = MarketData.getIndexSymbol(_symbolList, info);
+        const idxPriceS2Pair = idxPriceMap.get(indexSymbol)!; // checked in if
         let idxPriceS3Pair: [number, boolean] = [0, false];
-        perp.isMarketClosed = idxPriceS2Pair[1];
+        perp.isMarketClosed =
+          idxPriceS2Pair[1] ||
+          (MarketData.isPredictionMarketStatic(info) &&
+            (isNaN(idxPriceS2Pair[0]) || idxPriceS2Pair[0] < 1.01 || idxPriceS2Pair[0] > 1.99));
         if (info.S3Symbol != "" && idxPriceMap.has(info.S3Symbol)) {
           idxPriceS3Pair = idxPriceMap.get(info.S3Symbol)!;
           perp.isMarketClosed = perp.isMarketClosed || idxPriceS3Pair[1];
@@ -2443,7 +2448,7 @@ export default class MarketData extends PerpetualDataHandler {
         }
         perp.collToQuoteIndexPrice = indexS3;
 
-        const emaKey = info.S2Symbol + ":ema";
+        const emaKey = indexSymbol + ":ema";
         let markPrice: number;
         if (idxPriceMap.has(emaKey)) {
           let ema: number;