@d8x/perpetuals-sdk 2.0.13-alpha → 2.1.1-alpha2

package/doc/d8x-perpetuals-sdk.md

@@ -67,6 +67,9 @@ Send event variables to event handler &quot;on<EventName>&quot; - this updates m
 <li>[x] async onUpdateMarginAccount    : emitted on proxy; updates position data and open interest</li>
 <li>[x] onTrade                        : emitted on proxy; returns TradeEvent to be displayed</li>
 </ul></dd>
+<dt><a href="#PolyMktsPxFeed">PolyMktsPxFeed</a></dt>
+<dd><p>PolyMktsPxFeed gets prices from the official polymarket api
+and applies the 1+px transformation</p></dd>
 <dt><a href="#PriceFeeds">PriceFeeds</a></dt>
 <dd><p>This class communicates with the REST API that provides price-data that is
 to be submitted to the smart contracts for certain functions such as
@@ -99,6 +102,26 @@ require gas-payments.</p></dd>
 on-chain</p></dd>
 </dl>
 
+## Constants
+
+<dl>
+<dt><a href="#referralDomain">referralDomain</a></dt>
+<dd><p>LiquidityPoolData corresponding to the data in the smart contract</p></dd>
+</dl>
+
+## Typedefs
+
+<dl>
+<dt><a href="#ExchangeInfo">ExchangeInfo</a> : <code>Object</code></dt>
+<dd></dd>
+<dt><a href="#PoolState">PoolState</a> : <code>Object</code></dt>
+<dd></dd>
+<dt><a href="#SmartContractOrder">SmartContractOrder</a> : <code>Object</code></dt>
+<dd></dd>
+<dt><a href="#ClientOrder">ClientOrder</a> : <code>Object</code></dt>
+<dd></dd>
+</dl>
+
 <a name="module_d8xMath"></a>
 
 ## d8xMath
@@ -108,19 +131,29 @@ on-chain</p></dd>
     * [~ABK64x64ToFloat(x)](#module_d8xMath..ABK64x64ToFloat) ⇒ <code>number</code>
     * [~decNToFloat(x)](#module_d8xMath..decNToFloat) ⇒ <code>number</code>
     * [~dec18ToFloat(x)](#module_d8xMath..dec18ToFloat) ⇒ <code>number</code>
-    * [~floatToABK64x64(x)](#module_d8xMath..floatToABK64x64) ⇒ <code>BigNumber</code>
+    * [~floatToABK64x64(x)](#module_d8xMath..floatToABK64x64) ⇒ <code>bigint</code>
     * [~floatToDec18(x)](#module_d8xMath..floatToDec18) ⇒ <code>BigNumber</code>
     * [~floatToDecN(x, decimals)](#module_d8xMath..floatToDecN) ⇒ <code>BigNumber</code>
     * [~countDecimalsOf(x, precision)](#module_d8xMath..countDecimalsOf) ⇒
     * [~roundToLotString(x, lot, precision)](#module_d8xMath..roundToLotString) ⇒
-    * [~mul64x64(x, y)](#module_d8xMath..mul64x64) ⇒ <code>BigNumber</code>
-    * [~div64x64(x, y)](#module_d8xMath..div64x64) ⇒ <code>BigNumber</code>
+    * [~mul64x64(x, y)](#module_d8xMath..mul64x64) ⇒ <code>bigint</code>
+    * [~div64x64(x, y)](#module_d8xMath..div64x64) ⇒ <code>bigint</code>
     * [~calculateLiquidationPriceCollateralBase(LockedInValueQC, position, cash_cc, maintenance_margin_rate, S3)](#module_d8xMath..calculateLiquidationPriceCollateralBase) ⇒ <code>number</code>
     * [~calculateLiquidationPriceCollateralQuanto(LockedInValueQC, position, cash_cc, maintenance_margin_rate, S3, Sm)](#module_d8xMath..calculateLiquidationPriceCollateralQuanto) ⇒ <code>number</code>
     * [~calculateLiquidationPriceCollateralQuote(LockedInValueQC, position, cash_cc, maintenance_margin_rate, S3)](#module_d8xMath..calculateLiquidationPriceCollateralQuote) ⇒ <code>number</code>
     * [~getMarginRequiredForLeveragedTrade(targetLeverage, currentPosition, currentLockedInValue, tradeAmount, markPrice, indexPriceS2, indexPriceS3, tradePrice, feeRate)](#module_d8xMath..getMarginRequiredForLeveragedTrade) ⇒ <code>number</code>
     * [~getNewPositionLeverage(tradeAmount, marginCollateral, currentPosition, currentLockedInValue, price, indexPriceS3, markPrice)](#module_d8xMath..getNewPositionLeverage) ⇒
-    * [~getDepositAmountForLvgTrade(pos0, b0, tradeAmnt, targetLvg, price, S3, S2Mark)](#module_d8xMath..getDepositAmountForLvgTrade) ⇒ <code>number</code>
+    * [~getDepositAmountForLvgTrade(pos0, b0, tradeAmnt, targetLvg, price, S3, S2Mark, isPredMkt)](#module_d8xMath..getDepositAmountForLvgTrade) ⇒ <code>number</code>
+    * [~priceToProb(px)](#module_d8xMath..priceToProb) ⇒
+    * [~probToPrice(prob)](#module_d8xMath..probToPrice) ⇒
+    * [~pmMarginThresh(pos, s2, s3, m)](#module_d8xMath..pmMarginThresh) ⇒
+    * [~pmMaintenanceMarginRate(posSign, sm, m)](#module_d8xMath..pmMaintenanceMarginRate) ⇒
+    * [~pmInitialMarginRate(posSign, sm, m)](#module_d8xMath..pmInitialMarginRate) ⇒
+    * [~expectedLoss(p, m, totLong, totShort, tradeAmt, tradeMgnRate)](#module_d8xMath..expectedLoss)
+    * [~pmExchangeFee(prob, m, totShort, totLong, tradeAmt, tradeMgnRate)](#module_d8xMath..pmExchangeFee) ⇒
+    * [~pmMarginBalance(pos, s2, s3, ell, mc)](#module_d8xMath..pmMarginBalance) ⇒
+    * [~excessMargin(tradeAmt, currentCashCC, currentPos, currentLockedInQC, limitPrice, Sm, S3, totLong, totShort)](#module_d8xMath..excessMargin) ⇒
+    * [~pmFindMaxTradeSize(dir, currentPosition, currentCashCC, currentLockedInValue, limitPrice, Sm, S3, totLong, totShort, maxShort, maxLong)](#module_d8xMath..pmFindMaxTradeSize) ⇒
 
 <a name="module_d8xMath..ABDK29ToFloat"></a>
 
@@ -171,11 +204,11 @@ Result = x/2^64 if big number, x/2^29 if number</p>
 
 <a name="module_d8xMath..floatToABK64x64"></a>
 
-### d8xMath~floatToABK64x64(x) ⇒ <code>BigNumber</code>
+### d8xMath~floatToABK64x64(x) ⇒ <code>bigint</code>
 <p>Converts x into ABDK64x64 format</p>
 
 **Kind**: inner method of [<code>d8xMath</code>](#module_d8xMath)  
-**Returns**: <code>BigNumber</code> - <p>x^64 in big number format</p>  
+**Returns**: <code>bigint</code> - <p>x^64 in big number format</p>  
 
 | Param | Type | Description |
 | --- | --- | --- |
@@ -232,25 +265,25 @@ to for this lot-size</p>
 
 <a name="module_d8xMath..mul64x64"></a>
 
-### d8xMath~mul64x64(x, y) ⇒ <code>BigNumber</code>
+### d8xMath~mul64x64(x, y) ⇒ <code>bigint</code>
 **Kind**: inner method of [<code>d8xMath</code>](#module_d8xMath)  
-**Returns**: <code>BigNumber</code> - <p>x * y</p>  
+**Returns**: <code>bigint</code> - <p>x * y</p>  
 
 | Param | Type |
 | --- | --- |
-| x | <code>BigNumber</code> | 
-| y | <code>BigNumber</code> | 
+| x | <code>bigint</code> | 
+| y | <code>bigint</code> | 
 
 <a name="module_d8xMath..div64x64"></a>
 
-### d8xMath~div64x64(x, y) ⇒ <code>BigNumber</code>
+### d8xMath~div64x64(x, y) ⇒ <code>bigint</code>
 **Kind**: inner method of [<code>d8xMath</code>](#module_d8xMath)  
-**Returns**: <code>BigNumber</code> - <p>x / y</p>  
+**Returns**: <code>bigint</code> - <p>x / y</p>  
 
 | Param | Type |
 | --- | --- |
-| x | <code>BigNumber</code> | 
-| y | <code>BigNumber</code> | 
+| x | <code>bigint</code> | 
+| y | <code>bigint</code> | 
 
 <a name="module_d8xMath..calculateLiquidationPriceCollateralBase"></a>
 
@@ -339,7 +372,7 @@ to for this lot-size</p>
 
 <a name="module_d8xMath..getDepositAmountForLvgTrade"></a>
 
-### d8xMath~getDepositAmountForLvgTrade(pos0, b0, tradeAmnt, targetLvg, price, S3, S2Mark) ⇒ <code>number</code>
+### d8xMath~getDepositAmountForLvgTrade(pos0, b0, tradeAmnt, targetLvg, price, S3, S2Mark, isPredMkt) ⇒ <code>number</code>
 <p>Determine amount to be deposited into margin account so that the given leverage
 is obtained when trading a position pos (trade amount = position)
 Does NOT include fees
@@ -357,6 +390,169 @@ Smart contract equivalent: calcMarginForTargetLeverage(..., _ignorePosBalance =
 | price | <code>number</code> | <p>price to trade amount 'tradeAmnt'</p> |
 | S3 | <code>number</code> | <p>collateral to quote conversion (=S2 if base-collateral, =1 if quote collateral, = index S3 if quanto)</p> |
 | S2Mark | <code>number</code> | <p>mark price</p> |
+| isPredMkt | <code>boolean</code> | <p>true if prediction market</p> |
+
+<a name="module_d8xMath..priceToProb"></a>
+
+### d8xMath~priceToProb(px) ⇒
+<p>Convert a perpetual price to probability (predtictive markets)</p>
+
+**Kind**: inner method of [<code>d8xMath</code>](#module_d8xMath)  
+**Returns**: <p>Probability in [0,1]</p>  
+
+| Param | Description |
+| --- | --- |
+| px | <p>Perpetual price</p> |
+
+<a name="module_d8xMath..probToPrice"></a>
+
+### d8xMath~probToPrice(prob) ⇒
+<p>Convert a probability to a predictive market price</p>
+
+**Kind**: inner method of [<code>d8xMath</code>](#module_d8xMath)  
+**Returns**: <p>Perpetual price</p>  
+
+| Param | Description |
+| --- | --- |
+| prob | <p>Probability in [0,1]</p> |
+
+<a name="module_d8xMath..pmMarginThresh"></a>
+
+### d8xMath~pmMarginThresh(pos, s2, s3, m) ⇒
+<p>Maintenance margin requirement for prediction markets</p>
+
+**Kind**: inner method of [<code>d8xMath</code>](#module_d8xMath)  
+**Returns**: <p>required margin balance</p>  
+
+| Param | Default | Description |
+| --- | --- | --- |
+| pos |  | <p>signed position</p> |
+| s2 |  | <p>mark price</p> |
+| s3 |  | <p>collateral to quote conversion</p> |
+| m | <code>0.18</code> | <p>base margin rate</p> |
+
+<a name="module_d8xMath..pmMaintenanceMarginRate"></a>
+
+### d8xMath~pmMaintenanceMarginRate(posSign, sm, m) ⇒
+<p>Maintenance margin rate for prediction markets.</p>
+
+**Kind**: inner method of [<code>d8xMath</code>](#module_d8xMath)  
+**Returns**: <p>margin rate to be applied (Math.abs(pos) * p * tau) / s3;</p>  
+
+| Param | Default | Description |
+| --- | --- | --- |
+| posSign |  | <p>sign of position in base currency (can be signed position or -1, 1)</p> |
+| sm |  | <p>mark-price (=1+p)</p> |
+| m | <code>0.18</code> | <p>max margin rate from fInitialMarginRate</p> |
+
+<a name="module_d8xMath..pmInitialMarginRate"></a>
+
+### d8xMath~pmInitialMarginRate(posSign, sm, m) ⇒
+<p>Maintenance margin rate for prediction markets.</p>
+
+**Kind**: inner method of [<code>d8xMath</code>](#module_d8xMath)  
+**Returns**: <p>margin rate to be applied (Math.abs(pos) * p * tau) / s3;</p>  
+
+| Param | Default | Description |
+| --- | --- | --- |
+| posSign |  | <p>sign of position in base currency (can be signed position or -1, 1)</p> |
+| sm |  | <p>mark-price (=1+p)</p> |
+| m | <code>0.2</code> | <p>max margin rate from fMaintenanceMarginRate</p> |
+
+<a name="module_d8xMath..expectedLoss"></a>
+
+### d8xMath~expectedLoss(p, m, totLong, totShort, tradeAmt, tradeMgnRate)
+<p>Calculate the expected loss for a prediction market trade used for
+prediction market fees</p>
+
+**Kind**: inner method of [<code>d8xMath</code>](#module_d8xMath)  
+
+| Param | Description |
+| --- | --- |
+| p | <p>probability derived from mark price (long)</p> |
+| m | <p>maximal maintenance rate from which we defer the actual maintenance margin rate</p> |
+| totLong | <p>total long in base currency</p> |
+| totShort | <p>total short</p> |
+| tradeAmt | <p>signed trade amount, can be zero</p> |
+| tradeMgnRate | <p>margin rate of the trader</p> |
+
+<a name="module_d8xMath..pmExchangeFee"></a>
+
+### d8xMath~pmExchangeFee(prob, m, totShort, totLong, tradeAmt, tradeMgnRate) ⇒
+<p>Exchange fee as a rate for prediction markets</p>
+
+**Kind**: inner method of [<code>d8xMath</code>](#module_d8xMath)  
+**Returns**: <p>fee relative to tradeAmt</p>  
+
+| Param | Description |
+| --- | --- |
+| prob | <p>long probability</p> |
+| m | <p>max maintenance margin rate (0.18)</p> |
+| totShort |  |
+| totLong |  |
+| tradeAmt | <p>trade amount in base currency</p> |
+| tradeMgnRate | <p>margin rate for this trade</p> |
+
+<a name="module_d8xMath..pmMarginBalance"></a>
+
+### d8xMath~pmMarginBalance(pos, s2, s3, ell, mc) ⇒
+<p>Margin balance for prediction markets</p>
+
+**Kind**: inner method of [<code>d8xMath</code>](#module_d8xMath)  
+**Returns**: <p>current margin balance</p>  
+
+| Param | Description |
+| --- | --- |
+| pos | <p>signed position</p> |
+| s2 | <p>mark price</p> |
+| s3 | <p>collateral to quote conversion</p> |
+| ell | <p>locked in value</p> |
+| mc | <p>margin cash in collateral currency</p> |
+
+<a name="module_d8xMath..excessMargin"></a>
+
+### d8xMath~excessMargin(tradeAmt, currentCashCC, currentPos, currentLockedInQC, limitPrice, Sm, S3, totLong, totShort) ⇒
+<p>Calculate the excess margin defined as
+excess := margin balance - trading fee - initial margin threshold
+for the given trade and position</p>
+
+**Kind**: inner method of [<code>d8xMath</code>](#module_d8xMath)  
+**Returns**: <p>excess margin as defined above</p>  
+
+| Param |
+| --- |
+| tradeAmt | 
+| currentCashCC | 
+| currentPos | 
+| currentLockedInQC | 
+| limitPrice | 
+| Sm | 
+| S3 | 
+| totLong | 
+| totShort | 
+
+<a name="module_d8xMath..pmFindMaxTradeSize"></a>
+
+### d8xMath~pmFindMaxTradeSize(dir, currentPosition, currentCashCC, currentLockedInValue, limitPrice, Sm, S3, totLong, totShort, maxShort, maxLong) ⇒
+<p>Find maximal trade size (short dir=-1 or long dir=1) for prediction
+markets.</p>
+
+**Kind**: inner method of [<code>d8xMath</code>](#module_d8xMath)  
+**Returns**: <p>signed max trade size</p>  
+
+| Param |
+| --- |
+| dir | 
+| currentPosition | 
+| currentCashCC | 
+| currentLockedInValue | 
+| limitPrice | 
+| Sm | 
+| S3 | 
+| totLong | 
+| totShort | 
+| maxShort | 
+| maxLong | 
 
 <a name="module_utils"></a>
 
@@ -485,6 +681,7 @@ require gas-payments.</p>
     * [.getAddress()](#WriteAccessHandler+getAddress) ⇒ <code>string</code>
     * [.swapForMockToken(symbol, amountToPay)](#WriteAccessHandler+swapForMockToken) ⇒
     * [.getOrderBookContract(symbol)](#PerpetualDataHandler+getOrderBookContract) ⇒
+    * [.getOrderBookAddress(symbol)](#PerpetualDataHandler+getOrderBookAddress) ⇒
     * [.getPerpetuals(ids, overrides)](#PerpetualDataHandler+getPerpetuals) ⇒
     * [.getLiquidityPools(fromIdx, toIdx, overrides)](#PerpetualDataHandler+getLiquidityPools) ⇒
     * [._fillSymbolMaps()](#PerpetualDataHandler+_fillSymbolMaps)
@@ -509,6 +706,7 @@ require gas-payments.</p>
     * [.getMarginTokenDecimalsFromSymbol(symbol)](#PerpetualDataHandler+getMarginTokenDecimalsFromSymbol) ⇒
     * [.getSettlementTokenDecimalsFromSymbol(symbol)](#PerpetualDataHandler+getSettlementTokenDecimalsFromSymbol) ⇒
     * [.getABI(contract)](#PerpetualDataHandler+getABI) ⇒
+    * [.isPredictionMarket(symbol)](#PerpetualDataHandler+isPredictionMarket) ⇒
 
 <a name="new_AccountTrade_new"></a>
 
@@ -766,7 +964,7 @@ about perpetual currencies</p>
 
 **Kind**: instance method of [<code>AccountTrade</code>](#AccountTrade)  
 **Overrides**: [<code>setAllowance</code>](#WriteAccessHandler+setAllowance)  
-**Returns**: <p>ContractTransaction</p>  
+**Returns**: <p>Contract Transaction</p>  
 
 | Param | Description |
 | --- | --- |
@@ -809,6 +1007,19 @@ into a mock token used for trading on testnet, with a rate of 1:100_000</p>
 | --- | --- |
 | symbol | <p>symbol of the form ETH-USD-MATIC</p> |
 
+<a name="PerpetualDataHandler+getOrderBookAddress"></a>
+
+### accountTrade.getOrderBookAddress(symbol) ⇒
+<p>Returns the order-book contract for the symbol if found or fails</p>
+
+**Kind**: instance method of [<code>AccountTrade</code>](#AccountTrade)  
+**Overrides**: [<code>getOrderBookAddress</code>](#PerpetualDataHandler+getOrderBookAddress)  
+**Returns**: <p>order book contract for the perpetual</p>  
+
+| Param | Description |
+| --- | --- |
+| symbol | <p>symbol of the form ETH-USD-MATIC</p> |
+
 <a name="PerpetualDataHandler+getPerpetuals"></a>
 
 ### accountTrade.getPerpetuals(ids, overrides) ⇒
@@ -1166,6 +1377,19 @@ main();
 | --- | --- |
 | contract | <p>name of contract: proxy|lob|sharetoken</p> |
 
+<a name="PerpetualDataHandler+isPredictionMarket"></a>
+
+### accountTrade.isPredictionMarket(symbol) ⇒
+<p>Determines whether a given perpetual represents a prediction market</p>
+
+**Kind**: instance method of [<code>AccountTrade</code>](#AccountTrade)  
+**Overrides**: [<code>isPredictionMarket</code>](#PerpetualDataHandler+isPredictionMarket)  
+**Returns**: <p>True if this is a prediction market</p>  
+
+| Param | Description |
+| --- | --- |
+| symbol | <p>perpetual symbol of the form TRUMP24-USD-USDC</p> |
+
 <a name="BrokerTool"></a>
 
 ## BrokerTool ⇐ [<code>WriteAccessHandler</code>](#WriteAccessHandler)
@@ -1195,6 +1419,7 @@ require gas-payments.</p>
     * [.getAddress()](#WriteAccessHandler+getAddress) ⇒ <code>string</code>
     * [.swapForMockToken(symbol, amountToPay)](#WriteAccessHandler+swapForMockToken) ⇒
     * [.getOrderBookContract(symbol)](#PerpetualDataHandler+getOrderBookContract) ⇒
+    * [.getOrderBookAddress(symbol)](#PerpetualDataHandler+getOrderBookAddress) ⇒
     * [.getPerpetuals(ids, overrides)](#PerpetualDataHandler+getPerpetuals) ⇒
     * [.getLiquidityPools(fromIdx, toIdx, overrides)](#PerpetualDataHandler+getLiquidityPools) ⇒
     * [._fillSymbolMaps()](#PerpetualDataHandler+_fillSymbolMaps)
@@ -1219,6 +1444,7 @@ require gas-payments.</p>
     * [.getMarginTokenDecimalsFromSymbol(symbol)](#PerpetualDataHandler+getMarginTokenDecimalsFromSymbol) ⇒
     * [.getSettlementTokenDecimalsFromSymbol(symbol)](#PerpetualDataHandler+getSettlementTokenDecimalsFromSymbol) ⇒
     * [.getABI(contract)](#PerpetualDataHandler+getABI) ⇒
+    * [.isPredictionMarket(symbol)](#PerpetualDataHandler+isPredictionMarket) ⇒
 
 <a name="new_BrokerTool_new"></a>
 
@@ -1372,10 +1598,12 @@ main();
 ### brokerTool.determineExchangeFee(order, traderAddr) ⇒ <code>number</code>
 <p>Determine exchange fee based on an order and a trader.
 This is the fee charged by the exchange only, excluding the white-label partner fee,
-and it takes into account whether the order given here has been signed by a white-label partner or not.
+For regular perpetuals, the result takes into account whether the order given here has been
+signed by a white-label partner or not.
 Use this, for instance, to verify that the fee to be charged for a given order is as expected,
 before and after signing it with brokerTool.signOrder.
 This fee is equal or lower than the white-label partner induced fee, provided the order is properly signed.</p>
+<p>For prediction markets, the correct fee is to be applied as tradeamt * fee/s3.</p>
 
 **Kind**: instance method of [<code>BrokerTool</code>](#BrokerTool)  
 **Returns**: <code>number</code> - <p>Fee in decimals (i.e. 0.1% is 0.001).</p>  
@@ -1577,7 +1805,7 @@ to be routed through this white-label partner and benefits from the white-label
 
 | Param | Type | Description |
 | --- | --- | --- |
-| scOrder | <code>SmartContractOrder</code> | <p>Order to sign. It must contain valid white-label partner fee, white-label partner address, and order deadline.</p> |
+| scOrder | [<code>SmartContractOrder</code>](#SmartContractOrder) | <p>Order to sign. It must contain valid white-label partner fee, white-label partner address, and order deadline.</p> |
 | traderAddr | <code>string</code> | <p>Address of trader submitting the order.</p> |
 
 **Example**  
@@ -1658,7 +1886,7 @@ about perpetual currencies</p>
 
 **Kind**: instance method of [<code>BrokerTool</code>](#BrokerTool)  
 **Overrides**: [<code>setAllowance</code>](#WriteAccessHandler+setAllowance)  
-**Returns**: <p>ContractTransaction</p>  
+**Returns**: <p>Contract Transaction</p>  
 
 | Param | Description |
 | --- | --- |
@@ -1701,6 +1929,19 @@ into a mock token used for trading on testnet, with a rate of 1:100_000</p>
 | --- | --- |
 | symbol | <p>symbol of the form ETH-USD-MATIC</p> |
 
+<a name="PerpetualDataHandler+getOrderBookAddress"></a>
+
+### brokerTool.getOrderBookAddress(symbol) ⇒
+<p>Returns the order-book contract for the symbol if found or fails</p>
+
+**Kind**: instance method of [<code>BrokerTool</code>](#BrokerTool)  
+**Overrides**: [<code>getOrderBookAddress</code>](#PerpetualDataHandler+getOrderBookAddress)  
+**Returns**: <p>order book contract for the perpetual</p>  
+
+| Param | Description |
+| --- | --- |
+| symbol | <p>symbol of the form ETH-USD-MATIC</p> |
+
 <a name="PerpetualDataHandler+getPerpetuals"></a>
 
 ### brokerTool.getPerpetuals(ids, overrides) ⇒
@@ -2058,6 +2299,19 @@ main();
 | --- | --- |
 | contract | <p>name of contract: proxy|lob|sharetoken</p> |
 
+<a name="PerpetualDataHandler+isPredictionMarket"></a>
+
+### brokerTool.isPredictionMarket(symbol) ⇒
+<p>Determines whether a given perpetual represents a prediction market</p>
+
+**Kind**: instance method of [<code>BrokerTool</code>](#BrokerTool)  
+**Overrides**: [<code>isPredictionMarket</code>](#PerpetualDataHandler+isPredictionMarket)  
+**Returns**: <p>True if this is a prediction market</p>  
+
+| Param | Description |
+| --- | --- |
+| symbol | <p>perpetual symbol of the form TRUMP24-USD-USDC</p> |
+
 <a name="LiquidatorTool"></a>
 
 ## LiquidatorTool ⇐ [<code>WriteAccessHandler</code>](#WriteAccessHandler)
@@ -2079,6 +2333,7 @@ and executes smart-contract interactions that require gas-payments.</p>
     * [.getAddress()](#WriteAccessHandler+getAddress) ⇒ <code>string</code>
     * [.swapForMockToken(symbol, amountToPay)](#WriteAccessHandler+swapForMockToken) ⇒
     * [.getOrderBookContract(symbol)](#PerpetualDataHandler+getOrderBookContract) ⇒
+    * [.getOrderBookAddress(symbol)](#PerpetualDataHandler+getOrderBookAddress) ⇒
     * [.getPerpetuals(ids, overrides)](#PerpetualDataHandler+getPerpetuals) ⇒
     * [.getLiquidityPools(fromIdx, toIdx, overrides)](#PerpetualDataHandler+getLiquidityPools) ⇒
     * [._fillSymbolMaps()](#PerpetualDataHandler+_fillSymbolMaps)
@@ -2103,6 +2358,7 @@ and executes smart-contract interactions that require gas-payments.</p>
     * [.getMarginTokenDecimalsFromSymbol(symbol)](#PerpetualDataHandler+getMarginTokenDecimalsFromSymbol) ⇒
     * [.getSettlementTokenDecimalsFromSymbol(symbol)](#PerpetualDataHandler+getSettlementTokenDecimalsFromSymbol) ⇒
     * [.getABI(contract)](#PerpetualDataHandler+getABI) ⇒
+    * [.isPredictionMarket(symbol)](#PerpetualDataHandler+isPredictionMarket) ⇒
 
 <a name="new_LiquidatorTool_new"></a>
 
@@ -2302,7 +2558,7 @@ about perpetual currencies</p>
 
 **Kind**: instance method of [<code>LiquidatorTool</code>](#LiquidatorTool)  
 **Overrides**: [<code>setAllowance</code>](#WriteAccessHandler+setAllowance)  
-**Returns**: <p>ContractTransaction</p>  
+**Returns**: <p>Contract Transaction</p>  
 
 | Param | Description |
 | --- | --- |
@@ -2345,6 +2601,19 @@ into a mock token used for trading on testnet, with a rate of 1:100_000</p>
 | --- | --- |
 | symbol | <p>symbol of the form ETH-USD-MATIC</p> |
 
+<a name="PerpetualDataHandler+getOrderBookAddress"></a>
+
+### liquidatorTool.getOrderBookAddress(symbol) ⇒
+<p>Returns the order-book contract for the symbol if found or fails</p>
+
+**Kind**: instance method of [<code>LiquidatorTool</code>](#LiquidatorTool)  
+**Overrides**: [<code>getOrderBookAddress</code>](#PerpetualDataHandler+getOrderBookAddress)  
+**Returns**: <p>order book contract for the perpetual</p>  
+
+| Param | Description |
+| --- | --- |
+| symbol | <p>symbol of the form ETH-USD-MATIC</p> |
+
 <a name="PerpetualDataHandler+getPerpetuals"></a>
 
 ### liquidatorTool.getPerpetuals(ids, overrides) ⇒
@@ -2702,6 +2971,19 @@ main();
 | --- | --- |
 | contract | <p>name of contract: proxy|lob|sharetoken</p> |
 
+<a name="PerpetualDataHandler+isPredictionMarket"></a>
+
+### liquidatorTool.isPredictionMarket(symbol) ⇒
+<p>Determines whether a given perpetual represents a prediction market</p>
+
+**Kind**: instance method of [<code>LiquidatorTool</code>](#LiquidatorTool)  
+**Overrides**: [<code>isPredictionMarket</code>](#PerpetualDataHandler+isPredictionMarket)  
+**Returns**: <p>True if this is a prediction market</p>  
+
+| Param | Description |
+| --- | --- |
+| symbol | <p>perpetual symbol of the form TRUMP24-USD-USDC</p> |
+
 <a name="LiquidityProviderTool"></a>
 
 ## LiquidityProviderTool ⇐ [<code>WriteAccessHandler</code>](#WriteAccessHandler)
@@ -2721,6 +3003,7 @@ smart-contract interactions that require gas-payments.</p>
     * [.getAddress()](#WriteAccessHandler+getAddress) ⇒ <code>string</code>
     * [.swapForMockToken(symbol, amountToPay)](#WriteAccessHandler+swapForMockToken) ⇒
     * [.getOrderBookContract(symbol)](#PerpetualDataHandler+getOrderBookContract) ⇒
+    * [.getOrderBookAddress(symbol)](#PerpetualDataHandler+getOrderBookAddress) ⇒
     * [.getPerpetuals(ids, overrides)](#PerpetualDataHandler+getPerpetuals) ⇒
     * [.getLiquidityPools(fromIdx, toIdx, overrides)](#PerpetualDataHandler+getLiquidityPools) ⇒
     * [._fillSymbolMaps()](#PerpetualDataHandler+_fillSymbolMaps)
@@ -2745,6 +3028,7 @@ smart-contract interactions that require gas-payments.</p>
     * [.getMarginTokenDecimalsFromSymbol(symbol)](#PerpetualDataHandler+getMarginTokenDecimalsFromSymbol) ⇒
     * [.getSettlementTokenDecimalsFromSymbol(symbol)](#PerpetualDataHandler+getSettlementTokenDecimalsFromSymbol) ⇒
     * [.getABI(contract)](#PerpetualDataHandler+getABI) ⇒
+    * [.isPredictionMarket(symbol)](#PerpetualDataHandler+isPredictionMarket) ⇒
 
 <a name="new_LiquidityProviderTool_new"></a>
 
@@ -2883,7 +3167,7 @@ about perpetual currencies</p>
 
 **Kind**: instance method of [<code>LiquidityProviderTool</code>](#LiquidityProviderTool)  
 **Overrides**: [<code>setAllowance</code>](#WriteAccessHandler+setAllowance)  
-**Returns**: <p>ContractTransaction</p>  
+**Returns**: <p>Contract Transaction</p>  
 
 | Param | Description |
 | --- | --- |
@@ -2926,6 +3210,19 @@ into a mock token used for trading on testnet, with a rate of 1:100_000</p>
 | --- | --- |
 | symbol | <p>symbol of the form ETH-USD-MATIC</p> |
 
+<a name="PerpetualDataHandler+getOrderBookAddress"></a>
+
+### liquidityProviderTool.getOrderBookAddress(symbol) ⇒
+<p>Returns the order-book contract for the symbol if found or fails</p>
+
+**Kind**: instance method of [<code>LiquidityProviderTool</code>](#LiquidityProviderTool)  
+**Overrides**: [<code>getOrderBookAddress</code>](#PerpetualDataHandler+getOrderBookAddress)  
+**Returns**: <p>order book contract for the perpetual</p>  
+
+| Param | Description |
+| --- | --- |
+| symbol | <p>symbol of the form ETH-USD-MATIC</p> |
+
 <a name="PerpetualDataHandler+getPerpetuals"></a>
 
 ### liquidityProviderTool.getPerpetuals(ids, overrides) ⇒
@@ -3283,6 +3580,19 @@ main();
 | --- | --- |
 | contract | <p>name of contract: proxy|lob|sharetoken</p> |
 
+<a name="PerpetualDataHandler+isPredictionMarket"></a>
+
+### liquidityProviderTool.isPredictionMarket(symbol) ⇒
+<p>Determines whether a given perpetual represents a prediction market</p>
+
+**Kind**: instance method of [<code>LiquidityProviderTool</code>](#LiquidityProviderTool)  
+**Overrides**: [<code>isPredictionMarket</code>](#PerpetualDataHandler+isPredictionMarket)  
+**Returns**: <p>True if this is a prediction market</p>  
+
+| Param | Description |
+| --- | --- |
+| symbol | <p>perpetual symbol of the form TRUMP24-USD-USDC</p> |
+
 <a name="MarketData"></a>
 
 ## MarketData ⇐ [<code>PerpetualDataHandler</code>](#PerpetualDataHandler)
@@ -3295,61 +3605,67 @@ No gas required for the queries here.</p>
 
 * [MarketData](#MarketData) ⇐ [<code>PerpetualDataHandler</code>](#PerpetualDataHandler)
     * [new MarketData(config)](#new_MarketData_new)
-    * [.createProxyInstance(providerOrMarketData)](#MarketData+createProxyInstance)
-    * [.getProxyAddress()](#MarketData+getProxyAddress) ⇒ <code>string</code>
-    * [.getTriangulations()](#MarketData+getTriangulations) ⇒
-    * [.smartContractOrderToOrder(smOrder)](#MarketData+smartContractOrderToOrder) ⇒ <code>Order</code>
-    * [.getReadOnlyProxyInstance()](#MarketData+getReadOnlyProxyInstance) ⇒ <code>Contract</code>
-    * [.exchangeInfo()](#MarketData+exchangeInfo) ⇒ <code>ExchangeInfo</code>
-    * [.openOrders(traderAddr, symbol)](#MarketData+openOrders) ⇒
-    * [.positionRisk(traderAddr, symbol)](#MarketData+positionRisk) ⇒ <code>Array.&lt;MarginAccount&gt;</code>
-    * [.positionRiskOnTrade(traderAddr, order, account, indexPriceInfo)](#MarketData+positionRiskOnTrade) ⇒
-    * [.positionRiskOnCollateralAction(deltaCollateral, account)](#MarketData+positionRiskOnCollateralAction) ⇒ <code>MarginAccount</code>
-    * [.getWalletBalance(address, symbol)](#MarketData+getWalletBalance) ⇒
-    * [.getPoolShareTokenBalance(address, symbolOrId)](#MarketData+getPoolShareTokenBalance) ⇒ <code>number</code>
-    * [.getShareTokenPrice(symbolOrId)](#MarketData+getShareTokenPrice) ⇒ <code>number</code>
-    * [.getParticipationValue(address, symbolOrId)](#MarketData+getParticipationValue) ⇒
-    * [.maxOrderSizeForTrader(traderAddr, symbol)](#MarketData+maxOrderSizeForTrader) ⇒
-    * [.maxSignedPosition(side, symbol)](#MarketData+maxSignedPosition) ⇒ <code>number</code>
-    * [.getOraclePrice(base, quote)](#MarketData+getOraclePrice) ⇒ <code>number</code>
-    * [.getOrderStatus(symbol, orderId, overrides)](#MarketData+getOrderStatus) ⇒
-    * [.getOrdersStatus(symbol, orderId)](#MarketData+getOrdersStatus) ⇒
-    * [.getMarkPrice(symbol)](#MarketData+getMarkPrice) ⇒ <code>number</code>
-    * [.getPerpetualPrice(symbol, quantity)](#MarketData+getPerpetualPrice) ⇒ <code>number</code>
-    * [.getPerpetualState(symbol)](#MarketData+getPerpetualState) ⇒ <code>PerpetualState</code>
-    * [.getPoolState(poolSymbol)](#MarketData+getPoolState) ⇒ <code>PoolState</code>
-    * [.getPerpetualStaticInfo(symbol)](#MarketData+getPerpetualStaticInfo) ⇒ <code>PerpetualStaticInfo</code>
-    * [.getPerpetualMidPrice(symbol)](#MarketData+getPerpetualMidPrice) ⇒ <code>number</code>
-    * [.getAvailableMargin(traderAddr, symbol, indexPrices)](#MarketData+getAvailableMargin) ⇒
-    * [.getTraderLoyalityScore(traderAddr)](#MarketData+getTraderLoyalityScore) ⇒ <code>number</code>
-    * [.isMarketClosed(symbol)](#MarketData+isMarketClosed) ⇒ <code>boolean</code>
-    * [.getPriceInUSD(symbol)](#MarketData+getPriceInUSD) ⇒ <code>Map.&lt;string, number&gt;</code>
-    * [.fetchPricesForPerpetual(symbol)](#MarketData+fetchPricesForPerpetual) ⇒
-    * [.getOrderBookContract(symbol)](#PerpetualDataHandler+getOrderBookContract) ⇒
-    * [.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) ⇒
+    * _instance_
+        * [.createProxyInstance(providerOrMarketData)](#MarketData+createProxyInstance)
+        * [.getProxyAddress()](#MarketData+getProxyAddress) ⇒ <code>string</code>
+        * [.getTriangulations()](#MarketData+getTriangulations) ⇒
+        * [.smartContractOrderToOrder(smOrder)](#MarketData+smartContractOrderToOrder) ⇒ <code>Order</code>
+        * [.getReadOnlyProxyInstance()](#MarketData+getReadOnlyProxyInstance) ⇒
+        * [.exchangeInfo()](#MarketData+exchangeInfo) ⇒ [<code>ExchangeInfo</code>](#ExchangeInfo)
+        * [.openOrders(traderAddr, symbol)](#MarketData+openOrders) ⇒
+        * [.positionRisk(traderAddr, symbol)](#MarketData+positionRisk) ⇒ <code>Array.&lt;MarginAccount&gt;</code>
+        * [.positionRiskOnTrade(traderAddr, order, signedPositionNotionalBaseCCY, tradingFeeTbps, indexPriceInfo)](#MarketData+positionRiskOnTrade) ⇒
+        * [.positionRiskOnCollateralAction(deltaCollateral, account)](#MarketData+positionRiskOnCollateralAction) ⇒ <code>MarginAccount</code>
+        * [.getWalletBalance(address, symbol)](#MarketData+getWalletBalance) ⇒
+        * [.getPoolShareTokenBalance(address, symbolOrId)](#MarketData+getPoolShareTokenBalance) ⇒ <code>number</code>
+        * [.getShareTokenPrice(symbolOrId)](#MarketData+getShareTokenPrice) ⇒ <code>number</code>
+        * [.getParticipationValue(address, symbolOrId)](#MarketData+getParticipationValue) ⇒
+        * [.maxOrderSizeForTrader(traderAddr, symbol)](#MarketData+maxOrderSizeForTrader) ⇒
+        * [.getMaxShortLongPos(perpId, currentTraderPos, overrides)](#MarketData+getMaxShortLongPos) ⇒
+        * [.maxSignedPosition(side, symbol)](#MarketData+maxSignedPosition) ⇒ <code>number</code>
+        * [.getOraclePrice(base, quote)](#MarketData+getOraclePrice) ⇒ <code>number</code>
+        * [.getOrderStatus(symbol, orderId, overrides)](#MarketData+getOrderStatus) ⇒
+        * [.getOrdersStatus(symbol, orderId)](#MarketData+getOrdersStatus) ⇒
+        * [.getMarkPrice(symbol, indexPrices)](#MarketData+getMarkPrice) ⇒ <code>number</code>
+        * [.getPerpetualPrice(symbol, quantity, priceInfo)](#MarketData+getPerpetualPrice) ⇒ <code>number</code>
+        * [.getPerpetualState(symbol)](#MarketData+getPerpetualState) ⇒ <code>PerpetualState</code>
+        * [.getPoolState(poolSymbol)](#MarketData+getPoolState) ⇒ [<code>PoolState</code>](#PoolState)
+        * [.getPerpetualStaticInfo(symbol)](#MarketData+getPerpetualStaticInfo) ⇒ <code>PerpetualStaticInfo</code>
+        * [.getPerpetualMidPrice(symbol)](#MarketData+getPerpetualMidPrice) ⇒ <code>number</code>
+        * [.getAvailableMargin(traderAddr, symbol, indexPrices)](#MarketData+getAvailableMargin) ⇒
+        * [.getTraderLoyalityScore(traderAddr)](#MarketData+getTraderLoyalityScore) ⇒ <code>number</code>
+        * [.isMarketClosed(symbol)](#MarketData+isMarketClosed) ⇒ <code>boolean</code>
+        * [.getPriceInUSD(symbol)](#MarketData+getPriceInUSD) ⇒ <code>Map.&lt;string, number&gt;</code>
+        * [.fetchPricesForPerpetual(symbol)](#MarketData+fetchPricesForPerpetual) ⇒
+        * [.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) ⇒
+    * _static_
+        * [.exchangeFeePrdMkts(state, maxMaintMgnRate, Sm, tradeAmtBC, tradeMgnRate)](#MarketData.exchangeFeePrdMkts) ⇒
 
 <a name="new_MarketData_new"></a>
 
@@ -3412,15 +3728,15 @@ about perpetual currencies</p>
 
 | Param | Type | Description |
 | --- | --- | --- |
-| smOrder | <code>SmartContractOrder</code> | <p>SmartContractOrder, as obtained e.g., by PerpetualLimitOrderCreated event</p> |
+| smOrder | [<code>SmartContractOrder</code>](#SmartContractOrder) | <p>SmartContractOrder, as obtained e.g., by PerpetualLimitOrderCreated event</p> |
 
 <a name="MarketData+getReadOnlyProxyInstance"></a>
 
-### marketData.getReadOnlyProxyInstance() ⇒ <code>Contract</code>
+### marketData.getReadOnlyProxyInstance() ⇒
 <p>Get contract instance. Useful for event listening.</p>
 
 **Kind**: instance method of [<code>MarketData</code>](#MarketData)  
-**Returns**: <code>Contract</code> - <p>read-only proxy instance</p>  
+**Returns**: <p>read-only proxy instance</p>  
 **Example**  
 ```js
 import { MarketData, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
@@ -3438,11 +3754,11 @@ main();
 ```
 <a name="MarketData+exchangeInfo"></a>
 
-### marketData.exchangeInfo() ⇒ <code>ExchangeInfo</code>
+### marketData.exchangeInfo() ⇒ [<code>ExchangeInfo</code>](#ExchangeInfo)
 <p>Information about the products traded in the exchange.</p>
 
 **Kind**: instance method of [<code>MarketData</code>](#MarketData)  
-**Returns**: <code>ExchangeInfo</code> - <p>Array of static data for all the pools and perpetuals in the system.</p>  
+**Returns**: [<code>ExchangeInfo</code>](#ExchangeInfo) - <p>Array of static data for all the pools and perpetuals in the system.</p>  
 **Example**  
 ```js
 import { MarketData, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
@@ -3519,7 +3835,7 @@ main();
 ```
 <a name="MarketData+positionRiskOnTrade"></a>
 
-### marketData.positionRiskOnTrade(traderAddr, order, account, indexPriceInfo) ⇒
+### marketData.positionRiskOnTrade(traderAddr, order, signedPositionNotionalBaseCCY, tradingFeeTbps, indexPriceInfo) ⇒
 <p>Estimates what the position risk will be if a given order is executed.</p>
 
 **Kind**: instance method of [<code>MarketData</code>](#MarketData)  
@@ -3529,7 +3845,8 @@ main();
 | --- | --- |
 | traderAddr | <p>Address of trader</p> |
 | order | <p>Order to be submitted</p> |
-| account | <p>Position risk before trade. Defaults to current position if not given.</p> |
+| signedPositionNotionalBaseCCY | <p>signed position notional of current position (before trade)</p> |
+| tradingFeeTbps | <p>trading fee in tenth of basis points (exchange fee and broker fee)</p> |
 | indexPriceInfo | <p>Index prices and market status (open/closed). Defaults to current market status if not given.</p> |
 
 **Example**  
@@ -3550,7 +3867,7 @@ async function main() {
        executionTimestamp: Date.now()/1000,
    };
   // Get position risk conditional on this order being executed
-  const posRisk = await mktData.positionRiskOnTrade("0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B", order);
+  const posRisk = await mktData.positionRiskOnTrade("0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B", order, 0, 60);
   console.log(posRisk);
 }
 main();
@@ -3728,6 +4045,21 @@ async function main() {
 }
 main();
 ```
+<a name="MarketData+getMaxShortLongPos"></a>
+
+### marketData.getMaxShortLongPos(perpId, currentTraderPos, overrides) ⇒
+<p>Returns the maximal allowed short pos and long pos (signed) for a trader
+with given notional (in ABDK format) in the perpetual, ignoring the traders wallet balance</p>
+
+**Kind**: instance method of [<code>MarketData</code>](#MarketData)  
+**Returns**: <p>[maxShortPos, maxLongPos] signed maximal position sizes</p>  
+
+| Param | Description |
+| --- | --- |
+| perpId |  |
+| currentTraderPos | <p>ABDK64x64 notional position of trader</p> |
+| overrides |  |
+
 <a name="MarketData+maxSignedPosition"></a>
 
 ### marketData.maxSignedPosition(side, symbol) ⇒ <code>number</code>
@@ -3843,7 +4175,7 @@ main();
 ```
 <a name="MarketData+getMarkPrice"></a>
 
-### marketData.getMarkPrice(symbol) ⇒ <code>number</code>
+### marketData.getMarkPrice(symbol, indexPrices) ⇒ <code>number</code>
 <p>Get the current mark price</p>
 
 **Kind**: instance method of [<code>MarketData</code>](#MarketData)  
@@ -3852,6 +4184,7 @@ main();
 | Param | Description |
 | --- | --- |
 | symbol | <p>symbol of the form ETH-USD-MATIC</p> |
+| indexPrices | <p>optional. IdxPriceInfo</p> |
 
 **Example**  
 ```js
@@ -3870,7 +4203,7 @@ main();
 ```
 <a name="MarketData+getPerpetualPrice"></a>
 
-### marketData.getPerpetualPrice(symbol, quantity) ⇒ <code>number</code>
+### marketData.getPerpetualPrice(symbol, quantity, priceInfo) ⇒ <code>number</code>
 <p>get the current price for a given quantity</p>
 
 **Kind**: instance method of [<code>MarketData</code>](#MarketData)  
@@ -3880,6 +4213,7 @@ main();
 | --- | --- |
 | symbol | <p>symbol of the form ETH-USD-MATIC</p> |
 | quantity | <p>quantity to be traded, negative if short</p> |
+| priceInfo | <p>[s2, s3, conf, params]; for non-prediction markets conf/params can be 0</p> |
 
 **Example**  
 ```js
@@ -3910,11 +4244,11 @@ main();
 
 <a name="MarketData+getPoolState"></a>
 
-### marketData.getPoolState(poolSymbol) ⇒ <code>PoolState</code>
+### marketData.getPoolState(poolSymbol) ⇒ [<code>PoolState</code>](#PoolState)
 <p>Query recent pool state from blockchain, not including perpetual states</p>
 
 **Kind**: instance method of [<code>MarketData</code>](#MarketData)  
-**Returns**: <code>PoolState</code> - <p>PoolState copy</p>  
+**Returns**: [<code>PoolState</code>](#PoolState) - <p>PoolState copy</p>  
 
 | Param | Type | Description |
 | --- | --- | --- |
@@ -3973,7 +4307,7 @@ Result is in collateral currency</p>
 | --- | --- | --- |
 | traderAddr | <code>string</code> | <p>address of the trader</p> |
 | symbol | <code>string</code> | <p>perpetual symbol of the form BTC-USD-MATIC</p> |
-| indexPrices |  | <p>optional index prices, will otherwise fetch from REST API</p> |
+| indexPrices |  | <p>optional indexPriceInfo</p> |
 
 **Example**  
 ```js
@@ -4096,6 +4430,19 @@ main();
 | --- | --- |
 | symbol | <p>symbol of the form ETH-USD-MATIC</p> |
 
+<a name="PerpetualDataHandler+getOrderBookAddress"></a>
+
+### marketData.getOrderBookAddress(symbol) ⇒
+<p>Returns the order-book contract for the symbol if found or fails</p>
+
+**Kind**: instance method of [<code>MarketData</code>](#MarketData)  
+**Overrides**: [<code>getOrderBookAddress</code>](#PerpetualDataHandler+getOrderBookAddress)  
+**Returns**: <p>order book contract for the perpetual</p>  
+
+| Param | Description |
+| --- | --- |
+| symbol | <p>symbol of the form ETH-USD-MATIC</p> |
+
 <a name="PerpetualDataHandler+getPerpetuals"></a>
 
 ### marketData.getPerpetuals(ids, overrides) ⇒
@@ -4453,6 +4800,35 @@ main();
 | --- | --- |
 | contract | <p>name of contract: proxy|lob|sharetoken</p> |
 
+<a name="PerpetualDataHandler+isPredictionMarket"></a>
+
+### marketData.isPredictionMarket(symbol) ⇒
+<p>Determines whether a given perpetual represents a prediction market</p>
+
+**Kind**: instance method of [<code>MarketData</code>](#MarketData)  
+**Overrides**: [<code>isPredictionMarket</code>](#PerpetualDataHandler+isPredictionMarket)  
+**Returns**: <p>True if this is a prediction market</p>  
+
+| Param | Description |
+| --- | --- |
+| symbol | <p>perpetual symbol of the form TRUMP24-USD-USDC</p> |
+
+<a name="MarketData.exchangeFeePrdMkts"></a>
+
+### MarketData.exchangeFeePrdMkts(state, maxMaintMgnRate, Sm, tradeAmtBC, tradeMgnRate) ⇒
+<p>Fee is relative to base-currency amount (=trade amount)</p>
+
+**Kind**: static method of [<code>MarketData</code>](#MarketData)  
+**Returns**: <p>relative exchange fee in decimals</p>  
+
+| Param | Description |
+| --- | --- |
+| state | <p>current perpetual state (need longBC and shortBC)</p> |
+| maxMaintMgnRate | <p>maintenance margin rate param for pred mkts</p> |
+| Sm | <p>Mark price</p> |
+| tradeAmtBC | <p>signed trade amount</p> |
+| tradeMgnRate | <p>margin rate param from perpetual</p> |
+
 <a name="OnChainPxFeed"></a>
 
 ## OnChainPxFeed
@@ -4495,6 +4871,7 @@ gas-payments.</p>
     * [.getAddress()](#WriteAccessHandler+getAddress) ⇒ <code>string</code>
     * [.swapForMockToken(symbol, amountToPay)](#WriteAccessHandler+swapForMockToken) ⇒
     * [.getOrderBookContract(symbol)](#PerpetualDataHandler+getOrderBookContract) ⇒
+    * [.getOrderBookAddress(symbol)](#PerpetualDataHandler+getOrderBookAddress) ⇒
     * [.getPerpetuals(ids, overrides)](#PerpetualDataHandler+getPerpetuals) ⇒
     * [.getLiquidityPools(fromIdx, toIdx, overrides)](#PerpetualDataHandler+getLiquidityPools) ⇒
     * [._fillSymbolMaps()](#PerpetualDataHandler+_fillSymbolMaps)
@@ -4519,6 +4896,7 @@ gas-payments.</p>
     * [.getMarginTokenDecimalsFromSymbol(symbol)](#PerpetualDataHandler+getMarginTokenDecimalsFromSymbol) ⇒
     * [.getSettlementTokenDecimalsFromSymbol(symbol)](#PerpetualDataHandler+getSettlementTokenDecimalsFromSymbol) ⇒
     * [.getABI(contract)](#PerpetualDataHandler+getABI) ⇒
+    * [.isPredictionMarket(symbol)](#PerpetualDataHandler+isPredictionMarket) ⇒
 
 <a name="new_OrderExecutorTool_new"></a>
 
@@ -4764,7 +5142,7 @@ about perpetual currencies</p>
 
 **Kind**: instance method of [<code>OrderExecutorTool</code>](#OrderExecutorTool)  
 **Overrides**: [<code>setAllowance</code>](#WriteAccessHandler+setAllowance)  
-**Returns**: <p>ContractTransaction</p>  
+**Returns**: <p>Contract Transaction</p>  
 
 | Param | Description |
 | --- | --- |
@@ -4807,6 +5185,19 @@ into a mock token used for trading on testnet, with a rate of 1:100_000</p>
 | --- | --- |
 | symbol | <p>symbol of the form ETH-USD-MATIC</p> |
 
+<a name="PerpetualDataHandler+getOrderBookAddress"></a>
+
+### orderExecutorTool.getOrderBookAddress(symbol) ⇒
+<p>Returns the order-book contract for the symbol if found or fails</p>
+
+**Kind**: instance method of [<code>OrderExecutorTool</code>](#OrderExecutorTool)  
+**Overrides**: [<code>getOrderBookAddress</code>](#PerpetualDataHandler+getOrderBookAddress)  
+**Returns**: <p>order book contract for the perpetual</p>  
+
+| Param | Description |
+| --- | --- |
+| symbol | <p>symbol of the form ETH-USD-MATIC</p> |
+
 <a name="PerpetualDataHandler+getPerpetuals"></a>
 
 ### orderExecutorTool.getPerpetuals(ids, overrides) ⇒
@@ -5164,6 +5555,19 @@ main();
 | --- | --- |
 | contract | <p>name of contract: proxy|lob|sharetoken</p> |
 
+<a name="PerpetualDataHandler+isPredictionMarket"></a>
+
+### orderExecutorTool.isPredictionMarket(symbol) ⇒
+<p>Determines whether a given perpetual represents a prediction market</p>
+
+**Kind**: instance method of [<code>OrderExecutorTool</code>](#OrderExecutorTool)  
+**Overrides**: [<code>isPredictionMarket</code>](#PerpetualDataHandler+isPredictionMarket)  
+**Returns**: <p>True if this is a prediction market</p>  
+
+| Param | Description |
+| --- | --- |
+| symbol | <p>perpetual symbol of the form TRUMP24-USD-USDC</p> |
+
 <a name="PerpetualDataHandler"></a>
 
 ## PerpetualDataHandler
@@ -5176,6 +5580,7 @@ common data and chain operations.</p>
     * [new PerpetualDataHandler(config)](#new_PerpetualDataHandler_new)
     * _instance_
         * [.getOrderBookContract(symbol)](#PerpetualDataHandler+getOrderBookContract) ⇒
+        * [.getOrderBookAddress(symbol)](#PerpetualDataHandler+getOrderBookAddress) ⇒
         * [.getPerpetuals(ids, overrides)](#PerpetualDataHandler+getPerpetuals) ⇒
         * [.getLiquidityPools(fromIdx, toIdx, overrides)](#PerpetualDataHandler+getLiquidityPools) ⇒
         * [._fillSymbolMaps()](#PerpetualDataHandler+_fillSymbolMaps)
@@ -5200,13 +5605,16 @@ common data and chain operations.</p>
         * [.getMarginTokenDecimalsFromSymbol(symbol)](#PerpetualDataHandler+getMarginTokenDecimalsFromSymbol) ⇒
         * [.getSettlementTokenDecimalsFromSymbol(symbol)](#PerpetualDataHandler+getSettlementTokenDecimalsFromSymbol) ⇒
         * [.getABI(contract)](#PerpetualDataHandler+getABI) ⇒
+        * [.isPredictionMarket(symbol)](#PerpetualDataHandler+isPredictionMarket) ⇒
     * _static_
         * [.getPerpetualStaticInfo(_proxyContract, nestedPerpetualIDs, symbolList)](#PerpetualDataHandler.getPerpetualStaticInfo) ⇒
         * [.nestedIDsToChunks(chunkSize, nestedIDs)](#PerpetualDataHandler.nestedIDsToChunks) ⇒ <code>Array.&lt;Array.&lt;number&gt;&gt;</code>
         * [._getLiquidityPools(ids, _proxyContract, _symbolList, overrides)](#PerpetualDataHandler._getLiquidityPools) ⇒
         * [._getPerpetuals(ids, _proxyContract, _symbolList, overrides)](#PerpetualDataHandler._getPerpetuals) ⇒
-        * [.getMarginAccount(traderAddr, symbol, symbolToPerpStaticInfo, _proxyContract, _pxS2S3, overrides)](#PerpetualDataHandler.getMarginAccount) ⇒
-        * [.getMarginAccounts(traderAddrs, symbols, symbolToPerpStaticInfo, _multicall, _proxyContract, _pxS2S3s, overrides)](#PerpetualDataHandler.getMarginAccounts) ⇒
+        * [.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) ⇒
@@ -5222,6 +5630,7 @@ common data and chain operations.</p>
         * [._getABIFromContract(contract, functionName)](#PerpetualDataHandler._getABIFromContract) ⇒
         * [.checkOrder(order, traderAccount, perpStaticInfo)](#PerpetualDataHandler.checkOrder)
         * [.fromClientOrderToTypeSafeOrder(order)](#PerpetualDataHandler.fromClientOrderToTypeSafeOrder) ⇒
+        * [.isPredictionMarketStatic(staticInfo)](#PerpetualDataHandler.isPredictionMarketStatic) ⇒
 
 <a name="new_PerpetualDataHandler_new"></a>
 
@@ -5245,6 +5654,18 @@ common data and chain operations.</p>
 | --- | --- |
 | symbol | <p>symbol of the form ETH-USD-MATIC</p> |
 
+<a name="PerpetualDataHandler+getOrderBookAddress"></a>
+
+### perpetualDataHandler.getOrderBookAddress(symbol) ⇒
+<p>Returns the order-book contract for the symbol if found or fails</p>
+
+**Kind**: instance method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler)  
+**Returns**: <p>order book contract for the perpetual</p>  
+
+| Param | Description |
+| --- | --- |
+| symbol | <p>symbol of the form ETH-USD-MATIC</p> |
+
 <a name="PerpetualDataHandler+getPerpetuals"></a>
 
 ### perpetualDataHandler.getPerpetuals(ids, overrides) ⇒
@@ -5578,6 +5999,18 @@ main();
 | --- | --- |
 | contract | <p>name of contract: proxy|lob|sharetoken</p> |
 
+<a name="PerpetualDataHandler+isPredictionMarket"></a>
+
+### perpetualDataHandler.isPredictionMarket(symbol) ⇒
+<p>Determines whether a given perpetual represents a prediction market</p>
+
+**Kind**: instance method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler)  
+**Returns**: <p>True if this is a prediction market</p>  
+
+| Param | Description |
+| --- | --- |
+| symbol | <p>perpetual symbol of the form TRUMP24-USD-USDC</p> |
+
 <a name="PerpetualDataHandler.getPerpetualStaticInfo"></a>
 
 ### PerpetualDataHandler.getPerpetualStaticInfo(_proxyContract, nestedPerpetualIDs, symbolList) ⇒
@@ -5637,7 +6070,7 @@ main();
 
 <a name="PerpetualDataHandler.getMarginAccount"></a>
 
-### PerpetualDataHandler.getMarginAccount(traderAddr, symbol, symbolToPerpStaticInfo, _proxyContract, _pxS2S3, overrides) ⇒
+### PerpetualDataHandler.getMarginAccount(traderAddr, symbol, symbolToPerpStaticInfo, _proxyContract, _pxInfo, overrides) ⇒
 <p>Get trader state from the blockchain and parse into a human-readable margin account</p>
 
 **Kind**: static method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler)  
@@ -5649,12 +6082,12 @@ main();
 | symbol | <p>Perpetual symbol</p> |
 | symbolToPerpStaticInfo | <p>Symbol to perp static info mapping</p> |
 | _proxyContract | <p>Proxy contract instance</p> |
-| _pxS2S3 | <p>Prices [S2, S3]</p> |
+| _pxInfo | <p>index price info</p> |
 | overrides | <p>Optional overrides for eth_call</p> |
 
 <a name="PerpetualDataHandler.getMarginAccounts"></a>
 
-### PerpetualDataHandler.getMarginAccounts(traderAddrs, symbols, symbolToPerpStaticInfo, _multicall, _proxyContract, _pxS2S3s, overrides) ⇒
+### PerpetualDataHandler.getMarginAccounts(traderAddrs, symbols, symbolToPerpStaticInfo, _multicall, _proxyContract, _pxInfo, overrides) ⇒
 <p>Get trader states from the blockchain and parse into a list of human-readable margin accounts</p>
 
 **Kind**: static method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler)  
@@ -5667,9 +6100,37 @@ main();
 | symbolToPerpStaticInfo | <p>Symbol to perp static info mapping</p> |
 | _multicall | <p>Multicall3 contract instance</p> |
 | _proxyContract | <p>Proxy contract instance</p> |
-| _pxS2S3s | <p>List of price pairs, [[S2, S3] (1st perp), [S2, S3] (2nd perp), ... ]</p> |
+| _pxInfo | <p>List of price info</p> |
 | overrides | <p>Optional eth_call overrides</p> |
 
+<a name="PerpetualDataHandler._queryPerpetualMarkPrice"></a>
+
+### PerpetualDataHandler.\_queryPerpetualMarkPrice(symbol, symbolToPerpStaticInfo, _proxyContract, indexPrices, isPredMkt, overrides) ⇒
+**Kind**: static method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler)  
+**Returns**: <p>mark price</p>  
+
+| Param | Description |
+| --- | --- |
+| symbol | <p>perpetual symbol of the form BTC-USDC-USDC</p> |
+| symbolToPerpStaticInfo | <p>mapping</p> |
+| _proxyContract | <p>contract instance</p> |
+| indexPrices | <p>IdxPriceInfo</p> |
+| isPredMkt | <p>true if prediction market perpetual</p> |
+| overrides |  |
+
+<a name="PerpetualDataHandler._oiAndAmmPosToLongShort"></a>
+
+### PerpetualDataHandler.\_oiAndAmmPosToLongShort(oi, ammPos) ⇒
+<p>Calculate long and short exposures from open interest and long/short</p>
+
+**Kind**: static method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler)  
+**Returns**: <p>long, short exposure</p>  
+
+| Param | Description |
+| --- | --- |
+| oi | <p>open interest</p> |
+| ammPos | <p>amm net exposure</p> |
+
 <a name="PerpetualDataHandler._calculateLiquidationPrice"></a>
 
 ### PerpetualDataHandler.\_calculateLiquidationPrice(symbol, traderState, S2, symbolToPerpStaticInfo) ⇒
@@ -5840,7 +6301,7 @@ main();
 <a name="PerpetualDataHandler._getABIFromContract"></a>
 
 ### PerpetualDataHandler.\_getABIFromContract(contract, functionName) ⇒
-<p>Get the ABI of a function in a given contract</p>
+<p>Get the ABI of a function in a given contract. Undefined if it doesn't exist.</p>
 
 **Kind**: static method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler)  
 **Returns**: <p>Function ABI as a single JSON string</p>  
@@ -5875,6 +6336,18 @@ main();
 | --- | --- |
 | order | <p>Client order</p> |
 
+<a name="PerpetualDataHandler.isPredictionMarketStatic"></a>
+
+### PerpetualDataHandler.isPredictionMarketStatic(staticInfo) ⇒
+<p>Determines whether a given perpetual represents a prediction market</p>
+
+**Kind**: static method of [<code>PerpetualDataHandler</code>](#PerpetualDataHandler)  
+**Returns**: <p>True if this is a prediction market</p>  
+
+| Param | Description |
+| --- | --- |
+| staticInfo | <p>Perpetual static info</p> |
+
 <a name="PerpetualEventHandler"></a>
 
 ## PerpetualEventHandler
@@ -6147,13 +6620,20 @@ int128 fSpotIndexPrice
 )</p>
 
 **Kind**: static method of [<code>PerpetualEventHandler</code>](#PerpetualEventHandler)  
-**Returns**: <p>mark price and spot index in float</p>  
+**Returns**: <p>midPrice, markPricePremium, indexPrice in float</p>  
 
 | Param | Description |
 | --- | --- |
 | fMarkPricePremium | <p>premium rate in ABDK format</p> |
 | fSpotIndexPrice | <p>spot index price in ABDK format</p> |
 
+<a name="PolyMktsPxFeed"></a>
+
+## PolyMktsPxFeed
+<p>PolyMktsPxFeed gets prices from the official polymarket api
+and applies the 1+px transformation</p>
+
+**Kind**: global class  
 <a name="PriceFeeds"></a>
 
 ## PriceFeeds
@@ -6169,7 +6649,7 @@ trader liquidations, trade executions, change of trader margin amount.</p>
         * [.getTriangulations()](#PriceFeeds+getTriangulations) ⇒
         * [.setTriangulations()](#PriceFeeds+setTriangulations)
         * [.fetchFeedPriceInfoAndIndicesForPerpetual(symbol)](#PriceFeeds+fetchFeedPriceInfoAndIndicesForPerpetual) ⇒
-        * [.fetchPrices()](#PriceFeeds+fetchPrices) ⇒
+        * [.fetchPrices(symbol)](#PriceFeeds+fetchPrices) ⇒
         * [.fetchPricesForPerpetual(symbol)](#PriceFeeds+fetchPricesForPerpetual) ⇒
         * [.fetchFeedPrices(symbols)](#PriceFeeds+fetchFeedPrices) ⇒
         * [.fetchAllFeedPrices()](#PriceFeeds+fetchAllFeedPrices) ⇒
@@ -6210,8 +6690,8 @@ trader liquidations, trade executions, change of trader margin amount.</p>
 <a name="PriceFeeds+fetchFeedPriceInfoAndIndicesForPerpetual"></a>
 
 ### priceFeeds.fetchFeedPriceInfoAndIndicesForPerpetual(symbol) ⇒
-<p>Get required information to be able to submit a blockchain transaction with price-update
-such as trade execution, liquidation</p>
+<p>Get required information to be able to submit a blockchain transaction with
+price-update such as trade execution, liquidation. Uses write price feed endpoints.</p>
 
 **Kind**: instance method of [<code>PriceFeeds</code>](#PriceFeeds)  
 **Returns**: <p>PriceFeedSubmission, index prices, market closed information</p>  
@@ -6222,20 +6702,26 @@ such as trade execution, liquidation</p>
 
 <a name="PriceFeeds+fetchPrices"></a>
 
-### priceFeeds.fetchPrices() ⇒
+### priceFeeds.fetchPrices(symbol) ⇒
 <p>Get all prices/isMarketClosed for the provided symbols via
-&quot;latest_price_feeds&quot; and triangulation. Triangulation must be defined in config, unless
-it is a direct price feed.</p>
+&quot;latest_price_feeds&quot; and triangulation. Triangulation must be defined in
+config, unless it is a direct price feed. Uses read endpoints.</p>
 
 **Kind**: instance method of [<code>PriceFeeds</code>](#PriceFeeds)  
 **Returns**: <p>map of feed-price symbol to price/isMarketClosed</p>  
+
+| Param | Description |
+| --- | --- |
+| symbol | <p>perpetual symbol of the form BTC-USD-MATIC</p> |
+
 <a name="PriceFeeds+fetchPricesForPerpetual"></a>
 
 ### priceFeeds.fetchPricesForPerpetual(symbol) ⇒
 <p>Get index prices and market closed information for the given perpetual</p>
 
 **Kind**: instance method of [<code>PriceFeeds</code>](#PriceFeeds)  
-**Returns**: <p>Index prices and market closed information</p>  
+**Returns**: <p>Index prices and market closed information; for prediction markets also
+ema, confidence, and order book parameters.</p>  
 
 | Param | Description |
 | --- | --- |
@@ -6248,11 +6734,13 @@ it is a direct price feed.</p>
 <ul>
 <li>requires the feeds to be defined in priceFeedConfig.json</li>
 <li>if symbols undefined, all feeds are queried</li>
-<li>vaas are not of interest here</li>
+<li>vaas are not of interest here, therefore only readonly price feed
+endpoints are used</li>
 </ul>
 
 **Kind**: instance method of [<code>PriceFeeds</code>](#PriceFeeds)  
-**Returns**: <p>mapping symbol-&gt; [price, isMarketClosed]</p>  
+**Returns**: <p>mapping symbol-&gt; [price, isMarketClosed], also has an entry
+<symbol>:ema for each polymarket symbol that maps to the ema price</p>  
 
 | Param | Description |
 | --- | --- |
@@ -6261,7 +6749,7 @@ it is a direct price feed.</p>
 <a name="PriceFeeds+fetchAllFeedPrices"></a>
 
 ### priceFeeds.fetchAllFeedPrices() ⇒
-<p>Get all configured feed prices via &quot;latest_price_feeds&quot;</p>
+<p>Get all configured feed prices via &quot;latest_price_feeds&quot;.</p>
 
 **Kind**: instance method of [<code>PriceFeeds</code>](#PriceFeeds)  
 **Returns**: <p>map of feed-price symbol to price/isMarketClosed</p>  
@@ -6269,11 +6757,11 @@ it is a direct price feed.</p>
 
 ### priceFeeds.fetchLatestFeedPriceInfoForPerpetual(symbol) ⇒
 <p>Get the latest prices for a given perpetual from the offchain oracle
-networks</p>
+networks. Uses write price feed endpoints.</p>
 
 **Kind**: instance method of [<code>PriceFeeds</code>](#PriceFeeds)  
-**Returns**: <p>array of price feed updates that can be submitted to the smart contract
-and corresponding price information</p>  
+**Returns**: <p>array of price feed updates that can be submitted to the smart
+contract and corresponding price information</p>  
 
 | Param | Description |
 | --- | --- |
@@ -6391,8 +6879,11 @@ one chain, unless the backend employs code transferrals</p>
 * [ReferralCodeSigner](#ReferralCodeSigner)
     * [.getSignatureForNewReferral(rc, signingFun)](#ReferralCodeSigner.getSignatureForNewReferral) ⇒
     * [.getSignatureForNewCode(rc, signingFun)](#ReferralCodeSigner.getSignatureForNewCode) ⇒
+    * [.newReferralPayloadToTypedData(rc)](#ReferralCodeSigner.newReferralPayloadToTypedData) ⇒
     * [._referralCodeNewCodePayloadToMessage(rc)](#ReferralCodeSigner._referralCodeNewCodePayloadToMessage) ⇒
+    * [.referralCodeNewCodePayloadToTypedData(rc)](#ReferralCodeSigner.referralCodeNewCodePayloadToTypedData) ⇒
     * [._codeSelectionPayloadToMessage(rc)](#ReferralCodeSigner._codeSelectionPayloadToMessage) ⇒
+    * [.codeSelectionPayloadToTypedData(rc)](#ReferralCodeSigner.codeSelectionPayloadToTypedData) ⇒
     * [.checkNewCodeSignature(rc)](#ReferralCodeSigner.checkNewCodeSignature) ⇒
 
 <a name="ReferralCodeSigner.getSignatureForNewReferral"></a>
@@ -6423,6 +6914,18 @@ rc.PassOnPercTDF must be in 100*percentage unit</p>
 | rc | <p>APIReferralCodePayload without signature</p> |
 | signingFun | <p>function that signs</p> |
 
+<a name="ReferralCodeSigner.newReferralPayloadToTypedData"></a>
+
+### ReferralCodeSigner.newReferralPayloadToTypedData(rc) ⇒
+<p>Convert payload to data struct to sign</p>
+
+**Kind**: static method of [<code>ReferralCodeSigner</code>](#ReferralCodeSigner)  
+**Returns**: <p>typed data</p>  
+
+| Param | Description |
+| --- | --- |
+| rc | <p>payload</p> |
+
 <a name="ReferralCodeSigner._referralCodeNewCodePayloadToMessage"></a>
 
 ### ReferralCodeSigner.\_referralCodeNewCodePayloadToMessage(rc) ⇒
@@ -6435,6 +6938,18 @@ rc.PassOnPercTDF must be in 100*percentage unit</p>
 | --- | --- |
 | rc | <p>payload</p> |
 
+<a name="ReferralCodeSigner.referralCodeNewCodePayloadToTypedData"></a>
+
+### ReferralCodeSigner.referralCodeNewCodePayloadToTypedData(rc) ⇒
+<p>Convert payload to data struct to sign</p>
+
+**Kind**: static method of [<code>ReferralCodeSigner</code>](#ReferralCodeSigner)  
+**Returns**: <p>typed data</p>  
+
+| Param | Description |
+| --- | --- |
+| rc | <p>payload</p> |
+
 <a name="ReferralCodeSigner._codeSelectionPayloadToMessage"></a>
 
 ### ReferralCodeSigner.\_codeSelectionPayloadToMessage(rc) ⇒
@@ -6447,6 +6962,18 @@ rc.PassOnPercTDF must be in 100*percentage unit</p>
 | --- | --- |
 | rc | <p>payload</p> |
 
+<a name="ReferralCodeSigner.codeSelectionPayloadToTypedData"></a>
+
+### ReferralCodeSigner.codeSelectionPayloadToTypedData(rc) ⇒
+<p>Convert payload to data struct to sign</p>
+
+**Kind**: static method of [<code>ReferralCodeSigner</code>](#ReferralCodeSigner)  
+**Returns**: <p>typed data</p>  
+
+| Param | Description |
+| --- | --- |
+| rc | <p>payload</p> |
+
 <a name="ReferralCodeSigner.checkNewCodeSignature"></a>
 
 ### ReferralCodeSigner.checkNewCodeSignature(rc) ⇒
@@ -6490,25 +7017,26 @@ so that signatures can be handled in frontend via wallet</p>
         * [.getProxyAddress()](#MarketData+getProxyAddress) ⇒ <code>string</code>
         * [.getTriangulations()](#MarketData+getTriangulations) ⇒
         * [.smartContractOrderToOrder(smOrder)](#MarketData+smartContractOrderToOrder) ⇒ <code>Order</code>
-        * [.getReadOnlyProxyInstance()](#MarketData+getReadOnlyProxyInstance) ⇒ <code>Contract</code>
-        * [.exchangeInfo()](#MarketData+exchangeInfo) ⇒ <code>ExchangeInfo</code>
+        * [.getReadOnlyProxyInstance()](#MarketData+getReadOnlyProxyInstance) ⇒
+        * [.exchangeInfo()](#MarketData+exchangeInfo) ⇒ [<code>ExchangeInfo</code>](#ExchangeInfo)
         * [.openOrders(traderAddr, symbol)](#MarketData+openOrders) ⇒
         * [.positionRisk(traderAddr, symbol)](#MarketData+positionRisk) ⇒ <code>Array.&lt;MarginAccount&gt;</code>
-        * [.positionRiskOnTrade(traderAddr, order, account, indexPriceInfo)](#MarketData+positionRiskOnTrade) ⇒
+        * [.positionRiskOnTrade(traderAddr, order, signedPositionNotionalBaseCCY, tradingFeeTbps, indexPriceInfo)](#MarketData+positionRiskOnTrade) ⇒
         * [.positionRiskOnCollateralAction(deltaCollateral, account)](#MarketData+positionRiskOnCollateralAction) ⇒ <code>MarginAccount</code>
         * [.getWalletBalance(address, symbol)](#MarketData+getWalletBalance) ⇒
         * [.getPoolShareTokenBalance(address, symbolOrId)](#MarketData+getPoolShareTokenBalance) ⇒ <code>number</code>
         * [.getShareTokenPrice(symbolOrId)](#MarketData+getShareTokenPrice) ⇒ <code>number</code>
         * [.getParticipationValue(address, symbolOrId)](#MarketData+getParticipationValue) ⇒
         * [.maxOrderSizeForTrader(traderAddr, symbol)](#MarketData+maxOrderSizeForTrader) ⇒
+        * [.getMaxShortLongPos(perpId, currentTraderPos, overrides)](#MarketData+getMaxShortLongPos) ⇒
         * [.maxSignedPosition(side, symbol)](#MarketData+maxSignedPosition) ⇒ <code>number</code>
         * [.getOraclePrice(base, quote)](#MarketData+getOraclePrice) ⇒ <code>number</code>
         * [.getOrderStatus(symbol, orderId, overrides)](#MarketData+getOrderStatus) ⇒
         * [.getOrdersStatus(symbol, orderId)](#MarketData+getOrdersStatus) ⇒
-        * [.getMarkPrice(symbol)](#MarketData+getMarkPrice) ⇒ <code>number</code>
-        * [.getPerpetualPrice(symbol, quantity)](#MarketData+getPerpetualPrice) ⇒ <code>number</code>
+        * [.getMarkPrice(symbol, indexPrices)](#MarketData+getMarkPrice) ⇒ <code>number</code>
+        * [.getPerpetualPrice(symbol, quantity, priceInfo)](#MarketData+getPerpetualPrice) ⇒ <code>number</code>
         * [.getPerpetualState(symbol)](#MarketData+getPerpetualState) ⇒ <code>PerpetualState</code>
-        * [.getPoolState(poolSymbol)](#MarketData+getPoolState) ⇒ <code>PoolState</code>
+        * [.getPoolState(poolSymbol)](#MarketData+getPoolState) ⇒ [<code>PoolState</code>](#PoolState)
         * [.getPerpetualStaticInfo(symbol)](#MarketData+getPerpetualStaticInfo) ⇒ <code>PerpetualStaticInfo</code>
         * [.getPerpetualMidPrice(symbol)](#MarketData+getPerpetualMidPrice) ⇒ <code>number</code>
         * [.getAvailableMargin(traderAddr, symbol, indexPrices)](#MarketData+getAvailableMargin) ⇒
@@ -6541,6 +7069,7 @@ so that signatures can be handled in frontend via wallet</p>
         * [.getMarginTokenDecimalsFromSymbol(symbol)](#PerpetualDataHandler+getMarginTokenDecimalsFromSymbol) ⇒
         * [.getSettlementTokenDecimalsFromSymbol(symbol)](#PerpetualDataHandler+getSettlementTokenDecimalsFromSymbol) ⇒
         * [.getABI(contract)](#PerpetualDataHandler+getABI) ⇒
+        * [.isPredictionMarket(symbol)](#PerpetualDataHandler+isPredictionMarket) ⇒
     * _static_
         * [.chainOrders(orders, ids)](#TraderInterface.chainOrders) ⇒
 
@@ -6645,6 +7174,7 @@ main();
 <p>Get the order book address for a perpetual</p>
 
 **Kind**: instance method of [<code>TraderInterface</code>](#TraderInterface)  
+**Overrides**: [<code>getOrderBookAddress</code>](#PerpetualDataHandler+getOrderBookAddress)  
 **Returns**: <p>order book address for the perpetual</p>  
 
 | Param | Description |
@@ -6695,7 +7225,7 @@ Order must contain broker fee and broker address if there is supposed to be a br
 <a name="TraderInterface+getProxyABI"></a>
 
 ### traderInterface.getProxyABI(method) ⇒
-<p>Get the ABI of a method in the proxy contract</p>
+<p>Get the ABI of a method in the proxy contract. Throws if non-existent</p>
 
 **Kind**: instance method of [<code>TraderInterface</code>](#TraderInterface)  
 **Returns**: <p>ABI as a single string</p>  
@@ -6847,16 +7377,16 @@ about perpetual currencies</p>
 
 | Param | Type | Description |
 | --- | --- | --- |
-| smOrder | <code>SmartContractOrder</code> | <p>SmartContractOrder, as obtained e.g., by PerpetualLimitOrderCreated event</p> |
+| smOrder | [<code>SmartContractOrder</code>](#SmartContractOrder) | <p>SmartContractOrder, as obtained e.g., by PerpetualLimitOrderCreated event</p> |
 
 <a name="MarketData+getReadOnlyProxyInstance"></a>
 
-### traderInterface.getReadOnlyProxyInstance() ⇒ <code>Contract</code>
+### traderInterface.getReadOnlyProxyInstance() ⇒
 <p>Get contract instance. Useful for event listening.</p>
 
 **Kind**: instance method of [<code>TraderInterface</code>](#TraderInterface)  
 **Overrides**: [<code>getReadOnlyProxyInstance</code>](#MarketData+getReadOnlyProxyInstance)  
-**Returns**: <code>Contract</code> - <p>read-only proxy instance</p>  
+**Returns**: <p>read-only proxy instance</p>  
 **Example**  
 ```js
 import { MarketData, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
@@ -6874,12 +7404,12 @@ main();
 ```
 <a name="MarketData+exchangeInfo"></a>
 
-### traderInterface.exchangeInfo() ⇒ <code>ExchangeInfo</code>
+### traderInterface.exchangeInfo() ⇒ [<code>ExchangeInfo</code>](#ExchangeInfo)
 <p>Information about the products traded in the exchange.</p>
 
 **Kind**: instance method of [<code>TraderInterface</code>](#TraderInterface)  
 **Overrides**: [<code>exchangeInfo</code>](#MarketData+exchangeInfo)  
-**Returns**: <code>ExchangeInfo</code> - <p>Array of static data for all the pools and perpetuals in the system.</p>  
+**Returns**: [<code>ExchangeInfo</code>](#ExchangeInfo) - <p>Array of static data for all the pools and perpetuals in the system.</p>  
 **Example**  
 ```js
 import { MarketData, PerpetualDataHandler } from '@d8x/perpetuals-sdk';
@@ -6958,7 +7488,7 @@ main();
 ```
 <a name="MarketData+positionRiskOnTrade"></a>
 
-### traderInterface.positionRiskOnTrade(traderAddr, order, account, indexPriceInfo) ⇒
+### traderInterface.positionRiskOnTrade(traderAddr, order, signedPositionNotionalBaseCCY, tradingFeeTbps, indexPriceInfo) ⇒
 <p>Estimates what the position risk will be if a given order is executed.</p>
 
 **Kind**: instance method of [<code>TraderInterface</code>](#TraderInterface)  
@@ -6969,7 +7499,8 @@ main();
 | --- | --- |
 | traderAddr | <p>Address of trader</p> |
 | order | <p>Order to be submitted</p> |
-| account | <p>Position risk before trade. Defaults to current position if not given.</p> |
+| signedPositionNotionalBaseCCY | <p>signed position notional of current position (before trade)</p> |
+| tradingFeeTbps | <p>trading fee in tenth of basis points (exchange fee and broker fee)</p> |
 | indexPriceInfo | <p>Index prices and market status (open/closed). Defaults to current market status if not given.</p> |
 
 **Example**  
@@ -6990,7 +7521,7 @@ async function main() {
        executionTimestamp: Date.now()/1000,
    };
   // Get position risk conditional on this order being executed
-  const posRisk = await mktData.positionRiskOnTrade("0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B", order);
+  const posRisk = await mktData.positionRiskOnTrade("0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B", order, 0, 60);
   console.log(posRisk);
 }
 main();
@@ -7174,6 +7705,22 @@ async function main() {
 }
 main();
 ```
+<a name="MarketData+getMaxShortLongPos"></a>
+
+### traderInterface.getMaxShortLongPos(perpId, currentTraderPos, overrides) ⇒
+<p>Returns the maximal allowed short pos and long pos (signed) for a trader
+with given notional (in ABDK format) in the perpetual, ignoring the traders wallet balance</p>
+
+**Kind**: instance method of [<code>TraderInterface</code>](#TraderInterface)  
+**Overrides**: [<code>getMaxShortLongPos</code>](#MarketData+getMaxShortLongPos)  
+**Returns**: <p>[maxShortPos, maxLongPos] signed maximal position sizes</p>  
+
+| Param | Description |
+| --- | --- |
+| perpId |  |
+| currentTraderPos | <p>ABDK64x64 notional position of trader</p> |
+| overrides |  |
+
 <a name="MarketData+maxSignedPosition"></a>
 
 ### traderInterface.maxSignedPosition(side, symbol) ⇒ <code>number</code>
@@ -7293,7 +7840,7 @@ main();
 ```
 <a name="MarketData+getMarkPrice"></a>
 
-### traderInterface.getMarkPrice(symbol) ⇒ <code>number</code>
+### traderInterface.getMarkPrice(symbol, indexPrices) ⇒ <code>number</code>
 <p>Get the current mark price</p>
 
 **Kind**: instance method of [<code>TraderInterface</code>](#TraderInterface)  
@@ -7303,6 +7850,7 @@ main();
 | Param | Description |
 | --- | --- |
 | symbol | <p>symbol of the form ETH-USD-MATIC</p> |
+| indexPrices | <p>optional. IdxPriceInfo</p> |
 
 **Example**  
 ```js
@@ -7321,7 +7869,7 @@ main();
 ```
 <a name="MarketData+getPerpetualPrice"></a>
 
-### traderInterface.getPerpetualPrice(symbol, quantity) ⇒ <code>number</code>
+### traderInterface.getPerpetualPrice(symbol, quantity, priceInfo) ⇒ <code>number</code>
 <p>get the current price for a given quantity</p>
 
 **Kind**: instance method of [<code>TraderInterface</code>](#TraderInterface)  
@@ -7332,6 +7880,7 @@ main();
 | --- | --- |
 | symbol | <p>symbol of the form ETH-USD-MATIC</p> |
 | quantity | <p>quantity to be traded, negative if short</p> |
+| priceInfo | <p>[s2, s3, conf, params]; for non-prediction markets conf/params can be 0</p> |
 
 **Example**  
 ```js
@@ -7363,12 +7912,12 @@ main();
 
 <a name="MarketData+getPoolState"></a>
 
-### traderInterface.getPoolState(poolSymbol) ⇒ <code>PoolState</code>
+### traderInterface.getPoolState(poolSymbol) ⇒ [<code>PoolState</code>](#PoolState)
 <p>Query recent pool state from blockchain, not including perpetual states</p>
 
 **Kind**: instance method of [<code>TraderInterface</code>](#TraderInterface)  
 **Overrides**: [<code>getPoolState</code>](#MarketData+getPoolState)  
-**Returns**: <code>PoolState</code> - <p>PoolState copy</p>  
+**Returns**: [<code>PoolState</code>](#PoolState) - <p>PoolState copy</p>  
 
 | Param | Type | Description |
 | --- | --- | --- |
@@ -7430,7 +7979,7 @@ Result is in collateral currency</p>
 | --- | --- | --- |
 | traderAddr | <code>string</code> | <p>address of the trader</p> |
 | symbol | <code>string</code> | <p>perpetual symbol of the form BTC-USD-MATIC</p> |
-| indexPrices |  | <p>optional index prices, will otherwise fetch from REST API</p> |
+| indexPrices |  | <p>optional indexPriceInfo</p> |
 
 **Example**  
 ```js
@@ -7914,6 +8463,19 @@ main();
 | --- | --- |
 | contract | <p>name of contract: proxy|lob|sharetoken</p> |
 
+<a name="PerpetualDataHandler+isPredictionMarket"></a>
+
+### traderInterface.isPredictionMarket(symbol) ⇒
+<p>Determines whether a given perpetual represents a prediction market</p>
+
+**Kind**: instance method of [<code>TraderInterface</code>](#TraderInterface)  
+**Overrides**: [<code>isPredictionMarket</code>](#PerpetualDataHandler+isPredictionMarket)  
+**Returns**: <p>True if this is a prediction market</p>  
+
+| Param | Description |
+| --- | --- |
+| symbol | <p>perpetual symbol of the form TRUMP24-USD-USDC</p> |
+
 <a name="TraderInterface.chainOrders"></a>
 
 ### TraderInterface.chainOrders(orders, ids) ⇒
@@ -7946,6 +8508,7 @@ require gas-payments.</p>
     * [.getAddress()](#WriteAccessHandler+getAddress) ⇒ <code>string</code>
     * [.swapForMockToken(symbol, amountToPay)](#WriteAccessHandler+swapForMockToken) ⇒
     * [.getOrderBookContract(symbol)](#PerpetualDataHandler+getOrderBookContract) ⇒
+    * [.getOrderBookAddress(symbol)](#PerpetualDataHandler+getOrderBookAddress) ⇒
     * [.getPerpetuals(ids, overrides)](#PerpetualDataHandler+getPerpetuals) ⇒
     * [.getLiquidityPools(fromIdx, toIdx, overrides)](#PerpetualDataHandler+getLiquidityPools) ⇒
     * [._fillSymbolMaps()](#PerpetualDataHandler+_fillSymbolMaps)
@@ -7970,6 +8533,7 @@ require gas-payments.</p>
     * [.getMarginTokenDecimalsFromSymbol(symbol)](#PerpetualDataHandler+getMarginTokenDecimalsFromSymbol) ⇒
     * [.getSettlementTokenDecimalsFromSymbol(symbol)](#PerpetualDataHandler+getSettlementTokenDecimalsFromSymbol) ⇒
     * [.getABI(contract)](#PerpetualDataHandler+getABI) ⇒
+    * [.isPredictionMarket(symbol)](#PerpetualDataHandler+isPredictionMarket) ⇒
 
 <a name="new_WriteAccessHandler_new"></a>
 
@@ -8000,7 +8564,7 @@ about perpetual currencies</p>
 <p>Set allowance for ar margin token (e.g., MATIC, ETH, USDC)</p>
 
 **Kind**: instance method of [<code>WriteAccessHandler</code>](#WriteAccessHandler)  
-**Returns**: <p>ContractTransaction</p>  
+**Returns**: <p>Contract Transaction</p>  
 
 | Param | Description |
 | --- | --- |
@@ -8041,6 +8605,19 @@ into a mock token used for trading on testnet, with a rate of 1:100_000</p>
 | --- | --- |
 | symbol | <p>symbol of the form ETH-USD-MATIC</p> |
 
+<a name="PerpetualDataHandler+getOrderBookAddress"></a>
+
+### writeAccessHandler.getOrderBookAddress(symbol) ⇒
+<p>Returns the order-book contract for the symbol if found or fails</p>
+
+**Kind**: instance method of [<code>WriteAccessHandler</code>](#WriteAccessHandler)  
+**Overrides**: [<code>getOrderBookAddress</code>](#PerpetualDataHandler+getOrderBookAddress)  
+**Returns**: <p>order book contract for the perpetual</p>  
+
+| Param | Description |
+| --- | --- |
+| symbol | <p>symbol of the form ETH-USD-MATIC</p> |
+
 <a name="PerpetualDataHandler+getPerpetuals"></a>
 
 ### writeAccessHandler.getPerpetuals(ids, overrides) ⇒
@@ -8398,6 +8975,19 @@ main();
 | --- | --- |
 | contract | <p>name of contract: proxy|lob|sharetoken</p> |
 
+<a name="PerpetualDataHandler+isPredictionMarket"></a>
+
+### writeAccessHandler.isPredictionMarket(symbol) ⇒
+<p>Determines whether a given perpetual represents a prediction market</p>
+
+**Kind**: instance method of [<code>WriteAccessHandler</code>](#WriteAccessHandler)  
+**Overrides**: [<code>isPredictionMarket</code>](#PerpetualDataHandler+isPredictionMarket)  
+**Returns**: <p>True if this is a prediction market</p>  
+
+| Param | Description |
+| --- | --- |
+| symbol | <p>perpetual symbol of the form TRUMP24-USD-USDC</p> |
+
 <a name="default"></a>
 
 ## default ⇒
@@ -8411,3 +9001,85 @@ on-chain</p>
 | --- | --- |
 | provider | <p>arbitrum provider</p> |
 
+<a name="referralDomain"></a>
+
+## referralDomain
+<p>LiquidityPoolData corresponding to the data in the smart contract</p>
+
+**Kind**: global constant  
+<a name="ExchangeInfo"></a>
+
+## ExchangeInfo : <code>Object</code>
+**Kind**: global typedef  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| pools | [<code>Array.&lt;PoolState&gt;</code>](#PoolState) | <p>Array of state objects for all pools in the exchange.</p> |
+| oracleFactoryAddr | <code>string</code> | <p>Address of the oracle factory used by the pools in the exchange.</p> |
+
+<a name="PoolState"></a>
+
+## PoolState : <code>Object</code>
+**Kind**: global typedef  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| isRunning | <code>boolean</code> | <p>True if the pool is running.</p> |
+| marginTokenAddr | <code>string</code> | <p>Address of the token used by the pool. This is the token used for margin deposits, liquidity provision, and trading fees.</p> |
+| poolShareTokenAddr | <code>string</code> | <p>Address of the pool share token. This is the token issued to external liquidity providers.</p> |
+| defaultFundCashCC | <code>number</code> | <p>Amount of cash in the default fund of this pool, denominated in margin tokens.</p> |
+| pnlParticipantCashCC | <code>number</code> | <p>Amount of cash in the PnL participation pool, i.e. cash deposited by external liquidity providers.</p> |
+| totalTargetAMMFundSizeCC | <code>number</code> | <p>Target AMM funds aggregated across all perpetuals in this pool.</p> |
+| brokerCollateralLotSize | <code>number</code> | <p>Price of one lot for brokers who wish to participate in this pool. Denominated in margin tokens.</p> |
+| perpetuals | <code>Array.&lt;PerpetualState&gt;</code> | <p>Array of all perpetuals in this pool.</p> |
+
+<a name="SmartContractOrder"></a>
+
+## SmartContractOrder : <code>Object</code>
+**Kind**: global typedef  
+**Properties**
+
+| Name | Type |
+| --- | --- |
+| flags | <code>bigint</code> | 
+| iPerpetualId | <code>number</code> | 
+| brokerFeeTbps | <code>number</code> | 
+| traderAddr | <code>string</code> | 
+| brokerAddr | <code>string</code> | 
+| executorAddr | <code>string</code> | 
+| brokerSignature | <code>BytesLike</code> | 
+| fAmount | <code>bigint</code> | 
+| fLimitPrice | <code>bigint</code> | 
+| fTriggerPrice | <code>bigint</code> | 
+| leverageTDR | <code>number</code> | 
+| iDeadline | <code>number</code> | 
+| executionTimestamp | <code>number</code> | 
+| submittedTimestamp | <code>number</code> | 
+
+<a name="ClientOrder"></a>
+
+## ClientOrder : <code>Object</code>
+**Kind**: global typedef  
+**Properties**
+
+| Name | Type |
+| --- | --- |
+| flags | <code>bigint</code> | 
+| iPerpetualId | <code>bigint</code> | 
+| brokerFeeTbps | <code>bigint</code> | 
+| traderAddr | <code>string</code> | 
+| brokerAddr | <code>string</code> | 
+| executorAddr | <code>string</code> | 
+| brokerSignature | <code>BytesLike</code> | 
+| fAmount | <code>bigint</code> | 
+| fLimitPrice | <code>bigint</code> | 
+| fTriggerPrice | <code>bigint</code> | 
+| leverageTDR | <code>bigint</code> | 
+| iDeadline | <code>bigint</code> | 
+| executionTimestamp | <code>bigint</code> | 
+| parentChildDigest1 | <code>string</code> | 
+| parentChildDigest2 | <code>string</code> | 
+| callbackTarget | <code>string</code> | 
+