@d8x/perpetuals-sdk 2.1.0-alpha2 → 2.1.1-alpha2

package/src/marketData.ts

@@ -16,6 +16,7 @@ import {
 } from "./constants";
 import {
   ERC20__factory,
+  IPerpetualManager__factory,
   LimitOrderBook__factory,
   Multicall3__factory,
   type LimitOrderBook,
@@ -114,7 +115,7 @@ export default class MarketData extends PerpetualDataHandler {
       const mktData = providerOrMarketData;
       this.nodeURL = mktData.config.nodeURL;
       this.provider = new JsonRpcProvider(mktData.config.nodeURL, mktData.network, { staticNetwork: true });
-      this.proxyContract = new Contract(mktData.getProxyAddress(), this.config.proxyABI!, this.provider);
+      this.proxyContract = IPerpetualManager__factory.connect(mktData.getProxyAddress(), this.provider);
       this.multicall = Multicall3__factory.connect(this.config.multicall ?? MULTICALL_ADDRESS, this.provider);
       ({
         nestedPerpetualIDs: this.nestedPerpetualIDs,
@@ -179,9 +180,9 @@ export default class MarketData extends PerpetualDataHandler {
    * }
    * main();
    *
-   * @returns {Contract} read-only proxy instance
+   * @returns read-only proxy instance
    */
-  public getReadOnlyProxyInstance(): Contract {
+  public getReadOnlyProxyInstance() {
     if (this.proxyContract == null) {
       throw Error("no proxy contract initialized. Use createProxyInstance().");
     }
@@ -478,7 +479,7 @@ export default class MarketData extends PerpetualDataHandler {
     const isPredMkt = this.isPredictionMarket(symbol);
     // create all calls
     const perpId = PerpetualDataHandler.symbolToPerpetualId(symbol, this.symbolToPerpStaticInfo);
-    const [fS2, fS3, fEma] = [indexPriceInfo.s2, indexPriceInfo.s3, indexPriceInfo.ema].map((x) =>
+    const [fS2, fS3, fEma] = [indexPriceInfo.s2, indexPriceInfo.s3 ?? 0, indexPriceInfo.ema].map((x) =>
       floatToABK64x64(x)
     ) as [bigint, bigint, bigint];
     const proxyCalls: Multicall3.Call3Struct[] = [
@@ -556,7 +557,7 @@ export default class MarketData extends PerpetualDataHandler {
         fPrice = await this.proxyContract.queryPerpetualPrice(
           perpId,
           floatToABK64x64(tradeAmountBC),
-          [indexPriceInfo.s2, indexPriceInfo.s3],
+          [floatToABK64x64(indexPriceInfo.s2), floatToABK64x64(indexPriceInfo.s3 ?? 0)],
           indexPriceInfo.conf,
           indexPriceInfo.predMktCLOBParams
         );
@@ -748,12 +749,20 @@ export default class MarketData extends PerpetualDataHandler {
     let newMarginCashCC = currentMarginCashCC + deltaCashCC + traderDepositCC;
     let newEntryPrice = newPositionBC == 0 ? 0 : Math.abs(newLockedInValueQC / newPositionBC);
     let newMarginBalanceCC = newMarginCashCC + (newPositionBC * Sm - newLockedInValueQC) / S3;
-    let newLeverage =
-      newPositionBC == 0
-        ? 0
-        : newMarginBalanceCC <= 0
-        ? Infinity
-        : (Math.abs(newPositionBC) * Sm) / S3 / newMarginBalanceCC;
+
+    let newLeverage: number;
+    if (newPositionBC === 0) {
+      newLeverage = 0;
+    } else if (newMarginBalanceCC <= 0) {
+      newLeverage = Infinity;
+    } else {
+      let p = Sm;
+      if (isPredMkt) {
+        p -= 1;
+        p = newPositionBC > 0 ? p : 1 - p;
+      }
+      newLeverage = Math.abs(newPositionBC * p) / S3 / newMarginBalanceCC;
+    }
 
     // Liquidation params
     let [S2Liq, S3Liq, tau] = MarketData._getLiquidationParams(
@@ -1185,7 +1194,7 @@ export default class MarketData extends PerpetualDataHandler {
     const perpId = PerpetualDataHandler.symbolToPerpetualId(symbol, this.symbolToPerpStaticInfo);
     const poolInfo = this.poolStaticInfos[this.getPoolStaticInfoIndexFromSymbol(symbol)];
     const indexPriceInfo = await this.priceFeedGetter.fetchPricesForPerpetual(symbol);
-    const [fS2, fS3, fEma] = [indexPriceInfo.s2, indexPriceInfo.s3, indexPriceInfo.ema].map((x) =>
+    const [fS2, fS3, fEma] = [indexPriceInfo.s2, indexPriceInfo.s3 ?? 0, indexPriceInfo.ema].map((x) =>
       floatToABK64x64(x)
     ) as [bigint, bigint, bigint];
     const proxyCalls: Multicall3.Call3Struct[] = [
@@ -1258,20 +1267,20 @@ export default class MarketData extends PerpetualDataHandler {
       account.entryPrice * currentPositionBC,
       Sm,
       Sm,
-      indexPriceInfo.s3,
+      indexPriceInfo.s3 ?? 0,
       totLong,
       totShort,
       maxShortPosPerp,
       maxLongPosPerp
     );
     const maxLong = pmFindMaxTradeSize(
-      -1,
+      1,
       currentPositionBC,
       availCashCC,
       account.entryPrice * currentPositionBC,
       Sm,
       Sm,
-      indexPriceInfo.s3,
+      indexPriceInfo.s3 ?? 0,
       totLong,
       totShort,
       maxShortPosPerp,
@@ -1355,7 +1364,7 @@ export default class MarketData extends PerpetualDataHandler {
     const isPredMkt = false;
     const indexPriceInfo = await this.priceFeedGetter.fetchPricesForPerpetual(symbol);
     let coll2SettlePromise = this.fetchCollateralToSettlementConversion(symbol);
-    const [fS2, fS3, fEma] = [indexPriceInfo.s2, indexPriceInfo.s3, indexPriceInfo.ema].map((x) =>
+    const [fS2, fS3, fEma] = [indexPriceInfo.s2, indexPriceInfo.s3 ?? 0, indexPriceInfo.ema].map((x) =>
       floatToABK64x64(x)
     ) as [bigint, bigint, bigint];
     if (!this.proxyContract || !this.multicall) {
@@ -1516,12 +1525,11 @@ export default class MarketData extends PerpetualDataHandler {
    *
    * @returns {number} Price of index in given currency.
    */
-  public async getOraclePrice(base: string, quote: string, overrides?: Overrides): Promise<number | undefined> {
+  public async getOraclePrice(base: string, quote: string, overrides?: Overrides) {
     if (!this.proxyContract) {
       throw Error("no proxy contract initialized. Use createProxyInstance().");
     }
-    let px = await this.proxyContract.getOraclePrice([toBytes4(base), toBytes4(quote)], overrides || {});
-    return px == undefined ? undefined : ABK64x64ToFloat(px);
+    return await this.proxyContract.getOraclePrice([toBytes4(base), toBytes4(quote)], overrides || {});
   }
 
   /**
@@ -1669,7 +1677,7 @@ export default class MarketData extends PerpetualDataHandler {
       quantity,
       this.symbolToPerpStaticInfo,
       this.proxyContract,
-      [priceInfo.s2, priceInfo.s3], //s2,s3
+      [priceInfo.s2, priceInfo.s3 ?? 0], //s2,s3
       priceInfo.conf, //conf
       priceInfo.predMktCLOBParams, //params
       overrides
@@ -2293,6 +2301,7 @@ export default class MarketData extends PerpetualDataHandler {
         indexPrice: 0, //fill later
         collToQuoteIndexPrice: 0, //fill later
         markPremium: ABK64x64ToFloat(perp.currentMarkPremiumRate!.fPrice),
+        markPrice: 0, //fill later
         midPrice: 0, // fill later
         currentFundingRateBps: 1e4 * ABK64x64ToFloat(perp.fCurrentFundingRate!),
         openInterestBC: ABK64x64ToFloat(perp.fOpenInterest!),
@@ -2376,6 +2385,18 @@ export default class MarketData extends PerpetualDataHandler {
         indexS3 = idxPriceS3Pair[0];
       }
       perp.collToQuoteIndexPrice = indexS3;
+
+      const emaKey = info!.S2Symbol + ":ema";
+      let markPrice: number;
+      if (idxPriceMap.has(emaKey)) {
+        let ema: number;
+        let res = idxPriceMap.get(emaKey);
+        ema = res![0];
+        markPrice = ema + perp.markPremium;
+      } else {
+        markPrice = perp.indexPrice * (1 + perp.markPremium);
+      }
+      perp.markPrice = markPrice;
       perp.midPrice = midPriceMap.get(symbol3s!)!;
       // which pool?
       const poolId = info!.poolId;

package/src/nodeSDKTypes.ts

@@ -147,6 +147,7 @@ export interface PerpetualState {
   indexPrice: number;
   collToQuoteIndexPrice: number;
   markPremium: number;
+  markPrice: number;
   midPrice: number;
   currentFundingRateBps: number;
   openInterestBC: number;
@@ -539,10 +540,10 @@ export const referralTypes = {
 // prediction markets and regular markets
 export interface IdxPriceInfo {
   s2: number;
-  s3: number;
+  s3?: number;
   ema: number;
   s2MktClosed: boolean;
-  s3MktClosed: boolean;
+  s3MktClosed?: boolean;
   conf: bigint;
   predMktCLOBParams: bigint;
 }

package/src/perpetualDataHandler.ts

@@ -37,6 +37,7 @@ import {
 } from "./constants";
 import {
   ERC20__factory,
+  IPerpetualManager__factory,
   LimitOrderBook,
   LimitOrderBookFactory,
   LimitOrderBookFactory__factory,
@@ -45,7 +46,7 @@ import {
   Multicall3__factory,
   OracleFactory__factory,
 } from "./contracts";
-import { IPerpetualInfo } from "./contracts/IPerpetualManager";
+import { IPerpetualInfo, IPerpetualManager } from "./contracts/IPerpetualManager";
 import { IClientOrder, IPerpetualOrder } from "./contracts/LimitOrderBook";
 
 import {
@@ -111,7 +112,7 @@ export default class PerpetualDataHandler {
   protected symbolToTokenAddrMap: Map<string, string>;
   public chainId: bigint;
   public network: Network;
-  protected proxyContract: Contract | null = null;
+  protected proxyContract: IPerpetualManager | null = null;
   protected proxyABI: Interface;
   protected proxyAddr: string;
   // oracle
@@ -181,7 +182,7 @@ export default class PerpetualDataHandler {
     if (network.chainId !== this.chainId) {
       throw new Error(`Provider: chain id ${network.chainId} does not match config (${this.chainId})`);
     }
-    this.proxyContract = new Contract(this.proxyAddr, this.config.proxyABI!, signerOrProvider);
+    this.proxyContract = IPerpetualManager__factory.connect(this.proxyAddr, signerOrProvider);
     this.multicall = Multicall3__factory.connect(this.config.multicall ?? MULTICALL_ADDRESS, this.signerOrProvider);
     await this._fillSymbolMaps(overrides);
   }
@@ -616,7 +617,7 @@ export default class PerpetualDataHandler {
    * @returns array with PerpetualStaticInfo for each perpetual
    */
   public static async getPerpetualStaticInfo(
-    _proxyContract: Contract,
+    _proxyContract: IPerpetualManager,
     nestedPerpetualIDs: Array<Array<number>>,
     symbolList: Map<string, string>,
     overrides?: Overrides
@@ -695,7 +696,7 @@ export default class PerpetualDataHandler {
   public static async _getLiquidityPools(
     fromIdx: number,
     toIdx: number,
-    _proxyContract: Contract,
+    _proxyContract: IPerpetualManager,
     _symbolList: Map<string, string>,
     overrides?: Overrides
   ): Promise<LiquidityPoolData[]> {
@@ -742,7 +743,7 @@ export default class PerpetualDataHandler {
    */
   public static async _getPerpetuals(
     ids: number[],
-    _proxyContract: Contract,
+    _proxyContract: IPerpetualManager,
     _symbolList: Map<string, string>,
     overrides?: Overrides
   ): Promise<PerpetualData[]> {
@@ -813,7 +814,7 @@ export default class PerpetualDataHandler {
   }
 
   public static async getPoolStaticInfo(
-    _proxyContract: Contract,
+    _proxyContract: IPerpetualManager,
     overrides?: Overrides
   ): Promise<{
     nestedPerpetualIDs: Array<Array<number>>;
@@ -932,7 +933,7 @@ export default class PerpetualDataHandler {
     let traderState = await _proxyContract.getTraderState(
       perpId,
       traderAddr,
-      [_pxInfo.ema, _pxInfo.s3].map((x) => floatToABK64x64(x)) as [bigint, bigint],
+      [_pxInfo.ema, _pxInfo.s3 ?? 0].map((x) => floatToABK64x64(x)) as [bigint, bigint],
       overrides || {}
     );
     return PerpetualDataHandler.buildMarginAccountFromState(
@@ -1132,7 +1133,7 @@ export default class PerpetualDataHandler {
       callData: _proxyContract.interface.encodeFunctionData("getTraderState", [
         PerpetualDataHandler.symbolToPerpetualId(symbols[i], symbolToPerpStaticInfo),
         _addr,
-        [_pxInfo[i].ema, _pxInfo[i].s3].map((x) => floatToABK64x64(x)) as [bigint, bigint],
+        [_pxInfo[i].ema, _pxInfo[i].s3 ?? 0].map((x) => floatToABK64x64(x)) as [bigint, bigint],
       ]),
     }));
     const encodedResults = await _multicall.aggregate3.staticCall(proxyCalls, overrides || {});
@@ -1155,7 +1156,7 @@ export default class PerpetualDataHandler {
     symbol: string,
     tradeAmount: number,
     symbolToPerpStaticInfo: Map<string, PerpetualStaticInfo>,
-    _proxyContract: Contract,
+    _proxyContract: IPerpetualManager,
     indexPrices: [number, number],
     conf: bigint,
     params: bigint,
@@ -1187,7 +1188,7 @@ export default class PerpetualDataHandler {
   protected static async _queryPerpetualMarkPrice(
     symbol: string,
     symbolToPerpStaticInfo: Map<string, PerpetualStaticInfo>,
-    _proxyContract: Contract,
+    _proxyContract: IPerpetualManager,
     indexPrices: IdxPriceInfo,
     isPredMkt: boolean,
     overrides?: Overrides
@@ -1207,7 +1208,7 @@ export default class PerpetualDataHandler {
   protected static async _queryPerpetualState(
     symbol: string,
     symbolToPerpStaticInfo: Map<string, PerpetualStaticInfo>,
-    _proxyContract: Contract,
+    _proxyContract: IPerpetualManager,
     _multicall: Multicall3,
     indexPrices: IdxPriceInfo,
     overrides?: Overrides
@@ -1226,7 +1227,7 @@ export default class PerpetualDataHandler {
         allowFailure: false,
         callData: _proxyContract.interface.encodeFunctionData("getAMMState", [
           perpId,
-          [indexPrices.s2, indexPrices.s3].map(floatToABK64x64) as [bigint, bigint],
+          [indexPrices.s2, indexPrices.s3 ?? 0].map(floatToABK64x64) as [bigint, bigint],
         ]),
       },
       {
@@ -1281,18 +1282,28 @@ export default class PerpetualDataHandler {
     } else if (staticInfo.collateralCurrencyType == CollaterlCCY.QUOTE) {
       S3 = 1;
     }
+    const isPred = PerpetualDataHandler.isPredictionMarketStatic(staticInfo);
+    let markPrice: number;
+    if (isPred) {
+      // ema + premium
+      markPrice = indexPrices.ema + ABK64x64ToFloat(ammState[8]);
+    } else {
+      // S2 * (1+premium)
+      markPrice = indexPrices.s2 * (1 + ABK64x64ToFloat(ammState[8]));
+    }
     let state: PerpetualState = {
       id: perpId,
       state: PERP_STATE_STR[Number(ammState[13])],
       baseCurrency: ccy[0],
       quoteCurrency: ccy[1],
       indexPrice: S2,
-      collToQuoteIndexPrice: S3,
+      collToQuoteIndexPrice: S3 ?? (ccy[0] === ccy[1] ? S2 : 1),
       markPremium: ABK64x64ToFloat(ammState[8]),
+      markPrice: markPrice,
       midPrice: ABK64x64ToFloat(ammState[10]),
       currentFundingRateBps: ABK64x64ToFloat(ammState[14]) * 1e4,
       openInterestBC: ABK64x64ToFloat(ammState[11]),
-      isMarketClosed: indexPrices.s2MktClosed || indexPrices.s3MktClosed,
+      isMarketClosed: indexPrices.s2MktClosed || (indexPrices.s3MktClosed !== undefined && indexPrices.s3MktClosed),
       longBC: ABK64x64ToFloat(longShort[0]),
       shortBC: ABK64x64ToFloat(longShort[1]),
     };

package/src/polyMktsPxFeed.ts

@@ -16,8 +16,19 @@ export default class PolyMktsPxFeed {
   private ids: Map<string, PolyConfig>;
   private oracleEndpoint: string;
 
-  constructor(config: PriceFeedConfig, oracleEndpoint: string) {
+  constructor(config: PriceFeedConfig) {
     this.ids = new Map<string, PolyConfig>();
+    this.oracleEndpoint = "";
+    for (let k = 0; k < config.endpoints.length; k++) {
+      if (config.endpoints[k].type == "polymarket") {
+        let endp = config.endpoints[k].writeEndpoints;
+        this.oracleEndpoint = endp[Math.floor(Math.random() * endp.length)];
+        break;
+      }
+    }
+    if (this.oracleEndpoint == "") {
+      throw Error("no polymarkets write endpoint defined in priceFeedConfig");
+    }
     for (let k = 0; k < config.ids.length; k++) {
       if (config.ids[k].type == "polymarket") {
         const sym = config.ids[k].symbol;
@@ -31,7 +42,7 @@ export default class PolyMktsPxFeed {
       }
     }
 
-    this.oracleEndpoint = oracleEndpoint.replace(/\/$/, "") + "v2/updates/price/latest?encoding=base64&ids[]=";
+    this.oracleEndpoint = this.oracleEndpoint.replace(/\/$/, "") + "/v2/updates/price/latest?encoding=base64&ids[]=";
   }
 
   public isPolyMktsSym(sym: string) {
@@ -58,8 +69,8 @@ export default class PolyMktsPxFeed {
       throw new Error(`failed to fetch posts (${response.status}): ${response.statusText} ${query}`);
     }
     const data = await response.json();
-    const emaObj = data.parsed.ema_price as PriceFeedJson;
-    const pxObj = data.parsed.price as PriceFeedJson;
+    const emaObj = data.parsed[0].ema_price as PriceFeedJson;
+    const pxObj = data.parsed[0].price as PriceFeedJson;
 
     const px = Number(pxObj.price) * Math.pow(10, pxObj.expo);
     const ema = Number(emaObj.price) * Math.pow(10, emaObj.expo);

package/src/priceFeeds.ts

@@ -68,8 +68,7 @@ export default class PriceFeeds {
     if (this.writeFeedEndpoints.length == 0) {
       throw new Error("PriceFeeds: no writeEndpoints provided in config");
     }
-    const idx = Math.floor(Math.random() * this.writeFeedEndpoints.length);
-    this.polyMktsPxFeed = new PolyMktsPxFeed(this.config, this.writeFeedEndpoints[idx]);
+    this.polyMktsPxFeed = new PolyMktsPxFeed(this.config);
     this.dataHandler = dataHandler;
     this.triangulations = new Map<string, [string[], boolean[]]>();
   }
@@ -352,6 +351,7 @@ export default class PriceFeeds {
         prices.push(info);
       } catch (error) {
         console.log("fetchPriceForSym failed for " + symbols[k]);
+        console.log(error);
         prices.push(undefined);
       }
       if (k > 0) {

package/src/version.ts

@@ -1 +1 @@
-export const D8X_SDK_VERSION = "2.1.0-alpha2";
+export const D8X_SDK_VERSION = "2.1.1-alpha2";

package/src/writeAccessHandler.ts

@@ -9,7 +9,7 @@ import {
   Wallet,
 } from "ethers";
 import { MAX_UINT_256, MULTICALL_ADDRESS } from "./constants";
-import { ERC20__factory, MockTokenSwap__factory, Multicall3__factory } from "./contracts";
+import { ERC20__factory, IPerpetualManager__factory, MockTokenSwap__factory, Multicall3__factory } from "./contracts";
 import { PayableOverrides } from "./contracts/common";
 import { floatToDecN } from "./d8XMath";
 import MarketData from "./marketData";
@@ -66,7 +66,7 @@ export default class WriteAccessHandler extends PerpetualDataHandler {
       const mktData = providerOrMarketData;
       this.nodeURL = mktData.config.nodeURL;
       this.provider = new JsonRpcProvider(mktData.config.nodeURL, mktData.network, { staticNetwork: true });
-      this.proxyContract = new Contract(mktData.getProxyAddress(), this.config.proxyABI!, this.provider);
+      this.proxyContract = IPerpetualManager__factory.connect(mktData.getProxyAddress(), this.provider);
       this.multicall = Multicall3__factory.connect(this.config.multicall ?? MULTICALL_ADDRESS, this.provider);
       ({
         nestedPerpetualIDs: this.nestedPerpetualIDs,