@scallop-io/sui-scallop-sdk 0.44.28 → 0.45.0

package/dist/models/index.d.ts

@@ -5,3 +5,4 @@ export * from './scallopBuilder';
 export * from './scallopQuery';
 export * from './scallopUtils';
 export * from './scallopIndexer';
+export * from './scallopCache';

package/dist/models/scallop.d.ts

@@ -6,7 +6,12 @@ import { ScallopQuery } from './scallopQuery';
 import { ScallopUtils } from './scallopUtils';
 import type { ScallopParams } from '../types/';
 import { ScallopIndexer } from './scallopIndexer';
+import { ScallopCache } from './scallopCache';
+import { QueryClientConfig } from '@tanstack/query-core';
 /**
+ * @argument params - The parameters for the Scallop instance.
+ * @argument cacheOptions - The cache options for the QueryClient.
+ *
  * @description
  * The main instance that controls interaction with the Scallop contract.
  *
@@ -23,8 +28,9 @@ import { ScallopIndexer } from './scallopIndexer';
 export declare class Scallop {
     params: ScallopParams;
     suiKit: SuiKit;
+    cache: ScallopCache;
     private _address;
-    constructor(params: ScallopParams);
+    constructor(params: ScallopParams, cacheOptions?: QueryClientConfig);
     /**
      * Get a scallop address instance that already has read addresses.
      *

package/dist/models/scallopAddress.d.ts

@@ -1,5 +1,6 @@
 import type { NetworkType } from '@scallop-io/sui-kit';
 import type { ScallopAddressParams, AddressesInterface, AddressStringPath } from '../types';
+import { ScallopCache } from './scallopCache';
 /**
  * @description
  * It provides methods for managing addresses.
@@ -13,12 +14,13 @@ import type { ScallopAddressParams, AddressesInterface, AddressStringPath } from
  */
 export declare class ScallopAddress {
     private readonly _auth?;
-    private _requestClient;
+    private readonly _requestClient;
     private _id?;
     private _network;
     private _currentAddresses?;
     private _addressesMap;
-    constructor(params: ScallopAddressParams);
+    private _cache;
+    constructor(params: ScallopAddressParams, cache?: ScallopCache);
     /**
      * Get addresses API id.
      *

package/dist/models/scallopBuilder.d.ts

@@ -6,6 +6,7 @@ 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 { ScallopInstanceParams, ScallopBuilderParams, ScallopTxBlock, SupportMarketCoins, SupportAssetCoins } from '../types';
+import { ScallopCache } from './scallopCache';
 /**
  * @description
  * It provides methods for operating the transaction block, making it more convenient to organize transaction combinations.
@@ -25,6 +26,7 @@ export declare class ScallopBuilder {
     query: ScallopQuery;
     utils: ScallopUtils;
     walletAddress: string;
+    cache: ScallopCache;
     constructor(params: ScallopBuilderParams, instance?: ScallopInstanceParams);
     /**
      * Request the scallop API to initialize data.

package/dist/models/scallopCache.d.ts

@@ -0,0 +1,71 @@
+import { QueryClient, QueryClientConfig } from '@tanstack/query-core';
+import { SuiTxArg } from '@scallop-io/sui-kit';
+import { SuiKit } from '@scallop-io/sui-kit';
+import type { SuiObjectResponse, SuiObjectDataOptions, SuiObjectData, PaginatedObjectsResponse, GetOwnedObjectsParams, DevInspectResults, GetDynamicFieldsParams, DynamicFieldPage, GetDynamicFieldObjectParams } from '@mysten/sui.js/client';
+type QueryInspectTxnParams = {
+    queryTarget: string;
+    args: SuiTxArg[];
+    typeArgs?: any[];
+};
+/**
+ * @description
+ * It provides caching for moveCall, RPC Request, and API Request.
+ *
+ *
+ * @example
+ * ```typescript
+ * const scallopCache = new scallopCache(<parameters>);
+ * scallopCache.<indexer functions>();
+ * await scallopCache.<indexer async functions>();
+ * ```
+ */
+export declare class ScallopCache {
+    readonly queryClient: QueryClient;
+    readonly _suiKit?: SuiKit;
+    constructor(cacheOptions?: QueryClientConfig, suiKit?: SuiKit);
+    private get suiKit();
+    /**
+     * @description Invalidate cache based on the refetchType parameter
+     * @param refetchType Determines the type of queries to be refetched. Defaults to `active`.
+     *
+     * - `active`: Only queries that match the refetch predicate and are actively being rendered via useQuery and related functions will be refetched in the background.
+     * - `inactive`: Only queries that match the refetch predicate and are NOT actively being rendered via useQuery and related functions will be refetched in the background.
+     * - `all`: All queries that match the refetch predicate will be refetched in the background.
+     * - `none`: No queries will be refetched. Queries that match the refetch predicate will only be marked as invalid.
+     */
+    invalidateAndRefetchAllCache(refetchType: 'all' | 'active' | 'inactive' | 'none'): Promise<void>;
+    /**
+     * @description Cache protocol config call for 60 seconds.
+     * @returns Promise<ProtocolConfig>
+     */
+    private getProtocolConfig;
+    /**
+     * @description Provides cache for inspectTxn of the SuiKit.
+     * @param QueryInspectTxnParams
+     * @param txBlock
+     * @returns Promise<DevInspectResults>
+     */
+    queryInspectTxn({ queryTarget, args, typeArgs, }: QueryInspectTxnParams): Promise<DevInspectResults>;
+    /**
+     * @description Provides cache for getObject of the SuiKit.
+     * @param objectId
+     * @param QueryObjectParams
+     * @returns Promise<SuiObjectResponse>
+     */
+    queryGetObject(objectId: string, options?: SuiObjectDataOptions): Promise<SuiObjectResponse>;
+    /**
+     * @description Provides cache for getObjects of the SuiKit.
+     * @param objectIds
+     * @returns Promise<SuiObjectData[]>
+     */
+    queryGetObjects(objectIds: string[], options?: SuiObjectDataOptions): Promise<SuiObjectData[]>;
+    /**
+     * @description Provides cache for getOwnedObjects of the SuiKit.
+     * @param input
+     * @returns Promise<PaginatedObjectsResponse>
+     */
+    queryGetOwnedObjects(input: GetOwnedObjectsParams): Promise<PaginatedObjectsResponse>;
+    queryGetDynamicFields(input: GetDynamicFieldsParams): Promise<DynamicFieldPage>;
+    queryGetDynamicFieldObject(input: GetDynamicFieldObjectParams): Promise<SuiObjectResponse>;
+}
+export {};

package/dist/models/scallopClient.d.ts

@@ -7,6 +7,7 @@ import type { SuiTransactionBlockResponse } from '@mysten/sui.js/client';
 import type { TransactionObjectArgument } from '@mysten/sui.js/transactions';
 import type { SuiObjectArg } from '@scallop-io/sui-kit';
 import type { ScallopClientFnReturnType, ScallopInstanceParams, ScallopClientParams, SupportPoolCoins, SupportCollateralCoins, SupportAssetCoins, SupportStakeCoins, SupportStakeMarketCoins, SupportBorrowIncentiveCoins, ScallopTxBlock } from '../types';
+import { ScallopCache } from './scallopCache';
 /**
  * @description
  * It provides contract interaction operations for general users.
@@ -26,6 +27,7 @@ export declare class ScallopClient {
     builder: ScallopBuilder;
     query: ScallopQuery;
     utils: ScallopUtils;
+    cache: ScallopCache;
     walletAddress: string;
     constructor(params: ScallopClientParams, instance?: ScallopInstanceParams);
     /**

package/dist/models/scallopIndexer.d.ts

@@ -1,4 +1,4 @@
-import type { Market, MarketPools, MarketPool, MarketCollaterals, MarketCollateral, Spools, Spool, BorrowIncentivePools, BorrowIncentivePool, SupportPoolCoins, SupportCollateralCoins, SupportStakeMarketCoins, SupportBorrowIncentiveCoins, TotalValueLocked } from '../types';
+import type { Market, MarketPools, MarketPool, MarketCollaterals, MarketCollateral, Spools, Spool, BorrowIncentivePools, BorrowIncentivePool, SupportPoolCoins, SupportCollateralCoins, SupportStakeMarketCoins, SupportBorrowIncentiveCoins, TotalValueLocked, ScallopQueryParams, ScallopParams, ScallopInstanceParams } from '../types';
 /**
  * @description
  * It provides methods to obtain sdk index data from mainnet.
@@ -12,8 +12,10 @@ import type { Market, MarketPools, MarketPool, MarketCollaterals, MarketCollater
  * ```
  */
 export declare class ScallopIndexer {
-    private _requestClient;
-    constructor();
+    private readonly _cache;
+    readonly params: ScallopQueryParams;
+    private readonly _requestClient;
+    constructor(params: ScallopParams, instance?: ScallopInstanceParams);
     /**
      * Get market index data.
      *

package/dist/models/scallopQuery.d.ts

@@ -3,6 +3,7 @@ import { ScallopQueryParams, ScallopInstanceParams, SupportStakeMarketCoins, Sup
 import { ScallopAddress } from './scallopAddress';
 import { ScallopUtils } from './scallopUtils';
 import { ScallopIndexer } from './scallopIndexer';
+import { ScallopCache } from './scallopCache';
 /**
  * @description
  * It provides methods for getting on-chain data from the Scallop contract.
@@ -21,6 +22,7 @@ export declare class ScallopQuery {
     address: ScallopAddress;
     utils: ScallopUtils;
     indexer: ScallopIndexer;
+    cache: ScallopCache;
     constructor(params: ScallopQueryParams, instance?: ScallopInstanceParams);
     /**
      * Request the scallop API to initialize data.

package/dist/models/scallopUtils.d.ts

@@ -20,6 +20,7 @@ export declare class ScallopUtils {
     private _address;
     private _query;
     private _priceMap;
+    private _cache;
     constructor(params: ScallopUtilsParams, instance?: ScallopInstanceParams);
     /**
      * Request the scallop API to initialize data.

package/dist/types/model.d.ts

@@ -2,6 +2,7 @@ import type { SuiTransactionBlockResponse } from '@mysten/sui.js/client';
 import type { TransactionBlock } from '@mysten/sui.js/transactions';
 import type { SuiKit, SuiKitParams, NetworkType } from '@scallop-io/sui-kit';
 import type { ScallopAddress, ScallopQuery, ScallopUtils, ScallopBuilder } from '../models';
+import { ScallopCache } from 'src/models/scallopCache';
 export type ScallopClientFnReturnType<T extends boolean> = T extends true ? SuiTransactionBlockResponse : TransactionBlock;
 export type ScallopInstanceParams = {
     suiKit?: SuiKit;
@@ -9,6 +10,7 @@ export type ScallopInstanceParams = {
     query?: ScallopQuery;
     utils?: ScallopUtils;
     builder?: ScallopBuilder;
+    cache: ScallopCache;
 };
 export type ScallopAddressParams = {
     id: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scallop-io/sui-scallop-sdk",
-  "version": "0.44.28",
+  "version": "0.45.0",
   "description": "Typescript sdk for interacting with Scallop contract on SUI",
   "keywords": [
     "sui",
@@ -46,6 +46,7 @@
     "@pythnetwork/pyth-sui-js": "^1.2.4",
     "@scallop-io/sui-kit": "^0.44.2",
     "@scure/bip39": "^1.2.1",
+    "@tanstack/query-core": "^5.28.0",
     "axios": "^1.6.0",
     "bignumber.js": "^9.1.2",
     "superstruct": "^1.0.3",

package/src/builders/borrowIncentiveBuilder.ts

@@ -1,7 +1,6 @@
 import { TransactionBlock } from '@mysten/sui.js/transactions';
 import { SUI_CLOCK_OBJECT_ID } from '@mysten/sui.js/utils';
 import { SuiTxBlock as SuiKitTxBlock } from '@scallop-io/sui-kit';
-import { borrowIncentiveRewardCoins } from '../constants/enum';
 import {
   getObligations,
   getObligationLocked,
@@ -160,7 +159,8 @@ const generateBorrowIncentiveNormalMethod: GenerateBorrowIncentiveNormalMethod =
         coinName,
         rewardCoinName
       ) => {
-        const rewardCoinNames = borrowIncentiveRewardCoins[coinName];
+        const rewardCoinNames =
+          builder.utils.getBorrowIncentiveRewardCoinName(coinName);
         if (rewardCoinNames.includes(rewardCoinName) === false) {
           throw new Error(`Invalid reward coin name ${rewardCoinName}`);
         }

package/src/constants/cache.ts

@@ -0,0 +1,15 @@
+import { QueryClientConfig } from '@tanstack/query-core';
+
+/**
+ * Default cache options for the QueryClient.
+ * @type {QueryClientConfig}
+ * @description Default cache options for the QueryClient
+ * We set the default to 5s to prevent duplicate requests from being requested (e.g. query MarketObject, etc.)
+ */
+export const DEFAULT_CACHE_OPTIONS: QueryClientConfig = {
+  defaultOptions: {
+    queries: {
+      staleTime: 3000,
+    },
+  },
+};

package/src/models/index.ts

@@ -5,3 +5,4 @@ export * from './scallopBuilder';
 export * from './scallopQuery';
 export * from './scallopUtils';
 export * from './scallopIndexer';
+export * from './scallopCache';

package/src/models/scallop.ts

@@ -7,8 +7,14 @@ import { ScallopUtils } from './scallopUtils';
 import { ADDRESSES_ID } from '../constants';
 import type { ScallopParams } from '../types/';
 import { ScallopIndexer } from './scallopIndexer';
+import { ScallopCache } from './scallopCache';
+import { QueryClientConfig } from '@tanstack/query-core';
+import { DEFAULT_CACHE_OPTIONS } from 'src/constants/cache';
 
 /**
+ * @argument params - The parameters for the Scallop instance.
+ * @argument cacheOptions - The cache options for the QueryClient.
+ *
  * @description
  * The main instance that controls interaction with the Scallop contract.
  *
@@ -25,16 +31,24 @@ import { ScallopIndexer } from './scallopIndexer';
 export class Scallop {
   public params: ScallopParams;
   public suiKit: SuiKit;
+  public cache: ScallopCache;
 
   private _address: ScallopAddress;
 
-  public constructor(params: ScallopParams) {
+  public constructor(params: ScallopParams, cacheOptions?: QueryClientConfig) {
     this.params = params;
     this.suiKit = new SuiKit(params);
-    this._address = new ScallopAddress({
-      id: params?.addressesId || ADDRESSES_ID,
-      network: params?.networkType,
-    });
+    this.cache = new ScallopCache(
+      cacheOptions ?? DEFAULT_CACHE_OPTIONS,
+      this.suiKit
+    );
+    this._address = new ScallopAddress(
+      {
+        id: params?.addressesId || ADDRESSES_ID,
+        network: params?.networkType,
+      },
+      this.cache
+    );
   }
 
   /**
@@ -59,6 +73,7 @@ export class Scallop {
     const scallopBuilder = new ScallopBuilder(this.params, {
       suiKit: this.suiKit,
       address: this._address,
+      cache: this.cache,
     });
 
     return scallopBuilder;
@@ -74,7 +89,7 @@ export class Scallop {
     if (!this._address.getAddresses()) await this._address.read();
     const scallopClient = new ScallopClient(
       { ...this.params, walletAddress },
-      { suiKit: this.suiKit, address: this._address }
+      { suiKit: this.suiKit, address: this._address, cache: this.cache }
     );
 
     return scallopClient;
@@ -90,6 +105,7 @@ export class Scallop {
     const scallopQuery = new ScallopQuery(this.params, {
       suiKit: this.suiKit,
       address: this._address,
+      cache: this.cache,
     });
 
     return scallopQuery;
@@ -101,7 +117,9 @@ export class Scallop {
    * @return Scallop Indexer.
    */
   public async createScallopIndexer() {
-    const scallopIndexer = new ScallopIndexer();
+    const scallopIndexer = new ScallopIndexer(this.params, {
+      cache: this.cache,
+    });
 
     return scallopIndexer;
   }
@@ -116,6 +134,7 @@ export class Scallop {
     const scallopUtils = new ScallopUtils(this.params, {
       suiKit: this.suiKit,
       address: this._address,
+      cache: this.cache,
     });
 
     return scallopUtils;

package/src/models/scallopAddress.ts

@@ -1,4 +1,3 @@
-import axios, { AxiosInstance } from 'axios';
 import { API_BASE_URL } from '../constants';
 import type { NetworkType } from '@scallop-io/sui-kit';
 import type {
@@ -6,6 +5,9 @@ import type {
   AddressesInterface,
   AddressStringPath,
 } from '../types';
+import { ScallopCache } from './scallopCache';
+import { DEFAULT_CACHE_OPTIONS } from 'src/constants/cache';
+import axios, { AxiosInstance } from 'axios';
 
 const EMPTY_ADDRESSES: AddressesInterface = {
   core: {
@@ -270,20 +272,17 @@ const EMPTY_ADDRESSES: AddressesInterface = {
  */
 export class ScallopAddress {
   private readonly _auth?: string;
+  private readonly _requestClient: AxiosInstance;
 
-  private _requestClient: AxiosInstance;
   private _id?: string;
   private _network: NetworkType;
   private _currentAddresses?: AddressesInterface;
   private _addressesMap: Map<NetworkType, AddressesInterface>;
+  private _cache: ScallopCache;
 
-  public constructor(params: ScallopAddressParams) {
+  public constructor(params: ScallopAddressParams, cache?: ScallopCache) {
     const { id, auth, network } = params;
-
-    if (auth) this._auth = auth;
-    this._id = id;
-    this._network = network || 'mainnet';
-    this._addressesMap = new Map();
+    this._cache = cache ?? new ScallopCache(DEFAULT_CACHE_OPTIONS);
     this._requestClient = axios.create({
       baseURL: API_BASE_URL,
       headers: {
@@ -292,6 +291,10 @@ export class ScallopAddress {
       },
       timeout: 30000,
     });
+    if (auth) this._auth = auth;
+    this._id = id;
+    this._network = network || 'mainnet';
+    this._addressesMap = new Map();
   }
 
   /**
@@ -437,7 +440,7 @@ export class ScallopAddress {
       this._addressesMap.clear();
       this.setAddresses(targetAddresses, targetNetwork);
       const response = await this._requestClient.post(
-        `${API_BASE_URL}/addresses`,
+        `/addresses`,
         JSON.stringify({ ...Object.fromEntries(this._addressesMap), memo }),
         {
           headers: {
@@ -475,14 +478,16 @@ export class ScallopAddress {
   public async read(id?: string) {
     const addressesId = id || this._id || undefined;
     if (addressesId !== undefined) {
-      const response = await this._requestClient.get(
-        `${API_BASE_URL}/addresses/${addressesId}`,
-        {
-          headers: {
-            'Content-Type': 'application/json',
-          },
-        }
-      );
+      const response = await this._cache.queryClient.fetchQuery({
+        queryKey: ['api-getAddresses', addressesId],
+        queryFn: async () => {
+          return await this._requestClient.get(`/addresses/${addressesId}`, {
+            headers: {
+              'Content-Type': 'application/json',
+            },
+          });
+        },
+      });
 
       if (response.status === 200) {
         for (const [network, addresses] of Object.entries<AddressesInterface>(
@@ -548,7 +553,7 @@ export class ScallopAddress {
       }
       this.setAddresses(targetAddresses, targetNetwork);
       const response = await this._requestClient.put(
-        `${API_BASE_URL}/addresses/${targetId}`,
+        `/addresses/${targetId}`,
         JSON.stringify({ ...Object.fromEntries(this._addressesMap), memo }),
         {
           headers: {
@@ -592,7 +597,7 @@ export class ScallopAddress {
       throw Error('Require specific addresses id to be deleted.');
     if (apiKey !== undefined) {
       const response = await this._requestClient.delete(
-        `${API_BASE_URL}/addresses/${targetId}`,
+        `/addresses/${targetId}`,
         {
           headers: {
             'Content-Type': 'application/json',

package/src/models/scallopBuilder.ts

@@ -15,6 +15,8 @@ import type {
   SupportMarketCoins,
   SupportAssetCoins,
 } from '../types';
+import { ScallopCache } from './scallopCache';
+import { DEFAULT_CACHE_OPTIONS } from 'src/constants/cache';
 
 /**
  * @description
@@ -36,6 +38,7 @@ export class ScallopBuilder {
   public query: ScallopQuery;
   public utils: ScallopUtils;
   public walletAddress: string;
+  public cache: ScallopCache;
 
   public constructor(
     params: ScallopBuilderParams,
@@ -43,17 +46,23 @@ export class ScallopBuilder {
   ) {
     this.params = params;
     this.suiKit = instance?.suiKit ?? new SuiKit(params);
+    this.cache =
+      instance?.cache ?? new ScallopCache(DEFAULT_CACHE_OPTIONS, this.suiKit);
     this.address =
       instance?.address ??
-      new ScallopAddress({
-        id: params?.addressesId || ADDRESSES_ID,
-        network: params?.networkType,
-      });
+      new ScallopAddress(
+        {
+          id: params?.addressesId || ADDRESSES_ID,
+          network: params?.networkType,
+        },
+        this.cache
+      );
     this.query =
       instance?.query ??
       new ScallopQuery(params, {
         suiKit: this.suiKit,
         address: this.address,
+        cache: this.cache,
       });
     this.utils =
       instance?.utils ??
@@ -61,6 +70,7 @@ export class ScallopBuilder {
         suiKit: this.suiKit,
         address: this.address,
         query: this.query,
+        cache: this.cache,
       });
     this.walletAddress = normalizeSuiAddress(
       params?.walletAddress || this.suiKit.currentAddress()