@scallop-io/sui-scallop-sdk 0.47.1 → 0.47.3

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/queries/borrowIncentiveQuery.d.ts

@@ -56,4 +56,4 @@ export declare const getBindedObligationId: ({ address, }: {
 }, veScaKeyId: string) => Promise<string | null>;
 export declare const getBindedVeScaKey: ({ address, }: {
     address: ScallopAddress;
-}, obliationId: string) => Promise<string | null>;
+}, obligationId: string) => Promise<string | null>;

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.1",
+  "version": "0.47.3",
   "description": "Typescript sdk for interacting with Scallop contract on SUI",
   "keywords": [
     "sui",

package/src/builders/borrowIncentiveBuilder.ts

@@ -1,11 +1,7 @@
 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 {
-  getObligations,
-  getObligationLocked,
-  getBindedObligationId,
-} from '../queries';
+import { getObligations, getObligationLocked } from '../queries';
 import { requireSender } from '../utils';
 import type { SuiObjectArg } from '@scallop-io/sui-kit';
 import type { ScallopBuilder } from 'src/models';
@@ -18,7 +14,6 @@ import type {
   ScallopTxBlock,
   VescaIds,
 } from '../types';
-import { requireVeSca } from './vescaBuilder';
 import { OLD_BORROW_INCENTIVE_PROTOCOL_ID } from 'src/constants';
 
 /**
@@ -257,28 +252,17 @@ const generateBorrowIncentiveQuickMethod: GenerateBorrowIncentiveQuickMethod =
           );
 
         if (!obligationLocked || unstakeObligationBeforeStake) {
-          const veSca = await requireVeSca(builder, txBlock, veScaKey);
-          if (veSca) {
-            const bindedObligationId = await getBindedObligationId(
-              builder,
-              veSca.keyId
-            );
+          const bindedVeScaKey =
+            await builder.query.getBindedVeScaKey(obligationArg);
 
-            // if bindedObligationId is equal to obligationId, then use it again
-            if (
-              (!bindedObligationId || bindedObligationId === obligationArg) &&
-              veSca.currentVeScaBalance > 0
-            ) {
-              txBlock.stakeObligationWithVesca(
-                obligationArg,
-                obligationKeyArg,
-                veSca.keyId
-              );
-            } else {
-              txBlock.stakeObligation(obligationArg, obligationKeyArg);
-            }
-          } else {
+          if ((veScaKey && veScaKey !== bindedVeScaKey) || !bindedVeScaKey) {
             txBlock.stakeObligation(obligationArg, obligationKeyArg);
+          } else {
+            txBlock.stakeObligationWithVesca(
+              obligationArg,
+              obligationKeyArg,
+              bindedVeScaKey
+            );
           }
         }
       },

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/builders/vescaBuilder.ts

@@ -66,7 +66,8 @@ export const requireVeSca = async (
     return undefined;
   }
 
-  return veScas[0]; // return veSCA with highest veSCA balance
+  // return veSCA with the same veScaKey or the highest veSCA balance
+  return veScaKey ? veScas.find(({ keyId }) => veScaKey === keyId) : veScas[0];
 };
 
 /**

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/queries/borrowIncentiveQuery.ts

@@ -278,7 +278,7 @@ export const getBindedVeScaKey = async (
   }: {
     address: ScallopAddress;
   },
-  obliationId: string
+  obligationId: string
 ): Promise<string | null> => {
   const borrowIncentiveObjectId = address.get('borrowIncentive.object');
   const incentiveAccountsId = address.get('borrowIncentive.incentiveAccounts');
@@ -302,7 +302,7 @@ export const getBindedVeScaKey = async (
     parentId: incentiveAccountsTableId,
     name: {
       type: `${borrowIncentiveObjectId}::typed_id::TypedID<${corePkg}::obligation::Obligation>`,
-      value: obliationId,
+      value: obligationId,
     },
   });
 

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[];