@zofai/zo-sdk 0.1.92

package/src/factory/SDKFactory.ts

@@ -0,0 +1,340 @@
+/* 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 { LPToken, Network } from '../consts'
+import { LPToken as LPTokenEnum } from '../consts'
+// Import concrete implementations
+import {
+  SLPAPI,
+  SLPDataAPI,
+  USDZAPI,
+  USDZDataAPI,
+  ZLPAPI,
+  ZLPDataAPI,
+} from '../implementations'
+import { ZBTCVCAPI } from '../implementations/ZBTCVCAPI'
+import { ZBTCVCDataAPI } from '../implementations/ZBTCVCDataAPI'
+import type {
+  IBaseAPI,
+  IBaseDataAPI,
+  ISDKFactory,
+  ISLPAPI,
+  ISLPDataAPI,
+  IUSDZAPI,
+  IUSDZDataAPI,
+  IZBTCVCAPI,
+  IZBTCVCDataAPI,
+  IZLPAPI,
+  IZLPDataAPI,
+} from '../interfaces'
+
+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
+  private zbtcvcDataAPIInstance: IZBTCVCDataAPI | null = null
+
+  // Singleton instances for API
+  private zlpAPIInstance: IZLPAPI | null = null
+  private slpAPIInstance: ISLPAPI | null = null
+  private usdzAPIInstance: IUSDZAPI | null = null
+  private zbtcvcAPIInstance: IZBTCVCAPI | 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
+      }
+      case LPTokenEnum.ZBTCVC: {
+        if (!this.zbtcvcDataAPIInstance) {
+          this.zbtcvcDataAPIInstance = new ZBTCVCDataAPI(network, provider, apiEndpoint, connectionURL)
+        }
+        return this.zbtcvcDataAPIInstance
+      }
+      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
+      }
+      case LPTokenEnum.ZBTCVC: {
+        if (!this.zbtcvcAPIInstance) {
+          this.zbtcvcAPIInstance = new ZBTCVCAPI(network, provider, apiEndpoint, connectionURL)
+        }
+        return this.zbtcvcAPIInstance
+      }
+      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
+  }
+
+  /**
+   * Creates a typed DataAPI instance for USDZ (returns singleton)
+   */
+  public createZBTCVCDataAPI(
+    network: Network,
+    provider: SuiClient,
+    apiEndpoint: string,
+    connectionURL: string,
+  ): IZBTCVCDataAPI {
+    if (!this.zbtcvcDataAPIInstance) {
+      this.zbtcvcDataAPIInstance = new ZBTCVCDataAPI(network, provider, apiEndpoint, connectionURL)
+    }
+    return this.zbtcvcDataAPIInstance
+  }
+
+  /**
+   * Creates a typed API instance for USDZ (returns singleton)
+   */
+  public createZBTCVCAPI(
+    network: Network,
+    provider: SuiClient,
+    apiEndpoint: string,
+    connectionURL: string,
+  ): IZBTCVCAPI {
+    if (!this.zbtcvcAPIInstance) {
+      this.zbtcvcAPIInstance = new ZBTCVCAPI(network, provider, apiEndpoint, connectionURL)
+    }
+    return this.zbtcvcAPIInstance
+  }
+
+  /**
+   * Validates if a given LP token is supported
+   */
+  public static isLPTokenSupported(lpToken: string): lpToken is LPToken {
+    return Object.values(LPTokenEnum).includes(lpToken as LPToken)
+  }
+
+  /**
+   * Gets all supported LP token types
+   */
+  public static 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.zbtcvcAPIInstance = null
+    this.zlpAPIInstance = null
+    this.slpAPIInstance = null
+    this.usdzAPIInstance = null
+    this.zbtcvcAPIInstance = 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 (!SDKFactory.isLPTokenSupported(lpTokenString)) {
+      throw new Error(`Unsupported LP token: ${lpTokenString}`)
+    }
+
+    const lpToken = lpTokenString as LPToken
+
+    if (includeTrading) {
+      return this.createAPI(network, provider, apiEndpoint, connectionURL, lpToken)
+    }
+    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()