@scallop-io/sui-scallop-sdk 0.46.53 → 0.46.55

package/dist/models/scallop.d.ts

@@ -8,6 +8,7 @@ import type { ScallopParams } from '../types/';
 import { ScallopIndexer } from './scallopIndexer';
 import { ScallopCache } from './scallopCache';
 import { QueryClientConfig } from '@tanstack/query-core';
+import { TokenBucket } from 'src/utils';
 /**
  * @argument params - The parameters for the Scallop instance.
  * @argument cacheOptions - The cache options for the QueryClient.
@@ -30,7 +31,7 @@ export declare class Scallop {
     suiKit: SuiKit;
     cache: ScallopCache;
     private _address;
-    constructor(params: ScallopParams, cacheOptions?: QueryClientConfig);
+    constructor(params: ScallopParams, cacheOptions?: QueryClientConfig, tokenBucket?: TokenBucket);
     /**
      * Get a scallop address instance that already has read addresses.
      *

package/dist/models/scallopCache.d.ts

@@ -1,7 +1,8 @@
 import { QueryClient, QueryClientConfig } from '@tanstack/query-core';
 import { SuiTxArg } from '@scallop-io/sui-kit';
 import { SuiKit } from '@scallop-io/sui-kit';
-import type { SuiObjectResponse, SuiObjectDataOptions, SuiObjectData, PaginatedObjectsResponse, GetOwnedObjectsParams, DevInspectResults, GetDynamicFieldsParams, DynamicFieldPage, GetDynamicFieldObjectParams, GetBalanceParams } from '@mysten/sui.js/client';
+import type { SuiObjectResponse, SuiObjectDataOptions, SuiObjectData, GetOwnedObjectsParams, DevInspectResults, GetDynamicFieldsParams, DynamicFieldPage, GetDynamicFieldObjectParams, GetBalanceParams } from '@mysten/sui.js/client';
+import { TokenBucket } from 'src/utils';
 type QueryInspectTxnParams = {
     queryTarget: string;
     args: SuiTxArg[];
@@ -22,8 +23,10 @@ type QueryInspectTxnParams = {
 export declare class ScallopCache {
     readonly queryClient: QueryClient;
     readonly _suiKit?: SuiKit;
-    constructor(cacheOptions?: QueryClientConfig, suiKit?: SuiKit);
+    private tokenBucket;
+    constructor(cacheOptions?: QueryClientConfig, suiKit?: SuiKit, tokenBucket?: TokenBucket);
     private get suiKit();
+    private get client();
     /**
      * @description Invalidate cache based on the refetchType parameter
      * @param refetchType Determines the type of queries to be refetched. Defaults to `active`.
@@ -38,21 +41,21 @@ export declare class ScallopCache {
      * @description Cache protocol config call for 60 seconds.
      * @returns Promise<ProtocolConfig>
      */
-    getProtocolConfig(): Promise<import("@mysten/sui.js/client").ProtocolConfig>;
+    getProtocolConfig(): Promise<import("@mysten/sui.js/client").ProtocolConfig | null>;
     /**
      * @description Provides cache for inspectTxn of the SuiKit.
      * @param QueryInspectTxnParams
      * @param txBlock
      * @returns Promise<DevInspectResults>
      */
-    queryInspectTxn({ queryTarget, args, typeArgs, }: QueryInspectTxnParams): Promise<DevInspectResults>;
+    queryInspectTxn({ queryTarget, args, typeArgs, }: QueryInspectTxnParams): Promise<DevInspectResults | null>;
     /**
      * @description Provides cache for getObject of the SuiKit.
      * @param objectId
      * @param QueryObjectParams
      * @returns Promise<SuiObjectResponse>
      */
-    queryGetObject(objectId: string, options?: SuiObjectDataOptions): Promise<SuiObjectResponse>;
+    queryGetObject(objectId: string, options?: SuiObjectDataOptions): Promise<SuiObjectResponse | null>;
     /**
      * @description Provides cache for getObjects of the SuiKit.
      * @param objectIds
@@ -64,9 +67,9 @@ export declare class ScallopCache {
      * @param input
      * @returns Promise<PaginatedObjectsResponse>
      */
-    queryGetOwnedObjects(input: GetOwnedObjectsParams): Promise<PaginatedObjectsResponse>;
-    queryGetDynamicFields(input: GetDynamicFieldsParams): Promise<DynamicFieldPage>;
-    queryGetDynamicFieldObject(input: GetDynamicFieldObjectParams): Promise<SuiObjectResponse>;
+    queryGetOwnedObjects(input: GetOwnedObjectsParams): Promise<import("@mysten/sui.js/client").PaginatedObjectsResponse | null>;
+    queryGetDynamicFields(input: GetDynamicFieldsParams): Promise<DynamicFieldPage | null>;
+    queryGetDynamicFieldObject(input: GetDynamicFieldObjectParams): Promise<SuiObjectResponse | null>;
     queryGetAllCoinBalances(owner: string): Promise<{
         [k: string]: string;
     }>;

package/dist/models/scallopClient.d.ts

@@ -3,11 +3,11 @@ import { ScallopAddress } from './scallopAddress';
 import { ScallopUtils } from './scallopUtils';
 import { ScallopBuilder } from './scallopBuilder';
 import { ScallopQuery } from './scallopQuery';
+import { ScallopCache } from './scallopCache';
 import type { SuiTransactionBlockResponse } from '@mysten/sui.js/client';
 import type { TransactionObjectArgument } from '@mysten/sui.js/transactions';
 import type { SuiObjectArg } from '@scallop-io/sui-kit';
 import type { ScallopClientFnReturnType, ScallopInstanceParams, ScallopClientParams, SupportPoolCoins, SupportCollateralCoins, SupportAssetCoins, SupportStakeCoins, SupportStakeMarketCoins, SupportBorrowIncentiveCoins, ScallopTxBlock } from '../types';
-import { ScallopCache } from './scallopCache';
 /**
  * @description
  * It provides contract interaction operations for general users.
@@ -64,7 +64,7 @@ export declare class ScallopClient {
      * @param obligationId - The obligation id.
      * @return Obligation data.
      */
-    queryObligation(obligationId: string): Promise<import("../types").ObligationQueryInterface>;
+    queryObligation(obligationId: string): Promise<import("../types").ObligationQueryInterface | undefined>;
     /**
      * Query all stake accounts data.
      *

package/dist/models/scallopQuery.d.ts

@@ -118,7 +118,7 @@ export declare class ScallopQuery {
      * @param obligationId - The obligation id.
      * @return Obligation data.
      */
-    queryObligation(obligationId: string): Promise<import("../types").ObligationQueryInterface>;
+    queryObligation(obligationId: string): Promise<import("../types").ObligationQueryInterface | undefined>;
     /**
      * Get all asset coin amounts.
      *

package/dist/models/scallopUtils.d.ts

@@ -1,6 +1,6 @@
-import { SuiAddressArg } from '@scallop-io/sui-kit';
 import { ScallopAddress } from './scallopAddress';
 import type { ScallopUtilsParams, ScallopInstanceParams, SupportCoins, SupportAssetCoins, SupportMarketCoins, SupportStakeMarketCoins, SupportBorrowIncentiveCoins, CoinWrappedType, SupportSCoin } from '../types';
+import type { SuiAddressArg, SuiTxArg, SuiTxBlock } from '@scallop-io/sui-kit';
 /**
  * @description
  * Integrates some helper functions frequently used in interactions with the Scallop contract.
@@ -148,6 +148,14 @@ export declare class ScallopUtils {
         version: string;
         balance: string;
     }[]>;
+    /**
+     * Merge coins with type `coinType` to dest
+     * @param txBlock
+     * @param dest
+     * @param coinType
+     * @param sender
+     */
+    mergeSimilarCoins(txBlock: SuiTxBlock, dest: SuiTxArg, coinType: string, sender: string): Promise<void>;
     /**
      * Get all asset coin names in the obligation record by obligation id.
      *

package/dist/queries/coreQuery.d.ts

@@ -113,7 +113,7 @@ export declare const getObligationLocked: (query: ScallopQuery, obligationId: st
  * @param obligationId - The obligation id.
  * @return Obligation data.
  */
-export declare const queryObligation: (query: ScallopQuery, obligationId: SuiAddressArg) => Promise<ObligationQueryInterface>;
+export declare const queryObligation: (query: ScallopQuery, obligationId: SuiAddressArg) => Promise<ObligationQueryInterface | undefined>;
 /**
  * Query all owned coin amount.
  *

package/dist/utils/index.d.ts

@@ -1,3 +1,4 @@
 export * from './builder';
 export * from './query';
 export * from './util';
+export * from './tokenBucket';

package/dist/utils/tokenBucket.d.ts

@@ -0,0 +1,11 @@
+declare class TokenBucket {
+    private tokensPerInterval;
+    private interval;
+    private tokens;
+    private lastRefill;
+    constructor(tokensPerInterval: number, intervalInMs: number);
+    refill(): void;
+    removeTokens(count: number): boolean;
+}
+declare const callWithRateLimit: <T>(tokenBucket: TokenBucket, fn: () => Promise<T>, retryDelayInMs?: number, maxRetries?: number) => Promise<T | null>;
+export { TokenBucket, callWithRateLimit };

package/package.json

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

package/src/builders/loyaltyProgramBuilder.ts

@@ -1,5 +1,5 @@
 import { TransactionBlock } from '@mysten/sui.js/transactions';
-import { SuiObjectArg, SuiTxBlock as SuiKitTxBlock } from '@scallop-io/sui-kit';
+import { SuiTxBlock as SuiKitTxBlock } from '@scallop-io/sui-kit';
 import { coinIds } from 'src/constants';
 import { ScallopBuilder } from 'src/models';
 import {
@@ -43,26 +43,16 @@ const generateLoyaltyProgramQuickMethod: GenerateLoyaltyProgramQuickMethod = ({
       if (!veScaKey) throw new Error(`No veScaKey found for user ${sender}`);
 
       // claim the pending reward
-      const toTransferObject: SuiObjectArg[] = [];
       const rewardCoin = txBlock.claimLoyaltyRevenue(veScaKey);
 
       // get existing sca coin to merge with
-      try {
-        const existingScaCoin = await builder.suiKit.suiInteractor.selectCoins(
-          sender,
-          Infinity,
-          coinIds.sca
-        );
-        txBlock.mergeCoins(rewardCoin, existingScaCoin);
-      } catch (e) {
-        // ignore
-      } finally {
-        toTransferObject.push(rewardCoin);
-      }
-
-      if (toTransferObject.length > 0) {
-        txBlock.transferObjects(toTransferObject, sender);
-      }
+      await builder.utils.mergeSimilarCoins(
+        txBlock,
+        rewardCoin,
+        coinIds.sca,
+        requireSender(txBlock)
+      );
+      txBlock.transferObjects([rewardCoin], sender);
     },
   };
 };

package/src/builders/spoolBuilder.ts

@@ -276,7 +276,7 @@ const generateSpoolQuickMethod: GenerateSpoolQuickMethod = ({
         }
 
         amount -= amountToUnstake;
-        if (amount === 0) break;
+        if (amount <= 0) break;
       }
 
       if (toTransfer.length > 0) {
@@ -285,38 +285,6 @@ const generateSpoolQuickMethod: GenerateSpoolQuickMethod = ({
         if (toTransfer.length > 1) {
           txBlock.mergeCoins(mergedCoin, toTransfer.slice(1));
         }
-
-        if (returnSCoin) {
-          // check for existing sCoins
-          try {
-            const existingCoins = await builder.utils.selectCoins(
-              Number.MAX_SAFE_INTEGER,
-              builder.utils.parseSCoinType(stakeMarketCoinName),
-              requireSender(txBlock)
-            );
-
-            if (existingCoins.length > 0) {
-              txBlock.mergeCoins(mergedCoin, existingCoins);
-            }
-          } catch (e) {
-            // ignore
-          }
-        } else {
-          // check for existing market coins
-          try {
-            const existingCoins = await builder.utils.selectCoins(
-              Number.MAX_SAFE_INTEGER,
-              builder.utils.parseMarketCoinType(stakeMarketCoinName),
-              requireSender(txBlock)
-            );
-
-            if (existingCoins.length > 0) {
-              txBlock.mergeCoins(mergedCoin, existingCoins);
-            }
-          } catch (e) {
-            // ignore
-          }
-        }
         return mergedCoin;
       }
     },

package/src/constants/tokenBucket.ts

@@ -0,0 +1,2 @@
+export const DEFAULT_TOKENS_PER_INTERVAL = 10;
+export const DEFAULT_INTERVAL_IN_MS = 1000;

package/src/models/scallop.ts

@@ -10,6 +10,11 @@ import { ScallopIndexer } from './scallopIndexer';
 import { ScallopCache } from './scallopCache';
 import { QueryClientConfig } from '@tanstack/query-core';
 import { DEFAULT_CACHE_OPTIONS } from 'src/constants/cache';
+import { TokenBucket } from 'src/utils';
+import {
+  DEFAULT_INTERVAL_IN_MS,
+  DEFAULT_TOKENS_PER_INTERVAL,
+} from 'src/constants/tokenBucket';
 
 /**
  * @argument params - The parameters for the Scallop instance.
@@ -35,12 +40,18 @@ export class Scallop {
 
   private _address: ScallopAddress;
 
-  public constructor(params: ScallopParams, cacheOptions?: QueryClientConfig) {
+  public constructor(
+    params: ScallopParams,
+    cacheOptions?: QueryClientConfig,
+    tokenBucket?: TokenBucket
+  ) {
     this.params = params;
     this.suiKit = new SuiKit(params);
     this.cache = new ScallopCache(
       cacheOptions ?? DEFAULT_CACHE_OPTIONS,
-      this.suiKit
+      this.suiKit,
+      tokenBucket ??
+        new TokenBucket(DEFAULT_TOKENS_PER_INTERVAL, DEFAULT_INTERVAL_IN_MS)
     );
     this._address = new ScallopAddress(
       {

package/src/models/scallopCache.ts

@@ -10,15 +10,20 @@ import type {
   SuiObjectResponse,
   SuiObjectDataOptions,
   SuiObjectData,
-  PaginatedObjectsResponse,
   GetOwnedObjectsParams,
   DevInspectResults,
   GetDynamicFieldsParams,
   DynamicFieldPage,
   GetDynamicFieldObjectParams,
   GetBalanceParams,
+  SuiClient,
 } from '@mysten/sui.js/client';
 import { DEFAULT_CACHE_OPTIONS } from 'src/constants/cache';
+import { callWithRateLimit, TokenBucket } from 'src/utils';
+import {
+  DEFAULT_INTERVAL_IN_MS,
+  DEFAULT_TOKENS_PER_INTERVAL,
+} from 'src/constants/tokenBucket';
 
 type QueryInspectTxnParams = {
   queryTarget: string;
@@ -42,10 +47,18 @@ type QueryInspectTxnParams = {
 export class ScallopCache {
   public readonly queryClient: QueryClient;
   public readonly _suiKit?: SuiKit;
+  private tokenBucket: TokenBucket;
 
-  public constructor(cacheOptions?: QueryClientConfig, suiKit?: SuiKit) {
+  public constructor(
+    cacheOptions?: QueryClientConfig,
+    suiKit?: SuiKit,
+    tokenBucket?: TokenBucket
+  ) {
     this.queryClient = new QueryClient(cacheOptions ?? DEFAULT_CACHE_OPTIONS);
     this._suiKit = suiKit;
+    this.tokenBucket =
+      tokenBucket ??
+      new TokenBucket(DEFAULT_TOKENS_PER_INTERVAL, DEFAULT_INTERVAL_IN_MS);
   }
 
   private get suiKit(): SuiKit {
@@ -55,6 +68,10 @@ export class ScallopCache {
     return this._suiKit;
   }
 
+  private get client(): SuiClient {
+    return this.suiKit.client();
+  }
+
   /**
    * @description Invalidate cache based on the refetchType parameter
    * @param refetchType Determines the type of queries to be refetched. Defaults to `active`.
@@ -80,7 +97,9 @@ export class ScallopCache {
     return await this.queryClient.fetchQuery({
       queryKey: ['getProtocolConfig'],
       queryFn: async () => {
-        return await this.suiKit.client().getProtocolConfig();
+        return await callWithRateLimit(this.tokenBucket, () =>
+          this.client.getProtocolConfig()
+        );
       },
       staleTime: 30000,
     });
@@ -96,14 +115,14 @@ export class ScallopCache {
     queryTarget,
     args,
     typeArgs,
-  }: QueryInspectTxnParams): Promise<DevInspectResults> {
+  }: QueryInspectTxnParams): Promise<DevInspectResults | null> {
     const txBlock = new SuiTxBlock();
 
     // resolve all the object args to prevent duplicate getNormalizedMoveFunction calls
     const resolvedArgs = await Promise.all(
       args.map(async (arg) => {
         if (typeof arg === 'string') {
-          return (await this.queryGetObject(arg, { showContent: true })).data;
+          return (await this.queryGetObject(arg, { showContent: true }))?.data;
         }
         return arg;
       })
@@ -112,9 +131,9 @@ export class ScallopCache {
 
     // build the txBlock to prevent duplicate getProtocolConfig calls
     const txBytes = await txBlock.txBlock.build({
-      client: this.suiKit.client(),
+      client: this.client,
       onlyTransactionKind: true,
-      protocolConfig: await this.getProtocolConfig(),
+      protocolConfig: (await this.getProtocolConfig()) ?? undefined,
     });
 
     const query = await this.queryClient.fetchQuery({
@@ -127,7 +146,9 @@ export class ScallopCache {
             JSON.stringify(typeArgs),
           ],
       queryFn: async () => {
-        return await this.suiKit.inspectTxn(txBytes);
+        return await callWithRateLimit(this.tokenBucket, () =>
+          this.suiKit.inspectTxn(txBytes)
+        );
       },
     });
     return query;
@@ -142,7 +163,7 @@ export class ScallopCache {
   public async queryGetObject(
     objectId: string,
     options?: SuiObjectDataOptions
-  ): Promise<SuiObjectResponse> {
+  ): Promise<SuiObjectResponse | null> {
     const queryKey = ['getObject', objectId, this.suiKit.currentAddress()];
     if (options) {
       queryKey.push(JSON.stringify(options));
@@ -150,10 +171,12 @@ export class ScallopCache {
     return this.queryClient.fetchQuery({
       queryKey,
       queryFn: async () => {
-        return await this.suiKit.client().getObject({
-          id: objectId,
-          options,
-        });
+        return await callWithRateLimit(this.tokenBucket, () =>
+          this.client.getObject({
+            id: objectId,
+            options,
+          })
+        );
       },
     });
   }
@@ -179,7 +202,9 @@ export class ScallopCache {
     return this.queryClient.fetchQuery({
       queryKey: queryKey,
       queryFn: async () => {
-        return await this.suiKit.getObjects(objectIds, options);
+        return await callWithRateLimit(this.tokenBucket, () =>
+          this.suiKit.getObjects(objectIds, options)
+        );
       },
     });
   }
@@ -189,9 +214,7 @@ export class ScallopCache {
    * @param input
    * @returns Promise<PaginatedObjectsResponse>
    */
-  public async queryGetOwnedObjects(
-    input: GetOwnedObjectsParams
-  ): Promise<PaginatedObjectsResponse> {
+  public async queryGetOwnedObjects(input: GetOwnedObjectsParams) {
     const queryKey = ['getOwnedObjects', input.owner];
     if (input.cursor) {
       queryKey.push(JSON.stringify(input.cursor));
@@ -209,14 +232,16 @@ export class ScallopCache {
     return this.queryClient.fetchQuery({
       queryKey,
       queryFn: async () => {
-        return await this.suiKit.client().getOwnedObjects(input);
+        return await callWithRateLimit(this.tokenBucket, () =>
+          this.client.getOwnedObjects(input)
+        );
       },
     });
   }
 
   public async queryGetDynamicFields(
     input: GetDynamicFieldsParams
-  ): Promise<DynamicFieldPage> {
+  ): Promise<DynamicFieldPage | null> {
     const queryKey = ['getDynamicFields', input.parentId];
     if (input.cursor) {
       queryKey.push(JSON.stringify(input.cursor));
@@ -228,14 +253,16 @@ export class ScallopCache {
     return this.queryClient.fetchQuery({
       queryKey,
       queryFn: async () => {
-        return await this.suiKit.client().getDynamicFields(input);
+        return await callWithRateLimit(this.tokenBucket, () =>
+          this.client.getDynamicFields(input)
+        );
       },
     });
   }
 
   public async queryGetDynamicFieldObject(
     input: GetDynamicFieldObjectParams
-  ): Promise<SuiObjectResponse> {
+  ): Promise<SuiObjectResponse | null> {
     const queryKey = [
       'getDynamicFieldObject',
       input.parentId,
@@ -245,7 +272,9 @@ export class ScallopCache {
     return this.queryClient.fetchQuery({
       queryKey,
       queryFn: async () => {
-        return await this.suiKit.client().getDynamicFieldObject(input);
+        return await callWithRateLimit(this.tokenBucket, () =>
+          this.client.getDynamicFieldObject(input)
+        );
       },
     });
   }
@@ -257,9 +286,10 @@ export class ScallopCache {
     return this.queryClient.fetchQuery({
       queryKey,
       queryFn: async () => {
-        const allBalances = await this.suiKit
-          .client()
-          .getAllBalances({ owner });
+        const allBalances = await callWithRateLimit(this.tokenBucket, () =>
+          this.client.getAllBalances({ owner })
+        );
+        if (!allBalances) return {};
         const balances = allBalances.reduce(
           (acc, coinBalance) => {
             if (coinBalance.totalBalance !== '0') {

package/src/models/scallopClient.ts

@@ -1,5 +1,6 @@
 import { normalizeSuiAddress } from '@mysten/sui.js/utils';
 import { SuiKit } from '@scallop-io/sui-kit';
+import { DEFAULT_CACHE_OPTIONS } from 'src/constants/cache';
 import {
   ADDRESSES_ID,
   SUPPORT_BORROW_INCENTIVE_POOLS,
@@ -11,6 +12,8 @@ import { ScallopAddress } from './scallopAddress';
 import { ScallopUtils } from './scallopUtils';
 import { ScallopBuilder } from './scallopBuilder';
 import { ScallopQuery } from './scallopQuery';
+import { ScallopCache } from './scallopCache';
+import { requireSender } from 'src/utils';
 import type { SuiTransactionBlockResponse } from '@mysten/sui.js/client';
 import type { TransactionObjectArgument } from '@mysten/sui.js/transactions';
 import type { SuiObjectArg } from '@scallop-io/sui-kit';
@@ -27,8 +30,6 @@ import type {
   ScallopTxBlock,
   SupportSCoin,
 } from '../types';
-import { ScallopCache } from './scallopCache';
-import { DEFAULT_CACHE_OPTIONS } from 'src/constants/cache';
 
 /**
  * @description
@@ -747,6 +748,17 @@ export class ScallopClient {
       stakeMarketCoinName,
       stakeAccountId
     );
+
+    if (sCoin) {
+      // merge to existing sCoins if exist
+      await this.utils.mergeSimilarCoins(
+        txBlock,
+        sCoin,
+        this.utils.parseSCoinType(stakeMarketCoinName),
+        requireSender(txBlock)
+      );
+    }
+
     txBlock.transferObjects([sCoin], sender);
 
     if (sign) {
@@ -800,6 +812,13 @@ export class ScallopClient {
       this.utils.parseCoinName<SupportStakeCoins>(stakeMarketCoinName);
     if (stakeMarketCoin) {
       const coin = txBlock.withdraw(stakeMarketCoin, stakeCoinName);
+      await this.utils.mergeSimilarCoins(
+        txBlock,
+        coin,
+        this.utils.parseCoinType(this.utils.parseCoinName(stakeCoinName)),
+        requireSender(txBlock)
+      );
+
       txBlock.transferObjects([coin], sender);
     } else {
       throw new Error(`No stake found for ${stakeMarketCoinName}`);
@@ -1010,17 +1029,13 @@ export class ScallopClient {
             toDestroyMarketCoin
           );
 
-          // check if current sCoin exist
-          try {
-            const existSCoins = await this.utils.selectCoins(
-              Number.MAX_SAFE_INTEGER,
-              this.utils.parseSCoinType(sCoinName as SupportSCoin),
-              this.walletAddress
-            );
-            txBlock.mergeCoins(sCoin, existSCoins);
-          } catch (e: any) {
-            // ignore
-          }
+          // check if current sCoin
+          await this.utils.mergeSimilarCoins(
+            txBlock,
+            sCoin,
+            this.utils.parseSCoinType(sCoinName as SupportSCoin),
+            requireSender(txBlock)
+          );
           sCoins.push(sCoin);
         }
         // check for staked market coin in spool

package/src/models/scallopUtils.ts

@@ -1,5 +1,5 @@
 import { SUI_TYPE_ARG, normalizeStructTag } from '@mysten/sui.js/utils';
-import { SuiAddressArg, SuiKit } from '@scallop-io/sui-kit';
+import { SuiKit } from '@scallop-io/sui-kit';
 import { SuiPriceServiceConnection } from '@pythnetwork/pyth-sui-js';
 import { ScallopAddress } from './scallopAddress';
 import { ScallopQuery } from './scallopQuery';
@@ -26,6 +26,9 @@ import {
   parseAssetSymbol,
   findClosestUnlockRound,
 } from '../utils';
+import { PYTH_ENDPOINTS } from 'src/constants/pyth';
+import { ScallopCache } from './scallopCache';
+import { DEFAULT_CACHE_OPTIONS } from 'src/constants/cache';
 import type {
   ScallopUtilsParams,
   ScallopInstanceParams,
@@ -39,9 +42,7 @@ import type {
   CoinWrappedType,
   SupportSCoin,
 } from '../types';
-import { PYTH_ENDPOINTS } from 'src/constants/pyth';
-import { ScallopCache } from './scallopCache';
-import { DEFAULT_CACHE_OPTIONS } from 'src/constants/cache';
+import type { SuiAddressArg, SuiTxArg, SuiTxBlock } from '@scallop-io/sui-kit';
 
 /**
  * @description
@@ -396,6 +397,35 @@ export class ScallopUtils {
     return coins;
   }
 
+  /**
+   * Merge coins with type `coinType` to dest
+   * @param txBlock
+   * @param dest
+   * @param coinType
+   * @param sender
+   */
+  public async mergeSimilarCoins(
+    txBlock: SuiTxBlock,
+    dest: SuiTxArg,
+    coinType: string,
+    sender: string
+  ): Promise<void> {
+    // merge to existing coins if exist
+    try {
+      const existingSCoin = await this.selectCoins(
+        Number.MAX_SAFE_INTEGER,
+        coinType,
+        sender
+      );
+
+      if (existingSCoin.length > 0) {
+        txBlock.mergeCoins(dest, existingSCoin);
+      }
+    } catch (e) {
+      // ignore
+    }
+  }
+
   /**
    * Get all asset coin names in the obligation record by obligation id.
    *
@@ -408,12 +438,14 @@ export class ScallopUtils {
    */
   public async getObligationCoinNames(obligationId: SuiAddressArg) {
     const obligation = await queryObligation(this._query, obligationId);
-    const collateralCoinTypes = obligation.collaterals.map((collateral) => {
-      return `0x${collateral.type.name}`;
-    });
-    const debtCoinTypes = obligation.debts.map((debt) => {
-      return `0x${debt.type.name}`;
-    });
+    const collateralCoinTypes =
+      obligation?.collaterals.map((collateral) => {
+        return `0x${collateral.type.name}`;
+      }) ?? [];
+    const debtCoinTypes =
+      obligation?.debts.map((debt) => {
+        return `0x${debt.type.name}`;
+      }) ?? [];
     const obligationCoinTypes = [
       ...new Set([...collateralCoinTypes, ...debtCoinTypes]),
     ];