zo-sdk 0.1.2 → 0.1.3

package/src/consts/deployments-usdz-mainnet.json

@@ -30,29 +30,7 @@
     },
     "feeder": {
       "sui": "0x801dbc2f0053d34734814b2d6df491ce7807a725fe9a01ad74a07e9c51396c37",
-      "btc": "0x9a62b4863bdeaabdc9500fce769cf7e72d5585eeb28a6d26e4cafadc13f76ab2",
-      "eth": "0x9193fd47f9a0ab99b6e365a464c8a9ae30e6150fc37ed2a89c1586631f6fc4ab",
-      "nusdc": "0x5dec622733a204ca27f5a90d8c2fad453cc6665186fd5dff13a83d0b6c9027ab",
-      "usdt": "0x985e3db9f93f76ee8bace7c3dd5cc676a096accd5d9e09e9ae0fb6e492b14572",
-      "suiUsdt": "0x985e3db9f93f76ee8bace7c3dd5cc676a096accd5d9e09e9ae0fb6e492b14572",
-      "deep": "0x8c7f3a322b94cc69db2a2ac575cbd94bf5766113324c3a3eceac91e3e88a51ed",
-      "wal": "0xeb7e669f74d976c0b99b6ef9801e3a77716a95f1a15754e0f1399ce3fb60973d",
-      "xrp": "0x93bfda25cb6b1653a9c769e8216014bd2c06997f3edb479566761fbf2abf6ac2",
-      "sol": "0x9d0d275efbd37d8a8855f6f2c761fa5983293dd8ce202ee5196626de8fcd4469",
-      "doge": "0xd59a5f5173424ba725a7d033d86f2eadf2745f87a908bd27e1d27339eff598ce",
-      "hype": "0x1c047be615eaa5a87afa0e111b20a512dd6c0f4a1f0f691693cf852c1768f35d",
-      "ondo": "0xa64a406662db4ecde675fde111033e80629397715afc7fff53064f41dabab42f",
-      "trump": "0xd0835474be8cfcc7be4e02fc1bcd85dbdf11a54d061edc302e611ca304f57b14",
-      "cetus": "0x24c0247fb22457a719efac7f670cdc79be321b521460bd6bd2ccfa9f80713b14",
-      "haedal": "0xbc98681c15de1ca1b80a8e26500d43c77f7113368b024de1bf490afcb0387109",
-      "avax": "0x29e37978cb1c9501bda5d7c105f24f0058bc1668637e307fbc290dba48cb918d",
-      "bnb": "0x9c6e77f0ecfc46aac395e21c52ccb96518f85acacae743c5b47f4ca5e29826c3",
-      "ada": "0xf28e4e40a96948a19805fe76a4da373a262daac47588bac78d73033bce7b5a38",
-      "paxg": "0x78394446b806dcd3b26011b1c7fcfab104f95b718299bc98ff730983105bf943",
-      "jup": "0xb804ada6f77feb30a73fbed7fc53dc66ff25133dee0815109d4267e43b2e6bdd",
-      "aave": "0x4d1862d9ca2ad1f054f606220c22e0bcf37330d57bb82baa2063fd8193fc24ae",
-      "fartcoin": "0x330c38d9af008421306242945f9308dc80c0c6a3e30b289a079fbff5ceeb4696",
-      "spx": "0xbfa0e395413d94a7c45a9b987431a313a6e9da2e1b892f1924f64a0aff21e59f"
+      "nusdc": "0x5dec622733a204ca27f5a90d8c2fad453cc6665186fd5dff13a83d0b6c9027ab"
     }
   },
   "coins": {
@@ -61,120 +39,10 @@
       "module": "0x0000000000000000000000000000000000000000000000000000000000000002::sui::SUI",
       "metadata": "0x9258181f5ceac8dbffb7030890243caed69a9599d2886d957a9cb7656af3bdb3"
     },
-    "btc": {
-      "decimals": 8,
-      "module": "0x027792d9fed7f9844eb4839566001bb6f6cb4804f66aa2da6fe1ee242d896881::coin::COIN",
-      "metadata": "0x5d3c6e60eeff8a05b693b481539e7847dfe33013e7070cdcb387f5c0cac05dfd"
-    },
-    "eth": {
-      "decimals": 8,
-      "module": "0xaf8cd5edc19c4512f4259f0bee101a40d41ebed738ade5874359610ef8eeced5::coin::COIN",
-      "metadata": "0x8900e4ceede3363bef086d6b50ca89d816d0e90bf6bc46efefe1f8455e08f50f"
-    },
     "nusdc": {
       "decimals": 6,
       "module": "0xdba34672e30cb065b1f93e3ab55318768fd6fef66c15942c9f7cb846e2f900e7::usdc::USDC",
       "metadata": "0x69b7a7c3c200439c1b5f3b19d7d495d5966d5f08de66c69276152f8db3992ec6"
-    },
-    "usdt": {
-      "decimals": 6,
-      "module": "0xc060006111016b8a020ad5b33834984a437aaa7d3c74c18e09a95d48aceab08c::coin::COIN",
-      "metadata": "0xfb0e3eb97dd158a5ae979dddfa24348063843c5b20eb8381dd5fa7c93699e45c"
-    },
-    "suiUsdt": {
-      "decimals": 6,
-      "module": "0x375f70cf2ae4c00bf37117d0c85a2c71545e6ee05c4a5c7d282cd66a4504b068::usdt::USDT",
-      "metadata": "0xda61b33ac61ed4c084bbda65a2229459ed4eb2185729e70498538f0688bec3cc"
-    },
-    "deep": {
-      "decimals": 6,
-      "module": "0xdeeb7a4662eec9f2f3def03fb937a663dddaa2e215b8078a284d026b7946c270::deep::DEEP",
-      "metadata": "0x6e60b051a08fa836f5a7acd7c464c8d9825bc29c44657fe170fe9b8e1e4770c0"
-    },
-    "wal": {
-      "decimals": 9,
-      "module": "0x356a26eb9e012a68958082340d4c4116e7f55615cf27affcff209cf0ae544f59::wal::WAL",
-      "metadata": "0xcf8a31804ae40cb3e7183fe57320f87467a7750d4fa701bca1ffbb1edd37781e"
-    },
-    "xrp": {
-      "decimals": 6,
-      "module": "0x8592d41b28815030c40cae43bf30a3f75657e57e6028a05c1b56e5f236b1416e::xrp::XRP",
-      "metadata": "0x69004e9f9a4981fdee2f3050cf99c7d2f2a7e45b871da2cc056a850e6bf818b3"
-    },
-    "sol": {
-      "decimals": 8,
-      "module": "0xb7844e289a8410e50fb3ca48d69eb9cf29e27d223ef90353fe1bd8e27ff8f3f8::coin::COIN",
-      "metadata": "0x4d2c39082b4477e3e79dc4562d939147ab90c42fc5f3e4acf03b94383cd69b6e"
-    },
-    "doge": {
-      "decimals": 8,
-      "module": "0xe364a361406e7ab4ea4ec17cc4840b18737dd20bd7124a82130aa21422b8fc20::doge::DOGE",
-      "metadata": "0xf3da270f549dd26d1d2dd251961d46919d3abb3044a98ef0fd7dd914d3cc9159"
-    },
-    "hype": {
-      "decimals": 8,
-      "module": "0xea2748c16bb45cac2d2602d6ad25089d24a814abc9495c0210b8b856617c4e66::hype::HYPE",
-      "metadata": "0xc23c06733cab74bd55febf4f7f8a26234385974b048b95a254d2cbd7fde256b2"
-    },
-    "ondo": {
-      "decimals": 8,
-      "module": "0xfe7d492e5c3fd9c88ac859d4d37179e301ce78104da40e44ea7bb38911d4ae0a::ondo::ONDO",
-      "metadata": "0xa340ffa4f80fc2b4df43f469fb5088b396c20624ee6b54024052977f49be9f82"
-    },
-    "trump": {
-      "decimals": 6,
-      "module": "0xbac9a286efdb3520c76c2cbff789ad42c0834c857c3a249915b10d8b5bf8afac::trump::TRUMP",
-      "metadata": "0xdea3d7c4b12833a89edd5f04921e800a6e34f9e8256dc514979855d5084212ba"
-    },
-    "cetus": {
-      "decimals": 9,
-      "module": "0x06864a6f921804860930db6ddbe2e16acdf8504495ea7481637a1c8b9a8fe54b::cetus::CETUS",
-      "metadata": "0x4c0dce55eff2db5419bbd2d239d1aa22b4a400c01bbb648b058a9883989025da"
-    },
-    "haedal": {
-      "decimals": 9,
-      "module": "0x3a304c7feba2d819ea57c3542d68439ca2c386ba02159c740f7b406e592c62ea::haedal::HAEDAL",
-      "metadata": "0xcc89fcc22f0d13de3688b94fa16d64a22079186a941914280c67101ff754263c"
-    },
-    "aave": {
-      "decimals": 8,
-      "module": "0x398e363d2b93ecb615ca36687657d71bd5cb590b5ebd6c3033ad6956a62b1ca4::aave::AAVE",
-      "metadata": "0x0d9fbea2ed02fffc738a5c0bb61ec09cfd5388ac3095a1f0abc99b30a64cb45e"
-    },
-    "ada": {
-      "decimals": 8,
-      "module": "0xe0195a3d560e332aba28b4a3aa91c9430c76cc4be0cc43a46015879597b6d338::ada::ADA",
-      "metadata": "0x8a87d822e41044f8285127674c0fff2c0598d473dc75f6695ef729bf4caeef27"
-    },
-    "avax": {
-      "decimals": 8,
-      "module": "0xdbb90a6e799340738f9a500f955d9053eb54c1011691e27f58cb98762b290c81::avax::AVAX",
-      "metadata": "0x33dfac0409b0c134ef11e76f0e71839cb43f957315c69e678398abadc21e3160"
-    },
-    "fartcoin": {
-      "decimals": 9,
-      "module": "0xebda4656236c29b3a4472f35ae6a4a27e17b65259611d549b5b260e2f8e5abe2::fartcoin::FARTCOIN",
-      "metadata": "0x7a5a0e1dd1d9d8776b5312fd3f14e91d36ee02e97874df768b3b2cd16794ea17"
-    },
-    "jup": {
-      "decimals": 8,
-      "module": "0x31095ed9f80427b69635cde750237c3bd98aa806efd31306e13c50ae0b12a500::jup::JUP",
-      "metadata": "0x487f2f60529f8dbc41cff75e2f5cf8ebafb86e09f97c5c6df6a8cf7cbbdc04e6"
-    },
-    "paxg": {
-      "decimals": 8,
-      "module": "0xa613dcbd506ac7c0f5fd5574e26eaa53c2279bfcbae7e4541af98d697ef9a786::paxg::PAXG",
-      "metadata": "0x9ae44fdc2ddd13581c26d913d9fa43e47dd66a347cb7bb6f93036efd2eec9ab4"
-    },
-    "spx": {
-      "decimals": 9,
-      "module": "0x9f08c77e89af768d7ee5accf8b66b07d606a84b5939e6896a1ae92d519523eac::spx::SPX",
-      "metadata": "0x0400c0f644c94372c3784eba220402cba968659b7e16d640e455b4c72c5cc02c"
-    },
-    "bnb": {
-      "decimals": 8,
-      "module": "0x10cb719b69a7f529600e7238460944c3932f98a2a95b48a0728ac3bbb9c95534::bnb::BNB",
-      "metadata": "0xcfa4b4e79c836c7c278b7a8675e6fcc8356d6701871371b364fc4af01ac7fba7"
     }
   }
 }

package/src/consts/index.ts

@@ -1,10 +1,10 @@
 import { reverseKeyValue } from '../utils'
-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 usdzMainnetJson from './deployments-usdz-mainnet.json'
+import usdzTestnetJson from './deployments-usdz-testnet.json'
+import zlpMainnetJson from './deployments-zlp-mainnet.json'
+import zlpTestnetJson from './deployments-zlp-testnet.json'
 import PriceIdToObjectIdMainnet from './price_id_to_object_id.mainnet.json'
 import PriceIdToObjectIdTestnet from './price_id_to_object_id.testnet.json'
 
@@ -90,7 +90,7 @@ export interface IConsts {
     upgradeCap: string
     adminCap: string
     pool: string
-  },
+  }
   zoLootbox: {
     package: string
     upgradedPackage: string
@@ -146,7 +146,7 @@ export interface IConsts {
 }
 
 function toCamelCase(str: string): string {
-  return str.replace(/_([a-z])/g, (_, letter) => letter.toUpperCase())
+  return str.replaceAll(/_([a-z])/g, (_: string, letter: string) => letter.toUpperCase())
 }
 
 function parse(obj: any): any {
@@ -155,11 +155,12 @@ function parse(obj: any): any {
   }
 
   if (Array.isArray(obj)) {
-    return obj.map(parse)
+    return obj.map(element => parse(element))
   }
 
   const newObj: any = {}
 
+  // eslint-disable-next-line guard-for-in
   for (const key in obj) {
     const camelCaseKey = toCamelCase(key)
     newObj[camelCaseKey] = parse(obj[key])
@@ -189,28 +190,34 @@ export function getConsts(network: string, lpToken: LPToken = LPToken.ZLP): ICon
     case Network.TESTNET: {
       let testnetDeployment
       switch (lpToken) {
-        case LPToken.USDZ:
+        case LPToken.USDZ: {
           testnetDeployment = usdzTestnetJson
           break
-        case LPToken.SLP:
+        }
+        case LPToken.SLP: {
           testnetDeployment = slpTestnetJson
           break
-        default:
+        }
+        default: {
           testnetDeployment = zlpTestnetJson
+        }
       }
       return { ...parse(testnetDeployment) }
     }
     case Network.MAINNET: {
       let mainnetDeployment
       switch (lpToken) {
-        case LPToken.USDZ:
+        case LPToken.USDZ: {
           mainnetDeployment = usdzMainnetJson
           break
-        case LPToken.SLP:
+        }
+        case LPToken.SLP: {
           mainnetDeployment = slpMainnetJson
           break
-        default:
+        }
+        default: {
           mainnetDeployment = zlpMainnetJson
+        }
       }
       return { ...parse(mainnetDeployment) }
     }
@@ -259,7 +266,7 @@ export function getPriceIdToPythFeeder(network: Network): Record<string, string>
 }
 
 export function getPythFeederToId(network: string): Record<string, string> {
-  let feederToId: Record<string, string> = {}
+  const feederToId: Record<string, string> = {}
 
   // Iterate through all LP tokens to collect feeder data
   const lpTokens = [LPToken.ZLP, LPToken.SLP, LPToken.USDZ]
@@ -267,7 +274,7 @@ export function getPythFeederToId(network: string): Record<string, string> {
   for (const lpToken of lpTokens) {
     const consts = getConsts(network, lpToken)
     for (const key in consts.pythFeeder.feeder) {
-      if (Object.prototype.hasOwnProperty.call(consts.pythFeeder.feeder, key)) {
+      if (Object.hasOwn(consts.pythFeeder.feeder, key)) {
         const contract = consts.pythFeeder.feeder[key]
         feederToId[contract] = key
       }

package/src/factory/SDKFactory.ts

@@ -1,33 +1,34 @@
+/* eslint-disable unicorn/empty-brace-spaces */
 /**
  * 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 type { LPToken, Network } from '../consts'
 import { LPToken as LPTokenEnum } from '../consts'
+// Import concrete implementations
+import {
+  SLPAPI,
+  SLPDataAPI,
+  USDZAPI,
+  USDZDataAPI,
+  ZLPAPI,
+  ZLPDataAPI,
+} from '../implementations'
 import type {
-  IBaseDataAPI,
   IBaseAPI,
+  IBaseDataAPI,
   ISDKFactory,
-  IZLPDataAPI,
-  IZLPAPI,
-  ISLPDataAPI,
   ISLPAPI,
+  ISLPDataAPI,
+  IUSDZAPI,
   IUSDZDataAPI,
-  IUSDZAPI
+  IZLPAPI,
+  IZLPDataAPI,
 } from '../interfaces'
 
-// Import concrete implementations
-import {
-  ZLPDataAPI,
-  ZLPAPI,
-  SLPDataAPI,
-  SLPAPI,
-  USDZDataAPI,
-  USDZAPI
-} from '../implementations'
-
 export class SDKFactory implements ISDKFactory {
   private static instance: SDKFactory
 
@@ -61,26 +62,30 @@ export class SDKFactory implements ISDKFactory {
     provider: SuiClient,
     apiEndpoint: string,
     connectionURL: string,
-    lpToken: LPToken
+    lpToken: LPToken,
   ): IBaseDataAPI {
     switch (lpToken) {
-      case LPTokenEnum.ZLP:
+      case LPTokenEnum.ZLP: {
         if (!this.zlpDataAPIInstance) {
           this.zlpDataAPIInstance = new ZLPDataAPI(network, provider, apiEndpoint, connectionURL)
         }
         return this.zlpDataAPIInstance
-      case LPTokenEnum.SLP:
+      }
+      case LPTokenEnum.SLP: {
         if (!this.slpDataAPIInstance) {
           this.slpDataAPIInstance = new SLPDataAPI(network, provider, apiEndpoint, connectionURL)
         }
         return this.slpDataAPIInstance
-      case LPTokenEnum.USDZ:
+      }
+      case LPTokenEnum.USDZ: {
         if (!this.usdzDataAPIInstance) {
           this.usdzDataAPIInstance = new USDZDataAPI(network, provider, apiEndpoint, connectionURL)
         }
         return this.usdzDataAPIInstance
-      default:
+      }
+      default: {
         throw new Error(`Unsupported LP token type: ${lpToken}`)
+      }
     }
   }
 
@@ -92,26 +97,30 @@ export class SDKFactory implements ISDKFactory {
     provider: SuiClient,
     apiEndpoint: string,
     connectionURL: string,
-    lpToken: LPToken
+    lpToken: LPToken,
   ): IBaseAPI {
     switch (lpToken) {
-      case LPTokenEnum.ZLP:
+      case LPTokenEnum.ZLP: {
         if (!this.zlpAPIInstance) {
           this.zlpAPIInstance = new ZLPAPI(network, provider, apiEndpoint, connectionURL)
         }
         return this.zlpAPIInstance
-      case LPTokenEnum.SLP:
+      }
+      case LPTokenEnum.SLP: {
         if (!this.slpAPIInstance) {
           this.slpAPIInstance = new SLPAPI(network, provider, apiEndpoint, connectionURL)
         }
         return this.slpAPIInstance
-      case LPTokenEnum.USDZ:
+      }
+      case LPTokenEnum.USDZ: {
         if (!this.usdzAPIInstance) {
           this.usdzAPIInstance = new USDZAPI(network, provider, apiEndpoint, connectionURL)
         }
         return this.usdzAPIInstance
-      default:
+      }
+      default: {
         throw new Error(`Unsupported LP token type: ${lpToken}`)
+      }
     }
   }
 
@@ -122,7 +131,7 @@ export class SDKFactory implements ISDKFactory {
     network: Network,
     provider: SuiClient,
     apiEndpoint: string,
-    connectionURL: string
+    connectionURL: string,
   ): IZLPDataAPI {
     if (!this.zlpDataAPIInstance) {
       this.zlpDataAPIInstance = new ZLPDataAPI(network, provider, apiEndpoint, connectionURL)
@@ -137,7 +146,7 @@ export class SDKFactory implements ISDKFactory {
     network: Network,
     provider: SuiClient,
     apiEndpoint: string,
-    connectionURL: string
+    connectionURL: string,
   ): IZLPAPI {
     if (!this.zlpAPIInstance) {
       this.zlpAPIInstance = new ZLPAPI(network, provider, apiEndpoint, connectionURL)
@@ -152,7 +161,7 @@ export class SDKFactory implements ISDKFactory {
     network: Network,
     provider: SuiClient,
     apiEndpoint: string,
-    connectionURL: string
+    connectionURL: string,
   ): ISLPDataAPI {
     if (!this.slpDataAPIInstance) {
       this.slpDataAPIInstance = new SLPDataAPI(network, provider, apiEndpoint, connectionURL)
@@ -167,7 +176,7 @@ export class SDKFactory implements ISDKFactory {
     network: Network,
     provider: SuiClient,
     apiEndpoint: string,
-    connectionURL: string
+    connectionURL: string,
   ): ISLPAPI {
     if (!this.slpAPIInstance) {
       this.slpAPIInstance = new SLPAPI(network, provider, apiEndpoint, connectionURL)
@@ -182,7 +191,7 @@ export class SDKFactory implements ISDKFactory {
     network: Network,
     provider: SuiClient,
     apiEndpoint: string,
-    connectionURL: string
+    connectionURL: string,
   ): IUSDZDataAPI {
     if (!this.usdzDataAPIInstance) {
       this.usdzDataAPIInstance = new USDZDataAPI(network, provider, apiEndpoint, connectionURL)
@@ -197,7 +206,7 @@ export class SDKFactory implements ISDKFactory {
     network: Network,
     provider: SuiClient,
     apiEndpoint: string,
-    connectionURL: string
+    connectionURL: string,
   ): IUSDZAPI {
     if (!this.usdzAPIInstance) {
       this.usdzAPIInstance = new USDZAPI(network, provider, apiEndpoint, connectionURL)
@@ -208,14 +217,14 @@ export class SDKFactory implements ISDKFactory {
   /**
    * Validates if a given LP token is supported
    */
-  public isLPTokenSupported(lpToken: string): lpToken is LPToken {
+  public static isLPTokenSupported(lpToken: string): lpToken is LPToken {
     return Object.values(LPTokenEnum).includes(lpToken as LPToken)
   }
 
   /**
    * Gets all supported LP token types
    */
-  public getSupportedLPTokens(): LPToken[] {
+  public static getSupportedLPTokens(): LPToken[] {
     return Object.values(LPTokenEnum)
   }
 
@@ -241,9 +250,9 @@ export class SDKFactory implements ISDKFactory {
     provider: SuiClient,
     apiEndpoint: string,
     connectionURL: string,
-    includeTrading = true
+    includeTrading = true,
   ): IBaseDataAPI | IBaseAPI {
-    if (!this.isLPTokenSupported(lpTokenString)) {
+    if (!SDKFactory.isLPTokenSupported(lpTokenString)) {
       throw new Error(`Unsupported LP token: ${lpTokenString}`)
     }
 
@@ -251,9 +260,8 @@ export class SDKFactory implements ISDKFactory {
 
     if (includeTrading) {
       return this.createAPI(network, provider, apiEndpoint, connectionURL, lpToken)
-    } else {
-      return this.createDataAPI(network, provider, apiEndpoint, connectionURL, lpToken)
     }
+    return this.createDataAPI(network, provider, apiEndpoint, connectionURL, lpToken)
   }
 }
 
@@ -263,7 +271,7 @@ export function createDataAPI(
   provider: SuiClient,
   apiEndpoint: string,
   connectionURL: string,
-  lpToken: LPToken
+  lpToken: LPToken,
 ): IBaseDataAPI {
   return SDKFactory.getInstance().createDataAPI(network, provider, apiEndpoint, connectionURL, lpToken)
 }
@@ -273,10 +281,10 @@ export function createAPI(
   provider: SuiClient,
   apiEndpoint: string,
   connectionURL: string,
-  lpToken: LPToken
+  lpToken: LPToken,
 ): IBaseAPI {
   return SDKFactory.getInstance().createAPI(network, provider, apiEndpoint, connectionURL, lpToken)
 }
 
 // Export the singleton instance for direct use
-export const sdkFactory = SDKFactory.getInstance()
+export const sdkFactory = SDKFactory.getInstance()