zo-sdk 0.0.51 → 0.1.1

package/src/implementations/index.ts

@@ -0,0 +1,14 @@
+/**
+ * Implementation exports
+ * Exports all SDK implementations for easy importing
+ */
+
+// Data API implementations
+export { ZLPDataAPI } from './ZLPDataAPI'
+export { SLPDataAPI } from './SLPDataAPI'
+export { USDZDataAPI } from './USDZDataAPI'
+
+// API implementations
+export { ZLPAPI } from './ZLPAPI'
+export { SLPAPI } from './SLPAPI'
+export { USDZAPI } from './USDZAPI'

package/src/index.ts

@@ -1,5 +1,58 @@
+/**
+ * ZO SDK - Re-architected Multi-LP Token SDK
+ * 
+ * This SDK provides a unified interface for interacting with multiple LP tokens:
+ * - ZLP (ZO Liquidity Provider)
+ * - SLP (Sudo Liquidity Provider) 
+ * - USDZ (USD Stablecoin)
+ * 
+ * The architecture follows a common interface pattern with specific implementations
+ * for each LP token type, allowing for easy extension to support future LP tokens.
+ */
+
+// Export new re-architected interfaces and implementations
+export * from './interfaces'
+export * from './abstract'
+export * from './implementations'
+export * from './factory/SDKFactory'
+
+// Export legacy components for backward compatibility
 export * from './api'
+export * from './bcs'
 export * from './consts'
 export * from './data'
 export * from './oracle'
 export * from './utils'
+
+// Re-export commonly used types from Sui SDK
+export type { SuiClient } from '@mysten/sui/client'
+export type { Transaction } from '@mysten/sui/transactions'
+
+/**
+ * Main SDK Factory instance for convenient access
+ * 
+ * Usage examples:
+ * 
+ * ```typescript
+ * import { SDK, LPToken } from '@zo/sdk'
+ * 
+ * // Create ZLP API instance
+ * const zlpAPI = SDK.createZLPAPI(network, provider, apiEndpoint, connectionURL)
+ * 
+ * // Create SLP API instance  
+ * const slpAPI = SDK.createSLPAPI(network, provider, apiEndpoint, connectionURL)
+ * 
+ * // Create USDZ API instance
+ * const usdzAPI = SDK.createUSDZAPI(network, provider, apiEndpoint, connectionURL)
+ * 
+ * // Or use the generic factory method
+ * const api = SDK.createAPI(LPToken.ZLP, network, provider, apiEndpoint, connectionURL)
+ * ```
+ */
+export { SDKFactory as SDK } from './factory/SDKFactory'
+
+/**
+ * Default SDK instance for backward compatibility and convenience
+ */
+import { SDKFactory } from './factory/SDKFactory'
+export const defaultSDK = SDKFactory.getInstance()

package/src/interfaces/base.ts

@@ -0,0 +1,556 @@
+/**
+ * Base interfaces for all SDK implementations
+ * This file defines the common contracts that all LP token SDKs must implement
+ */
+
+import type { SuiClient } from '@mysten/sui/client'
+import type { Transaction } from '@mysten/sui/transactions'
+import type { PriceFeed } from '@pythnetwork/pyth-sui-js'
+
+import type { IConsts, Network, LPToken } from '../consts'
+import { KioskClient, KioskOwnerCap } from '@mysten/kiosk'
+
+// Common data interfaces
+export interface IBaseMarketValuationInfo {
+  marketCap: number
+  price: number
+  supply: number
+  apr?: number
+}
+
+export interface IBaseMarketInfo {
+  lpSupply: string
+  positionId: string
+  vaultId: string
+  symbolId: string
+  lpSupplyWithDecimals: number
+  referralId?: string
+  orderId?: string
+  rebaseFeeModel?: string
+  apr?: string
+}
+
+export interface IBaseVaultInfo {
+  liquidity: number
+  reservedAmount: number
+  unrealisedReservingFeeAmount: number
+  accReservingRate: number
+  enabled: boolean
+  weight: number
+  lastUpdate: number
+  reservingFeeModel: IBaseReservingFeeModel
+  priceConfig: {
+    maxInterval: number
+    maxConfidence: number
+    precision: number
+    feeder: string
+  }
+}
+
+export interface IBaseReservingFeeModel {
+  multiplier: number
+}
+
+export interface IBaseFundingFeeModel {
+  multiplier: number
+  max: number
+}
+
+export interface IBaseRebaseFeeModel {
+  base: number
+  multiplier: number
+}
+
+export interface IBaseSymbolInfo {
+  openingSize: number
+  openingAmount: number
+  accFundingRate: number
+  realisedPnl: number
+  unrealisedFundingFeeValue: number
+  openEnabled: boolean
+  liquidateEnabled: boolean
+  decreaseEnabled: boolean
+  lastUpdate: number
+  fundingFeeModel: IBaseFundingFeeModel
+  long: boolean
+  priceConfig: {
+    maxInterval: number
+    maxConfidence: number
+    precision: number
+    feeder: string
+  }
+}
+
+export interface IBasePositionInfo {
+  id: string
+  long: boolean
+  owner: string
+  version: number
+  collateralToken: string
+  indexToken: string
+  collateralAmount: number
+  positionAmount: number
+  reservedAmount: number
+  positionSize: number
+  lastFundingRate: number
+  lastReservingRate: number
+  reservingFeeAmount: number
+  fundingFeeValue: number
+  closed: boolean
+  openTimestamp: number
+}
+
+export interface IBaseOrderInfo {
+  id: string
+  capId: string
+  executed: boolean
+  owner: string
+  collateralToken: string
+  indexToken: string
+  feeToken: string
+  collateralPriceThreshold: number
+  feeAmount: bigint
+  long: boolean
+  indexPrice: number
+  openOrder?: {
+    reserveAmount: bigint
+    collateralAmount: bigint
+    openAmount: bigint
+  }
+  decreaseOrder?: {
+    decreaseAmount: bigint
+    takeProfit: boolean
+  }
+  orderType: 'OPEN_POSITION' | 'DECREASE_POSITION'
+  createdAt: number
+  v11Order?: boolean
+}
+
+export interface IBasePositionConfig {
+  decreaseFeeBps: number
+  liquidationBonus: number
+  liquidationThreshold: number
+  maxLeverage: number
+  minHoldingDuration: number
+  openFeeBps: number
+  maxReservedMultiplier: number
+  minCollateralValue: number
+}
+
+export interface IBasePositionCapInfo {
+  positionCapId: string
+  symbol0: string
+  symbol1: string
+  long: boolean
+}
+
+export interface IBaseOrderCapInfo {
+  orderCapId: string
+  symbol0: string
+  symbol1: string
+  long: boolean
+  positionId: string | null
+}
+
+export interface IBaseHistory {
+  owner: string
+  txid: string
+  id: string
+  created: number
+  eventName: string
+  indexToken: string
+  direction: string
+  collateralAmount: number
+  collateralPrice: number
+  indexPrice: number
+  pnl: number
+  positionId: string
+  volume: number
+  fee: number
+  network: string
+}
+
+export interface IBasePagination {
+  total: number
+  page: number
+  limit: number
+  pages: number
+}
+
+export interface IBaseHistoryResponse {
+  histories: IBaseHistory[]
+  pagination: IBasePagination
+}
+
+export interface IBaseStaked {
+  credentials: IBaseCredential[]
+  amount: bigint
+  claimable: bigint
+}
+
+export interface IBaseStakePool {
+  id: string
+  enabled: boolean
+  lastUpdatedTime: number
+  stakedAmount: bigint
+  reward: bigint
+  startTime: number
+  endTime: number
+  accRewardPerShare: bigint
+  lockDuration: number
+}
+
+export interface IBaseCredential {
+  id: string
+  lockUntil: number
+  accRewardPerShare: bigint
+  amount: bigint
+  claimable: bigint
+}
+
+// Abstract base interfaces for SDK implementations
+export interface IBaseDataAPI {
+  readonly network: Network
+  readonly provider: SuiClient
+  readonly apiEndpoint: string
+  readonly connectionURL: string
+  readonly lpToken: LPToken
+  readonly consts: IConsts
+
+  // Core valuation methods
+  valuateVaults(tx: Transaction): any
+  valuateSymbols(tx: Transaction): any
+  valuate(tx: Transaction): { vaultsValuation: any; symbolsValuation: any }
+  valuateMarket(): Promise<IBaseMarketValuationInfo>
+
+  // Fee methods
+  fundingFeeRate(indexToken: string, long: boolean, sender?: string): Promise<number>
+  rebaseFeeRate(collateralToken: string, increase: boolean, amount: number, sender?: string): Promise<number>
+  reservingFeeRate(collateralToken: string, amount: number, sender?: string): Promise<number>
+
+  // Market data methods
+  getMarketInfo(): Promise<IBaseMarketInfo>
+  getVaultInfo(vault: string): Promise<IBaseVaultInfo>
+  getSymbolInfo(tokenId: string, long: boolean): Promise<IBaseSymbolInfo>
+  getPositionConfig(indexToken: string, long: boolean): Promise<IBasePositionConfig>
+  getOpenPositions(batchSize: number, symbol: string): Promise<IBasePositionInfo[]>
+
+  // User data methods
+  getPositionCapInfoList(owner: string): Promise<IBasePositionCapInfo[]>
+  getPositionInfoList(positionCapInfoList: IBasePositionCapInfo[], owner: string): Promise<IBasePositionInfo[]>
+  getOrderCapInfoList(owner: string): Promise<IBaseOrderCapInfo[]>
+  getOrderInfoList(orderCapInfoList: IBaseOrderCapInfo[], owner: string): Promise<IBaseOrderInfo[]>
+  getHistory(trader: string, page: number, limit: number, orderType?: string, symbol?: string): Promise<IBaseHistoryResponse>
+
+  // Staking methods
+  getStaked(owner: string): Promise<IBaseStaked>
+  getStakePool(): Promise<IBaseStakePool>
+
+  // Referral methods
+  hasReferral(referree: string): Promise<boolean>
+  getReferralData(referree: string): Promise<any>
+
+  // Oracle methods
+  getOraclePrice(tokenId: string): Promise<PriceFeed>
+  getOraclePrices(tokens: string[]): Promise<PriceFeed[]>
+  subOraclePrices(tokens: string[], callback: (price: PriceFeed) => void): Promise<() => void>
+  initOracleTxb(tokens: string[], tx?: Transaction): Promise<Transaction>
+
+  // Utility methods
+  validateCache(): void
+}
+
+export interface IBaseAPI {
+  // LP operations
+  deposit(
+    coin: string,
+    coinObjects: string[],
+    amount: number,
+    minAmountOut?: number,
+    referralAddress?: string,
+    sender?: string
+  ): Promise<Transaction>
+
+  withdraw(
+    coin: string,
+    lpCoinObjects: string[],
+    amount: number,
+    minAmountOut?: number
+  ): Promise<Transaction>
+
+  swap(
+    fromToken: string,
+    toToken: string,
+    fromAmount: bigint,
+    fromCoinObjects: string[],
+  ): Promise<Transaction>
+
+  // Staking
+  stake(
+    lpCoinObjects: string[],
+    amount: bigint,
+    pool: string,
+    tx?: Transaction
+  ): Promise<Transaction>
+
+  unstake(
+    credentials: IBaseCredential[],
+    amount: bigint,
+    pool: string,
+    tx?: Transaction
+  ): Promise<Transaction>
+
+  // Trading operations
+  openPosition(
+    collateralToken: string,
+    indexToken: string,
+    size: bigint,
+    collateralAmount: bigint,
+    coinObjects: string[],
+    long: boolean,
+    reserveAmount: bigint,
+    indexPrice: number,
+    collateralPrice: number,
+    isLimitOrder?: boolean,
+    isIocOrder?: boolean,
+    pricesSlippage?: number,
+    collateralSlippage?: number,
+    relayerFee?: bigint,
+    referralAddress?: string,
+    sender?: string
+  ): Promise<Transaction>
+
+  decreasePosition(
+    pcpId: string,
+    collateralToken: string,
+    indexToken: string,
+    amount: bigint,
+    long: boolean,
+    indexPrice: number,
+    collateralPrice: number,
+    isTriggerOrder?: boolean,
+    isTakeProfitOrder?: boolean,
+    isIocOrder?: boolean,
+    pricesSlippage?: number,
+    collateralSlippage?: number,
+    relayerFee?: bigint,
+    coinObjects?: string[]
+  ): Promise<Transaction>
+
+  decreaseMultiPositions(
+    positions: Array<{
+      pcpId: string,
+      collateralToken: string,
+      indexToken: string,
+      amount: bigint,
+      long: boolean,
+      indexPrice: number,
+      collateralPrice: number,
+      isTriggerOrder?: boolean,
+      isTakeProfitOrder?: boolean,
+      isIocOrder?: boolean,
+      pricesSlippage?: number,
+      collateralSlippage?: number,
+      relayerFee?: bigint,
+      coinObjects?: string[]
+    }>, tx?: Transaction
+  ): Promise<Transaction>
+
+  pledgeInPosition(
+    pcpId: string,
+    collateralToken: string,
+    indexToken: string,
+    amount: number,
+    coinObjects: string[],
+    long: boolean
+  ): Promise<Transaction>
+
+  redeemFromPosition(
+    pcpId: string,
+    collateralToken: string,
+    indexToken: string,
+    amount: number,
+    long: boolean
+  ): Promise<Transaction>
+
+  cancelOrder(
+    orderCapId: string,
+    collateralToken: string,
+    indexToken: string,
+    long: boolean,
+    type: string,
+    isV11Order?: boolean
+  ): Promise<Transaction>
+
+  cancelMultiOrders(
+    orders: Array<{
+      orderCapId: string,
+      collateralToken: string,
+      indexToken: string,
+      long: boolean,
+      type: string,
+      isV11Order?: boolean
+    }>, tx?: Transaction
+  ): Promise<Transaction>
+
+  clearClosedPosition(
+    pcpId: string,
+    collateralToken: string,
+    indexToken: string,
+    long: boolean,
+    tx: Transaction,
+  ): void
+
+  clearOpenPositionOrder(
+    orderCapId: string,
+    collateralToken: string,
+    indexToken: string,
+    long: boolean,
+    tx: Transaction,
+    isV11Order?: boolean
+  ): void
+
+  clearDecreasePositionOrder(
+    orderCapId: string,
+    collateralToken: string,
+    indexToken: string,
+    long: boolean,
+    tx: Transaction,
+    isV11Order?: boolean
+  ): void
+
+  // S Card operations
+  openPositionWithSCard(
+    collateralToken: string,
+    indexToken: string,
+    size: bigint,
+    collateralAmount: bigint,
+    coinObjects: string[],
+    long: boolean,
+    reserveAmount: bigint,
+    indexPrice: number,
+    collateralPrice: number,
+    kioskClient: KioskClient,
+    kioskCap: KioskOwnerCap,
+    scard: string,
+    isLimitOrder?: boolean,
+    isIocOrder?: boolean,
+    pricesSlippage?: number,
+    collateralSlippage?: number,
+    relayerFee?: bigint,
+    referralAddress?: string,
+    sender?: string,
+  ): Promise<Transaction>
+
+  decreasePositionWithSCard(
+    pcpId: string,
+    collateralToken: string,
+    indexToken: string,
+    amount: bigint,
+    long: boolean,
+    indexPrice: number,
+    collateralPrice: number,
+    kioskClient: KioskClient,
+    kioskCap: KioskOwnerCap,
+    scard: string,
+    isTriggerOrder?: boolean,
+    isTakeProfitOrder?: boolean,
+    isIocOrder?: boolean,
+    pricesSlippage?: number,
+    collateralSlippage?: number,
+    relayerFee?: bigint,
+    coinObjects?: string[]
+  ): Promise<Transaction>
+
+  decreaseMultiPositionsWithSCard(
+    positions: Array<{
+      pcpId: string,
+      collateralToken: string,
+      indexToken: string,
+      amount: bigint,
+      long: boolean,
+      indexPrice: number,
+      collateralPrice: number,
+      isTriggerOrder?: boolean,
+      isTakeProfitOrder?: boolean,
+      isIocOrder?: boolean,
+      pricesSlippage?: number,
+      collateralSlippage?: number,
+      relayerFee?: bigint,
+      coinObjects?: string[]
+    }>,
+    kioskClient: KioskClient,
+    kioskCap: KioskOwnerCap,
+    scard: string,
+    tx?: Transaction
+  ): Promise<Transaction>
+
+  claimTokenFromSCard(
+    token: string,
+    coinObjects: string[],
+    kioskClient: KioskClient,
+    kioskCap: KioskOwnerCap,
+    scard: string,
+  ): Promise<Transaction>
+
+  // Miscellaneous
+  addReferral(
+    referrer: string,
+    tx?: Transaction
+  ): Transaction
+
+  // Admin operations
+  adminUpdatePriceFeed(
+    collateralToken: string,
+    indexToken: string
+  ): Promise<Transaction>
+
+  adminSettlePosition(
+    positionId: string,
+    owner: string,
+    collateralToken: string,
+    indexToken: string,
+    long: boolean,
+  ): Promise<Transaction>
+
+  adminDecreasePosition(
+    positionId: string,
+    owner: string,
+    collateralToken: string,
+    indexToken: string,
+    positionAmount: number,
+    amount: bigint,
+    long: boolean,
+    collateralPrice?: number,
+    collateralSlippage?: number,
+    relayerFee?: bigint
+  ): Promise<Transaction>
+
+  adminClearClosedPosition(
+    positionId: string,
+    owner: string,
+    collateralToken: string,
+    indexToken: string,
+    long: boolean,
+    tx: Transaction
+  ): Promise<void>
+}
+
+// Factory interface for creating SDK instances
+export interface ISDKFactory {
+  createDataAPI(
+    network: Network,
+    provider: SuiClient,
+    apiEndpoint: string,
+    connectionURL: string,
+    lpToken: LPToken
+  ): IBaseDataAPI
+
+  createAPI(
+    network: Network,
+    provider: SuiClient,
+    apiEndpoint: string,
+    connectionURL: string,
+    lpToken: LPToken
+  ): IBaseAPI
+}

package/src/interfaces/index.ts

@@ -0,0 +1,45 @@
+/**
+ * Interface exports for all LP token types
+ * Provides a centralized export point for all SDK interfaces
+ */
+
+// Base interfaces
+export * from './base'
+
+// ZLP interfaces
+export * from './zlp'
+
+// SLP interfaces
+export * from './slp'
+
+// USDZ interfaces
+export * from './usdz'
+
+// Re-export commonly used types for convenience
+export type {
+  IBaseMarketValuationInfo,
+  IBaseDataAPI,
+  IBaseAPI,
+  ISDKFactory
+} from './base'
+
+export type {
+  IZLPMarketValuationInfo,
+  IZLPDataAPI,
+  IZLPAPI
+} from './zlp'
+
+export type {
+  ISLPMarketValuationInfo,
+  ISLPDataAPI,
+  ISLPAPI,
+  ISudoMarket,
+  ISudoVault,
+  ISudoSymbol
+} from './slp'
+
+export type {
+  IUSDZMarketValuationInfo,
+  IUSDZDataAPI,
+  IUSDZAPI
+} from './usdz'