@scallop-io/sui-scallop-sdk 1.4.14-alpha.1 → 1.4.15-rc.1

package/dist/models/scallopQuery.d.ts

@@ -34,6 +34,7 @@ export declare class ScallopQuery {
      */
     init(force?: boolean, address?: ScallopAddress): Promise<void>;
     /**
+     * @deprecated use getMarketPools
      * Query market data.
      * @param indexer - Whether to use indexer.
      * @return Market data.
@@ -57,22 +58,8 @@ export declare class ScallopQuery {
         coinPrices?: CoinPrices;
         indexer?: boolean;
     }): Promise<{
-        usdc?: MarketPool | undefined;
-        sbeth?: MarketPool | undefined;
-        weth?: MarketPool | undefined;
-        wbtc?: MarketPool | undefined;
-        wusdc?: MarketPool | undefined;
-        wusdt?: MarketPool | undefined;
-        sui?: MarketPool | undefined;
-        wapt?: MarketPool | undefined;
-        wsol?: MarketPool | undefined;
-        cetus?: MarketPool | undefined;
-        afsui?: MarketPool | undefined;
-        hasui?: MarketPool | undefined;
-        vsui?: MarketPool | undefined;
-        sca?: MarketPool | undefined;
-        fud?: MarketPool | undefined;
-        deep?: MarketPool | undefined;
+        pools: MarketPools;
+        collaterals: import("../types").MarketCollaterals;
     }>;
     /**
      * Get  market pool
@@ -82,7 +69,6 @@ export declare class ScallopQuery {
      * @return Market pool data.
      */
     getMarketPool(poolCoinName: SupportPoolCoins, args?: {
-        marketObject?: SuiObjectData | null;
         coinPrice?: number;
         indexer?: boolean;
     }): Promise<MarketPool | undefined>;
@@ -568,4 +554,21 @@ export declare class ScallopQuery {
         deep?: number | undefined;
         swapt?: number | undefined;
     }>;
+    /**
+     * Query all address (lending pool, collateral pool, borrow dynamics, interest models) of all pool
+     * @returns
+     */
+    getPoolAddresses(): Promise<import("../types").OptionalKeys<Record<"usdc" | "sbeth" | "weth" | "wbtc" | "wusdc" | "wusdt" | "sui" | "wapt" | "wsol" | "cetus" | "afsui" | "hasui" | "vsui" | "sca" | "fud" | "deep", {
+        lendingPoolAddress?: string;
+        collateralPoolAddress?: string;
+        borrowDynamic?: string;
+        spoolReward?: string;
+        spool?: string;
+        interestModel?: string;
+        riskModel?: string;
+        borrowFeeKey?: string;
+        supplyLimitKey?: string;
+        borrowLimitKey?: string;
+        isolatedAssetKey?: string;
+    }>>>;
 }

package/dist/queries/coreQuery.d.ts

@@ -1,10 +1,12 @@
 import type { SuiObjectData } from '@mysten/sui/client';
 import type { SuiObjectArg } from '@scallop-io/sui-kit';
 import type { ScallopAddress, ScallopCache, ScallopQuery } from '../models';
-import { Market, MarketPool, MarketCollateral, SupportAssetCoins, SupportPoolCoins, SupportCollateralCoins, ObligationQueryInterface, Obligation, SupportMarketCoins, OptionalKeys, CoinPrices } from '../types';
+import { Market, MarketPools, MarketPool, MarketCollaterals, MarketCollateral, SupportAssetCoins, SupportPoolCoins, SupportCollateralCoins, ObligationQueryInterface, Obligation, SupportMarketCoins, OptionalKeys, CoinPrices } from '../types';
 /**
  * Query market data.
  *
+ * @deprecated Use query market pools
+ *
  * @description
  * Use inspectTxn call to obtain the data provided in the scallop contract query module.
  *
@@ -25,23 +27,9 @@ export declare const queryMarket: (query: ScallopQuery, indexer?: boolean, coinP
  * @param indexer - Whether to use indexer.
  * @return Market pools data.
  */
-export declare const getMarketPools: (query: ScallopQuery, poolCoinNames?: SupportPoolCoins[], indexer?: boolean, coinPrices?: CoinPrices) => Promise<{
-    usdc?: MarketPool | undefined;
-    sbeth?: MarketPool | undefined;
-    weth?: MarketPool | undefined;
-    wbtc?: MarketPool | undefined;
-    wusdc?: MarketPool | undefined;
-    wusdt?: MarketPool | undefined;
-    sui?: MarketPool | undefined;
-    wapt?: MarketPool | undefined;
-    wsol?: MarketPool | undefined;
-    cetus?: MarketPool | undefined;
-    afsui?: MarketPool | undefined;
-    hasui?: MarketPool | undefined;
-    vsui?: MarketPool | undefined;
-    sca?: MarketPool | undefined;
-    fud?: MarketPool | undefined;
-    deep?: MarketPool | undefined;
+export declare const getMarketPools: (query: ScallopQuery, poolCoinNames: SupportPoolCoins[], indexer?: boolean, coinPrices?: CoinPrices) => Promise<{
+    pools: MarketPools;
+    collaterals: MarketCollaterals;
 }>;
 /**
  * Get market pool data.
@@ -53,7 +41,18 @@ export declare const getMarketPools: (query: ScallopQuery, poolCoinNames?: Suppo
  * @param coinPrice - The coin price.
  * @returns Market pool data.
  */
-export declare const getMarketPool: (query: ScallopQuery, poolCoinName: SupportPoolCoins, indexer?: boolean, marketObject?: SuiObjectData | null, coinPrice?: number) => Promise<MarketPool | undefined>;
+export declare const getMarketPool: (query: ScallopQuery, poolCoinName: SupportPoolCoins, indexer: boolean | undefined, coinPrice: number, requiredObjects?: {
+    balanceSheet: SuiObjectData;
+    borrowDynamic: SuiObjectData;
+    interestModel: SuiObjectData;
+    borrowFeeKey: SuiObjectData;
+    supplyLimitKey: SuiObjectData;
+    borrowLimitKey: SuiObjectData;
+    isolatedAssetKey: SuiObjectData;
+}) => Promise<{
+    marketPool: MarketPool;
+    collateral?: MarketCollateral;
+} | undefined>;
 /**
  * Get coin market collaterals data.
  *

package/dist/queries/index.d.ts

@@ -10,3 +10,5 @@ export * from './spoolQuery';
 export * from './supplyLimitQuery';
 export * from './vescaQuery';
 export * from './borrowLimitQuery';
+export * from './poolAddressesQuery';
+export * from './objectsQuery';

package/dist/queries/isolatedAssetQuery.d.ts

@@ -1,11 +1,11 @@
-import { ScallopAddress, ScallopUtils } from '../models';
+import { ScallopQuery, ScallopUtils } from '../models';
 import { SupportPoolCoins } from '../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[]>;
+export declare const getIsolatedAssets: (query: ScallopQuery) => Promise<string[]>;
 /**
  * Check if the coin type is an isolated asset
  * @param coinName coin name

package/dist/queries/objectsQuery.d.ts

@@ -0,0 +1,3 @@
+import { SuiObjectDataOptions } from '@mysten/sui/dist/cjs/client';
+import { ScallopCache } from 'src/models/scallopCache';
+export declare const queryMultipleObjects: (cache: ScallopCache, objectIds: string[], options?: SuiObjectDataOptions, partitionSize?: number) => Promise<import("@mysten/sui/dist/cjs/client").SuiObjectData[]>;

package/dist/queries/poolAddressesQuery.d.ts

@@ -0,0 +1,15 @@
+import { ScallopQuery } from 'src/models';
+import { OptionalKeys } from 'src/types';
+export declare const getAllAddresses: (query: ScallopQuery) => Promise<OptionalKeys<Record<"usdc" | "sbeth" | "weth" | "wbtc" | "wusdc" | "wusdt" | "sui" | "wapt" | "wsol" | "cetus" | "afsui" | "hasui" | "vsui" | "sca" | "fud" | "deep", {
+    lendingPoolAddress?: string;
+    collateralPoolAddress?: string;
+    borrowDynamic?: string;
+    spoolReward?: string;
+    spool?: string;
+    interestModel?: string;
+    riskModel?: string;
+    borrowFeeKey?: string;
+    supplyLimitKey?: string;
+    borrowLimitKey?: string;
+    isolatedAssetKey?: string;
+}>>>;

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

@@ -13,7 +13,7 @@ export type BalanceSheet = {
     market_coin_supply: string;
     revenue: string;
 };
-export type BorrowIndex = {
+export type BorrowDynamic = {
     borrow_index: string;
     interest_rate: {
         fields: {
@@ -23,6 +23,9 @@ export type BorrowIndex = {
     interest_rate_scale: string;
     last_updated: string;
 };
+export type BorrowFee = {
+    value: string;
+};
 export type InterestModel = {
     base_borrow_rate_per_sec: {
         fields: {
@@ -135,7 +138,7 @@ export type MarketCollateral = {
     coinDecimal: number;
     coinPrice: number;
     isIsolated: boolean;
-} & Required<Pick<ParsedMarketCollateralData, 'collateralFactor' | 'liquidationFactor' | 'liquidationDiscount' | 'liquidationPanelty' | 'liquidationReserveFactor'>> & CalculatedMarketCollateralData;
+} & Required<Pick<ParsedMarketCollateralData, 'collateralFactor' | 'liquidationFactor' | 'liquidationDiscount' | 'liquidationPenalty' | 'liquidationReserveFactor'>> & CalculatedMarketCollateralData;
 export type OriginMarketPoolData = {
     type: {
         name: string;
@@ -178,6 +181,9 @@ export type OriginMarketPoolData = {
         value: string;
     };
     minBorrowAmount: string;
+    isIsolated: boolean;
+    supplyLimit: string;
+    borrowLimit: string;
 };
 export type ParsedMarketPoolData = {
     coinType: string;
@@ -199,6 +205,9 @@ export type ParsedMarketPoolData = {
     highKink: number;
     midKink: number;
     minBorrowAmount: number;
+    isIsolated: boolean;
+    supplyLimit: number;
+    borrowLimit: number;
 };
 export type CalculatedMarketPoolData = {
     baseBorrowApr: number;
@@ -207,6 +216,8 @@ export type CalculatedMarketPoolData = {
     borrowApyOnHighKink: number;
     borrowAprOnMidKink: number;
     borrowApyOnMidKink: number;
+    coinDecimal: number;
+    conversionRate: number;
     maxBorrowApr: number;
     maxBorrowApy: number;
     borrowApr: number;
@@ -222,12 +233,15 @@ export type CalculatedMarketPoolData = {
     utilizationRate: number;
     supplyApr: number;
     supplyApy: number;
-    conversionRate: number;
+    isIsolated: boolean;
+    maxSupplyCoin: number;
+    maxBorrowCoin: number;
 };
 export type OriginMarketCollateralData = {
     type: {
         name: string;
     };
+    isIsolated: boolean;
     collateralFactor: {
         value: string;
     };
@@ -237,7 +251,7 @@ export type OriginMarketCollateralData = {
     liquidationDiscount: {
         value: string;
     };
-    liquidationPanelty: {
+    liquidationPenalty: {
         value: string;
     };
     liquidationReserveFactor: {
@@ -251,12 +265,15 @@ export type ParsedMarketCollateralData = {
     collateralFactor: number;
     liquidationFactor: number;
     liquidationDiscount: number;
-    liquidationPanelty: number;
+    liquidationPenalty: number;
     liquidationReserveFactor: number;
     maxCollateralAmount: number;
     totalCollateralAmount: number;
+    isIsolated: boolean;
 };
 export type CalculatedMarketCollateralData = {
+    coinDecimal: number;
+    isIsolated: boolean;
     maxDepositAmount: number;
     maxDepositCoin: number;
     depositAmount: number;

package/dist/types/utils.d.ts

@@ -8,10 +8,15 @@ export type PoolAddressInfo = {
     coingeckoId: string;
     decimal: number;
     pythFeedId: string;
-    lendingPoolAddress: string;
+    lendingPoolAddress?: string;
     collateralPoolAddress?: string;
+    borrowDynamic?: string;
+    interestModelId?: string;
+    borrowFeeKey?: string;
+    supplyLimitKey?: string;
+    borrowLimitKey?: string;
+    isolatedAssetKey?: string;
     sCoinAddress: string | undefined;
     marketCoinAddress: string;
-    coinAddress: string;
     sCoinName: string | undefined;
 };

package/dist/utils/core.d.ts

@@ -0,0 +1,2 @@
+import { SuiObjectData } from '@mysten/sui/client';
+export declare const parseObjectAs: <T>(object: SuiObjectData) => T;

package/dist/utils/index.d.ts

@@ -3,3 +3,4 @@ export * from './query';
 export * from './util';
 export * from './tokenBucket';
 export * from './indexer';
+export * from './core';

package/dist/utils/util.d.ts

@@ -24,3 +24,4 @@ export declare const parseDataFromPythPriceFeed: (feed: PriceFeed, address: Scal
  * @returns Closest round (12AM) in seconds timestamp.
  */
 export declare const findClosestUnlockRound: (unlockAtInSecondTimestamp: number) => number;
+export declare const partitionArray: <T>(array: T[], chunkSize: number) => T[][];

package/package.json

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

package/src/constants/enum.ts

@@ -157,24 +157,16 @@ export const voloCoinIds: types.VoloCoinIds = {
 
 // PROD VERSION
 export const sCoinIds: types.SCoinIds = {
-  // prod values
-  // ssui: '0xaafc4f740de0dd0dde642a31148fb94517087052f19afb0f7bed1dc41a50c77b::scallop_sui::SCALLOP_SUI',
-  // swusdc:
-  //   '0xad4d71551d31092230db1fd482008ea42867dbf27b286e9c70a79d2a6191d58d::scallop_wormhole_usdc::SCALLOP_WORMHOLE_USDC',
-  // swusdt:
-  //   '0xe6e5a012ec20a49a3d1d57bd2b67140b96cd4d3400b9d79e541f7bdbab661f95::scallop_wormhole_usdt::SCALLOP_WORMHOLE_USDT',
-  // ssca: '0x5ca17430c1d046fae9edeaa8fd76c7b4193a00d764a0ecfa9418d733ad27bc1e::scallop_sca::SCALLOP_SCA',
-
-  ssui: '0xf569919046f19a0c40b519ecfbb6ca0319698cd5908716c29b62ef56541f298b::scallop_sui::SCALLOP_SUI',
-  swusdt:
-    '0xac781d9f73058ff5e69f9bf8dde32f2e8c71c66d7fe8497fc83b2d9182254b22::scallop_wormhole_usdt::SCALLOP_WORMHOLE_USDT',
-  swusdc:
-    '0xf5447c4305a486d8c8557559887c2c39449ddb5e748f15d33946d02a1663c158::scallop_wormhole_usdc::SCALLOP_WORMHOLE_USDC',
-  ssca: '0x958428555e778e55918a59eb1c92c77f32b5c554fa3a5e56cd0815086b5072e7::scallop_sca::SCALLOP_SCA',
   susdc:
     '0x854950aa624b1df59fe64e630b2ba7c550642e9342267a33061d59fb31582da5::scallop_usdc::SCALLOP_USDC',
   ssbeth:
     '0xb14f82d8506d139eacef109688d1b71e7236bcce9b2c0ad526abcd6aa5be7de0::scallop_sb_eth::SCALLOP_SB_ETH',
+  ssui: '0xaafc4f740de0dd0dde642a31148fb94517087052f19afb0f7bed1dc41a50c77b::scallop_sui::SCALLOP_SUI',
+  swusdc:
+    '0xad4d71551d31092230db1fd482008ea42867dbf27b286e9c70a79d2a6191d58d::scallop_wormhole_usdc::SCALLOP_WORMHOLE_USDC',
+  swusdt:
+    '0xe6e5a012ec20a49a3d1d57bd2b67140b96cd4d3400b9d79e541f7bdbab661f95::scallop_wormhole_usdt::SCALLOP_WORMHOLE_USDT',
+  ssca: '0x5ca17430c1d046fae9edeaa8fd76c7b4193a00d764a0ecfa9418d733ad27bc1e::scallop_sca::SCALLOP_SCA',
   scetus:
     '0xea346ce428f91ab007210443efcea5f5cdbbb3aae7e9affc0ca93f9203c31f0c::scallop_cetus::SCALLOP_CETUS',
   sweth: