@scallop-io/sui-scallop-sdk 2.3.0-lst-x-oracle-alpha.4 → 2.3.0-lst-x-oracle-alpha.6

package/src/builders/sCoinBuilder.ts

@@ -8,8 +8,8 @@ import {
   ScallopTxBlock,
   SuiTxBlockWithSCoinNormalMethods,
   sCoinPkgIds,
-} from 'src/types';
-import { requireSender } from 'src/utils';
+} from 'src/types/builder';
+import { requireSender } from './utils';
 
 const generateSCoinNormalMethod: GenerateSCoinNormalMethod = ({
   builder,

package/src/builders/spoolBuilder.ts

@@ -2,7 +2,7 @@ import { Transaction } from '@mysten/sui/transactions';
 import { SUI_CLOCK_OBJECT_ID } from '@mysten/sui/utils';
 import { SuiTxBlock as SuiKitTxBlock } from '@scallop-io/sui-kit';
 import { getStakeAccounts } from '../queries/spoolQuery';
-import { requireSender } from '../utils';
+import { requireSender } from './utils';
 import type { SuiAddressArg } from '@scallop-io/sui-kit';
 import type { TransactionResult } from '@mysten/sui/transactions';
 import type { ScallopBuilder } from 'src/models';
@@ -14,7 +14,7 @@ import type {
   SpoolTxBlock,
   ScallopTxBlock,
   SuiTxBlockWithSCoin,
-} from 'src/types';
+} from 'src/types/builder';
 
 /**
  * Check and get stake account id from transaction block.

package/src/builders/vescaBuilder.ts

@@ -14,21 +14,21 @@ import {
   checkExtendLockAmount,
   checkRenewExpiredVeSca,
   checkVesca,
-} from 'src/utils';
+} from './utils';
 import type {
   TransactionObjectArgument,
   SuiObjectArg,
 } from '@scallop-io/sui-kit';
 import type {
-  AddressesInterface,
   GenerateVeScaNormalMethod,
   GenerateVeScaQuickMethod,
   QuickMethodReturnType,
   ScallopTxBlock,
   SuiTxBlockWithVeScaNormalMethods,
   VeScaTxBlock,
-} from 'src/types';
+} from 'src/types/builder';
 import { SuiObjectData } from '@mysten/sui/client';
+import { AddressesInterface } from 'src/types/address';
 
 /**
  * Check and get veSCA data from transaction block.

package/src/constants/index.ts

@@ -1,7 +1,6 @@
 export * from './api';
 export * from './cache';
 export * from './common';
-export * from './package';
 export * from './queryKeys';
 export * from './rpc';
 export * from './testAddress';

package/src/constants/testAddress.ts

@@ -449,7 +449,7 @@ export const TEST_ADDRESSES: AddressesInterface = {
   },
 };
 
-export const WHITELIST = {
+export const TEST_WHITELIST = {
   lending: new Set([
     'usdc',
     // 'sbeth',
@@ -584,7 +584,7 @@ export const WHITELIST = {
   emerging: new Set(['wal', 'deep', 'sca', 'cetus']),
 };
 
-export const POOL_ADDRESSES = {
+export const TEST_POOL_ADDRESSES = {
   usdc: {
     coinName: 'usdc',
     symbol: 'USDC',

package/src/index.ts

@@ -1,3 +1,12 @@
-export type * from './constants';
-export type * from './models';
-export type * from './types';
+export * from './constants';
+export {
+  Scallop,
+  ScallopConstants,
+  ScallopAddress,
+  ScallopBuilder,
+  ScallopQuery,
+  ScallopSuiKit,
+  ScallopClient,
+  ScallopIndexer,
+  ScallopUtils,
+} from './models';

package/src/models/scallop.ts

@@ -18,7 +18,7 @@ import ScallopClient, { ScallopClientParams } from './scallopClient';
  * ```
  */
 
-export type ScallopParams = {
+type ScallopParams = {
   client?: ScallopClient;
 } & ScallopClientParams;
 class Scallop {

package/src/models/scallopAddress.ts

@@ -5,7 +5,7 @@ import { AddressesInterface, AddressStringPath } from 'src/types/address';
 import ScallopAxios, { ScallopAxiosParams } from './scallopAxios';
 import { QueryKey } from '@tanstack/query-core';
 import { AxiosRequestConfig } from 'axios';
-import { parseUrl } from 'src/utils';
+import { parseUrl } from './utils';
 
 export type ScallopAddressParams = {
   addressId?: string;

package/src/models/scallopBuilder.ts

@@ -12,7 +12,7 @@ import type {
   SuiTxArg,
   SuiVecTxArg,
 } from '@scallop-io/sui-kit';
-import type { ScallopTxBlock, SelectCoinReturnType } from 'src/types';
+import type { ScallopTxBlock, SelectCoinReturnType } from 'src/types/builder';
 import { ScallopBuilderInterface } from './interface';
 
 export type ScallopBuilderParams = {

package/src/models/scallopClient.ts

@@ -5,7 +5,7 @@ import type {
   TransactionObjectArgument,
   TransactionResult,
 } from '@mysten/sui/transactions';
-import { requireSender } from 'src/utils';
+import { requireSender } from './utils';
 import type { NetworkType, SuiObjectArg } from '@scallop-io/sui-kit';
 import { ScallopClientInterface } from './interface';
 import { ScallopTxBlock } from 'src/types/builder';

package/src/models/scallopConstants.ts

@@ -2,7 +2,7 @@ import { PoolAddress, Whitelist } from 'src/types/constant';
 import ScallopAddress, { ScallopAddressParams } from './scallopAddress';
 import { NetworkType, parseStructTag } from '@scallop-io/sui-kit';
 import { queryKeys } from 'src/constants/queryKeys';
-import { parseUrl } from 'src/utils';
+import { parseUrl } from './utils';
 
 const isEmptyObject = (obj: object) => {
   return Object.keys(obj).length === 0;

package/src/models/scallopQuery.ts

@@ -1,6 +1,6 @@
 import ScallopUtils, { ScallopUtilsParams } from './scallopUtils';
 import ScallopIndexer, { ScallopIndexerParams } from './scallopIndexer';
-import { withIndexerFallback } from 'src/utils';
+import { withIndexerFallback } from './utils';
 import {
   MarketCollaterals,
   MarketPool,
@@ -76,7 +76,7 @@ import {
   getPriceUpdatePolicies,
   getAssetOracles,
 } from 'src/queries/xOracleQuery';
-import { CoinPrices } from 'src/types/utils';
+import { CoinPrices } from 'src/types/util';
 import { SupportOracleType, xOracleRules } from 'src/types/constant';
 
 export type ScallopQueryParams = {

package/src/models/scallopUtils.ts

@@ -7,7 +7,7 @@ import {
   Transaction,
 } from '@scallop-io/sui-kit';
 import ScallopConstants, { ScallopConstantsParams } from './scallopConstants';
-import { findClosestUnlockRound } from 'src/utils';
+import { findClosestUnlockRound } from './utils';
 import { PriceFeed, SuiPriceServiceConnection } from '@pythnetwork/pyth-sui-js';
 import ScallopSuiKit, { ScallopSuiKitParams } from './scallopSuiKit';
 import { SuiObjectData } from '@mysten/sui/dist/cjs/client';
@@ -16,7 +16,7 @@ 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';
+import { CoinPrices } from 'src/types/util';
 
 export type ScallopUtilsParams = {
   pythEndpoints?: string[];

package/src/models/utils.ts

@@ -0,0 +1,97 @@
+/**
+ * Generic wrapper for methods with indexer fallback.
+ *
+ * @param method - The method to call with fallback behavior.
+ * @param context - The context (`this`) of the class instance.
+ * @param args - The arguments to pass to the method.
+ * @returns The result of the method call.
+ */
+export async function callMethodWithIndexerFallback(
+  method: Function,
+  context: any,
+  ...args: any[]
+) {
+  const lastArgs = args[args.length - 1]; // Assume last argument is always `indexer`
+
+  if (typeof lastArgs === 'object' && lastArgs.indexer) {
+    try {
+      return await method.apply(context, args);
+    } catch (e: any) {
+      console.warn(
+        `Indexer requests failed: ${e.message}. Retrying without indexer..`
+      );
+      return await method.apply(context, [
+        ...args.slice(0, -1),
+        {
+          ...lastArgs,
+          indexer: false,
+        },
+      ]);
+    }
+  }
+  return await method.apply(context, args);
+}
+
+/**
+ * This function creates a wrapper for methods that have an indexer parameter.
+ * It ensures fallback behavior if indexer fails.
+ *
+ * @param method - The method to wrap.
+ * @returns A function that applies indexer fallback.
+ */
+export function withIndexerFallback(method: Function) {
+  return (...args: any[]) => {
+    // @ts-ignore
+    return callMethodWithIndexerFallback(method, this, ...args); // Preserve `this` with arrow function
+  };
+}
+
+import { SuiTxBlock } from '@scallop-io/sui-kit';
+import { MAX_LOCK_DURATION } from 'src/constants/vesca';
+// import { ScallopConstants } from 'src/models/scallopConstants';
+
+/**
+ * Find the closest unlock round timestamp (12AM) to the given unlock at timestamp in seconds.
+ *
+ * @param unlockAtInSecondTimestamp - Unlock at in seconds timestamp to find the closest round.
+ * @returns Closest round (12AM) in seconds timestamp.
+ */
+export const findClosestUnlockRound = (unlockAtInSecondTimestamp: number) => {
+  const unlockDate = new Date(unlockAtInSecondTimestamp * 1000);
+  const closestTwelveAM = new Date(unlockAtInSecondTimestamp * 1000);
+
+  closestTwelveAM.setUTCHours(0, 0, 0, 0); // Set the time to the next 12 AM UTC
+
+  // If the current time is past 12 AM, set the date to the next day
+  if (unlockDate.getUTCHours() >= 0) {
+    closestTwelveAM.setUTCDate(closestTwelveAM.getUTCDate() + 1);
+  }
+
+  const now = new Date().getTime();
+  // check if unlock period > 4 years
+  if (closestTwelveAM.getTime() - now > MAX_LOCK_DURATION * 1000) {
+    closestTwelveAM.setUTCDate(closestTwelveAM.getUTCDate() - 1);
+  }
+  return Math.floor(closestTwelveAM.getTime() / 1000);
+};
+
+export const parseUrl = (url: string) => {
+  if (url.endsWith('/')) {
+    url = url.slice(0, -1);
+  }
+  return url;
+};
+
+/**
+ * Check and get the sender from the transaction block.
+ *
+ * @param txBlock - TxBlock created by SuiKit.
+ * @return Sender of transaction.
+ */
+export const requireSender = (txBlock: SuiTxBlock) => {
+  const sender = txBlock.blockData.sender;
+  if (!sender) {
+    throw new Error('Sender is required');
+  }
+  return sender;
+};

package/src/queries/borrowIncentiveQuery.ts

@@ -3,7 +3,7 @@ import {
   parseOriginBorrowIncentivePoolData,
   parseOriginBorrowIncentiveAccountData,
   calculateBorrowIncentivePoolPointData,
-} from 'src/utils';
+} from './utils';
 import type {
   ScallopAddress,
   ScallopQuery,
@@ -20,7 +20,7 @@ import type {
 } from 'src/types/query';
 import BigNumber from 'bignumber.js';
 import { SuiObjectRef } from '@mysten/sui/client';
-import { CoinPrices, OptionalKeys } from 'src/types/utils';
+import { CoinPrices, OptionalKeys } from 'src/types/util';
 
 /**
  * Query borrow incentive pools data using moveCall

package/src/queries/coreQuery.ts

@@ -5,7 +5,7 @@ import {
   parseOriginMarketCollateralData,
   calculateMarketCollateralData,
   parseObjectAs,
-} from 'src/utils';
+} from './utils';
 import type {
   SuiObjectResponse,
   SuiObjectData,
@@ -43,7 +43,7 @@ import {
   ScallopIndexer,
   ScallopAddress,
 } from 'src/models';
-import { CoinPrices, OptionalKeys } from 'src/types';
+import { CoinPrices, OptionalKeys } from 'src/types/util';
 
 /**
  * Query market data.

package/src/queries/loyaltyProgramQuery.ts

@@ -2,7 +2,7 @@ import { SuiObjectData } from '@mysten/sui/client';
 import BigNumber from 'bignumber.js';
 import { MAX_LOCK_DURATION } from 'src/constants/vesca';
 import { ScallopQuery } from 'src/models';
-import { LoyaltyProgramInfo, VeScaLoyaltyProgramInfo } from 'src/types';
+import { LoyaltyProgramInfo, VeScaLoyaltyProgramInfo } from 'src/types/query';
 import { z as zod } from 'zod';
 
 const rewardPoolFieldsZod = zod

package/src/queries/poolAddressesQuery.ts

@@ -1,5 +1,7 @@
 import { getFullnodeUrl, SuiClient, SuiParsedData } from '@mysten/sui/client';
-import { AddressesInterface, OptionalKeys, PoolAddress } from 'src/types';
+import { AddressesInterface } from 'src/types/address';
+import { PoolAddress } from 'src/types/constant';
+import { OptionalKeys } from 'src/types/util';
 
 const RPC_PROVIDERS = [
   getFullnodeUrl('mainnet'),

package/src/queries/portfolioQuery.ts

@@ -1,5 +1,5 @@
 import BigNumber from 'bignumber.js';
-import { minBigNumber, estimatedFactor } from 'src/utils';
+import { minBigNumber, estimatedFactor } from './utils';
 import type { ScallopQuery } from 'src/models';
 import { SuiObjectRef } from '@mysten/sui/client';
 import { normalizeStructTag, SUI_TYPE_ARG } from '@scallop-io/sui-kit';
@@ -18,7 +18,7 @@ import {
   StakeAccount,
   TotalValueLocked,
 } from 'src/types/query';
-import { CoinPrices } from 'src/types/utils';
+import { CoinPrices } from 'src/types/util';
 
 /**
  * Get user lending infomation for specific pools.

package/src/queries/priceQuery.ts

@@ -1,6 +1,7 @@
 import { SuiObjectData } from '@mysten/sui/client';
 import type { ScallopAddress, ScallopQuery, ScallopSuiKit } from 'src/models';
-import type { CoinPrices, MarketPools, OptionalKeys } from '../types';
+import type { MarketPools } from 'src/types/query';
+import type { CoinPrices } from 'src/types/util';
 import BigNumber from 'bignumber.js';
 
 /**
@@ -150,7 +151,7 @@ export const getAllCoinPrices = async (
     throw new Error(`Failed to fetch market pool for getAllCoinPrices`);
   }
 
-  const sCoinPrices: OptionalKeys<Record<string, number>> = {};
+  const sCoinPrices: CoinPrices = {};
   query.constants.whitelist.scoin.forEach((sCoinName) => {
     const coinName = query.utils.parseCoinName(sCoinName);
     sCoinPrices[sCoinName] = BigNumber(coinPrices[coinName] ?? 0)

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 } from 'src/types';
+import { OptionalKeys } from 'src/types/util';
 
 /**
  * Get total supply of sCoin

package/src/queries/spoolQuery.ts

@@ -5,10 +5,9 @@ import {
   parseOriginSpoolRewardPoolData,
   calculateSpoolRewardPoolData,
   parseObjectAs,
-} from 'src/utils';
+} from './utils';
 import type { SuiObjectData, SuiObjectResponse } from '@mysten/sui/client';
 import type { ScallopQuery, ScallopUtils } from 'src/models';
-import { CoinPrices } from 'src/types';
 import {
   OriginSpoolData,
   OriginSpoolRewardPoolData,
@@ -20,6 +19,7 @@ import {
   StakePool,
   StakeRewardPool,
 } from 'src/types/query';
+import { CoinPrices } from 'src/types/util';
 
 const queryRequiredSpoolObjects = async (
   query: ScallopQuery,
@@ -164,11 +164,11 @@ export const getSpools = async (
       if (!stakeMarketCoinNames.includes(spool.marketCoinName)) return;
       const coinName = query.utils.parseCoinName(spool.marketCoinName);
       const rewardCoinName = query.utils.getSpoolRewardCoinName();
-      spool.coinPrice = coinPrices[coinName] ?? spool.coinPrice;
+      spool.coinPrice = coinPrices?.[coinName] ?? spool.coinPrice;
       spool.marketCoinPrice =
-        coinPrices[spool.marketCoinName] ?? spool.marketCoinPrice;
+        coinPrices?.[spool.marketCoinName] ?? spool.marketCoinPrice;
       spool.rewardCoinPrice =
-        coinPrices[rewardCoinName] ?? spool.rewardCoinPrice;
+        coinPrices?.[rewardCoinName] ?? spool.rewardCoinPrice;
       spools[spool.marketCoinName] = spool;
     };
     Object.values(spoolsIndexer)

package/src/{utils/query.ts → queries/utils.ts}

@@ -1,6 +1,6 @@
 import BigNumber from 'bignumber.js';
 import { normalizeStructTag } from '@mysten/sui/utils';
-import type { ScallopUtils } from '../models';
+import type { ScallopUtils } from 'src/models';
 import {
   OriginMarketPoolData,
   ParsedMarketPoolData,
@@ -24,6 +24,7 @@ import {
   OriginBorrowIncentiveAccountData,
   ParsedBorrowIncentiveAccountData,
 } from 'src/types/query';
+import { SuiObjectData } from '@mysten/sui/client';
 
 /**
  *  Parse origin market pool data to a more readable format.
@@ -642,3 +643,20 @@ export const estimatedFactor = (
 
   return adjustFactor;
 };
+
+export const parseObjectAs = <T>(object: SuiObjectData): T => {
+  if (!(object && object.content && 'fields' in object.content))
+    throw new Error(`Failed to parse object ${object}`);
+
+  const fields = object.content.fields as any;
+
+  if (typeof fields === 'object' && 'value' in fields) {
+    const value = fields.value;
+    if (typeof value === 'object' && 'fields' in value)
+      return value.fields as T;
+    return value as T;
+  } else if (typeof fields === 'object') {
+    return fields as T;
+  }
+  return fields as T;
+};

package/src/queries/vescaQuery.ts

@@ -1,5 +1,5 @@
 import BigNumber from 'bignumber.js';
-import { VeScaTreasuryFields, VeScaTreasuryInfo, Vesca } from 'src/types';
+import { VeScaTreasuryFields, VeScaTreasuryInfo, Vesca } from 'src/types/query';
 import {
   type SuiObjectResponse,
   type SuiObjectData,

package/src/queries/xOracleQuery.ts

@@ -1,6 +1,6 @@
 import { SuiObjectResponse } from '@mysten/sui/client';
 import { ScallopAddress, ScallopSuiKit, ScallopUtils } from 'src/models';
-import { SupportOracleType, xOracleRuleType } from 'src/types';
+import { SupportOracleType, xOracleRuleType } from 'src/types/constant';
 
 /**
  * Query the price update policy table ids. Usually the value for these table will be constant.

package/src/types/builder/index.ts

@@ -1,32 +1,7 @@
-import type { CoreTxBlock, NestedResult } from './core';
-import type { SpoolTxBlock } from './spool';
-import type { BorrowIncentiveTxBlock } from './borrowIncentive';
-import type { VeScaTxBlock } from './vesca';
-import type { ReferralTxBlock } from './referral';
-import { LoyaltyProgramTxBlock } from './loyaltyProgram';
-import { SCoinTxBlock } from './sCoin';
-
 export type * from './core';
 export type * from './spool';
 export type * from './borrowIncentive';
 export type * from './vesca';
 export type * from './loyaltyProgram';
 export type * from './sCoin';
-
-export type BaseScallopTxBlock = ReferralTxBlock &
-  LoyaltyProgramTxBlock &
-  BorrowIncentiveTxBlock &
-  VeScaTxBlock;
-
-export type SuiTxBlockWithSCoin = BaseScallopTxBlock & SCoinTxBlock;
-export type SuiTxBlockWithSpool = SuiTxBlockWithSCoin & SpoolTxBlock;
-export type ScallopTxBlock = SuiTxBlockWithSpool & CoreTxBlock;
-
-export type SelectCoinReturnType<T extends string> = T extends 'sui'
-  ? {
-      takeCoin: NestedResult;
-    }
-  : {
-      takeCoin: NestedResult;
-      leftCoin: NestedResult;
-    };
+export type * from './type';

package/src/types/builder/type.ts

@@ -0,0 +1,25 @@
+import type { CoreTxBlock, NestedResult } from './core';
+import type { SpoolTxBlock } from './spool';
+import type { BorrowIncentiveTxBlock } from './borrowIncentive';
+import type { VeScaTxBlock } from './vesca';
+import type { ReferralTxBlock } from './referral';
+import type { LoyaltyProgramTxBlock } from './loyaltyProgram';
+import type { SCoinTxBlock } from './sCoin';
+
+export type BaseScallopTxBlock = ReferralTxBlock &
+  LoyaltyProgramTxBlock &
+  BorrowIncentiveTxBlock &
+  VeScaTxBlock;
+
+export type SuiTxBlockWithSCoin = BaseScallopTxBlock & SCoinTxBlock;
+export type SuiTxBlockWithSpool = SuiTxBlockWithSCoin & SpoolTxBlock;
+export type ScallopTxBlock = SuiTxBlockWithSpool & CoreTxBlock;
+
+export type SelectCoinReturnType<T extends string> = T extends 'sui'
+  ? {
+      takeCoin: NestedResult;
+    }
+  : {
+      takeCoin: NestedResult;
+      leftCoin: NestedResult;
+    };

package/src/types/constant/package.ts

@@ -1,3 +1,16 @@
-import { PACKAGE_NAMES } from 'src/constants/package';
+const _PACKAGE_NAMES = [
+  'coinDecimalsRegistry',
+  'math',
+  'whitelist',
+  'x',
+  'protocol',
+  'protocolWhitelist',
+  'query',
+  'supra',
+  'pyth',
+  'switchboard',
+  'xOracle',
+  'testCoin',
+] as const;
 
-export type PackageName = (typeof PACKAGE_NAMES)[number];
+export type PackageName = (typeof _PACKAGE_NAMES)[number];