@scallop-io/sui-scallop-sdk 2.0.4 → 2.0.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scallop-io/sui-scallop-sdk",
-  "version": "2.0.4",
+  "version": "2.0.6",
   "description": "Typescript sdk for interacting with Scallop contract on SUI",
   "keywords": [
     "sui",

package/src/builders/coreBuilder.ts

@@ -359,51 +359,28 @@ const generateCoreQuickMethod: GenerateCoreQuickMethod = ({
     },
     withdrawQuick: async (amount, poolCoinName) => {
       const sender = requireSender(txBlock);
-      const marketCoinName = builder.utils.parseMarketCoinName(poolCoinName);
-
       const sCoinName = builder.utils.parseSCoinName(poolCoinName);
       if (!sCoinName) throw new Error(`No sCoin for ${poolCoinName}`);
 
-      // check if user has sCoin instead of marketCoin
-      const {
-        leftCoin,
-        takeCoin: sCoins,
-        totalAmount,
-      } = await builder.selectSCoin(txBlock, sCoinName, amount, sender);
-      if (totalAmount === 0) {
-        const { leftCoin, takeCoin: walletMarketCoins } =
-          await builder.selectMarketCoin(
-            txBlock,
-            marketCoinName,
-            amount,
-            sender
-          );
-        txBlock.transferObjects([leftCoin], sender);
-        return txBlock.withdraw(walletMarketCoins, poolCoinName);
-      }
-
-      txBlock.transferObjects([leftCoin], sender);
-      const marketCoins = txBlock.burnSCoin(sCoinName, sCoins);
+      // eslint-disable-next-line prefer-const
+      let { sCoin, marketCoin } = await builder.selectSCoinOrMarketCoin(
+        txBlock,
+        sCoinName,
+        amount,
+        sender
+      );
 
-      // check amount
-      amount -= totalAmount;
-      try {
-        if (amount > 0) {
-          // sCoin is not enough, try market coin
-          const { leftCoin, takeCoin: walletMarketCoins } =
-            await builder.selectMarketCoin(
-              txBlock,
-              marketCoinName,
-              amount,
-              sender
-            );
-          txBlock.transferObjects([leftCoin], sender);
-          txBlock.mergeCoins(marketCoins, [walletMarketCoins]);
+      if (sCoin) {
+        const newMarketCoin = txBlock.burnSCoin(sCoinName, sCoin);
+        if (marketCoin) {
+          txBlock.mergeCoins(marketCoin, newMarketCoin);
+        } else {
+          marketCoin = newMarketCoin;
         }
-      } catch (_e) {
-        // ignore
       }
-      return txBlock.withdraw(marketCoins, poolCoinName);
+
+      if (!marketCoin) throw new Error(`No market coin for ${poolCoinName}`);
+      return txBlock.withdraw(marketCoin, poolCoinName);
     },
     borrowQuick: async (amount, poolCoinName, obligationId, obligationKey) => {
       const obligationInfo = await requireObligationInfo(

package/src/builders/sCoinBuilder.ts

@@ -61,7 +61,7 @@ const generateSCoinQuickMethod: GenerateSCoinQuickMethod = ({
       );
 
       txBlock.transferObjects([leftCoin], sender);
-      return await txBlock.mintSCoin(marketCoinName, takeCoin);
+      return txBlock.mintSCoin(marketCoinName, takeCoin);
     },
     burnSCoinQuick: async (sCoinName, amount) => {
       const sender = requireSender(txBlock);
@@ -73,7 +73,7 @@ const generateSCoinQuickMethod: GenerateSCoinQuickMethod = ({
       );
 
       txBlock.transferObjects([leftCoin], sender);
-      return await txBlock.burnSCoin(sCoinName, takeCoin);
+      return txBlock.burnSCoin(sCoinName, takeCoin);
     },
   };
 };

package/src/models/scallopBuilder.ts

@@ -5,7 +5,10 @@ import { ScallopAddress } from './scallopAddress';
 import { ScallopQuery } from './scallopQuery';
 import { ScallopUtils } from './scallopUtils';
 import type { SuiTransactionBlockResponse } from '@mysten/sui/client';
-import type { Transaction } from '@mysten/sui/transactions';
+import type {
+  Transaction,
+  TransactionObjectArgument,
+} from '@mysten/sui/transactions';
 import type {
   SuiAmountsArg,
   SuiTxBlock as SuiKitTxBlock,
@@ -201,6 +204,79 @@ export class ScallopBuilder {
     };
   }
 
+  /**
+   * Select sCoin or market coin automatically. Prioritize sCoin first
+   */
+  public async selectSCoinOrMarketCoin(
+    txBlock: ScallopTxBlock | SuiKitTxBlock,
+    sCoinName: string,
+    amount: number,
+    sender: string = this.walletAddress
+  ) {
+    let totalAmount = amount;
+    const result = {
+      sCoins: [] as TransactionObjectArgument[],
+      marketCoins: [] as TransactionObjectArgument[],
+      leftCoins: [] as TransactionObjectArgument[],
+    };
+    try {
+      // try sCoin first
+      const {
+        leftCoin,
+        takeCoin,
+        totalAmount: sCoinAmount,
+      } = await this.selectSCoin(txBlock, sCoinName, totalAmount, sender);
+      result.leftCoins.push(leftCoin);
+      result.sCoins.push(takeCoin);
+      totalAmount -= sCoinAmount;
+
+      if (totalAmount > 0) {
+        // sCoin is not enough, try market coin
+        const { leftCoin, takeCoin: marketCoin } = await this.selectMarketCoin(
+          txBlock,
+          sCoinName,
+          amount,
+          sender
+        );
+        txBlock.transferObjects([leftCoin], sender);
+        result.marketCoins.push(marketCoin);
+      }
+    } catch (_e) {
+      // no sCoin, try market coin
+      const { takeCoin: marketCoin, leftCoin } = await this.selectMarketCoin(
+        txBlock,
+        sCoinName,
+        amount,
+        sender
+      );
+      result.leftCoins.push(leftCoin);
+      result.marketCoins.push(marketCoin);
+    }
+
+    txBlock.transferObjects(result.leftCoins, sender);
+
+    // merge sCoins and marketCoins
+    const mergedMarketCoins =
+      result.marketCoins.length > 0
+        ? result.marketCoins.length > 1
+          ? txBlock.mergeCoins(
+              result.marketCoins[0],
+              result.marketCoins.slice(1)
+            )
+          : result.marketCoins[0]
+        : undefined;
+    const mergedSCoins =
+      result.sCoins.length > 0
+        ? result.sCoins.length > 1
+          ? txBlock.mergeCoins(result.sCoins[0], result.sCoins.slice(1))
+          : result.sCoins[0]
+        : undefined;
+    return {
+      sCoin: mergedSCoins,
+      marketCoin: mergedMarketCoins,
+    };
+  }
+
   /**
    * Execute Scallop txBlock using the `signAndSendTxn` methods in suikit.
    *

package/src/models/scallopCache.ts

@@ -82,7 +82,7 @@ export class ScallopCache {
   private lastRefill: number;
 
   public constructor(
-    params: ScallopCacheParams,
+    params: ScallopCacheParams = {},
     instance?: ScallopCacheInstanceParams
   ) {
     this.params = params;

package/src/models/scallopConstants.ts

@@ -210,7 +210,7 @@ export class ScallopConstants {
     if (this.isEmptyObject(this._coinNameToOldMarketCoinTypeMap))
       this._coinNameToOldMarketCoinTypeMap = Object.fromEntries(
         Object.entries(this.poolAddresses)
-          .filter(([_, value]) => !!value && value.spool)
+          .filter(([_, value]) => !!value)
           .map(([_, value]) => [
             value!.coinName,
             this.parseToOldMarketCoin(value!.coinType),

package/src/queries/portfolioQuery.ts

@@ -852,7 +852,7 @@ export const getUserPortfolio = async (
   walletAddress: string,
   indexer: boolean = false
 ) => {
-  const coinPrices = await query.utils.getCoinPrices();
+  const coinPrices = await query.getAllCoinPrices({ indexer });
   const market = await query.getMarketPools(undefined, { indexer, coinPrices });
 
   const [lendings, obligationAccounts, borrowIncentivePools, veScas] =
@@ -953,19 +953,22 @@ export const getUserPortfolio = async (
       };
     });
 
+  const LENDING_SPOOL_REWARD_COIN_NAME = 'sui' as const;
+  const LENDING_SPOOL_REWARD_COIN_SYMBOL = 'SUI' as const;
   const pendingLendingRewards = Object.values(lendings).reduce(
     (acc, reward) => {
       if (reward) {
         if (reward.availableClaimCoin === 0) return acc;
-        if (!acc[reward.symbol]) {
-          acc[reward.symbol] = {
-            symbol: reward.symbol,
+        if (!acc[LENDING_SPOOL_REWARD_COIN_NAME]) {
+          acc[LENDING_SPOOL_REWARD_COIN_NAME] = {
+            symbol: LENDING_SPOOL_REWARD_COIN_SYMBOL,
             coinType: normalizeStructTag(SUI_TYPE_ARG), // @TODO: for now lending reward is all in SUI
-            coinPrice: reward.coinPrice,
+            coinPrice: coinPrices[LENDING_SPOOL_REWARD_COIN_NAME] ?? 0,
             pendingRewardInCoin: reward.availableClaimCoin,
           };
         } else {
-          acc[reward.symbol].pendingRewardInCoin += reward.availableClaimCoin;
+          acc[LENDING_SPOOL_REWARD_COIN_NAME].pendingRewardInCoin +=
+            reward.availableClaimCoin;
         }
       }
       return acc;
@@ -1054,10 +1057,10 @@ export const getUserPortfolio = async (
     borrowings: parsedObligationAccounts,
     pendingRewards: {
       lendings: Object.entries(pendingLendingRewards).reduce(
-        (acc, [key, value]) => {
+        (acc, [_, value]) => {
           acc.push({
             ...value,
-            coinName: key,
+            coinName: 'sui',
             pendingRewardInUsd: value.coinPrice * value.pendingRewardInCoin,
           });
           return acc;