@scallop-io/sui-scallop-sdk 0.44.3 → 0.44.5

package/dist/types/address.d.ts

@@ -4,6 +4,7 @@ export interface AddressesInterface {
     core: {
         version: string;
         versionCap: string;
+        object: string;
         market: string;
         adminCap: string;
         coinDecimalsRegistry: string;
@@ -46,6 +47,7 @@ export interface AddressesInterface {
     spool: {
         id: string;
         adminCap: string;
+        object: string;
         pools: Partial<Record<SupportStakeMarketCoins, {
             id: string;
             rewardPoolId: string;
@@ -54,6 +56,7 @@ export interface AddressesInterface {
     borrowIncentive: {
         id: string;
         adminCap: string;
+        object: string;
         query: string;
         incentivePools: string;
         incentiveAccounts: string;

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

@@ -59,6 +59,8 @@ 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;
@@ -67,8 +69,10 @@ export type OriginBorrowIncentiveRewardPoolData = {
 export type ParsedBorrowIncentiveRewardPoolData = {
     rewardType: string;
     claimedRewards: number;
-    exchangeRateNumerator: number;
     exchangeRateDenominator: number;
+    exchangeRateNumerator: number;
+    rewardsFeeRateDenominator: number;
+    rewardsFeeRateNumerator: number;
     remainingRewards: number;
 };
 export type CalculatedBorrowIncentiveRewardPoolData = {
@@ -83,6 +87,7 @@ 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/core.d.ts

@@ -43,6 +43,11 @@ export type InterestModel = {
             value: string;
         };
     };
+    borrow_fee_rate: {
+        fields: {
+            value: string;
+        };
+    };
     high_kink: {
         fields: {
             value: string;
@@ -115,7 +120,7 @@ export type MarketPool = {
     coinWrappedType: CoinWrappedType;
     coinDecimal: number;
     coinPrice: number;
-} & Required<Pick<ParsedMarketPoolData, 'highKink' | 'midKink' | 'reserveFactor' | 'borrowWeight' | 'marketCoinSupplyAmount' | 'minBorrowAmount'>> & CalculatedMarketPoolData;
+} & Required<Pick<ParsedMarketPoolData, 'highKink' | 'midKink' | 'reserveFactor' | 'borrowWeight' | 'borrowFee' | 'marketCoinSupplyAmount' | 'minBorrowAmount'>> & CalculatedMarketPoolData;
 export type MarketCollateral = {
     coinName: SupportCollateralCoins;
     symbol: string;
@@ -148,6 +153,9 @@ export type OriginMarketPoolData = {
     borrowWeight: {
         value: string;
     };
+    borrowFeeRate: {
+        value: string;
+    };
     baseBorrowRatePerSec: {
         value: string;
     };
@@ -178,6 +186,7 @@ export type ParsedMarketPoolData = {
     reserveAmount: number;
     reserveFactor: number;
     borrowWeight: number;
+    borrowFee: number;
     baseBorrowRate: number;
     borrowRateOnHighKink: number;
     borrowRateOnMidKink: number;
@@ -319,6 +328,9 @@ export interface MarketQueryInterface {
         borrowWeight: {
             value: string;
         };
+        borrowFeeRate: {
+            value: string;
+        };
         type: {
             name: string;
         };

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

@@ -48,6 +48,7 @@ export type ObligationAccount = {
     totalBorrowedPools: number;
     collaterals: OptionalKeys<Record<SupportCollateralCoins, ObligationCollateral>>;
     debts: OptionalKeys<Record<SupportPoolCoins, ObligationDebt>>;
+    borrowIncentives: OptionalKeys<Record<SupportPoolCoins, ObligationBorrowIncentive>>;
 };
 export type ObligationCollateral = {
     coinName: SupportCollateralCoins;
@@ -81,6 +82,18 @@ export type ObligationDebt = {
     availableRepayAmount: number;
     availableRepayCoin: number;
 };
+export type ObligationBorrowIncentive = {
+    coinName: SupportPoolCoins;
+    coinType: string;
+    rewardCoinType: string;
+    symbol: string;
+    coinDecimal: number;
+    rewardCoinDecimal: number;
+    coinPrice: number;
+    rewardCoinPrice: number;
+    availableClaimAmount: number;
+    availableClaimCoin: number;
+};
 export type TotalValueLocked = {
     supplyValue: number;
     borrowValue: number;

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

@@ -59,13 +59,17 @@ 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;
 };
 export type ParsedSpoolRewardPoolData = {
     claimedRewards: number;
-    exchangeRateNumerator: number;
     exchangeRateDenominator: number;
+    exchangeRateNumerator: number;
+    feeRateDenominator: number;
+    feeRateNumerator: number;
     rewards: number;
     spoolId: string;
 };
@@ -81,6 +85,7 @@ 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>>;
@@ -113,8 +118,10 @@ export interface StakeRewardPool {
     id: string;
     type: string;
     stakePoolId: string;
-    ratioNumerator: number;
     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.3",
+  "version": "0.44.5",
   "description": "Typescript sdk for interacting with Scallop contract on SUI",
   "keywords": [
     "sui",

package/src/constants/common.ts

@@ -5,6 +5,9 @@ export const ADDRESSES_ID = '6462a088a7ace142bb6d7e9b';
 export const PROTOCOL_OBJECT_ID =
   '0xefe8b36d5b2e43728cc323298626b83177803521d195cfb11e15b910e892fddf';
 
+export const BORROW_FEE_PROTOCOL_ID =
+  '0xc38f849e81cfe46d4e4320f508ea7dda42934a329d5a6571bb4c3cb6ea63f5da';
+
 export const SUPPORT_POOLS = [
   'eth',
   'btc',

package/src/models/scallopAddress.ts

@@ -11,6 +11,7 @@ const EMPTY_ADDRESSES: AddressesInterface = {
   core: {
     version: '',
     versionCap: '',
+    object: '',
     market: '',
     adminCap: '',
     coinDecimalsRegistry: '',
@@ -188,6 +189,7 @@ const EMPTY_ADDRESSES: AddressesInterface = {
   spool: {
     id: '',
     adminCap: '',
+    object: '',
     pools: {
       ssui: {
         id: '',
@@ -202,6 +204,7 @@ const EMPTY_ADDRESSES: AddressesInterface = {
   borrowIncentive: {
     id: '',
     adminCap: '',
+    object: '',
     query: '',
     incentivePools: '',
     incentiveAccounts: '',

package/src/models/scallopUtils.ts

@@ -159,8 +159,10 @@ export class ScallopUtils {
    * @return Market coin type.
    */
   public parseMarketCoinType(coinName: SupportCoins) {
+    const protocolObjectId =
+      this._address.get('core.object') || PROTOCOL_OBJECT_ID;
     const coinType = this.parseCoinType(coinName);
-    return `${PROTOCOL_OBJECT_ID}::reserve::MarketCoin<${coinType}>`;
+    return `${protocolObjectId}::reserve::MarketCoin<${coinType}>`;
   }
 
   /**

package/src/queries/borrowIncentiveQuery.ts

@@ -1,3 +1,4 @@
+import { normalizeStructTag } from '@mysten/sui.js/utils';
 import { SuiTxBlock as SuiKitTxBlock } from '@scallop-io/sui-kit';
 import { SUPPORT_BORROW_INCENTIVE_POOLS } from '../constants';
 import {
@@ -49,7 +50,7 @@ export const queryBorrowIncentivePools = async (
 
   const borrowIncentivePools: BorrowIncentivePools = {};
   for (const pool of borrowIncentivePoolsQueryData.incentive_pools) {
-    const coinType = '0x' + pool.pool_type.name;
+    const coinType = normalizeStructTag(pool.pool_type.name);
     const coinName =
       query.utils.parseCoinNameFromType<SupportBorrowIncentiveCoins>(coinType);
     const rewardCoinName =

package/src/queries/coreQuery.ts

@@ -1,9 +1,11 @@
+import { normalizeStructTag } from '@mysten/sui.js/utils';
 import { SuiTxBlock as SuiKitTxBlock } from '@scallop-io/sui-kit';
 import BigNumber from 'bignumber.js';
 import {
   SUPPORT_POOLS,
   PROTOCOL_OBJECT_ID,
   SUPPORT_COLLATERALS,
+  BORROW_FEE_PROTOCOL_ID,
 } from '../constants';
 import {
   parseOriginMarketPoolData,
@@ -59,7 +61,7 @@ export const queryMarket = async (query: ScallopQuery) => {
   const collaterals: MarketCollaterals = {};
 
   for (const pool of marketData.pools) {
-    const coinType = '0x' + pool.type.name;
+    const coinType = normalizeStructTag(pool.type.name);
     const poolCoinName =
       query.utils.parseCoinNameFromType<SupportPoolCoins>(coinType);
     const coinPrice =
@@ -83,6 +85,7 @@ export const queryMarket = async (query: ScallopQuery) => {
       reserve: pool.reserve,
       reserveFactor: pool.reserveFactor,
       borrowWeight: pool.borrowWeight,
+      borrowFeeRate: pool.borrowFeeRate,
       baseBorrowRatePerSec: pool.baseBorrowRatePerSec,
       borrowRateOnHighKink: pool.borrowRateOnHighKink,
       borrowRateOnMidKink: pool.borrowRateOnMidKink,
@@ -108,6 +111,7 @@ export const queryMarket = async (query: ScallopQuery) => {
       midKink: parsedMarketPoolData.midKink,
       reserveFactor: parsedMarketPoolData.reserveFactor,
       borrowWeight: parsedMarketPoolData.borrowWeight,
+      borrowFee: parsedMarketPoolData.borrowFee,
       marketCoinSupplyAmount: parsedMarketPoolData.marketCoinSupplyAmount,
       minBorrowAmount: parsedMarketPoolData.minBorrowAmount,
       ...calculatedMarketPoolData,
@@ -115,7 +119,7 @@ export const queryMarket = async (query: ScallopQuery) => {
   }
 
   for (const collateral of marketData.collaterals) {
-    const coinType = '0x' + collateral.type.name;
+    const coinType = normalizeStructTag(collateral.type.name);
     const collateralCoinName =
       query.utils.parseCoinNameFromType<SupportCollateralCoins>(coinType);
     const coinPrice =
@@ -242,6 +246,7 @@ export const getMarketPool = async (
   let balanceSheet: BalanceSheet | undefined;
   let borrowIndex: BorrowIndex | undefined;
   let interestModel: InterestModel | undefined;
+  let borrowFeeRate: { value: string } | undefined;
   if (marketObject) {
     if (marketObject.content && 'fields' in marketObject.content) {
       const fields = marketObject.content.fields as any;
@@ -324,10 +329,36 @@ export const getMarketPool = async (
           .fields as any;
         interestModel = dynamicFields.value.fields;
       }
+
+      // Get borrow fee.
+      const borrowFeeDynamicFieldObjectResponse = await query.suiKit
+        .client()
+        .getDynamicFieldObject({
+          parentId: marketId,
+          name: {
+            type: `${BORROW_FEE_PROTOCOL_ID}::market_dynamic_keys::BorrowFeeKey`,
+            value: {
+              type: {
+                name: coinType.substring(2),
+              },
+            },
+          },
+        });
+
+      const borrowFeeDynamicFieldObject =
+        borrowFeeDynamicFieldObjectResponse.data;
+      if (
+        borrowFeeDynamicFieldObject &&
+        borrowFeeDynamicFieldObject.content &&
+        'fields' in borrowFeeDynamicFieldObject.content
+      ) {
+        const dynamicFields = borrowFeeDynamicFieldObject.content.fields as any;
+        borrowFeeRate = dynamicFields.value.fields;
+      }
     }
   }
 
-  if (balanceSheet && borrowIndex && interestModel) {
+  if (balanceSheet && borrowIndex && interestModel && borrowFeeRate) {
     const parsedMarketPoolData = parseOriginMarketPoolData({
       type: interestModel.type.fields,
       maxBorrowRate: interestModel.max_borrow_rate.fields,
@@ -341,6 +372,7 @@ export const getMarketPool = async (
       reserve: balanceSheet.revenue,
       reserveFactor: interestModel.revenue_factor.fields,
       borrowWeight: interestModel.borrow_weight.fields,
+      borrowFeeRate: borrowFeeRate,
       baseBorrowRatePerSec: interestModel.base_borrow_rate_per_sec.fields,
       borrowRateOnHighKink: interestModel.borrow_rate_on_high_kink.fields,
       borrowRateOnMidKink: interestModel.borrow_rate_on_mid_kink.fields,
@@ -369,6 +401,7 @@ export const getMarketPool = async (
       midKink: parsedMarketPoolData.midKink,
       reserveFactor: parsedMarketPoolData.reserveFactor,
       borrowWeight: parsedMarketPoolData.borrowWeight,
+      borrowFee: parsedMarketPoolData.borrowFee,
       marketCoinSupplyAmount: parsedMarketPoolData.marketCoinSupplyAmount,
       minBorrowAmount: parsedMarketPoolData.minBorrowAmount,
       ...calculatedMarketPoolData,
@@ -563,6 +596,8 @@ export const getObligations = async (
   ownerAddress?: string
 ) => {
   const owner = ownerAddress || query.suiKit.currentAddress();
+  const protocolObjectId =
+    query.address.get('core.object') || PROTOCOL_OBJECT_ID;
   const keyObjectsResponse: SuiObjectResponse[] = [];
   let hasNextPage = false;
   let nextCursor: string | null = null;
@@ -572,7 +607,7 @@ export const getObligations = async (
       .getOwnedObjects({
         owner,
         filter: {
-          StructType: `${PROTOCOL_OBJECT_ID}::obligation::ObligationKey`,
+          StructType: `${protocolObjectId}::obligation::ObligationKey`,
         },
         cursor: nextCursor,
       });

package/src/queries/portfolioQuery.ts

@@ -19,6 +19,7 @@ import type {
   CoinPrices,
   SupportMarketCoins,
   TotalValueLocked,
+  SupportBorrowIncentiveCoins,
 } from '../types';
 
 /**
@@ -164,7 +165,9 @@ export const getLending = async (
       availableUnstakeAmount = availableUnstakeAmount.plus(
         accountStakedMarketCoinAmount
       );
-      availableUnstakeCoin = availableUnstakeAmount.shiftedBy(-1 * coinDecimal);
+      availableUnstakeCoin = availableUnstakeAmount.shiftedBy(
+        -1 * spool.coinDecimal
+      );
 
       const baseIndexRate = 1_000_000_000;
       const increasedPointRate = spool?.currentPointIndex
@@ -173,13 +176,15 @@ export const getLending = async (
           )
         : 1;
       availableClaimAmount = availableClaimAmount.plus(
-        BigNumber(stakeAccount.staked)
+        accountStakedMarketCoinAmount
           .multipliedBy(increasedPointRate)
           .plus(stakeAccount.points)
           .multipliedBy(spool.exchangeRateNumerator)
           .dividedBy(spool.exchangeRateDenominator)
       );
-      availableClaimCoin = availableClaimAmount.shiftedBy(-1 * coinDecimal);
+      availableClaimCoin = availableClaimAmount.shiftedBy(
+        -1 * spool.rewardCoinDecimal
+      );
     }
   }
 
@@ -298,12 +303,16 @@ export const getObligationAccount = async (
     ]),
   ];
   const obligationQuery = await query.queryObligation(obligationId);
+  const borrowIncentivePools = await query.getBorrowIncentivePools();
+  const borrowIncentiveAccounts =
+    await query.getBorrowIncentiveAccounts(obligationId);
   coinPrices = coinPrices || (await query.utils.getCoinPrices(assetCoinNames));
   coinAmounts =
     coinAmounts || (await query.getCoinAmounts(assetCoinNames, ownerAddress));
 
   const collaterals: ObligationAccount['collaterals'] = {};
   const debts: ObligationAccount['debts'] = {};
+  const borrowIncentives: ObligationAccount['borrowIncentives'] = {};
   let totalDepositedPools = 0;
   let totalDepositedValue = BigNumber(0);
   let totalBorrowCapacityValue = BigNumber(0);
@@ -419,6 +428,50 @@ export const getObligationAccount = async (
     }
   }
 
+  for (const [poolCoinName, borrowIncentiveAccount] of Object.entries(
+    borrowIncentiveAccounts
+  )) {
+    const coinName = poolCoinName as SupportBorrowIncentiveCoins;
+    const borrowIncentivePool = borrowIncentivePools[coinName];
+
+    let availableClaimAmount = BigNumber(0);
+    let availableClaimCoin = BigNumber(0);
+    if (borrowIncentivePool) {
+      const accountBorrowedAmount = BigNumber(borrowIncentiveAccount.amount);
+      const baseIndexRate = 1_000_000_000;
+      const increasedPointRate = borrowIncentivePool.currentPointIndex
+        ? BigNumber(
+            borrowIncentivePool.currentPointIndex - borrowIncentiveAccount.index
+          ).dividedBy(baseIndexRate)
+        : 1;
+      availableClaimAmount = availableClaimAmount.plus(
+        accountBorrowedAmount
+          .multipliedBy(increasedPointRate)
+          .plus(borrowIncentiveAccount.points)
+          .multipliedBy(borrowIncentivePool.exchangeRateNumerator)
+          .dividedBy(borrowIncentivePool.exchangeRateDenominator)
+      );
+      availableClaimCoin = availableClaimAmount.shiftedBy(
+        -1 * borrowIncentivePool.rewardCoinDecimal
+      );
+
+      if (availableClaimAmount.isGreaterThan(0)) {
+        borrowIncentives[coinName] = {
+          coinName: borrowIncentivePool.coinName,
+          coinType: borrowIncentivePool.coinType,
+          rewardCoinType: borrowIncentivePool.rewardCoinType,
+          symbol: borrowIncentivePool.symbol,
+          coinDecimal: borrowIncentivePool.coinDecimal,
+          rewardCoinDecimal: borrowIncentivePool.rewardCoinDecimal,
+          coinPrice: borrowIncentivePool.coinPrice,
+          rewardCoinPrice: borrowIncentivePool.rewardCoinPrice,
+          availableClaimAmount: availableClaimAmount.toNumber(),
+          availableClaimCoin: availableClaimCoin.toNumber(),
+        };
+      }
+    }
+  }
+
   let riskLevel =
     totalRequiredCollateralValue.isZero() &&
     totalBorrowedValueWithWeight.isZero()
@@ -472,6 +525,7 @@ export const getObligationAccount = async (
     totalBorrowedPools,
     collaterals,
     debts,
+    borrowIncentives,
   };
 
   for (const [collateralCoinName, obligationCollateral] of Object.entries(
@@ -500,10 +554,10 @@ export const getObligationAccount = async (
         .toNumber();
     }
   }
-  for (const [assetCoinName, obligationDebt] of Object.entries(
+  for (const [poolCoinName, obligationDebt] of Object.entries(
     obligationAccount.debts
   )) {
-    const marketPool = market.pools[assetCoinName as SupportPoolCoins];
+    const marketPool = market.pools[poolCoinName as SupportPoolCoins];
     if (marketPool) {
       const availableRepayAmount = BigNumber(
         obligationDebt.availableRepayAmount