@scallop-io/sui-scallop-sdk 0.47.5 → 0.47.7

package/dist/types/model.d.ts

@@ -3,6 +3,7 @@ import type { TransactionBlock, TransactionResult } from '@mysten/sui.js/transac
 import type { SuiKit, SuiKitParams, NetworkType } from '@scallop-io/sui-kit';
 import type { ScallopAddress, ScallopQuery, ScallopUtils, ScallopBuilder, ScallopIndexer } from '../models';
 import { ScallopCache } from 'src/models/scallopCache';
+import { AddressesInterface } from './address';
 export type ScallopClientFnReturnType<T extends boolean> = T extends true ? SuiTransactionBlockResponse : TransactionBlock;
 export type ScallopClientVeScaReturnType<T extends boolean> = T extends true ? SuiTransactionBlockResponse : {
     tx: TransactionBlock;
@@ -35,9 +36,11 @@ export type ScallopAddressParams = {
     id: string;
     auth?: string;
     network?: NetworkType;
+    forceInterface?: Partial<Record<NetworkType, AddressesInterface>>;
 };
 export type ScallopParams = {
     addressesId?: string;
+    forceAddressesInterface?: Partial<Record<NetworkType, AddressesInterface>>;
     walletAddress?: string;
 } & SuiKitParams;
 export type ScallopClientParams = ScallopParams & ScallopBuilderParams & ScallopQueryParams & ScallopUtilsParams;

package/dist/utils/index.d.ts

@@ -2,3 +2,4 @@ export * from './builder';
 export * from './query';
 export * from './util';
 export * from './tokenBucket';
+export * from './indexer';

package/dist/utils/indexer.d.ts

@@ -0,0 +1,17 @@
+/**
+ * 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 declare function callMethodWithIndexerFallback(method: Function, context: any, ...args: any[]): Promise<any>;
+/**
+ * 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 declare function withIndexerFallback(method: Function): (...args: any[]) => Promise<any>;

package/package.json

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

package/src/models/scallop.ts

@@ -64,6 +64,7 @@ export class Scallop {
       {
         id: params?.addressesId || ADDRESSES_ID,
         network: params?.networkType,
+        forceInterface: params?.forceAddressesInterface,
       },
       { cache: this.cache }
     );

package/src/models/scallopAddress.ts

@@ -377,7 +377,7 @@ export class ScallopAddress {
     params: ScallopAddressParams,
     instance?: ScallopAddressInstanceParams
   ) {
-    const { id, auth, network } = params;
+    const { id, auth, network, forceInterface } = params;
     this.cache =
       instance?.cache ??
       new ScallopCache(
@@ -401,6 +401,18 @@ export class ScallopAddress {
       ? new Map([['mainnet', TEST_ADDRESSES]])
       : new Map();
     if (USE_TEST_ADDRESS) this._currentAddresses = TEST_ADDRESSES;
+
+    // Set the addresses from the forceInterface if it is provided.
+    if (forceInterface) {
+      for (const [network, addresses] of Object.entries<AddressesInterface>(
+        forceInterface
+      )) {
+        if (['localnet', 'devnet', 'testnet', 'mainnet'].includes(network)) {
+          if (network === this._network) this._currentAddresses = addresses;
+          this._addressesMap.set(network as NetworkType, addresses);
+        }
+      }
+    }
   }
 
   /**

package/src/models/scallopBuilder.ts

@@ -68,6 +68,7 @@ export class ScallopBuilder {
         {
           id: params?.addressesId || ADDRESSES_ID,
           network: params?.networkType,
+          forceInterface: params?.forceAddressesInterface,
         },
         {
           cache: this.cache,

package/src/models/scallopClient.ts

@@ -85,6 +85,7 @@ export class ScallopClient {
         {
           id: params?.addressesId || ADDRESSES_ID,
           network: params?.networkType,
+          forceInterface: params?.forceAddressesInterface,
         },
         {
           cache: this.cache,

package/src/models/scallopQuery.ts

@@ -62,6 +62,7 @@ import {
 } from 'src/queries/sCoinQuery';
 import { normalizeSuiAddress } from '@mysten/sui.js/utils';
 import { getSupplyLimit } from 'src/queries/supplyLimit';
+import { withIndexerFallback } from 'src/utils/indexer';
 
 /**
  * @description
@@ -111,6 +112,7 @@ export class ScallopQuery {
         {
           id: params?.addressesId || ADDRESSES_ID,
           network: params?.networkType,
+          forceInterface: params?.forceAddressesInterface,
         },
         {
           cache: this.cache,
@@ -123,8 +125,40 @@ export class ScallopQuery {
     this.indexer =
       instance?.indexer ??
       new ScallopIndexer(this.params, { cache: this.cache });
+
+    // Wrap any method that has an indexer parameter as the last parameter
+    this.queryMarket = withIndexerFallback.call(this, this.queryMarket);
+    this.getMarketPools = withIndexerFallback.call(this, this.getMarketPools);
+    this.getMarketPool = withIndexerFallback.call(this, this.getMarketPool);
+    this.getMarketCollaterals = withIndexerFallback.call(
+      this,
+      this.getMarketCollaterals
+    );
+    this.getMarketCollateral = withIndexerFallback.call(
+      this,
+      this.getMarketCollateral
+    );
+    this.getSpools = withIndexerFallback.call(this, this.getSpools);
+    this.getSpool = withIndexerFallback.call(this, this.getSpool);
+    this.getBorrowIncentivePools = withIndexerFallback.call(
+      this,
+      this.getBorrowIncentivePools
+    );
+    this.getLendings = withIndexerFallback.call(this, this.getLendings);
+    this.getLending = withIndexerFallback.call(this, this.getLending);
+    this.getObligationAccounts = withIndexerFallback.call(
+      this,
+      this.getObligationAccounts
+    );
+    this.getObligationAccount = withIndexerFallback.call(
+      this,
+      this.getObligationAccount
+    );
+    this.getTvl = withIndexerFallback.call(this, this.getTvl);
   }
 
+  /* ========================================================== */
+
   /**
    * Request the scallop API to initialize data.
    *

package/src/models/scallopUtils.ts

@@ -101,6 +101,7 @@ export class ScallopUtils {
           {
             id: params?.addressesId || ADDRESSES_ID,
             network: params?.networkType,
+            forceInterface: params?.forceAddressesInterface,
           },
           {
             cache: this.cache,

package/src/types/model.ts

@@ -12,6 +12,7 @@ import type {
   ScallopIndexer,
 } from '../models';
 import { ScallopCache } from 'src/models/scallopCache';
+import { AddressesInterface } from './address';
 
 export type ScallopClientFnReturnType<T extends boolean> = T extends true
   ? SuiTransactionBlockResponse
@@ -59,10 +60,12 @@ export type ScallopAddressParams = {
   id: string;
   auth?: string;
   network?: NetworkType;
+  forceInterface?: Partial<Record<NetworkType, AddressesInterface>>;
 };
 
 export type ScallopParams = {
   addressesId?: string;
+  forceAddressesInterface?: Partial<Record<NetworkType, AddressesInterface>>;
   walletAddress?: string;
 } & SuiKitParams;
 

package/src/utils/index.ts

@@ -2,3 +2,4 @@ export * from './builder';
 export * from './query';
 export * from './util';
 export * from './tokenBucket';
+export * from './indexer';

package/src/utils/indexer.ts

@@ -0,0 +1,39 @@
+/**
+ * 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 indexer = args[args.length - 1]; // Assume last argument is always `indexer`
+
+  if (indexer) {
+    try {
+      return await method.apply(context, args);
+    } catch (_e) {
+      console.warn('Indexer requests failed. Retrying without indexer..');
+      return await method.apply(context, [...args.slice(0, -1), 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
+  };
+}