@scallop-io/sui-scallop-sdk 0.44.28 → 0.46.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,75 @@
+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, GetBalanceParams } 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>
+     */
+    getProtocolConfig(): Promise<import("@mysten/sui.js/client").ProtocolConfig>;
+    /**
+     * @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>;
+    queryGetAllCoinBalances(owner: string): Promise<{
+        [k: string]: string;
+    }>;
+    queryGetCoinBalance(input: GetBalanceParams): Promise<string>;
+}
+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.
@@ -122,20 +124,7 @@ export declare class ScallopQuery {
      * @param ownerAddress - The owner address.
      * @return All coin amounts.
      */
-    getCoinAmounts(assetCoinNames?: SupportAssetCoins[], ownerAddress?: string): Promise<{
-        eth?: number | undefined;
-        btc?: number | undefined;
-        usdc?: number | undefined;
-        usdt?: number | undefined;
-        sui?: number | undefined;
-        apt?: number | undefined;
-        sol?: number | undefined;
-        cetus?: number | undefined;
-        afsui?: number | undefined;
-        hasui?: number | undefined;
-        vsui?: number | undefined;
-        sca?: number | undefined;
-    }>;
+    getCoinAmounts(assetCoinNames?: SupportAssetCoins[], ownerAddress?: string): Promise<import("../types").OptionalKeys<Record<SupportAssetCoins, number>>>;
     /**
      * Get asset coin amount.
      *
@@ -151,20 +140,7 @@ export declare class ScallopQuery {
      * @param ownerAddress - The owner address.
      * @return All market market coin amounts.
      */
-    getMarketCoinAmounts(marketCoinNames?: SupportMarketCoins[], ownerAddress?: string): Promise<{
-        seth?: number | undefined;
-        ssui?: number | undefined;
-        susdc?: number | undefined;
-        susdt?: number | undefined;
-        scetus?: number | undefined;
-        safsui?: number | undefined;
-        shasui?: number | undefined;
-        svsui?: number | undefined;
-        sbtc?: number | undefined;
-        sapt?: number | undefined;
-        ssol?: number | undefined;
-        ssca?: number | undefined;
-    }>;
+    getMarketCoinAmounts(marketCoinNames?: SupportMarketCoins[], ownerAddress?: string): Promise<import("../types").OptionalKeys<Record<SupportMarketCoins, number>>>;
     /**
      * Get market coin amount.
      *
@@ -180,6 +156,13 @@ export declare class ScallopQuery {
      * @return Asset coin price.
      */
     getPriceFromPyth(assetCoinName: SupportAssetCoins): Promise<number>;
+    /**
+     * Get prices from pyth fee object.
+     *
+     * @param assetCoinNames - Array of supported asset coin names.
+     * @return Array of asset coin prices.
+     */
+    getPricesFromPyth(assetCoinNames: SupportAssetCoins[]): Promise<Record<SupportAssetCoins, number>>;
     /**
      * Get spools data.
      *
@@ -382,6 +365,23 @@ export declare class ScallopQuery {
      * @return Total value locked.
      */
     getTvl(indexer?: boolean): Promise<import("../types").TotalValueLocked>;
+    /**
+     * Get all veSca from walletAdddress
+     * @param walletAddress
+     * @returns array of veSca
+     */
+    getVeScas(walletAddress: string): Promise<(import("../types").Vesca | undefined)[]>;
+    /**
+     * Get total vesca treasury with movecall
+     * @returns Promise<string | undefined>
+     */
+    getTotalVeScaTreasuryAmount(): Promise<string>;
+    /**
+     * Return binded veScaKeyId of walletAddress if exist
+     * @param walletAddress
+     * @returns veScaKeyId
+     */
+    getVeScaKeyIdFromReferralBindings(walletAddress: string): Promise<string | null>;
     /**
      * Get binded obligationId from a veScaKey if it exists.
      * @param veScaKey

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

@@ -1,7 +1,7 @@
 import type { SuiObjectData } from '@mysten/sui.js/client';
 import type { SuiAddressArg } from '@scallop-io/sui-kit';
 import type { ScallopQuery } from '../models';
-import { Market, MarketPool, MarketCollateral, SupportAssetCoins, SupportPoolCoins, SupportCollateralCoins, ObligationQueryInterface, Obligation, SupportMarketCoins } from '../types';
+import { Market, MarketPool, MarketCollateral, SupportAssetCoins, SupportPoolCoins, SupportCollateralCoins, ObligationQueryInterface, Obligation, SupportMarketCoins, OptionalKeys } from '../types';
 /**
  * Query market data.
  *
@@ -122,20 +122,7 @@ export declare const queryObligation: (query: ScallopQuery, obligationId: SuiAdd
  * @param ownerAddress - The owner address.
  * @return All owned coin amounts.
  */
-export declare const getCoinAmounts: (query: ScallopQuery, assetCoinNames?: SupportAssetCoins[], ownerAddress?: string) => Promise<{
-    eth?: number | undefined;
-    btc?: number | undefined;
-    usdc?: number | undefined;
-    usdt?: number | undefined;
-    sui?: number | undefined;
-    apt?: number | undefined;
-    sol?: number | undefined;
-    cetus?: number | undefined;
-    afsui?: number | undefined;
-    hasui?: number | undefined;
-    vsui?: number | undefined;
-    sca?: number | undefined;
-}>;
+export declare const getCoinAmounts: (query: ScallopQuery, assetCoinNames?: SupportAssetCoins[], ownerAddress?: string) => Promise<OptionalKeys<Record<SupportAssetCoins, number>>>;
 /**
  * Query owned coin amount.
  *
@@ -153,20 +140,7 @@ export declare const getCoinAmount: (query: ScallopQuery, assetCoinName: Support
  * @param ownerAddress - The owner address.
  * @return All owned market coins amount.
  */
-export declare const getMarketCoinAmounts: (query: ScallopQuery, marketCoinNames?: SupportMarketCoins[], ownerAddress?: string) => Promise<{
-    seth?: number | undefined;
-    ssui?: number | undefined;
-    susdc?: number | undefined;
-    susdt?: number | undefined;
-    scetus?: number | undefined;
-    safsui?: number | undefined;
-    shasui?: number | undefined;
-    svsui?: number | undefined;
-    sbtc?: number | undefined;
-    sapt?: number | undefined;
-    ssol?: number | undefined;
-    ssca?: number | undefined;
-}>;
+export declare const getMarketCoinAmounts: (query: ScallopQuery, marketCoinNames?: SupportMarketCoins[], ownerAddress?: string) => Promise<OptionalKeys<Record<SupportMarketCoins, number>>>;
 /**
  * Query owned market coin (sCoin) amount.
  *

package/dist/queries/index.d.ts

@@ -4,3 +4,4 @@ export * from './borrowIncentiveQuery';
 export * from './priceQuery';
 export * from './portfolioQuery';
 export * from './vescaQuery';
+export * from './referralQuery';

package/dist/queries/priceQuery.d.ts

@@ -1,3 +1,4 @@
+import { SuiObjectData } from '@mysten/sui.js/src/client';
 import type { ScallopQuery } from '../models';
 import type { SupportAssetCoins } from '../types';
 /**
@@ -7,4 +8,5 @@ import type { SupportAssetCoins } from '../types';
  * @param assetCoinName - Specific support asset coin name.
  * @return Asset coin price.
  */
-export declare const getPythPrice: (query: ScallopQuery, assetCoinName: SupportAssetCoins) => Promise<number>;
+export declare const getPythPrice: (query: ScallopQuery, assetCoinName: SupportAssetCoins, priceFeedObject?: SuiObjectData | null) => Promise<number>;
+export declare const getPythPrices: (query: ScallopQuery, assetCoinNames: SupportAssetCoins[]) => Promise<Record<SupportAssetCoins, number>>;

package/dist/queries/referralQuery.d.ts

@@ -0,0 +1,7 @@
+import { ScallopQuery } from 'src/models';
+/**
+ * Query the veScaKeyId from the referral bindings table using the borrower address
+ * @param query
+ * @returns
+ */
+export declare const queryVeScaKeyIdFromReferralBindings: (query: ScallopQuery, refereeAddress: string) => Promise<string | null>;

package/dist/queries/vescaQuery.d.ts

@@ -1,5 +1,5 @@
 import { Vesca } from '../types';
-import type { SuiObjectData } from '@mysten/sui.js/client';
+import { type SuiObjectData } from '@mysten/sui.js/client';
 import type { ScallopQuery } from '../models';
 /**
  * Query all owned veSca key.
@@ -16,7 +16,7 @@ export declare const getVescaKeys: (query: ScallopQuery, ownerAddress?: string)
  * @param ownerAddress - The owner address.
  * @return Owned veScas.
  */
-export declare const getVeScas: (query: ScallopQuery, ownerAddress?: string) => Promise<Vesca[]>;
+export declare const getVeScas: (query: ScallopQuery, ownerAddress?: string) => Promise<(Vesca | undefined)[]>;
 /**
  * Get veSca data.
  *
@@ -26,3 +26,7 @@ export declare const getVeScas: (query: ScallopQuery, ownerAddress?: string) =>
  * @returns Vesca data.
  */
 export declare const getVeSca: (query: ScallopQuery, veScaKeyId?: string, ownerAddress?: string) => Promise<Vesca | undefined>;
+/**
+ * Get current total veSca treasury amount.
+ */
+export declare const getTotalVeScaTreasuryAmount: (query: ScallopQuery) => Promise<string>;

package/dist/types/address.d.ts

@@ -48,6 +48,7 @@ export interface AddressesInterface {
         id: string;
         adminCap: string;
         object: string;
+        config: string;
         pools: Partial<Record<SupportStakeMarketCoins, {
             id: string;
             rewardPoolId: string;
@@ -64,12 +65,26 @@ export interface AddressesInterface {
     };
     vesca: {
         id: string;
+        object: string;
         adminCap: string;
         tableId: string;
         table: string;
         treasury: string;
         config: string;
     };
+    referral: {
+        id: string;
+        version: string;
+        object: string;
+        adminCap: string;
+        referralBindings: string;
+        bindingTableId: string;
+        referralRevenuePool: string;
+        revenueTableId: string;
+        referralTiers: string;
+        tiersTableId: string;
+        authorizedWitnessList: string;
+    };
 }
 type AddressPathsProps<T> = T extends string ? [] : {
     [K in Extract<keyof T, string>]: [K, ...AddressPathsProps<T[K]>];

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

@@ -20,6 +20,7 @@ export type CoreNormalMethods = {
     withdraw: (marketCoin: SuiObjectArg, poolCoinName: SupportPoolCoins) => TransactionResult;
     withdrawEntry: (marketCoin: SuiObjectArg, poolCoinName: SupportPoolCoins) => void;
     borrow: (obligation: SuiAddressArg, obligationKey: SuiAddressArg, amount: SuiTxArg, poolCoinName: SupportPoolCoins) => TransactionResult;
+    borrowWithReferral: (obligation: SuiAddressArg, obligationKey: SuiAddressArg, borrowReferral: SuiObjectArg, amount: SuiTxArg, poolCoinName: SupportPoolCoins) => TransactionResult;
     borrowEntry: (obligation: SuiAddressArg, obligationKey: SuiAddressArg, amount: SuiTxArg, poolCoinName: SupportPoolCoins) => void;
     repay: (obligation: SuiAddressArg, coin: SuiObjectArg, poolCoinName: SupportPoolCoins) => void;
     borrowFlashLoan: (amount: SuiTxArg, poolCoinName: SupportPoolCoins) => TransactionResult;
@@ -29,6 +30,7 @@ export type CoreQuickMethods = {
     addCollateralQuick: (amount: number, collateralCoinName: SupportCollateralCoins, obligationId?: SuiAddressArg) => Promise<void>;
     takeCollateralQuick: (amount: number, collateralCoinName: SupportCollateralCoins, obligationId?: SuiAddressArg, obligationKey?: SuiAddressArg) => Promise<TransactionResult>;
     borrowQuick: (amount: number, poolCoinName: SupportPoolCoins, obligationId?: SuiAddressArg, obligationKey?: SuiAddressArg) => Promise<TransactionResult>;
+    borrowWithReferralQuick: (amount: number, poolCoinName: SupportPoolCoins, borrowReferral: SuiObjectArg, obligationId?: SuiAddressArg, obligationKey?: SuiAddressArg) => Promise<TransactionResult>;
     depositQuick: (amount: number, poolCoinName: SupportPoolCoins) => Promise<TransactionResult>;
     withdrawQuick: (amount: number, poolCoinName: SupportPoolCoins) => Promise<TransactionResult>;
     repayQuick: (amount: number, poolCoinName: SupportPoolCoins, obligationId?: SuiAddressArg) => Promise<void>;

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

@@ -2,8 +2,9 @@ import type { CoreTxBlock } from './core';
 import type { SpoolTxBlock } from './spool';
 import type { BorrowIncentiveTxBlock } from './borrowIncentive';
 import type { VeScaTxBlock } from './vesca';
+import type { ReferralTxBlock } from './referral';
 export type * from './core';
 export type * from './spool';
 export type * from './borrowIncentive';
 export type * from './vesca';
-export type ScallopTxBlock = CoreTxBlock & SpoolTxBlock & BorrowIncentiveTxBlock & VeScaTxBlock;
+export type ScallopTxBlock = CoreTxBlock & SpoolTxBlock & ReferralTxBlock & BorrowIncentiveTxBlock & VeScaTxBlock;

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

@@ -0,0 +1,30 @@
+import { SuiObjectArg, TransactionResult, SuiTxBlock as SuiKitTxBlock } from '@scallop-io/sui-kit';
+import { ScallopBuilder } from 'src/models';
+import { SupportPoolCoins } from '../constant';
+export type ReferralIds = {
+    referralPgkId: string;
+    referralBindings: string;
+    referralRevenuePool: string;
+    referralTiers: string;
+    authorizedWitnessList: string;
+    version: string;
+};
+export type ReferralNormalMethods = {
+    bindToReferral: (veScaKeyId: string) => void;
+    claimReferralTicket: (poolCoinName: SupportPoolCoins) => TransactionResult;
+    burnReferralTicket: (ticket: SuiObjectArg, poolCoinName: SupportPoolCoins) => void;
+    claimReferralRevenue: (veScaKey: SuiObjectArg, poolCoinName: SupportPoolCoins) => TransactionResult;
+};
+export type ReferralQuickMethods = {
+    claimReferralRevenueQuick: (veScaKey: SuiObjectArg, coinNames: SupportPoolCoins[]) => Promise<void>;
+};
+export type SuiTxBlockWithReferralNormalMethods = SuiKitTxBlock & ReferralNormalMethods;
+export type ReferralTxBlock = SuiTxBlockWithReferralNormalMethods & ReferralQuickMethods;
+export type GenerateReferralNormalMethod = (params: {
+    builder: ScallopBuilder;
+    txBlock: SuiKitTxBlock;
+}) => ReferralNormalMethods;
+export type GenerateReferralQuickMethod = (params: {
+    builder: ScallopBuilder;
+    txBlock: SuiTxBlockWithReferralNormalMethods;
+}) => ReferralQuickMethods;

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

@@ -13,6 +13,7 @@ export type VeScaNormalMethods = {
     extendLockAmount: (veScaKey: SuiObjectArg, scaCoin: SuiObjectArg) => void;
     renewExpiredVeSca: (veScaKey: SuiObjectArg, scaCoin: SuiObjectArg, newUnlockAtInSecondTimestamp: SuiTxArg) => void;
     redeemSca: (veScaKey: SuiObjectArg) => TransactionResult;
+    mintEmptyVeSca: () => TransactionResult;
 };
 export type VeScaQuickMethods = {
     lockScaQuick(amountOrCoin?: SuiObjectArg | number, lockPeriodInDays?: number, autoCheck?: boolean): Promise<void>;

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.46.0",
   "description": "Typescript sdk for interacting with Scallop contract on SUI",
   "keywords": [
     "sui",
@@ -39,14 +39,16 @@
   ],
   "dependencies": {
     "@mysten/bcs": "^0.8.1",
-    "@mysten/sui.js": "^0.44.0",
+    "@mysten/sui.js": "^0.49.1",
     "@noble/curves": "^1.2.0",
     "@noble/hashes": "^1.3.2",
     "@pythnetwork/price-service-client": "^1.8.2",
-    "@pythnetwork/pyth-sui-js": "^1.2.4",
-    "@scallop-io/sui-kit": "^0.44.2",
+    "@pythnetwork/pyth-sui-js": "2.0.0",
+    "@scallop-io/sui-kit": "^0.45.0",
     "@scure/bip39": "^1.2.1",
+    "@tanstack/query-core": "^5.28.0",
     "axios": "^1.6.0",
+    "bech32": "^2.0.0",
     "bignumber.js": "^9.1.2",
     "superstruct": "^1.0.3",
     "tweetnacl": "^1.0.3"
@@ -73,8 +75,8 @@
     "vitest": "^0.34.6"
   },
   "peerDependencies": {
-    "@mysten/sui.js": "^0.44.0",
-    "@scallop-io/sui-kit": "^0.44.0"
+    "@mysten/sui.js": "0.49.1",
+    "@scallop-io/sui-kit": "^0.44.2"
   },
   "lint-staged": {
     "**/*.ts": [

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,
@@ -9,7 +8,7 @@ import {
 } from '../queries';
 import { requireSender } from '../utils';
 import type { SuiObjectArg } from '@scallop-io/sui-kit';
-import type { ScallopBuilder } from '../models';
+import type { ScallopBuilder } from 'src/models';
 import type {
   BorrowIncentiveIds,
   GenerateBorrowIncentiveNormalMethod,
@@ -20,10 +19,7 @@ import type {
   VescaIds,
 } from '../types';
 import { requireVeSca } from './vescaBuilder';
-import {
-  IS_VE_SCA_TEST,
-  OLD_BORROW_INCENTIVE_PROTOCOL_ID,
-} from 'src/constants';
+import { OLD_BORROW_INCENTIVE_PROTOCOL_ID } from 'src/constants';
 
 /**
  * Check and get Obligation information from transaction block.
@@ -89,9 +85,7 @@ const requireObligationInfo = async (
 const generateBorrowIncentiveNormalMethod: GenerateBorrowIncentiveNormalMethod =
   ({ builder, txBlock }) => {
     const borrowIncentiveIds: BorrowIncentiveIds = {
-      borrowIncentivePkg: IS_VE_SCA_TEST
-        ? '0x4d5a7cefa4147b4ace0ca845b20437d6ac0d32e5f2f855171f745472c2576246'
-        : builder.address.get('borrowIncentive.id'),
+      borrowIncentivePkg: builder.address.get('borrowIncentive.id'),
       query: builder.address.get('borrowIncentive.query'),
       config: builder.address.get('borrowIncentive.config'),
       incentivePools: builder.address.get('borrowIncentive.incentivePools'),
@@ -160,7 +154,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}`);
         }
@@ -228,11 +223,7 @@ const generateBorrowIncentiveQuickMethod: GenerateBorrowIncentiveQuickMethod =
               (txn.target ===
                 `${OLD_BORROW_INCENTIVE_PROTOCOL_ID}::user::unstake` ||
                 txn.target ===
-                  (IS_VE_SCA_TEST
-                    ? `${'0x4d5a7cefa4147b4ace0ca845b20437d6ac0d32e5f2f855171f745472c2576246'}::user::unstake`
-                    : `${builder.address.get(
-                        'borrowIncentive.id'
-                      )}::user::unstake`))
+                  `${builder.address.get('borrowIncentive.id')}::user::unstake`)
           );
 
         if (!obligationLocked || unstakeObligationBeforeStake) {
@@ -262,11 +253,7 @@ const generateBorrowIncentiveQuickMethod: GenerateBorrowIncentiveQuickMethod =
               (txn.target ===
                 `${OLD_BORROW_INCENTIVE_PROTOCOL_ID}::user::unstake` ||
                 txn.target ===
-                  (IS_VE_SCA_TEST
-                    ? `${'0x4d5a7cefa4147b4ace0ca845b20437d6ac0d32e5f2f855171f745472c2576246'}::user::unstake`
-                    : `${builder.address.get(
-                        'borrowIncentive.id'
-                      )}::user::unstake`))
+                  `${builder.address.get('borrowIncentive.id')}::user::unstake`)
           );
 
         if (!obligationLocked || unstakeObligationBeforeStake) {
@@ -276,8 +263,12 @@ const generateBorrowIncentiveQuickMethod: GenerateBorrowIncentiveQuickMethod =
               builder.query,
               veSca.keyId
             );
+
             // if bindedObligationId is equal to obligationId, then use it again
-            if (!bindedObligationId || bindedObligationId === obligationArg) {
+            if (
+              (!bindedObligationId || bindedObligationId === obligationArg) &&
+              veSca.currentVeScaBalance > 0
+            ) {
               txBlock.stakeObligationWithVesca(
                 obligationArg,
                 obligationtKeyArg,