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

package/doc/perpetualDataHandler.md

@@ -10,6 +10,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)
@@ -34,13 +35,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) ⇒
@@ -56,6 +60,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>
 
@@ -79,6 +84,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) ⇒
@@ -412,6 +429,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) ⇒
@@ -471,7 +500,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)  
@@ -483,12 +512,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)  
@@ -501,9 +530,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) ⇒
@@ -674,7 +731,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>  
@@ -709,3 +766,15 @@ 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> |
+

package/package.json

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

package/src/abi/IPerpetualManager.json

@@ -1095,7 +1095,7 @@
       {
         "indexed": false,
         "internalType": "int128",
-        "name": "fSpotIndexPrice",
+        "name": "fMarkIndexPrice",
         "type": "int128"
       }
     ],
@@ -1510,6 +1510,25 @@
     "stateMutability": "nonpayable",
     "type": "function"
   },
+  {
+    "inputs": [
+      {
+        "internalType": "uint16",
+        "name": "num",
+        "type": "uint16"
+      }
+    ],
+    "name": "decodeUint16Float",
+    "outputs": [
+      {
+        "internalType": "int128",
+        "name": "",
+        "type": "int128"
+      }
+    ],
+    "stateMutability": "pure",
+    "type": "function"
+  },
   {
     "inputs": [
       {
@@ -1929,6 +1948,25 @@
     "stateMutability": "nonpayable",
     "type": "function"
   },
+  {
+    "inputs": [
+      {
+        "internalType": "int128",
+        "name": "_p",
+        "type": "int128"
+      }
+    ],
+    "name": "entropy",
+    "outputs": [
+      {
+        "internalType": "int128",
+        "name": "",
+        "type": "int128"
+      }
+    ],
+    "stateMutability": "pure",
+    "type": "function"
+  },
   {
     "inputs": [
       {
@@ -2263,6 +2301,35 @@
     "stateMutability": "pure",
     "type": "function"
   },
+  {
+    "inputs": [
+      {
+        "internalType": "uint24",
+        "name": "_perpetualId",
+        "type": "uint24"
+      },
+      {
+        "internalType": "int128",
+        "name": "_fAmount",
+        "type": "int128"
+      },
+      {
+        "internalType": "uint16",
+        "name": "_leverageTDR",
+        "type": "uint16"
+      }
+    ],
+    "name": "getExchangeFeePrdMkts",
+    "outputs": [
+      {
+        "internalType": "uint16",
+        "name": "",
+        "type": "uint16"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
   {
     "inputs": [
       {
@@ -2818,8 +2885,13 @@
     "outputs": [
       {
         "internalType": "int128",
-        "name": "fPrice",
+        "name": "",
         "type": "int128"
+      },
+      {
+        "internalType": "uint64",
+        "name": "",
+        "type": "uint64"
       }
     ],
     "stateMutability": "view",
@@ -4176,6 +4248,50 @@
     "stateMutability": "nonpayable",
     "type": "function"
   },
+  {
+    "inputs": [
+      {
+        "internalType": "int128",
+        "name": "_fPx",
+        "type": "int128"
+      },
+      {
+        "internalType": "int128",
+        "name": "_fm",
+        "type": "int128"
+      },
+      {
+        "internalType": "int128",
+        "name": "_fTotLong",
+        "type": "int128"
+      },
+      {
+        "internalType": "int128",
+        "name": "_fTotShort",
+        "type": "int128"
+      },
+      {
+        "internalType": "int128",
+        "name": "_fTradeAmt",
+        "type": "int128"
+      },
+      {
+        "internalType": "int128",
+        "name": "_fMgnRate",
+        "type": "int128"
+      }
+    ],
+    "name": "prdMktsLvgFee",
+    "outputs": [
+      {
+        "internalType": "int128",
+        "name": "",
+        "type": "int128"
+      }
+    ],
+    "stateMutability": "pure",
+    "type": "function"
+  },
   {
     "inputs": [
       {
@@ -4272,6 +4388,30 @@
     "stateMutability": "nonpayable",
     "type": "function"
   },
+  {
+    "inputs": [
+      {
+        "internalType": "int128",
+        "name": "_amount",
+        "type": "int128"
+      },
+      {
+        "internalType": "uint64",
+        "name": "_params",
+        "type": "uint64"
+      }
+    ],
+    "name": "priceImpact",
+    "outputs": [
+      {
+        "internalType": "int128",
+        "name": "",
+        "type": "int128"
+      }
+    ],
+    "stateMutability": "pure",
+    "type": "function"
+  },
   {
     "inputs": [
       {
@@ -4305,12 +4445,12 @@
     "inputs": [
       {
         "internalType": "uint24[]",
-        "name": "perpetualIds",
+        "name": "_perpetualIds",
         "type": "uint24[]"
       },
       {
         "internalType": "int128[]",
-        "name": "idxPriceDataPairs",
+        "name": "_idxPriceDataPairs",
         "type": "int128[]"
       }
     ],
@@ -4341,6 +4481,16 @@
         "internalType": "int128[2]",
         "name": "_fIndexPrice",
         "type": "int128[2]"
+      },
+      {
+        "internalType": "uint16",
+        "name": "_confTbps",
+        "type": "uint16"
+      },
+      {
+        "internalType": "uint64",
+        "name": "_params",
+        "type": "uint64"
       }
     ],
     "name": "queryPerpetualPrice",