@zofai/zo-sdk 0.2.9 → 0.2.11

package/src/api.ts

@@ -2,7 +2,6 @@
 /* eslint-disable class-methods-use-this */
 import type { KioskClient, KioskOwnerCap } from '@mysten/kiosk'
 import { KioskTransaction } from '@mysten/kiosk'
-import type { SuiClient } from '@mysten/sui/client'
 import { Transaction } from '@mysten/sui/transactions'
 import { SUI_CLOCK_OBJECT_ID } from '@mysten/sui/utils'
 
@@ -10,6 +9,7 @@ import type { Network } from './consts'
 import { ALLOW_TRADE_CAN_TRADE, ALLOW_TRADE_MUST_TRADE, ALLOW_TRADE_NO_TRADE } from './consts'
 import type { ICredential } from './data'
 import { DataAPI } from './data'
+import type { SuiClient } from './suiClient'
 import { joinSymbol } from './utils'
 
 export class API extends DataAPI {
@@ -64,7 +64,7 @@ export class API extends DataAPI {
     sender = '',
   ) => {
     let tx = new Transaction()
-    tx = await this.initOracleTxb(Object.keys(this.consts.pythFeeder.feeder), tx)
+    tx = (await this.initOracleTxb(Object.keys(this.consts.pythFeeder.feeder), tx)).tx
     if (referralAddress && !(await this.hasReferral(sender || ''))) {
       tx = await this.addReferral(referralAddress, tx)
     }
@@ -90,7 +90,7 @@ export class API extends DataAPI {
   }
 
   withdraw = async (coin: string, zlpCoinObjects: string[], amount: number, minAmountOut = 0) => {
-    const tx = await this.initOracleTxb(Object.keys(this.consts.pythFeeder.feeder))
+    const { tx } = await this.initOracleTxb(Object.keys(this.consts.pythFeeder.feeder))
     const zlpCoinObject = this.#processCoins(tx, 'zlp', zlpCoinObjects)
     const [withdrawObject] = tx.splitCoins(zlpCoinObject, [tx.pure.u64(amount)])
 
@@ -133,7 +133,7 @@ export class API extends DataAPI {
     if (referralAddress && !(await this.hasReferral(sender || ''))) {
       tx = await this.addReferral(referralAddress, tx)
     }
-    tx = await this.initOracleTxb([collateralToken, indexToken], tx)
+    tx = (await this.initOracleTxb([collateralToken, indexToken], tx)).tx
     const coinObject = this.#processCoins(tx, collateralToken, coinObjects)
     const [depositObject, feeObject] = tx.splitCoins(coinObject, [
       tx.pure.u64(collateralAmount),
@@ -203,7 +203,7 @@ export class API extends DataAPI {
     if (referralAddress && !(await this.hasReferral(sender || ''))) {
       tx = await this.addReferral(referralAddress, tx)
     }
-    tx = await this.initOracleTxb([collateralToken, indexToken], tx)
+    tx = (await this.initOracleTxb([collateralToken, indexToken], tx)).tx
     const coinObject = this.#processCoins(tx, collateralToken, coinObjects)
     const [depositObject, feeObject] = tx.splitCoins(coinObject, [
       tx.pure.u64(collateralAmount),
@@ -276,7 +276,7 @@ export class API extends DataAPI {
     coinObjects: string[],
     long: boolean,
   ) => {
-    const tx = await this.initOracleTxb([collateralToken, indexToken])
+    const { tx } = await this.initOracleTxb([collateralToken, indexToken])
     const coinObject = this.#processCoins(tx, collateralToken, coinObjects)
     const [depositObject] = tx.splitCoins(coinObject, [tx.pure.u64(amount)])
 
@@ -300,7 +300,7 @@ export class API extends DataAPI {
     amount: number,
     long: boolean,
   ) => {
-    const tx = await this.initOracleTxb([collateralToken, indexToken])
+    const { tx } = await this.initOracleTxb([collateralToken, indexToken])
     const symbol = joinSymbol(long ? 'long' : 'short', indexToken)
 
     tx.moveCall({
@@ -342,7 +342,7 @@ export class API extends DataAPI {
     collateralSlippage = 0.5,
     relayerFee = BigInt(0.5),
   ) => {
-    const tx = await this.initOracleTxb([collateralToken, indexToken])
+    const { tx } = await this.initOracleTxb([collateralToken, indexToken])
     const symbol = joinSymbol(long ? 'long' : 'short', indexToken)
     const coinObject = this.#processCoins(tx, collateralToken, coinObjects)
     const feeObject = tx.splitCoins(coinObject, [tx.pure.u64(relayerFee)])
@@ -358,7 +358,6 @@ export class API extends DataAPI {
       isTakeProfitOrder = true
     }
 
-
     tx.moveCall({
       target: `${this.consts.zoCore.upgradedPackage}::market::decrease_position`,
       typeArguments: [
@@ -407,7 +406,7 @@ export class API extends DataAPI {
     collateralSlippage = 0.5,
     relayerFee = BigInt(0.5),
   ) => {
-    const tx = await this.initOracleTxb([collateralToken, indexToken])
+    const { tx } = await this.initOracleTxb([collateralToken, indexToken])
 
     const kioskTx = new KioskTransaction({
       transaction: tx,
@@ -435,7 +434,6 @@ export class API extends DataAPI {
       isTakeProfitOrder = true
     }
 
-
     tx.moveCall({
       target: `${this.consts.zoCore.upgradedPackage}::market::decrease_position_with_scard`,
       typeArguments: [
@@ -491,7 +489,7 @@ export class API extends DataAPI {
     if (!tx) {
       tx = new Transaction()
     }
-    tx = await this.initOracleTxb(positions.flatMap(position => [position.collateralToken, position.indexToken]), tx)
+    tx = (await this.initOracleTxb(positions.flatMap(position => [position.collateralToken, position.indexToken]), tx)).tx
 
     for (const position of positions) {
       const {
@@ -525,7 +523,6 @@ export class API extends DataAPI {
         innerIsTakeProfitOrder = true
       }
 
-
       tx.moveCall({
         target: `${this.consts.zoCore.upgradedPackage}::market::decrease_position`,
         typeArguments: [
@@ -573,7 +570,7 @@ export class API extends DataAPI {
     if (!tx) {
       tx = new Transaction()
     }
-    tx = await this.initOracleTxb(positions.flatMap(position => [position.collateralToken, position.indexToken]), tx)
+    tx = (await this.initOracleTxb(positions.flatMap(position => [position.collateralToken, position.indexToken]), tx)).tx
 
     const kioskTx = new KioskTransaction({
       transaction: tx,
@@ -618,7 +615,6 @@ export class API extends DataAPI {
         innerIsTakeProfitOrder = true
       }
 
-
       tx.moveCall({
         target: `${this.consts.zoCore.upgradedPackage}::market::decrease_position_with_scard`,
         typeArguments: [
@@ -748,7 +744,7 @@ export class API extends DataAPI {
     fromAmount: bigint,
     fromCoinObjects: string[],
   ) => {
-    const tx = await this.initOracleTxb(Object.keys(this.consts.zoCore.vaults))
+    const { tx } = await this.initOracleTxb(Object.keys(this.consts.zoCore.vaults))
     const fromCoinObject = this.#processCoins(tx, fromToken, fromCoinObjects)
     const [fromDepositObject] = tx.splitCoins(fromCoinObject, [tx.pure.u64(fromAmount)])
     const vaultsValuation = this.valuateVaults(tx)
@@ -901,7 +897,7 @@ export class API extends DataAPI {
 
   // admin methods
   adminUpdatePriceFeed = async (collateralToken: string, indexToken: string) => {
-    const tx = await this.initOracleTxb([collateralToken, indexToken])
+    const { tx } = await this.initOracleTxb([collateralToken, indexToken])
     return tx
   }
 

package/src/coins.ts

@@ -0,0 +1,116 @@
+import type { Transaction, TransactionObjectArgument } from '@mysten/sui/transactions'
+import { coinWithBalance } from '@mysten/sui/transactions'
+import { SUI_TYPE_ARG } from '@mysten/sui/utils'
+
+import type { SuiClient } from './suiClient'
+
+/**
+ * Sui wallets can hold funds in two places for the same coin type:
+ * - coin objects (what getCoins returns)
+ * - address balance (funds held at the address until redeemed in a tx)
+ */
+export interface ICoinBalanceBreakdown {
+  coinType: string
+  totalBalance: bigint
+  coinObjectBalance: bigint
+  addressBalance: bigint
+}
+
+export interface ICoinFundingOptions {
+  /** bigint values matching each split in processCoinSplitting (sum = total spend). */
+  splitAmounts?: bigint[]
+  /** Use coinWithBalance (redeems address balance and/or merges coin objects). */
+  useAddressBalance?: boolean
+}
+
+export function sumSplitAmounts(amounts: bigint[]): bigint {
+  return amounts.reduce((total, amount) => total + amount, 0n)
+}
+
+export async function getCoinBalanceBreakdown(
+  provider: SuiClient,
+  owner: string,
+  coinType: string,
+): Promise<ICoinBalanceBreakdown> {
+  const balance = await provider.getBalance({ owner, coinType })
+  const totalBalance = BigInt(balance.totalBalance)
+
+  const extended = balance as { coinBalance?: string, addressBalance?: string }
+  if (extended.coinBalance !== undefined && extended.addressBalance !== undefined) {
+    return {
+      coinType: balance.coinType,
+      totalBalance,
+      coinObjectBalance: BigInt(extended.coinBalance),
+      addressBalance: BigInt(extended.addressBalance),
+    }
+  }
+
+  let coinObjectBalance = 0n
+  let cursor: string | null | undefined = null
+  do {
+    const page = await provider.getCoins({ owner, coinType, cursor })
+    for (const coin of page.data) {
+      coinObjectBalance += BigInt(coin.balance)
+    }
+    cursor = page.hasNextPage ? page.nextCursor : null
+  } while (cursor)
+
+  const addressBalance = totalBalance > coinObjectBalance ? totalBalance - coinObjectBalance : 0n
+
+  return {
+    coinType: balance.coinType,
+    totalBalance,
+    coinObjectBalance,
+    addressBalance,
+  }
+}
+
+/**
+ * Prefer coinWithBalance when the wallet has address balance and/or coin objects alone
+ * cannot cover `amount`. processCoins / processCoinSplitting only spend explicit object IDs otherwise.
+ */
+export function needsCoinWithBalanceFunding(
+  breakdown: ICoinBalanceBreakdown,
+  amount: bigint,
+): boolean {
+  if (breakdown.totalBalance < amount) {
+    return false
+  }
+  if (breakdown.addressBalance > 0n) {
+    return true
+  }
+  return breakdown.coinObjectBalance < amount
+}
+
+/**
+ * Creates a spendable Coin<T> inside an open transaction.
+ * At build time Mysten resolves this via coin::redeem_funds (address balance) and/or merging coin objects.
+ */
+export function createSpendableCoin(
+  tx: Transaction,
+  coinType: string,
+  amount: bigint,
+  useGasCoin = false,
+): TransactionObjectArgument {
+  return coinWithBalance({ balance: amount, type: coinType, useGasCoin })(tx)
+}
+
+/**
+ * Resolves a spendable SUI coin for sponsored transactions.
+ * Uses coinWithBalance so address balance and coin objects are both supported.
+ */
+export async function resolveSpendableSuiCoin(
+  tx: Transaction,
+  provider: SuiClient,
+  sender: string,
+  amount: bigint,
+): Promise<TransactionObjectArgument> {
+  const breakdown = await getCoinBalanceBreakdown(provider, sender, SUI_TYPE_ARG)
+  if (breakdown.totalBalance < amount) {
+    throw new Error(
+      `Insufficient SUI balance: need ${amount} MIST, have ${breakdown.totalBalance} MIST `
+      + `(coin objects: ${breakdown.coinObjectBalance}, address balance: ${breakdown.addressBalance})`,
+    )
+  }
+  return createSpendableCoin(tx, SUI_TYPE_ARG, amount, false)
+}

package/src/data.ts

@@ -1,6 +1,6 @@
 /* eslint-disable class-methods-use-this */
 
-import type { DynamicFieldInfo, SuiClient } from '@mysten/sui/client'
+import type { DynamicFieldInfo, SuiClient } from './suiClient'
 import type { Transaction } from '@mysten/sui/transactions'
 import { SUI_CLOCK_OBJECT_ID } from '@mysten/sui/utils'
 

package/src/factory/SDKFactory.ts

@@ -4,7 +4,7 @@
  * This is the main entry point for the re-architected SDK system
  */
 
-import type { SuiClient } from '@mysten/sui/client'
+import type { SuiClient } from '../suiClient'
 
 import type { LPToken, Network } from '../consts'
 import { LPToken as LPTokenEnum } from '../consts'