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

package/src/index.ts

@@ -10,4 +10,4 @@ export {
   ScallopIndexer,
   ScallopUtils,
 } from './models';
-export * from './types';
+export type * from './types';

package/src/models/index.ts

@@ -1,4 +1,3 @@
-// export type * from './interface';
 export { default as Scallop } from './scallop';
 export { default as ScallopClient } from './scallopClient';
 export { default as ScallopBuilder } from './scallopBuilder';
@@ -7,6 +6,6 @@ export { default as ScallopAxios } from './scallopAxios';
 export { default as ScallopConstants } from './scallopConstants';
 export { default as ScallopIndexer } from './scallopIndexer';
 export { default as ScallopQuery } from './scallopQuery';
-export { default as ScallopQueryClient } from './scallopQueryClient';
+export { default as ScallopQueryClient } from '../models/scallopQueryClient';
 export { default as ScallopUtils } from './scallopUtils';
 export { default as ScallopSuiKit } from './scallopSuiKit';

package/src/models/interface.ts

@@ -1,9 +1,9 @@
-import type { default as ScallopAddress } from './scallopAddress';
-import type { default as ScallopBuilder } from './scallopBuilder';
-import type { default as ScallopConstants } from './scallopConstants';
-import type { default as ScallopQuery } from './scallopQuery';
-import type { default as ScallopSuiKit } from './scallopSuiKit';
-import type { default as ScallopUtils } from './scallopUtils';
+import ScallopAddress from './scallopAddress';
+import ScallopBuilder from './scallopBuilder';
+import ScallopConstants from './scallopConstants';
+import ScallopQuery from './scallopQuery';
+import ScallopSuiKit from './scallopSuiKit';
+import ScallopUtils from './scallopUtils';
 
 interface ScallopBaseInterface {
   scallopSuiKit: ScallopSuiKit;

package/src/models/rateLimiter.ts

@@ -0,0 +1,55 @@
+export class RateLimiter {
+  private tokens: number;
+  private lastRefillTime: number;
+  private readonly refillRate: number; // tokens per millisecond
+
+  constructor(private readonly capacity: number = 10) {
+    this.refillRate = this.capacity / 1000; // 10 tokens per second = 0.01 tokens/ms
+    this.tokens = this.capacity;
+    this.lastRefillTime = Date.now();
+  }
+
+  private refill() {
+    const now = Date.now();
+    const elapsed = now - this.lastRefillTime;
+    const newTokens = elapsed * this.refillRate;
+
+    this.tokens = Math.min(this.capacity, this.tokens + newTokens);
+    this.lastRefillTime = now;
+  }
+
+  private getTimeToNextToken(): number {
+    this.refill();
+
+    if (this.tokens >= 1) {
+      return 0;
+    }
+
+    // Calculate exact milliseconds needed for 1 full token
+    const deficit = 1 - this.tokens;
+    return Math.ceil(deficit / this.refillRate);
+  }
+
+  async acquireToken(): Promise<void> {
+    // eslint-disable-next-line no-constant-condition
+    while (true) {
+      const waitTime = this.getTimeToNextToken();
+
+      if (waitTime === 0) {
+        if (this.tokens >= 1) {
+          this.tokens -= 1;
+          return;
+        }
+        continue;
+      }
+
+      await new Promise((resolve) => setTimeout(resolve, waitTime));
+      this.refill();
+    }
+  }
+
+  async execute<T>(fn: () => Promise<T>): Promise<T> {
+    await this.acquireToken();
+    return await fn();
+  }
+}

package/src/models/scallop.ts

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

package/src/models/scallopAddress.ts

@@ -1,11 +1,10 @@
 import { NetworkType } from '@scallop-io/sui-kit';
-import { API_BASE_URL } from 'src/constants/api';
-import { queryKeys } from 'src/constants/queryKeys';
-import { AddressesInterface, AddressStringPath } from 'src/types/address';
+import { API_BASE_URL, queryKeys } from 'src/constants';
+import { AddressesInterface, AddressStringPath } from 'src/types';
 import ScallopAxios, { ScallopAxiosParams } from './scallopAxios';
 import { QueryKey } from '@tanstack/query-core';
 import { AxiosRequestConfig } from 'axios';
-import { parseUrl } from './utils';
+import { parseUrl } from 'src/utils';
 
 export type ScallopAddressParams = {
   addressId?: string;
@@ -243,17 +242,6 @@ const EMPTY_ADDRESSES: AddressesInterface = {
         state: '',
         wormhole: '',
         wormholeState: '',
-        lst: {
-          afsui: {
-            safeId: '',
-            stakedSuiVaultId: '',
-            configId: '',
-          },
-          hasui: {
-            configId: '',
-            staking: '',
-          },
-        },
       },
     },
     packages: {
@@ -285,28 +273,12 @@ const EMPTY_ADDRESSES: AddressesInterface = {
         id: '',
         upgradeCap: '',
       },
-      supra: {
-        id: '',
-        upgradeCap: '',
-      },
+      supra: { id: '', upgradeCap: '' },
       pyth: {
         id: '',
         upgradeCap: '',
-        lst: {
-          afsui: {
-            id: '',
-            object: '',
-          },
-          hasui: {
-            id: '',
-            object: '',
-          },
-        },
-      },
-      switchboard: {
-        id: '',
-        upgradeCap: '',
       },
+      switchboard: { id: '', upgradeCap: '' },
       xOracle: {
         id: '',
         upgradeCap: '',

package/src/models/scallopBuilder.ts

@@ -12,13 +12,13 @@ import type {
   SuiTxArg,
   SuiVecTxArg,
 } from '@scallop-io/sui-kit';
-import type { ScallopTxBlock, SelectCoinReturnType } from 'src/types/builder';
+import type { ScallopTxBlock } from '../types';
 import { ScallopBuilderInterface } from './interface';
 
 export type ScallopBuilderParams = {
   query?: ScallopQuery;
   usePythPullModel?: boolean;
-  pythSponsoredFeeds?: string[];
+  sponsoredFeeds?: string[];
   useOnChainXOracleList?: boolean;
 } & ScallopQueryParams;
 
@@ -37,13 +37,13 @@ class ScallopBuilder implements ScallopBuilderInterface {
   public readonly query: ScallopQuery;
   public readonly usePythPullModel: boolean;
   public readonly useOnChainXOracleList: boolean;
-  public readonly pythSponsoredFeeds: string[];
+  public readonly sponsoredFeeds: string[];
 
   public constructor(params: ScallopBuilderParams) {
     this.query = params.query ?? new ScallopQuery(params);
     this.usePythPullModel = params.usePythPullModel ?? true;
     this.useOnChainXOracleList = params.useOnChainXOracleList ?? true;
-    this.pythSponsoredFeeds = [...new Set(params.pythSponsoredFeeds ?? [])];
+    this.sponsoredFeeds = params.sponsoredFeeds ?? [];
   }
 
   get utils() {
@@ -96,22 +96,25 @@ class ScallopBuilder implements ScallopBuilderInterface {
    * @param assetCoinName - Specific support asset coin name.
    * @param amount - Amount of coins to be selected.
    * @param sender - Sender address.
+   * @param isSponsored - Whether the transaction is a sponsored transaction.
    * @return Take coin and left coin.
    */
-  async selectCoin<T extends string>(
+  async selectCoin(
     txBlock: ScallopTxBlock | SuiKitTxBlock,
-    assetCoinName: T,
+    assetCoinName: string,
     amount: number,
-    sender: string = this.walletAddress
-  ): Promise<SelectCoinReturnType<T>> {
-    if (assetCoinName === 'sui') {
+    sender: string = this.walletAddress,
+    isSponsored: boolean = false
+  ) {
+    if (assetCoinName === 'sui' && !isSponsored) {
       const [takeCoin] = txBlock.splitSUIFromGas([amount]);
-      return { takeCoin } as SelectCoinReturnType<T>;
+      return { takeCoin };
     } else {
       const coinType = this.utils.parseCoinType(assetCoinName);
       const coins = await this.utils.selectCoins(amount, coinType, sender);
       const [takeCoin, leftCoin] = txBlock.takeAmountFromCoins(coins, amount);
-      return { takeCoin, leftCoin } as SelectCoinReturnType<T>;
+
+      return { takeCoin, leftCoin };
     }
   }
 

package/src/models/scallopClient.ts

@@ -5,10 +5,10 @@ import type {
   TransactionObjectArgument,
   TransactionResult,
 } from '@mysten/sui/transactions';
-import { requireSender } from './utils';
+import { requireSender } from 'src/utils';
 import type { NetworkType, SuiObjectArg } from '@scallop-io/sui-kit';
+import type { ScallopTxBlock } from '../types';
 import { ScallopClientInterface } from './interface';
-import { ScallopTxBlock } from 'src/types/builder';
 
 export type ScallopClientParams = {
   networkType?: NetworkType;
@@ -210,6 +210,7 @@ class ScallopClient implements ScallopClientInterface {
    * @param sign - Decide to directly sign the transaction or return the transaction block.
    * @param obligationId - The obligation object.
    * @param walletAddress - The wallet address of the owner.
+   * @param isSponsoredTx - Whether the transaction is sponsored.
    * @return Transaction block response or transaction block.
    */
   async depositCollateral(
@@ -221,30 +222,38 @@ class ScallopClient implements ScallopClientInterface {
     amount: number,
     sign?: S,
     obligationId?: string,
-    walletAddress?: string
+    walletAddress?: string,
+    isSponsoredTx?: boolean
   ): Promise<ScallopClientFnReturnType<S>>;
   async depositCollateral<S extends boolean>(
     collateralCoinName: string,
     amount: number,
     sign: S = true as S,
     obligationId?: string,
-    walletAddress?: string
+    walletAddress?: string,
+    isSponsoredTx?: boolean
   ): Promise<ScallopClientFnReturnType<S>> {
     const txBlock = this.builder.createTxBlock();
     const sender = walletAddress ?? this.walletAddress;
     txBlock.setSender(sender);
 
-    const obligations = await this.query.getObligations(sender);
-    const specificObligationId = obligationId ?? obligations[0]?.id;
+    const specificObligationId =
+      obligationId ?? (await this.query.getObligations(sender))[0]?.id;
     if (specificObligationId) {
       await txBlock.addCollateralQuick(
         amount,
         collateralCoinName,
-        specificObligationId
+        specificObligationId,
+        isSponsoredTx
       );
     } else {
       const [obligation, obligationKey, hotPotato] = txBlock.openObligation();
-      await txBlock.addCollateralQuick(amount, collateralCoinName, obligation);
+      await txBlock.addCollateralQuick(
+        amount,
+        collateralCoinName,
+        obligation,
+        isSponsoredTx
+      );
       txBlock.returnObligation(obligation, hotPotato);
       txBlock.transferObjects([obligationKey], sender);
     }
@@ -267,6 +276,7 @@ class ScallopClient implements ScallopClientInterface {
    * @param obligationId - The obligation object.
    * @param obligationKey - The obligation key object to verifying obligation authority.
    * @param walletAddress - The wallet address of the owner.
+   * @param isSponsoredTx - Whether the transaction is sponsored.
    * @return Transaction block response or transaction block.
    */
   async withdrawCollateral<S extends boolean>(
@@ -275,7 +285,8 @@ class ScallopClient implements ScallopClientInterface {
     sign: S = true as S,
     obligationId: string,
     obligationKey: string,
-    walletAddress?: string
+    walletAddress?: string,
+    isSponsoredTx?: boolean
   ): Promise<ScallopClientFnReturnType<S>> {
     const txBlock = this.builder.createTxBlock();
     const sender = walletAddress ?? this.walletAddress;
@@ -285,7 +296,8 @@ class ScallopClient implements ScallopClientInterface {
       amount,
       collateralCoinName,
       obligationId,
-      obligationKey
+      obligationKey,
+      { isSponsoredTx }
     );
     txBlock.transferObjects([collateralCoin], sender);
 
@@ -449,6 +461,7 @@ class ScallopClient implements ScallopClientInterface {
    * @param obligationId - The obligation object.
    * @param obligationKey - The obligation key object to verifying obligation authority.
    * @param walletAddress - The wallet address of the owner.
+   * @param isSponsoredTx - Whether the transaction is sponsored.
    * @return Transaction block response or transaction block.
    */
   async borrow<S extends boolean>(
@@ -457,7 +470,8 @@ class ScallopClient implements ScallopClientInterface {
     sign: S = true as S,
     obligationId: string,
     obligationKey: string,
-    walletAddress?: string
+    walletAddress?: string,
+    isSponsoredTx?: boolean
   ): Promise<ScallopClientFnReturnType<S>> {
     const txBlock = this.builder.createTxBlock();
     const sender = walletAddress ?? this.walletAddress;
@@ -471,7 +485,8 @@ class ScallopClient implements ScallopClientInterface {
       amount,
       poolCoinName,
       obligationId,
-      obligationKey
+      obligationKey,
+      { isSponsoredTx }
     );
     txBlock.transferObjects([coin], sender);
     if (sign && availableStake) {
@@ -495,6 +510,7 @@ class ScallopClient implements ScallopClientInterface {
    * @param sign - Decide to directly sign the transaction or return the transaction block.
    * @param obligationId - The obligation object.
    * @param walletAddress - The wallet address of the owner.
+   * @param isSponsoredTx - Whether the transaction is sponsored.
    * @return Transaction block response or transaction block.
    */
   async repay<S extends boolean>(
@@ -503,7 +519,8 @@ class ScallopClient implements ScallopClientInterface {
     sign: S = true as S,
     obligationId: string,
     obligationKey: string,
-    walletAddress?: string
+    walletAddress?: string,
+    isSponsoredTx?: boolean
   ): Promise<ScallopClientFnReturnType<S>> {
     const txBlock = this.builder.createTxBlock();
     const sender = walletAddress ?? this.walletAddress;
@@ -513,7 +530,7 @@ class ScallopClient implements ScallopClientInterface {
     if (sign && availableStake) {
       await txBlock.unstakeObligationQuick(obligationId, obligationKey);
     }
-    await txBlock.repayQuick(amount, poolCoinName, obligationId);
+    await txBlock.repayQuick(amount, poolCoinName, obligationId, isSponsoredTx);
     if (sign && availableStake) {
       await txBlock.stakeObligationWithVeScaQuick(obligationId, obligationKey);
     }

package/src/models/scallopConstants.ts

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

package/src/models/scallopIndexer.ts

@@ -10,10 +10,9 @@ import {
   Spool,
   Spools,
   TotalValueLocked,
-} from 'src/types/query';
+} from 'src/types';
 import ScallopAxios, { ScallopAxiosParams } from './scallopAxios';
-import { SDK_API_BASE_URL } from 'src/constants/api';
-import { queryKeys } from 'src/constants/queryKeys';
+import { queryKeys, SDK_API_BASE_URL } from 'src/constants';
 
 export type ScallopIndexerParams = {
   indexerApiUrl?: string;
@@ -135,7 +134,7 @@ class ScallopIndexer extends ScallopAxios {
       borrowIncentivePools: BorrowIncentivePool[];
     }>(
       '/api/borrowIncentivePools/migrate',
-      queryKeys.api.getBorrowIncentivePool()
+      queryKeys.api.getBorrowIncentivePools()
     );
 
     if (response.status === 200) {

package/src/models/scallopQuery.ts

@@ -1,83 +1,68 @@
 import ScallopUtils, { ScallopUtilsParams } from './scallopUtils';
 import ScallopIndexer, { ScallopIndexerParams } from './scallopIndexer';
-import { withIndexerFallback } from './utils';
+import { withIndexerFallback } from 'src/utils';
 import {
+  CoinPrices,
   MarketCollaterals,
   MarketPool,
   MarketPools,
   StakePools,
   StakeRewardPools,
-} from 'src/types/query';
-import { SuiObjectRef, SuiObjectData } from '@mysten/sui/dist/cjs/client';
-import { SuiObjectArg } from '@scallop-io/sui-kit';
-import { ScallopQueryInterface } from './interface';
+  SupportOracleType,
+  xOracleRules,
+} from 'src/types';
 import {
-  getBorrowIncentivePools,
-  queryBorrowIncentiveAccounts,
+  getAllCoinPrices,
+  getAssetOracles,
   getBindedObligationId,
   getBindedVeScaKey,
-} from 'src/queries/borrowIncentiveQuery';
-import { getBorrowLimit } from 'src/queries/borrowLimitQuery';
-import {
-  queryMarket,
-  getMarketPools,
-  getMarketCollaterals,
-  getMarketCollateral,
-  getObligations,
-  queryObligation,
-  getCoinAmounts,
+  getBorrowIncentivePools,
+  getBorrowLimit,
   getCoinAmount,
-  getMarketCoinAmounts,
-  getMarketCoinAmount,
+  getCoinAmounts,
   getFlashLoanFees,
-} from 'src/queries/coreQuery';
-import {
   getIsolatedAssets,
-  isIsolatedAsset,
-} from 'src/queries/isolatedAssetQuery';
-import {
-  getLoyaltyProgramInformations,
-  getVeScaLoyaltyProgramInformations,
-} from 'src/queries/loyaltyProgramQuery';
-import { getPoolAddresses } from 'src/queries/poolAddressesQuery';
-import {
-  getLendings,
   getLending,
+  getLendings,
+  getLoyaltyProgramInformations,
+  getMarketCoinAmount,
+  getMarketCoinAmounts,
+  getMarketCollateral,
+  getMarketCollaterals,
+  getMarketPools,
+  getObligationAccount,
   getObligationAccounts,
-  getTotalValueLocked,
-  getUserPortfolio,
-} from 'src/queries/portfolioQuery';
-import {
+  getObligationAccountsByIds,
+  getObligations,
+  getOnDemandAggObjectIds,
+  getPoolAddresses,
+  getPriceUpdatePolicies,
   getPythPrice,
   getPythPrices,
-  getAllCoinPrices,
-} from 'src/queries/priceQuery';
-import { queryVeScaKeyIdFromReferralBindings } from 'src/queries/referralQuery';
-import {
-  getSCoinTotalSupply,
-  getSCoinAmounts,
   getSCoinAmount,
+  getSCoinAmounts,
   getSCoinSwapRate,
-} from 'src/queries/sCoinQuery';
-import {
+  getSCoinTotalSupply,
   getSpools,
   getStakeAccounts,
   getStakePool,
   getStakeRewardPool,
-} from 'src/queries/spoolQuery';
-import { getSupplyLimit } from 'src/queries/supplyLimitQuery';
-import { getOnDemandAggObjectIds } from 'src/queries/switchboardQuery';
-import {
+  getSupplyLimit,
+  getTotalValueLocked,
+  getUserPortfolio,
   getVeSca,
+  getVeScaLoyaltyProgramInformations,
   getVeScas,
   getVeScaTreasuryInfo,
-} from 'src/queries/vescaQuery';
-import {
-  getPriceUpdatePolicies,
-  getAssetOracles,
-} from 'src/queries/xOracleQuery';
-import { CoinPrices } from 'src/types/util';
-import { SupportOracleType, xOracleRules } from 'src/types/constant';
+  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';
 
 export type ScallopQueryParams = {
   indexer?: ScallopIndexer;
@@ -125,6 +110,14 @@ class ScallopQuery implements ScallopQueryInterface {
       this,
       this.getObligationAccounts
     );
+    this.getObligationAccountsByIds = withIndexerFallback.call(
+      this,
+      this.getObligationAccountsByIds
+    );
+    this.getObligationAccountById = withIndexerFallback.call(
+      this,
+      this.getObligationAccountById
+    );
     this.getObligationAccount = withIndexerFallback.call(
       this,
       this.getObligationAccount
@@ -575,13 +568,13 @@ class ScallopQuery implements ScallopQueryInterface {
   }
 
   /**
-   * Get user all obligation accounts information.
+   * Get user all obligation accounts information from ownerAddress.
    *
    * @description
    * All collateral and borrowing information in all obligation accounts owned by the user.
    *
    * @param ownerAddress - The owner address.
-   * @param indexer - Whether to use indexer.
+   * @param args - Additional arguments.
    * @return All obligation accounts information.
    */
   async getObligationAccounts(
@@ -604,6 +597,68 @@ class ScallopQuery implements ScallopQueryInterface {
     );
   }
 
+  /**
+   * Get user all obligation accounts information from obligationIds.
+   *
+   * @description
+   * All collateral and borrowing information in all obligation accounts.
+   *
+   * @param obligationIds - Obligation IDs.
+   * @param args - Additional arguments.
+   * @return All obligation accounts information.
+   */
+  async getObligationAccountsByIds(
+    obligationIds: string[],
+    args?: {
+      market?: {
+        collaterals: MarketCollaterals;
+        pools: MarketPools;
+      };
+      coinPrices?: CoinPrices;
+      indexer?: boolean;
+    }
+  ) {
+    return await getObligationAccountsByIds(
+      this,
+      obligationIds,
+      args?.market,
+      args?.coinPrices,
+      args?.indexer
+    );
+  }
+
+  /**
+   * Get obligation account by id
+   *
+   * @description
+   * All collateral and borrowing information in obligation account.
+   *
+   * @param obligationId - Obligation ID.
+   * @param args - Additional arguments.
+   * @return All obligation accounts information.
+   */
+  async getObligationAccountById(
+    obligationId: string,
+    args?: {
+      market?: {
+        collaterals: MarketCollaterals;
+        pools: MarketPools;
+      };
+      coinPrices?: CoinPrices;
+      indexer?: boolean;
+    }
+  ) {
+    return await getObligationAccount(
+      this,
+      obligationId,
+      '',
+      args?.indexer,
+      args?.market,
+      args?.coinPrices,
+      {}
+    );
+  }
+
   /**
    * Get obligation account information for specific id.
    *
@@ -612,7 +667,7 @@ class ScallopQuery implements ScallopQueryInterface {
    *
    * @param obligationId - The obligation id.
    * @param ownerAddress - The owner address.
-   * @param indexer - Whether to use indexer.
+   * @param args - Additional arguments.
    * @return Borrowing and collateral information.
    */
   async getObligationAccount(
@@ -868,6 +923,7 @@ 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/cache';
+import { DEFAULT_CACHE_OPTIONS } from 'src/constants';
 
 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/queryKeys';
+import { queryKeys } from 'src/constants';
 import {
   CoinBalance,
   DevInspectResults,