@scallop-io/sui-scallop-sdk 0.46.60 → 0.46.62

package/dist/models/scallopQuery.d.ts

@@ -367,6 +367,12 @@ export declare class ScallopQuery {
      * @return Total value locked.
      */
     getTvl(indexer?: boolean): Promise<import("../types").TotalValueLocked>;
+    /**
+     * Get veSca data.
+     * @param veScaKey
+     * @returns veSca
+     */
+    getVeSca(veScaKey: string | SuiObjectData): Promise<import("../types").Vesca | undefined>;
     /**
      * Get all veSca from walletAdddress
      * @param walletAddress
@@ -431,4 +437,8 @@ export declare class ScallopQuery {
      */
     getSCoinSwapRate(fromSCoin: SupportSCoin, toSCoin: SupportSCoin): Promise<number>;
     getFlashLoanFees(assetCoinNames?: SupportAssetCoins[]): Promise<Record<"eth" | "btc" | "usdc" | "usdt" | "sui" | "apt" | "sol" | "cetus" | "afsui" | "hasui" | "vsui" | "sca", number>>;
+    /**
+     * Get supply limit of supply pool
+     */
+    getPoolSupplyLimit(poolName: SupportPoolCoins): Promise<string | null>;
 }

package/dist/models/scallopUtils.d.ts

@@ -191,7 +191,7 @@ export declare class ScallopUtils {
      */
     parseAprToApy(apr: number, compoundFrequency?: number): number;
     /**
-     * Convert apr to apy.
+     * Convert apy to apr.
      *
      * @param apr The equivalent annual percentage yield (APY).
      * @param compoundFrequency How often interest is compounded per year. Default is daily (365 times a year).

package/dist/queries/supplyLimit.d.ts

@@ -0,0 +1,9 @@
+import { ScallopUtils } from 'src/models';
+import { SupportPoolCoins } from 'src/types';
+/**
+ * Return supply limit of a pool (including the decimals)
+ * @param utils
+ * @param poolName
+ * @returns supply limit (decimals included)
+ */
+export declare const getSupplyLimit: (utils: ScallopUtils, poolName: SupportPoolCoins) => Promise<string | null>;

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

@@ -122,6 +122,7 @@ export type MarketPool = {
     coinWrappedType: CoinWrappedType;
     coinDecimal: number;
     coinPrice: number;
+    maxSupplyCoin: number;
 } & Required<Pick<ParsedMarketPoolData, 'highKink' | 'midKink' | 'reserveFactor' | 'borrowWeight' | 'borrowFee' | 'marketCoinSupplyAmount' | 'minBorrowAmount'>> & CalculatedMarketPoolData;
 export type MarketCollateral = {
     coinName: SupportCollateralCoins;

package/package.json

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

package/src/models/scallopQuery.ts

@@ -33,6 +33,7 @@ import {
   getVeScaTreasuryInfo,
   getLoyaltyProgramInformations,
   getFlashLoanFees,
+  getVeSca,
 } from '../queries';
 import {
   ScallopQueryParams,
@@ -60,6 +61,7 @@ import {
   getSCoinTotalSupply,
 } from 'src/queries/sCoinQuery';
 import { normalizeSuiAddress } from '@mysten/sui.js/utils';
+import { getSupplyLimit } from 'src/queries/supplyLimit';
 
 /**
  * @description
@@ -563,6 +565,15 @@ export class ScallopQuery {
     return await getTotalValueLocked(this, indexer);
   }
 
+  /**
+   * Get veSca data.
+   * @param veScaKey
+   * @returns veSca
+   */
+  public async getVeSca(veScaKey: string | SuiObjectData) {
+    return await getVeSca(this.utils, veScaKey);
+  }
+
   /**
    * Get all veSca from walletAdddress
    * @param walletAddress
@@ -681,4 +692,11 @@ export class ScallopQuery {
   ) {
     return await getFlashLoanFees(this, assetCoinNames);
   }
+
+  /**
+   * Get supply limit of supply pool
+   */
+  public async getPoolSupplyLimit(poolName: SupportPoolCoins) {
+    return await getSupplyLimit(this.utils, poolName);
+  }
 }

package/src/models/scallopUtils.ts

@@ -582,7 +582,7 @@ export class ScallopUtils {
   }
 
   /**
-   * Convert apr to apy.
+   * Convert apy to apr.
    *
    * @param apr The equivalent annual percentage yield (APY).
    * @param compoundFrequency How often interest is compounded per year. Default is daily (365 times a year).

package/src/queries/coreQuery.ts

@@ -37,6 +37,7 @@ import {
   OptionalKeys,
 } from '../types';
 import BigNumber from 'bignumber.js';
+import { getSupplyLimit } from './supplyLimit';
 
 /**
  * Query market data.
@@ -124,6 +125,13 @@ export const queryMarket = async (
       parsedMarketPoolData
     );
 
+    const coinDecimal = query.utils.getCoinDecimal(poolCoinName);
+    const maxSupplyCoin = BigNumber(
+      (await getSupplyLimit(query.utils, poolCoinName)) ?? '0'
+    )
+      .shiftedBy(-coinDecimal)
+      .toNumber();
+
     pools[poolCoinName] = {
       coinName: poolCoinName,
       symbol: query.utils.parseSymbol(poolCoinName),
@@ -133,7 +141,7 @@ export const queryMarket = async (
         query.utils.parseMarketCoinName(poolCoinName)
       ),
       coinWrappedType: query.utils.getCoinWrappedType(poolCoinName),
-      coinDecimal: query.utils.getCoinDecimal(poolCoinName),
+      coinDecimal,
       coinPrice: coinPrice,
       highKink: parsedMarketPoolData.highKink,
       midKink: parsedMarketPoolData.midKink,
@@ -142,6 +150,7 @@ export const queryMarket = async (
       borrowFee: parsedMarketPoolData.borrowFee,
       marketCoinSupplyAmount: parsedMarketPoolData.marketCoinSupplyAmount,
       minBorrowAmount: parsedMarketPoolData.minBorrowAmount,
+      maxSupplyCoin,
       ...calculatedMarketPoolData,
     };
   }
@@ -451,6 +460,13 @@ export const getMarketPool = async (
       parsedMarketPoolData
     );
 
+    const coinDecimal = query.utils.getCoinDecimal(poolCoinName);
+    const maxSupplyCoin = BigNumber(
+      (await getSupplyLimit(query.utils, poolCoinName)) ?? '0'
+    )
+      .shiftedBy(-coinDecimal)
+      .toNumber();
+
     marketPool = {
       coinName: poolCoinName,
       symbol: query.utils.parseSymbol(poolCoinName),
@@ -460,7 +476,7 @@ export const getMarketPool = async (
         query.utils.parseMarketCoinName(poolCoinName)
       ),
       coinWrappedType: query.utils.getCoinWrappedType(poolCoinName),
-      coinDecimal: query.utils.getCoinDecimal(poolCoinName),
+      coinDecimal,
       coinPrice: coinPrice ?? 0,
       highKink: parsedMarketPoolData.highKink,
       midKink: parsedMarketPoolData.midKink,
@@ -469,6 +485,7 @@ export const getMarketPool = async (
       borrowFee: parsedMarketPoolData.borrowFee,
       marketCoinSupplyAmount: parsedMarketPoolData.marketCoinSupplyAmount,
       minBorrowAmount: parsedMarketPoolData.minBorrowAmount,
+      maxSupplyCoin,
       ...calculatedMarketPoolData,
     };
   }

package/src/queries/supplyLimit.ts

@@ -0,0 +1,48 @@
+import { ScallopUtils } from 'src/models';
+import { SupportPoolCoins } from 'src/types';
+import { z as zod } from 'zod';
+
+const supplyLimitZod = zod.object({
+  dataType: zod.string(),
+  type: zod.string(),
+  hasPublicTransfer: zod.boolean(),
+  fields: zod.object({
+    id: zod.object({
+      id: zod.string(),
+    }),
+    name: zod.object({
+      type: zod.string(),
+    }),
+    value: zod.string(),
+  }),
+});
+
+const SUPPLY_LIMIT_TYPE =
+  '0x6e641f0dca8aedab3101d047e96439178f16301bf0b57fe8745086ff1195eb3e::market_dynamic_keys::SupplyLimitKey';
+
+/**
+ * Return supply limit of a pool (including the decimals)
+ * @param utils
+ * @param poolName
+ * @returns supply limit (decimals included)
+ */
+export const getSupplyLimit = async (
+  utils: ScallopUtils,
+  poolName: SupportPoolCoins
+) => {
+  const poolCoinType = utils.parseCoinType(poolName).slice(2);
+  const marketObject = utils.address.get('core.market');
+  if (!marketObject) return null;
+
+  const object = await utils.cache.queryGetDynamicFieldObject({
+    parentId: marketObject,
+    name: {
+      type: SUPPLY_LIMIT_TYPE,
+      value: poolCoinType,
+    },
+  });
+
+  const parsedData = supplyLimitZod.safeParse(object?.data?.content);
+  if (!parsedData.success) return null;
+  return parsedData.data.fields.value;
+};

package/src/types/query/core.ts

@@ -129,6 +129,7 @@ export type MarketPool = {
   coinWrappedType: CoinWrappedType;
   coinDecimal: number;
   coinPrice: number;
+  maxSupplyCoin: number;
 } & Required<
   Pick<
     ParsedMarketPoolData,