zo-sdk 0.0.50 → 0.1.0

package/src/consts/index.ts

@@ -1,10 +1,12 @@
 import { reverseKeyValue } from '../utils'
-import mainnetJson from './deployments-mainnet.json'
-import testnetJson from './deployments-testnet.json'
+import zlpMainnetJson from './deployments-zlp-mainnet.json'
+import zlpTestnetJson from './deployments-zlp-testnet.json'
+import usdzMainnetJson from './deployments-usdz-mainnet.json'
+import usdzTestnetJson from './deployments-usdz-testnet.json'
+import slpMainnetJson from './deployments-slp-mainnet.json'
+import slpTestnetJson from './deployments-slp-testnet.json'
 import PriceIdToObjectIdMainnet from './price_id_to_object_id.mainnet.json'
 import PriceIdToObjectIdTestnet from './price_id_to_object_id.testnet.json'
-import mainnetStakingJson from './staking/deployments-mainnet.json'
-import testnetStakingJson from './staking/deployments-testnet.json'
 
 interface IVault {
   weight: string
@@ -25,8 +27,8 @@ interface ICoin {
 }
 
 interface IPrizePool {
-  id: string;
-  display: string;
+  id: string
+  display: string
 }
 
 type IVersionedContract = string
@@ -50,57 +52,120 @@ export interface IConsts {
     referralsParent: string
     ordersParent: string
   }
-  pythFeeder: {
+  sudoCore: {
     package: string
-    state: IVersionedContract
-    wormhole: {
-      package: string
-      state: IVersionedContract
-    }
-    feeder: IFeeder
+    upgradedPackage: string
+    upgradeCap: string
+    adminCap: string
+    market: IVersionedContract
+    slpMetadata: IVersionedContract
+    rebaseFeeModel: IVersionedContract
+    vaultsParent: string
+    symbolsParent: string
+    positionsParent: string
+    vaults: Record<string, IVault>
+    symbols: Record<string, ISymbol>
+    referralsParent: string
+    ordersParent: string
+  }
+  usdzCore: {
+    package: string
+    upgradedPackage: string
+    upgradeCap: string
+    adminCap: string
+    market: IVersionedContract
+    usdzMetadata: IVersionedContract
+    rebaseFeeModel: IVersionedContract
+    vaultsParent: string
+    symbolsParent: string
+    positionsParent: string
+    vaults: Record<string, IVault>
+    symbols: Record<string, ISymbol>
+    referralsParent: string
+    ordersParent: string
   }
-  coins: Record<string, ICoin>
   zoStaking: {
     package: string
+    upgradedPackage: string
     upgradeCap: string
     adminCap: string
     pool: string
   },
   zoLootbox: {
-    package: string;
-    upgradedPackage: string;
-    upgradeCap: string;
-    adminCap: string;
-    lootboxTreasury: string;
-    lootboxSettings: string;
-    prizePoolParent: string;
-    prizePools: {
-      [key: string]: IPrizePool;
-    };
+    package: string
+    upgradedPackage: string
+    upgradeCap: string
+    adminCap: string
+    lootboxTreasury: string
+    lootboxSettings: string
+    prizePoolParent: string
+    prizePools: Record<string, IPrizePool>
   }
+  sudoStaking: {
+    package: string
+    upgradedPackage: string
+    upgradeCap: string
+    adminCap: string
+    pool: string
+  }
+  sudoNft: {
+    package: string
+    upgradedPackage: string
+    upgradeCap: string
+    adminCap: string
+    mintSettings: string
+    cardRegistry: string
+    displayCard: string
+    displayMintTicket: string
+    silverCardTracker: string
+    emeraldCardTracker: string
+    blackCardTracker: string
+    transferPolicy: string
+    transferPolicyCap: string
+  }
+  sudoLootbox: {
+    package: string
+    upgradedPackage: string
+    upgradeCap: string
+    adminCap: string
+    lootboxTreasury: string
+    lootboxSettings: string
+    prizePoolParent: string
+    prizePool: Record<string, IPrizePool>
+  }
+  pythFeeder: {
+    package: string
+    state: IVersionedContract
+    wormhole: {
+      package: string
+      state: IVersionedContract
+    }
+    feeder: IFeeder
+  }
+  coins: Record<string, ICoin>
 }
 
 function toCamelCase(str: string): string {
-  return str.replace(/_([a-z])/g, (_, letter) => letter.toUpperCase());
+  return str.replace(/_([a-z])/g, (_, letter) => letter.toUpperCase())
 }
 
 function parse(obj: any): any {
   if (typeof obj !== 'object' || obj === null) {
-    return obj;
+    return obj
   }
 
   if (Array.isArray(obj)) {
-    return obj.map(parse);
+    return obj.map(parse)
   }
 
-  const newObj: any = {};
+  const newObj: any = {}
 
   for (const key in obj) {
-    const camelCaseKey = toCamelCase(key);
-    newObj[camelCaseKey] = parse(obj[key]);
+    const camelCaseKey = toCamelCase(key)
+    newObj[camelCaseKey] = parse(obj[key])
   }
 
-  return newObj;
+  return newObj
 }
 
 export enum Network {
@@ -109,17 +174,45 @@ export enum Network {
   DEVNET = 'devnet',
 }
 
+export enum LPToken {
+  ZLP = 'ZLP',
+  USDZ = 'USDZ',
+  SLP = 'SLP',
+}
+
 function throwNetworkError(network: string): never {
   throw new Error(`Unknown network: ${network}`)
 }
 
-export function getConsts(network: string): IConsts {
+export function getConsts(network: string, lpToken: LPToken = LPToken.ZLP): IConsts {
   switch (network) {
     case Network.TESTNET: {
-      return { ...parse(testnetJson), ...parse(testnetStakingJson) }
+      let testnetDeployment
+      switch (lpToken) {
+        case LPToken.USDZ:
+          testnetDeployment = usdzTestnetJson
+          break
+        case LPToken.SLP:
+          testnetDeployment = slpTestnetJson
+          break
+        default:
+          testnetDeployment = zlpTestnetJson
+      }
+      return { ...parse(testnetDeployment) }
     }
     case Network.MAINNET: {
-      return { ...parse(mainnetJson), ...parse(mainnetStakingJson) }
+      let mainnetDeployment
+      switch (lpToken) {
+        case LPToken.USDZ:
+          mainnetDeployment = usdzMainnetJson
+          break
+        case LPToken.SLP:
+          mainnetDeployment = slpMainnetJson
+          break
+        default:
+          mainnetDeployment = zlpMainnetJson
+      }
+      return { ...parse(mainnetDeployment) }
     }
     default: {
       return throwNetworkError(network)
@@ -128,6 +221,8 @@ export function getConsts(network: string): IConsts {
 }
 
 export const ZLP_TOKEN_DECIMALS = 6
+export const SLP_TOKEN_DECIMALS = 6
+export const USDZ_TOKEN_DECIMALS = 6
 
 export const SECONDS_PER_EIGHT_HOUR = 8 * 60 * 60
 
@@ -164,15 +259,15 @@ export function getPriceIdToPythFeeder(network: Network): Record<string, string>
 }
 
 export function getPythFeederToId(network: string): Record<string, string> {
-  let feederToId: Record<string, string> = {};
-  const consts = getConsts(network);
+  let feederToId: Record<string, string> = {}
+  const consts = getConsts(network)
   for (const key in consts.pythFeeder.feeder) {
     if (Object.prototype.hasOwnProperty.call(consts.pythFeeder.feeder, key)) {
-      const contract = consts.pythFeeder.feeder[key];
-      feederToId[contract] = key;
+      const contract = consts.pythFeeder.feeder[key]
+      feederToId[contract] = key
     }
   }
-  return feederToId;
+  return feederToId
 }
 
 export const ALLOW_TRADE_NO_TRADE = 0

package/src/consts/price_id_to_object_id.mainnet.json

@@ -21,5 +21,13 @@
   "0a0408d619e9380abad35060f9192039ed5042fa6f82301d0e48bb52be830996": "0xb804ada6f77feb30a73fbed7fc53dc66ff25133dee0815109d4267e43b2e6bdd",
   "2b9ab1e972a281585084148ba1389800799bd4be63b957507db1349314e47445": "0x4d1862d9ca2ad1f054f606220c22e0bcf37330d57bb82baa2063fd8193fc24ae",
   "58cd29ef0e714c5affc44f269b2c1899a52da4169d7acc147b9da692e6953608": "0x330c38d9af008421306242945f9308dc80c0c6a3e30b289a079fbff5ceeb4696",
-  "8414cfadf82f6bed644d2e399c11df21ec0131aa574c56030b132113dbbf3a0a": "0xbfa0e395413d94a7c45a9b987431a313a6e9da2e1b892f1924f64a0aff21e59f"
-}
+  "8414cfadf82f6bed644d2e399c11df21ec0131aa574c56030b132113dbbf3a0a": "0xbfa0e395413d94a7c45a9b987431a313a6e9da2e1b892f1924f64a0aff21e59f",
+  "09f7c1d7dfbb7df2b8fe3d3d87ee94a2259d212da4f30c1f0540d066dfa44723": "0xfa3d517e6ae2647708313f811fe7f481f8254cd738073e3e23dfca3b578c21d2",
+  "eff7446475e218517566ea99e72a4abec2e1bd8498b43b7d8331e29dcb059389": "0xd2e6ed72dcd8922164e1aa833ff39077cf01cb55b41a37324e8baccf93b1be9d",
+  "17cd845b16e874485b2684f8b8d1517d744105dbb904eec30222717f4bc9ee0d": "0xd779885c5246357e24cbde7348f2d81f756d9650975c02d81346b15d8b557ebf",
+  "57ff7100a282e4af0c91154679c5dae2e5dcacb93fd467ea9cb7e58afdcfde27": "0xf3bc79117acc3636d57778d9d0f83a871df1b7a53eb61fe893ff108d9664ec8b",
+  "fdf28a46570252b25fd31cb257973f865afc5ca2f320439e45d95e0394bc7382": "0x3ef821a54dbdfe3f211b2ff7261dea0f0330c72fd292422ce586e21f43809a56",
+  "d9912df360b5b7f21a122f15bdd5e27f62ce5e72bd316c291f7c86620e07fb2a": "0x94ef89923e7beccd4a52043a9451a87c614684b847426fb5fd76faa8cb1e907f",
+  "bb5ff26e47a3a6cc7ec2fce1db996c2a145300edc5acaabe43bf9ff7c5dd5d32": "0xc6352e1ea55d7b5acc3ed690cc3cdf8007978071d7bfd6a189445018cfb366e0",
+  "03ae4db29ed4ae33d323568895aa00337e658e348b37509f5372ae51f0af00d5": "0x7c5b7837c44a69b469325463ac0673ac1aa8435ff44ddb4191c9ae380463647f"
+}

package/src/data.ts

@@ -592,7 +592,7 @@ export class DataAPI extends OracleAPI {
 
   #calculatePositionFundingFee(position: IPositionInfo, symbol: ISymbolInfo, model: IFundingFeeModel, price: number, lpSupplyAmount: number, timestamp: number): number {
     const accFundingRate = this.#calcAccFundingFeeRate(symbol, model, price, lpSupplyAmount, timestamp)
-    return position.fundingFeeValue + (accFundingRate - symbol.accFundingRate) * position.positionSize
+    return position.fundingFeeValue + (accFundingRate - position.lastFundingRate) * position.positionSize
   }
 
   #calculateVaultReservingFee(vault: IVaultInfo, model: IReservingFeeModel, timestamp: number): number {
@@ -602,7 +602,7 @@ export class DataAPI extends OracleAPI {
 
   #calculatePositionReserveFee(position: IPositionInfo, vault: IVaultInfo, model: IReservingFeeModel, timestamp: number): number {
     const accReservingRate = this.#calcAccReservingFeeRate(vault, model, timestamp)
-    return position.reservingFeeAmount + (accReservingRate - vault.accReservingRate) * position.collateralAmount
+    return position.reservingFeeAmount + (accReservingRate - position.lastReservingRate) * position.collateralAmount
   }
 
   public async getPastFee(days = 7) {

package/src/factory/SDKFactory.ts

@@ -0,0 +1,282 @@
+/**
+ * SDK Factory for creating appropriate SDK instances based on LP token type
+ * This is the main entry point for the re-architected SDK system
+ */
+
+import type { SuiClient } from '@mysten/sui/client'
+import type { Network, LPToken } from '../consts'
+import { LPToken as LPTokenEnum } from '../consts'
+import type {
+  IBaseDataAPI,
+  IBaseAPI,
+  ISDKFactory,
+  IZLPDataAPI,
+  IZLPAPI,
+  ISLPDataAPI,
+  ISLPAPI,
+  IUSDZDataAPI,
+  IUSDZAPI
+} from '../interfaces'
+
+// Import concrete implementations
+import {
+  ZLPDataAPI,
+  ZLPAPI,
+  SLPDataAPI,
+  SLPAPI,
+  USDZDataAPI,
+  USDZAPI
+} from '../implementations'
+
+export class SDKFactory implements ISDKFactory {
+  private static instance: SDKFactory
+
+  // Singleton instances for DataAPI
+  private zlpDataAPIInstance: IZLPDataAPI | null = null
+  private slpDataAPIInstance: ISLPDataAPI | null = null
+  private usdzDataAPIInstance: IUSDZDataAPI | null = null
+
+  // Singleton instances for API
+  private zlpAPIInstance: IZLPAPI | null = null
+  private slpAPIInstance: ISLPAPI | null = null
+  private usdzAPIInstance: IUSDZAPI | null = null
+
+  private constructor() { }
+
+  /**
+   * Gets the singleton instance of the SDK factory
+   */
+  public static getInstance(): SDKFactory {
+    if (!SDKFactory.instance) {
+      SDKFactory.instance = new SDKFactory()
+    }
+    return SDKFactory.instance
+  }
+
+  /**
+   * Creates a DataAPI instance based on the LP token type (returns singleton)
+   */
+  public createDataAPI(
+    network: Network,
+    provider: SuiClient,
+    apiEndpoint: string,
+    connectionURL: string,
+    lpToken: LPToken
+  ): IBaseDataAPI {
+    switch (lpToken) {
+      case LPTokenEnum.ZLP:
+        if (!this.zlpDataAPIInstance) {
+          this.zlpDataAPIInstance = new ZLPDataAPI(network, provider, apiEndpoint, connectionURL)
+        }
+        return this.zlpDataAPIInstance
+      case LPTokenEnum.SLP:
+        if (!this.slpDataAPIInstance) {
+          this.slpDataAPIInstance = new SLPDataAPI(network, provider, apiEndpoint, connectionURL)
+        }
+        return this.slpDataAPIInstance
+      case LPTokenEnum.USDZ:
+        if (!this.usdzDataAPIInstance) {
+          this.usdzDataAPIInstance = new USDZDataAPI(network, provider, apiEndpoint, connectionURL)
+        }
+        return this.usdzDataAPIInstance
+      default:
+        throw new Error(`Unsupported LP token type: ${lpToken}`)
+    }
+  }
+
+  /**
+   * Creates an API instance based on the LP token type (returns singleton)
+   */
+  public createAPI(
+    network: Network,
+    provider: SuiClient,
+    apiEndpoint: string,
+    connectionURL: string,
+    lpToken: LPToken
+  ): IBaseAPI {
+    switch (lpToken) {
+      case LPTokenEnum.ZLP:
+        if (!this.zlpAPIInstance) {
+          this.zlpAPIInstance = new ZLPAPI(network, provider, apiEndpoint, connectionURL)
+        }
+        return this.zlpAPIInstance
+      case LPTokenEnum.SLP:
+        if (!this.slpAPIInstance) {
+          this.slpAPIInstance = new SLPAPI(network, provider, apiEndpoint, connectionURL)
+        }
+        return this.slpAPIInstance
+      case LPTokenEnum.USDZ:
+        if (!this.usdzAPIInstance) {
+          this.usdzAPIInstance = new USDZAPI(network, provider, apiEndpoint, connectionURL)
+        }
+        return this.usdzAPIInstance
+      default:
+        throw new Error(`Unsupported LP token type: ${lpToken}`)
+    }
+  }
+
+  /**
+   * Creates a typed DataAPI instance for ZLP (returns singleton)
+   */
+  public createZLPDataAPI(
+    network: Network,
+    provider: SuiClient,
+    apiEndpoint: string,
+    connectionURL: string
+  ): IZLPDataAPI {
+    if (!this.zlpDataAPIInstance) {
+      this.zlpDataAPIInstance = new ZLPDataAPI(network, provider, apiEndpoint, connectionURL)
+    }
+    return this.zlpDataAPIInstance
+  }
+
+  /**
+   * Creates a typed API instance for ZLP (returns singleton)
+   */
+  public createZLPAPI(
+    network: Network,
+    provider: SuiClient,
+    apiEndpoint: string,
+    connectionURL: string
+  ): IZLPAPI {
+    if (!this.zlpAPIInstance) {
+      this.zlpAPIInstance = new ZLPAPI(network, provider, apiEndpoint, connectionURL)
+    }
+    return this.zlpAPIInstance
+  }
+
+  /**
+   * Creates a typed DataAPI instance for SLP (returns singleton)
+   */
+  public createSLPDataAPI(
+    network: Network,
+    provider: SuiClient,
+    apiEndpoint: string,
+    connectionURL: string
+  ): ISLPDataAPI {
+    if (!this.slpDataAPIInstance) {
+      this.slpDataAPIInstance = new SLPDataAPI(network, provider, apiEndpoint, connectionURL)
+    }
+    return this.slpDataAPIInstance
+  }
+
+  /**
+   * Creates a typed API instance for SLP (returns singleton)
+   */
+  public createSLPAPI(
+    network: Network,
+    provider: SuiClient,
+    apiEndpoint: string,
+    connectionURL: string
+  ): ISLPAPI {
+    if (!this.slpAPIInstance) {
+      this.slpAPIInstance = new SLPAPI(network, provider, apiEndpoint, connectionURL)
+    }
+    return this.slpAPIInstance
+  }
+
+  /**
+   * Creates a typed DataAPI instance for USDZ (returns singleton)
+   */
+  public createUSDZDataAPI(
+    network: Network,
+    provider: SuiClient,
+    apiEndpoint: string,
+    connectionURL: string
+  ): IUSDZDataAPI {
+    if (!this.usdzDataAPIInstance) {
+      this.usdzDataAPIInstance = new USDZDataAPI(network, provider, apiEndpoint, connectionURL)
+    }
+    return this.usdzDataAPIInstance
+  }
+
+  /**
+   * Creates a typed API instance for USDZ (returns singleton)
+   */
+  public createUSDZAPI(
+    network: Network,
+    provider: SuiClient,
+    apiEndpoint: string,
+    connectionURL: string
+  ): IUSDZAPI {
+    if (!this.usdzAPIInstance) {
+      this.usdzAPIInstance = new USDZAPI(network, provider, apiEndpoint, connectionURL)
+    }
+    return this.usdzAPIInstance
+  }
+
+  /**
+   * Validates if a given LP token is supported
+   */
+  public isLPTokenSupported(lpToken: string): lpToken is LPToken {
+    return Object.values(LPTokenEnum).includes(lpToken as LPToken)
+  }
+
+  /**
+   * Gets all supported LP token types
+   */
+  public getSupportedLPTokens(): LPToken[] {
+    return Object.values(LPTokenEnum)
+  }
+
+  /**
+   * Clears all singleton instances (useful for testing or configuration changes)
+   */
+  public clearInstances(): void {
+    this.zlpDataAPIInstance = null
+    this.slpDataAPIInstance = null
+    this.usdzDataAPIInstance = null
+    this.zlpAPIInstance = null
+    this.slpAPIInstance = null
+    this.usdzAPIInstance = null
+  }
+
+  /**
+   * Creates the appropriate SDK instance based on string LP token type
+   * Useful for dynamic SDK creation from configuration
+   */
+  public createSDKFromString(
+    lpTokenString: string,
+    network: Network,
+    provider: SuiClient,
+    apiEndpoint: string,
+    connectionURL: string,
+    includeTrading = true
+  ): IBaseDataAPI | IBaseAPI {
+    if (!this.isLPTokenSupported(lpTokenString)) {
+      throw new Error(`Unsupported LP token: ${lpTokenString}`)
+    }
+
+    const lpToken = lpTokenString as LPToken
+
+    if (includeTrading) {
+      return this.createAPI(network, provider, apiEndpoint, connectionURL, lpToken)
+    } else {
+      return this.createDataAPI(network, provider, apiEndpoint, connectionURL, lpToken)
+    }
+  }
+}
+
+// Export convenience functions for backward compatibility
+export function createDataAPI(
+  network: Network,
+  provider: SuiClient,
+  apiEndpoint: string,
+  connectionURL: string,
+  lpToken: LPToken
+): IBaseDataAPI {
+  return SDKFactory.getInstance().createDataAPI(network, provider, apiEndpoint, connectionURL, lpToken)
+}
+
+export function createAPI(
+  network: Network,
+  provider: SuiClient,
+  apiEndpoint: string,
+  connectionURL: string,
+  lpToken: LPToken
+): IBaseAPI {
+  return SDKFactory.getInstance().createAPI(network, provider, apiEndpoint, connectionURL, lpToken)
+}
+
+// Export the singleton instance for direct use
+export const sdkFactory = SDKFactory.getInstance()