@scallop-io/sui-scallop-sdk 0.44.13 → 0.44.15

package/dist/models/scallopBuilder.d.ts

@@ -29,9 +29,9 @@ export declare class ScallopBuilder {
     /**
      * Request the scallop API to initialize data.
      *
-     * @param forece - Whether to force initialization.
+     * @param force - Whether to force initialization.
      */
-    init(forece?: boolean): Promise<void>;
+    init(force?: boolean): Promise<void>;
     /**
      * Create a scallop txBlock instance that enhances transaction block.
      *

package/dist/models/scallopClient.d.ts

@@ -264,23 +264,23 @@ export declare class ScallopClient {
     /**
      * stake obligaion.
      *
-     * @param sign - Decide to directly sign the transaction or return the transaction block.
      * @param obligaionId - The obligation account object.
      * @param obligaionKeyId - The obligation key account object.
+     * @param sign - Decide to directly sign the transaction or return the transaction block.
      * @param walletAddress - The wallet address of the owner.
      * @return Transaction block response or transaction block
      */
-    stakeObligation<S extends boolean>(coinName: SupportBorrowIncentiveCoins, obligaionId: string, obligaionKeyId: string, sign?: S, walletAddress?: string): Promise<ScallopClientFnReturnType<S>>;
+    stakeObligation<S extends boolean>(obligaionId: string, obligaionKeyId: string, sign?: S, walletAddress?: string): Promise<ScallopClientFnReturnType<S>>;
     /**
      * unstake obligaion.
      *
-     * @param sign - Decide to directly sign the transaction or return the transaction block.
      * @param obligaionId - The obligation account object.
      * @param obligaionKeyId - The obligation key account object.
+     * @param sign - Decide to directly sign the transaction or return the transaction block.
      * @param walletAddress - The wallet address of the owner.
      * @return Transaction block response or transaction block
      */
-    unstakeObligation<S extends boolean>(coinName: SupportBorrowIncentiveCoins, obligaionId: string, obligaionKeyId: string, sign?: S, walletAddress?: string): Promise<ScallopClientFnReturnType<S>>;
+    unstakeObligation<S extends boolean>(obligaionId: string, obligaionKeyId: string, sign?: S, walletAddress?: string): Promise<ScallopClientFnReturnType<S>>;
     /**
      * unstake market coin from the specific spool.
      *

package/dist/models/scallopQuery.d.ts

@@ -151,14 +151,14 @@ export declare class ScallopQuery {
         ssui?: number | undefined;
         susdc?: number | undefined;
         susdt?: number | undefined;
+        safsui?: number | undefined;
+        shasui?: number | undefined;
+        svsui?: number | undefined;
         seth?: number | undefined;
         sbtc?: number | undefined;
         sapt?: number | undefined;
         ssol?: number | undefined;
         scetus?: number | undefined;
-        safsui?: number | undefined;
-        shasui?: number | undefined;
-        svsui?: number | undefined;
     }>;
     /**
      * Get market coin amount.
@@ -186,6 +186,9 @@ export declare class ScallopQuery {
         ssui?: import("../types").Spool | undefined;
         susdc?: import("../types").Spool | undefined;
         susdt?: import("../types").Spool | undefined;
+        safsui?: import("../types").Spool | undefined;
+        shasui?: import("../types").Spool | undefined;
+        svsui?: import("../types").Spool | undefined;
     }>;
     /**
      * Get spool data.
@@ -224,6 +227,9 @@ export declare class ScallopQuery {
         ssui?: import("../types").StakePool | undefined;
         susdc?: import("../types").StakePool | undefined;
         susdt?: import("../types").StakePool | undefined;
+        safsui?: import("../types").StakePool | undefined;
+        shasui?: import("../types").StakePool | undefined;
+        svsui?: import("../types").StakePool | undefined;
     }>;
     /**
      * Get stake pool (spool) data.
@@ -250,6 +256,9 @@ export declare class ScallopQuery {
         ssui?: import("../types").StakeRewardPool | undefined;
         susdc?: import("../types").StakeRewardPool | undefined;
         susdt?: import("../types").StakeRewardPool | undefined;
+        safsui?: import("../types").StakeRewardPool | undefined;
+        shasui?: import("../types").StakeRewardPool | undefined;
+        svsui?: import("../types").StakeRewardPool | undefined;
     }>;
     /**
      * Get stake reward pool data.

package/dist/queries/coreQuery.d.ts

@@ -154,14 +154,14 @@ export declare const getMarketCoinAmounts: (query: ScallopQuery, marketCoinNames
     ssui?: number | undefined;
     susdc?: number | undefined;
     susdt?: number | undefined;
+    safsui?: number | undefined;
+    shasui?: number | undefined;
+    svsui?: number | undefined;
     seth?: number | undefined;
     sbtc?: number | undefined;
     sapt?: number | undefined;
     ssol?: number | undefined;
     scetus?: number | undefined;
-    safsui?: number | undefined;
-    shasui?: number | undefined;
-    svsui?: number | undefined;
 }>;
 /**
  * Query owned market coin (sCoin) amount.

package/dist/queries/spoolQuery.d.ts

@@ -12,6 +12,9 @@ export declare const getSpools: (query: ScallopQuery, stakeMarketCoinNames?: Sup
     ssui?: Spool | undefined;
     susdc?: Spool | undefined;
     susdt?: Spool | undefined;
+    safsui?: Spool | undefined;
+    shasui?: Spool | undefined;
+    svsui?: Spool | undefined;
 }>;
 /**
  * Get spool data.

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

@@ -10,13 +10,13 @@ export type BorrowIncentiveIds = {
     obligationAccessStore: string;
 };
 export type BorrowIncentiveNormalMethods = {
-    stakeObligation: (obligation: SuiAddressArg, obligaionKey: SuiAddressArg, coinName: SupportBorrowIncentiveCoins) => void;
-    unstakeObligation: (obligation: SuiAddressArg, obligaionKey: SuiAddressArg, coinName: SupportBorrowIncentiveCoins) => void;
+    stakeObligation: (obligation: SuiAddressArg, obligaionKey: SuiAddressArg) => void;
+    unstakeObligation: (obligation: SuiAddressArg, obligaionKey: SuiAddressArg) => void;
     claimBorrowIncentive: (obligation: SuiAddressArg, obligaionKey: SuiAddressArg, coinName: SupportBorrowIncentiveCoins) => TransactionResult;
 };
 export type BorrowIncentiveQuickMethods = {
-    stakeObligationQuick(coinName: SupportBorrowIncentiveCoins, obligation?: SuiAddressArg, obligationKey?: SuiAddressArg): Promise<void>;
-    unstakeObligationQuick(coinName: SupportBorrowIncentiveCoins, obligation?: SuiAddressArg, obligationKey?: SuiAddressArg): Promise<void>;
+    stakeObligationQuick(obligation?: SuiAddressArg, obligationKey?: SuiAddressArg): Promise<void>;
+    unstakeObligationQuick(obligation?: SuiAddressArg, obligationKey?: SuiAddressArg): Promise<void>;
     claimBorrowIncentiveQuick(coinName: SupportBorrowIncentiveCoins, obligation?: SuiAddressArg, obligationKey?: SuiAddressArg): Promise<TransactionResult>;
 };
 export type SuiTxBlockWithBorrowIncentiveNormalMethods = SuiKitTxBlock & BorrowIncentiveNormalMethods;

package/dist/types/query/portfolio.d.ts

@@ -1,11 +1,12 @@
 import type { MarketPool } from './core';
+import type { Spool } from './spool';
 import type { SupportPoolCoins, SupportCollateralCoins } from '../constant';
 type OptionalKeys<T> = {
     [K in keyof T]?: T[K];
 };
 export type Lendings = OptionalKeys<Record<SupportPoolCoins, Lending>>;
 export type ObligationAccounts = OptionalKeys<Record<string, ObligationAccount>>;
-export type Lending = Required<Pick<MarketPool, 'coinName' | 'symbol' | 'coinType' | 'marketCoinType' | 'coinDecimal' | 'coinPrice'>> & {
+export type Lending = Required<Pick<MarketPool, 'coinName' | 'symbol' | 'coinType' | 'marketCoinType' | 'coinDecimal' | 'coinPrice' | 'conversionRate'> & Pick<Spool, 'marketCoinPrice'>> & {
     supplyApr: number;
     supplyApy: number;
     rewardApr: number;

package/package.json

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

package/src/builders/borrowIncentiveBuilder.ts

@@ -81,8 +81,10 @@ const generateBorrowIncentiveNormalMethod: GenerateBorrowIncentiveNormalMethod =
       obligationAccessStore: builder.address.get('core.obligationAccessStore'),
     };
     return {
-      stakeObligation: (obligationId, obligaionKey, coinName) => {
-        const rewardCoinName = borrowIncentiveRewardCoins[coinName];
+      stakeObligation: (obligationId, obligaionKey) => {
+        // NOTE: Pools without incentives also need to stake after change obligation,
+        // the default here use sui as reward coin.
+        const rewardCoinName = 'sui';
         const rewardType = builder.utils.parseCoinType(rewardCoinName);
         txBlock.moveCall(
           `${borrowIncentiveIds.borrowIncentivePkg}::user::stake`,
@@ -97,8 +99,10 @@ const generateBorrowIncentiveNormalMethod: GenerateBorrowIncentiveNormalMethod =
           [rewardType]
         );
       },
-      unstakeObligation: (obligationId, obligaionKey, coinName) => {
-        const rewardCoinName = borrowIncentiveRewardCoins[coinName];
+      unstakeObligation: (obligationId, obligaionKey) => {
+        // NOTE: Pools without incentives also need to unstake to change obligation,
+        // the default here use sui as reward coin.
+        const rewardCoinName = 'sui';
         const rewardType = builder.utils.parseCoinType(rewardCoinName);
         txBlock.moveCall(
           `${borrowIncentiveIds.borrowIncentivePkg}::user::unstake`,
@@ -145,7 +149,7 @@ const generateBorrowIncentiveNormalMethod: GenerateBorrowIncentiveNormalMethod =
 const generateBorrowIncentiveQuickMethod: GenerateBorrowIncentiveQuickMethod =
   ({ builder, txBlock }) => {
     return {
-      stakeObligationQuick: async (coinName, obligation, obligationKey) => {
+      stakeObligationQuick: async (obligation, obligationKey) => {
         const {
           obligationId: obligationArg,
           obligationKey: obligationtKeyArg,
@@ -166,10 +170,10 @@ const generateBorrowIncentiveQuickMethod: GenerateBorrowIncentiveQuickMethod =
           );
 
         if (!obligationLocked || unstakeObligationBeforeStake) {
-          txBlock.stakeObligation(obligationArg, obligationtKeyArg, coinName);
+          txBlock.stakeObligation(obligationArg, obligationtKeyArg);
         }
       },
-      unstakeObligationQuick: async (coinName, obligation, obligationKey) => {
+      unstakeObligationQuick: async (obligation, obligationKey) => {
         const {
           obligationId: obligationArg,
           obligationKey: obligationtKeyArg,
@@ -182,7 +186,7 @@ const generateBorrowIncentiveQuickMethod: GenerateBorrowIncentiveQuickMethod =
         );
 
         if (obligationLocked) {
-          txBlock.unstakeObligation(obligationArg, obligationtKeyArg, coinName);
+          txBlock.unstakeObligation(obligationArg, obligationtKeyArg);
         }
       },
       claimBorrowIncentiveQuick: async (

package/src/builders/spoolBuilder.ts

@@ -21,7 +21,7 @@ import type {
  * Check and get stake account id from transaction block.
  *
  * @description
- * If the stake account id is provided, direactly return it.
+ * If the stake account id is provided, directly return it.
  * Otherwise, automatically get all stake account id from the sender.
  *
  * @param builder - Scallop builder instance.
@@ -52,7 +52,7 @@ const requireStakeAccountIds = async (
  * Check and get stake accounts information from transaction block.
  *
  * @description
- * If the stake account id is provided, direactly return its account.
+ * If the stake account id is provided, directly return its account.
  * Otherwise, automatically get all stake account from the sender.
  *
  * @param builder - Scallop builder instance.

package/src/constants/common.ts

@@ -37,7 +37,14 @@ export const SUPPORT_COLLATERALS = [
   'vsui',
 ] as const;
 
-export const SUPPORT_SPOOLS = ['ssui', 'susdc', 'susdt'] as const;
+export const SUPPORT_SPOOLS = [
+  'ssui',
+  'susdc',
+  'susdt',
+  'safsui',
+  'shasui',
+  'svsui',
+] as const;
 
 export const SUPPORT_SPOOLS_REWARDS = ['sui'] as const;
 

package/src/constants/enum.ts

@@ -67,12 +67,18 @@ export const stakeMarketCoins: StakeMarketCoins = {
   ssui: 'ssui',
   susdc: 'susdc',
   susdt: 'susdt',
+  safsui: 'safsui',
+  shasui: 'shasui',
+  svsui: 'svsui',
 };
 
 export const spoolRewardCoins: StakeRewardCoins = {
   ssui: 'sui',
   susdc: 'sui',
   susdt: 'sui',
+  safsui: 'sui',
+  shasui: 'sui',
+  svsui: 'sui',
 };
 
 export const borrowIncentiveRewardCoins: BorrowIncentiveRewardCoins = {

package/src/models/scallopAddress.ts

@@ -199,6 +199,22 @@ const EMPTY_ADDRESSES: AddressesInterface = {
         id: '',
         rewardPoolId: '',
       },
+      susdt: {
+        id: '',
+        rewardPoolId: '',
+      },
+      safsui: {
+        id: '',
+        rewardPoolId: '',
+      },
+      shasui: {
+        id: '',
+        rewardPoolId: '',
+      },
+      svsui: {
+        id: '',
+        rewardPoolId: '',
+      },
     },
   },
   borrowIncentive: {

package/src/models/scallopBuilder.ts

@@ -73,14 +73,14 @@ export class ScallopBuilder {
   /**
    * Request the scallop API to initialize data.
    *
-   * @param forece - Whether to force initialization.
+   * @param force - Whether to force initialization.
    */
-  public async init(forece: boolean = false) {
-    if (forece || !this.address.getAddresses()) {
+  public async init(force: boolean = false) {
+    if (force || !this.address.getAddresses()) {
       await this.address.read();
     }
-    await this.query.init(forece);
-    await this.utils.init(forece);
+    await this.query.init(force);
+    await this.utils.init(force);
   }
 
   /**

package/src/models/scallopClient.ts

@@ -485,11 +485,7 @@ export class ScallopClient {
       SUPPORT_BORROW_INCENTIVE_POOLS as readonly SupportPoolCoins[]
     ).includes(poolCoinName);
     if (sign && availableStake) {
-      await txBlock.unstakeObligationQuick(
-        poolCoinName as SupportBorrowIncentiveCoins,
-        obligationId,
-        obligationKey
-      );
+      await txBlock.unstakeObligationQuick(obligationId, obligationKey);
     }
     const coin = await txBlock.borrowQuick(
       amount,
@@ -499,11 +495,7 @@ export class ScallopClient {
     );
     txBlock.transferObjects([coin], sender);
     if (sign && availableStake) {
-      await txBlock.stakeObligationQuick(
-        poolCoinName as SupportBorrowIncentiveCoins,
-        obligationId,
-        obligationKey
-      );
+      await txBlock.stakeObligationQuick(obligationId, obligationKey);
     }
 
     if (sign) {
@@ -541,19 +533,11 @@ export class ScallopClient {
       SUPPORT_BORROW_INCENTIVE_POOLS as readonly SupportPoolCoins[]
     ).includes(poolCoinName);
     if (sign && availableStake) {
-      await txBlock.unstakeObligationQuick(
-        poolCoinName as SupportBorrowIncentiveCoins,
-        obligationId,
-        obligationKey
-      );
+      await txBlock.unstakeObligationQuick(obligationId, obligationKey);
     }
     await txBlock.repayQuick(amount, poolCoinName, obligationId);
     if (sign && availableStake) {
-      await txBlock.stakeObligationQuick(
-        poolCoinName as SupportBorrowIncentiveCoins,
-        obligationId,
-        obligationKey
-      );
+      await txBlock.stakeObligationQuick(obligationId, obligationKey);
     }
 
     if (sign) {
@@ -860,14 +844,13 @@ export class ScallopClient {
   /**
    * stake obligaion.
    *
-   * @param sign - Decide to directly sign the transaction or return the transaction block.
    * @param obligaionId - The obligation account object.
    * @param obligaionKeyId - The obligation key account object.
+   * @param sign - Decide to directly sign the transaction or return the transaction block.
    * @param walletAddress - The wallet address of the owner.
    * @return Transaction block response or transaction block
    */
   public async stakeObligation<S extends boolean>(
-    coinName: SupportBorrowIncentiveCoins,
     obligaionId: string,
     obligaionKeyId: string,
     sign: S = true as S,
@@ -877,7 +860,7 @@ export class ScallopClient {
     const sender = walletAddress || this.walletAddress;
     txBlock.setSender(sender);
 
-    await txBlock.stakeObligationQuick(coinName, obligaionId, obligaionKeyId);
+    await txBlock.stakeObligationQuick(obligaionId, obligaionKeyId);
 
     if (sign) {
       return (await this.suiKit.signAndSendTxn(
@@ -891,14 +874,13 @@ export class ScallopClient {
   /**
    * unstake obligaion.
    *
-   * @param sign - Decide to directly sign the transaction or return the transaction block.
    * @param obligaionId - The obligation account object.
    * @param obligaionKeyId - The obligation key account object.
+   * @param sign - Decide to directly sign the transaction or return the transaction block.
    * @param walletAddress - The wallet address of the owner.
    * @return Transaction block response or transaction block
    */
   public async unstakeObligation<S extends boolean>(
-    coinName: SupportBorrowIncentiveCoins,
     obligaionId: string,
     obligaionKeyId: string,
     sign: S = true as S,
@@ -908,7 +890,7 @@ export class ScallopClient {
     const sender = walletAddress || this.walletAddress;
     txBlock.setSender(sender);
 
-    await txBlock.unstakeObligationQuick(coinName, obligaionId, obligaionKeyId);
+    await txBlock.unstakeObligationQuick(obligaionId, obligaionKeyId);
 
     if (sign) {
       return (await this.suiKit.signAndSendTxn(

package/src/queries/portfolioQuery.ts

@@ -200,6 +200,9 @@ export const getLending = async (
   const suppliedCoin = suppliedAmount.shiftedBy(-1 * coinDecimal);
   const suppliedValue = suppliedCoin.multipliedBy(coinPrice ?? 0);
 
+  const marketCoinPrice = BigNumber(coinPrice ?? 0).multipliedBy(
+    marketPool?.conversionRate ?? 1
+  );
   const unstakedMarketAmount = BigNumber(marketCoinAmount);
   const unstakedMarketCoin = unstakedMarketAmount.shiftedBy(-1 * coinDecimal);
 
@@ -221,6 +224,8 @@ export const getLending = async (
     marketCoinType: query.utils.parseMarketCoinType(poolCoinName),
     coinDecimal: coinDecimal,
     coinPrice: coinPrice ?? 0,
+    conversionRate: marketPool?.conversionRate ?? 1,
+    marketCoinPrice: marketCoinPrice.toNumber(),
     supplyApr: marketPool?.supplyApr ?? 0,
     supplyApy: marketPool?.supplyApy ?? 0,
     rewardApr: spool?.rewardApr ?? 0,

package/src/queries/spoolQuery.ts

@@ -292,6 +292,9 @@ export const getStakeAccounts = async (
     ssui: [],
     susdc: [],
     susdt: [],
+    safsui: [],
+    shasui: [],
+    svsui: [],
   };
 
   const stakeMarketCoinTypes: Record<SupportStakeMarketCoins, string> =
@@ -357,6 +360,39 @@ export const getStakeAccounts = async (
           points,
           totalPoints,
         });
+      } else if (normalizeStructTag(type) === stakeMarketCoinTypes.safsui) {
+        stakeAccounts.safsui.push({
+          id,
+          type: normalizeStructTag(type),
+          stakePoolId,
+          stakeType: normalizeStructTag(stakeType),
+          staked,
+          index,
+          points,
+          totalPoints,
+        });
+      } else if (normalizeStructTag(type) === stakeMarketCoinTypes.shasui) {
+        stakeAccounts.shasui.push({
+          id,
+          type: normalizeStructTag(type),
+          stakePoolId,
+          stakeType: normalizeStructTag(stakeType),
+          staked,
+          index,
+          points,
+          totalPoints,
+        });
+      } else if (normalizeStructTag(type) === stakeMarketCoinTypes.svsui) {
+        stakeAccounts.svsui.push({
+          id,
+          type: normalizeStructTag(type),
+          stakePoolId,
+          stakeType: normalizeStructTag(stakeType),
+          staked,
+          index,
+          points,
+          totalPoints,
+        });
       }
     }
   }

package/src/types/builder/borrowIncentive.ts

@@ -17,13 +17,11 @@ export type BorrowIncentiveIds = {
 export type BorrowIncentiveNormalMethods = {
   stakeObligation: (
     obligation: SuiAddressArg,
-    obligaionKey: SuiAddressArg,
-    coinName: SupportBorrowIncentiveCoins
+    obligaionKey: SuiAddressArg
   ) => void;
   unstakeObligation: (
     obligation: SuiAddressArg,
-    obligaionKey: SuiAddressArg,
-    coinName: SupportBorrowIncentiveCoins
+    obligaionKey: SuiAddressArg
   ) => void;
   claimBorrowIncentive: (
     obligation: SuiAddressArg,
@@ -34,12 +32,10 @@ export type BorrowIncentiveNormalMethods = {
 
 export type BorrowIncentiveQuickMethods = {
   stakeObligationQuick(
-    coinName: SupportBorrowIncentiveCoins,
     obligation?: SuiAddressArg,
     obligationKey?: SuiAddressArg
   ): Promise<void>;
   unstakeObligationQuick(
-    coinName: SupportBorrowIncentiveCoins,
     obligation?: SuiAddressArg,
     obligationKey?: SuiAddressArg
   ): Promise<void>;

package/src/types/query/portfolio.ts

@@ -1,4 +1,5 @@
 import type { MarketPool } from './core';
+import type { Spool } from './spool';
 import type { SupportPoolCoins, SupportCollateralCoins } from '../constant';
 
 type OptionalKeys<T> = {
@@ -19,7 +20,9 @@ export type Lending = Required<
     | 'marketCoinType'
     | 'coinDecimal'
     | 'coinPrice'
-  >
+    | 'conversionRate'
+  > &
+    Pick<Spool, 'marketCoinPrice'>
 > & {
   supplyApr: number;
   supplyApy: number;