@scallop-io/sui-scallop-sdk 0.42.6 → 0.42.8

package/dist/models/scallopUtils.d.ts

@@ -64,6 +64,7 @@ export declare class ScallopUtils {
      */
     parseCoinNameFromType<T extends SupportAssetCoins>(coinType: string): T extends SupportAssetCoins ? T : SupportAssetCoins;
     parseCoinNameFromType<T extends SupportMarketCoins>(coinType: string): T extends SupportMarketCoins ? T : SupportMarketCoins;
+    parseCoinNameFromType<T extends SupportCoins>(coinType: string): T extends SupportCoins ? T : SupportCoins;
     /**
      * Convert marke coin name to coin name.
      *

package/dist/types/constant/enum.d.ts

@@ -14,3 +14,11 @@ export type StakeMarketCoins = {
 export type RewardCoins = {
     [key in SupportStakeMarketCoins]: SupportRewardCoins;
 };
+export type AssetCoinIds = {
+    [key in SupportAssetCoins]: string;
+};
+type PickFromUnion<T, K extends string> = K extends T ? K : never;
+export type WormholeCoinIds = {
+    [key in PickFromUnion<SupportAssetCoins, 'eth' | 'btc' | 'usdc' | 'usdt' | 'apt' | 'sol'>]: string;
+};
+export {};

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

@@ -109,13 +109,13 @@ export type CollateralStat = {
 };
 export type MarketPool = {
     coinName: SupportPoolCoins;
-    symbol: String;
+    symbol: string;
     coinType: string;
     marketCoinType: string;
     coinWrappedType: CoinWrappedType;
     coinDecimal: number;
     coinPrice: number;
-} & Required<Pick<ParsedMarketPoolData, 'reserveFactor' | 'borrowWeight' | 'marketCoinSupplyAmount' | 'minBorrowAmount'>> & CalculatedMarketPoolData;
+} & Required<Pick<ParsedMarketPoolData, 'highKink' | 'midKink' | 'reserveFactor' | 'borrowWeight' | 'marketCoinSupplyAmount' | 'minBorrowAmount'>> & CalculatedMarketPoolData;
 export type MarketCollateral = {
     coinName: SupportCollateralCoins;
     symbol: string;

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

@@ -17,52 +17,69 @@ export type Lending = Required<Pick<MarketPool, 'coinName' | 'symbol' | 'coinTyp
     stakedAmount: number;
     stakedCoin: number;
     stakedValue: number;
+    unstakedMarketAmount: number;
+    unstakedMarketCoin: number;
+    unstakedAmount: number;
+    unstakedCoin: number;
+    unstakedValue: number;
     availableSupplyAmount: number;
+    availableSupplyCoin: number;
     availableWithdrawAmount: number;
+    availableWithdrawCoin: number;
     availableStakeAmount: number;
+    availableStakeCoin: number;
     availableUnstakeAmount: number;
+    availableUnstakeCoin: number;
     availableClaimAmount: number;
+    availableClaimCoin: number;
 };
 export type ObligationAccount = {
-    obligationId?: string;
-    obligationAccount?: ObligationAccount;
-    totalCollateralValue: number;
-    totalDebtValue: number;
+    obligationId: string;
+    totalDepositedValue: number;
+    totalBorrowedValue: number;
     totalBalanceValue: number;
     totalBorrowCapacityValue: number;
-    availableCollateralValue: number;
-    totalDebtValueWithWeight: number;
+    totalAvailableCollateralValue: number;
+    totalBorrowedValueWithWeight: number;
+    totalRequiredCollateralValue: number;
+    totalUnhealthyCollateralValue: number;
+    totalRiskLevel: number;
+    totalDepositedPools: number;
+    totalBorrowedPools: number;
+    collaterals: OptionalKeys<Record<SupportCollateralCoins, ObligationCollateral>>;
+    debts: OptionalKeys<Record<SupportPoolCoins, ObligationDebt>>;
+};
+export type ObligationCollateral = {
+    coinName: SupportCollateralCoins;
+    coinType: string;
+    symbol: string;
+    coinDecimal: number;
+    coinPrice: number;
+    depositedAmount: number;
+    depositedCoin: number;
+    depositedValue: number;
+    borrowCapacityValue: number;
     requiredCollateralValue: number;
-    unhealthyCollateralValue: number;
-    riskLevel: number;
-    totalCollateralPools: number;
-    totalDebtPools: number;
-    collaterals: OptionalKeys<Record<SupportPoolCoins, {
-        coinName: string;
-        coinType: string;
-        collateralAmount: number;
-        collateralCoin: number;
-        collateralValue: number;
-        borrowCapacityValue: number;
-        requiredCollateralValue: number;
-        availableDepositAmount: number;
-        availableDepositCoin: number;
-        availableWithdrawAmount: number;
-        availableWithdrawCoin: number;
-    }>>;
-    debts: OptionalKeys<Record<SupportCollateralCoins, {
-        coinName: string;
-        coinType: string;
-        debtAmount: number;
-        debtCoin: number;
-        debtValue: number;
-        debtValueWithWeight: number;
-        borrowIndex: number;
-        availableBorrowAmount: number;
-        availableBorrowCoin: number;
-        availableRepayAmount: number;
-        availableRepayCoin: number;
-    }>>;
+    availableDepositAmount: number;
+    availableDepositCoin: number;
+    availableWithdrawAmount: number;
+    availableWithdrawCoin: number;
+};
+export type ObligationDebt = {
+    coinName: SupportPoolCoins;
+    coinType: string;
+    symbol: string;
+    coinDecimal: number;
+    coinPrice: number;
+    borrowedAmount: number;
+    borrowedCoin: number;
+    borrowedValue: number;
+    borrowedValueWithWeight: number;
+    borrowIndex: number;
+    availableBorrowAmount: number;
+    availableBorrowCoin: number;
+    availableRepayAmount: number;
+    availableRepayCoin: number;
 };
 export type TotalValueLocked = {
     supplyValue: number;

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

@@ -7,8 +7,8 @@ export type RewardPools = OptionalKeys<Record<SupportStakeMarketCoins, RewardPoo
 export type StakeAccounts = Record<SupportStakeMarketCoins, StakeAccount[]>;
 export type Spools = OptionalKeys<Record<SupportStakeMarketCoins, Spool>>;
 export type Spool = {
-    marketCoin: SupportStakeMarketCoins;
-    symbol: String;
+    marketCoinName: SupportStakeMarketCoins;
+    symbol: string;
     coinType: string;
     marketCoinType: string;
     rewardCoinType: string;
@@ -72,7 +72,7 @@ export type ParsedRewardPoolData = {
     spoolId: string;
 };
 export type CalculatedRewardPoolData = {
-    stakeApr: number;
+    rewardApr: number;
     totalRewardAmount: number;
     totalRewardCoin: number;
     totalRewardValue: number;

package/dist/utils/query.d.ts

@@ -1,3 +1,4 @@
+import BigNumber from 'bignumber.js';
 import type { ScallopUtils } from '../models';
 import type { OriginMarketPoolData, ParsedMarketPoolData, CalculatedMarketPoolData, OriginMarketCollateralData, ParsedMarketCollateralData, CalculatedMarketCollateralData, OriginStakePoolData, ParsedStakePoolData, CalculatedStakePoolData, OriginRewardPoolData, ParsedRewardPoolData, CalculatedRewardPoolData } from '../types';
 /**
@@ -32,3 +33,5 @@ export declare const calculateStakePoolData: (parsedStakePoolData: ParsedStakePo
  */
 export declare const parseOriginRewardPoolData: (originRewardPoolData: OriginRewardPoolData) => ParsedRewardPoolData;
 export declare const calculateRewardPoolData: (parsedStakePoolData: ParsedStakePoolData, parsedRewardPoolData: ParsedRewardPoolData, calculatedStakePoolData: CalculatedStakePoolData, rewardCoinPrice: number, rewardCoinDecimal: number) => CalculatedRewardPoolData;
+export declare const minBigNumber: (...args: BigNumber.Value[]) => BigNumber;
+export declare const maxBigNumber: (...args: BigNumber.Value[]) => BigNumber;

package/package.json

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

package/src/constants/enum.ts

@@ -4,6 +4,8 @@ import type {
   MarketCoins,
   StakeMarketCoins,
   RewardCoins,
+  AssetCoinIds,
+  WormholeCoinIds,
 } from '../types';
 
 export const coinDecimals: SupportCoinDecimals = {
@@ -58,3 +60,23 @@ export const rewardCoins: RewardCoins = {
   susdc: 'sui',
   susdt: 'sui',
 };
+
+export const coinIds: AssetCoinIds = {
+  sui: '0x0000000000000000000000000000000000000000000000000000000000000002',
+  eth: '0xaf8cd5edc19c4512f4259f0bee101a40d41ebed738ade5874359610ef8eeced5',
+  btc: '0x027792d9fed7f9844eb4839566001bb6f6cb4804f66aa2da6fe1ee242d896881',
+  usdc: '0x5d4b302506645c37ff133b98c4b50a5ae14841659738d6d733d59d0d217a93bf',
+  usdt: '0xc060006111016b8a020ad5b33834984a437aaa7d3c74c18e09a95d48aceab08c',
+  apt: '0x3a5143bb1196e3bcdfab6203d1683ae29edd26294fc8bfeafe4aaa9d2704df37',
+  sol: '0xb7844e289a8410e50fb3ca48d69eb9cf29e27d223ef90353fe1bd8e27ff8f3f8',
+  cetus: '0x06864a6f921804860930db6ddbe2e16acdf8504495ea7481637a1c8b9a8fe54b',
+};
+
+export const wormholeCoinIds: WormholeCoinIds = {
+  eth: '0xaf8cd5edc19c4512f4259f0bee101a40d41ebed738ade5874359610ef8eeced5',
+  btc: '0x027792d9fed7f9844eb4839566001bb6f6cb4804f66aa2da6fe1ee242d896881',
+  usdc: '0x5d4b302506645c37ff133b98c4b50a5ae14841659738d6d733d59d0d217a93bf',
+  usdt: '0xc060006111016b8a020ad5b33834984a437aaa7d3c74c18e09a95d48aceab08c',
+  apt: '0x3a5143bb1196e3bcdfab6203d1683ae29edd26294fc8bfeafe4aaa9d2704df37',
+  sol: '0xb7844e289a8410e50fb3ca48d69eb9cf29e27d223ef90353fe1bd8e27ff8f3f8',
+};

package/src/models/scallopUtils.ts

@@ -10,6 +10,8 @@ import {
   SUPPORT_COLLATERALS,
   rewardCoins,
   coinDecimals,
+  wormholeCoinIds,
+  coinIds,
 } from '../constants';
 import { queryObligation } from '../queries';
 import { parseDataFromPythPriceFeed, isMarketCoin } from '../utils';
@@ -108,16 +110,22 @@ export class ScallopUtils {
    */
   public parseCoinType(coinName: SupportCoins) {
     coinName = isMarketCoin(coinName) ? this.parseCoinName(coinName) : coinName;
-    const coinPackageId = this._address.get(`core.coins.${coinName}.id`);
+    const coinPackageId =
+      this._address.get(`core.coins.${coinName}.id`) ??
+      coinIds[coinName] ??
+      undefined;
+    if (!coinPackageId) {
+      throw Error(`Coin ${coinName} is not supported`);
+    }
     if (coinName === 'sui')
       return normalizeStructTag(`${coinPackageId}::sui::SUI`);
     const wormHoleCoinIds = [
-      this._address.get('core.coins.usdc.id'),
-      this._address.get('core.coins.usdt.id'),
-      this._address.get('core.coins.eth.id'),
-      this._address.get('core.coins.btc.id'),
-      this._address.get('core.coins.sol.id'),
-      this._address.get('core.coins.apt.id'),
+      this._address.get('core.coins.usdc.id') ?? wormholeCoinIds.usdc,
+      this._address.get('core.coins.usdt.id') ?? wormholeCoinIds.usdt,
+      this._address.get('core.coins.eth.id') ?? wormholeCoinIds.eth,
+      this._address.get('core.coins.btc.id') ?? wormholeCoinIds.btc,
+      this._address.get('core.coins.sol.id') ?? wormholeCoinIds.sol,
+      this._address.get('core.coins.apt.id') ?? wormholeCoinIds.apt,
     ];
     if (wormHoleCoinIds.includes(coinPackageId)) {
       return `${coinPackageId}::coin::COIN`;
@@ -154,6 +162,9 @@ export class ScallopUtils {
   public parseCoinNameFromType<T extends SupportMarketCoins>(
     coinType: string
   ): T extends SupportMarketCoins ? T : SupportMarketCoins;
+  public parseCoinNameFromType<T extends SupportCoins>(
+    coinType: string
+  ): T extends SupportCoins ? T : SupportCoins;
   public parseCoinNameFromType(coinType: string) {
     coinType = normalizeStructTag(coinType);
     const coinTypeRegex = new RegExp(`((0x[^:]+::[^:]+::[^<>]+))(?![^<>]*<)`);
@@ -162,12 +173,24 @@ export class ScallopUtils {
     coinType = coinTypeMatch?.[1] || coinType;
 
     const wormHoleCoinTypeMap: Record<string, SupportAssetCoins> = {
-      [`${this._address.get('core.coins.usdc.id')}::coin::COIN`]: 'usdc',
-      [`${this._address.get('core.coins.usdt.id')}::coin::COIN`]: 'usdt',
-      [`${this._address.get('core.coins.eth.id')}::coin::COIN`]: 'eth',
-      [`${this._address.get('core.coins.btc.id')}::coin::COIN`]: 'btc',
-      [`${this._address.get('core.coins.sol.id')}::coin::COIN`]: 'sol',
-      [`${this._address.get('core.coins.apt.id')}::coin::COIN`]: 'apt',
+      [`${
+        this._address.get('core.coins.usdc.id') ?? wormholeCoinIds.usdc
+      }::coin::COIN`]: 'usdc',
+      [`${
+        this._address.get('core.coins.usdt.id') ?? wormholeCoinIds.usdt
+      }::coin::COIN`]: 'usdt',
+      [`${
+        this._address.get('core.coins.eth.id') ?? wormholeCoinIds.eth
+      }::coin::COIN`]: 'eth',
+      [`${
+        this._address.get('core.coins.btc.id') ?? wormholeCoinIds.btc
+      }::coin::COIN`]: 'btc',
+      [`${
+        this._address.get('core.coins.sol.id') ?? wormholeCoinIds.sol
+      }::coin::COIN`]: 'sol',
+      [`${
+        this._address.get('core.coins.apt.id') ?? wormholeCoinIds.apt
+      }::coin::COIN`]: 'apt',
     };
 
     const assetCoinName =

package/src/queries/coreQuery.ts

@@ -98,6 +98,8 @@ export const queryMarket = async (query: ScallopQuery) => {
       coinWrappedType: query.utils.getCoinWrappedType(poolCoinName),
       coinDecimal: query.utils.getCoinDecimal(poolCoinName),
       coinPrice: coinPrice,
+      highKink: parsedMarketPoolData.highKink,
+      midKink: parsedMarketPoolData.midKink,
       reserveFactor: parsedMarketPoolData.reserveFactor,
       borrowWeight: parsedMarketPoolData.borrowWeight,
       marketCoinSupplyAmount: parsedMarketPoolData.marketCoinSupplyAmount,
@@ -352,6 +354,8 @@ export const getMarketPool = async (
       coinWrappedType: query.utils.getCoinWrappedType(poolCoinName),
       coinDecimal: query.utils.getCoinDecimal(poolCoinName),
       coinPrice: coinPrice ?? 0,
+      highKink: parsedMarketPoolData.highKink,
+      midKink: parsedMarketPoolData.midKink,
       reserveFactor: parsedMarketPoolData.reserveFactor,
       borrowWeight: parsedMarketPoolData.borrowWeight,
       marketCoinSupplyAmount: parsedMarketPoolData.marketCoinSupplyAmount,