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

package/dist/constants/common.d.ts

@@ -1,6 +1,7 @@
 export declare const API_BASE_URL = "https://sui.api.scallop.io";
 export declare const ADDRESSES_ID = "6462a088a7ace142bb6d7e9b";
 export declare const PROTOCOL_OBJECT_ID = "0xefe8b36d5b2e43728cc323298626b83177803521d195cfb11e15b910e892fddf";
+export declare const BORROW_FEE_PROTOCOL_ID = "0xc38f849e81cfe46d4e4320f508ea7dda42934a329d5a6571bb4c3cb6ea63f5da";
 export declare const SUPPORT_POOLS: readonly ["eth", "btc", "usdc", "usdt", "sui", "apt", "sol", "cetus", "afsui", "hasui", "vsui"];
 export declare const SUPPORT_COLLATERALS: readonly ["eth", "btc", "usdc", "usdt", "sui", "apt", "sol", "cetus", "afsui", "hasui", "vsui"];
 export declare const SUPPORT_SPOOLS: readonly ["ssui", "susdc", "susdt"];

package/dist/index.js

@@ -32,6 +32,7 @@ var src_exports = {};
 __export(src_exports, {
   ADDRESSES_ID: () => ADDRESSES_ID,
   API_BASE_URL: () => API_BASE_URL,
+  BORROW_FEE_PROTOCOL_ID: () => BORROW_FEE_PROTOCOL_ID,
   PROTOCOL_OBJECT_ID: () => PROTOCOL_OBJECT_ID,
   SUPPORT_BORROW_INCENTIVE_POOLS: () => SUPPORT_BORROW_INCENTIVE_POOLS,
   SUPPORT_BORROW_INCENTIVE_REWARDS: () => SUPPORT_BORROW_INCENTIVE_REWARDS,
@@ -63,6 +64,7 @@ module.exports = __toCommonJS(src_exports);
 var API_BASE_URL = "https://sui.api.scallop.io";
 var ADDRESSES_ID = "6462a088a7ace142bb6d7e9b";
 var PROTOCOL_OBJECT_ID = "0xefe8b36d5b2e43728cc323298626b83177803521d195cfb11e15b910e892fddf";
+var BORROW_FEE_PROTOCOL_ID = "0xc38f849e81cfe46d4e4320f508ea7dda42934a329d5a6571bb4c3cb6ea63f5da";
 var SUPPORT_POOLS = [
   "eth",
   "btc",
@@ -208,6 +210,7 @@ var EMPTY_ADDRESSES = {
   core: {
     version: "",
     versionCap: "",
+    object: "",
     market: "",
     adminCap: "",
     coinDecimalsRegistry: "",
@@ -385,6 +388,7 @@ var EMPTY_ADDRESSES = {
   spool: {
     id: "",
     adminCap: "",
+    object: "",
     pools: {
       ssui: {
         id: "",
@@ -399,6 +403,7 @@ var EMPTY_ADDRESSES = {
   borrowIncentive: {
     id: "",
     adminCap: "",
+    object: "",
     query: "",
     incentivePools: "",
     incentiveAccounts: ""
@@ -748,6 +753,7 @@ var parseOriginMarketPoolData = (originMarketPoolData) => {
     reserveAmount: Number(originMarketPoolData.reserve),
     reserveFactor: Number(originMarketPoolData.reserveFactor.value) / 2 ** 32,
     borrowWeight: Number(originMarketPoolData.borrowWeight.value) / 2 ** 32,
+    borrowFee: Number(originMarketPoolData.borrowFeeRate.value) / 2 ** 32,
     // Parse origin data required for additional display.
     baseBorrowRate: Number(originMarketPoolData.baseBorrowRatePerSec.value) / 2 ** 32,
     borrowRateOnHighKink: Number(originMarketPoolData.borrowRateOnHighKink.value) / 2 ** 32,
@@ -918,12 +924,14 @@ var calculateSpoolData = (parsedSpoolData, stakeMarketCoinPrice, stakeMarketCoin
 var parseOriginSpoolRewardPoolData = (originSpoolRewardPoolData) => {
   return {
     claimedRewards: Number(originSpoolRewardPoolData.claimed_rewards),
-    exchangeRateNumerator: Number(
-      originSpoolRewardPoolData.exchange_rate_numerator
-    ),
     exchangeRateDenominator: Number(
       originSpoolRewardPoolData.exchange_rate_denominator
     ),
+    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)
   };
@@ -948,6 +956,7 @@ var calculateSpoolRewardPoolData = (parsedSpoolData, parsedSpoolRewardPoolData,
   const claimedRewardValue = claimedRewardCoin.multipliedBy(rewardCoinPrice);
   const rewardValueForYear = (0, import_bignumber.default)(rewardPerSec).shiftedBy(-1 * rewardCoinDecimal).multipliedBy(rateYearFactor).multipliedBy(rewardCoinPrice);
   const rewardRate = rewardValueForYear.dividedBy(calculatedSpoolData.stakedValue).isFinite() ? rewardValueForYear.dividedBy(calculatedSpoolData.stakedValue).toNumber() : Infinity;
+  const rewardFeeRate = (0, import_bignumber.default)(parsedSpoolRewardPoolData.feeRateNumerator).dividedBy(parsedSpoolRewardPoolData.feeRateDenominator).toNumber();
   return {
     rewardApr: rewardRate,
     totalRewardAmount: totalRewardAmount.toNumber(),
@@ -959,7 +968,8 @@ var calculateSpoolRewardPoolData = (parsedSpoolData, parsedSpoolRewardPoolData,
     claimedRewardAmount: claimedRewardAmount.toNumber(),
     claimedRewardCoin: claimedRewardCoin.toNumber(),
     claimedRewardValue: claimedRewardValue.toNumber(),
-    rewardPerSec: rewardPerSec.toNumber()
+    rewardPerSec: rewardPerSec.toNumber(),
+    rewardFee: rewardFeeRate
   };
 };
 var parseOriginBorrowIncentivePoolData = (originBorrowIncentivePoolData) => {
@@ -1034,6 +1044,12 @@ var parseOriginBorrowIncentiveRewardPoolData = (originBorrowIncentiveRewardPoolD
     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
     )
@@ -1063,6 +1079,9 @@ var calculateBorrowIncentiveRewardPoolData = (parsedBorrowIncentivePoolData, par
   const claimedRewardValue = claimedRewardCoin.multipliedBy(rewardCoinPrice);
   const rewardValueForYear = (0, import_bignumber.default)(rewardPerSec).shiftedBy(-1 * rewardCoinDecimal).multipliedBy(rateYearFactor).multipliedBy(rewardCoinPrice);
   const rewardRate = rewardValueForYear.dividedBy(calculatedBorrowIncentivePoolData.stakedValue).isFinite() ? rewardValueForYear.dividedBy(calculatedBorrowIncentivePoolData.stakedValue).toNumber() : Infinity;
+  const rewardFeeRate = (0, import_bignumber.default)(
+    parsedBorrowIncentiveRewardPoolData.rewardsFeeRateNumerator
+  ).dividedBy(parsedBorrowIncentiveRewardPoolData.rewardsFeeRateDenominator).toNumber();
   return {
     rewardApr: rewardRate,
     totalRewardAmount: totalRewardAmount.toNumber(),
@@ -1074,7 +1093,8 @@ var calculateBorrowIncentiveRewardPoolData = (parsedBorrowIncentivePoolData, par
     claimedRewardAmount: claimedRewardAmount.toNumber(),
     claimedRewardCoin: claimedRewardCoin.toNumber(),
     claimedRewardValue: claimedRewardValue.toNumber(),
-    rewardPerSec: rewardPerSec.toNumber()
+    rewardPerSec: rewardPerSec.toNumber(),
+    rewardFee: rewardFeeRate
   };
 };
 var parseOriginBorrowIncentiveAccountData = (originBorrowIncentiveAccountData) => {
@@ -1169,6 +1189,7 @@ var queryMarket = async (query) => {
       reserve: pool.reserve,
       reserveFactor: pool.reserveFactor,
       borrowWeight: pool.borrowWeight,
+      borrowFeeRate: pool.borrowFeeRate,
       baseBorrowRatePerSec: pool.baseBorrowRatePerSec,
       borrowRateOnHighKink: pool.borrowRateOnHighKink,
       borrowRateOnMidKink: pool.borrowRateOnMidKink,
@@ -1192,6 +1213,7 @@ var queryMarket = async (query) => {
       midKink: parsedMarketPoolData.midKink,
       reserveFactor: parsedMarketPoolData.reserveFactor,
       borrowWeight: parsedMarketPoolData.borrowWeight,
+      borrowFee: parsedMarketPoolData.borrowFee,
       marketCoinSupplyAmount: parsedMarketPoolData.marketCoinSupplyAmount,
       minBorrowAmount: parsedMarketPoolData.minBorrowAmount,
       ...calculatedMarketPoolData
@@ -1276,6 +1298,7 @@ var getMarketPool = async (query, poolCoinName, marketObject, coinPrice) => {
   let balanceSheet;
   let borrowIndex;
   let interestModel;
+  let borrowFeeRate;
   if (marketObject) {
     if (marketObject.content && "fields" in marketObject.content) {
       const fields = marketObject.content.fields;
@@ -1325,9 +1348,25 @@ var getMarketPool = async (query, poolCoinName, marketObject, coinPrice) => {
         const dynamicFields = interestModelDynamicFieldObject.content.fields;
         interestModel = dynamicFields.value.fields;
       }
+      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;
+        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,
@@ -1341,6 +1380,7 @@ var getMarketPool = async (query, poolCoinName, marketObject, coinPrice) => {
       reserve: balanceSheet.revenue,
       reserveFactor: interestModel.revenue_factor.fields,
       borrowWeight: interestModel.borrow_weight.fields,
+      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,
@@ -1365,6 +1405,7 @@ var getMarketPool = async (query, poolCoinName, marketObject, coinPrice) => {
       midKink: parsedMarketPoolData.midKink,
       reserveFactor: parsedMarketPoolData.reserveFactor,
       borrowWeight: parsedMarketPoolData.borrowWeight,
+      borrowFee: parsedMarketPoolData.borrowFee,
       marketCoinSupplyAmount: parsedMarketPoolData.marketCoinSupplyAmount,
       minBorrowAmount: parsedMarketPoolData.minBorrowAmount,
       ...calculatedMarketPoolData
@@ -1479,6 +1520,7 @@ var getMarketCollateral = async (query, collateralCoinName, marketObject, coinPr
 };
 var getObligations = async (query, ownerAddress) => {
   const owner = ownerAddress || query.suiKit.currentAddress();
+  const protocolObjectId = query.address.get("core.object") || PROTOCOL_OBJECT_ID;
   const keyObjectsResponse = [];
   let hasNextPage = false;
   let nextCursor = null;
@@ -1486,7 +1528,7 @@ var getObligations = async (query, ownerAddress) => {
     const paginatedKeyObjectsResponse = await query.suiKit.client().getOwnedObjects({
       owner,
       filter: {
-        StructType: `${PROTOCOL_OBJECT_ID}::obligation::ObligationKey`
+        StructType: `${protocolObjectId}::obligation::ObligationKey`
       },
       cursor: nextCursor
     });
@@ -1723,6 +1765,7 @@ var getSpools = async (query, stakeMarketCoinNames) => {
 var getSpool = async (query, marketCoinName, marketPool) => {
   const coinName = query.utils.parseCoinName(marketCoinName);
   marketPool = marketPool || await query.getMarketPool(coinName);
+  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`
@@ -1734,6 +1777,13 @@ var getSpool = async (query, marketCoinName, marketPool) => {
       showContent: true
     }
   });
+  const spoolRewardFeeDynamicFieldsResponse = await query.suiKit.client().getDynamicFieldObject({
+    parentId: rewardPoolId,
+    name: {
+      type: `${spoolPkgId}::rewards_pool::RewardsPoolFeeKey`,
+      value: { dummy_field: false }
+    }
+  });
   if (marketPool && spoolObjectResponse[0].data && spoolObjectResponse[1].data) {
     const rewardCoinName = query.utils.getSpoolRewardCoinName(marketCoinName);
     const coinPrices = await query.utils.getCoinPrices([
@@ -1742,19 +1792,20 @@ var getSpool = async (query, marketCoinName, marketPool) => {
     ]);
     const spoolObject = spoolObjectResponse[0].data;
     const rewardPoolObject = spoolObjectResponse[1].data;
+    const rewardFeeObject = spoolRewardFeeDynamicFieldsResponse.data;
     if (spoolObject.content && "fields" in spoolObject.content) {
-      const fields = spoolObject.content.fields;
+      const spoolFields = spoolObject.content.fields;
       const parsedSpoolData = parseOriginSpoolData({
-        stakeType: fields.stake_type,
-        maxDistributedPoint: fields.max_distributed_point,
-        distributedPoint: fields.distributed_point,
-        distributedPointPerPeriod: fields.distributed_point_per_period,
-        pointDistributionTime: fields.point_distribution_time,
-        maxStake: fields.max_stakes,
-        stakes: fields.stakes,
-        index: fields.index,
-        createdAt: fields.created_at,
-        lastUpdate: fields.last_update
+        stakeType: spoolFields.stake_type,
+        maxDistributedPoint: spoolFields.max_distributed_point,
+        distributedPoint: spoolFields.distributed_point,
+        distributedPointPerPeriod: spoolFields.distributed_point_per_period,
+        pointDistributionTime: spoolFields.point_distribution_time,
+        maxStake: spoolFields.max_stakes,
+        stakes: spoolFields.stakes,
+        index: spoolFields.index,
+        createdAt: spoolFields.created_at,
+        lastUpdate: spoolFields.last_update
       });
       const marketCoinPrice = (coinPrices?.[coinName] ?? 0) * marketPool.conversionRate;
       const marketCoinDecimal = query.utils.getCoinDecimal(marketCoinName);
@@ -1763,14 +1814,17 @@ var getSpool = async (query, marketCoinName, marketPool) => {
         marketCoinPrice,
         marketCoinDecimal
       );
-      if (rewardPoolObject.content && "fields" in rewardPoolObject.content) {
-        const fields2 = rewardPoolObject.content.fields;
+      if (rewardPoolObject.content && rewardFeeObject?.content && "fields" in rewardPoolObject.content && "fields" in rewardFeeObject.content) {
+        const rewardPoolFields = rewardPoolObject.content.fields;
+        const rewardFeeFields = rewardFeeObject.content.fields.value.fields;
         const parsedSpoolRewardPoolData = parseOriginSpoolRewardPoolData({
-          claimed_rewards: fields2.claimed_rewards,
-          exchange_rate_numerator: fields2.exchange_rate_numerator,
-          exchange_rate_denominator: fields2.exchange_rate_denominator,
-          rewards: fields2.rewards,
-          spool_id: fields2.spool_id
+          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
         });
         const rewardCoinPrice = coinPrices?.[rewardCoinName] ?? 0;
         const rewardCoinDecimal = query.utils.getCoinDecimal(rewardCoinName);
@@ -1807,8 +1861,8 @@ var getSpool = async (query, marketCoinName, marketPool) => {
 };
 var getStakeAccounts = async (query, ownerAddress) => {
   const owner = ownerAddress || query.suiKit.currentAddress();
-  const spoolPkgId = query.address.get("spool.id");
-  const stakeAccountType = `${spoolPkgId}::spool_account::SpoolAccount`;
+  const spoolObjectId = query.address.get("spool.object");
+  const stakeAccountType = `${spoolObjectId}::spool_account::SpoolAccount`;
   const stakeObjectsResponse = [];
   let hasNextPage = false;
   let nextCursor = null;
@@ -1837,7 +1891,7 @@ var getStakeAccounts = async (query, ownerAddress) => {
     (types, stakeMarketCoinName) => {
       const stakeCoinName = query.utils.parseCoinName(stakeMarketCoinName);
       const marketCoinType = query.utils.parseMarketCoinType(stakeCoinName);
-      types[stakeMarketCoinName] = `${spoolPkgId}::spool_account::SpoolAccount<${marketCoinType}>`;
+      types[stakeMarketCoinName] = `${spoolObjectId}::spool_account::SpoolAccount<${marketCoinType}>`;
       return types;
     },
     {}
@@ -1938,6 +1992,7 @@ var getStakePool = async (query, marketCoinName) => {
   return stakePool;
 };
 var getStakeRewardPool = async (query, marketCoinName) => {
+  const spoolPkgId = query.address.get("spool.id");
   const poolId = query.address.get(
     `spool.pools.${marketCoinName}.rewardPoolId`
   );
@@ -1949,23 +2004,38 @@ var getStakeRewardPool = async (query, marketCoinName) => {
       showType: true
     }
   });
-  if (stakeRewardPoolObjectResponse.data) {
+  const stakeRewardFeeDynamicFieldsResponse = await query.suiKit.client().getDynamicFieldObject({
+    parentId: poolId,
+    name: {
+      type: `${spoolPkgId}::rewards_pool::RewardsPoolFeeKey`,
+      value: { dummy_field: false }
+    }
+  });
+  if (stakeRewardPoolObjectResponse.data && stakeRewardFeeDynamicFieldsResponse.data) {
     const stakeRewardPoolObject = stakeRewardPoolObjectResponse.data;
+    const stakeRewardFeeDynamicFieldObject = stakeRewardFeeDynamicFieldsResponse.data;
     const id = stakeRewardPoolObject.objectId;
     const type = stakeRewardPoolObject.type;
-    if (stakeRewardPoolObject.content && "fields" in stakeRewardPoolObject.content) {
-      const fields = stakeRewardPoolObject.content.fields;
-      const stakePoolId = String(fields.spool_id);
-      const ratioNumerator = Number(fields.exchange_rate_numerator);
-      const ratioDenominator = Number(fields.exchange_rate_denominator);
-      const rewards = Number(fields.rewards);
-      const claimedRewards = Number(fields.claimed_rewards);
+    if (stakeRewardPoolObject.content && stakeRewardFeeDynamicFieldObject.content && "fields" in stakeRewardPoolObject.content && "fields" in stakeRewardFeeDynamicFieldObject.content) {
+      const rewardPoolFields = stakeRewardPoolObject.content.fields;
+      const rewardFeeFields = stakeRewardFeeDynamicFieldObject.content.fields.value.fields;
+      const stakePoolId = String(rewardPoolFields.spool_id);
+      const ratioNumerator = Number(rewardPoolFields.exchange_rate_numerator);
+      const ratioDenominator = Number(
+        rewardPoolFields.exchange_rate_denominator
+      );
+      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,
         type: (0, import_utils4.normalizeStructTag)(type),
         stakePoolId,
         ratioNumerator,
         ratioDenominator,
+        feeRateNumerator,
+        feeRateDenominator,
         rewards,
         claimedRewards
       };
@@ -2963,8 +3033,9 @@ var ScallopUtils = class {
    * @return Market coin type.
    */
   parseMarketCoinType(coinName) {
+    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}>`;
   }
   parseCoinNameFromType(coinType) {
     coinType = (0, import_utils9.normalizeStructTag)(coinType);
@@ -4659,6 +4730,7 @@ var Scallop = class {
 0 && (module.exports = {
   ADDRESSES_ID,
   API_BASE_URL,
+  BORROW_FEE_PROTOCOL_ID,
   PROTOCOL_OBJECT_ID,
   SUPPORT_BORROW_INCENTIVE_POOLS,
   SUPPORT_BORROW_INCENTIVE_REWARDS,