@scallop-io/sui-scallop-sdk 2.2.3-pyth-sponsored-transaction-alpha.1 → 2.3.0-lst-x-oracle-alpha.2

package/src/models/scallopIndexer.ts

@@ -10,9 +10,10 @@ import {
   Spool,
   Spools,
   TotalValueLocked,
-} from 'src/types';
+} from 'src/types/query';
 import ScallopAxios, { ScallopAxiosParams } from './scallopAxios';
-import { queryKeys, SDK_API_BASE_URL } from 'src/constants';
+import { SDK_API_BASE_URL } from 'src/constants/api';
+import { queryKeys } from 'src/constants/queryKeys';
 
 export type ScallopIndexerParams = {
   indexerApiUrl?: string;

package/src/models/scallopQuery.ts

@@ -2,65 +2,82 @@ import ScallopUtils, { ScallopUtilsParams } from './scallopUtils';
 import ScallopIndexer, { ScallopIndexerParams } from './scallopIndexer';
 import { withIndexerFallback } from 'src/utils';
 import {
-  CoinPrices,
   MarketCollaterals,
   MarketPool,
   MarketPools,
   StakePools,
   StakeRewardPools,
-  SupportOracleType,
-  xOracleRules,
-} from 'src/types';
+} from 'src/types/query';
+import { SuiObjectRef, SuiObjectData } from '@mysten/sui/dist/cjs/client';
+import { SuiObjectArg } from '@scallop-io/sui-kit';
+import { ScallopQueryInterface } from './interface';
 import {
-  getAllCoinPrices,
-  getAssetOracles,
+  getBorrowIncentivePools,
+  queryBorrowIncentiveAccounts,
   getBindedObligationId,
   getBindedVeScaKey,
-  getBorrowIncentivePools,
-  getBorrowLimit,
-  getCoinAmount,
+} from 'src/queries/borrowIncentiveQuery';
+import { getBorrowLimit } from 'src/queries/borrowLimitQuery';
+import {
+  queryMarket,
+  getMarketPools,
+  getMarketCollaterals,
+  getMarketCollateral,
+  getObligations,
+  queryObligation,
   getCoinAmounts,
+  getCoinAmount,
+  getMarketCoinAmounts,
+  getMarketCoinAmount,
   getFlashLoanFees,
+} from 'src/queries/coreQuery';
+import {
   getIsolatedAssets,
-  getLending,
-  getLendings,
+  isIsolatedAsset,
+} from 'src/queries/isolatedAssetQuery';
+import {
   getLoyaltyProgramInformations,
-  getMarketCoinAmount,
-  getMarketCoinAmounts,
-  getMarketCollateral,
-  getMarketCollaterals,
-  getMarketPools,
+  getVeScaLoyaltyProgramInformations,
+} from 'src/queries/loyaltyProgramQuery';
+import { getPoolAddresses } from 'src/queries/poolAddressesQuery';
+import {
+  getLendings,
+  getLending,
   getObligationAccounts,
-  getObligations,
-  getOnDemandAggObjectIds,
-  getPoolAddresses,
-  getPriceUpdatePolicies,
+  getTotalValueLocked,
+  getUserPortfolio,
+} from 'src/queries/portfolioQuery';
+import {
   getPythPrice,
   getPythPrices,
-  getSCoinAmount,
+  getAllCoinPrices,
+} from 'src/queries/priceQuery';
+import { queryVeScaKeyIdFromReferralBindings } from 'src/queries/referralQuery';
+import {
+  getSCoinTotalSupply,
   getSCoinAmounts,
+  getSCoinAmount,
   getSCoinSwapRate,
-  getSCoinTotalSupply,
+} from 'src/queries/sCoinQuery';
+import {
   getSpools,
   getStakeAccounts,
   getStakePool,
   getStakeRewardPool,
-  getSupplyLimit,
-  getTotalValueLocked,
-  getUserPortfolio,
+} from 'src/queries/spoolQuery';
+import { getSupplyLimit } from 'src/queries/supplyLimitQuery';
+import { getOnDemandAggObjectIds } from 'src/queries/switchboardQuery';
+import {
   getVeSca,
-  getVeScaLoyaltyProgramInformations,
   getVeScas,
   getVeScaTreasuryInfo,
-  isIsolatedAsset,
-  queryBorrowIncentiveAccounts,
-  queryMarket,
-  queryObligation,
-  queryVeScaKeyIdFromReferralBindings,
-} from 'src/queries';
-import { SuiObjectRef, SuiObjectData } from '@mysten/sui/dist/cjs/client';
-import { SuiObjectArg } from '@scallop-io/sui-kit';
-import { ScallopQueryInterface } from './interface';
+} from 'src/queries/vescaQuery';
+import {
+  getPriceUpdatePolicies,
+  getAssetOracles,
+} from 'src/queries/xOracleQuery';
+import { CoinPrices } from 'src/types/utils';
+import { SupportOracleType, xOracleRules } from 'src/types/constant';
 
 export type ScallopQueryParams = {
   indexer?: ScallopIndexer;
@@ -851,7 +868,6 @@ class ScallopQuery implements ScallopQueryInterface {
 
   /**
    * Return the supported primary and secondary oracles for all supported pool assets
-   * @returns
    */
   async getAssetOracles() {
     const [primary, secondary] = await Promise.all([

package/src/models/scallopQueryClient.ts

@@ -1,5 +1,5 @@
 import { QueryClient, QueryClientConfig } from '@tanstack/query-core';
-import { DEFAULT_CACHE_OPTIONS } from 'src/constants';
+import { DEFAULT_CACHE_OPTIONS } from 'src/constants/cache';
 
 export type ScallopQueryClientParams = {
   queryClient?: QueryClient;

package/src/models/scallopSuiKit.ts

@@ -8,7 +8,7 @@ import {
   SuiTxBlock,
   Transaction,
 } from '@scallop-io/sui-kit';
-import { queryKeys } from 'src/constants';
+import { queryKeys } from 'src/constants/queryKeys';
 import {
   CoinBalance,
   DevInspectResults,

package/src/models/scallopUtils.ts

@@ -7,18 +7,16 @@ import {
   Transaction,
 } from '@scallop-io/sui-kit';
 import ScallopConstants, { ScallopConstantsParams } from './scallopConstants';
-import { CoinPrices, CoinWrappedType, PoolAddress } from 'src/types';
 import { findClosestUnlockRound } from 'src/utils';
-import {
-  MAX_LOCK_DURATION,
-  queryKeys,
-  UNLOCK_ROUND_DURATION,
-} from 'src/constants';
 import { PriceFeed, SuiPriceServiceConnection } from '@pythnetwork/pyth-sui-js';
 import ScallopSuiKit, { ScallopSuiKitParams } from './scallopSuiKit';
 import { SuiObjectData } from '@mysten/sui/dist/cjs/client';
-import { queryObligation } from 'src/queries';
+import { queryObligation } from 'src/queries/coreQuery';
 import { ScallopUtilsInterface } from './interface';
+import { MAX_LOCK_DURATION, UNLOCK_ROUND_DURATION } from 'src/constants/vesca';
+import { queryKeys } from 'src/constants/queryKeys';
+import { CoinWrappedType, PoolAddress } from 'src/types/constant';
+import { CoinPrices } from 'src/types/utils';
 
 export type ScallopUtilsParams = {
   pythEndpoints?: string[];
@@ -43,7 +41,6 @@ class ScallopUtils implements ScallopUtilsInterface {
 
     this.pythEndpoints = params.pythEndpoints ?? [
       'https://hermes.pyth.network',
-      'https://scallop.rpc.p2p.world',
     ];
   }
 

package/src/queries/borrowIncentiveQuery.ts

@@ -16,12 +16,11 @@ import type {
   BorrowIncentiveAccountsQueryInterface,
   BorrowIncentiveAccounts,
   BorrowIncentivePoolPoints,
-  OptionalKeys,
-  CoinPrices,
   MarketPools,
-} from 'src/types';
+} from 'src/types/query';
 import BigNumber from 'bignumber.js';
 import { SuiObjectRef } from '@mysten/sui/client';
+import { CoinPrices, OptionalKeys } from 'src/types/utils';
 
 /**
  * Query borrow incentive pools data using moveCall

package/src/queries/coreQuery.ts

@@ -26,13 +26,11 @@ import {
   BalanceSheet,
   RiskModel,
   CollateralStat,
-  OptionalKeys,
-  CoinPrices,
   OriginMarketPoolData,
   BorrowFee,
   BorrowDynamic,
   OriginMarketCollateralData,
-} from 'src/types';
+} from 'src/types/query';
 import BigNumber from 'bignumber.js';
 import { getSupplyLimit } from './supplyLimitQuery';
 import { isIsolatedAsset } from './isolatedAssetQuery';
@@ -45,6 +43,7 @@ import {
   ScallopIndexer,
   ScallopAddress,
 } from 'src/models';
+import { CoinPrices, OptionalKeys } from 'src/types';
 
 /**
  * Query market data.

package/src/queries/index.ts

@@ -1,15 +1,16 @@
 export * from './borrowIncentiveQuery';
+export * from './borrowLimitQuery';
 export * from './coreQuery';
+export * from './flashloanFeeQuery';
 export * from './isolatedAssetQuery';
 export * from './loyaltyProgramQuery';
+export * from './poolAddressesQuery';
 export * from './portfolioQuery';
 export * from './priceQuery';
 export * from './referralQuery';
 export * from './sCoinQuery';
 export * from './spoolQuery';
 export * from './supplyLimitQuery';
-export * from './vescaQuery';
-export * from './borrowLimitQuery';
-export * from './poolAddressesQuery';
 export * from './switchboardQuery';
+export * from './vescaQuery';
 export * from './xOracleQuery';

package/src/queries/loyaltyProgramQuery.ts

@@ -1,6 +1,6 @@
 import { SuiObjectData } from '@mysten/sui/client';
 import BigNumber from 'bignumber.js';
-import { MAX_LOCK_DURATION } from 'src/constants';
+import { MAX_LOCK_DURATION } from 'src/constants/vesca';
 import { ScallopQuery } from 'src/models';
 import { LoyaltyProgramInfo, VeScaLoyaltyProgramInfo } from 'src/types';
 import { z as zod } from 'zod';

package/src/queries/portfolioQuery.ts

@@ -1,24 +1,24 @@
 import BigNumber from 'bignumber.js';
 import { minBigNumber, estimatedFactor } from 'src/utils';
 import type { ScallopQuery } from 'src/models';
-import type {
+import { SuiObjectRef } from '@mysten/sui/client';
+import { normalizeStructTag, SUI_TYPE_ARG } from '@scallop-io/sui-kit';
+import {
+  CoinAmounts,
+  Lending,
+  Lendings,
   Market,
+  MarketCollaterals,
   MarketPool,
+  MarketPools,
+  ObligationAccount,
+  ObligationAccounts,
+  ObligationBorrowIncentiveReward,
   Spool,
   StakeAccount,
-  Lendings,
-  Lending,
-  ObligationAccounts,
-  ObligationAccount,
-  CoinAmounts,
-  CoinPrices,
   TotalValueLocked,
-  ObligationBorrowIncentiveReward,
-  MarketPools,
-  MarketCollaterals,
-} from 'src/types';
-import { SuiObjectRef } from '@mysten/sui/client';
-import { normalizeStructTag, SUI_TYPE_ARG } from '@scallop-io/sui-kit';
+} from 'src/types/query';
+import { CoinPrices } from 'src/types/utils';
 
 /**
  * Get user lending infomation for specific pools.

package/src/queries/sCoinQuery.ts

@@ -2,7 +2,7 @@ import { bcs } from '@mysten/sui/bcs';
 import assert from 'assert';
 import BigNumber from 'bignumber.js';
 import { ScallopQuery, ScallopUtils } from 'src/models';
-import { OptionalKeys, sCoinBalance } from 'src/types';
+import { OptionalKeys } from 'src/types';
 
 /**
  * Get total supply of sCoin
@@ -17,7 +17,7 @@ export const getSCoinTotalSupply = async (
     utils: ScallopUtils;
   },
   sCoinName: string
-): Promise<sCoinBalance> => {
+): Promise<number> => {
   const sCoinPkgId = utils.address.get('scoin.id');
   // get treasury
   const args = [utils.getSCoinTreasury(sCoinName)];

package/src/queries/spoolQuery.ts

@@ -8,18 +8,18 @@ import {
 } from 'src/utils';
 import type { SuiObjectData, SuiObjectResponse } from '@mysten/sui/client';
 import type { ScallopQuery, ScallopUtils } from 'src/models';
-import type {
+import { CoinPrices } from 'src/types';
+import {
+  OriginSpoolData,
+  OriginSpoolRewardPoolData,
+  SpoolData,
+  MarketPools,
   Spools,
   Spool,
+  StakeAccounts,
   StakePool,
   StakeRewardPool,
-  StakeAccounts,
-  CoinPrices,
-  MarketPools,
-  OriginSpoolRewardPoolData,
-  SpoolData,
-  OriginSpoolData,
-} from '../types';
+} from 'src/types/query';
 
 const queryRequiredSpoolObjects = async (
   query: ScallopQuery,

package/src/queries/vescaQuery.ts

@@ -6,11 +6,11 @@ import {
   DevInspectResults,
 } from '@mysten/sui/client';
 import type { ScallopUtils } from 'src/models';
-import { MAX_LOCK_DURATION } from 'src/constants';
+import { MAX_LOCK_DURATION } from 'src/constants/vesca';
 import { SUI_CLOCK_OBJECT_ID, SuiTxBlock } from '@scallop-io/sui-kit';
 import { bcs } from '@mysten/sui/bcs';
 import { z as zod } from 'zod';
-import { queryKeys } from 'src/constants';
+import { queryKeys } from 'src/constants/queryKeys';
 import assert from 'assert';
 /**
  * Query all owned veSca key.

package/src/queries/xOracleQuery.ts

@@ -61,11 +61,28 @@ export const getAssetOracles = async (
     return null;
   }
 
+  const createRuleType = (objectId: string): string => {
+    return `${objectId}::rule::Rule`;
+  };
+
+  const pythLstRuleTypeNameToOracleType: Record<string, SupportOracleType> =
+    Object.values<{
+      object: string;
+    }>(utils.address.get('core.packages.pyth.lst') ?? {}).reduce(
+      (acc, curr) => {
+        acc[createRuleType(curr.object)] = 'pyth';
+        return acc;
+      },
+      {} as Record<string, SupportOracleType>
+    );
+
   const ruleTypeNameToOracleType: Record<string, SupportOracleType> = {
-    [`${utils.address.get('core.packages.pyth.object')}::rule::Rule`]: 'pyth',
-    [`${utils.address.get('core.packages.supra.object')}::rule::Rule`]: 'supra',
-    [`${utils.address.get('core.packages.switchboard.object')}::rule::Rule`]:
+    [createRuleType(utils.address.get('core.packages.pyth.object'))]: 'pyth',
+    // include the pyth lst type
+    [createRuleType(utils.address.get('core.packages.supra.object'))]: 'supra',
+    [createRuleType(utils.address.get('core.packages.switchboard.object'))]:
       'switchboard',
+    ...pythLstRuleTypeNameToOracleType,
   };
 
   const assetOracles = {} as Record<string, SupportOracleType[]>;

package/src/types/address.ts

@@ -1,5 +1,54 @@
-import { _SUPPORT_ORACLES, SupportOracleType } from './constant/xOracle';
+import { SUPPORT_ORACLE_LST, SUPPORT_ORACLES } from 'src/constants/xoracle';
+import { SupportOracleType, SupportedOracleSuiLst } from './constant/xOracle';
+import { PackageName } from './constant/package';
 
+export type BasePackage = {
+  id: string;
+  object?: string;
+  upgradeCap?: string;
+};
+
+export type OracleLstPackage = {
+  [K in SupportedOracleSuiLst]: BasePackage;
+};
+
+type OraclePackage<T> = BasePackage & T extends SupportOracleLst
+  ? BasePackage & {
+      lst: OracleLstPackage;
+    }
+  : BasePackage;
+
+type Packages<
+  T extends SupportOracleType | PackageName = SupportOracleType | PackageName,
+> = T extends SupportOracleType
+  ? Record<T, OraclePackage<T>>
+  : T extends PackageName
+    ? Record<T, BasePackage>
+    : never;
+
+export type SupportOracleLst = (typeof SUPPORT_ORACLE_LST)[number];
+
+export type OracleLstConfig<T extends SupportedOracleSuiLst> = T extends 'afsui'
+  ? Record<
+      T,
+      {
+        stakedSuiVaultId: string;
+        safeId: string;
+        configId: string;
+      }
+    >
+  : never;
+
+export type OracleLst<
+  T extends SupportOracleLst,
+  U extends SupportedOracleSuiLst = SupportedOracleSuiLst,
+> = T extends 'pyth' ? OracleLstConfig<U> : undefined;
+
+type MaybeWithOracleLst<T, U> = T extends SupportOracleLst
+  ? U & {
+      lst: OracleLst<T>;
+    }
+  : U;
 export interface AddressesInterface {
   id?: string;
   core: {
@@ -21,11 +70,11 @@ export interface AddressesInterface {
           symbol: string;
           decimals: number;
           oracle: {
-            [K in SupportOracleType]: K extends (typeof _SUPPORT_ORACLES)[0]
+            [K in SupportOracleType]: K extends (typeof SUPPORT_ORACLES)[0]
               ? string
-              : K extends (typeof _SUPPORT_ORACLES)[1]
+              : K extends (typeof SUPPORT_ORACLES)[1]
                 ? string
-                : K extends (typeof _SUPPORT_ORACLES)[2]
+                : K extends (typeof SUPPORT_ORACLES)[2]
                   ? {
                       feed: string;
                       feedObject: string;
@@ -36,27 +85,36 @@ export interface AddressesInterface {
       >
     >;
     oracles: {
-      [K in SupportOracleType]: K extends (typeof _SUPPORT_ORACLES)[0]
-        ? {
-            registry: string;
-            registryCap: string;
-            holder: string;
-          }
-        : K extends (typeof _SUPPORT_ORACLES)[1]
-          ? {
+      [K in SupportOracleType]: K extends (typeof SUPPORT_ORACLES)[0]
+        ? MaybeWithOracleLst<
+            K,
+            {
               registry: string;
               registryCap: string;
-              registryTableId: string;
-              state: string;
+              holder: string;
             }
-          : K extends (typeof _SUPPORT_ORACLES)[2]
-            ? {
+          >
+        : K extends (typeof SUPPORT_ORACLES)[1]
+          ? MaybeWithOracleLst<
+              K,
+              {
                 registry: string;
                 registryCap: string;
+                registryTableId: string;
                 state: string;
-                wormhole: string;
-                wormholeState: string;
               }
+            >
+          : K extends (typeof SUPPORT_ORACLES)[2]
+            ? MaybeWithOracleLst<
+                K,
+                {
+                  registry: string;
+                  registryCap: string;
+                  state: string;
+                  wormhole: string;
+                  wormholeState: string;
+                }
+              >
             : never;
     } & {
       xOracle: string;
@@ -66,16 +124,7 @@ export interface AddressesInterface {
       primaryPriceUpdatePolicyVecsetId: string;
       secondaryPriceUpdatePolicyVecsetId: string;
     };
-    packages: Partial<
-      Record<
-        string,
-        {
-          id: string;
-          object?: string;
-          upgradeCap: string;
-        }
-      >
-    >;
+    packages: Packages;
   };
   spool: {
     id: string;
@@ -156,23 +205,12 @@ export interface AddressesInterface {
   };
 }
 
-type AddressPathsProps<T> = T extends string
-  ? []
-  : {
-      [K in Extract<keyof T, string>]: [K, ...AddressPathsProps<T[K]>];
-    }[Extract<keyof T, string>];
-
-type Join<T extends string[], D extends string> = T extends []
-  ? never
-  : T extends [infer F]
-    ? F
-    : T extends [infer F, ...infer R]
-      ? F extends string
-        ? `${F}${D}${Join<Extract<R, string[]>, D>}`
-        : never
-      : string;
+type Paths<T> = T extends object
+  ? {
+      [K in Extract<keyof T, string>]: T[K] extends object // if T[K] is itself an object, emit K *and* K.<deep>
+        ? K | `${K}.${Paths<T[K]>}`
+        : K;
+    }[Extract<keyof T, string>]
+  : never;
 
-export type AddressStringPath = Join<
-  AddressPathsProps<AddressesInterface>,
-  '.'
->;
+export type AddressStringPath = Paths<AddressesInterface>;

package/src/types/builder/core.ts

@@ -99,16 +99,14 @@ export type CoreQuickMethods = {
     amount: number,
     poolCoinName: string,
     obligationId?: SuiObjectArg,
-    obligationKey?: SuiObjectArg,
-    isSponsoredTx?: boolean
+    obligationKey?: SuiObjectArg
   ) => Promise<TransactionResult>;
   borrowWithReferralQuick: (
     amount: number,
     poolCoinName: string,
     borrowReferral: SuiObjectArg,
     obligationId?: SuiObjectArg,
-    obligationKey?: SuiObjectArg,
-    isSponsoredTx?: boolean
+    obligationKey?: SuiObjectArg
   ) => Promise<TransactionResult>;
   depositQuick: (
     amount: number,

package/src/types/constant/index.ts

@@ -1,3 +1,4 @@
 export type * from './common';
-export type * from './enum';
+export type * from './queryKeys';
 export type * from './xOracle';
+export type * from './package';

package/src/types/constant/package.ts

@@ -0,0 +1,3 @@
+import { PACKAGE_NAMES } from 'src/constants/package';
+
+export type PackageName = (typeof PACKAGE_NAMES)[number];

package/src/types/constant/xOracle.ts

@@ -1,12 +1,15 @@
-export const _SUPPORT_ORACLES = ['supra', 'switchboard', 'pyth'] as const;
-export type SupportOracleType = (typeof _SUPPORT_ORACLES)[number];
+import {
+  SUPPORT_ORACLES,
+  X_ORACLE_RULES,
+  SUPPORT_SUI_LST,
+} from 'src/constants/xoracle';
 
-export type xOracleRules = {
-  primary: SupportOracleType[];
-  secondary: SupportOracleType[];
-};
-export type xOracleRuleType = keyof xOracleRules;
+export type SupportOracleType = (typeof SUPPORT_ORACLES)[number];
+export type xOracleRuleType = (typeof X_ORACLE_RULES)[number];
+
+export type xOracleRules = Record<xOracleRuleType, SupportOracleType[]>;
 
 export type xOracleListType = {
   [key in string]: xOracleRules;
 };
+export type SupportedOracleSuiLst = (typeof SUPPORT_SUI_LST)[number];

package/src/types/query/index.ts

@@ -2,6 +2,5 @@ export type * from './borrowIncentive';
 export type * from './core';
 export type * from './loyaltyProgram';
 export type * from './portfolio';
-export type * from './sCoin';
 export type * from './spool';
 export type * from './vesca';

package/src/utils/builder.ts

@@ -5,7 +5,7 @@ import {
   MAX_LOCK_ROUNDS,
   MIN_INITIAL_LOCK_AMOUNT,
   MIN_TOP_UP_AMOUNT,
-} from 'src/constants';
+} from 'src/constants/vesca';
 import type { SuiObjectArg } from '@scallop-io/sui-kit';
 
 /**

package/src/utils/index.ts

@@ -1,5 +1,5 @@
 export * from './builder';
+export * from './core';
+export * from './indexer';
 export * from './query';
 export * from './util';
-export * from './indexer';
-export * from './core';