@scallop-io/sui-scallop-sdk 1.3.5-alpha.2 → 1.3.5-alpha.3

package/dist/models/scallopClient.d.ts

@@ -7,7 +7,7 @@ import type { SuiTransactionBlockResponse } from '@mysten/sui/client';
 import type { TransactionObjectArgument } from '@mysten/sui/transactions';
 import { ScallopCache } from './scallopCache';
 import type { SuiObjectArg } from '@scallop-io/sui-kit';
-import type { ScallopClientFnReturnType, ScallopClientParams, SupportPoolCoins, SupportCollateralCoins, SupportAssetCoins, SupportStakeCoins, SupportStakeMarketCoins, SupportBorrowIncentiveCoins, ScallopTxBlock, ScallopClientVeScaReturnType, ScallopClientInstanceParams } from '../types';
+import type { ScallopClientFnReturnType, ScallopClientParams, SupportPoolCoins, SupportCollateralCoins, SupportAssetCoins, SupportStakeCoins, SupportStakeMarketCoins, ScallopTxBlock, ScallopClientVeScaReturnType, ScallopClientInstanceParams } from '../types';
 /**
  * @description
  * It provides contract interaction operations for general users.
@@ -284,16 +284,16 @@ export declare class ScallopClient {
      */
     unstakeObligation<S extends boolean>(obligationId: string, obligationKeyId: string, sign?: S, walletAddress?: string): Promise<ScallopClientFnReturnType<S>>;
     /**
-     * unstake market coin from the specific spool.
+     * Claim borrow incentive reward.
      *
-     * @param marketCoinName - Types of mak coin.
+     * @param poolName
      * @param amount - The amount of coins would deposit.
      * @param sign - Decide to directly sign the transaction or return the transaction block.
      * @param accountId - The stake account object.
      * @param walletAddress - The wallet address of the owner.
      * @return Transaction block response or transaction block
      */
-    claimBorrowIncentive<S extends boolean>(coinName: SupportBorrowIncentiveCoins, obligationId: string, obligationKeyId: string, sign?: S, walletAddress?: string): Promise<ScallopClientFnReturnType<S>>;
+    claimBorrowIncentive<S extends boolean>(obligationId: string, obligationKeyId: string, sign?: S, walletAddress?: string): Promise<ScallopClientFnReturnType<S>>;
     /**
      * Function to migrate all market coin in user wallet into sCoin
      * @returns Transaction response

package/dist/models/scallopUtils.d.ts

@@ -1,7 +1,7 @@
 import { SuiKit } from '@scallop-io/sui-kit';
 import { ScallopAddress } from './scallopAddress';
 import { ScallopCache } from './scallopCache';
-import type { ScallopUtilsParams, SupportCoins, SupportAssetCoins, SupportMarketCoins, SupportStakeMarketCoins, SupportBorrowIncentiveCoins, CoinWrappedType, SupportSCoin, ScallopUtilsInstanceParams, SupportSuiBridgeCoins, SupportWormholeCoins, PoolAddressInfo } from '../types';
+import type { ScallopUtilsParams, SupportCoins, SupportAssetCoins, SupportMarketCoins, SupportStakeMarketCoins, CoinWrappedType, SupportSCoin, ScallopUtilsInstanceParams, SupportSuiBridgeCoins, SupportWormholeCoins, PoolAddressInfo } from '../types';
 import type { SuiObjectArg, SuiTxArg, SuiTxBlock } from '@scallop-io/sui-kit';
 /**
  * @description
@@ -131,13 +131,6 @@ export declare class ScallopUtils {
      * @return Spool reward coin name.
      */
     getSpoolRewardCoinName: (stakeMarketCoinName: SupportStakeMarketCoins) => "sui";
-    /**
-     * Get reward type of borrow incentive pool.
-     *
-     * @param borrowIncentiveCoinName - Support borrow incentive coin.
-     * @return Borrow incentive reward coin name.
-     */
-    getBorrowIncentiveRewardCoinName: (borrowIncentiveCoinName: SupportBorrowIncentiveCoins) => ("usdc" | "sbeth" | "weth" | "wbtc" | "wusdc" | "wusdt" | "sui" | "wapt" | "wsol" | "cetus" | "afsui" | "hasui" | "vsui" | "sca" | "susdc" | "ssbeth" | "sweth" | "swbtc" | "swusdc" | "swusdt" | "ssui" | "swsol" | "scetus" | "safsui" | "shasui" | "svsui" | "ssca")[];
     /**
      * Get coin decimal.
      *

package/dist/types/builder/borrowIncentive.d.ts

@@ -1,7 +1,7 @@
 import type { SuiTxBlock as SuiKitTxBlock, SuiObjectArg } from '@scallop-io/sui-kit';
 import type { TransactionResult } from '@mysten/sui/transactions';
 import type { ScallopBuilder } from '../../models';
-import type { SupportBorrowIncentiveCoins, SupportBorrowIncentiveRewardCoins } from '../constant';
+import type { SupportBorrowIncentiveRewardCoins } from '../constant';
 export type BorrowIncentiveIds = {
     borrowIncentivePkg: string;
     query: string;
@@ -14,14 +14,14 @@ export type BorrowIncentiveNormalMethods = {
     stakeObligation: (obligation: SuiObjectArg, obligationKey: SuiObjectArg) => void;
     stakeObligationWithVesca: (obligation: SuiObjectArg, obligationKey: SuiObjectArg, veScaKey: SuiObjectArg) => void;
     unstakeObligation: (obligation: SuiObjectArg, obligationKey: SuiObjectArg) => void;
-    claimBorrowIncentive: (obligation: SuiObjectArg, obligationKey: SuiObjectArg, coinName: SupportBorrowIncentiveCoins, rewardType: SupportBorrowIncentiveRewardCoins) => TransactionResult;
+    claimBorrowIncentive: (obligation: SuiObjectArg, obligationKey: SuiObjectArg, rewardType: SupportBorrowIncentiveRewardCoins) => TransactionResult;
     deactivateBoost: (obligation: SuiObjectArg, veScaKey: SuiObjectArg) => void;
 };
 export type BorrowIncentiveQuickMethods = {
-    stakeObligationQuick(obligation?: SuiObjectArg, obligationKey?: SuiObjectArg): Promise<void>;
-    stakeObligationWithVeScaQuick(obligation?: SuiObjectArg, obligationKey?: SuiObjectArg, veScaKey?: SuiObjectArg): Promise<void>;
-    unstakeObligationQuick(obligation?: SuiObjectArg, obligationKey?: SuiObjectArg): Promise<void>;
-    claimBorrowIncentiveQuick(coinName: SupportBorrowIncentiveCoins, rewardType: SupportBorrowIncentiveRewardCoins, obligation?: SuiObjectArg, obligationKey?: SuiObjectArg): Promise<TransactionResult>;
+    stakeObligationQuick(obligation?: string, obligationKey?: string): Promise<void>;
+    stakeObligationWithVeScaQuick(obligation?: string, obligationKey?: string, veScaKey?: string): Promise<void>;
+    unstakeObligationQuick(obligation?: string, obligationKey?: string): Promise<void>;
+    claimBorrowIncentiveQuick(rewardType: SupportBorrowIncentiveRewardCoins, obligation?: string, obligationKey?: string): Promise<TransactionResult>;
 };
 export type SuiTxBlockWithBorrowIncentiveNormalMethods = SuiKitTxBlock & BorrowIncentiveNormalMethods;
 export type BorrowIncentiveTxBlock = SuiTxBlockWithBorrowIncentiveNormalMethods & BorrowIncentiveQuickMethods;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scallop-io/sui-scallop-sdk",
-  "version": "1.3.5-alpha.2",
+  "version": "1.3.5-alpha.3",
   "description": "Typescript sdk for interacting with Scallop contract on SUI",
   "keywords": [
     "sui",

package/src/builders/borrowIncentiveBuilder.ts

@@ -143,17 +143,7 @@ const generateBorrowIncentiveNormalMethod: GenerateBorrowIncentiveNormalMethod =
           ]
         );
       },
-      claimBorrowIncentive: (
-        obligationId,
-        obligationKey,
-        coinName,
-        rewardCoinName
-      ) => {
-        const rewardCoinNames =
-          builder.utils.getBorrowIncentiveRewardCoinName(coinName);
-        if (rewardCoinNames.includes(rewardCoinName) === false) {
-          throw new Error(`Invalid reward coin name ${rewardCoinName}`);
-        }
+      claimBorrowIncentive: (obligationId, obligationKey, rewardCoinName) => {
         const rewardType = builder.utils.parseCoinType(rewardCoinName);
         return txBlock.moveCall(
           `${borrowIncentiveIds.borrowIncentivePkg}::user::redeem_rewards`,
@@ -284,11 +274,11 @@ const generateBorrowIncentiveQuickMethod: GenerateBorrowIncentiveQuickMethod =
         }
       },
       claimBorrowIncentiveQuick: async (
-        coinName,
         rewardCoinName,
         obligation,
         obligationKey
       ) => {
+        // check for available reward coin names
         const { obligationId: obligationArg, obligationKey: obligationKeyArg } =
           await requireObligationInfo(
             builder,
@@ -300,7 +290,6 @@ const generateBorrowIncentiveQuickMethod: GenerateBorrowIncentiveQuickMethod =
         return txBlock.claimBorrowIncentive(
           obligationArg,
           obligationKeyArg,
-          coinName,
           rewardCoinName
         );
       },

package/src/constants/enum.ts

@@ -125,19 +125,6 @@ export const suiBridgeCoins: types.SuiBridgeCoins = {
   sbeth: 'sbeth',
 };
 
-export const borrowIncentiveRewardCoins: types.BorrowIncentiveRewardCoins = {
-  usdc: ['ssui', 'ssca'],
-  sui: ['ssui', 'ssca'],
-  wusdc: ['ssui', 'ssca'],
-  wusdt: ['ssui', 'ssca'],
-  sca: ['ssui', 'ssca'],
-  afsui: ['ssui'],
-  hasui: ['ssui'],
-  vsui: ['ssui'],
-  weth: ['ssui'],
-  sbeth: ['ssui'],
-};
-
 export const coinIds: types.AssetCoinIds = {
   usdc: '0xdba34672e30cb065b1f93e3ab55318768fd6fef66c15942c9f7cb846e2f900e7',
   sui: '0x0000000000000000000000000000000000000000000000000000000000000002',

package/src/models/scallopClient.ts

@@ -4,7 +4,6 @@ import { DEFAULT_CACHE_OPTIONS } from 'src/constants/cache';
 import {
   ADDRESSES_ID,
   SUPPORT_BORROW_INCENTIVE_POOLS,
-  SUPPORT_BORROW_INCENTIVE_REWARDS,
   SUPPORT_SCOIN,
   SUPPORT_SPOOLS,
 } from '../constants';
@@ -28,7 +27,6 @@ import type {
   SupportAssetCoins,
   SupportStakeCoins,
   SupportStakeMarketCoins,
-  SupportBorrowIncentiveCoins,
   ScallopTxBlock,
   SupportSCoin,
   ScallopClientVeScaReturnType,
@@ -945,9 +943,9 @@ export class ScallopClient {
   }
 
   /**
-   * unstake market coin from the specific spool.
+   * Claim borrow incentive reward.
    *
-   * @param marketCoinName - Types of mak coin.
+   * @param poolName
    * @param amount - The amount of coins would deposit.
    * @param sign - Decide to directly sign the transaction or return the transaction block.
    * @param accountId - The stake account object.
@@ -955,7 +953,6 @@ export class ScallopClient {
    * @return Transaction block response or transaction block
    */
   public async claimBorrowIncentive<S extends boolean>(
-    coinName: SupportBorrowIncentiveCoins,
     obligationId: string,
     obligationKeyId: string,
     sign: S = true as S,
@@ -965,17 +962,37 @@ export class ScallopClient {
     const sender = walletAddress ?? this.walletAddress;
     txBlock.setSender(sender);
 
-    const rewardCoins = [];
-    for (const rewardCoinName of SUPPORT_BORROW_INCENTIVE_REWARDS) {
+    const rewardCoinsCollection: Record<string, TransactionResult[]> = {};
+    const obligationAccount =
+      await this.query.getObligationAccount(obligationId);
+    const rewardCoinNames = Object.values(obligationAccount.borrowIncentives)
+      .flatMap(({ rewards }) =>
+        rewards.filter(({ availableClaimAmount }) => availableClaimAmount > 0)
+      )
+      .flatMap(({ coinName }) => coinName);
+    for (const rewardCoinName of rewardCoinNames) {
       const rewardCoin = await txBlock.claimBorrowIncentiveQuick(
-        coinName,
         rewardCoinName,
         obligationId,
         obligationKeyId
       );
-      rewardCoins.push(rewardCoin);
+      if (!rewardCoinsCollection[rewardCoinName]) {
+        rewardCoinsCollection[rewardCoinName] = [rewardCoin];
+      } else {
+        rewardCoinsCollection[rewardCoinName].push(rewardCoin);
+      }
     }
-    txBlock.transferObjects(rewardCoins, sender);
+
+    txBlock.transferObjects(
+      Object.values(rewardCoinsCollection).map((rewardCoins) => {
+        const mergeDest = rewardCoins[0];
+        if (rewardCoins.length > 1) {
+          txBlock.mergeCoins(mergeDest, rewardCoins.slice(1));
+        }
+        return mergeDest;
+      }),
+      sender
+    );
 
     if (sign) {
       return (await this.suiKit.signAndSendTxn(

package/src/models/scallopUtils.ts

@@ -8,7 +8,6 @@ import {
   SUPPORT_POOLS,
   SUPPORT_COLLATERALS,
   spoolRewardCoins,
-  borrowIncentiveRewardCoins,
   coinDecimals,
   wormholeCoinIds,
   voloCoinIds,
@@ -41,7 +40,6 @@ import type {
   SupportAssetCoins,
   SupportMarketCoins,
   SupportStakeMarketCoins,
-  SupportBorrowIncentiveCoins,
   CoinPrices,
   CoinWrappedType,
   SupportSCoin,
@@ -159,6 +157,10 @@ export class ScallopUtils {
    * @return Coin type.
    */
   public parseCoinType(coinName: SupportCoins) {
+    // try parse scoin first
+    if (sCoinIds[coinName as SupportSCoin]) {
+      return sCoinIds[coinName as SupportSCoin];
+    }
     coinName = isMarketCoin(coinName) ? this.parseCoinName(coinName) : coinName;
     const coinPackageId =
       this.address.get(`core.coins.${coinName}.id`) ||
@@ -395,18 +397,6 @@ export class ScallopUtils {
     return spoolRewardCoins[stakeMarketCoinName];
   };
 
-  /**
-   * Get reward type of borrow incentive pool.
-   *
-   * @param borrowIncentiveCoinName - Support borrow incentive coin.
-   * @return Borrow incentive reward coin name.
-   */
-  public getBorrowIncentiveRewardCoinName = (
-    borrowIncentiveCoinName: SupportBorrowIncentiveCoins
-  ) => {
-    return borrowIncentiveRewardCoins[borrowIncentiveCoinName];
-  };
-
   /**
    * Get coin decimal.
    *

package/src/types/builder/borrowIncentive.ts

@@ -4,10 +4,7 @@ import type {
 } from '@scallop-io/sui-kit';
 import type { TransactionResult } from '@mysten/sui/transactions';
 import type { ScallopBuilder } from '../../models';
-import type {
-  SupportBorrowIncentiveCoins,
-  SupportBorrowIncentiveRewardCoins,
-} from '../constant';
+import type { SupportBorrowIncentiveRewardCoins } from '../constant';
 
 export type BorrowIncentiveIds = {
   borrowIncentivePkg: string;
@@ -35,7 +32,6 @@ export type BorrowIncentiveNormalMethods = {
   claimBorrowIncentive: (
     obligation: SuiObjectArg,
     obligationKey: SuiObjectArg,
-    coinName: SupportBorrowIncentiveCoins,
     rewardType: SupportBorrowIncentiveRewardCoins
   ) => TransactionResult;
   deactivateBoost: (obligation: SuiObjectArg, veScaKey: SuiObjectArg) => void;
@@ -43,23 +39,22 @@ export type BorrowIncentiveNormalMethods = {
 
 export type BorrowIncentiveQuickMethods = {
   stakeObligationQuick(
-    obligation?: SuiObjectArg,
-    obligationKey?: SuiObjectArg
+    obligation?: string,
+    obligationKey?: string
   ): Promise<void>;
   stakeObligationWithVeScaQuick(
-    obligation?: SuiObjectArg,
-    obligationKey?: SuiObjectArg,
-    veScaKey?: SuiObjectArg
+    obligation?: string,
+    obligationKey?: string,
+    veScaKey?: string
   ): Promise<void>;
   unstakeObligationQuick(
-    obligation?: SuiObjectArg,
-    obligationKey?: SuiObjectArg
+    obligation?: string,
+    obligationKey?: string
   ): Promise<void>;
   claimBorrowIncentiveQuick(
-    coinName: SupportBorrowIncentiveCoins,
     rewardType: SupportBorrowIncentiveRewardCoins,
-    obligation?: SuiObjectArg,
-    obligationKey?: SuiObjectArg
+    obligation?: string,
+    obligationKey?: string
   ): Promise<TransactionResult>;
 };