@zofai/zo-sdk 0.1.92

package/src/interfaces/index.ts

@@ -0,0 +1,50 @@
+/**
+ * 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'
+
+// USDZ interfaces
+export * from './zbtcvc'
+
+// Re-export commonly used types for convenience
+export type {
+  IBaseAPI,
+  IBaseDataAPI,
+  IBaseMarketValuationInfo,
+  ISDKFactory,
+} from './base'
+export type {
+  ISLPAPI,
+  ISLPDataAPI,
+  ISLPMarketValuationInfo,
+  ISudoMarket,
+  ISudoSymbol,
+  ISudoVault,
+} from './slp'
+export type {
+  IUSDZAPI,
+  IUSDZDataAPI,
+  IUSDZMarketValuationInfo,
+} from './usdz'
+export type {
+  IZBTCVCAPI,
+  IZBTCVCDataAPI,
+  IZBTCVCMarketValuationInfo,
+} from './zbtcvc'
+export type {
+  IZLPAPI,
+  IZLPDataAPI,
+  IZLPMarketValuationInfo,
+} from './zlp'

package/src/interfaces/slp.ts

@@ -0,0 +1,268 @@
+/**
+ * SLP-specific interfaces and types
+ * Extends base interfaces with SLP-specific implementations for Sudo SDK
+ */
+
+import type { KioskClient, KioskOwnerCap } from '@mysten/kiosk'
+import type { Transaction, TransactionObjectArgument } from '@mysten/sui/transactions'
+
+import type {
+  IBaseAPI,
+  IBaseCredential,
+  IBaseDataAPI,
+  IBaseFundingFeeModel,
+  IBaseHistory,
+  IBaseMarketInfo,
+  IBaseMarketValuationInfo,
+  IBaseOrderCapInfo,
+  IBaseOrderInfo,
+  IBasePositionCapInfo,
+  IBasePositionConfig,
+  IBasePositionInfo,
+  IBaseRebaseFeeModel,
+  IBaseReservingFeeModel,
+  IBaseStaked,
+  IBaseStakePool,
+  IBaseSymbolInfo,
+  IBaseVaultInfo,
+} from './base'
+
+// SLP-specific interfaces
+export interface ISLPMarketValuationInfo extends IBaseMarketValuationInfo { }
+
+export interface ISLPVaultInfo extends IBaseVaultInfo { }
+
+export interface ISLPSymbolInfo extends IBaseSymbolInfo { }
+
+export interface ISLPFundingFeeModel extends IBaseFundingFeeModel { }
+
+export interface ISLPReservingFeeModel extends IBaseReservingFeeModel { }
+
+export interface ISLPRebaseFeeModel extends IBaseRebaseFeeModel { }
+
+export interface ISLPMarketInfo extends IBaseMarketInfo { }
+
+export interface ISLPPositionInfo extends IBasePositionInfo { }
+
+export interface ISLPPositionConfig extends IBasePositionConfig { }
+
+export interface ISLPPositionCapInfo extends IBasePositionCapInfo { }
+
+export interface ISLPOrderInfo extends IBaseOrderInfo {
+  orderVersion: string
+}
+
+export interface ISLPOrderCapInfo extends IBaseOrderCapInfo { }
+
+export interface ISLPHistory extends IBaseHistory { }
+
+export interface ISLPStaked extends IBaseStaked { }
+
+export interface ISLPStakePool extends IBaseStakePool {
+  // SLP-specific stake pool fields to match new staking implementation
+  rewardRate?: bigint // Optional for backward compatibility
+}
+
+export interface ISLPCredential extends IBaseCredential { }
+
+// ZLP Symbol Config interfaces
+export interface ISLPPositionInstantExitFeeConfig {
+  instant_exit_tier_1_duration_threshold: number
+  instant_exit_tier_1_fee_bps: number
+  instant_exit_tier_1_fee_enabled: boolean
+  instant_exit_tier_2_duration_threshold: number
+  instant_exit_tier_2_fee_bps: number
+  instant_exit_tier_2_fee_enabled: boolean
+  instant_exit_tier_3_duration_threshold: number
+  instant_exit_tier_3_fee_bps: number
+  instant_exit_tier_3_fee_enabled: boolean
+}
+
+export interface ISLPSymbolConfig {
+  id: string
+  max_opening_size: number
+  max_opening_size_enabled: boolean
+  max_opening_size_per_position: number
+  max_opening_size_per_position_enabled: boolean
+  instant_exit_fee_config: ISLPPositionInstantExitFeeConfig
+}
+
+export interface ISLPOiFundingModel {
+  id: string
+  multiplier: number
+  exponent: number
+  max: number
+}
+
+export interface ISLPOiFundingState {
+  id: string
+  enabled: boolean
+  last_update: number
+  model: ISLPOiFundingModel
+}
+
+/**
+ * Price impact configuration for a trading symbol.
+ * Used to compute dynamic spreads based on OI skew.
+ */
+export interface ISLPPriceImpactConfig {
+  id: string
+  /** Whether price impact is enabled for this symbol */
+  enabled: boolean
+  /** Base spread applied to all trades (as a rate, e.g., 0.001 = 0.1%) */
+  baseSpreadRate: number
+  /** Maximum additional dynamic spread based on OI skew */
+  maxDynamicSpreadRate: number
+  /** Cap for total spread (base + dynamic) */
+  maxTotalSpreadRate: number
+  /** Exponent for spread curve (1.0=linear, 2.0=quadratic, 3.0=cubic) */
+  impactExponent: number
+  /** Maximum OI for long side used in skew calculation */
+  maxOiLong: number
+  /** Maximum OI for short side used in skew calculation */
+  maxOiShort: number
+  /** Reference position size for size scaling. If zero, size scaling is disabled. */
+  referenceSize: number
+}
+
+// Sudo SDK specific data structures
+export interface ISudoMarket {
+  lpSupply: bigint
+  lpSupplyWithDecimals: number
+  totalValue: number
+  apr?: number
+}
+
+export interface ISudoVault {
+  symbol: string
+  liquidity: bigint
+  reservedAmount: bigint
+  enabled: boolean
+  weight: number
+  lastUpdate: number
+  totalValue: number
+}
+
+export interface ISudoSymbol {
+  name: string
+  openingSize: bigint
+  openingAmount: bigint
+  fundingRate: number
+  long: boolean
+  lastUpdate: number
+  totalOpenInterest: number
+}
+
+export interface ISudoPosition {
+  id: string
+  owner: string
+  symbol: string
+  size: bigint
+  collateralAmount: bigint
+  long: boolean
+  lastUpdate: number
+  unrealizedPnl: number
+  liquidationPrice: number
+}
+
+export interface ISudoOrder {
+  id: string
+  owner: string
+  symbol: string
+  size: bigint
+  triggerPrice: number
+  long: boolean
+  createdAt: number
+}
+
+export interface ISudoHistory {
+  owner: string
+  txid: string
+  id: string
+  timestamp: number
+  action: string
+  symbol: string
+  price: number
+  size: number
+  pnl: number
+  fee: number
+}
+
+export interface ISudoStaked {
+  credentials: ISudoStakeCredential[]
+  amount: bigint
+  claimable: bigint
+}
+
+export interface ISudoStakeCredential {
+  id: string
+  poolId: string
+  amount: bigint
+  lockUntil: number
+  claimable: bigint
+  rewardRate: number
+}
+
+// SLP-specific data API interface
+export interface ISLPDataAPI extends IBaseDataAPI {
+  getCumulativeApr: () => Promise<number>
+  getSymbolConfig: (indexToken: string, long: boolean) => Promise<ISLPSymbolConfig | null>
+  getPriceImpactConfig: (indexToken: string) => Promise<ISLPPriceImpactConfig | null>
+}
+
+// SLP-specific API interface
+export interface ISLPAPI extends IBaseAPI {
+  // SLP-specific api methods can be added here
+  claimTokenFromSCard: (
+    token: string,
+    coinObjects: string[],
+    kioskClient: KioskClient,
+    kioskCap: KioskOwnerCap,
+    scard: string
+  ) => Transaction
+
+  depositPtb: (
+    coin: string,
+    coinObjects: string[],
+    amount: number,
+    minAmountOut?: number,
+    referralAddress?: string,
+    sender?: string,
+    tx?: Transaction,
+    sponsoredTx?: boolean,
+    suiCoinObjectsForPythUpdate?: string[],
+  ) => Promise<TransactionObjectArgument>
+
+  withdrawLpCoinObject: (
+    coin: string,
+    lpCoinObject: TransactionObjectArgument,
+    minAmountOut: number,
+    tx?: Transaction,
+  ) => Promise<Transaction>
+
+  stakeCoinObject: (
+    coinObject: TransactionObjectArgument,
+    pool: string,
+    tx?: Transaction,
+  ) => Transaction
+
+  withdrawFromVaultPtb: (
+    pool: string,
+    credential: string,
+    withdrawAmount: bigint,
+    tx: Transaction,
+  ) => TransactionObjectArgument
+
+  claimRewardsPtb: (
+    pool: string,
+    credential: string,
+    tx: Transaction,
+  ) => TransactionObjectArgument
+
+  unstakeToCoins: (
+    credentials: ISLPCredential[],
+    amount: bigint,
+    pool: string,
+    tx: Transaction,
+  ) => TransactionObjectArgument[]
+}

package/src/interfaces/usdz.ts

@@ -0,0 +1,181 @@
+/**
+ * USDZ-specific interfaces and types
+ * Extends base interfaces with USDZ-specific implementations
+ */
+
+import type { Transaction, TransactionObjectArgument } from '@mysten/sui/transactions'
+
+import type {
+  IBaseAPI,
+  IBaseCredential,
+  IBaseDataAPI,
+  IBaseFundingFeeModel,
+  IBaseHistory,
+  IBaseMarketInfo,
+  IBaseMarketValuationInfo,
+  IBaseOrderCapInfo,
+  IBaseOrderInfo,
+  IBasePositionCapInfo,
+  IBasePositionConfig,
+  IBasePositionInfo,
+  IBaseRebaseFeeModel,
+  IBaseReservingFeeModel,
+  IBaseStakePool,
+  IBaseSymbolInfo,
+  IBaseVaultInfo,
+} from './base'
+
+// USDZ-specific interfaces
+export interface IUSDZMarketValuationInfo extends IBaseMarketValuationInfo { }
+
+export interface IUSDZVaultInfo extends IBaseVaultInfo { }
+
+export interface IUSDZReservingFeeModel extends IBaseReservingFeeModel { }
+
+export interface IUSDZFundingFeeModel extends IBaseFundingFeeModel { }
+
+export interface IUSDZRebaseFeeModel extends IBaseRebaseFeeModel { }
+
+export interface IUSDZSymbolInfo extends IBaseSymbolInfo { }
+
+export interface IUSDZMarketInfo extends IBaseMarketInfo {
+  // USDZ-specific market info fields can be added here
+}
+
+export interface IUSDZPositionInfo extends IBasePositionInfo {
+  // USDZ-specific position fields can be added here
+}
+
+export interface IUSDZPositionConfig extends IBasePositionConfig { }
+
+export interface IUSDZPositionCapInfo extends IBasePositionCapInfo { }
+
+export interface IUSDZOrderInfo extends IBaseOrderInfo { }
+
+export interface IUSDZOrderCapInfo extends IBaseOrderCapInfo { }
+
+export interface IUSDZHistory extends IBaseHistory {
+  // USDZ-specific history fields can be added here
+}
+
+export interface IUSDZStakePool extends IBaseStakePool {
+  // USDZ-specific stake pool fields can be added here
+  rewardRate: bigint
+}
+
+export interface IUSDZCredential extends IBaseCredential {
+  // USDZ-specific credential fields can be added here
+}
+
+// USDZ Symbol Config interfaces
+export interface IUSDZPositionInstantExitFeeConfig {
+  instant_exit_tier_1_duration_threshold: number
+  instant_exit_tier_1_fee_bps: number
+  instant_exit_tier_1_fee_enabled: boolean
+  instant_exit_tier_2_duration_threshold: number
+  instant_exit_tier_2_fee_bps: number
+  instant_exit_tier_2_fee_enabled: boolean
+  instant_exit_tier_3_duration_threshold: number
+  instant_exit_tier_3_fee_bps: number
+  instant_exit_tier_3_fee_enabled: boolean
+}
+
+export interface IUSDZSymbolConfig {
+  id: string
+  max_opening_size: number
+  max_opening_size_enabled: boolean
+  max_opening_size_per_position: number
+  max_opening_size_per_position_enabled: boolean
+  instant_exit_fee_config: IUSDZPositionInstantExitFeeConfig
+}
+
+export interface IUSDZOiFundingModel {
+  id: string
+  multiplier: number
+  exponent: number
+  max: number
+}
+export interface IUSDZOiFundingState {
+  id: string
+  enabled: boolean
+  last_update: number
+  model: IUSDZOiFundingModel
+}
+
+/**
+ * Price impact configuration for a trading symbol.
+ * Used to compute dynamic spreads based on OI skew.
+ */
+export interface IUSDZPriceImpactConfig {
+  id: string
+  /** Whether price impact is enabled for this symbol */
+  enabled: boolean
+  /** Base spread applied to all trades (as a rate, e.g., 0.001 = 0.1%) */
+  baseSpreadRate: number
+  /** Maximum additional dynamic spread based on OI skew */
+  maxDynamicSpreadRate: number
+  /** Cap for total spread (base + dynamic) */
+  maxTotalSpreadRate: number
+  /** Exponent for spread curve (1.0=linear, 2.0=quadratic, 3.0=cubic) */
+  impactExponent: number
+  /** Maximum OI for long side used in skew calculation */
+  maxOiLong: number
+  /** Maximum OI for short side used in skew calculation */
+  maxOiShort: number
+  /** Reference position size for size scaling. If zero, size scaling is disabled. */
+  referenceSize: number
+}
+
+// USDZ-specific data API interface
+export interface IUSDZDataAPI extends IBaseDataAPI {
+  getSymbolConfig: (indexToken: string, long: boolean) => Promise<IUSDZSymbolConfig | null>
+  getPriceImpactConfig: (indexToken: string) => Promise<IUSDZPriceImpactConfig | null>
+}
+
+// USDZ-specific API interface
+export interface IUSDZAPI extends IBaseAPI {
+  depositPtb: (
+    coin: string,
+    coinObjects: string[],
+    amount: number,
+    minAmountOut?: number,
+    referralAddress?: string,
+    sender?: string,
+    tx?: Transaction,
+    sponsoredTx?: boolean,
+    suiCoinObjectsForPythUpdate?: string[],
+  ) => Promise<TransactionObjectArgument>
+
+  withdrawLpCoinObject: (
+    coin: string,
+    lpCoinObject: TransactionObjectArgument,
+    minAmountOut: number,
+    tx?: Transaction,
+  ) => Promise<Transaction>
+
+  stakeCoinObject: (
+    coinObject: TransactionObjectArgument,
+    pool: string,
+    tx?: Transaction,
+  ) => Transaction
+
+  withdrawFromVaultPtb: (
+    pool: string,
+    credential: string,
+    withdrawAmount: bigint,
+    tx: Transaction,
+  ) => TransactionObjectArgument
+
+  claimRewardsPtb: (
+    pool: string,
+    credential: string,
+    tx: Transaction,
+  ) => TransactionObjectArgument
+
+  unstakeToCoins: (
+    credentials: IUSDZCredential[],
+    amount: bigint,
+    pool: string,
+    tx: Transaction,
+  ) => TransactionObjectArgument[]
+}

package/src/interfaces/zbtcvc.ts

@@ -0,0 +1,116 @@
+/**
+ * USDZ-specific interfaces and types
+ * Extends base interfaces with USDZ-specific implementations
+ */
+
+import type { Transaction, TransactionObjectArgument } from '@mysten/sui/transactions'
+
+import type {
+  IBaseAPI,
+  IBaseCredential,
+  IBaseDataAPI,
+  IBaseFundingFeeModel,
+  IBaseHistory,
+  IBaseMarketInfo,
+  IBaseMarketValuationInfo,
+  IBaseOrderCapInfo,
+  IBaseOrderInfo,
+  IBasePositionCapInfo,
+  IBasePositionConfig,
+  IBasePositionInfo,
+  IBaseRebaseFeeModel,
+  IBaseReservingFeeModel,
+  IBaseStakePool,
+  IBaseSymbolInfo,
+  IBaseVaultInfo,
+} from './base'
+
+// USDZ-specific interfaces
+export interface IZBTCVCMarketValuationInfo extends IBaseMarketValuationInfo { }
+
+export interface IZBTCVCVaultInfo extends IBaseVaultInfo { }
+
+export interface IZBTCVCReservingFeeModel extends IBaseReservingFeeModel { }
+
+export interface IZBTCVCFundingFeeModel extends IBaseFundingFeeModel { }
+
+export interface IZBTCVCRebaseFeeModel extends IBaseRebaseFeeModel { }
+
+export interface IZBTCVCSymbolInfo extends IBaseSymbolInfo { }
+
+export interface IZBTCVCMarketInfo extends IBaseMarketInfo {
+  // USDZ-specific market info fields can be added here
+}
+
+export interface IZBTCVCPositionInfo extends IBasePositionInfo {
+  // USDZ-specific position fields can be added here
+}
+
+export interface IZBTCVCPositionConfig extends IBasePositionConfig { }
+
+export interface IZBTCVCPositionCapInfo extends IBasePositionCapInfo { }
+
+export interface IZBTCVCOrderInfo extends IBaseOrderInfo { }
+
+export interface IZBTCVCOrderCapInfo extends IBaseOrderCapInfo { }
+
+export interface IZBTCVCHistory extends IBaseHistory {
+  // USDZ-specific history fields can be added here
+}
+
+export interface IZBTCVCStakePool extends IBaseStakePool {
+  // USDZ-specific stake pool fields can be added here
+  rewardRate: bigint
+}
+
+export interface IZBTCVCCredential extends IBaseCredential {
+  // USDZ-specific credential fields can be added here
+}
+
+// USDZ Symbol Config interfaces
+export interface IZBTCVCPositionInstantExitFeeConfig {
+  instant_exit_tier_1_duration_threshold: number
+  instant_exit_tier_1_fee_bps: number
+  instant_exit_tier_1_fee_enabled: boolean
+  instant_exit_tier_2_duration_threshold: number
+  instant_exit_tier_2_fee_bps: number
+  instant_exit_tier_2_fee_enabled: boolean
+  instant_exit_tier_3_duration_threshold: number
+  instant_exit_tier_3_fee_bps: number
+  instant_exit_tier_3_fee_enabled: boolean
+}
+
+export interface IZBTCVCSymbolConfig {
+  id: string
+  max_opening_size: number
+  max_opening_size_enabled: boolean
+  max_opening_size_per_position: number
+  max_opening_size_per_position_enabled: boolean
+  instant_exit_fee_config: IZBTCVCPositionInstantExitFeeConfig
+}
+
+// USDZ-specific data API interface
+export interface IZBTCVCDataAPI extends IBaseDataAPI {
+  getSymbolConfig: (indexToken: string, long: boolean) => Promise<IZBTCVCSymbolConfig | null>
+}
+
+// USDZ-specific API interface
+export interface IZBTCVCAPI extends IBaseAPI {
+  depositPtb: (
+    coin: string,
+    coinObjects: string[],
+    amount: number,
+    minAmountOut?: number,
+    referralAddress?: string,
+    sender?: string,
+    tx?: Transaction,
+    sponsoredTx?: boolean,
+    suiCoinObjectsForPythUpdate?: string[],
+  ) => Promise<TransactionObjectArgument>
+
+  stakeCoinObject: (
+    coinObject: TransactionObjectArgument,
+    pool: string,
+    tx?: Transaction,
+  ) => Transaction
+}