zo-sdk 0.1.42 → 0.1.44

package/src/implementations/USDZDataAPI.ts

@@ -19,6 +19,8 @@ import type {
   IUSDZFundingFeeModel,
   IUSDZMarketInfo,
   IUSDZMarketValuationInfo,
+  IUSDZOiFundingModel,
+  IUSDZOiFundingState,
   IUSDZOrderCapInfo,
   IUSDZOrderInfo,
   IUSDZPositionCapInfo,
@@ -203,8 +205,25 @@ export class USDZDataAPI extends BaseDataAPI implements IUSDZDataAPI {
     const symbolPromises = Object.keys(this.consts.zoCore.symbols).map(async (symbol) => {
       const [direction, tokenId] = parseSymbolKey(symbol)
       const symbolInfo = await this.getSymbolInfo(tokenId, direction === 'long')
-      const deltaSize = USDZDataAPI.calcDeltaSize(symbolInfo, (await this.getOraclePrice(tokenId)).getPriceUnchecked().getPriceAsNumberUnchecked())
-      const fundingFeeDelta = USDZDataAPI.calculateSymbolFundingFee(symbolInfo, symbolInfo.fundingFeeModel, (await this.getOraclePrice(tokenId)).getPriceUnchecked().getPriceAsNumberUnchecked(), marketInfo.lpSupplyWithDecimals, Date.now() / 1000)
+      const deltaSize = USDZDataAPI.calcDeltaSize(
+        symbolInfo,
+        (await this.getOraclePrice(tokenId)).getPriceUnchecked().getPriceAsNumberUnchecked(),
+      )
+
+      // OI context for funding fee delta
+      const oiState = await this.getSymbolOiFundingState(tokenId)
+      const pairedSymbol = await this.getSymbolInfo(tokenId, !(direction === 'long'))
+
+      const fundingFeeDelta = USDZDataAPI.calculateSymbolFundingFee(
+        symbolInfo,
+        symbolInfo.fundingFeeModel,
+        (await this.getOraclePrice(tokenId)).getPriceUnchecked().getPriceAsNumberUnchecked(),
+        marketInfo.lpSupplyWithDecimals,
+        Date.now() / 1000,
+        oiState && oiState.enabled ? oiState.model : undefined,
+        pairedSymbol.openingSize,
+      )
+
       return fundingFeeDelta + deltaSize
     })
 
@@ -315,6 +334,27 @@ export class USDZDataAPI extends BaseDataAPI implements IUSDZDataAPI {
     }
   }
 
+  /**
+   * Gets USDZ symbol OI funding state (global per symbol)
+   */
+  public async getSymbolOiFundingState(indexToken: string): Promise<IUSDZOiFundingState | null> {
+    this.validateCache()
+    try {
+      const rawData = await this.provider.getDynamicFieldObject({
+        parentId: this.consts.zoCore.market,
+        name: {
+          type: `${this.consts.zoCore.upgradedPackage}::funding::FundingStateKey<${this.consts.coins[indexToken].module}>`,
+          value: { dummy_field: false },
+        },
+      })
+      return USDZDataAPI.parseOiFundingState(rawData)
+    }
+    catch (e: any) {
+      console.error('Error Fetching USDZ Symbol OI Funding State:', e)
+      return null
+    }
+  }
+
   public async getPositionCapInfoList(owner: string): Promise<IUSDZPositionCapInfo[]> {
     const positionCapInfoList: IUSDZPositionCapInfo[] = []
     let cursor: string | undefined | null
@@ -539,18 +579,37 @@ export class USDZDataAPI extends BaseDataAPI implements IUSDZDataAPI {
   }
 
   public async fundingFeeRate(indexToken: string, long: boolean): Promise<number> {
-    const symbol = await this.getSymbolInfo(indexToken, long)
-    if (symbol.lastUpdate <= 0) {
+    const oiState = await this.getSymbolOiFundingState(indexToken)
+
+    if (!oiState || !oiState.enabled) {
+      const symbol = await this.getSymbolInfo(indexToken, long)
+      if (symbol.lastUpdate <= 0) {
+        return 0
+      }
+      const price = (await this.getOraclePrice(indexToken)).getPriceUnchecked().getPriceAsNumberUnchecked()
+      const lpSupplyAmount = (await this.getMarketInfo()).lpSupplyWithDecimals
+      const model = symbol.fundingFeeModel
+      const elapsed = SECONDS_PER_EIGHT_HOUR
+
+      const deltaSize = USDZDataAPI.calcDeltaSize(symbol, price)
+      const pnlPerLp = (symbol.realisedPnl + symbol.unrealisedFundingFeeValue + deltaSize) / lpSupplyAmount
+      return USDZDataAPI.calcFundingFeeRate(model, pnlPerLp, elapsed)
+    }
+
+    // OI model enabled: rate based on long/short imbalance
+    const longSymbol = await this.getSymbolInfo(indexToken, true)
+    const shortSymbol = await this.getSymbolInfo(indexToken, false)
+
+    if (longSymbol.lastUpdate <= 0 && shortSymbol.lastUpdate <= 0) {
       return 0
     }
-    const price = (await this.getOraclePrice(indexToken)).getPriceUnchecked().getPriceAsNumberUnchecked()
-    const lpSupplyAmount = (await this.getMarketInfo()).lpSupplyWithDecimals
-    const model = symbol.fundingFeeModel
+
     const elapsed = SECONDS_PER_EIGHT_HOUR
+    const longSize = longSymbol.openingSize
+    const shortSize = shortSymbol.openingSize
 
-    const deltaSize = USDZDataAPI.calcDeltaSize(symbol, price)
-    const pnlPerLp = (symbol.realisedPnl + symbol.unrealisedFundingFeeValue + deltaSize) / lpSupplyAmount
-    return USDZDataAPI.calcFundingFeeRate(model, pnlPerLp, elapsed)
+    const deltaRate = USDZDataAPI.calcOiFundingFeeRate(oiState.model, longSize, shortSize, elapsed)
+    return long ? deltaRate : -deltaRate
   }
 
   public async rebaseFeeRate(collateralToken: string, increase: boolean, amount: number): Promise<number> {
@@ -636,10 +695,32 @@ export class USDZDataAPI extends BaseDataAPI implements IUSDZDataAPI {
     return pnlPerRate >= 0 ? -secondsRate : secondsRate
   }
 
-  private static calcAccFundingFeeRate(symbol: IUSDZSymbolInfo, model: IUSDZFundingFeeModel, price: number, lpSupplyAmount: number, timestamp: number): number {
+  private static calcOiFundingFeeRate(model: IUSDZOiFundingModel, longSize: number, shortSize: number, elapsed: number): number {
+    const imbalance = Math.abs(longSize - shortSize)
+    const total = longSize + shortSize > 0 ? longSize + shortSize : 1
+    const dailyRate = Math.min((model.multiplier * (imbalance ** model.exponent)) / total, model.max)
+    const secondsRate = dailyRate * elapsed / SECONDS_PER_EIGHT_HOUR
+    return longSize >= shortSize ? secondsRate : -secondsRate
+  }
+
+  private static calcAccFundingFeeRate(
+    symbol: IUSDZSymbolInfo,
+    model: IUSDZFundingFeeModel,
+    price: number,
+    lpSupplyAmount: number,
+    timestamp: number,
+    oiModel?: IUSDZOiFundingModel,
+    pairedOpeningSize?: number,
+  ): number {
     if (symbol.lastUpdate > 0) {
       const elapsed = timestamp - symbol.lastUpdate
       if (elapsed > 0) {
+        if (oiModel && typeof pairedOpeningSize === 'number') {
+          const longSize = symbol.long ? symbol.openingSize : pairedOpeningSize
+          const shortSize = symbol.long ? pairedOpeningSize : symbol.openingSize
+          const deltaRate = USDZDataAPI.calcOiFundingFeeRate(oiModel, longSize, shortSize, elapsed)
+          return symbol.accFundingRate + deltaRate
+        }
         const deltaSize = USDZDataAPI.calcDeltaSize(symbol, price)
         const pnlPerLp = (symbol.realisedPnl + symbol.unrealisedFundingFeeValue + deltaSize) / lpSupplyAmount
         return symbol.accFundingRate + USDZDataAPI.calcFundingFeeRate(model, pnlPerLp, elapsed)
@@ -648,8 +729,24 @@ export class USDZDataAPI extends BaseDataAPI implements IUSDZDataAPI {
     return symbol.accFundingRate
   }
 
-  private static calculateSymbolFundingFee(symbol: IUSDZSymbolInfo, model: IUSDZFundingFeeModel, price: number, lpSupplyAmount: number, timestamp: number): number {
-    const accFundingRate = USDZDataAPI.calcAccFundingFeeRate(symbol, model, price, lpSupplyAmount, timestamp)
+  private static calculateSymbolFundingFee(
+    symbol: IUSDZSymbolInfo,
+    model: IUSDZFundingFeeModel,
+    price: number,
+    lpSupplyAmount: number,
+    timestamp: number,
+    oiModel?: IUSDZOiFundingModel,
+    pairedOpeningSize?: number,
+  ): number {
+    const accFundingRate = USDZDataAPI.calcAccFundingFeeRate(
+      symbol,
+      model,
+      price,
+      lpSupplyAmount,
+      timestamp,
+      oiModel,
+      pairedOpeningSize,
+    )
     return symbol.unrealisedFundingFeeValue + (accFundingRate - symbol.accFundingRate) * symbol.openingSize
   }
 
@@ -836,15 +933,50 @@ export class USDZDataAPI extends BaseDataAPI implements IUSDZDataAPI {
       openTimestamp: parseValue(positionFields.open_timestamp),
     }
 
-    positionInfo.reservingFeeAmount = USDZDataAPI.calculatePositionReserveFee(positionInfo, await this.getVaultInfo(positionInfo.collateralToken), (await this.getVaultInfo(positionInfo.collateralToken)).reservingFeeModel, Date.now() / 1000)
-    positionInfo.fundingFeeValue = USDZDataAPI.calculatePositionFundingFee(positionInfo, await this.getSymbolInfo(positionInfo.indexToken, positionInfo.long), (await this.getSymbolInfo(positionInfo.indexToken, positionInfo.long)).fundingFeeModel, (await this.getOraclePrice(positionInfo.indexToken)).getPriceUnchecked().getPriceAsNumberUnchecked(), (await this.getMarketInfo()).lpSupplyWithDecimals, Date.now() / 1000)
+    positionInfo.reservingFeeAmount = USDZDataAPI.calculatePositionReserveFee(
+      positionInfo,
+      await this.getVaultInfo(positionInfo.collateralToken),
+      (await this.getVaultInfo(positionInfo.collateralToken)).reservingFeeModel,
+      Date.now() / 1000,
+    )
+
+    // OI context for funding: fetch state and paired side size when enabled
+    const oiState = await this.getSymbolOiFundingState(positionInfo.indexToken)
+    const pairedSymbol = await this.getSymbolInfo(positionInfo.indexToken, !positionInfo.long)
+    positionInfo.fundingFeeValue = USDZDataAPI.calculatePositionFundingFee(
+      positionInfo,
+      await this.getSymbolInfo(positionInfo.indexToken, positionInfo.long),
+      (await this.getSymbolInfo(positionInfo.indexToken, positionInfo.long)).fundingFeeModel,
+      (await this.getOraclePrice(positionInfo.indexToken)).getPriceUnchecked().getPriceAsNumberUnchecked(),
+      (await this.getMarketInfo()).lpSupplyWithDecimals,
+      Date.now() / 1000,
+      oiState && oiState.enabled ? oiState.model : undefined,
+      pairedSymbol.openingSize,
+    )
 
     return positionInfo
   }
 
-  private static calculatePositionFundingFee(position: IUSDZPositionInfo, symbol: IUSDZSymbolInfo, model: IUSDZFundingFeeModel, price: number, lpSupplyAmount: number, timestamp: number): number {
-    const accFundingRate = USDZDataAPI.calcAccFundingFeeRate(symbol, model, price, lpSupplyAmount, timestamp)
-    return position.fundingFeeValue + (accFundingRate - symbol.accFundingRate) * position.positionSize
+  private static calculatePositionFundingFee(
+    position: IUSDZPositionInfo,
+    symbol: IUSDZSymbolInfo,
+    model: IUSDZFundingFeeModel,
+    price: number,
+    lpSupplyAmount: number,
+    timestamp: number,
+    oiModel?: IUSDZOiFundingModel,
+    pairedOpeningSize?: number,
+  ): number {
+    const accFundingRate = USDZDataAPI.calcAccFundingFeeRate(
+      symbol,
+      model,
+      price,
+      lpSupplyAmount,
+      timestamp,
+      oiModel,
+      pairedOpeningSize,
+    )
+    return position.fundingFeeValue + (accFundingRate - position.lastFundingRate) * position.positionSize
   }
 
   private static parseRebaseFeeModel(raw: any): { base: number, multiplier: number } {
@@ -871,6 +1003,21 @@ export class USDZDataAPI extends BaseDataAPI implements IUSDZDataAPI {
     }
   }
 
+  private static parseOiFundingState(raw: any): IUSDZOiFundingState {
+    const content = raw.data.content.fields
+    return {
+      id: content.id.id,
+      enabled: content.enabled,
+      last_update: parseValue(content.last_update),
+      model: {
+        id: content.model.fields.id.id,
+        multiplier: parseValue(content.model.fields.multiplier),
+        exponent: parseValue(content.model.fields.exponent),
+        max: parseValue(content.model.fields.max),
+      },
+    }
+  }
+
   private parseOrderInfo(raw: any, capId: string): IUSDZOrderInfo {
     const { content } = raw.data
     const { fields } = content.fields.value

package/src/interfaces/slp.ts

@@ -87,6 +87,20 @@ export interface ISLPSymbolConfig {
   instant_exit_fee_config: ISLPPositionInstantExitFeeConfig
 }
 
+export interface ISLPOiFundingModel {
+  id: string
+  multiplier: number
+  exponent: number
+  max: number
+}
+
+export interface ISLPOiFundingState {
+  id: string
+  enabled: boolean
+  last_update: number
+  model: ISLPOiFundingModel
+}
+
 // Sudo SDK specific data structures
 export interface ISudoMarket {
   lpSupply: bigint

package/src/interfaces/usdz.ts

@@ -89,6 +89,19 @@ export interface IUSDZSymbolConfig {
   instant_exit_fee_config: IUSDZPositionInstantExitFeeConfig
 }
 
+export interface IUSDZOiFundingModel {
+  id: string
+  multiplier: number
+  exponent: number
+  max: number
+}
+export interface IUSDZOiFundingState {
+  id: string
+  enabled: boolean
+  last_update: number
+  model: IUSDZOiFundingModel
+}
+
 // USDZ-specific data API interface
 export interface IUSDZDataAPI extends IBaseDataAPI {
   getSymbolConfig: (indexToken: string, long: boolean) => Promise<IUSDZSymbolConfig | null>