@zofai/zo-sdk 0.2.15 → 0.2.17

package/src/implementations/USDZAPI.ts

@@ -20,7 +20,7 @@ import type {
 } from '../interfaces'
 import type { IInitPythProOracleOptions } from '../oracle'
 import type { OracleInputs, OracleInputsAlt } from '../oraclePro'
-import { buildOracleInputsAlt, oracleArgsAlt, oracleArgsStandard, oracleArgsWithClock } from '../oraclePro'
+import { buildOracleInputsAlt, oracleArgsAlt, oracleArgsStandard } from '../oraclePro'
 import type { SuiClient } from '../suiClient'
 import { joinSymbol, parseSymbolKey } from '../utils'
 import { USDZDataAPI } from './USDZDataAPI'
@@ -2329,7 +2329,6 @@ export class USDZAPI extends BaseAPI implements IUSDZAPI {
     sender?: string,
   ): Promise<Transaction> {
     let tx = new Transaction()
-    // Handle oracle initialization and coin processing
     let suiCoinObject
     if (sponsoredTx) {
       const oracle = await this.initOracleTxb([collateralToken, indexToken], tx, true, {
@@ -2343,14 +2342,12 @@ export class USDZAPI extends BaseAPI implements IUSDZAPI {
       tx = (await this.initOracleTxb([collateralToken, indexToken], tx)).tx
     }
 
-    // Process coin splitting
-    const [depositObject] = this.processCoinSplitting(
+    const depositObject = await this.resolveSplitCoinObject(
       tx,
       collateralToken,
+      BigInt(amount),
       coinObjects,
-      [tx.pure.u64(amount)],
-      sponsoredTx,
-      suiCoinObject,
+      { sponsoredTx, suiCoinObject, sender },
     )
 
     tx.moveCall({
@@ -2363,6 +2360,8 @@ export class USDZAPI extends BaseAPI implements IUSDZAPI {
       ],
       arguments: [tx.object(this.consts.zoCore.market), tx.object(pcpId), depositObject],
     })
+
+    this.returnUnusedSuiCoin(tx, suiCoinObject, sender)
     return tx
   }
 
@@ -2411,6 +2410,7 @@ export class USDZAPI extends BaseAPI implements IUSDZAPI {
       ],
     })
 
+    this.returnUnusedSuiCoin(tx, suiCoinObject, sender)
     return tx
   }
 
@@ -2678,7 +2678,7 @@ export class USDZAPI extends BaseAPI implements IUSDZAPI {
         fromDepositObject,
         tx_.pure.u64(minAmountOut || 0),
         vaultsValuation,
-        ...oracleArgsWithClock(oracle),
+        ...oracleArgsStandard(oracle),
       ],
     })
     return tx_
@@ -2722,7 +2722,7 @@ export class USDZAPI extends BaseAPI implements IUSDZAPI {
         fromDepositObject,
         tx_.pure.u64(minAmountOut || 0),
         vaultsValuation,
-        ...oracleArgsWithClock(oracle),
+        ...oracleArgsStandard(oracle),
       ],
     })
     return outputCoin
@@ -2905,6 +2905,171 @@ export class USDZAPI extends BaseAPI implements IUSDZAPI {
     return tx
   }
 
+  /**
+   * Opens a position with a pre-composed collateral coin using open_position_v3 (Pyth Pro + Stork).
+   */
+  public async openPositionWithCoinV3(
+    collateralToken: string,
+    indexToken: string,
+    size: bigint,
+    coinObj: TransactionObjectArgument,
+    long: boolean,
+    reserveAmount: bigint,
+    indexPrice: number,
+    collateralPrice: number,
+    pythProUpdateBytes: Uint8Array | number[],
+    isLimitOrder?: boolean,
+    isIocOrder?: boolean,
+    pricesSlippage = 0.003,
+    collateralSlippage = 0.5,
+    relayerFee = BigInt(0.5),
+    referralAddress?: string,
+    sender?: string,
+    tx?: Transaction,
+    sponsoredTx?: boolean,
+  ): Promise<Transaction> {
+    if (!tx) {
+      tx = new Transaction()
+    }
+    if (referralAddress && !(await this.dataAPI.hasReferral(sender || ''))) {
+      tx = await this.addReferral(referralAddress, tx)
+    }
+
+    const symbol = joinSymbol(long ? 'long' : 'short', indexToken)
+    const adjustPrice = this.processSlippage(indexPrice, long, isLimitOrder ? 0 : pricesSlippage)
+    const adjustCollateralPrice = this.processSlippage(collateralPrice, false, collateralSlippage)
+    const indexPriceThreshold = this.processPriceThreshold(indexPrice, pricesSlippage)
+
+    let allowTrade = ALLOW_TRADE_MUST_TRADE
+    if (isLimitOrder) {
+      allowTrade = isIocOrder ? ALLOW_TRADE_NO_TRADE : ALLOW_TRADE_CAN_TRADE
+    }
+
+    const { tx: tx_, oracle } = await this.initV3OracleForTokens(
+      [collateralToken, indexToken],
+      tx,
+      pythProUpdateBytes,
+    )
+    tx = tx_
+
+    const [feeObject] = tx.splitCoins(coinObj, [tx.pure.u64(relayerFee)])
+
+    tx.moveCall({
+      target: `${this.consts.zoCore.upgradedPackage}::market::open_position_v3`,
+      typeArguments: this.positionTypeArgs(collateralToken, indexToken, long),
+      arguments: [
+        tx.object(SUI_CLOCK_OBJECT_ID),
+        tx.object(this.consts.zoCore.market),
+        tx.object(this.consts.zoCore.symbols[symbol].positionConfig),
+        ...oracleArgsStandard(oracle),
+        coinObj,
+        feeObject,
+        tx.pure.u8(allowTrade),
+        tx.pure.u64(size),
+        tx.pure.u64(reserveAmount),
+        tx.pure.u256(adjustCollateralPrice),
+        tx.pure.u256(adjustPrice),
+        tx.pure.u256(indexPriceThreshold),
+      ],
+    })
+
+    return tx
+  }
+
+  /**
+   * Opens a position with a pre-composed collateral coin and S Card using open_position_with_scard_v3.
+   */
+  public async openPositionWithCoinAndSCardV3(
+    collateralToken: string,
+    indexToken: string,
+    size: bigint,
+    coinObj: TransactionObjectArgument,
+    long: boolean,
+    reserveAmount: bigint,
+    indexPrice: number,
+    collateralPrice: number,
+    kioskClient: KioskClient,
+    kioskCap: KioskOwnerCap,
+    scard: string,
+    pythProUpdateBytes: Uint8Array | number[],
+    isLimitOrder?: boolean,
+    isIocOrder?: boolean,
+    pricesSlippage = 0.003,
+    collateralSlippage = 0.5,
+    relayerFee = BigInt(0.5),
+    referralAddress?: string,
+    sender?: string,
+    tx?: Transaction,
+    sponsoredTx?: boolean,
+  ): Promise<Transaction> {
+    if (!tx) {
+      tx = new Transaction()
+    }
+    if (referralAddress && !(await this.dataAPI.hasReferral(sender || ''))) {
+      tx = await this.addReferral(referralAddress, tx)
+    }
+
+    const symbol = joinSymbol(long ? 'long' : 'short', indexToken)
+    const adjustPrice = this.processSlippage(indexPrice, long, isLimitOrder ? 0 : pricesSlippage)
+    const adjustCollateralPrice = this.processSlippage(collateralPrice, false, collateralSlippage)
+    const indexPriceThreshold = this.processPriceThreshold(indexPrice, pricesSlippage)
+
+    let allowTrade = ALLOW_TRADE_MUST_TRADE
+    if (isLimitOrder) {
+      allowTrade = isIocOrder ? ALLOW_TRADE_NO_TRADE : ALLOW_TRADE_CAN_TRADE
+    }
+
+    const kioskTx = new KioskTransaction({
+      transaction: tx,
+      kioskClient,
+      cap: kioskCap,
+    })
+
+    const [sudoCard, promise] = kioskTx.borrow({
+      itemType: `0xe7e651e4974fe367aa2837712d68081efb299c470242a15e2b9c26ea326159ec::card::SudoCard`,
+      itemId: scard,
+    })
+
+    const { tx: tx_, oracle } = await this.initV3OracleForTokens(
+      [collateralToken, indexToken],
+      tx,
+      pythProUpdateBytes,
+    )
+    tx = tx_
+
+    const [feeObject] = tx.splitCoins(coinObj, [tx.pure.u64(relayerFee)])
+
+    tx.moveCall({
+      target: `${this.consts.zoCore.upgradedPackage}::market::open_position_with_scard_v3`,
+      typeArguments: this.positionTypeArgs(collateralToken, indexToken, long),
+      arguments: [
+        tx.object(SUI_CLOCK_OBJECT_ID),
+        tx.object(this.consts.zoCore.market),
+        tx.object(this.consts.zoCore.symbols[symbol].positionConfig),
+        ...oracleArgsStandard(oracle),
+        coinObj,
+        feeObject,
+        tx.pure.u8(allowTrade),
+        tx.pure.u64(size),
+        tx.pure.u64(reserveAmount),
+        tx.pure.u256(adjustCollateralPrice),
+        tx.pure.u256(adjustPrice),
+        tx.pure.u256(indexPriceThreshold),
+        sudoCard,
+      ],
+    })
+
+    kioskTx
+      .return({
+        itemType: `0xe7e651e4974fe367aa2837712d68081efb299c470242a15e2b9c26ea326159ec::card::SudoCard`,
+        item: sudoCard,
+        promise,
+      })
+      .finalize()
+
+    return tx
+  }
+
   /**
    * Decreases a position using decrease_position_v3.
    */
@@ -3107,6 +3272,8 @@ export class USDZAPI extends BaseAPI implements IUSDZAPI {
       pythProUpdateBytes,
     )
 
+    const symbol = joinSymbol(long ? 'long' : 'short', indexToken)
+
     tx_.moveCall({
       target: `${this.consts.zoCore.upgradedPackage}::market::redeem_from_position_v2`,
       typeArguments: this.redeemTypeArgs(collateralToken, indexToken, long),
@@ -3114,6 +3281,8 @@ export class USDZAPI extends BaseAPI implements IUSDZAPI {
         tx_.object(SUI_CLOCK_OBJECT_ID),
         tx_.object(this.consts.zoCore.market),
         tx_.object(pcpId),
+        tx_.object(this.consts.zoCore.vaults[collateralToken].reservingFeeModel),
+        tx_.object(this.consts.zoCore.symbols[symbol].fundingFeeModel),
         ...oracleArgsStandard(oracle),
         tx_.pure.u64(amount),
       ],

package/src/implementations/ZBTCVCAPI.ts

@@ -1107,13 +1107,12 @@ export class ZBTCVCAPI extends BaseAPI implements IZBTCVCAPI {
     }
 
     // Process coin splitting
-    const [depositObject] = this.processCoinSplitting(
+    const depositObject = await this.resolveSplitCoinObject(
       tx,
       collateralToken,
+      BigInt(amount),
       coinObjects,
-      [tx.pure.u64(amount)],
-      sponsoredTx,
-      suiCoinObject,
+      { sponsoredTx, suiCoinObject, sender },
     )
 
     tx.moveCall({
@@ -1126,6 +1125,8 @@ export class ZBTCVCAPI extends BaseAPI implements IZBTCVCAPI {
       ],
       arguments: [tx.object(this.consts.zoCore.market), tx.object(pcpId), depositObject],
     })
+
+    this.returnUnusedSuiCoin(tx, suiCoinObject, sender)
     return tx
   }
 
@@ -1174,6 +1175,7 @@ export class ZBTCVCAPI extends BaseAPI implements IZBTCVCAPI {
       ],
     })
 
+    this.returnUnusedSuiCoin(tx, suiCoinObject, sender)
     return tx
   }
 

package/src/implementations/ZLPAPI.ts

@@ -2392,14 +2392,12 @@ export class ZLPAPI extends BaseAPI implements IZLPAPI {
       tx = (await this.initOracleTxb([collateralToken, indexToken], tx)).tx
     }
 
-    // Process coin splitting
-    const [depositObject] = this.processCoinSplitting(
+    const depositObject = await this.resolveSplitCoinObject(
       tx,
       collateralToken,
+      BigInt(amount),
       coinObjects,
-      [tx.pure.u64(amount)],
-      sponsoredTx,
-      suiCoinObject,
+      { sponsoredTx, suiCoinObject, sender },
     )
 
     tx.moveCall({
@@ -2412,6 +2410,8 @@ export class ZLPAPI extends BaseAPI implements IZLPAPI {
       ],
       arguments: [tx.object(this.consts.zoCore.market), tx.object(pcpId), depositObject],
     })
+
+    this.returnUnusedSuiCoin(tx, suiCoinObject, sender)
     return tx
   }
 
@@ -2460,6 +2460,7 @@ export class ZLPAPI extends BaseAPI implements IZLPAPI {
       ],
     })
 
+    this.returnUnusedSuiCoin(tx, suiCoinObject, sender)
     return tx
   }
 

package/src/interfaces/base.ts

@@ -584,6 +584,7 @@ export interface IBaseAPI {
     amount: number,
     long: boolean,
     sponsoredTx?: boolean,
+    sender?: string,
   ) => Promise<Transaction>
 
   cancelOrder: (

package/src/interfaces/usdz.ts

@@ -271,6 +271,51 @@ export interface IUSDZAPI extends IBaseAPI {
     sponsoredTx?: boolean,
   ) => Promise<Transaction>
 
+  openPositionWithCoinV3: (
+    collateralToken: string,
+    indexToken: string,
+    size: bigint,
+    coinObj: import('@mysten/sui/transactions').TransactionObjectArgument,
+    long: boolean,
+    reserveAmount: bigint,
+    indexPrice: number,
+    collateralPrice: number,
+    pythProUpdateBytes: Uint8Array | number[],
+    isLimitOrder?: boolean,
+    isIocOrder?: boolean,
+    pricesSlippage?: number,
+    collateralSlippage?: number,
+    relayerFee?: bigint,
+    referralAddress?: string,
+    sender?: string,
+    tx?: import('@mysten/sui/transactions').Transaction,
+    sponsoredTx?: boolean,
+  ) => Promise<Transaction>
+
+  openPositionWithCoinAndSCardV3: (
+    collateralToken: string,
+    indexToken: string,
+    size: bigint,
+    coinObj: import('@mysten/sui/transactions').TransactionObjectArgument,
+    long: boolean,
+    reserveAmount: bigint,
+    indexPrice: number,
+    collateralPrice: number,
+    kioskClient: import('@mysten/kiosk').KioskClient,
+    kioskCap: import('@mysten/kiosk').KioskOwnerCap,
+    scard: string,
+    pythProUpdateBytes: Uint8Array | number[],
+    isLimitOrder?: boolean,
+    isIocOrder?: boolean,
+    pricesSlippage?: number,
+    collateralSlippage?: number,
+    relayerFee?: bigint,
+    referralAddress?: string,
+    sender?: string,
+    tx?: import('@mysten/sui/transactions').Transaction,
+    sponsoredTx?: boolean,
+  ) => Promise<Transaction>
+
   decreasePositionV3: (
     pcpId: string,
     collateralToken: string,

package/src/oraclePro.ts

@@ -203,11 +203,6 @@ export function oracleArgsStandard(oracle: OracleInputs): TransactionObjectArgum
   return [oracle.pythProUpdate, oracle.storkState, oracle.oracleRegistry]
 }
 
-/** `[pythProUpdate, storkState, oracleRegistry, clock]` — for public fns that take clock after oracle args. */
-export function oracleArgsWithClock(oracle: OracleInputs): TransactionObjectArgument[] {
-  return [...oracleArgsStandard(oracle), oracle.clock]
-}
-
 export function oracleArgsAlt(oracle: OracleInputsAlt): TransactionObjectArgument[] {
   return [oracle.oracleRegistry, oracle.storkState, oracle.pythProUpdate]
 }
@@ -259,7 +254,8 @@ export function valuateVaultsV2(params: IValuateVaultsV2Params): TransactionObje
       arguments: [
         tx.object(market),
         tx.object(vault.reservingFeeModel),
-        ...oracleArgsWithClock(oracle),
+        ...oracleArgsStandard(oracle),
+        oracle.clock,
         vaultsValuation,
       ],
     })
@@ -302,7 +298,8 @@ export function valuateSymbolsV2(params: IValuateSymbolsV2Params): TransactionOb
       arguments: [
         tx.object(market),
         tx.object(symbol.fundingFeeModel),
-        ...oracleArgsWithClock(oracle),
+        ...oracleArgsStandard(oracle),
+        oracle.clock,
         symbolsValuation,
       ],
     })