@d8x/perpetuals-sdk 2.1.0-alpha2 → 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.1.0-alpha2",
+  "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"
       }
     ],
@@ -2301,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": [
       {

package/src/accountTrade.ts

@@ -1,7 +1,7 @@
 import { Buffer } from "buffer";
 import { BigNumberish, Contract, ContractTransaction, ContractTransactionResponse, Overrides, Signer } from "ethers";
 import { ZERO_ADDRESS } from "./constants";
-import { LimitOrderBook } from "./contracts";
+import { IPerpetualManager, LimitOrderBook } from "./contracts";
 import { PayableOverrides } from "./contracts/common";
 import { ABK64x64ToFloat, floatToABK64x64 } from "./d8XMath";
 import MarketData from "./marketData";
@@ -176,7 +176,7 @@ export default class AccountTrade extends WriteAccessHandler {
     }
     let poolId = PerpetualDataHandler._getPoolIdFromSymbol(poolSymbolName, this.poolStaticInfos);
     let feeTbps = await this.proxyContract.queryExchangeFee(poolId, this.traderAddr, brokerAddr, overrides || {});
-    return feeTbps / 100_000;
+    return Number(feeTbps) / 100_000;
   }
 
   /**
@@ -254,7 +254,7 @@ export default class AccountTrade extends WriteAccessHandler {
     order: Order,
     traderAddr: string,
     symbolToPerpetualMap: Map<string, PerpetualStaticInfo>,
-    proxyContract: Contract,
+    proxyContract: IPerpetualManager,
     orderBookContract: LimitOrderBook,
     chainId: BigNumberish,
     signer: Signer,

package/src/brokerTool.ts

@@ -68,7 +68,7 @@ export default class BrokerTool extends WriteAccessHandler {
     }
     let poolId = PerpetualDataHandler._getPoolIdFromSymbol(poolSymbolName, this.poolStaticInfos);
     let feeTbps = await this.proxyContract.getBrokerInducedFee(poolId, this.traderAddr, overrides || {});
-    let fee = feeTbps / 100_000;
+    let fee = Number(feeTbps) / 100_000;
     if (fee == 0.65535) {
       return undefined;
     }
@@ -115,7 +115,7 @@ export default class BrokerTool extends WriteAccessHandler {
       brokerDesignation = lots;
     }
     let feeTbps = await this.proxyContract.getFeeForBrokerDesignation(brokerDesignation, overrides || {});
-    return feeTbps / 100_000;
+    return Number(feeTbps) / 100_000;
   }
 
   /**
@@ -146,7 +146,7 @@ export default class BrokerTool extends WriteAccessHandler {
     }
     let poolId = PerpetualDataHandler._getPoolIdFromSymbol(poolSymbolName, this.poolStaticInfos);
     let feeTbps = await this.proxyContract.getFeeForBrokerVolume(poolId, this.traderAddr, overrides || {});
-    return feeTbps / 100_000;
+    return Number(feeTbps) / 100_000;
   }
 
   /**
@@ -179,7 +179,7 @@ export default class BrokerTool extends WriteAccessHandler {
       brokerAddr = this.traderAddr;
     }
     let feeTbps = await this.proxyContract.getFeeForBrokerStake(brokerAddr, overrides || {});
-    return feeTbps / 100_000;
+    return Number(feeTbps) / 100_000;
   }
 
   /**
@@ -231,12 +231,12 @@ export default class BrokerTool extends WriteAccessHandler {
       const lvgTdr = order.leverage == undefined ? 0 : Math.round(100 * order.leverage);
       const feeTbps = await this.proxyContract.getExchangeFeePrdMkts(id, fAmount, lvgTdr);
 
-      return feeTbps / 100_000;
+      return Number(feeTbps) / 100_000;
     }
     // regular markets
     let scOrder = AccountTrade.toSmartContractOrder(order, traderAddr, this.symbolToPerpStaticInfo);
     let feeTbps = await this.proxyContract.determineExchangeFee(scOrder, overrides || {});
-    return feeTbps / 100_000;
+    return Number(feeTbps) / 100_000;
   }
 
   // Volume
@@ -331,7 +331,7 @@ export default class BrokerTool extends WriteAccessHandler {
     }
     let poolId = PerpetualDataHandler._getPoolIdFromSymbol(poolSymbolName, this.poolStaticInfos);
     let designation = await this.proxyContract.getBrokerDesignation(poolId, this.traderAddr, overrides || {});
-    return designation;
+    return Number(designation);
   }
 
   /**

package/src/config/defaultConfig.json

@@ -1,17 +1,4 @@
 [
-  {
-    "name": "zkevm",
-    "chainId": 1101,
-    "version": 1,
-    "proxyAddr": "0xaB7794EcD2c8e9Decc6B577864b40eBf9204720f",
-    "nodeURL": "https://zkevm-rpc.com",
-    "priceFeedConfigNetwork": "mainnet",
-    "shareTokenABILocation": "./abi/ShareToken.json",
-    "proxyABILocation": "./abi-zkevm/IPerpetualManager.json",
-    "limitOrderBookFactoryABILocation": "./abi/LimitOrderBookFactory.json",
-    "limitOrderBookABILocation": "./abi/LimitOrderBook.json"
-  },
-
   {
     "name": "x1",
     "chainId": 195,

package/src/config/priceFeedConfig.json

@@ -246,7 +246,7 @@
       }
     ],
     "endpoints": [
-      { "type": "odin", "endpoints": ["https://hermes.pyth.network"], "writeEndpoints": ["https://odin.d8x.xyz"] },
+      { "type": "odin", "endpoints": ["https://hermes.pyth.network"], "writeEndpoints": ["https://odin-poly.d8x.xyz"] },
       { "type": "polymarket", "endpoints": [""], "writeEndpoints": ["https://odin-poly.d8x.xyz"] }
     ]
   }

package/src/constants.ts

@@ -4,7 +4,6 @@ import { NodeSDKConfig } from "./nodeSDKTypes";
 export const ERC20_ABI = require("./abi/ERC20.json");
 export const MOCK_TOKEN_SWAP_ABI = require("./abi/MockTokenSwap.json");
 export const PROXY_ABI = require("./abi/IPerpetualManager.json");
-export const PROXY_ZKEVM_ABI = require("./abi-zkevm/IPerpetualManager.json");
 export const LOB_FACTORY_ABI = require("./abi/LimitOrderBookFactory.json");
 export const LOB_ABI = require("./abi/LimitOrderBook.json");
 export const SHARE_TOKEN_ABI = require("./abi/ShareToken.json");
@@ -58,7 +57,7 @@ export const DEFAULT_CONFIG_TESTNET_NAME = "testnet";
 
 let defaultConfigs = require("./config/defaultConfig.json") as NodeSDKConfig[];
 defaultConfigs.map((config) => {
-  config.proxyABI = config.proxyABILocation.includes("abi-zkevm") ? PROXY_ZKEVM_ABI : PROXY_ABI;
+  config.proxyABI = PROXY_ABI;
   config.lobABI = LOB_ABI;
   config.lobFactoryABI = LOB_FACTORY_ABI;
   config.shareTokenABI = SHARE_TOKEN_ABI;

package/src/contracts/IPerpetualManager.ts

@@ -459,6 +459,7 @@ export interface IPerpetualManagerInterface extends Interface {
       | "getCurrentBrokerVolume"
       | "getCurrentTraderVolume"
       | "getDepositAmountForLvgPosition"
+      | "getExchangeFeePrdMkts"
       | "getFeeForBrokerDesignation"
       | "getFeeForBrokerStake"
       | "getFeeForBrokerVolume"
@@ -787,6 +788,10 @@ export interface IPerpetualManagerInterface extends Interface {
       BigNumberish
     ]
   ): string;
+  encodeFunctionData(
+    functionFragment: "getExchangeFeePrdMkts",
+    values: [BigNumberish, BigNumberish, BigNumberish]
+  ): string;
   encodeFunctionData(
     functionFragment: "getFeeForBrokerDesignation",
     values: [BigNumberish]
@@ -1358,6 +1363,10 @@ export interface IPerpetualManagerInterface extends Interface {
     functionFragment: "getDepositAmountForLvgPosition",
     data: BytesLike
   ): Result;
+  decodeFunctionResult(
+    functionFragment: "getExchangeFeePrdMkts",
+    data: BytesLike
+  ): Result;
   decodeFunctionResult(
     functionFragment: "getFeeForBrokerDesignation",
     data: BytesLike
@@ -2544,19 +2553,19 @@ export namespace UpdateMarkPriceEvent {
     perpetualId: BigNumberish,
     fMidPricePremium: BigNumberish,
     fMarkPricePremium: BigNumberish,
-    fSpotIndexPrice: BigNumberish
+    fMarkIndexPrice: BigNumberish
   ];
   export type OutputTuple = [
     perpetualId: bigint,
     fMidPricePremium: bigint,
     fMarkPricePremium: bigint,
-    fSpotIndexPrice: bigint
+    fMarkIndexPrice: bigint
   ];
   export interface OutputObject {
     perpetualId: bigint;
     fMidPricePremium: bigint;
     fMarkPricePremium: bigint;
-    fSpotIndexPrice: bigint;
+    fMarkIndexPrice: bigint;
   }
   export type Event = TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
   export type Filter = TypedDeferredTopicFilter<Event>;
@@ -2871,6 +2880,16 @@ export interface IPerpetualManager extends BaseContract {
     "view"
   >;
 
+  getExchangeFeePrdMkts: TypedContractMethod<
+    [
+      _perpetualId: BigNumberish,
+      _fAmount: BigNumberish,
+      _leverageTDR: BigNumberish
+    ],
+    [bigint],
+    "view"
+  >;
+
   getFeeForBrokerDesignation: TypedContractMethod<
     [_brokerDesignation: BigNumberish],
     [bigint],
@@ -3810,6 +3829,17 @@ export interface IPerpetualManager extends BaseContract {
     [bigint],
     "view"
   >;
+  getFunction(
+    nameOrSignature: "getExchangeFeePrdMkts"
+  ): TypedContractMethod<
+    [
+      _perpetualId: BigNumberish,
+      _fAmount: BigNumberish,
+      _leverageTDR: BigNumberish
+    ],
+    [bigint],
+    "view"
+  >;
   getFunction(
     nameOrSignature: "getFeeForBrokerDesignation"
   ): TypedContractMethod<[_brokerDesignation: BigNumberish], [bigint], "view">;

package/src/contracts/factories/IPerpetualManager__factory.ts

@@ -1105,7 +1105,7 @@ const _abi = [
       {
         indexed: false,
         internalType: "int128",
-        name: "fSpotIndexPrice",
+        name: "fMarkIndexPrice",
         type: "int128",
       },
     ],
@@ -2311,6 +2311,35 @@ const _abi = [
     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: [
       {

package/src/d8XMath.ts

@@ -464,15 +464,38 @@ function pmMarginThresh(pos: number, s2: number, s3: number, m: number | undefin
   return (Math.abs(pos) * p * tau) / s3;
 }
 
-export function pmMaintenanceMarginRate(pos: number, s2: number, m: number | undefined = 0.18): number {
-  let p = s2 - 1;
-  if (pos < 0) {
+/**
+ * Maintenance margin rate for prediction markets.
+ * @param posSign sign of position in base currency (can be signed position or -1, 1)
+ * @param sm  mark-price (=1+p)
+ * @param m   max margin rate from fInitialMarginRate
+ * @returns margin rate to be applied (Math.abs(pos) * p * tau) / s3;
+ */
+export function pmMaintenanceMarginRate(posSign: number, sm: number, m: number | undefined = 0.18): number {
+  let p = sm - 1;
+  if (posSign < 0) {
     p = 1 - p;
   }
   const h = entropy(p);
   return m + (0.4 - m) * h;
 }
 
+/**
+ * Maintenance margin rate for prediction markets.
+ * @param posSign sign of position in base currency (can be signed position or -1, 1)
+ * @param sm  mark-price (=1+p)
+ * @param m   max margin rate from fMaintenanceMarginRate
+ * @returns margin rate to be applied (Math.abs(pos) * p * tau) / s3;
+ */
+export function pmInitialMarginRate(posSign: number, sm: number, m: number | undefined = 0.2): number {
+  let p = sm - 1;
+  if (posSign < 0) {
+    p = 1 - p;
+  }
+  const h = entropy(p);
+  return m + (0.5 - m) * h;
+}
+
 /**
  * Calculate the expected loss for a prediction market trade used for
  * prediction market fees
@@ -593,7 +616,7 @@ export function pmFindLiquidationPrice(
  * @param S3
  * @param totLong
  * @param totShort
- * @returns
+ * @returns excess margin as defined above
  */
 function excessMargin(
   tradeAmt: number,

package/src/liquidatorTool.ts

@@ -223,7 +223,7 @@ export default class LiquidatorTool extends WriteAccessHandler {
 
       indexPrices = [
         obj.ema, // ema (pred mkts) or s2
-        obj.s3, // s3
+        obj.s3 ?? 0, // s3
       ];
     }
     const fIdxPx = indexPrices.map((x) => floatToABK64x64(x == undefined || Number.isNaN(x) ? 0 : x)) as [
@@ -231,7 +231,7 @@ export default class LiquidatorTool extends WriteAccessHandler {
       bigint
     ];
     let traderState = await this.proxyContract.getTraderState(perpID, traderAddr, fIdxPx, overrides || {});
-    if (traderState[idx_notional].eq(0)) {
+    if (traderState[idx_notional] === 0n) {
       // trader does not have open position
       return true;
     }