@scallop-io/sui-scallop-sdk 0.46.56 → 0.46.58-alpha.1

package/dist/models/scallopBuilder.d.ts

@@ -5,7 +5,7 @@ import { ScallopUtils } from './scallopUtils';
 import type { SuiTransactionBlockResponse } from '@mysten/sui.js/client';
 import type { TransactionBlock } from '@mysten/sui.js/transactions';
 import type { SuiTxBlock as SuiKitTxBlock } from '@scallop-io/sui-kit';
-import type { ScallopBuilderParams, ScallopTxBlock, SupportMarketCoins, SupportAssetCoins, SupportSCoin, ScallopBuilderInstanceParams } from '../types';
+import type { ScallopBuilderParams, ScallopTxBlock, SupportMarketCoins, SupportAssetCoins, SupportSCoin, ScallopBuilderInstanceParams, SelectCoinReturnType } from '../types';
 import { ScallopCache } from './scallopCache';
 /**
  * @description
@@ -51,10 +51,7 @@ export declare class ScallopBuilder {
      * @param sender - Sender address.
      * @return Take coin and left coin.
      */
-    selectCoin(txBlock: ScallopTxBlock | SuiKitTxBlock, assetCoinName: SupportAssetCoins, amount: number, sender?: string): Promise<{
-        takeCoin: import("@scallop-io/sui-kit").TransactionObjectArgument;
-        leftCoin: import("@scallop-io/sui-kit").TransactionObjectArgument;
-    }>;
+    selectCoin<T extends SupportAssetCoins>(txBlock: ScallopTxBlock | SuiKitTxBlock, assetCoinName: T, amount: number, sender?: string): Promise<SelectCoinReturnType<T>>;
     /**
      * Specifying the sender's amount of market coins to get coins args from transaction result.
      *

package/dist/models/scallopCache.d.ts

@@ -24,7 +24,8 @@ export declare class ScallopCache {
     readonly queryClient: QueryClient;
     readonly _suiKit: SuiKit;
     private tokenBucket;
-    constructor(suiKit: SuiKit, cacheOptions?: QueryClientConfig, tokenBucket?: TokenBucket);
+    walletAddress: string;
+    constructor(suiKit: SuiKit, walletAddress?: string, cacheOptions?: QueryClientConfig, tokenBucket?: TokenBucket);
     private get suiKit();
     private get client();
     /**

package/dist/models/scallopUtils.d.ts

@@ -21,6 +21,7 @@ export declare class ScallopUtils {
     suiKit: SuiKit;
     address: ScallopAddress;
     cache: ScallopCache;
+    walletAddress: string;
     private _priceMap;
     constructor(params: ScallopUtilsParams, instance?: ScallopUtilsInstanceParams);
     /**
@@ -156,7 +157,7 @@ export declare class ScallopUtils {
      * @param coinType
      * @param sender
      */
-    mergeSimilarCoins(txBlock: SuiTxBlock, dest: SuiTxArg, coinType: string, sender: string): Promise<void>;
+    mergeSimilarCoins(txBlock: SuiTxBlock, dest: SuiTxArg, coinType: string, sender?: string): Promise<void>;
     /**
      * Get all asset coin names in the obligation record by obligation id.
      *

package/dist/types/builder/index.d.ts

@@ -1,10 +1,11 @@
-import type { CoreTxBlock } from './core';
+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';
+import { SupportAssetCoins } from '../constant';
 export type * from './core';
 export type * from './spool';
 export type * from './borrowIncentive';
@@ -15,3 +16,9 @@ export type BaseScallopTxBlock = ReferralTxBlock & LoyaltyProgramTxBlock & Borro
 export type SuiTxBlockWithSCoin = BaseScallopTxBlock & SCoinTxBlock;
 export type SuiTxBlockWithSpool = SuiTxBlockWithSCoin & SpoolTxBlock;
 export type ScallopTxBlock = SuiTxBlockWithSpool & CoreTxBlock;
+export type SelectCoinReturnType<T extends SupportAssetCoins> = T extends 'sui' ? {
+    takeCoin: NestedResult;
+} : {
+    takeCoin: NestedResult;
+    leftCoin: NestedResult;
+};

package/dist/utils/query.d.ts

@@ -53,7 +53,7 @@ export declare const parseOriginBorrowIncentiveAccountData: (originBorrowIncenti
 export declare const minBigNumber: (...args: BigNumber.Value[]) => BigNumber;
 export declare const maxBigNumber: (...args: BigNumber.Value[]) => BigNumber;
 /**
- * Dynamically adjust the decrease or increase ratio according to the amout
+ * Dynamically adjust the decrease or increase ratio according to the amount
  * @param amount - The amount required to calculate factor.
  * @param scaleStep - The scale step required to determine the factor..
  * @param type - The type of the calculation.

package/dist/utils/tokenBucket.d.ts

@@ -7,5 +7,5 @@ declare class TokenBucket {
     refill(): void;
     removeTokens(count: number): boolean;
 }
-declare const callWithRateLimit: <T>(tokenBucket: TokenBucket, fn: () => Promise<T>, retryDelayInMs?: number, maxRetries?: number) => Promise<T | null>;
+declare const callWithRateLimit: <T>(tokenBucket: TokenBucket, fn: () => Promise<T>, retryDelayInMs?: number, maxRetries?: number, backoffFactor?: number) => Promise<T | null>;
 export { TokenBucket, callWithRateLimit };

package/package.json

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

package/src/constants/cache.ts

@@ -9,7 +9,7 @@ import { QueryClientConfig } from '@tanstack/query-core';
 export const DEFAULT_CACHE_OPTIONS: QueryClientConfig = {
   defaultOptions: {
     queries: {
-      staleTime: 1500,
+      staleTime: 2000,
     },
   },
 };

package/src/constants/tokenBucket.ts

@@ -1,2 +1,2 @@
-export const DEFAULT_TOKENS_PER_INTERVAL = 10;
-export const DEFAULT_INTERVAL_IN_MS = 1000;
+export const DEFAULT_TOKENS_PER_INTERVAL = 50;
+export const DEFAULT_INTERVAL_IN_MS = 300;

package/src/models/scallop.ts

@@ -49,6 +49,7 @@ export class Scallop {
     this.suiKit = new SuiKit(params);
     this.cache = new ScallopCache(
       this.suiKit,
+      params.walletAddress,
       cacheOptions ?? DEFAULT_CACHE_OPTIONS,
       tokenBucket ??
         new TokenBucket(DEFAULT_TOKENS_PER_INTERVAL, DEFAULT_INTERVAL_IN_MS)

package/src/models/scallopAddress.ts

@@ -382,6 +382,7 @@ export class ScallopAddress {
       instance?.cache ??
       new ScallopCache(
         instance?.suiKit ?? new SuiKit({}),
+        undefined,
         DEFAULT_CACHE_OPTIONS
       );
 

package/src/models/scallopBuilder.ts

@@ -15,6 +15,7 @@ import type {
   SupportAssetCoins,
   SupportSCoin,
   ScallopBuilderInstanceParams,
+  SelectCoinReturnType,
 } from '../types';
 import { ScallopCache } from './scallopCache';
 import { DEFAULT_CACHE_OPTIONS } from 'src/constants/cache';
@@ -58,7 +59,11 @@ export class ScallopBuilder {
       this.address = this.utils.address;
       this.cache = this.address.cache;
     } else {
-      this.cache = new ScallopCache(this.suiKit, DEFAULT_CACHE_OPTIONS);
+      this.cache = new ScallopCache(
+        this.suiKit,
+        this.walletAddress,
+        DEFAULT_CACHE_OPTIONS
+      );
       this.address = new ScallopAddress(
         {
           id: params?.addressesId || ADDRESSES_ID,
@@ -122,16 +127,21 @@ export class ScallopBuilder {
    * @param sender - Sender address.
    * @return Take coin and left coin.
    */
-  public async selectCoin(
+  public async selectCoin<T extends SupportAssetCoins>(
     txBlock: ScallopTxBlock | SuiKitTxBlock,
-    assetCoinName: SupportAssetCoins,
+    assetCoinName: T,
     amount: number,
     sender: string = this.walletAddress
-  ) {
-    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 };
+  ): Promise<SelectCoinReturnType<T>> {
+    if (assetCoinName === 'sui') {
+      const [takeCoin] = txBlock.splitSUIFromGas([amount]);
+      return { takeCoin } as SelectCoinReturnType<T>;
+    } 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>;
+    }
   }
 
   /**

package/src/models/scallopCache.ts

@@ -48,9 +48,11 @@ export class ScallopCache {
   public readonly queryClient: QueryClient;
   public readonly _suiKit: SuiKit;
   private tokenBucket: TokenBucket;
+  public walletAddress: string;
 
   public constructor(
     suiKit: SuiKit,
+    walletAddress?: string,
     cacheOptions?: QueryClientConfig,
     tokenBucket?: TokenBucket
   ) {
@@ -59,6 +61,7 @@ export class ScallopCache {
     this.tokenBucket =
       tokenBucket ??
       new TokenBucket(DEFAULT_TOKENS_PER_INTERVAL, DEFAULT_INTERVAL_IN_MS);
+    this.walletAddress = walletAddress ?? suiKit.currentAddress();
   }
 
   private get suiKit(): SuiKit {
@@ -164,7 +167,7 @@ export class ScallopCache {
     objectId: string,
     options?: SuiObjectDataOptions
   ): Promise<SuiObjectResponse | null> {
-    const queryKey = ['getObject', objectId, this.suiKit.currentAddress()];
+    const queryKey = ['getObject', objectId, this.walletAddress];
     if (options) {
       queryKey.push(JSON.stringify(options));
     }
@@ -188,13 +191,15 @@ export class ScallopCache {
    */
   public async queryGetObjects(
     objectIds: string[],
-    options?: SuiObjectDataOptions
+    options: SuiObjectDataOptions = {
+      showContent: true,
+    }
   ): Promise<SuiObjectData[]> {
     if (objectIds.length === 0) return [];
     const queryKey = [
       'getObjects',
       JSON.stringify(objectIds),
-      this.suiKit.currentAddress(),
+      this.walletAddress,
     ];
     if (options) {
       queryKey.push(JSON.stringify(options));

package/src/models/scallopClient.ts

@@ -76,7 +76,11 @@ export class ScallopClient {
       this.address = this.utils.address;
       this.cache = this.address.cache;
     } else {
-      this.cache = new ScallopCache(this.suiKit, DEFAULT_CACHE_OPTIONS);
+      this.cache = new ScallopCache(
+        this.suiKit,
+        this.walletAddress,
+        DEFAULT_CACHE_OPTIONS
+      );
       this.address = new ScallopAddress(
         {
           id: params?.addressesId || ADDRESSES_ID,

package/src/models/scallopIndexer.ts

@@ -49,7 +49,7 @@ export class ScallopIndexer {
     this.params = params;
     this.cache =
       instance?.cache ??
-      new ScallopCache(new SuiKit({}), DEFAULT_CACHE_OPTIONS);
+      new ScallopCache(new SuiKit({}), undefined, DEFAULT_CACHE_OPTIONS);
     this._requestClient = axios.create({
       baseURL: SDK_API_BASE_URL,
       headers: {

package/src/models/scallopQuery.ts

@@ -90,12 +90,21 @@ export class ScallopQuery {
     this.params = params;
     this.suiKit =
       instance?.suiKit ?? instance?.utils?.suiKit ?? new SuiKit(params);
+
+    this.walletAddress = normalizeSuiAddress(
+      params.walletAddress || this.suiKit.currentAddress()
+    );
+
     if (instance?.utils) {
       this.utils = instance.utils;
       this.address = instance.utils.address;
       this.cache = this.address.cache;
     } else {
-      this.cache = new ScallopCache(this.suiKit, DEFAULT_CACHE_OPTIONS);
+      this.cache = new ScallopCache(
+        this.suiKit,
+        this.walletAddress,
+        DEFAULT_CACHE_OPTIONS
+      );
       this.address = new ScallopAddress(
         {
           id: params?.addressesId || ADDRESSES_ID,
@@ -112,10 +121,6 @@ export class ScallopQuery {
     this.indexer =
       instance?.indexer ??
       new ScallopIndexer(this.params, { cache: this.cache });
-
-    this.walletAddress = normalizeSuiAddress(
-      params.walletAddress || this.suiKit.currentAddress()
-    );
   }
 
   /**

package/src/models/scallopUtils.ts

@@ -62,6 +62,7 @@ export class ScallopUtils {
   public suiKit: SuiKit;
   public address: ScallopAddress;
   public cache: ScallopCache;
+  public walletAddress: string;
   private _priceMap: PriceMap = new Map();
 
   public constructor(
@@ -77,12 +78,18 @@ export class ScallopUtils {
       instance?.address?.cache._suiKit ??
       new SuiKit(params);
 
+    this.walletAddress = params.walletAddress ?? this.suiKit.currentAddress();
+
     if (instance?.address) {
       this.address = instance.address;
       this.cache = this.address.cache;
       this.suiKit = this.address.cache._suiKit;
     } else {
-      this.cache = new ScallopCache(this.suiKit, DEFAULT_CACHE_OPTIONS);
+      this.cache = new ScallopCache(
+        this.suiKit,
+        this.walletAddress,
+        DEFAULT_CACHE_OPTIONS
+      );
       this.address =
         instance?.address ??
         new ScallopAddress(
@@ -409,7 +416,7 @@ export class ScallopUtils {
     txBlock: SuiTxBlock,
     dest: SuiTxArg,
     coinType: string,
-    sender: string
+    sender: string = this.walletAddress
   ): Promise<void> {
     // merge to existing coins if exist
     try {

package/src/queries/borrowIncentiveQuery.ts

@@ -183,7 +183,7 @@ export const queryBorrowIncentiveAccounts = async (
 
   const queryResult = await utils.cache.queryInspectTxn({ queryTarget, args });
   const borrowIncentiveAccountsQueryData = queryResult?.events[0]
-    .parsedJson as BorrowIncentiveAccountsQueryInterface;
+    ?.parsedJson as BorrowIncentiveAccountsQueryInterface | undefined;
 
   const borrowIncentiveAccounts: BorrowIncentiveAccounts = Object.values(
     borrowIncentiveAccountsQueryData?.pool_records ?? []

package/src/queries/coreQuery.ts

@@ -709,6 +709,7 @@ export const getObligations = async (
           StructType: `${protocolObjectId}::obligation::ObligationKey`,
         },
         cursor: nextCursor,
+        limit: 10,
       });
 
     if (!paginatedKeyObjectsResponse) break;
@@ -802,7 +803,7 @@ export const queryObligation = async (
     { queryTarget, args }
     // txBlock
   );
-  return queryResult?.events[0].parsedJson as
+  return queryResult?.events[0]?.parsedJson as
     | ObligationQueryInterface
     | undefined;
 };
@@ -972,7 +973,7 @@ export const getFlashLoanFees = async (
     // the balance sheet is a VecSet<0x1::type_name::TypeName
     const balanceSheetDynamicFields = await query.cache.queryGetDynamicFields({
       parentId: flashloanFeesTableId,
-      limit: 50,
+      limit: 10,
     });
 
     // get the dynamic object ids

package/src/queries/spoolQuery.ts

@@ -251,9 +251,9 @@ export const getStakeAccounts = async (
         filter: { StructType: stakeAccountType },
         options: {
           showContent: true,
-          showType: true,
         },
         cursor: nextCursor,
+        limit: 10,
       });
     if (!paginatedStakeObjectsResponse) continue;
 
@@ -299,7 +299,10 @@ export const getStakeAccounts = async (
   const stakeObjectIds: string[] = stakeObjectsResponse
     .map((ref: any) => ref?.data?.objectId)
     .filter((id: any) => id !== undefined);
-  const stakeObjects = await utils.cache.queryGetObjects(stakeObjectIds);
+  const stakeObjects = await utils.cache.queryGetObjects(stakeObjectIds, {
+    showContent: true,
+    showType: true,
+  });
   for (const stakeObject of stakeObjects) {
     const id = stakeObject.objectId;
     const type = stakeObject.type!;

package/src/queries/vescaQuery.ts

@@ -34,6 +34,7 @@ export const getVescaKeys = async (
         StructType: veScaKeyType,
       },
       cursor: nextCursor,
+      limit: 10,
     });
     if (!paginatedKeyObjectsResponse) continue;
 

package/src/types/builder/index.ts

@@ -1,10 +1,11 @@
-import type { CoreTxBlock } from './core';
+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';
+import { SupportAssetCoins } from '../constant';
 
 export type * from './core';
 export type * from './spool';
@@ -21,3 +22,12 @@ export type BaseScallopTxBlock = ReferralTxBlock &
 export type SuiTxBlockWithSCoin = BaseScallopTxBlock & SCoinTxBlock;
 export type SuiTxBlockWithSpool = SuiTxBlockWithSCoin & SpoolTxBlock;
 export type ScallopTxBlock = SuiTxBlockWithSpool & CoreTxBlock;
+
+export type SelectCoinReturnType<T extends SupportAssetCoins> = T extends 'sui'
+  ? {
+      takeCoin: NestedResult;
+    }
+  : {
+      takeCoin: NestedResult;
+      leftCoin: NestedResult;
+    };

package/src/utils/query.ts

@@ -697,7 +697,7 @@ export const maxBigNumber = (...args: BigNumber.Value[]) => {
 };
 
 /**
- * Dynamically adjust the decrease or increase ratio according to the amout
+ * Dynamically adjust the decrease or increase ratio according to the amount
  * @param amount - The amount required to calculate factor.
  * @param scaleStep - The scale step required to determine the factor..
  * @param type - The type of the calculation.

package/src/utils/tokenBucket.ts

@@ -38,20 +38,44 @@ const callWithRateLimit = async <T>(
   tokenBucket: TokenBucket,
   fn: () => Promise<T>,
   retryDelayInMs = DEFAULT_INTERVAL_IN_MS,
-  maxRetries = 5 // Adding a maximum retries limit,
+  maxRetries = 15,
+  backoffFactor = 1.25 // The factor by which to increase the delay
 ): Promise<T | null> => {
   let retries = 0;
 
   const tryRequest = async (): Promise<T | null> => {
     if (tokenBucket.removeTokens(1)) {
-      return await fn();
+      try {
+        const result = await fn();
+
+        // Check if the result is an object with status code (assuming the response has a status property)
+        if (result && (result as any).status === 429) {
+          throw new Error('Unexpected status code: 429');
+        }
+
+        return result;
+      } catch (error: any) {
+        if (
+          error.message === 'Unexpected status code: 429' &&
+          retries < maxRetries
+        ) {
+          retries++;
+          const delay = retryDelayInMs * Math.pow(backoffFactor, retries);
+          // console.warn(`429 encountered, retrying in ${delay} ms`);
+          await new Promise((resolve) => setTimeout(resolve, delay));
+          return tryRequest();
+        } else {
+          console.error('An error occurred:', error);
+          return null;
+        }
+      }
     } else if (retries < maxRetries) {
       retries++;
-      // Use a Promise to correctly handle the async operation with setTimeout
-      await new Promise((resolve) => setTimeout(resolve, retryDelayInMs));
+      const delay = retryDelayInMs * Math.pow(backoffFactor, retries);
+      // console.warn(`Rate limit exceeded, retrying in ${delay} ms`);
+      await new Promise((resolve) => setTimeout(resolve, delay));
       return tryRequest();
     } else {
-      // Optionally, handle the case where the maximum number of retries is reached
       console.error('Maximum retries reached');
       return null;
     }