@scallop-io/sui-scallop-sdk 1.3.0-alpha.3 → 1.3.0-alpha.4

package/dist/models/scallopQuery.d.ts

@@ -457,4 +457,12 @@ export declare class ScallopQuery {
      * Get supply limit of supply pool
      */
     getPoolSupplyLimit(poolName: SupportPoolCoins): Promise<string | null>;
+    /**
+     * Get list of isolated assets
+     */
+    getIsolatedAssets(): Promise<string[]>;
+    /**
+     * Check if asset is an isolated asset
+     */
+    isIsolatedAsset(assetCoinName: SupportAssetCoins): Promise<boolean>;
 }

package/dist/queries/isolatedAsset.d.ts

@@ -0,0 +1,14 @@
+import { ScallopAddress, ScallopUtils } from 'src/models';
+import { SupportPoolCoins } from 'src/types';
+/**
+ * Return list of isolated assets coin types
+ * @param utils ScallopUtils
+ * @returns list of isolated assets coin types
+ */
+export declare const getIsolatedAssets: (address: ScallopAddress) => Promise<string[]>;
+/**
+ * Check if the coin type is an isolated asset
+ * @param coinName coin name
+ * @returns true if the coin type is an isolated asset
+ */
+export declare const isIsolatedAsset: (utils: ScallopUtils, coinName: SupportPoolCoins) => Promise<boolean>;

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

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

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

@@ -6,7 +6,7 @@ type OptionalKeys<T> = {
 };
 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' | 'conversionRate'> & Pick<Spool, 'marketCoinPrice'>> & {
+export type Lending = Required<Pick<MarketPool, 'coinName' | 'symbol' | 'coinType' | 'marketCoinType' | 'coinDecimal' | 'coinPrice' | 'conversionRate' | 'isIsolated'> & Pick<Spool, 'marketCoinPrice'>> & {
     supplyApr: number;
     supplyApy: number;
     rewardApr: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scallop-io/sui-scallop-sdk",
-  "version": "1.3.0-alpha.3",
+  "version": "1.3.0-alpha.4",
   "description": "Typescript sdk for interacting with Scallop contract on SUI",
   "keywords": [
     "sui",

package/src/constants/common.ts

@@ -32,7 +32,7 @@ export const OLD_BORROW_INCENTIVE_PROTOCOL_ID =
 
 export const SUPPORT_POOLS = [
   'usdc', // native USDC
-  'sbeth', // native ETH
+  'sbeth', // sui bridge ETH
   'weth',
   'wbtc',
   'wusdc',
@@ -49,7 +49,7 @@ export const SUPPORT_POOLS = [
 
 export const SUPPORT_COLLATERALS = [
   'usdc', // native USDC
-  'sbeth', // native ETH
+  'sbeth', // sui bridge ETH
   'weth',
   'wbtc',
   'wusdc',

package/src/models/scallopQuery.ts

@@ -63,6 +63,7 @@ import {
 import { normalizeSuiAddress } from '@mysten/sui/utils';
 import { getSupplyLimit } from 'src/queries/supplyLimit';
 import { withIndexerFallback } from 'src/utils/indexer';
+import { getIsolatedAssets, isIsolatedAsset } from 'src/queries/isolatedAsset';
 
 /**
  * @description
@@ -739,4 +740,18 @@ export class ScallopQuery {
   public async getPoolSupplyLimit(poolName: SupportPoolCoins) {
     return await getSupplyLimit(this.utils, poolName);
   }
+
+  /**
+   * Get list of isolated assets
+   */
+  public async getIsolatedAssets() {
+    return await getIsolatedAssets(this.address);
+  }
+
+  /**
+   * Check if asset is an isolated asset
+   */
+  public async isIsolatedAsset(assetCoinName: SupportAssetCoins) {
+    return isIsolatedAsset(this.utils, assetCoinName);
+  }
 }

package/src/queries/coreQuery.ts

@@ -38,6 +38,7 @@ import {
 } from '../types';
 import BigNumber from 'bignumber.js';
 import { getSupplyLimit } from './supplyLimit';
+import { isIsolatedAsset } from './isolatedAsset';
 
 /**
  * Query market data.
@@ -155,6 +156,7 @@ export const queryMarket = async (
       borrowFee: parsedMarketPoolData.borrowFee,
       marketCoinSupplyAmount: parsedMarketPoolData.marketCoinSupplyAmount,
       minBorrowAmount: parsedMarketPoolData.minBorrowAmount,
+      isIsolated: await isIsolatedAsset(query.utils, poolCoinName),
       maxSupplyCoin,
       ...calculatedMarketPoolData,
     };
@@ -492,6 +494,7 @@ export const getMarketPool = async (
       marketCoinSupplyAmount: parsedMarketPoolData.marketCoinSupplyAmount,
       minBorrowAmount: parsedMarketPoolData.minBorrowAmount,
       maxSupplyCoin,
+      isIsolated: await isIsolatedAsset(query.utils, poolCoinName),
       ...calculatedMarketPoolData,
     };
   }

package/src/queries/isolatedAsset.ts

@@ -0,0 +1,105 @@
+import { DynamicFieldInfo, DynamicFieldName } from '@mysten/sui/client';
+import { ScallopAddress, ScallopUtils } from 'src/models';
+import { SupportPoolCoins } from 'src/types';
+import { z as zod } from 'zod';
+
+const isolatedAssetZod = 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.boolean(),
+  }),
+});
+
+const ISOLATED_ASSET_KEY =
+  '0x6e641f0dca8aedab3101d047e96439178f16301bf0b57fe8745086ff1195eb3e::market_dynamic_keys::IsolatedAssetKey';
+
+/**
+ * Return list of isolated assets coin types
+ * @param utils ScallopUtils
+ * @returns list of isolated assets coin types
+ */
+export const getIsolatedAssets = async (
+  address: ScallopAddress
+): Promise<string[]> => {
+  const marketObject = address.get('core.market');
+  const isolatedAssets: string[] = [];
+  if (!marketObject) return isolatedAssets;
+
+  let hasNextPage = false;
+  let nextCursor: string | null | undefined = null;
+
+  const isIsolatedDynamicField = (
+    dynamicField: DynamicFieldInfo
+  ): dynamicField is DynamicFieldInfo & {
+    name: DynamicFieldName & { value: { type: { name: string } } };
+  } => {
+    return dynamicField.name.type === ISOLATED_ASSET_KEY;
+  };
+
+  do {
+    const response = await address.cache.queryGetDynamicFields({
+      parentId: marketObject,
+      cursor: nextCursor,
+      limit: 10,
+    });
+    if (!response) break;
+
+    const isolatedAssetCoinTypes = response.data
+      .filter(isIsolatedDynamicField)
+      .map(({ name }) => `0x${name.value.type.name}`);
+    isolatedAssets.push(...isolatedAssetCoinTypes);
+
+    if (response && response.hasNextPage && response.nextCursor) {
+      hasNextPage = true;
+      nextCursor = response.nextCursor;
+    } else {
+      hasNextPage = false;
+    }
+  } while (hasNextPage);
+  return isolatedAssets;
+};
+
+/**
+ * Check if the coin type is an isolated asset
+ * @param coinName coin name
+ * @returns true if the coin type is an isolated asset
+ */
+export const isIsolatedAsset = async (
+  utils: ScallopUtils,
+  coinName: SupportPoolCoins
+): Promise<boolean> => {
+  const marketObject = utils.address.get('core.market');
+
+  // check if the coin type is in the list
+  const cachedData = utils.address.cache.queryClient.getQueryData<string[]>([
+    'getDynamicFields',
+    marketObject,
+  ]);
+  if (cachedData) {
+    const coinType = utils.parseCoinType(coinName);
+    return cachedData.includes(coinType);
+  }
+
+  // fetch dynamic field object
+  const coinType = utils.parseCoinType(coinName).slice(2);
+
+  const object = await utils.cache.queryGetDynamicFieldObject({
+    parentId: marketObject,
+    name: {
+      type: ISOLATED_ASSET_KEY,
+      value: coinType,
+    },
+  });
+
+  const parsedData = isolatedAssetZod.safeParse(object?.data?.content);
+  if (!parsedData.success) return false;
+  return parsedData.data.fields.value;
+};

package/src/queries/portfolioQuery.ts

@@ -269,6 +269,7 @@ export const getLending = async (
     availableUnstakeCoin: availableUnstakeCoin.toNumber(),
     availableClaimAmount: availableClaimAmount.toNumber(),
     availableClaimCoin: availableClaimCoin.toNumber(),
+    isIsolated: marketPool ? marketPool.isIsolated : false,
   };
 
   return lending;

package/src/queries/supplyLimit.ts

@@ -17,7 +17,7 @@ const supplyLimitZod = zod.object({
   }),
 });
 
-const SUPPLY_LIMIT_TYPE =
+const SUPPLY_LIMIT_KEY =
   '0x6e641f0dca8aedab3101d047e96439178f16301bf0b57fe8745086ff1195eb3e::market_dynamic_keys::SupplyLimitKey';
 
 /**
@@ -37,7 +37,7 @@ export const getSupplyLimit = async (
   const object = await utils.cache.queryGetDynamicFieldObject({
     parentId: marketObject,
     name: {
-      type: SUPPLY_LIMIT_TYPE,
+      type: SUPPLY_LIMIT_KEY,
       value: poolCoinType,
     },
   });

package/src/types/query/core.ts

@@ -130,6 +130,7 @@ export type MarketPool = {
   coinDecimal: number;
   coinPrice: number;
   maxSupplyCoin: number;
+  isIsolated: boolean;
 } & Required<
   Pick<
     ParsedMarketPoolData,

package/src/types/query/portfolio.ts

@@ -25,6 +25,7 @@ export type Lending = Required<
     | 'coinDecimal'
     | 'coinPrice'
     | 'conversionRate'
+    | 'isIsolated'
   > &
     Pick<Spool, 'marketCoinPrice'>
 > & {

package/src/utils/tokenBucket.ts

@@ -65,7 +65,7 @@ const callWithRateLimit = async <T>(
           await new Promise((resolve) => setTimeout(resolve, delay));
           return tryRequest();
         } else {
-          console.error('An error occurred:', error);
+          console.error('An error occurred:', error.message);
           return null;
         }
       }

package/dist/test.d.ts

@@ -1 +0,0 @@
-export {};

package/src/test.ts

@@ -1,26 +0,0 @@
-import { ScallopQuery } from './models';
-
-const query = new ScallopQuery({
-  walletAddress:
-    '0xe78704e7c188b1902dbb630dc4c3ef7f46740c8cf121e38b3438ac1daea09f2d',
-});
-
-const main = async () => {
-  try {
-    await query.init();
-    const result = await query.suiKit.client().getObject({
-      id: '0xaa72bd551b25715b8f9d72f226fa02526bdf2e085a86faec7184230c5209bb6e',
-      options: {
-        showContent: true,
-        showType: true,
-      },
-    });
-    console.dir(result.data, { depth: null });
-  } catch (e) {
-    console.error(e);
-  } finally {
-    process.exit(0);
-  }
-};
-
-main();