@scallop-io/sui-scallop-sdk 0.47.2 → 0.47.4

package/dist/models/scallop.d.ts

@@ -4,7 +4,7 @@ import { ScallopClient } from './scallopClient';
 import { ScallopBuilder } from './scallopBuilder';
 import { ScallopQuery } from './scallopQuery';
 import { ScallopUtils } from './scallopUtils';
-import type { ScallopParams } from '../types/';
+import type { ScallopBuilderParams, ScallopClientParams, ScallopParams, ScallopQueryParams, ScallopUtilsParams } from '../types/';
 import { ScallopIndexer } from './scallopIndexer';
 import { ScallopCache } from './scallopCache';
 import { QueryClientConfig } from '@tanstack/query-core';
@@ -44,20 +44,20 @@ export declare class Scallop {
      *
      * @return Scallop Builder.
      */
-    createScallopBuilder(): Promise<ScallopBuilder>;
+    createScallopBuilder(params?: ScallopBuilderParams): Promise<ScallopBuilder>;
     /**
      * Create a scallop client instance that already has initial data.
      *
      * @param walletAddress - When user cannot provide a secret key or mnemonic, the scallop client cannot directly derive the address of the transaction the user wants to sign. This argument specifies the wallet address for signing the transaction.
      * @return Scallop Client.
      */
-    createScallopClient(walletAddress?: string): Promise<ScallopClient>;
+    createScallopClient(params?: ScallopClientParams): Promise<ScallopClient>;
     /**
      * Create a scallop query instance.
      *
      * @return Scallop Query.
      */
-    createScallopQuery(): Promise<ScallopQuery>;
+    createScallopQuery(params?: ScallopQueryParams): Promise<ScallopQuery>;
     /**
      * Create a scallop indexer instance.
      *
@@ -69,5 +69,5 @@ export declare class Scallop {
      *
      * @return Scallop Utils.
      */
-    createScallopUtils(): Promise<ScallopUtils>;
+    createScallopUtils(params?: ScallopUtilsParams): Promise<ScallopUtils>;
 }

package/dist/models/scallopQuery.d.ts

@@ -386,7 +386,10 @@ export declare class ScallopQuery {
      * @param walletAddress
      * @returns array of veSca
      */
-    getVeScas(walletAddress?: string): Promise<import("../types").Vesca[]>;
+    getVeScas({ walletAddress, excludeEmpty, }?: {
+        walletAddress?: string;
+        excludeEmpty?: boolean;
+    }): Promise<import("../types").Vesca[]>;
     /**
      * Get total vesca treasury with movecall
      * @returns Promise<string | undefined>

package/dist/queries/vescaQuery.d.ts

@@ -18,7 +18,7 @@ export declare const getVescaKeys: (utils: ScallopUtils, ownerAddress?: string)
  */
 export declare const getVeScas: ({ utils, }: {
     utils: ScallopUtils;
-}, ownerAddress?: string) => Promise<Vesca[]>;
+}, ownerAddress?: string, excludeEmpty?: boolean) => Promise<Vesca[]>;
 /**
  * Get veSca data.
  *

package/dist/types/model.d.ts

@@ -40,11 +40,12 @@ export type ScallopParams = {
     addressesId?: string;
     walletAddress?: string;
 } & SuiKitParams;
-export type ScallopClientParams = ScallopParams;
+export type ScallopClientParams = ScallopParams & ScallopBuilderParams & ScallopQueryParams & ScallopUtilsParams;
 export type ScallopBuilderParams = ScallopParams & {
     pythEndpoints?: string[];
-};
-export type ScallopQueryParams = ScallopParams;
+    usePythPullModel?: boolean;
+} & ScallopQueryParams;
+export type ScallopQueryParams = ScallopParams & ScallopUtilsParams;
 export type ScallopUtilsParams = ScallopParams & {
     pythEndpoints?: string[];
 };

package/package.json

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

package/src/builders/borrowIncentiveBuilder.ts

@@ -255,19 +255,14 @@ const generateBorrowIncentiveQuickMethod: GenerateBorrowIncentiveQuickMethod =
           const bindedVeScaKey =
             await builder.query.getBindedVeScaKey(obligationArg);
 
-          if (veScaKey && veScaKey !== bindedVeScaKey) {
-            throw new Error(
-              'Binded veScaKey is not equal to the provided veScaKey'
-            );
-          }
-          if (bindedVeScaKey) {
+          if ((veScaKey && veScaKey !== bindedVeScaKey) || !bindedVeScaKey) {
+            txBlock.stakeObligation(obligationArg, obligationKeyArg);
+          } else {
             txBlock.stakeObligationWithVesca(
               obligationArg,
               obligationKeyArg,
               bindedVeScaKey
             );
-          } else {
-            txBlock.stakeObligation(obligationArg, obligationKeyArg);
           }
         }
       },

package/src/builders/oracle.ts

@@ -16,17 +16,23 @@ import { PYTH_ENDPOINTS } from 'src/constants/pyth';
  * @param builder - The scallop builder.
  * @param txBlock - TxBlock created by SuiKit.
  * @param assetCoinNames - Specific an array of support asset coin name.
+ * @param options - The options for update oracles.
  */
 export const updateOracles = async (
   builder: ScallopBuilder,
   txBlock: SuiKitTxBlock,
-  assetCoinNames?: SupportAssetCoins[]
+  assetCoinNames?: SupportAssetCoins[],
+  options: {
+    usePythPullModel: boolean;
+  } = { usePythPullModel: true }
 ) => {
+  const usePythPullModel =
+    builder.params.usePythPullModel ?? options.usePythPullModel;
   assetCoinNames = assetCoinNames ?? [
     ...new Set([...SUPPORT_POOLS, ...SUPPORT_COLLATERALS]),
   ];
   const rules: SupportOracleType[] = builder.isTestnet ? ['pyth'] : ['pyth'];
-  if (rules.includes('pyth')) {
+  if (usePythPullModel && rules.includes('pyth')) {
     const pythClient = new SuiPythClient(
       builder.suiKit.client(),
       builder.address.get('core.oracles.pyth.state'),

package/src/models/scallop.ts

@@ -5,7 +5,13 @@ import { ScallopBuilder } from './scallopBuilder';
 import { ScallopQuery } from './scallopQuery';
 import { ScallopUtils } from './scallopUtils';
 import { ADDRESSES_ID } from '../constants';
-import type { ScallopParams } from '../types/';
+import type {
+  ScallopBuilderParams,
+  ScallopClientParams,
+  ScallopParams,
+  ScallopQueryParams,
+  ScallopUtilsParams,
+} from '../types/';
 import { ScallopIndexer } from './scallopIndexer';
 import { ScallopCache } from './scallopCache';
 import { QueryClientConfig } from '@tanstack/query-core';
@@ -80,10 +86,14 @@ export class Scallop {
    *
    * @return Scallop Builder.
    */
-  public async createScallopBuilder() {
+  public async createScallopBuilder(params?: ScallopBuilderParams) {
     if (!this.address.getAddresses()) await this.address.read();
-    const scallopBuilder = new ScallopBuilder(this.params, {
-      query: await this.createScallopQuery(),
+    const builderParams = {
+      ...this.params,
+      ...params,
+    };
+    const scallopBuilder = new ScallopBuilder(builderParams, {
+      query: await this.createScallopQuery(builderParams),
     });
 
     return scallopBuilder;
@@ -95,12 +105,15 @@ export class Scallop {
    * @param walletAddress - When user cannot provide a secret key or mnemonic, the scallop client cannot directly derive the address of the transaction the user wants to sign. This argument specifies the wallet address for signing the transaction.
    * @return Scallop Client.
    */
-  public async createScallopClient(walletAddress?: string) {
+  public async createScallopClient(params?: ScallopClientParams) {
     if (!this.address.getAddresses()) await this.address.read();
-    const scallopClient = new ScallopClient(
-      { ...this.params, walletAddress },
-      { builder: await this.createScallopBuilder() }
-    );
+    const clientParams = {
+      ...this.params,
+      ...params,
+    };
+    const scallopClient = new ScallopClient(clientParams, {
+      builder: await this.createScallopBuilder(clientParams),
+    });
 
     return scallopClient;
   }
@@ -110,10 +123,14 @@ export class Scallop {
    *
    * @return Scallop Query.
    */
-  public async createScallopQuery() {
+  public async createScallopQuery(params?: ScallopQueryParams) {
     if (!this.address.getAddresses()) await this.address.read();
-    const scallopQuery = new ScallopQuery(this.params, {
-      utils: await this.createScallopUtils(),
+    const queryParams = {
+      ...this.params,
+      ...params,
+    };
+    const scallopQuery = new ScallopQuery(queryParams, {
+      utils: await this.createScallopUtils(queryParams),
     });
 
     return scallopQuery;
@@ -137,11 +154,17 @@ export class Scallop {
    *
    * @return Scallop Utils.
    */
-  public async createScallopUtils() {
+  public async createScallopUtils(params?: ScallopUtilsParams) {
     if (!this.address.getAddresses()) await this.address.read();
-    const scallopUtils = new ScallopUtils(this.params, {
-      address: this.address,
-    });
+    const scallopUtils = new ScallopUtils(
+      {
+        ...this.params,
+        ...params,
+      },
+      {
+        address: this.address,
+      }
+    );
 
     return scallopUtils;
   }

package/src/models/scallopClient.ts

@@ -1095,7 +1095,9 @@ export class ScallopClient {
   ): Promise<ScallopClientVeScaReturnType<S>> {
     // get all veSca keys
     const veScaKeys = (
-      (await this.query.getVeScas(this.walletAddress)) ?? []
+      (await this.query.getVeScas({
+        walletAddress: this.walletAddress,
+      })) ?? []
     ).map(({ keyObject }) => keyObject);
     if (veScaKeys.length === 0) {
       throw new Error('No veSCA found in the wallet');

package/src/models/scallopQuery.ts

@@ -579,8 +579,14 @@ export class ScallopQuery {
    * @param walletAddress
    * @returns array of veSca
    */
-  public async getVeScas(walletAddress: string = this.walletAddress) {
-    return await getVeScas(this, walletAddress);
+  public async getVeScas({
+    walletAddress = this.walletAddress,
+    excludeEmpty = false,
+  }: {
+    walletAddress?: string;
+    excludeEmpty?: boolean;
+  } = {}) {
+    return await getVeScas(this, walletAddress, excludeEmpty);
   }
 
   /**

package/src/queries/vescaQuery.ts

@@ -70,7 +70,8 @@ export const getVeScas = async (
   }: {
     utils: ScallopUtils;
   },
-  ownerAddress?: string
+  ownerAddress?: string,
+  excludeEmpty?: boolean
 ) => {
   const keyObjectDatas = await getVescaKeys(utils, ownerAddress);
 
@@ -83,9 +84,14 @@ export const getVeScas = async (
   });
   await Promise.allSettled(tasks);
 
-  return veScas
+  const result = veScas
     .filter(Boolean)
     .sort((a, b) => b!.currentVeScaBalance - a!.currentVeScaBalance);
+
+  if (excludeEmpty) {
+    return result.filter((v) => v.lockedScaAmount !== '0');
+  }
+  return result;
 };
 
 const SuiObjectRefZod = zod.object({

package/src/types/model.ts

@@ -66,13 +66,17 @@ export type ScallopParams = {
   walletAddress?: string;
 } & SuiKitParams;
 
-export type ScallopClientParams = ScallopParams;
+export type ScallopClientParams = ScallopParams &
+  ScallopBuilderParams &
+  ScallopQueryParams &
+  ScallopUtilsParams;
 
 export type ScallopBuilderParams = ScallopParams & {
   pythEndpoints?: string[];
-};
+  usePythPullModel?: boolean;
+} & ScallopQueryParams;
 
-export type ScallopQueryParams = ScallopParams;
+export type ScallopQueryParams = ScallopParams & ScallopUtilsParams;
 
 export type ScallopUtilsParams = ScallopParams & {
   pythEndpoints?: string[];