@scallop-io/sui-scallop-sdk 0.46.55 → 0.46.56

package/dist/models/scallop.d.ts

@@ -30,7 +30,7 @@ export declare class Scallop {
     params: ScallopParams;
     suiKit: SuiKit;
     cache: ScallopCache;
-    private _address;
+    private address;
     constructor(params: ScallopParams, cacheOptions?: QueryClientConfig, tokenBucket?: TokenBucket);
     /**
      * Get a scallop address instance that already has read addresses.

package/dist/models/scallopAddress.d.ts

@@ -1,5 +1,5 @@
-import type { NetworkType } from '@scallop-io/sui-kit';
-import type { ScallopAddressParams, AddressesInterface, AddressStringPath } from '../types';
+import { type NetworkType } from '@scallop-io/sui-kit';
+import type { ScallopAddressParams, AddressesInterface, AddressStringPath, ScallopAddressInstanceParams } from '../types';
 import { ScallopCache } from './scallopCache';
 /**
  * @description
@@ -19,8 +19,8 @@ export declare class ScallopAddress {
     private _network;
     private _currentAddresses?;
     private _addressesMap;
-    private _cache;
-    constructor(params: ScallopAddressParams, cache?: ScallopCache);
+    cache: ScallopCache;
+    constructor(params: ScallopAddressParams, instance?: ScallopAddressInstanceParams);
     /**
      * Get addresses API id.
      *

package/dist/models/scallopBuilder.d.ts

@@ -5,7 +5,7 @@ import { ScallopUtils } from './scallopUtils';
 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, SupportSCoin } from '../types';
+import type { ScallopBuilderParams, ScallopTxBlock, SupportMarketCoins, SupportAssetCoins, SupportSCoin, ScallopBuilderInstanceParams } from '../types';
 import { ScallopCache } from './scallopCache';
 /**
  * @description
@@ -27,7 +27,7 @@ export declare class ScallopBuilder {
     utils: ScallopUtils;
     walletAddress: string;
     cache: ScallopCache;
-    constructor(params: ScallopBuilderParams, instance?: ScallopInstanceParams);
+    constructor(params: ScallopBuilderParams, instance?: ScallopBuilderInstanceParams);
     /**
      * Request the scallop API to initialize data.
      *

package/dist/models/scallopCache.d.ts

@@ -22,9 +22,9 @@ type QueryInspectTxnParams = {
  */
 export declare class ScallopCache {
     readonly queryClient: QueryClient;
-    readonly _suiKit?: SuiKit;
+    readonly _suiKit: SuiKit;
     private tokenBucket;
-    constructor(cacheOptions?: QueryClientConfig, suiKit?: SuiKit, tokenBucket?: TokenBucket);
+    constructor(suiKit: SuiKit, cacheOptions?: QueryClientConfig, tokenBucket?: TokenBucket);
     private get suiKit();
     private get client();
     /**

package/dist/models/scallopClient.d.ts

@@ -7,7 +7,7 @@ import { ScallopCache } from './scallopCache';
 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 type { ScallopClientFnReturnType, ScallopClientParams, SupportPoolCoins, SupportCollateralCoins, SupportAssetCoins, SupportStakeCoins, SupportStakeMarketCoins, SupportBorrowIncentiveCoins, ScallopTxBlock, ScallopClientVeScaReturnType, ScallopClientInstanceParams } from '../types';
 /**
  * @description
  * It provides contract interaction operations for general users.
@@ -29,7 +29,7 @@ export declare class ScallopClient {
     utils: ScallopUtils;
     cache: ScallopCache;
     walletAddress: string;
-    constructor(params: ScallopClientParams, instance?: ScallopInstanceParams);
+    constructor(params: ScallopClientParams, instance?: ScallopClientInstanceParams);
     /**
      * Request the scallop API to initialize data.
      *
@@ -299,6 +299,11 @@ export declare class ScallopClient {
      * @returns Transaction response
      */
     migrateAllMarketCoin<S extends boolean>(sign?: S): Promise<ScallopClientFnReturnType<S>>;
+    /**
+     * Claim unlocked SCA from all veSCA accounts.
+     */
+    claimAllUnlockedSca(): Promise<SuiTransactionBlockResponse>;
+    claimAllUnlockedSca<S extends boolean>(sign?: S): Promise<ScallopClientVeScaReturnType<S>>;
     /**
      * Mint and get test coin.
      *

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

package/dist/models/scallopQuery.d.ts

@@ -1,5 +1,5 @@
 import { SuiKit } from '@scallop-io/sui-kit';
-import { ScallopQueryParams, ScallopInstanceParams, SupportStakeMarketCoins, SupportAssetCoins, SupportPoolCoins, SupportCollateralCoins, SupportMarketCoins, SupportBorrowIncentiveCoins, SupportSCoin } from '../types';
+import { ScallopQueryParams, SupportStakeMarketCoins, SupportAssetCoins, SupportPoolCoins, SupportCollateralCoins, SupportMarketCoins, SupportBorrowIncentiveCoins, SupportSCoin, ScallopQueryInstanceParams } from '../types';
 import { ScallopAddress } from './scallopAddress';
 import { ScallopUtils } from './scallopUtils';
 import { ScallopIndexer } from './scallopIndexer';
@@ -25,7 +25,7 @@ export declare class ScallopQuery {
     indexer: ScallopIndexer;
     cache: ScallopCache;
     walletAddress: string;
-    constructor(params: ScallopQueryParams, instance?: ScallopInstanceParams);
+    constructor(params: ScallopQueryParams, instance?: ScallopQueryInstanceParams);
     /**
      * Request the scallop API to initialize data.
      *
@@ -383,7 +383,7 @@ export declare class ScallopQuery {
      * @param walletAddress
      * @returns veScaKeyId
      */
-    getVeScaKeyIdFromReferralBindings(walletAddress: string): Promise<string | null>;
+    getVeScaKeyIdFromReferralBindings(walletAddress?: string): Promise<string | null>;
     /**
      * Get binded obligationId from a veScaKey if it exists.
      * @param veScaKey
@@ -415,7 +415,7 @@ export declare class ScallopQuery {
      * @param ownerAddress - The owner address.
      * @return All market sCoin amounts.
      */
-    getSCoinAmounts(sCoinNames?: SupportSCoin[], ownerAddress?: string): Promise<import("../types").OptionalKeys<Record<"seth" | "ssui" | "susdc" | "susdt" | "scetus" | "safsui" | "shasui" | "svsui" | "ssca", number>>>;
+    getSCoinAmounts(sCoinNames?: SupportSCoin[], ownerAddress?: string): Promise<import("../types").OptionalKeys<Record<"seth" | "ssui" | "susdc" | "susdt" | "scetus" | "safsui" | "shasui" | "svsui" | "ssca" | "ssol" | "sbtc", number>>>;
     /**
      * Get sCoin amount.
      *
@@ -424,5 +424,11 @@ export declare class ScallopQuery {
      * @return sCoin amount.
      */
     getSCoinAmount(sCoinName: SupportSCoin | SupportMarketCoins, ownerAddress?: string): Promise<number>;
+    /**
+     * Get swap rate from sCoin A to sCoin B
+     * @param assetCoinNames
+     * @returns
+     */
+    getSCoinSwapRate(fromSCoin: SupportSCoin, toSCoin: SupportSCoin): Promise<number>;
     getFlashLoanFees(assetCoinNames?: SupportAssetCoins[]): Promise<Record<"eth" | "btc" | "usdc" | "usdt" | "sui" | "apt" | "sol" | "cetus" | "afsui" | "hasui" | "vsui" | "sca", number>>;
 }

package/dist/models/scallopUtils.d.ts

@@ -1,5 +1,7 @@
+import { SuiKit } from '@scallop-io/sui-kit';
 import { ScallopAddress } from './scallopAddress';
-import type { ScallopUtilsParams, ScallopInstanceParams, SupportCoins, SupportAssetCoins, SupportMarketCoins, SupportStakeMarketCoins, SupportBorrowIncentiveCoins, CoinWrappedType, SupportSCoin } from '../types';
+import { ScallopCache } from './scallopCache';
+import type { ScallopUtilsParams, SupportCoins, SupportAssetCoins, SupportMarketCoins, SupportStakeMarketCoins, SupportBorrowIncentiveCoins, CoinWrappedType, SupportSCoin, ScallopUtilsInstanceParams } from '../types';
 import type { SuiAddressArg, SuiTxArg, SuiTxBlock } from '@scallop-io/sui-kit';
 /**
  * @description
@@ -16,12 +18,11 @@ import type { SuiAddressArg, SuiTxArg, SuiTxBlock } from '@scallop-io/sui-kit';
 export declare class ScallopUtils {
     readonly params: ScallopUtilsParams;
     readonly isTestnet: boolean;
-    private _suiKit;
-    private _address;
-    private _query;
+    suiKit: SuiKit;
+    address: ScallopAddress;
+    cache: ScallopCache;
     private _priceMap;
-    private _cache;
-    constructor(params: ScallopUtilsParams, instance?: ScallopInstanceParams);
+    constructor(params: ScallopUtilsParams, instance?: ScallopUtilsInstanceParams);
     /**
      * Request the scallop API to initialize data.
      *
@@ -166,7 +167,7 @@ export declare class ScallopUtils {
      * @param obligationId - The obligation id.
      * @return Asset coin Names.
      */
-    getObligationCoinNames(obligationId: SuiAddressArg): Promise<SupportAssetCoins[]>;
+    getObligationCoinNames(obligationId: SuiAddressArg): Promise<SupportAssetCoins[] | undefined>;
     /**
      * Get asset coin price.
      *

package/dist/queries/borrowIncentiveQuery.d.ts

@@ -1,4 +1,4 @@
-import type { ScallopQuery } from '../models';
+import type { ScallopAddress, ScallopQuery, ScallopUtils } from '../models';
 import type { SupportBorrowIncentiveCoins } from '../types';
 /**
  * Query borrow incentive pools data.
@@ -25,7 +25,9 @@ export declare const queryBorrowIncentivePools: (query: ScallopQuery, borrowInce
  * @param borrowIncentiveCoinNames - Specific an array of support borrow incentive coin name.
  * @return Borrow incentive accounts data.
  */
-export declare const queryBorrowIncentiveAccounts: (query: ScallopQuery, obligationId: string, borrowIncentiveCoinNames?: SupportBorrowIncentiveCoins[]) => Promise<{
+export declare const queryBorrowIncentiveAccounts: ({ utils, }: {
+    utils: ScallopUtils;
+}, obligationId: string, borrowIncentiveCoinNames?: SupportBorrowIncentiveCoins[]) => Promise<{
     eth?: import("../types").ParsedBorrowIncentiveAccountData | undefined;
     usdc?: import("../types").ParsedBorrowIncentiveAccountData | undefined;
     usdt?: import("../types").ParsedBorrowIncentiveAccountData | undefined;
@@ -41,5 +43,9 @@ export declare const queryBorrowIncentiveAccounts: (query: ScallopQuery, obligat
  * @param veScaKey
  * @returns
  */
-export declare const getBindedObligationId: (query: ScallopQuery, veScaKeyId: string) => Promise<string | null>;
-export declare const getBindedVeScaKey: (query: ScallopQuery, obliationId: string) => Promise<string | null>;
+export declare const getBindedObligationId: ({ address, }: {
+    address: ScallopAddress;
+}, veScaKeyId: string) => Promise<string | null>;
+export declare const getBindedVeScaKey: ({ address, }: {
+    address: ScallopAddress;
+}, obliationId: string) => Promise<string | null>;

package/dist/queries/coreQuery.d.ts

@@ -1,6 +1,6 @@
 import type { SuiObjectData } from '@mysten/sui.js/client';
 import type { SuiAddressArg } from '@scallop-io/sui-kit';
-import type { ScallopQuery } from '../models';
+import type { ScallopAddress, ScallopCache, ScallopQuery } from '../models';
 import { Market, MarketPool, MarketCollateral, SupportAssetCoins, SupportPoolCoins, SupportCollateralCoins, ObligationQueryInterface, Obligation, SupportMarketCoins, OptionalKeys } from '../types';
 /**
  * Query market data.
@@ -94,7 +94,9 @@ export declare const getMarketCollateral: (query: ScallopQuery, collateralCoinNa
  * @param ownerAddress - The owner address.
  * @return Owned obligations.
  */
-export declare const getObligations: (query: ScallopQuery, ownerAddress?: string) => Promise<Obligation[]>;
+export declare const getObligations: ({ address, }: {
+    address: ScallopAddress;
+}, ownerAddress: string) => Promise<Obligation[]>;
 /**
  * Query obligation locked status.
  *
@@ -102,7 +104,7 @@ export declare const getObligations: (query: ScallopQuery, ownerAddress?: string
  * @param obligationId - The obligation id.
  * @return Obligation locked status.
  */
-export declare const getObligationLocked: (query: ScallopQuery, obligationId: string) => Promise<boolean>;
+export declare const getObligationLocked: (cache: ScallopCache, obligationId: string) => Promise<boolean>;
 /**
  * Query obligation data.
  *
@@ -113,7 +115,9 @@ export declare const getObligationLocked: (query: ScallopQuery, obligationId: st
  * @param obligationId - The obligation id.
  * @return Obligation data.
  */
-export declare const queryObligation: (query: ScallopQuery, obligationId: SuiAddressArg) => Promise<ObligationQueryInterface | undefined>;
+export declare const queryObligation: ({ address, }: {
+    address: ScallopAddress;
+}, obligationId: SuiAddressArg) => Promise<ObligationQueryInterface | undefined>;
 /**
  * Query all owned coin amount.
  *

package/dist/queries/priceQuery.d.ts

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

package/dist/queries/referralQuery.d.ts

@@ -1,7 +1,7 @@
-import { ScallopQuery } from 'src/models';
+import { ScallopAddress } 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>;
+export declare const queryVeScaKeyIdFromReferralBindings: (address: ScallopAddress, refereeAddress: string) => Promise<string | null>;

package/dist/queries/sCoinQuery.d.ts

@@ -1,4 +1,4 @@
-import { ScallopQuery } from 'src/models';
+import { ScallopQuery, ScallopUtils } from 'src/models';
 import { OptionalKeys, SupportSCoin, sCoinBalance } from 'src/types';
 /**
  * Get total supply of sCoin
@@ -6,7 +6,9 @@ import { OptionalKeys, SupportSCoin, sCoinBalance } from 'src/types';
  * @param sCoinName
  * @returns `number`
  */
-export declare const getSCoinTotalSupply: (query: ScallopQuery, sCoinName: SupportSCoin) => Promise<sCoinBalance>;
+export declare const getSCoinTotalSupply: ({ utils, }: {
+    utils: ScallopUtils;
+}, sCoinName: SupportSCoin) => Promise<sCoinBalance>;
 /**
  * Query all owned sCoin amount.
  *
@@ -15,7 +17,9 @@ export declare const getSCoinTotalSupply: (query: ScallopQuery, sCoinName: Suppo
  * @param ownerAddress - The owner address.
  * @return All owned sCoins amount.
  */
-export declare const getSCoinAmounts: (query: ScallopQuery, sCoinNames?: SupportSCoin[], ownerAddress?: string) => Promise<OptionalKeys<Record<"seth" | "ssui" | "susdc" | "susdt" | "scetus" | "safsui" | "shasui" | "svsui" | "ssca", number>>>;
+export declare const getSCoinAmounts: ({ utils, }: {
+    utils: ScallopUtils;
+}, sCoinNames?: SupportSCoin[], ownerAddress?: string) => Promise<OptionalKeys<Record<"seth" | "ssui" | "susdc" | "susdt" | "scetus" | "safsui" | "shasui" | "svsui" | "ssca" | "ssol" | "sbtc", number>>>;
 /**
  * Query owned sCoin amount.
  *
@@ -24,4 +28,14 @@ export declare const getSCoinAmounts: (query: ScallopQuery, sCoinNames?: Support
  * @param ownerAddress - The owner address.
  * @return Owned sCoin amount.
  */
-export declare const getSCoinAmount: (query: ScallopQuery, sCoinName: SupportSCoin, ownerAddress?: string) => Promise<number>;
+export declare const getSCoinAmount: ({ utils, }: {
+    utils: ScallopUtils;
+}, sCoinName: SupportSCoin, ownerAddress?: string) => Promise<number>;
+/**
+ * Get swap rate from sCoin A to sCoin B.
+ * @param fromSCoin
+ * @param toSCoin
+ * @param underlyingCoinPrice - The price of the underlying coin. For example, if fromSCoin is sSUI and toSCoin is sUSDC, then underlyingCoinPrice represents the price of 1 SUI in USDC.
+ * @returns number
+ */
+export declare const getSCoinSwapRate: (query: ScallopQuery, fromSCoin: SupportSCoin, toSCoin: SupportSCoin, underlyingCoinPrice?: number) => Promise<number>;

package/dist/queries/spoolQuery.d.ts

@@ -1,4 +1,4 @@
-import type { ScallopQuery } from '../models';
+import type { ScallopQuery, ScallopUtils } from '../models';
 import type { MarketPool, Spool, StakePool, StakeRewardPool, StakeAccounts, SupportStakeMarketCoins, CoinPrices } from '../types';
 /**
  * Get spools data.
@@ -36,7 +36,9 @@ export declare const getSpool: (query: ScallopQuery, marketCoinName: SupportStak
  * @param ownerAddress - Owner address.
  * @return Stake accounts.
  */
-export declare const getStakeAccounts: (query: ScallopQuery, ownerAddress?: string) => Promise<StakeAccounts>;
+export declare const getStakeAccounts: ({ utils, }: {
+    utils: ScallopUtils;
+}, ownerAddress?: string) => Promise<StakeAccounts>;
 /**
  * Get stake pool data.
  *
@@ -48,7 +50,9 @@ export declare const getStakeAccounts: (query: ScallopQuery, ownerAddress?: stri
  * @param marketCoinName - Specific support stake market coin name.
  * @return Stake pool data.
  */
-export declare const getStakePool: (query: ScallopQuery, marketCoinName: SupportStakeMarketCoins) => Promise<StakePool | undefined>;
+export declare const getStakePool: ({ utils, }: {
+    utils: ScallopUtils;
+}, marketCoinName: SupportStakeMarketCoins) => Promise<StakePool | undefined>;
 /**
  * Get stake reward pool of the owner.
  *
@@ -60,4 +64,6 @@ export declare const getStakePool: (query: ScallopQuery, marketCoinName: Support
  * @param marketCoinName - Specific support stake market coin name.
  * @return Stake reward pool.
  */
-export declare const getStakeRewardPool: (query: ScallopQuery, marketCoinName: SupportStakeMarketCoins) => Promise<StakeRewardPool | undefined>;
+export declare const getStakeRewardPool: ({ utils, }: {
+    utils: ScallopUtils;
+}, marketCoinName: SupportStakeMarketCoins) => Promise<StakeRewardPool | undefined>;

package/dist/queries/vescaQuery.d.ts

@@ -1,6 +1,6 @@
 import { VeScaTreasuryInfo, Vesca } from '../types';
 import { type SuiObjectData } from '@mysten/sui.js/client';
-import type { ScallopQuery } from '../models';
+import type { ScallopUtils } from '../models';
 /**
  * Query all owned veSca key.
  *
@@ -8,7 +8,7 @@ import type { ScallopQuery } from '../models';
  * @param ownerAddress - The owner address.
  * @return Owned veSca key.
  */
-export declare const getVescaKeys: (query: ScallopQuery, ownerAddress?: string) => Promise<SuiObjectData[]>;
+export declare const getVescaKeys: (utils: ScallopUtils, ownerAddress?: string) => Promise<SuiObjectData[]>;
 /**
  * Query all owned veSca.
  *
@@ -16,7 +16,9 @@ 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: ({ utils, }: {
+    utils: ScallopUtils;
+}, ownerAddress?: string) => Promise<Vesca[]>;
 /**
  * Get veSca data.
  *
@@ -25,10 +27,10 @@ export declare const getVeScas: (query: ScallopQuery, ownerAddress?: string) =>
  * @param ownerAddress - The owner address.
  * @returns Vesca data.
  */
-export declare const getVeSca: (query: ScallopQuery, veScaKey?: string | SuiObjectData, ownerAddress?: string) => Promise<Vesca | undefined>;
+export declare const getVeSca: (utils: ScallopUtils, veScaKey?: string | SuiObjectData, ownerAddress?: string) => Promise<Vesca | undefined>;
 /**
  * Get veSCA treasury informations
  * @param query
  * @returns VeScaTreasuryInfo
  */
-export declare const getVeScaTreasuryInfo: (query: ScallopQuery) => Promise<VeScaTreasuryInfo | null>;
+export declare const getVeScaTreasuryInfo: (utils: ScallopUtils) => Promise<VeScaTreasuryInfo | null>;

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

@@ -15,6 +15,7 @@ export type VeScaNormalMethods = {
     redeemSca: (veScaKey: SuiObjectArg) => TransactionResult;
     mintEmptyVeSca: () => TransactionResult;
 };
+export type RedeemScaQuickReturnType<T extends boolean> = T extends true ? void : TransactionResult | undefined;
 export type VeScaQuickMethods = {
     /**
      * Quick methods to automate
@@ -36,7 +37,7 @@ export type VeScaQuickMethods = {
     extendLockPeriodQuick: (lockPeriodInDays: number, veScaKey?: SuiObjectArg, autoCheck?: boolean) => Promise<void>;
     extendLockAmountQuick: (scaAmount: number, veScaKey?: SuiObjectArg, autoCheck?: boolean) => Promise<void>;
     renewExpiredVeScaQuick: (scaAmount: number, lockPeriodInDays: number, veScaKey?: SuiObjectArg, autoCheck?: boolean) => Promise<void>;
-    redeemScaQuick: (veScaKey?: SuiObjectArg) => Promise<void>;
+    redeemScaQuick: <T extends boolean>(veSCaKey?: SuiObjectArg, transferSca?: T) => Promise<RedeemScaQuickReturnType<T>>;
 };
 export type SuiTxBlockWithVeScaNormalMethods = SuiKitTxBlock & VeScaNormalMethods;
 export type VeScaTxBlock = SuiTxBlockWithVeScaNormalMethods & VeScaQuickMethods;

package/dist/types/model.d.ts

@@ -1,16 +1,35 @@
 import type { SuiTransactionBlockResponse } from '@mysten/sui.js/client';
-import type { TransactionBlock } from '@mysten/sui.js/transactions';
+import type { TransactionBlock, TransactionResult } from '@mysten/sui.js/transactions';
 import type { SuiKit, SuiKitParams, NetworkType } from '@scallop-io/sui-kit';
-import type { ScallopAddress, ScallopQuery, ScallopUtils, ScallopBuilder } from '../models';
+import type { ScallopAddress, ScallopQuery, ScallopUtils, ScallopBuilder, ScallopIndexer } from '../models';
 import { ScallopCache } from 'src/models/scallopCache';
 export type ScallopClientFnReturnType<T extends boolean> = T extends true ? SuiTransactionBlockResponse : TransactionBlock;
-export type ScallopInstanceParams = {
+export type ScallopClientVeScaReturnType<T extends boolean> = T extends true ? SuiTransactionBlockResponse : {
+    tx: TransactionBlock;
+    scaCoin: TransactionResult;
+};
+export type ScallopBaseInstanceParams = {
     suiKit?: SuiKit;
+};
+export type ScallopCacheInstanceParams = ScallopBaseInstanceParams;
+export type ScallopAddressInstanceParams = ScallopBaseInstanceParams & {
+    cache?: ScallopCache;
+};
+export type ScallopIndexerInstanceParams = {
+    cache?: ScallopCache;
+};
+export type ScallopUtilsInstanceParams = ScallopBaseInstanceParams & {
     address?: ScallopAddress;
-    query?: ScallopQuery;
+};
+export type ScallopQueryInstanceParams = ScallopBaseInstanceParams & {
     utils?: ScallopUtils;
+    indexer?: ScallopIndexer;
+};
+export type ScallopBuilderInstanceParams = ScallopBaseInstanceParams & {
+    query?: ScallopQuery;
+};
+export type ScallopClientInstanceParams = ScallopBaseInstanceParams & {
     builder?: ScallopBuilder;
-    cache: ScallopCache;
 };
 export type ScallopAddressParams = {
     id: string;
@@ -19,17 +38,13 @@ export type ScallopAddressParams = {
 };
 export type ScallopParams = {
     addressesId?: string;
-} & SuiKitParams;
-export type ScallopClientParams = ScallopParams & {
     walletAddress?: string;
-};
+} & SuiKitParams;
+export type ScallopClientParams = ScallopParams;
 export type ScallopBuilderParams = ScallopParams & {
-    walletAddress?: string;
     pythEndpoints?: string[];
 };
-export type ScallopQueryParams = ScallopParams & {
-    walletAddress?: string;
-};
+export type ScallopQueryParams = ScallopParams;
 export type ScallopUtilsParams = ScallopParams & {
     pythEndpoints?: string[];
 };

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

@@ -118,6 +118,7 @@ export type MarketPool = {
     symbol: string;
     coinType: string;
     marketCoinType: string;
+    sCoinType: string;
     coinWrappedType: CoinWrappedType;
     coinDecimal: number;
     coinPrice: number;

package/package.json

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

package/src/builders/borrowIncentiveBuilder.ts

@@ -51,13 +51,13 @@ const requireObligationInfo = async (
     typeof obligationId === 'string'
   ) {
     const obligationLocked = await getObligationLocked(
-      builder.query,
+      builder.cache,
       obligationId
     );
     return { obligationId, obligationKey, obligationLocked };
   }
   const sender = requireSender(txBlock);
-  const obligations = await getObligations(builder.query, sender);
+  const obligations = await getObligations(builder, sender);
   if (obligations.length === 0) {
     throw new Error(`No obligation found for sender ${sender}`);
   }
@@ -207,7 +207,7 @@ const generateBorrowIncentiveQuickMethod: GenerateBorrowIncentiveQuickMethod =
       stakeObligationQuick: async (obligation, obligationKey) => {
         const {
           obligationId: obligationArg,
-          obligationKey: obligationtKeyArg,
+          obligationKey: obligationKeyArg,
           obligationLocked: obligationLocked,
         } = await requireObligationInfo(
           builder,
@@ -227,7 +227,7 @@ const generateBorrowIncentiveQuickMethod: GenerateBorrowIncentiveQuickMethod =
           );
 
         if (!obligationLocked || unstakeObligationBeforeStake) {
-          txBlock.stakeObligation(obligationArg, obligationtKeyArg);
+          txBlock.stakeObligation(obligationArg, obligationKeyArg);
         }
       },
       stakeObligationWithVeScaQuick: async (
@@ -237,7 +237,7 @@ const generateBorrowIncentiveQuickMethod: GenerateBorrowIncentiveQuickMethod =
       ) => {
         const {
           obligationId: obligationArg,
-          obligationKey: obligationtKeyArg,
+          obligationKey: obligationKeyArg,
           obligationLocked: obligationLocked,
         } = await requireObligationInfo(
           builder,
@@ -260,7 +260,7 @@ const generateBorrowIncentiveQuickMethod: GenerateBorrowIncentiveQuickMethod =
           const veSca = await requireVeSca(builder, txBlock, veScaKey);
           if (veSca) {
             const bindedObligationId = await getBindedObligationId(
-              builder.query,
+              builder,
               veSca.keyId
             );
 
@@ -271,21 +271,21 @@ const generateBorrowIncentiveQuickMethod: GenerateBorrowIncentiveQuickMethod =
             ) {
               txBlock.stakeObligationWithVesca(
                 obligationArg,
-                obligationtKeyArg,
+                obligationKeyArg,
                 veSca.keyId
               );
             } else {
-              txBlock.stakeObligation(obligationArg, obligationtKeyArg);
+              txBlock.stakeObligation(obligationArg, obligationKeyArg);
             }
           } else {
-            txBlock.stakeObligation(obligationArg, obligationtKeyArg);
+            txBlock.stakeObligation(obligationArg, obligationKeyArg);
           }
         }
       },
       unstakeObligationQuick: async (obligation, obligationKey) => {
         const {
           obligationId: obligationArg,
-          obligationKey: obligationtKeyArg,
+          obligationKey: obligationKeyArg,
           obligationLocked: obligationLocked,
         } = await requireObligationInfo(
           builder,
@@ -295,7 +295,7 @@ const generateBorrowIncentiveQuickMethod: GenerateBorrowIncentiveQuickMethod =
         );
 
         if (obligationLocked) {
-          txBlock.unstakeObligation(obligationArg, obligationtKeyArg);
+          txBlock.unstakeObligation(obligationArg, obligationKeyArg);
         }
       },
       claimBorrowIncentiveQuick: async (
@@ -304,19 +304,17 @@ const generateBorrowIncentiveQuickMethod: GenerateBorrowIncentiveQuickMethod =
         obligation,
         obligationKey
       ) => {
-        const {
-          obligationId: obligationArg,
-          obligationKey: obligationtKeyArg,
-        } = await requireObligationInfo(
-          builder,
-          txBlock,
-          obligation,
-          obligationKey
-        );
+        const { obligationId: obligationArg, obligationKey: obligationKeyArg } =
+          await requireObligationInfo(
+            builder,
+            txBlock,
+            obligation,
+            obligationKey
+          );
 
         return txBlock.claimBorrowIncentive(
           obligationArg,
-          obligationtKeyArg,
+          obligationKeyArg,
           coinName,
           rewardCoinName
         );