@scallop-io/sui-scallop-sdk 0.44.14 → 0.44.16

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/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/query/borrowIncentive.d.ts

@@ -59,8 +59,6 @@ export type OriginBorrowIncentiveRewardPoolData = {
     claimed_rewards: string;
     exchange_rate_denominator: string;
     exchange_rate_numerator: string;
-    rewards_fee_rate_denominator: string;
-    rewards_fee_rate_numerator: string;
     remaining_reward: string;
     reward_type: {
         name: string;
@@ -71,8 +69,6 @@ export type ParsedBorrowIncentiveRewardPoolData = {
     claimedRewards: number;
     exchangeRateDenominator: number;
     exchangeRateNumerator: number;
-    rewardsFeeRateDenominator: number;
-    rewardsFeeRateNumerator: number;
     remainingRewards: number;
 };
 export type CalculatedBorrowIncentiveRewardPoolData = {
@@ -87,7 +83,6 @@ export type CalculatedBorrowIncentiveRewardPoolData = {
     claimedRewardCoin: number;
     claimedRewardValue: number;
     rewardPerSec: number;
-    rewardFee: number;
 };
 export type BorrowIncentiveAccounts = OptionalKeys<Record<SupportBorrowIncentiveCoins, ParsedBorrowIncentiveAccountData>>;
 export type OriginBorrowIncentiveAccountData = {

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/dist/types/query/spool.d.ts

@@ -59,8 +59,6 @@ export type OriginSpoolRewardPoolData = {
     claimed_rewards: string;
     exchange_rate_denominator: string;
     exchange_rate_numerator: string;
-    fee_rate_denominator: string;
-    fee_rate_numerator: string;
     rewards: string;
     spool_id: string;
 };
@@ -68,8 +66,6 @@ export type ParsedSpoolRewardPoolData = {
     claimedRewards: number;
     exchangeRateDenominator: number;
     exchangeRateNumerator: number;
-    feeRateDenominator: number;
-    feeRateNumerator: number;
     rewards: number;
     spoolId: string;
 };
@@ -85,7 +81,6 @@ export type CalculatedSpoolRewardPoolData = {
     claimedRewardCoin: number;
     claimedRewardValue: number;
     rewardPerSec: number;
-    rewardFee: number;
 };
 export type StakePools = OptionalKeys<Record<SupportStakeMarketCoins, StakePool>>;
 export type StakeRewardPools = OptionalKeys<Record<SupportStakeMarketCoins, StakeRewardPool>>;
@@ -120,8 +115,6 @@ export interface StakeRewardPool {
     stakePoolId: string;
     ratioDenominator: number;
     ratioNumerator: number;
-    feeRateDenominator: number;
-    feeRateNumerator: number;
     rewards: number;
     claimedRewards: number;
 }

package/package.json

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

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/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

@@ -111,7 +111,6 @@ export const getSpool = async (
 ) => {
   const coinName = query.utils.parseCoinName<SupportStakeCoins>(marketCoinName);
   marketPool = marketPool || (await query.getMarketPool(coinName, indexer));
-  const spoolPkgId = query.address.get(`spool.id`);
   const poolId = query.address.get(`spool.pools.${marketCoinName}.id`);
   const rewardPoolId = query.address.get(
     `spool.pools.${marketCoinName}.rewardPoolId`
@@ -140,15 +139,6 @@ export const getSpool = async (
       showContent: true,
     },
   });
-  const spoolRewardFeeDynamicFieldsResponse = await query.suiKit
-    .client()
-    .getDynamicFieldObject({
-      parentId: rewardPoolId,
-      name: {
-        type: `${spoolPkgId}::rewards_pool::RewardsPoolFeeKey`,
-        value: { dummy_field: false },
-      },
-    });
 
   if (
     marketPool &&
@@ -162,7 +152,6 @@ export const getSpool = async (
 
     const spoolObject = spoolObjectResponse[0].data;
     const rewardPoolObject = spoolObjectResponse[1].data;
-    const rewardFeeObject = spoolRewardFeeDynamicFieldsResponse.data;
     if (spoolObject.content && 'fields' in spoolObject.content) {
       const spoolFields = spoolObject.content.fields as any;
       const parsedSpoolData = parseOriginSpoolData({
@@ -187,21 +176,12 @@ export const getSpool = async (
         marketCoinDecimal
       );
 
-      if (
-        rewardPoolObject.content &&
-        rewardFeeObject?.content &&
-        'fields' in rewardPoolObject.content &&
-        'fields' in rewardFeeObject.content
-      ) {
+      if (rewardPoolObject.content && 'fields' in rewardPoolObject.content) {
         const rewardPoolFields = rewardPoolObject.content.fields as any;
-        const rewardFeeFields = (rewardFeeObject.content.fields as any).value
-          .fields;
         const parsedSpoolRewardPoolData = parseOriginSpoolRewardPoolData({
           claimed_rewards: rewardPoolFields.claimed_rewards,
           exchange_rate_numerator: rewardPoolFields.exchange_rate_numerator,
           exchange_rate_denominator: rewardPoolFields.exchange_rate_denominator,
-          fee_rate_numerator: rewardFeeFields.fee_rate_numerator,
-          fee_rate_denominator: rewardFeeFields.fee_rate_denominator,
           rewards: rewardPoolFields.rewards,
           spool_id: rewardPoolFields.spool_id,
         });
@@ -292,6 +272,9 @@ export const getStakeAccounts = async (
     ssui: [],
     susdc: [],
     susdt: [],
+    safsui: [],
+    shasui: [],
+    svsui: [],
   };
 
   const stakeMarketCoinTypes: Record<SupportStakeMarketCoins, string> =
@@ -357,6 +340,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,
+        });
       }
     }
   }
@@ -437,7 +453,6 @@ export const getStakeRewardPool = async (
   query: ScallopQuery,
   marketCoinName: SupportStakeMarketCoins
 ) => {
-  const spoolPkgId = query.address.get('spool.id');
   const poolId = query.address.get(
     `spool.pools.${marketCoinName}.rewardPoolId`
   );
@@ -449,34 +464,15 @@ export const getStakeRewardPool = async (
       showType: true,
     },
   });
-  const stakeRewardFeeDynamicFieldsResponse = await query.suiKit
-    .client()
-    .getDynamicFieldObject({
-      parentId: poolId,
-      name: {
-        type: `${spoolPkgId}::rewards_pool::RewardsPoolFeeKey`,
-        value: { dummy_field: false },
-      },
-    });
-  if (
-    stakeRewardPoolObjectResponse.data &&
-    stakeRewardFeeDynamicFieldsResponse.data
-  ) {
+  if (stakeRewardPoolObjectResponse.data) {
     const stakeRewardPoolObject = stakeRewardPoolObjectResponse.data;
-    const stakeRewardFeeDynamicFieldObject =
-      stakeRewardFeeDynamicFieldsResponse.data;
     const id = stakeRewardPoolObject.objectId;
     const type = stakeRewardPoolObject.type!;
     if (
       stakeRewardPoolObject.content &&
-      stakeRewardFeeDynamicFieldObject.content &&
-      'fields' in stakeRewardPoolObject.content &&
-      'fields' in stakeRewardFeeDynamicFieldObject.content
+      'fields' in stakeRewardPoolObject.content
     ) {
       const rewardPoolFields = stakeRewardPoolObject.content.fields as any;
-      const rewardFeeFields = (
-        stakeRewardFeeDynamicFieldObject.content.fields as any
-      ).value.fields;
       const stakePoolId = String(rewardPoolFields.spool_id);
       const ratioNumerator = Number(rewardPoolFields.exchange_rate_numerator);
       const ratioDenominator = Number(
@@ -484,8 +480,6 @@ export const getStakeRewardPool = async (
       );
       const rewards = Number(rewardPoolFields.rewards);
       const claimedRewards = Number(rewardPoolFields.claimed_rewards);
-      const feeRateNumerator = Number(rewardFeeFields.fee_rate_numerator);
-      const feeRateDenominator = Number(rewardFeeFields.fee_rate_denominator);
 
       stakeRewardPool = {
         id,
@@ -493,8 +487,6 @@ export const getStakeRewardPool = async (
         stakePoolId,
         ratioNumerator,
         ratioDenominator,
-        feeRateNumerator,
-        feeRateDenominator,
         rewards,
         claimedRewards,
       };

package/src/types/query/borrowIncentive.ts

@@ -83,8 +83,6 @@ export type OriginBorrowIncentiveRewardPoolData = {
   claimed_rewards: string;
   exchange_rate_denominator: string;
   exchange_rate_numerator: string;
-  rewards_fee_rate_denominator: string;
-  rewards_fee_rate_numerator: string;
   remaining_reward: string;
   reward_type: {
     name: string;
@@ -96,8 +94,6 @@ export type ParsedBorrowIncentiveRewardPoolData = {
   claimedRewards: number;
   exchangeRateDenominator: number;
   exchangeRateNumerator: number;
-  rewardsFeeRateDenominator: number;
-  rewardsFeeRateNumerator: number;
   remainingRewards: number;
 };
 
@@ -113,7 +109,6 @@ export type CalculatedBorrowIncentiveRewardPoolData = {
   claimedRewardCoin: number;
   claimedRewardValue: number;
   rewardPerSec: number;
-  rewardFee: number;
 };
 
 export type BorrowIncentiveAccounts = OptionalKeys<

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;

package/src/types/query/spool.ts

@@ -73,8 +73,6 @@ export type OriginSpoolRewardPoolData = {
   claimed_rewards: string;
   exchange_rate_denominator: string;
   exchange_rate_numerator: string;
-  fee_rate_denominator: string;
-  fee_rate_numerator: string;
   rewards: string;
   spool_id: string;
 };
@@ -83,8 +81,6 @@ export type ParsedSpoolRewardPoolData = {
   claimedRewards: number;
   exchangeRateDenominator: number;
   exchangeRateNumerator: number;
-  feeRateDenominator: number;
-  feeRateNumerator: number;
   rewards: number;
   spoolId: string;
 };
@@ -101,7 +97,6 @@ export type CalculatedSpoolRewardPoolData = {
   claimedRewardCoin: number;
   claimedRewardValue: number;
   rewardPerSec: number;
-  rewardFee: number;
 };
 
 export type StakePools = OptionalKeys<
@@ -144,8 +139,6 @@ export interface StakeRewardPool {
   stakePoolId: string;
   ratioDenominator: number;
   ratioNumerator: number;
-  feeRateDenominator: number;
-  feeRateNumerator: number;
   rewards: number;
   claimedRewards: number;
 }

package/src/utils/query.ts

@@ -320,8 +320,6 @@ export const parseOriginSpoolRewardPoolData = (
     exchangeRateNumerator: Number(
       originSpoolRewardPoolData.exchange_rate_numerator
     ),
-    feeRateDenominator: Number(originSpoolRewardPoolData.fee_rate_denominator),
-    feeRateNumerator: Number(originSpoolRewardPoolData.fee_rate_numerator),
     rewards: Number(originSpoolRewardPoolData.rewards),
     spoolId: String(originSpoolRewardPoolData.spool_id),
   };
@@ -366,9 +364,6 @@ export const calculateSpoolRewardPoolData = (
     .isFinite()
     ? rewardValueForYear.dividedBy(calculatedSpoolData.stakedValue).toNumber()
     : Infinity;
-  const rewardFeeRate = BigNumber(parsedSpoolRewardPoolData.feeRateNumerator)
-    .dividedBy(parsedSpoolRewardPoolData.feeRateDenominator)
-    .toNumber();
 
   return {
     rewardApr: rewardRate,
@@ -382,7 +377,6 @@ export const calculateSpoolRewardPoolData = (
     claimedRewardCoin: claimedRewardCoin.toNumber(),
     claimedRewardValue: claimedRewardValue.toNumber(),
     rewardPerSec: rewardPerSec.toNumber(),
-    rewardFee: rewardFeeRate,
   };
 };
 
@@ -498,12 +492,6 @@ export const parseOriginBorrowIncentiveRewardPoolData = (
     exchangeRateDenominator: Number(
       originBorrowIncentiveRewardPoolData.exchange_rate_denominator
     ),
-    rewardsFeeRateNumerator: Number(
-      originBorrowIncentiveRewardPoolData.rewards_fee_rate_numerator
-    ),
-    rewardsFeeRateDenominator: Number(
-      originBorrowIncentiveRewardPoolData.rewards_fee_rate_denominator
-    ),
     remainingRewards: Number(
       originBorrowIncentiveRewardPoolData.remaining_reward
     ),
@@ -555,11 +543,6 @@ export const calculateBorrowIncentiveRewardPoolData = (
         .dividedBy(calculatedBorrowIncentivePoolData.stakedValue)
         .toNumber()
     : Infinity;
-  const rewardFeeRate = BigNumber(
-    parsedBorrowIncentiveRewardPoolData.rewardsFeeRateNumerator
-  )
-    .dividedBy(parsedBorrowIncentiveRewardPoolData.rewardsFeeRateDenominator)
-    .toNumber();
 
   return {
     rewardApr: rewardRate,
@@ -573,7 +556,6 @@ export const calculateBorrowIncentiveRewardPoolData = (
     claimedRewardCoin: claimedRewardCoin.toNumber(),
     claimedRewardValue: claimedRewardValue.toNumber(),
     rewardPerSec: rewardPerSec.toNumber(),
-    rewardFee: rewardFeeRate,
   };
 };