zo-sdk 0.1.2 → 0.1.3

package/src/interfaces/base.ts

@@ -3,12 +3,12 @@
  * This file defines the common contracts that all LP token SDKs must implement
  */
 
+import type { KioskClient, KioskOwnerCap } from '@mysten/kiosk'
 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'
+import type { IConsts, LPToken, Network } from '../consts'
 
 // Common data interfaces
 export interface IBaseMarketValuationInfo {
@@ -218,90 +218,95 @@ export interface IBaseDataAPI {
   readonly consts: IConsts
 
   // Core valuation methods
-  valuateVaults(tx: Transaction): any
-  valuateSymbols(tx: Transaction): any
-  valuate(tx: Transaction): { vaultsValuation: any; symbolsValuation: any }
-  valuateMarket(): Promise<IBaseMarketValuationInfo>
+  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>
+  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[]>
+  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>
+  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>
+  getStaked: (owner: string) => Promise<IBaseStaked>
+  getStakePool: () => Promise<IBaseStakePool>
 
   // Referral methods
-  hasReferral(referree: string): Promise<boolean>
-  getReferralData(referree: string): Promise<any>
+  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>
+  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
+  validateCache: () => void
 }
 
 export interface IBaseAPI {
   // LP operations
-  deposit(
+  deposit: (
     coin: string,
     coinObjects: string[],
     amount: number,
     minAmountOut?: number,
     referralAddress?: string,
-    sender?: string
-  ): Promise<Transaction>
+    sender?: string,
+    sponsoredTx?: boolean,
+    suiCoinObjectsForPythUpdate?: string[],
+    isDepositingSui?: boolean,
+  ) => Promise<Transaction>
 
-  withdraw(
+  withdraw: (
     coin: string,
     lpCoinObjects: string[],
     amount: number,
-    minAmountOut?: number
-  ): Promise<Transaction>
+    minAmountOut?: number,
+    sponsoredTx?: boolean,
+    suiCoinObjectsForPythUpdate?: string[],
+  ) => Promise<Transaction>
 
-  swap(
+  swap: (
     fromToken: string,
     toToken: string,
     fromAmount: bigint,
     fromCoinObjects: string[],
-  ): Promise<Transaction>
+  ) => Promise<Transaction>
 
   // Staking
-  stake(
+  stake: (
     lpCoinObjects: string[],
     amount: bigint,
     pool: string,
     tx?: Transaction
-  ): Promise<Transaction>
+  ) => Transaction
 
-  unstake(
+  unstake: (
     credentials: IBaseCredential[],
     amount: bigint,
     pool: string,
     tx?: Transaction
-  ): Promise<Transaction>
+  ) => Transaction
 
   // Trading operations
-  openPosition(
+  openPosition: (
     collateralToken: string,
     indexToken: string,
     size: bigint,
@@ -318,9 +323,9 @@ export interface IBaseAPI {
     relayerFee?: bigint,
     referralAddress?: string,
     sender?: string
-  ): Promise<Transaction>
+  ) => Promise<Transaction>
 
-  decreasePosition(
+  decreasePosition: (
     pcpId: string,
     collateralToken: string,
     indexToken: string,
@@ -335,92 +340,94 @@ export interface IBaseAPI {
     collateralSlippage?: number,
     relayerFee?: bigint,
     coinObjects?: string[]
-  ): Promise<Transaction>
+  ) => Promise<Transaction>
 
-  decreaseMultiPositions(
+  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,
+      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>
+    }>,
+    tx?: Transaction
+  ) => Promise<Transaction>
 
-  pledgeInPosition(
+  pledgeInPosition: (
     pcpId: string,
     collateralToken: string,
     indexToken: string,
     amount: number,
     coinObjects: string[],
     long: boolean
-  ): Promise<Transaction>
+  ) => Promise<Transaction>
 
-  redeemFromPosition(
+  redeemFromPosition: (
     pcpId: string,
     collateralToken: string,
     indexToken: string,
     amount: number,
     long: boolean
-  ): Promise<Transaction>
+  ) => Promise<Transaction>
 
-  cancelOrder(
+  cancelOrder: (
     orderCapId: string,
     collateralToken: string,
     indexToken: string,
     long: boolean,
     type: string,
     isV11Order?: boolean
-  ): Promise<Transaction>
+  ) => Transaction
 
-  cancelMultiOrders(
+  cancelMultiOrders: (
     orders: Array<{
-      orderCapId: string,
-      collateralToken: string,
-      indexToken: string,
-      long: boolean,
-      type: string,
+      orderCapId: string
+      collateralToken: string
+      indexToken: string
+      long: boolean
+      type: string
       isV11Order?: boolean
-    }>, tx?: Transaction
-  ): Promise<Transaction>
+    }>,
+    tx?: Transaction
+  ) => Transaction
 
-  clearClosedPosition(
+  clearClosedPosition: (
     pcpId: string,
     collateralToken: string,
     indexToken: string,
     long: boolean,
     tx: Transaction,
-  ): void
+  ) => void
 
-  clearOpenPositionOrder(
+  clearOpenPositionOrder: (
     orderCapId: string,
     collateralToken: string,
     indexToken: string,
     long: boolean,
     tx: Transaction,
     isV11Order?: boolean
-  ): void
+  ) => void
 
-  clearDecreasePositionOrder(
+  clearDecreasePositionOrder: (
     orderCapId: string,
     collateralToken: string,
     indexToken: string,
     long: boolean,
     tx: Transaction,
     isV11Order?: boolean
-  ): void
+  ) => void
 
   // S Card operations
-  openPositionWithSCard(
+  openPositionWithSCard: (
     collateralToken: string,
     indexToken: string,
     size: bigint,
@@ -440,9 +447,9 @@ export interface IBaseAPI {
     relayerFee?: bigint,
     referralAddress?: string,
     sender?: string,
-  ): Promise<Transaction>
+  ) => Promise<Transaction>
 
-  decreasePositionWithSCard(
+  decreasePositionWithSCard: (
     pcpId: string,
     collateralToken: string,
     indexToken: string,
@@ -460,60 +467,60 @@ export interface IBaseAPI {
     collateralSlippage?: number,
     relayerFee?: bigint,
     coinObjects?: string[]
-  ): Promise<Transaction>
+  ) => Promise<Transaction>
 
-  decreaseMultiPositionsWithSCard(
+  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,
+      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>
+  ) => Promise<Transaction>
 
-  claimTokenFromSCard(
+  claimTokenFromSCard: (
     token: string,
     coinObjects: string[],
     kioskClient: KioskClient,
     kioskCap: KioskOwnerCap,
     scard: string,
-  ): Promise<Transaction>
+  ) => Transaction
 
   // Miscellaneous
-  addReferral(
+  addReferral: (
     referrer: string,
     tx?: Transaction
-  ): Transaction
+  ) => Transaction
 
   // Admin operations
-  adminUpdatePriceFeed(
+  adminUpdatePriceFeed: (
     collateralToken: string,
     indexToken: string
-  ): Promise<Transaction>
+  ) => Promise<Transaction>
 
-  adminSettlePosition(
+  adminSettlePosition: (
     positionId: string,
     owner: string,
     collateralToken: string,
     indexToken: string,
     long: boolean,
-  ): Promise<Transaction>
+  ) => Transaction
 
-  adminDecreasePosition(
+  adminDecreasePosition: (
     positionId: string,
     owner: string,
     collateralToken: string,
@@ -524,33 +531,33 @@ export interface IBaseAPI {
     collateralPrice?: number,
     collateralSlippage?: number,
     relayerFee?: bigint
-  ): Promise<Transaction>
+  ) => Transaction
 
-  adminClearClosedPosition(
+  adminClearClosedPosition: (
     positionId: string,
     owner: string,
     collateralToken: string,
     indexToken: string,
     long: boolean,
     tx: Transaction
-  ): Promise<void>
+  ) => void
 }
 
 // Factory interface for creating SDK instances
 export interface ISDKFactory {
-  createDataAPI(
+  createDataAPI: (
     network: Network,
     provider: SuiClient,
     apiEndpoint: string,
     connectionURL: string,
     lpToken: LPToken
-  ): IBaseDataAPI
+  ) => IBaseDataAPI
 
-  createAPI(
+  createAPI: (
     network: Network,
     provider: SuiClient,
     apiEndpoint: string,
     connectionURL: string,
     lpToken: LPToken
-  ): IBaseAPI
-}
+  ) => IBaseAPI
+}

package/src/interfaces/index.ts

@@ -17,29 +17,26 @@ export * from './usdz'
 
 // Re-export commonly used types for convenience
 export type {
-  IBaseMarketValuationInfo,
-  IBaseDataAPI,
   IBaseAPI,
-  ISDKFactory
+  IBaseDataAPI,
+  IBaseMarketValuationInfo,
+  ISDKFactory,
 } from './base'
-
 export type {
-  IZLPMarketValuationInfo,
-  IZLPDataAPI,
-  IZLPAPI
-} from './zlp'
-
-export type {
-  ISLPMarketValuationInfo,
-  ISLPDataAPI,
   ISLPAPI,
+  ISLPDataAPI,
+  ISLPMarketValuationInfo,
   ISudoMarket,
+  ISudoSymbol,
   ISudoVault,
-  ISudoSymbol
 } from './slp'
-
 export type {
-  IUSDZMarketValuationInfo,
+  IUSDZAPI,
   IUSDZDataAPI,
-  IUSDZAPI
-} from './usdz'
+  IUSDZMarketValuationInfo,
+} from './usdz'
+export type {
+  IZLPAPI,
+  IZLPDataAPI,
+  IZLPMarketValuationInfo,
+} from './zlp'

package/src/interfaces/slp.ts

@@ -3,28 +3,29 @@
  * Extends base interfaces with SLP-specific implementations for Sudo SDK
  */
 
-import { Transaction } from '@mysten/sui/transactions'
+import type { KioskClient, KioskOwnerCap } from '@mysten/kiosk'
+import type { Transaction } from '@mysten/sui/transactions'
+
 import type {
-  IBaseMarketValuationInfo,
-  IBaseVaultInfo,
-  IBaseSymbolInfo,
-  IBaseMarketInfo,
-  IBasePositionInfo,
-  IBaseOrderInfo,
-  IBaseHistory,
-  IBaseStakePool,
+  IBaseAPI,
   IBaseCredential,
   IBaseDataAPI,
-  IBaseAPI,
-  IBasePositionCapInfo,
+  IBaseFundingFeeModel,
+  IBaseHistory,
+  IBaseMarketInfo,
+  IBaseMarketValuationInfo,
   IBaseOrderCapInfo,
-  IBaseStaked,
+  IBaseOrderInfo,
+  IBasePositionCapInfo,
   IBasePositionConfig,
-  IBaseFundingFeeModel,
+  IBasePositionInfo,
+  IBaseRebaseFeeModel,
   IBaseReservingFeeModel,
-  IBaseRebaseFeeModel
+  IBaseStaked,
+  IBaseStakePool,
+  IBaseSymbolInfo,
+  IBaseVaultInfo,
 } from './base'
-import { KioskClient, KioskOwnerCap } from '@mysten/kiosk'
 
 // SLP-specific interfaces
 export interface ISLPMarketValuationInfo extends IBaseMarketValuationInfo { }
@@ -140,17 +141,17 @@ export interface ISudoStakeCredential {
 // SLP-specific data API interface
 export interface ISLPDataAPI extends IBaseDataAPI {
   // SLP-specific data api methods can be added here
-  getCumulativeApr(): Promise<number>
+  getCumulativeApr: () => Promise<number>
 }
 
 // SLP-specific API interface
 export interface ISLPAPI extends IBaseAPI {
   // SLP-specific api methods can be added here
-  claimTokenFromSCard(
+  claimTokenFromSCard: (
     token: string,
     coinObjects: string[],
     kioskClient: KioskClient,
     kioskCap: KioskOwnerCap,
     scard: string
-  ): Promise<Transaction>
-}
+  ) => Transaction
+}

package/src/interfaces/usdz.ts

@@ -4,23 +4,23 @@
  */
 
 import type {
-  IBaseMarketValuationInfo,
-  IBaseVaultInfo,
-  IBaseSymbolInfo,
-  IBaseMarketInfo,
-  IBasePositionInfo,
-  IBaseOrderInfo,
-  IBaseHistory,
-  IBaseStakePool,
+  IBaseAPI,
   IBaseCredential,
   IBaseDataAPI,
-  IBaseAPI,
   IBaseFundingFeeModel,
-  IBasePositionConfig,
+  IBaseHistory,
+  IBaseMarketInfo,
+  IBaseMarketValuationInfo,
+  IBaseOrderCapInfo,
+  IBaseOrderInfo,
   IBasePositionCapInfo,
+  IBasePositionConfig,
+  IBasePositionInfo,
+  IBaseRebaseFeeModel,
   IBaseReservingFeeModel,
-  IBaseOrderCapInfo,
-  IBaseRebaseFeeModel
+  IBaseStakePool,
+  IBaseSymbolInfo,
+  IBaseVaultInfo,
 } from './base'
 
 // USDZ-specific interfaces
@@ -68,4 +68,4 @@ export interface IUSDZCredential extends IBaseCredential {
 export interface IUSDZDataAPI extends IBaseDataAPI { }
 
 // USDZ-specific API interface
-export interface IUSDZAPI extends IBaseAPI { }
+export interface IUSDZAPI extends IBaseAPI { }

package/src/interfaces/zlp.ts

@@ -4,24 +4,25 @@
  */
 
 import type { Transaction } from '@mysten/sui/transactions'
+
 import type {
-  IBaseMarketValuationInfo,
-  IBaseVaultInfo,
-  IBaseSymbolInfo,
-  IBaseMarketInfo,
-  IBasePositionInfo,
-  IBaseOrderInfo,
-  IBaseHistory,
-  IBaseStakePool,
+  IBaseAPI,
   IBaseCredential,
   IBaseDataAPI,
-  IBaseAPI,
   IBaseFundingFeeModel,
-  IBasePositionConfig,
+  IBaseHistory,
+  IBaseMarketInfo,
+  IBaseMarketValuationInfo,
+  IBaseOrderCapInfo,
+  IBaseOrderInfo,
   IBasePositionCapInfo,
+  IBasePositionConfig,
+  IBasePositionInfo,
+  IBaseRebaseFeeModel,
   IBaseReservingFeeModel,
-  IBaseOrderCapInfo,
-  IBaseRebaseFeeModel
+  IBaseStakePool,
+  IBaseSymbolInfo,
+  IBaseVaultInfo,
 } from './base'
 
 // ZLP-specific interfaces
@@ -70,27 +71,27 @@ export interface IZLPDataAPI extends IBaseDataAPI { }
 
 // ZLP-specific API interface
 export interface IZLPAPI extends IBaseAPI {
-  adminIssueLootbox(
+  adminIssueLootbox: (
     coin: string,
     tiers: number[],
     beneficiaries: string[],
     amounts: number[],
     tx: Transaction,
-  ): Promise<void>
+  ) => void
 
-  depositToPrizePool(
+  depositToPrizePool: (
     coin: string,
     coinObjects: string[],
     amount: number,
-  ): Promise<Transaction>
+  ) => Transaction
 
-  withdrawFromPricePool(
+  withdrawFromPricePool: (
     coin: string,
     amount: number
-  ): Promise<Transaction>
+  ) => Transaction
 
-  openLootbox(
+  openLootbox: (
     coin: string,
     lootbox: string
-  ): Promise<Transaction>
-}
+  ) => Transaction
+}