@zofai/zo-sdk 0.2.8 → 0.2.10

package/src/index.ts

@@ -24,6 +24,7 @@ export * from './interfaces'
 // Export legacy components for backward compatibility
 export * from './api'
 export * from './bcs'
+export * from './coins'
 export * from './consts'
 export * from './data'
 export * from './oracle'

package/src/interfaces/base.ts

@@ -9,6 +9,7 @@ import type { Transaction, TransactionObjectArgument } from '@mysten/sui/transac
 import type { PriceFeed } from '@pythnetwork/pyth-sui-js'
 
 import type { IConsts, LPToken, Network } from '../consts'
+import type { IInitOracleTxbResult } from '../oracle'
 
 // Common data interfaces
 export interface IBaseMarketValuationInfo {
@@ -293,7 +294,12 @@ export interface IBaseDataAPI {
   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>
+  initOracleTxb: (
+    tokens: string[],
+    tx?: Transaction,
+    sponsoredTx?: boolean,
+    sponsorOptions?: { sender: string, additionalSuiAmount?: bigint },
+  ) => Promise<IInitOracleTxbResult>
 
   // Utility methods
   validateCache: () => void
@@ -309,7 +315,6 @@ export interface IBaseAPI {
     referralAddress?: string,
     sender?: string,
     sponsoredTx?: boolean,
-    suiCoinObjectsForPythUpdate?: string[],
   ) => Promise<Transaction>
 
   withdraw: (
@@ -318,7 +323,6 @@ export interface IBaseAPI {
     amount: number,
     minAmountOut?: number,
     sponsoredTx?: boolean,
-    suiCoinObjectsForPythUpdate?: string[],
   ) => Promise<Transaction>
 
   swap: (
@@ -362,7 +366,6 @@ export interface IBaseAPI {
     referralAddress?: string,
     sender?: string,
     sponsoredTx?: boolean,
-    suiCoinObjectsForPythUpdate?: string[],
   ) => Promise<Transaction>
 
   // Trading operations
@@ -384,7 +387,6 @@ export interface IBaseAPI {
     sender?: string,
     tx?: Transaction,
     sponsoredTx?: boolean,
-    suiCoinObjectsForPythUpdate?: string[],
   ) => Promise<Transaction>
 
   decreasePosition: (
@@ -403,7 +405,7 @@ export interface IBaseAPI {
     relayerFee?: bigint,
     coinObjects?: string[],
     sponsoredTx?: boolean,
-    suiCoinObjectsForPythUpdate?: string[],
+    sender?: string,
   ) => Promise<Transaction>
 
   decreaseMultiPositions: (
@@ -425,7 +427,7 @@ export interface IBaseAPI {
     }>,
     tx?: Transaction,
     sponsoredTx?: boolean,
-    suiCoinObjectsForPythUpdate?: string[],
+    sender?: string,
   ) => Promise<Transaction>
 
   openPositionV2?: (
@@ -446,7 +448,6 @@ export interface IBaseAPI {
     referralAddress?: string,
     sender?: string,
     sponsoredTx?: boolean,
-    suiCoinObjectsForPythUpdate?: string[],
   ) => Promise<Transaction>
 
   // Trading operations
@@ -468,7 +469,6 @@ export interface IBaseAPI {
     sender?: string,
     tx?: Transaction,
     sponsoredTx?: boolean,
-    suiCoinObjectsForPythUpdate?: string[],
   ) => Promise<Transaction>
 
   decreasePositionV2?: (
@@ -487,7 +487,7 @@ export interface IBaseAPI {
     relayerFee?: bigint,
     coinObjects?: string[],
     sponsoredTx?: boolean,
-    suiCoinObjectsForPythUpdate?: string[],
+    sender?: string,
   ) => Promise<Transaction>
 
   decreaseMultiPositionsV2?: (
@@ -509,7 +509,7 @@ export interface IBaseAPI {
     }>,
     tx?: Transaction,
     sponsoredTx?: boolean,
-    suiCoinObjectsForPythUpdate?: string[],
+    sender?: string,
     feeObjects?: TransactionObjectArgument[],
   ) => Promise<Transaction>
 
@@ -521,7 +521,7 @@ export interface IBaseAPI {
     coinObjects: string[],
     long: boolean,
     sponsoredTx?: boolean,
-    suiCoinObjectsForPythUpdate?: string[],
+    sender?: string,
   ) => Promise<Transaction>
 
   redeemFromPosition: (
@@ -531,7 +531,6 @@ export interface IBaseAPI {
     amount: number,
     long: boolean,
     sponsoredTx?: boolean,
-    suiCoinObjectsForPythUpdate?: string[],
   ) => Promise<Transaction>
 
   cancelOrder: (
@@ -621,7 +620,6 @@ export interface IBaseAPI {
     referralAddress?: string,
     sender?: string,
     sponsoredTx?: boolean,
-    suiCoinObjectsForPythUpdate?: string[],
   ) => Promise<Transaction>
 
   // S Card operations
@@ -646,7 +644,6 @@ export interface IBaseAPI {
     sender?: string,
     tx?: Transaction,
     sponsoredTx?: boolean,
-    suiCoinObjectsForPythUpdate?: string[],
   ) => Promise<Transaction>
 
   decreasePositionWithSCard: (
@@ -668,7 +665,6 @@ export interface IBaseAPI {
     relayerFee?: bigint,
     coinObjects?: string[],
     sponsoredTx?: boolean,
-    suiCoinObjectsForPythUpdate?: string[],
   ) => Promise<Transaction>
 
   decreaseMultiPositionsWithSCard: (
@@ -693,7 +689,6 @@ export interface IBaseAPI {
     scard: string,
     tx?: Transaction,
     sponsoredTx?: boolean,
-    suiCoinObjectsForPythUpdate?: string[],
   ) => Promise<Transaction>
 
   openPositionWithSCardV2?: (
@@ -717,7 +712,6 @@ export interface IBaseAPI {
     referralAddress?: string,
     sender?: string,
     sponsoredTx?: boolean,
-    suiCoinObjectsForPythUpdate?: string[],
   ) => Promise<Transaction>
 
   // S Card operations
@@ -742,7 +736,6 @@ export interface IBaseAPI {
     sender?: string,
     tx?: Transaction,
     sponsoredTx?: boolean,
-    suiCoinObjectsForPythUpdate?: string[],
   ) => Promise<Transaction>
 
   decreasePositionWithSCardV2?: (
@@ -764,7 +757,6 @@ export interface IBaseAPI {
     relayerFee?: bigint,
     coinObjects?: string[],
     sponsoredTx?: boolean,
-    suiCoinObjectsForPythUpdate?: string[],
   ) => Promise<Transaction>
 
   decreaseMultiPositionsWithSCardV2?: (
@@ -789,7 +781,7 @@ export interface IBaseAPI {
     scard: string,
     tx?: Transaction,
     sponsoredTx?: boolean,
-    suiCoinObjectsForPythUpdate?: string[],
+    sender?: string,
     feeObjects?: TransactionObjectArgument[],
   ) => Promise<Transaction>
 

package/src/interfaces/slp.ts

@@ -239,7 +239,6 @@ export interface ISLPAPI extends IBaseAPI {
     sender?: string,
     tx?: Transaction,
     sponsoredTx?: boolean,
-    suiCoinObjectsForPythUpdate?: string[],
   ) => Promise<TransactionObjectArgument>
 
   withdrawLpCoinObject: (

package/src/interfaces/usdz.ts

@@ -152,7 +152,6 @@ export interface IUSDZAPI extends IBaseAPI {
     sender?: string,
     tx?: Transaction,
     sponsoredTx?: boolean,
-    suiCoinObjectsForPythUpdate?: string[],
   ) => Promise<TransactionObjectArgument>
 
   withdrawLpCoinObject: (

package/src/interfaces/zbtcvc.ts

@@ -105,7 +105,6 @@ export interface IZBTCVCAPI extends IBaseAPI {
     sender?: string,
     tx?: Transaction,
     sponsoredTx?: boolean,
-    suiCoinObjectsForPythUpdate?: string[],
   ) => Promise<TransactionObjectArgument>
 
   stakeCoinObject: (

package/src/interfaces/zlp.ts

@@ -215,7 +215,6 @@ export interface IZLPAPI extends IBaseAPI {
     sender?: string,
     tx?: Transaction,
     sponsoredTx?: boolean,
-    suiCoinObjectsForPythUpdate?: string[],
   ) => Promise<TransactionObjectArgument>
 
   stakeCoinObject: (

package/src/oracle.ts

@@ -1,12 +1,26 @@
 import type { SuiClient } from '@mysten/sui/client'
+import type { TransactionObjectArgument } from '@mysten/sui/transactions'
 import { Transaction } from '@mysten/sui/transactions'
 import type { PriceFeed } from '@pythnetwork/pyth-sui-js'
 import { SuiPriceServiceConnection, SuiPythClient } from '@pythnetwork/pyth-sui-js'
 
+import { resolveSpendableSuiCoin } from './coins'
 import type { IConsts, Network } from './consts'
 import { getConsts, getPriceIdToPythFeeder, getPythFeederToId, getPythFeederToPriceId, getSharedConfig, LPToken } from './consts'
 import { createJsonRpcProvider } from './utils'
 
+export interface IInitOracleSponsorOptions {
+  sender: string
+  /** SUI (MIST) needed beyond Pyth update fees, e.g. SUI collateral deposit + relayer fee. */
+  additionalSuiAmount?: bigint
+}
+
+export interface IInitOracleTxbResult {
+  tx: Transaction
+  /** Remaining SUI coin after Pyth fee splits; present when sponsored and SUI was resolved. */
+  suiCoinObject?: TransactionObjectArgument
+}
+
 export class OracleAPI {
   network: Network
   consts: IConsts
@@ -90,39 +104,47 @@ export class OracleAPI {
     }
   }
 
-  async initOracleTxb(
-    tokens: string[],
-    tx?: Transaction,
-    sponsoredTx?: boolean,
-    suiCoinObject?: any,
-  ) {
-    let tx_ = tx
-    if (!tx_) {
-      tx_ = new Transaction()
-    }
-    // Remove redundant tokens first
+  async getStalePriceFeedIds(tokens: string[]): Promise<string[]> {
     const uniqueTokens = Array.from(new Set(tokens))
-
-    const connection = new SuiPriceServiceConnection(this.connectionURL, {
-      priceFeedRequestConfig: {
-        binary: true,
-      },
-    })
     let pythObjectIds = uniqueTokens.map(token => this.consts.pythFeeder.feeder[token])
-    // remove dupe object ids. If any of the object ids are duplicates the call will fail
     pythObjectIds = [...new Set(pythObjectIds)].filter(Boolean)
-    const needUpdateObjectIds = (await this.provider.multiGetObjects({
+
+    const objects = await this.provider.multiGetObjects({
       ids: pythObjectIds,
-      options: {
-        showContent: true,
-      },
-    })).map(pythObject => [
+      options: { showContent: true },
+    })
+
+    return objects.map(pythObject => [
       Number.parseInt((pythObject.data?.content as any).fields.price_info.fields.arrival_time || 0, 10) - Date.now() / 1000,
       pythObject.data?.objectId,
     ]).filter((x: any) => Math.abs(x[0]) >= 0).map(x => x[1] as string)
+  }
+
+  async initOracleTxb(
+    tokens: string[],
+    tx?: Transaction,
+    sponsoredTx?: boolean,
+    sponsorOptions?: IInitOracleSponsorOptions,
+  ): Promise<IInitOracleTxbResult> {
+    const tx_ = tx ?? new Transaction()
+
+    const connection = new SuiPriceServiceConnection(this.connectionURL, {
+      priceFeedRequestConfig: { binary: true },
+    })
+
+    const needUpdateObjectIds = await this.getStalePriceFeedIds(tokens)
 
     if (needUpdateObjectIds.length === 0) {
-      return tx_
+      if (sponsoredTx && sponsorOptions && (sponsorOptions.additionalSuiAmount ?? 0n) > 0n) {
+        const suiCoinObject = await resolveSpendableSuiCoin(
+          tx_,
+          this.provider,
+          sponsorOptions.sender,
+          sponsorOptions.additionalSuiAmount!,
+        )
+        return { tx: tx_, suiCoinObject }
+      }
+      return { tx: tx_ }
     }
 
     const priceFeedIds = needUpdateObjectIds
@@ -133,18 +155,32 @@ export class OracleAPI {
     const priceUpdateData = await connection.getPriceFeedsUpdateData(priceFeedIds)
 
     if (sponsoredTx) {
+      if (!sponsorOptions?.sender) {
+        throw new Error('sender is required for sponsored transactions that update Pyth price feeds')
+      }
+
       const baseUpdateFee = await this.getBaseUpdateFee()
+      const pythCost = BigInt(baseUpdateFee) * BigInt(priceFeedIds.length)
+      const totalSui = pythCost + (sponsorOptions.additionalSuiAmount ?? 0n)
+
+      const suiCoinObject = await resolveSpendableSuiCoin(
+        tx_,
+        this.provider,
+        sponsorOptions.sender,
+        totalSui,
+      )
+
       const pythUpdateCoins = tx_.splitCoins(
         suiCoinObject,
         priceFeedIds.map(() => tx_.pure.u64(baseUpdateFee)),
       )
       await this.client.updatePriceFeedsWithCoins(tx_, priceUpdateData, priceFeedIds, pythUpdateCoins)
-    }
-    else {
-      await this.client.updatePriceFeeds(tx_, priceUpdateData, priceFeedIds)
+
+      return { tx: tx_, suiCoinObject }
     }
 
-    return tx_
+    await this.client.updatePriceFeeds(tx_, priceUpdateData, priceFeedIds)
+    return { tx: tx_ }
   }
 
   async getBaseUpdateFee(): Promise<number> {