@scallop-io/sui-scallop-sdk 1.5.0-alpha.1 → 1.5.0

package/dist/index.d.mts

@@ -0,0 +1,3159 @@
+import { DevInspectResults, SuiObjectDataOptions, SuiObjectResponse, SuiObjectData, GetOwnedObjectsParams, GetDynamicFieldsParams, DynamicFieldPage, GetDynamicFieldObjectParams, CoinBalance, GetBalanceParams, SuiObjectRef, SuiTransactionBlockResponse } from '@mysten/sui/client';
+import * as _scallop_io_sui_kit from '@scallop-io/sui-kit';
+import { SuiKit, SuiObjectArg, NetworkType, SuiTxBlock, SuiTxArg, SuiVecTxArg, SuiAmountsArg, SuiAddressArg, TransactionResult as TransactionResult$1, SuiKitParams } from '@scallop-io/sui-kit';
+import * as _mysten_sui_dist_cjs_client from '@mysten/sui/dist/cjs/client';
+import { QueryClient, QueryClientConfig } from '@tanstack/query-core';
+import { Transaction, TransactionObjectArgument, Argument, TransactionResult } from '@mysten/sui/transactions';
+
+/**
+ * Default cache options for the QueryClient.
+ * @type {QueryClientConfig}
+ * @description Default cache options for the QueryClient
+ * We set the default to 5s to prevent duplicate requests from being requested (e.g. query MarketObject, etc.)
+ */
+declare const DEFAULT_CACHE_OPTIONS: {
+    defaultOptions: {
+        queries: {
+            staleTime: number;
+            gcTime: number;
+        };
+    };
+};
+
+type ParseMarketCoins<T extends string> = `s${T}`;
+type ParseCoins<T extends string> = T extends `s${infer R}` ? R : never;
+type SupportCoins = SupportAssetCoins | SupportMarketCoins | SupportStakeMarketCoins | SupportSCoin;
+type SupportAssetCoins = SupportPoolCoins | SupportCollateralCoins | SupportStakeRewardCoins;
+type SupportPoolCoins = (typeof SUPPORT_POOLS)[number];
+type SupportCollateralCoins = (typeof SUPPORT_COLLATERALS)[number];
+type SupportMarketCoins = ParseMarketCoins<SupportPoolCoins> | SupportStakeMarketCoins;
+type SupportStakeMarketCoins = (typeof SUPPORT_SPOOLS)[number];
+type SupportSuiBridgeCoins = (typeof SUPPORT_SUI_BRIDGE)[number];
+type SupportWormholeCoins = (typeof SUPPORT_WORMHOLE)[number];
+type SupportStakeCoins = Extract<SupportPoolCoins, ParseCoins<SupportStakeMarketCoins>>;
+type SupportStakeRewardCoins = (typeof SUPPORT_SPOOLS_REWARDS)[number];
+type SupportBorrowIncentiveCoins = (typeof SUPPORT_BORROW_INCENTIVE_POOLS)[number];
+type SupportBorrowIncentiveRewardCoins = (typeof SUPPORT_BORROW_INCENTIVE_REWARDS)[number];
+type SupportSCoin = (typeof SUPPORT_SCOIN)[number];
+type SupportOracleType = (typeof SUPPORT_ORACLES)[number];
+type SupportPackageType = (typeof SUPPORT_PACKAGES)[number];
+type SupportCoinDecimals = Record<SupportCoins, number>;
+type CoinWrappedType = {
+    from: string;
+    type: string;
+} | undefined;
+
+declare const COIN_GECKGO_IDS: Record<SupportPoolCoins, string>;
+
+declare const API_BASE_URL: "https://sui.apis.scallop.io";
+declare const SDK_API_BASE_URL: "https://sdk.api.scallop.io";
+declare const IS_VE_SCA_TEST: boolean;
+declare const USE_TEST_ADDRESS: boolean;
+declare const ADDRESSES_ID: "65fb07c39c845425d71d7b18" | "675c65cd301dd817ea262e76";
+declare const PROTOCOL_OBJECT_ID: "0xc9f859f98ca352a11b97a038c4b4162bee437b8df8caa047990fe9cb03d4f778" | "0xefe8b36d5b2e43728cc323298626b83177803521d195cfb11e15b910e892fddf";
+declare const BORROW_FEE_PROTOCOL_ID: "0xc9f859f98ca352a11b97a038c4b4162bee437b8df8caa047990fe9cb03d4f778" | "0xc38f849e81cfe46d4e4320f508ea7dda42934a329d5a6571bb4c3cb6ea63f5da";
+declare const SCA_COIN_TYPE: "0x6cd813061a3adf3602b76545f076205f0c8e7ec1d3b1eab9a1da7992c18c0524::sca::SCA" | "0x7016aae72cfc67f2fadf55769c0a7dd54291a583b63051a5ed71081cce836ac6::sca::SCA";
+declare const OLD_BORROW_INCENTIVE_PROTOCOL_ID: "0xc63072e7f5f4983a2efaf5bdba1480d5e7d74d57948e1c7cc436f8e22cbeb410";
+declare const SUPPORT_POOLS: readonly ["usdc", "sbeth", "sbusdt", "sbwbtc", "weth", "wbtc", "wusdc", "wusdt", "sui", "wapt", "wsol", "cetus", "afsui", "hasui", "vsui", "sca", "fud", "deep", "fdusd", "blub", "musd", "ns", "usdy"];
+declare const SUPPORT_COLLATERALS: readonly ["usdc", "sbeth", "sbusdt", "sbwbtc", "weth", "wbtc", "wusdc", "wusdt", "sui", "wapt", "wsol", "cetus", "afsui", "hasui", "vsui", "sca", "fdusd", "usdy"];
+declare const SUPPORT_SPOOLS: readonly ["susdc", "sweth", "ssui", "swusdc", "swusdt", "scetus", "safsui", "shasui", "svsui"];
+declare const SUPPORT_SCOIN: readonly ["susdc", "ssbeth", "ssbusdt", "ssbwbtc", "ssui", "swusdc", "swusdt", "safsui", "shasui", "svsui", "sweth", "ssca", "scetus", "swsol", "swbtc", "sdeep", "sfud", "sfdusd", "sblub", "smusd", "sns", "susdy"];
+declare const SUPPORT_SUI_BRIDGE: readonly ["sbeth", "sbusdt", "sbwbtc"];
+declare const SUPPORT_WORMHOLE: readonly ["wusdc", "wusdt", "weth", "wbtc", "wapt", "wsol"];
+declare const SUPPORT_SPOOLS_REWARDS: readonly ["sui"];
+declare const SUPPORT_BORROW_INCENTIVE_POOLS: readonly ["usdc", "sbeth", "sbusdt", "sbwbtc", "weth", "wbtc", "wusdc", "wusdt", "sui", "wapt", "wsol", "cetus", "afsui", "hasui", "vsui", "sca", "fud", "deep", "fdusd", "blub", "musd", "ns", "usdy"];
+declare const SUPPORT_BORROW_INCENTIVE_REWARDS: readonly ["usdc", "sbeth", "sbusdt", "sbwbtc", "weth", "wbtc", "wusdc", "wusdt", "sui", "wapt", "wsol", "cetus", "afsui", "hasui", "vsui", "sca", "fud", "deep", "fdusd", "blub", "musd", "ns", "usdy", "susdc", "ssbeth", "ssbusdt", "ssbwbtc", "ssui", "swusdc", "swusdt", "safsui", "shasui", "svsui", "sweth", "ssca", "scetus", "swsol", "swbtc", "sdeep", "sfud", "sfdusd", "sblub", "smusd", "sns", "susdy"];
+declare const SUPPORT_ORACLES: readonly ["supra", "switchboard", "pyth"];
+declare const SUPPORT_PACKAGES: readonly ["coinDecimalsRegistry", "math", "whitelist", "x", "protocol", "protocolWhitelist", "query", "supra", "pyth", "switchboard", "xOracle", "testCoin"];
+
+type QueryInspectTxnParams = {
+    queryTarget: string;
+    args: SuiObjectArg[];
+    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>();
+ * ```
+ */
+declare class ScallopCache {
+    readonly params: ScallopCacheParams;
+    queryClient: QueryClient;
+    suiKit: SuiKit;
+    walletAddress: string;
+    private tokensPerInterval;
+    private interval;
+    private tokens;
+    private lastRefill;
+    constructor(params?: ScallopCacheParams, instance?: ScallopCacheInstanceParams);
+    private get client();
+    private refill;
+    private removeTokens;
+    private callWithRateLimit;
+    /**
+     * @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.
+     */
+    private retryFn;
+    /**
+     * @description Provides cache for inspectTxn of the SuiKit.
+     * @param QueryInspectTxnParams
+     * @param txBlock
+     * @returns Promise<DevInspectResults>
+     */
+    queryInspectTxn({ queryTarget, args, typeArgs, }: QueryInspectTxnParams): Promise<DevInspectResults | null>;
+    queryGetNormalizedMoveFunction(target: string): Promise<_mysten_sui_dist_cjs_client.SuiMoveNormalizedFunction | null>;
+    /**
+     * @description Provides cache for getObject of the SuiKit.
+     * @param objectId
+     * @param QueryObjectParams
+     * @returns Promise<SuiObjectResponse>
+     */
+    queryGetObject(objectId: string, options?: SuiObjectDataOptions): Promise<SuiObjectResponse | null>;
+    /**
+     * @description Provides cache for getObjects of the SuiKit.
+     * @param objectIds
+     * @returns Promise<SuiObjectData[]>
+     */
+    queryGetObjects(objectIds: string[]): Promise<SuiObjectData[]>;
+    /**
+     * @description Provides cache for getOwnedObjects of the SuiKit.
+     * @param input
+     * @returns Promise<PaginatedObjectsResponse>
+     */
+    queryGetOwnedObjects(input: GetOwnedObjectsParams): Promise<_mysten_sui_dist_cjs_client.PaginatedObjectsResponse | null>;
+    queryGetDynamicFields(input: GetDynamicFieldsParams): Promise<DynamicFieldPage | null>;
+    queryGetDynamicFieldObject(input: GetDynamicFieldObjectParams): Promise<SuiObjectResponse | null>;
+    queryGetAllCoinBalances(owner: string): Promise<{
+        [k: string]: CoinBalance;
+    }>;
+    queryGetCoinBalance(input: GetBalanceParams): Promise<CoinBalance | null>;
+}
+
+/**
+ * @description
+ * It provides methods for managing addresses.
+ *
+ * @example
+ * ```typescript
+ * const scallopAddress = new ScallopAddress(<parameters>);
+ * scallopAddress.<address functions>();
+ * await scallopAddress.<address async functions>();
+ * ```
+ */
+declare class ScallopAddress {
+    private readonly _auth?;
+    private readonly _requestClient;
+    private _id?;
+    private _network;
+    private _currentAddresses?;
+    private _addressesMap;
+    cache: ScallopCache;
+    constructor(params: ScallopAddressParams, instance?: ScallopAddressInstanceParams);
+    /**
+     * Get addresses API id.
+     *
+     * @return The addresses API id.
+     */
+    getId(): string | undefined;
+    /**
+     * Get the address at the provided path.
+     *
+     * @param path - The path of the address to get.
+     * @return The address at the provided path.
+     */
+    get(path: AddressStringPath): any;
+    /**
+     * Sets the address for the specified path, it does not interact with the API.
+     *
+     * @param path - The path of the address to set.
+     * @param address - The address be setted to the tartget path.
+     * @return The addresses.
+     */
+    set(path: AddressStringPath, address: string): AddressesInterface | undefined;
+    /**
+     * Synchronize the specified network addresses from the addresses map to the
+     * current addresses and change the default network to specified network.
+     *
+     * @param network - Specifies which network's addresses you want to get.
+     * @return Current addresses.
+     */
+    switchCurrentAddresses(network: NetworkType): AddressesInterface | undefined;
+    /**
+     * Get the addresses, If `network` is not provided, returns the current
+     * addresses or the default network addresses in the addresses map.
+     *
+     * @param network - Specifies which network's addresses you want to get.
+     */
+    getAddresses(network?: NetworkType): AddressesInterface | undefined;
+    /**
+     * Set the addresses into addresses map. If the specified network is the same
+     * as the current network, the current addresses will be updated at the same time.
+     *
+     * @param addresses - The addresses be setted to the tartget network.
+     * @param network - Specifies which network's addresses you want to set.
+     * @return The addresses.
+     */
+    setAddresses(addresses: AddressesInterface, network?: NetworkType): void;
+    /**
+     * Get all addresses.
+     *
+     * @return All addresses.
+     */
+    getAllAddresses(): {
+        [k: string]: AddressesInterface;
+    };
+    /**
+     * Create a new addresses through the API and synchronize it back to the
+     * instance.
+     *
+     * @description
+     * If the `network` is not specified, the mainnet is used by default.
+     * If no `addresses` from instance or parameter is provided, an addresses with
+     * all empty strings is created by default.
+     *
+     * This function only allows for one addresses to be input into a specific network
+     * at a time, and does not provide an addresses map for setting addresses
+     * across all networks at once.
+     *
+     * @param params.addresses - The addresses be setted to the tartget network.
+     * @param params.network - Specifies which network's addresses you want to set.
+     * @param params.auth - The authentication API key.
+     * @param params.memo - Add memo to the addresses created in the API.
+     * @return All addresses.
+     */
+    create(params?: {
+        addresses?: AddressesInterface | undefined;
+        network?: NetworkType | undefined;
+        auth?: string | undefined;
+        memo?: string | undefined;
+    }): Promise<{
+        [k: string]: AddressesInterface;
+    }>;
+    /**
+     * Read and synchronizes all addresses from the API into instance.
+     *
+     * @param id - The id of the addresses to get.
+     * @return All addresses.
+     */
+    read(id?: string): Promise<{
+        [k: string]: AddressesInterface;
+    }>;
+    /**
+     * Update the addresses through the API and synchronize it back to the
+     * instance.
+     *
+     * @description
+     * If the `network` is not specified, the mainnet is used by default.
+     * If no `addresses` from instance or parameter is provided, an addresses with
+     * all empty strings is created by default.
+     *
+     * This function only allows for one addresses to be input into a specific network
+     * at a time, and does not provide an addresses map for setting addresses
+     * across all networks at once.
+     *
+     * @param params.id - The id of the addresses to update.
+     * @param params.addresses - The addresses be setted to the tartget network.
+     * @param params.network - Specifies which network's addresses you want to set.
+     * @param params.auth - The authentication api key.
+     * @param params.memo - Add memo to the addresses created in the API.
+     * @return All addresses.
+     */
+    update(params?: {
+        id?: string;
+        addresses?: AddressesInterface | undefined;
+        network?: NetworkType | undefined;
+        auth?: string | undefined;
+        memo?: string | undefined;
+    }): Promise<{
+        [k: string]: AddressesInterface;
+    }>;
+    /**
+     * Deletes all addresses of a specified id through the API and clear all
+     * addresses in the instance.
+     *
+     * @param id - The id of the addresses to delete.
+     * @param auth - The authentication API key.
+     */
+    delete(id?: string, auth?: string): Promise<void>;
+}
+
+/**
+ * @description
+ * Integrates some helper functions frequently used in interactions with the Scallop contract.
+ *
+ * @example
+ * ```typescript
+ * const scallopUtils  = new ScallopUtils(<parameters>);
+ * await scallopUtils.init();
+ * scallopUtils.<utils functions>();
+ * await scallopUtils.<utils functions>();
+ * ```
+ */
+declare class ScallopUtils {
+    readonly params: ScallopUtilsParams;
+    readonly isTestnet: boolean;
+    suiKit: SuiKit;
+    address: ScallopAddress;
+    cache: ScallopCache;
+    walletAddress: string;
+    constructor(params: ScallopUtilsParams, instance?: ScallopUtilsInstanceParams);
+    isSuiBridgeAsset(coinName: any): coinName is SupportSuiBridgeCoins;
+    isWormholeAsset(coinName: any): coinName is SupportWormholeCoins;
+    /**
+     * Request the scallop API to initialize data.
+     *
+     * @param force - Whether to force initialization.
+     * @param address - ScallopAddress instance.
+     */
+    init(force?: boolean, address?: ScallopAddress): Promise<void>;
+    /**
+     * Convert coin name to symbol.
+     *
+     * @param coinName - Specific support coin name.
+     * @return Symbol string.
+     */
+    parseSymbol(coinName: SupportCoins): string;
+    /**
+     * Convert coin name to coin type.
+     *
+     * @description
+     * The Coin type of wormhole is fixed `coin:Coin`. Here using package id
+     * to determine and return the type.
+     *
+     * @param coinPackageId - Package id of coin.
+     * @param coinName - Specific support coin name.
+     * @return Coin type.
+     */
+    parseCoinType(coinName: SupportCoins, useOldMarketCoin?: boolean): string;
+    /**
+     * Convert coin name to sCoin name.
+     *
+     * @param coinName - Specific support coin name.
+     * @return sCoin name.
+     */
+    parseSCoinName<T extends SupportSCoin>(coinName: SupportCoins | SupportMarketCoins): T | undefined;
+    /**
+     * Convert sCoin name to market coin name.
+     * This function will parse new sCoin name `scallop_...` to its old market coin name which is shorter
+     * e.g: `scallop_sui -> ssui
+     * if no `scallop_...` is encountered, return coinName
+     * @return sCoin name
+     */
+    parseSCoinTypeNameToMarketCoinName(coinName: string): "susdc" | "ssbeth" | "ssbusdt" | "ssbwbtc" | "sweth" | "swbtc" | "swusdc" | "swusdt" | "ssui" | "swsol" | "scetus" | "safsui" | "shasui" | "svsui" | "ssca" | "sfud" | "sdeep" | "sfdusd" | "sblub" | "smusd" | "sns" | "susdy";
+    /**
+     * Convert sCoin name into sCoin type
+     * @param sCoinName
+     * @returns sCoin type
+     */
+    parseSCoinType(sCoinName: SupportSCoin): string;
+    /**
+     * Convert sCoinType into sCoin name
+     * @param sCoinType
+     * @returns sCoin name
+     */
+    parseSCoinNameFromType(sCoinType: string): "susdc" | "ssbeth" | "ssbusdt" | "ssbwbtc" | "sweth" | "swbtc" | "swusdc" | "swusdt" | "ssui" | "swsol" | "scetus" | "safsui" | "shasui" | "svsui" | "ssca" | "sfud" | "sdeep" | "sfdusd" | "sblub" | "smusd" | "sns" | "susdy";
+    /**
+     * Convert sCoin name into its underlying coin type
+     * @param sCoinName
+     * @returns coin type
+     */
+    parseUnderlyingSCoinType(sCoinName: SupportSCoin): string;
+    /**
+     * Get sCoin treasury id from sCoin name
+     * @param sCoinName
+     * @returns sCoin treasury id
+     */
+    getSCoinTreasury(sCoinName: SupportSCoin): any;
+    /**
+     * Convert coin name to market coin type.
+     *
+     * @param coinPackageId - Package id of coin.
+     * @param coinName - Specific support coin name.
+     * @return Market coin type.
+     */
+    parseMarketCoinType(coinName: SupportCoins): string;
+    /**
+     * Convert coin type to coin name.
+     *
+     * @description
+     * The coin name cannot be obtained directly from the wormhole type. Here
+     * the package id is used to determine and return a specific name.
+     *
+     * @param coinType - Specific support coin type.
+     * @return Coin Name.
+     */
+    parseCoinNameFromType<T extends SupportAssetCoins>(coinType: string): T extends SupportAssetCoins ? T : SupportAssetCoins;
+    parseCoinNameFromType<T extends SupportMarketCoins>(coinType: string): T extends SupportMarketCoins ? T : SupportMarketCoins;
+    parseCoinNameFromType<T extends SupportCoins>(coinType: string): T extends SupportCoins ? T : SupportCoins;
+    parseCoinNameFromType<T extends SupportSCoin>(coinType: string): T extends SupportSCoin ? T : SupportSCoin;
+    /**
+     * Convert market coin name to coin name.
+     *
+     * @param marketCoinName - Specific support market coin name.
+     * @return Coin Name.
+     */
+    parseCoinName<T extends SupportAssetCoins>(marketCoinName: string): T;
+    /**
+     * Convert coin name to market coin name.
+     *
+     * @param coinName - Specific support coin name.
+     * @return Market coin name.
+     */
+    parseMarketCoinName<T extends SupportMarketCoins>(coinName: SupportCoins): T;
+    /**
+     * Get reward type of spool.
+     *
+     * @param stakeMarketCoinName - Support stake market coin.
+     * @return Spool reward coin name.
+     */
+    getSpoolRewardCoinName: (stakeMarketCoinName: SupportStakeMarketCoins) => "sui";
+    /**
+     * Get coin decimal.
+     *
+     * return Coin decimal.
+     */
+    getCoinDecimal(coinName: SupportCoins): number;
+    /**
+     * Get coin wrapped type.
+     *
+     * return Coin wrapped type.
+     */
+    getCoinWrappedType(assetCoinName: SupportAssetCoins): CoinWrappedType;
+    /**
+     * Select coin id  that add up to the given amount as transaction arguments.
+     *
+     * @param ownerAddress - The address of the owner.
+     * @param amount - The amount that including coin decimals.
+     * @param coinType - The coin type, default is 0x2::SUI::SUI.
+     * @return The selected transaction coin arguments.
+     */
+    selectCoins(amount: number, coinType?: string, ownerAddress?: string): Promise<{
+        objectId: string;
+        digest: string;
+        version: string;
+        balance: string;
+    }[]>;
+    /**
+     * Merge coins with type `coinType` to dest
+     * @param txBlock
+     * @param dest
+     * @param coinType
+     * @param sender
+     */
+    mergeSimilarCoins(txBlock: SuiTxBlock, dest: SuiObjectArg, coinType: string, sender?: string): Promise<void>;
+    /**
+     * Get all asset coin names in the obligation record by obligation id.
+     *
+     * @description
+     * This can often be used to determine which assets in an obligation require
+     * price updates before interacting with specific instructions of the Scallop contract.
+     *
+     * @param obligationId - The obligation id.
+     * @return Asset coin Names.
+     */
+    getObligationCoinNames(obligationId: SuiObjectArg): Promise<SupportAssetCoins[] | undefined>;
+    /**
+     * Get asset coin price.
+     *
+     * @description
+     * The strategy for obtaining the price is to get it through API first,
+     * and then on-chain data if API cannot be retrieved.
+     * Currently, we only support obtaining from pyth protocol, other
+     * oracles will be supported in the future.
+     *
+     * @param assetCoinNames - Specific an array of support asset coin name.
+     * @return  Asset coin price.
+     */
+    getCoinPrices(_?: SupportAssetCoins[]): Promise<OptionalKeys<Record<SupportCoins, number>>>;
+    /**
+     * Convert apr to apy.
+     *
+     * @param apr The annual percentage rate (APR).
+     * @param compoundFrequency How often interest is compounded per year. Default is daily (365 times a year).
+     * @return The equivalent annual percentage yield (APY) for the given APR and compounding frequency.
+     */
+    parseAprToApy(apr: number, compoundFrequency?: number): number;
+    /**
+     * Convert apy to apr.
+     *
+     * @param apr The equivalent annual percentage yield (APY).
+     * @param compoundFrequency How often interest is compounded per year. Default is daily (365 times a year).
+     * @return The equivalent annual percentage rate (APR) for the given APY and compounding frequency.
+     */
+    parseApyToApr(apy: number, compoundFrequency?: number): number;
+    /**
+     * Give extend lock period to get unlock at in seconds timestamp.
+     *
+     * @description
+     * - When the user without remaining unlock period, If the extended unlock day is not specified,
+     *   the unlock period will be increased by one day by default.
+     * - When the given extended day plus the user's remaining unlock period exceeds the maximum
+     *    unlock period, the maximum unlock period is used as unlock period.
+     *
+     * @param extendLockPeriodInDay The extend lock period in day.
+     * @param unlockAtInSecondTimestamp The unlock timestamp from veSca object.
+     * @return New unlock at in seconds timestamp.
+     */
+    getUnlockAt(extendLockPeriodInDay?: number, unlockAtInMillisTimestamp?: number): number;
+    /**
+     * Get detailed contract address and price id information for supported pool in Scallop
+     * @returns Supported pool informations
+     */
+    getSupportedPoolAddresses(): PoolAddressInfo[];
+}
+
+/**
+ * @description
+ * It provides methods to obtain sdk index data from mainnet.
+ *
+ *
+ * @example
+ * ```typescript
+ * const scallopIndexer = new scallopIndexer(<parameters>);
+ * scallopIndexer.<indexer functions>();
+ * await scallopIndexer.<indexer async functions>();
+ * ```
+ */
+declare class ScallopIndexer {
+    private readonly cache;
+    readonly params: ScallopQueryParams;
+    private readonly _requestClient;
+    constructor(params?: ScallopParams, instance?: ScallopIndexerInstanceParams);
+    /**
+     * Get market index data.
+     *
+     * @return Market data.
+     */
+    getMarket(): Promise<Pick<Market, 'pools' | 'collaterals'>>;
+    /**
+     * Get market pools index data.
+     *
+     * @return Market pools data.
+     */
+    getMarketPools(): Promise<Required<MarketPools>>;
+    /**
+     * Get market pool index data.
+     *
+     * @return Market pool data.
+     */
+    getMarketPool(poolCoinName: SupportPoolCoins): Promise<MarketPool>;
+    /**
+     * Get market collaterals index data.
+     *
+     * @return Market collaterals data.
+     */
+    getMarketCollaterals(): Promise<Required<MarketCollaterals>>;
+    /**
+     * Get market collateral index data.
+     *
+     * @return Market collateral data.
+     */
+    getMarketCollateral(collateralCoinName: SupportCollateralCoins): Promise<MarketCollateral>;
+    /**
+     * Get spools index data.
+     *
+     * @return Spools data.
+     */
+    getSpools(): Promise<Required<Spools>>;
+    /**
+     * Get spool index data.
+     *
+     * @return Spool data.
+     */
+    getSpool(marketCoinName: SupportStakeMarketCoins): Promise<Spool>;
+    /**
+     * Get borrow incentive pools index data.
+     *
+     * @return Borrow incentive pools data.
+     */
+    getBorrowIncentivePools(): Promise<Required<BorrowIncentivePools>>;
+    /**
+     * Get borrow incentive pool index data.
+     *
+     * @return Borrow incentive pool data.
+     */
+    getBorrowIncentivePool(borrowIncentiveCoinName: SupportBorrowIncentiveCoins): Promise<BorrowIncentivePool>;
+    /**
+     * Get total value locked index data.
+     *
+     * @return Total value locked.
+     */
+    getTotalValueLocked(): Promise<TotalValueLocked & {
+        totalValueChangeRatio: number;
+        borrowValueChangeRatio: number;
+        supplyValueChangeRatio: number;
+    }>;
+    /**
+     * Get coin price index data.
+     *
+     * @return price data.
+     */
+    getCoinPrice(poolCoinName: SupportPoolCoins): Promise<number>;
+    getCoinPrices(): Promise<Record<string, number>>;
+}
+
+/**
+ * @description
+ * It provides methods for getting on-chain data from the Scallop contract.
+ *
+ * @example
+ * ```typescript
+ * const scallopQuery  = new ScallopQuery(<parameters>);
+ * await scallopQuery.init();
+ * scallopQuery.<query functions>();
+ * await scallopQuery.<query functions>();
+ * ```
+ */
+declare class ScallopQuery {
+    readonly params: ScallopQueryParams;
+    suiKit: SuiKit;
+    address: ScallopAddress;
+    utils: ScallopUtils;
+    indexer: ScallopIndexer;
+    cache: ScallopCache;
+    walletAddress: string;
+    constructor(params?: ScallopQueryParams, instance?: ScallopQueryInstanceParams);
+    /**
+     * Request the scallop API to initialize data.
+     *
+     * @param force - Whether to force initialization.
+     * @param address - ScallopAddress instance.
+     */
+    init(force?: boolean, address?: ScallopAddress): Promise<void>;
+    /**
+     * @deprecated use getMarketPools
+     * Query market data.
+     * @param indexer - Whether to use indexer.
+     * @return Market data.
+     */
+    queryMarket(args?: {
+        coinPrices?: CoinPrices;
+        indexer?: boolean;
+    }): Promise<Market>;
+    /**
+     * Get market pools.
+     *
+     * @description
+     * To obtain all market pools at once, it is recommended to use
+     * the `queryMarket` method to reduce time consumption.
+     *
+     * @param poolCoinNames - Specific an array of support pool coin name.
+     * @param indexer - Whether to use indexer.
+     * @return Market pools data.
+     */
+    getMarketPools(poolCoinNames?: SupportPoolCoins[], args?: {
+        coinPrices?: CoinPrices;
+        indexer?: boolean;
+    }): Promise<{
+        pools: MarketPools;
+        collaterals: MarketCollaterals;
+    }>;
+    /**
+     * Get  market pool
+     *
+     * @param poolCoinName - Specific support pool coin name.
+     * @param indexer - Whether to use indexer.
+     * @return Market pool data.
+     */
+    getMarketPool(poolCoinName: SupportPoolCoins, args?: {
+        coinPrice?: number;
+        indexer?: boolean;
+    }): Promise<MarketPool | undefined>;
+    /**
+     * Get market collaterals.
+     *
+     * @description
+     * To obtain all market collaterals at once, it is recommended to use
+     * the `queryMarket` method to reduce time consumption.
+     *
+     * @param collateralCoinNames - Specific an array of support collateral coin name.
+     * @param indexer - Whether to use indexer.
+     * @return Market collaterals data.
+     */
+    getMarketCollaterals(collateralCoinNames?: SupportCollateralCoins[], args?: {
+        indexer?: boolean;
+    }): Promise<{
+        usdc?: MarketCollateral | undefined;
+        sbeth?: MarketCollateral | undefined;
+        sbusdt?: MarketCollateral | undefined;
+        sbwbtc?: MarketCollateral | undefined;
+        weth?: MarketCollateral | undefined;
+        wbtc?: MarketCollateral | undefined;
+        wusdc?: MarketCollateral | undefined;
+        wusdt?: MarketCollateral | undefined;
+        sui?: MarketCollateral | undefined;
+        wapt?: MarketCollateral | undefined;
+        wsol?: MarketCollateral | undefined;
+        cetus?: MarketCollateral | undefined;
+        afsui?: MarketCollateral | undefined;
+        hasui?: MarketCollateral | undefined;
+        vsui?: MarketCollateral | undefined;
+        sca?: MarketCollateral | undefined;
+        fdusd?: MarketCollateral | undefined;
+        usdy?: MarketCollateral | undefined;
+    }>;
+    /**
+     * Get market collateral
+     *
+     * @param collateralCoinName - Specific support collateral coin name.
+     * @param indexer - Whether to use indexer.
+     * @return Market collateral data.
+     */
+    getMarketCollateral(collateralCoinName: SupportCollateralCoins, args?: {
+        indexer?: boolean;
+    }): Promise<MarketCollateral | undefined>;
+    /**
+     * Get obligations data.
+     *
+     * @param ownerAddress - The owner address.
+     * @return Obligations data.
+     */
+    getObligations(ownerAddress?: string): Promise<Obligation[]>;
+    /**
+     * Query obligation data.
+     *
+     * @param obligationId - The obligation id.
+     * @return Obligation data.
+     */
+    queryObligation(obligationId: SuiObjectArg, args?: {
+        version: SuiObjectArg;
+        market: SuiObjectArg;
+    }): Promise<ObligationQueryInterface | undefined>;
+    /**
+     * Get all asset coin amounts.
+     *
+     * @param assetCoinNames - Specific an array of support asset coin name.
+     * @param ownerAddress - The owner address.
+     * @return All coin amounts.
+     */
+    getCoinAmounts(assetCoinNames?: SupportAssetCoins[], ownerAddress?: string): Promise<OptionalKeys<Record<SupportAssetCoins, number>>>;
+    /**
+     * Get asset coin amount.
+     *
+     * @param assetCoinName - Specific support asset coin name.
+     * @param ownerAddress - The owner address.
+     * @return Coin amount.
+     */
+    getCoinAmount(assetCoinName: SupportAssetCoins, ownerAddress?: string): Promise<number>;
+    /**
+     * Get all market coin amounts.
+     *
+     * @param coinNames - Specific an array of support market coin name.
+     * @param ownerAddress - The owner address.
+     * @return All market market coin amounts.
+     */
+    getMarketCoinAmounts(marketCoinNames?: SupportMarketCoins[], ownerAddress?: string): Promise<OptionalKeys<Record<SupportMarketCoins, number>>>;
+    /**
+     * Get market coin amount.
+     *
+     * @param coinNames - Specific support market coin name.
+     * @param ownerAddress - The owner address.
+     * @return Market market coin amount.
+     */
+    getMarketCoinAmount(marketCoinName: SupportMarketCoins, ownerAddress?: string): Promise<number>;
+    /**
+     * Get price from pyth fee object.
+     *
+     * @param assetCoinName - Specific support asset coin name.
+     * @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.
+     *
+     * @param stakeMarketCoinNames - Specific an array of support stake market coin name.
+     * @param indexer - Whether to use indexer.
+     * @return Spools data.
+     */
+    getSpools(stakeMarketCoinNames?: SupportStakeMarketCoins[], args?: {
+        marketPools?: MarketPools;
+        coinPrices?: CoinPrices;
+        indexer?: boolean;
+    }): Promise<{
+        susdc?: Spool | undefined;
+        sweth?: Spool | undefined;
+        swusdc?: Spool | undefined;
+        swusdt?: Spool | undefined;
+        ssui?: Spool | undefined;
+        scetus?: Spool | undefined;
+        safsui?: Spool | undefined;
+        shasui?: Spool | undefined;
+        svsui?: Spool | undefined;
+    }>;
+    /**
+     * Get spool data.
+     *
+     * @param stakeMarketCoinName - Specific support stake market coin name.
+     * @param indexer - Whether to use indexer.
+     * @return Spool data.
+     */
+    getSpool(stakeMarketCoinName: SupportStakeMarketCoins, args?: {
+        marketPool?: MarketPool;
+        coinPrices?: CoinPrices;
+        indexer?: boolean;
+    }): Promise<Spool | undefined>;
+    /**
+     * Get stake accounts data for all stake pools (spools).
+     *
+     * @param ownerAddress - The owner address.
+     * @return All Stake accounts data.
+     */
+    getAllStakeAccounts(ownerAddress?: string): Promise<StakeAccounts>;
+    /**
+     * Get stake accounts data for specific stake pool (spool).
+     *
+     * @param stakeMarketCoinName - Specific support stake market coin name.
+     * @param ownerAddress - The owner address.
+     * @return Stake accounts data.
+     */
+    getStakeAccounts(stakeMarketCoinName: SupportStakeMarketCoins, ownerAddress?: string): Promise<StakeAccount[]>;
+    /**
+     * Get stake pools (spools) data.
+     *
+     * @description
+     * For backward compatible, it is recommended to use `getSpools` method
+     * to get all spools data.
+     *
+     * @param stakeMarketCoinNames - Specific an array of support stake market coin name.
+     * @return Stake pools data.
+     */
+    getStakePools(stakeMarketCoinNames?: SupportStakeMarketCoins[]): Promise<{
+        susdc?: StakePool | undefined;
+        sweth?: StakePool | undefined;
+        swusdc?: StakePool | undefined;
+        swusdt?: StakePool | undefined;
+        ssui?: StakePool | undefined;
+        scetus?: StakePool | undefined;
+        safsui?: StakePool | undefined;
+        shasui?: StakePool | undefined;
+        svsui?: StakePool | undefined;
+    }>;
+    /**
+     * Get stake pool (spool) data.
+     *
+     * @description
+     * For backward compatible, it is recommended to use `getSpool` method
+     * to get all spool data.
+     *
+     * @param stakeMarketCoinName - Specific support stake market coin name.
+     * @return Stake pool data.
+     */
+    getStakePool(stakeMarketCoinName: SupportStakeMarketCoins): Promise<StakePool | undefined>;
+    /**
+     * Get stake reward pools data.
+     *
+     * @description
+     * For backward compatible, it is recommended to use `getSpools` method
+     * to get all spools data.
+     *
+     * @param stakeMarketCoinNames - Specific an array of stake market coin name.
+     * @return Stake reward pools data.
+     */
+    getStakeRewardPools(stakeMarketCoinNames?: SupportStakeMarketCoins[]): Promise<{
+        susdc?: StakeRewardPool | undefined;
+        sweth?: StakeRewardPool | undefined;
+        swusdc?: StakeRewardPool | undefined;
+        swusdt?: StakeRewardPool | undefined;
+        ssui?: StakeRewardPool | undefined;
+        scetus?: StakeRewardPool | undefined;
+        safsui?: StakeRewardPool | undefined;
+        shasui?: StakeRewardPool | undefined;
+        svsui?: StakeRewardPool | undefined;
+    }>;
+    /**
+     * Get stake reward pool data.
+     *
+     * @description
+     * For backward compatible, it is recommended to use `getSpool` method
+     * to get spool data.
+     *
+     * @param marketCoinName - Specific support stake market coin name.
+     * @return Stake reward pool data.
+     */
+    getStakeRewardPool(stakeMarketCoinName: SupportStakeMarketCoins): Promise<StakeRewardPool | undefined>;
+    /**
+     * Get borrow incentive pools data.
+     *
+     * @param coinNames - Specific an array of support borrow incentive coin name.
+     * @param indexer - Whether to use indexer.
+     * @return Borrow incentive pools data.
+     */
+    getBorrowIncentivePools(coinNames?: SupportBorrowIncentiveCoins[], args?: {
+        coinPrices?: CoinPrices;
+        indexer?: boolean;
+        marketPools?: MarketPools;
+    }): Promise<{
+        usdc?: BorrowIncentivePool | undefined;
+        sbeth?: BorrowIncentivePool | undefined;
+        sbusdt?: BorrowIncentivePool | undefined;
+        sbwbtc?: BorrowIncentivePool | undefined;
+        weth?: BorrowIncentivePool | undefined;
+        wbtc?: BorrowIncentivePool | undefined;
+        wusdc?: BorrowIncentivePool | undefined;
+        wusdt?: BorrowIncentivePool | undefined;
+        sui?: BorrowIncentivePool | undefined;
+        wapt?: BorrowIncentivePool | undefined;
+        wsol?: BorrowIncentivePool | undefined;
+        cetus?: BorrowIncentivePool | undefined;
+        afsui?: BorrowIncentivePool | undefined;
+        hasui?: BorrowIncentivePool | undefined;
+        vsui?: BorrowIncentivePool | undefined;
+        sca?: BorrowIncentivePool | undefined;
+        fud?: BorrowIncentivePool | undefined;
+        deep?: BorrowIncentivePool | undefined;
+        fdusd?: BorrowIncentivePool | undefined;
+        blub?: BorrowIncentivePool | undefined;
+        musd?: BorrowIncentivePool | undefined;
+        ns?: BorrowIncentivePool | undefined;
+        usdy?: BorrowIncentivePool | undefined;
+    }>;
+    /**
+     * Get borrow incentive accounts data.
+     *
+     * @param coinNames - Specific support borrow incentive coin name.
+     * @param ownerAddress - The owner address.
+     * @return Borrow incentive accounts data.
+     */
+    getBorrowIncentiveAccounts(obligationId: string | SuiObjectRef, coinNames?: SupportBorrowIncentiveCoins[]): Promise<{
+        usdc?: ParsedBorrowIncentiveAccountData | undefined;
+        sbeth?: ParsedBorrowIncentiveAccountData | undefined;
+        sbusdt?: ParsedBorrowIncentiveAccountData | undefined;
+        sbwbtc?: ParsedBorrowIncentiveAccountData | undefined;
+        weth?: ParsedBorrowIncentiveAccountData | undefined;
+        wbtc?: ParsedBorrowIncentiveAccountData | undefined;
+        wusdc?: ParsedBorrowIncentiveAccountData | undefined;
+        wusdt?: ParsedBorrowIncentiveAccountData | undefined;
+        sui?: ParsedBorrowIncentiveAccountData | undefined;
+        wapt?: ParsedBorrowIncentiveAccountData | undefined;
+        wsol?: ParsedBorrowIncentiveAccountData | undefined;
+        cetus?: ParsedBorrowIncentiveAccountData | undefined;
+        afsui?: ParsedBorrowIncentiveAccountData | undefined;
+        hasui?: ParsedBorrowIncentiveAccountData | undefined;
+        vsui?: ParsedBorrowIncentiveAccountData | undefined;
+        sca?: ParsedBorrowIncentiveAccountData | undefined;
+        fud?: ParsedBorrowIncentiveAccountData | undefined;
+        deep?: ParsedBorrowIncentiveAccountData | undefined;
+        fdusd?: ParsedBorrowIncentiveAccountData | undefined;
+        blub?: ParsedBorrowIncentiveAccountData | undefined;
+        musd?: ParsedBorrowIncentiveAccountData | undefined;
+        ns?: ParsedBorrowIncentiveAccountData | undefined;
+        usdy?: ParsedBorrowIncentiveAccountData | undefined;
+    }>;
+    /**
+     * Get user lending and spool infomation for specific pools.
+     *
+     * @param poolCoinNames - Specific an array of support pool coin name.
+     * @param ownerAddress - The owner address.
+     * @param indexer - Whether to use indexer.
+     * @return All lending and spool infomation.
+     */
+    getLendings(poolCoinNames?: SupportPoolCoins[], ownerAddress?: string, args?: {
+        indexer?: boolean;
+        marketPools?: MarketPools;
+        coinPrices?: CoinPrices;
+    }): Promise<{
+        usdc?: Lending | undefined;
+        sbeth?: Lending | undefined;
+        sbusdt?: Lending | undefined;
+        sbwbtc?: Lending | undefined;
+        weth?: Lending | undefined;
+        wbtc?: Lending | undefined;
+        wusdc?: Lending | undefined;
+        wusdt?: Lending | undefined;
+        sui?: Lending | undefined;
+        wapt?: Lending | undefined;
+        wsol?: Lending | undefined;
+        cetus?: Lending | undefined;
+        afsui?: Lending | undefined;
+        hasui?: Lending | undefined;
+        vsui?: Lending | undefined;
+        sca?: Lending | undefined;
+        fud?: Lending | undefined;
+        deep?: Lending | undefined;
+        fdusd?: Lending | undefined;
+        blub?: Lending | undefined;
+        musd?: Lending | undefined;
+        ns?: Lending | undefined;
+        usdy?: Lending | undefined;
+    }>;
+    /**
+     * Get user lending and spool information for specific pool.
+     *
+     * @param poolCoinName - Specific support pool coin name.
+     * @param ownerAddress - The owner address.
+     * @param indexer - Whether to use indexer.
+     * @return Lending pool data.
+     */
+    getLending(poolCoinName: SupportPoolCoins, ownerAddress?: string, args?: {
+        indexer?: boolean;
+    }): Promise<Lending>;
+    /**
+     * Get user all obligation accounts information.
+     *
+     * @description
+     * All collateral and borrowing information in all obligation accounts owned by the user.
+     *
+     * @param ownerAddress - The owner address.
+     * @param indexer - Whether to use indexer.
+     * @return All obligation accounts information.
+     */
+    getObligationAccounts(ownerAddress?: string, args?: {
+        indexer?: boolean;
+        market?: {
+            collaterals: MarketCollaterals;
+            pools: MarketPools;
+        };
+        coinPrices?: CoinPrices;
+    }): Promise<{
+        [x: string]: ObligationAccount | undefined;
+    }>;
+    /**
+     * Get obligation account information for specific id.
+     *
+     * @description
+     * borrowing and obligation information for specific pool.
+     *
+     * @param obligationId - The obligation id.
+     * @param ownerAddress - The owner address.
+     * @param indexer - Whether to use indexer.
+     * @return Borrowing and collateral information.
+     */
+    getObligationAccount(obligationId: string, ownerAddress?: string, args?: {
+        indexer?: boolean;
+    }): Promise<ObligationAccount | undefined>;
+    /**
+     * Get total value locked.
+     *
+     * @param indexer - Whether to use indexer.
+     * @description
+     * Include total supplied value and total borrowed value.
+     *
+     * @return Total value locked.
+     */
+    getTvl(args?: {
+        indexer?: boolean;
+    }): Promise<TotalValueLocked>;
+    /**
+     * Get veSca data.
+     * @param veScaKey
+     * @returns veSca
+     */
+    getVeSca(veScaKey: string | SuiObjectData): Promise<Vesca | undefined>;
+    /**
+     * Get all veSca from walletAdddress
+     * @param walletAddress
+     * @returns array of veSca
+     */
+    getVeScas({ walletAddress, excludeEmpty, }?: {
+        walletAddress?: string;
+        excludeEmpty?: boolean;
+    }): Promise<Vesca[]>;
+    /**
+     * Get total vesca treasury with movecall
+     * @returns Promise<string | undefined>
+     */
+    getVeScaTreasuryInfo(): Promise<VeScaTreasuryInfo | null>;
+    /**
+     * Return binded referrer veScaKeyId of referee walletAddress if exist
+     * @param walletAddress
+     * @returns veScaKeyId
+     */
+    getVeScaKeyIdFromReferralBindings(walletAddress?: string): Promise<string | null>;
+    /**
+     * Get binded obligationId from a veScaKey if it exists.
+     * @param veScaKey
+     * @returns obligationId
+     */
+    getBindedObligationId(veScaKey: string): Promise<string | null>;
+    /**
+     * Get binded veSCA key from a obligationId if it exists.
+     * @param obligationId
+     * @returns veScaKey
+     */
+    getBindedVeScaKey(obligationId: string): Promise<string | null>;
+    /**
+     * Get user's veSCA loyalty program informations
+     * @param walletAddress
+     * @returns Loyalty program information
+     */
+    getLoyaltyProgramInfos(veScaKey?: string | SuiObjectData): Promise<LoyaltyProgramInfo | null>;
+    /**
+     * Get total supply of sCoin
+     * @param sCoinName - Supported sCoin name
+     * @returns Total Supply
+     */
+    getSCoinTotalSupply(sCoinName: SupportSCoin): Promise<number>;
+    /**
+     * Get all sCoin amounts.
+     *
+     * @param sCoinNames - Specific an array of support sCoin name.
+     * @param ownerAddress - The owner address.
+     * @return All market sCoin amounts.
+     */
+    getSCoinAmounts(sCoinNames?: SupportSCoin[], ownerAddress?: string): Promise<OptionalKeys<Record<"susdc" | "ssbeth" | "ssbusdt" | "ssbwbtc" | "sweth" | "swbtc" | "swusdc" | "swusdt" | "ssui" | "swsol" | "scetus" | "safsui" | "shasui" | "svsui" | "ssca" | "sfud" | "sdeep" | "sfdusd" | "sblub" | "smusd" | "sns" | "susdy", number>>>;
+    /**
+     * Get sCoin amount.
+     *
+     * @param coinNames - Specific support sCoin name.
+     * @param ownerAddress - The owner address.
+     * @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<"usdc" | "sbeth" | "sbusdt" | "sbwbtc" | "weth" | "wbtc" | "wusdc" | "wusdt" | "sui" | "wapt" | "wsol" | "cetus" | "afsui" | "hasui" | "vsui" | "sca" | "fud" | "deep" | "fdusd" | "blub" | "musd" | "ns" | "usdy", number>>;
+    /**
+     * Get supply limit of lending pool
+     */
+    getPoolSupplyLimit(poolName: SupportPoolCoins): Promise<string | null>;
+    /**
+     * Get borrow limit of borrow pool
+     */
+    getPoolBorrowLimit(poolName: SupportPoolCoins): Promise<string | null>;
+    /**
+     * Get list of isolated assets
+     */
+    getIsolatedAssets(): Promise<string[]>;
+    /**
+     * Check if asset is an isolated asset
+     */
+    isIsolatedAsset(assetCoinName: SupportAssetCoins): Promise<boolean>;
+    /**
+     * Get pool coin price from indexer
+     * @param coinName
+     * @returns price data
+     */
+    getCoinPriceByIndexer(poolName: SupportPoolCoins): Promise<number>;
+    /**
+     * Get all supported pool price from indexer
+     * @returns prices data
+     */
+    getCoinPricesByIndexer(): Promise<Record<string, number>>;
+    /**
+     * Get all coin prices, including sCoin
+     * @returns prices data
+     */
+    getAllCoinPrices(args?: {
+        marketPools?: MarketPools;
+        coinPrices?: CoinPrices;
+        indexer?: boolean;
+    }): Promise<{
+        susdc?: number | undefined;
+        ssbeth?: number | undefined;
+        ssbusdt?: number | undefined;
+        ssbwbtc?: number | undefined;
+        sweth?: number | undefined;
+        swbtc?: number | undefined;
+        swusdc?: number | undefined;
+        swusdt?: number | undefined;
+        ssui?: number | undefined;
+        swsol?: number | undefined;
+        scetus?: number | undefined;
+        safsui?: number | undefined;
+        shasui?: number | undefined;
+        svsui?: number | undefined;
+        ssca?: number | undefined;
+        sfud?: number | undefined;
+        sdeep?: number | undefined;
+        sfdusd?: number | undefined;
+        sblub?: number | undefined;
+        smusd?: number | undefined;
+        sns?: number | undefined;
+        susdy?: number | undefined;
+        usdc?: number | undefined;
+        sbeth?: number | undefined;
+        sbusdt?: number | undefined;
+        sbwbtc?: number | undefined;
+        weth?: number | undefined;
+        wbtc?: number | undefined;
+        wusdc?: number | undefined;
+        wusdt?: number | undefined;
+        sui?: number | undefined;
+        wapt?: number | undefined;
+        wsol?: number | undefined;
+        cetus?: number | undefined;
+        afsui?: number | undefined;
+        hasui?: number | undefined;
+        vsui?: number | undefined;
+        sca?: number | undefined;
+        fud?: number | undefined;
+        deep?: number | undefined;
+        fdusd?: number | undefined;
+        blub?: number | undefined;
+        musd?: number | undefined;
+        ns?: number | undefined;
+        usdy?: number | undefined;
+        swapt?: number | undefined;
+    }>;
+    /**
+     * Query all address (lending pool, collateral pool, borrow dynamics, interest models, etc.) of all pool
+     * @returns
+     */
+    getPoolAddresses(pools?: SupportPoolCoins[]): Promise<OptionalKeys<Record<"usdc" | "sbeth" | "sbusdt" | "sbwbtc" | "weth" | "wbtc" | "wusdc" | "wusdt" | "sui" | "wapt" | "wsol" | "cetus" | "afsui" | "hasui" | "vsui" | "sca" | "fud" | "deep" | "fdusd" | "blub" | "musd" | "ns" | "usdy", {
+        coinName: string;
+        symbol: string;
+        lendingPoolAddress?: string;
+        collateralPoolAddress?: string;
+        borrowDynamic?: string;
+        spoolReward?: string;
+        spool?: string;
+        sCoinType?: string;
+        sCoinName?: string;
+        sCoinSymbol?: string;
+        sCoinTreasury?: string;
+        interestModel?: string;
+        riskModel?: string;
+        borrowFeeKey?: string;
+        supplyLimitKey?: string;
+        borrowLimitKey?: string;
+        isolatedAssetKey?: string;
+        coinMetadataId?: string;
+        borrowIncentivePoolId?: string;
+        coinType?: string;
+        sCoinMetadataId?: string;
+        spoolName?: string;
+        decimals: number;
+        pythFeed?: string;
+        pythFeedObjectId?: string;
+    }>>>;
+    /**
+     * Get user portfolio
+     */
+    getUserPortfolio(args?: {
+        walletAddress?: string;
+        indexer?: boolean;
+    }): Promise<{
+        totalLockedScaValue: number;
+        lendings: {
+            suppliedCoin: number;
+            suppliedValue: number;
+            stakedCoin: number;
+            coinName: "usdc" | "sbeth" | "sbusdt" | "sbwbtc" | "weth" | "wbtc" | "wusdc" | "wusdt" | "sui" | "wapt" | "wsol" | "cetus" | "afsui" | "hasui" | "vsui" | "sca" | "fud" | "deep" | "fdusd" | "blub" | "musd" | "ns" | "usdy";
+            symbol: string;
+            coinType: string;
+            coinPrice: number;
+            coinDecimals: number;
+            supplyApr: number;
+            supplyApy: number;
+            incentiveApr: number;
+        }[];
+        borrowings: {
+            obligationId: string;
+            totalDebtsInUsd: number;
+            totalCollateralInUsd: number;
+            riskLevel: number;
+            availableCollateralInUsd: number;
+            totalUnhealthyCollateralInUsd: number;
+            borrowedPools: {
+                coinName: "usdc" | "sbeth" | "sbusdt" | "sbwbtc" | "weth" | "wbtc" | "wusdc" | "wusdt" | "sui" | "wapt" | "wsol" | "cetus" | "afsui" | "hasui" | "vsui" | "sca" | "fud" | "deep" | "fdusd" | "blub" | "musd" | "ns" | "usdy";
+                symbol: string;
+                coinDecimals: number;
+                coinType: string;
+                coinPrice: number;
+                borrowedCoin: number;
+                borrowedValueInUsd: number;
+                borrowApr: number | undefined;
+                borrowApy: number | undefined;
+                incentiveInfos: {
+                    coinName: "usdc" | "sbeth" | "sbusdt" | "sbwbtc" | "weth" | "wbtc" | "wusdc" | "wusdt" | "sui" | "wapt" | "wsol" | "cetus" | "afsui" | "hasui" | "vsui" | "sca" | "fud" | "deep" | "fdusd" | "blub" | "musd" | "ns" | "usdy" | "susdc" | "ssbeth" | "ssbusdt" | "ssbwbtc" | "sweth" | "swbtc" | "swusdc" | "swusdt" | "ssui" | "swsol" | "scetus" | "safsui" | "shasui" | "svsui" | "ssca" | "sfud" | "sdeep" | "sfdusd" | "sblub" | "smusd" | "sns" | "susdy";
+                    symbol: string;
+                    coinType: string;
+                    incentiveApr: number;
+                }[];
+            }[];
+        }[];
+        pendingRewards: {
+            lendings: any;
+            borrowIncentives: any;
+        };
+        veScas: {
+            veScaKey: string;
+            coinPrice: number;
+            lockedScaInCoin: number;
+            lockedScaInUsd: number;
+            currentVeScaBalance: number;
+            remainingLockPeriodInDays: number;
+            unlockAt: number;
+        }[];
+        totalDebtValue: number;
+        totalCollateralValue: number;
+        totalSupplyValue: number;
+    }>;
+    /**
+     * Get both primary and secondary price update policy objects
+     * @returns price update policies
+     */
+    getPriceUpdatePolicies(): Promise<{
+        primary: _mysten_sui_dist_cjs_client.SuiObjectResponse | null;
+        secondary: _mysten_sui_dist_cjs_client.SuiObjectResponse | null;
+    }>;
+    /**
+     * Return the supported primary and secondary oracles for all supported pool assets
+     * @returns
+     */
+    getAssetOracles(): Promise<Record<SupportAssetCoins, xOracleRules>>;
+}
+
+/**
+ * @description
+ * It provides methods for operating the transaction block, making it more convenient to organize transaction combinations.
+ *
+ * @example
+ * ```typescript
+ * const scallopBuilder = new ScallopBuilder(<parameters>);
+ * await scallopBuilder.init();
+ * const txBlock = scallopBuilder.<builder functions>();
+ * ```
+ */
+declare class ScallopBuilder {
+    readonly params: ScallopBuilderParams;
+    readonly isTestnet: boolean;
+    suiKit: SuiKit;
+    address: ScallopAddress;
+    query: ScallopQuery;
+    utils: ScallopUtils;
+    walletAddress: string;
+    cache: ScallopCache;
+    constructor(params?: ScallopBuilderParams, instance?: ScallopBuilderInstanceParams);
+    /**
+     * Request the scallop API to initialize data.
+     *
+     * @param force - Whether to force initialization.
+     * @param address - ScallopAddress instance.
+     */
+    init(force?: boolean, address?: ScallopAddress): Promise<void>;
+    /**
+     * Create a scallop txBlock instance that enhances transaction block.
+     *
+     * @param txBlock - Scallop txBlock, txBlock created by SuiKit, or original transaction block.
+     * @return Scallop txBlock.
+     */
+    createTxBlock(txBlock?: ScallopTxBlock | SuiTxBlock | Transaction): ScallopTxBlock;
+    /**
+     * Specifying the sender's amount of coins to get coins args from transaction result.
+     *
+     * @param txBlock - Scallop txBlock or txBlock created by SuiKit .
+     * @param assetCoinName - Specific support asset coin name.
+     * @param amount - Amount of coins to be selected.
+     * @param sender - Sender address.
+     * @return Take coin and left coin.
+     */
+    selectCoin<T extends SupportAssetCoins>(txBlock: ScallopTxBlock | SuiTxBlock, assetCoinName: T, amount: number, sender?: string): Promise<SelectCoinReturnType<T>>;
+    /**
+     * Specifying the sender's amount of market coins to get coins args from transaction result.
+     *
+     * @param txBlock - Scallop txBlock or txBlock created by SuiKit .
+     * @param marketCoinName - Specific support market coin name.
+     * @param amount - Amount of coins to be selected.
+     * @param sender - Sender address.
+     * @return Take coin and left coin.
+     */
+    selectMarketCoin(txBlock: ScallopTxBlock | SuiTxBlock, marketCoinName: SupportMarketCoins, amount: number, sender?: string): Promise<{
+        takeCoin: _scallop_io_sui_kit.TransactionObjectArgument;
+        leftCoin: _scallop_io_sui_kit.TransactionObjectArgument;
+        totalAmount: number;
+    }>;
+    /**
+     * Specifying the sender's amount of sCoins to get coins args from transaction result.
+     *
+     * @param txBlock - Scallop txBlock or txBlock created by SuiKit .
+     * @param marketCoinName - Specific support sCoin name.
+     * @param amount - Amount of coins to be selected.
+     * @param sender - Sender address.
+     * @return Take coin and left coin.
+     */
+    selectSCoin(txBlock: ScallopTxBlock | SuiTxBlock, sCoinName: SupportSCoin, amount: number, sender?: string): Promise<{
+        takeCoin: _scallop_io_sui_kit.TransactionObjectArgument;
+        leftCoin: _scallop_io_sui_kit.TransactionObjectArgument;
+        totalAmount: number;
+    }>;
+    /**
+     * Execute Scallop txBlock using the `signAndSendTxn` methods in suikit.
+     *
+     * @param txBlock - Scallop txBlock, txBlock created by SuiKit, or original transaction block.
+     */
+    signAndSendTxBlock(txBlock: ScallopTxBlock | SuiTxBlock | Transaction): Promise<SuiTransactionBlockResponse>;
+    moveCall(txb: ScallopTxBlock | SuiTxBlock, target: string, args?: (SuiTxArg | SuiVecTxArg | SuiObjectArg | SuiAmountsArg)[], typeArgs?: string[]): _scallop_io_sui_kit.TransactionResult;
+}
+
+/**
+ * @description
+ * It provides contract interaction operations for general users.
+ *
+ * @example
+ * ```typescript
+ * const scallopClient  = new ScallopClient(<parameters>);
+ * await scallopClient.init();
+ * scallopClient.<client functions>();
+ * await scallopClient.<client async functions>();
+ * ```
+ */
+declare class ScallopClient {
+    readonly params: ScallopClientParams;
+    suiKit: SuiKit;
+    address: ScallopAddress;
+    builder: ScallopBuilder;
+    query: ScallopQuery;
+    utils: ScallopUtils;
+    cache: ScallopCache;
+    walletAddress: string;
+    constructor(params?: ScallopClientParams, instance?: ScallopClientInstanceParams);
+    /**
+     * Request the scallop API to initialize data.
+     *
+     * @param force - Whether to force initialization.
+     */
+    init(force?: boolean): Promise<void>;
+    /**
+     * Query market data.
+     *
+     * @description
+     * This method might be @deprecated in the future, please use the {@link ScallopQuery} query instance instead.
+     *
+     * @return Market data.
+     */
+    queryMarket(): Promise<Market>;
+    /**
+     * Get obligations data.
+     *
+     * @description
+     * This method might be @deprecated in the future, please use the {@link ScallopQuery} query instance instead.
+     *
+     * @param ownerAddress - The owner address.
+     * @return Obligations data.
+     */
+    getObligations(ownerAddress?: string): Promise<Obligation[]>;
+    /**
+     * Query obligation data.
+     *
+     * @description
+     * This method might be @deprecated in the future, please use the {@link ScallopQuery} query instance instead.
+     *
+     * @param obligationId - The obligation id.
+     * @return Obligation data.
+     */
+    queryObligation(obligationId: string): Promise<ObligationQueryInterface | undefined>;
+    /**
+     * Query all stake accounts data.
+     *
+     * @description
+     * This method might be @deprecated in the future, please use the {@link ScallopQuery} query instance instead.
+     *
+     * @param ownerAddress - The owner address.
+     * @return All stake accounts data.
+     */
+    getAllStakeAccounts(ownerAddress?: string): Promise<StakeAccounts>;
+    /**
+     * Query stake account data.
+     *
+     * @description
+     * This method might be @deprecated in the future, please use the {@link ScallopQuery} query instance instead.
+     *
+     * @param stakeMarketCoinName - Support stake market coin.
+     * @param ownerAddress - The owner address.
+     * @return Stake accounts data.
+     */
+    getStakeAccounts(stakeMarketCoinName: SupportStakeMarketCoins, ownerAddress?: string): Promise<StakeAccount[]>;
+    /**
+     * Query stake pool data.
+     *
+     * @description
+     * This method might be @deprecated in the future, please use the {@link ScallopQuery} query instance instead.
+     *
+     * @param stakeMarketCoinName - Support stake market coin.
+     * @return Stake pool data.
+     */
+    getStakePool(stakeMarketCoinName: SupportStakeMarketCoins): Promise<StakePool | undefined>;
+    /**
+     * Query reward pool data.
+     *
+     * @description
+     * This method might be @deprecated in the future, please use the {@link ScallopQuery} query instance instead.
+     *
+     * @param stakeMarketCoinName - Support stake market coin.
+     * @return Reward pool data.
+     */
+    getStakeRewardPool(stakeMarketCoinName: SupportStakeMarketCoins): Promise<StakeRewardPool | undefined>;
+    /**
+     * Open obligation.
+     *
+     * @param sign - Decide to directly sign the transaction or return the transaction block.
+     * @return Transaction block response or transaction block.
+     */
+    openObligation(): Promise<SuiTransactionBlockResponse>;
+    openObligation<S extends boolean>(sign?: S): Promise<ScallopClientFnReturnType<S>>;
+    /**
+     * Deposit collateral into the specific pool.
+     *
+     * @param collateralCoinName - Types of collateral coin.
+     * @param amount - The amount of coins would deposit.
+     * @param sign - Decide to directly sign the transaction or return the transaction block.
+     * @param obligationId - The obligation object.
+     * @param walletAddress - The wallet address of the owner.
+     * @return Transaction block response or transaction block.
+     */
+    depositCollateral(collateralCoinName: SupportCollateralCoins, amount: number): Promise<SuiTransactionBlockResponse>;
+    depositCollateral<S extends boolean>(collateralCoinName: SupportCollateralCoins, amount: number, sign?: S, obligationId?: string, walletAddress?: string): Promise<ScallopClientFnReturnType<S>>;
+    /**
+     * Withdraw collateral from the specific pool.
+     *
+     * @param collateralCoinName - Types of collateral coin.
+     * @param amount - The amount of coins would deposit.
+     * @param sign - Decide to directly sign the transaction or return the transaction block.
+     * @param obligationId - The obligation object.
+     * @param obligationKey - The obligation key object to verifying obligation authority.
+     * @param walletAddress - The wallet address of the owner.
+     * @return Transaction block response or transaction block.
+     */
+    withdrawCollateral<S extends boolean>(collateralCoinName: SupportCollateralCoins, amount: number, sign: S | undefined, obligationId: string, obligationKey: string, walletAddress?: string): Promise<ScallopClientFnReturnType<S>>;
+    /**
+     * Deposit asset into the specific pool.
+     *
+     * @param poolCoinName - Types of pool coin.
+     * @param amount - The amount of coins would deposit.
+     * @param sign - Decide to directly sign the transaction or return the transaction block.
+     * @param walletAddress - The wallet address of the owner.
+     * @return Transaction block response or transaction block.
+     */
+    deposit(poolCoinName: SupportPoolCoins, amount: number): Promise<SuiTransactionBlockResponse>;
+    deposit<S extends boolean>(poolCoinName: SupportPoolCoins, amount: number, sign?: S, walletAddress?: string): Promise<ScallopClientFnReturnType<S>>;
+    /**
+     * Deposit asset into the specific pool and Stake market coin into the corresponding spool.
+     *
+     * @param stakeCoinName - Types of stake coin.
+     * @param amount - The amount of coins would deposit.
+     * @param sign - Decide to directly sign the transaction or return the transaction block.
+     * @param stakeAccountId - The stake account object.
+     * @param walletAddress - The wallet address of the owner.
+     * @return Transaction block response or transaction block.
+     */
+    depositAndStake(stakeCoinName: SupportStakeCoins, amount: number): Promise<SuiTransactionBlockResponse>;
+    depositAndStake<S extends boolean>(stakeCoinName: SupportStakeCoins, amount: number, sign?: S, stakeAccountId?: string, walletAddress?: string): Promise<ScallopClientFnReturnType<S>>;
+    /**
+     * Withdraw asset from the specific pool, must return market coin.
+     *
+     * @param poolCoinName - Specific support pool coin name.
+     * @param amount - The amount of coins would withdraw.
+     * @param sign - Decide to directly sign the transaction or return the transaction block.
+     * @param walletAddress - The wallet address of the owner.
+     * @return Transaction block response or transaction block.
+     */
+    withdraw(poolCoinName: SupportPoolCoins, amount: number): Promise<SuiTransactionBlockResponse>;
+    withdraw<S extends boolean>(poolCoinName: SupportPoolCoins, amount: number, sign?: S, walletAddress?: string): Promise<ScallopClientFnReturnType<S>>;
+    /**
+     * Borrow asset from the specific pool.
+     *
+     * @param poolCoinName - Specific support pool coin name.
+     * @param amount - The amount of coins would borrow.
+     * @param sign - Decide to directly sign the transaction or return the transaction block.
+     * @param obligationId - The obligation object.
+     * @param obligationKey - The obligation key object to verifying obligation authority.
+     * @param walletAddress - The wallet address of the owner.
+     * @return Transaction block response or transaction block.
+     */
+    borrow<S extends boolean>(poolCoinName: SupportPoolCoins, amount: number, sign: S | undefined, obligationId: string, obligationKey: string, walletAddress?: string): Promise<ScallopClientFnReturnType<S>>;
+    /**
+     * Repay asset into the specific pool.
+     *
+     * @param poolCoinName - Specific support pool coin name.
+     * @param amount - The amount of coins would repay.
+     * @param sign - Decide to directly sign the transaction or return the transaction block.
+     * @param obligationId - The obligation object.
+     * @param walletAddress - The wallet address of the owner.
+     * @return Transaction block response or transaction block.
+     */
+    repay<S extends boolean>(poolCoinName: SupportPoolCoins, amount: number, sign: S | undefined, obligationId: string, obligationKey: string, walletAddress?: string): Promise<ScallopClientFnReturnType<S>>;
+    /**
+     * FlashLoan asset from the specific pool.
+     *
+     * @param poolCoinName - Specific support pool coin name..
+     * @param amount - The amount of coins would repay.
+     * @param callback - The callback function to build transaction block and return coin argument.
+     * @param sign - Decide to directly sign the transaction or return the transaction block.
+     * @return Transaction block response or transaction block.
+     */
+    flashLoan(poolCoinName: SupportPoolCoins, amount: number, callback: (txBlock: ScallopTxBlock, coin: TransactionObjectArgument | string) => SuiObjectArg): Promise<SuiTransactionBlockResponse>;
+    flashLoan<S extends boolean>(poolCoinName: SupportPoolCoins, amount: number, callback: (txBlock: ScallopTxBlock, coin: TransactionObjectArgument | string) => SuiObjectArg, sign?: S, walletAddress?: string): Promise<ScallopClientFnReturnType<S>>;
+    /**
+     * Create stake account.
+     *
+     * @param sign - Decide to directly sign the transaction or return the transaction block.
+     * @param walletAddress - The wallet address of the owner.
+     * @return Transaction block response or transaction block.
+     */
+    createStakeAccount(marketCoinName: SupportStakeMarketCoins): Promise<SuiTransactionBlockResponse>;
+    createStakeAccount<S extends boolean>(marketCoinName: SupportStakeMarketCoins, sign?: S, walletAddress?: string): Promise<ScallopClientFnReturnType<S>>;
+    /**
+     * Stake market coin into the specific spool.
+     *
+     * @param marketCoinName - Types of market coin.
+     * @param amount - The amount of coins would deposit.
+     * @param sign - Decide to directly sign the transaction or return the transaction block.
+     * @param stakeAccountId - The stake account object.
+     * @param walletAddress - The wallet address of the owner.
+     * @return Transaction block response or transaction block.
+     */
+    stake(stakeMarketCoinName: SupportStakeMarketCoins, amount: number): Promise<SuiTransactionBlockResponse>;
+    stake<S extends boolean>(stakeMarketCoinName: SupportStakeMarketCoins, amount: number, sign?: S, stakeAccountId?: string, walletAddress?: string): Promise<ScallopClientFnReturnType<S>>;
+    /**
+     * Unstake market coin from the specific spool.
+     *
+     * @param stakeMarketCoinName - Types of mak coin.
+     * @param amount - The amount of coins would deposit.
+     * @param sign - Decide to directly sign the transaction or return the transaction block.
+     * @param accountId - The stake account object.
+     * @param walletAddress - The wallet address of the owner.
+     * @return Transaction block response or transaction block.
+     */
+    unstake(stakeMarketCoinName: SupportStakeMarketCoins, amount: number): Promise<SuiTransactionBlockResponse>;
+    unstake<S extends boolean>(stakeMarketCoinName: SupportStakeMarketCoins, amount: number, sign?: S, stakeAccountId?: string, walletAddress?: string): Promise<ScallopClientFnReturnType<S>>;
+    /**
+     * Unstake market coin from the specific spool and withdraw asset from the corresponding pool.
+     *
+     * @param marketCoinName - Types of mak coin.
+     * @param amount - The amount of coins would deposit.
+     * @param sign - Decide to directly sign the transaction or return the transaction block.
+     * @param accountId - The stake account object.
+     * @param walletAddress - The wallet address of the owner.
+     * @return Transaction block response or transaction block.
+     */
+    unstakeAndWithdraw(stakeMarketCoinName: SupportStakeMarketCoins, amount: number): Promise<SuiTransactionBlockResponse>;
+    unstakeAndWithdraw<S extends boolean>(stakeMarketCoinName: SupportStakeMarketCoins, amount: number, sign?: S, stakeAccountId?: string, walletAddress?: string): Promise<ScallopClientFnReturnType<S>>;
+    /**
+     * Claim reward coin from the specific spool.
+     *
+     * @param stakeMarketCoinName - Types of mak coin.
+     * @param amount - The amount of coins would deposit.
+     * @param sign - Decide to directly sign the transaction or return the transaction block.
+     * @param accountId - The stake account object.
+     * @param walletAddress - The wallet address of the owner.
+     * @return Transaction block response or transaction block.
+     */
+    claim(stakeMarketCoinName: SupportStakeMarketCoins): Promise<SuiTransactionBlockResponse>;
+    claim<S extends boolean>(stakeMarketCoinName: SupportStakeMarketCoins, sign?: S, stakeAccountId?: string, walletAddress?: string): Promise<ScallopClientFnReturnType<S>>;
+    /**
+     * stake obligaion.
+     *
+     * @param obligationId - The obligation account object.
+     * @param obligationKeyId - The obligation key account object.
+     * @param sign - Decide to directly sign the transaction or return the transaction block.
+     * @param walletAddress - The wallet address of the owner.
+     * @return Transaction block response or transaction block
+     */
+    stakeObligation<S extends boolean>(obligationId: string, obligationKeyId: string, sign?: S, walletAddress?: string): Promise<ScallopClientFnReturnType<S>>;
+    /**
+     * unstake obligaion.
+     *
+     * @param obligationId - The obligation account object.
+     * @param obligationKeyId - The obligation key account object.
+     * @param sign - Decide to directly sign the transaction or return the transaction block.
+     * @param walletAddress - The wallet address of the owner.
+     * @return Transaction block response or transaction block
+     */
+    unstakeObligation<S extends boolean>(obligationId: string, obligationKeyId: string, sign?: S, walletAddress?: string): Promise<ScallopClientFnReturnType<S>>;
+    /**
+     * Claim borrow incentive reward.
+     *
+     * @param poolName
+     * @param amount - The amount of coins would deposit.
+     * @param sign - Decide to directly sign the transaction or return the transaction block.
+     * @param accountId - The stake account object.
+     * @param walletAddress - The wallet address of the owner.
+     * @return Transaction block response or transaction block
+     */
+    claimBorrowIncentive<S extends boolean>(obligationId: string, obligationKeyId: string, sign?: S, walletAddress?: string): Promise<ScallopClientFnReturnType<S>>;
+    /**
+     * Function to migrate all market coin in user wallet into sCoin
+     * @returns Transaction response
+     */
+    migrateAllMarketCoin<S extends boolean>(includeStakePool?: 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.
+     *
+     * @remarks
+     * Only be used on the test network.
+     *
+     * @param assetCoinName - Specific asset coin name.
+     * @param amount - The amount of coins minted and received.
+     * @param receiveAddress - The wallet address that receives the coins.
+     * @param sign - Decide to directly sign the transaction or return the transaction block.
+     * @return Transaction block response or transaction block.
+     */
+    mintTestCoin(assetCoinName: Exclude<SupportAssetCoins, 'sui'>, amount: number): Promise<SuiTransactionBlockResponse>;
+    mintTestCoin<S extends boolean>(assetCoinName: Exclude<SupportAssetCoins, 'sui'>, amount: number, sign?: S, receiveAddress?: string): Promise<ScallopClientFnReturnType<S>>;
+}
+
+/**
+ * @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.
+ *
+ * @example
+ * ```typescript
+ * const sdk = new Scallop(<parameters>);
+ * const scallopAddress = await sdk.getScallopAddress();
+ * const scallopBuilder = await sdk.createScallopBuilder();
+ * const scallopClient = await sdk.createScallopClient();
+ * const scallopIndexer= await sdk.createScallopIndexer();
+ * const scallopUtils= await sdk.createScallopUtils();
+ * ```
+ */
+declare class Scallop {
+    params: ScallopParams;
+    suiKit: SuiKit;
+    cache: ScallopCache;
+    private address;
+    constructor(params: ScallopParams, cacheOptions?: QueryClientConfig, queryClient?: QueryClient);
+    /**
+     * Get a scallop address instance that already has read addresses.
+     *
+     * @param id - The API id of the addresses.
+     * @return Scallop Address.
+     */
+    getScallopAddress(id?: string): Promise<ScallopAddress>;
+    /**
+     * Create a scallop builder instance that already has initial data.
+     *
+     * @return Scallop Builder.
+     */
+    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(params?: ScallopClientParams): Promise<ScallopClient>;
+    /**
+     * Create a scallop query instance.
+     *
+     * @return Scallop Query.
+     */
+    createScallopQuery(params?: ScallopQueryParams): Promise<ScallopQuery>;
+    /**
+     * Create a scallop indexer instance.
+     *
+     * @return Scallop Indexer.
+     */
+    createScallopIndexer(): Promise<ScallopIndexer>;
+    /**
+     * Create a scallop utils instance.
+     *
+     * @return Scallop Utils.
+     */
+    createScallopUtils(params?: ScallopUtilsParams): Promise<ScallopUtils>;
+}
+
+type Coins = {
+    [K in SupportCoins]: K;
+};
+type AssetCoins = {
+    [K in SupportAssetCoins]: K;
+};
+type MarketCoins = {
+    [K in SupportMarketCoins]: K;
+};
+type SCoins = {
+    [K in SupportSCoin]: K;
+};
+type StakeMarketCoins = {
+    [K in SupportStakeMarketCoins]: K;
+};
+type StakeRewardCoins = {
+    [key in SupportStakeMarketCoins]: SupportStakeRewardCoins;
+};
+type SuiBridgeCoins = {
+    [K in SupportSuiBridgeCoins]: K;
+};
+type BorrowIncentiveRewardCoins = {
+    [key in SupportBorrowIncentiveCoins]: SupportBorrowIncentiveRewardCoins[];
+};
+type AssetCoinIds = {
+    [key in SupportAssetCoins]: string;
+};
+type SCoinIds = {
+    [key in SupportSCoin]: string;
+};
+type SCoinTreasuryCaps = {
+    [key in SupportSCoin]: string;
+};
+type SCoinConverterTreasury = {
+    [key in SupportSCoin]: string;
+};
+type PickFromUnion<T, K extends string> = K extends T ? K : never;
+type WormholeCoinIds = {
+    [key in PickFromUnion<SupportAssetCoins, 'weth' | 'wbtc' | 'wusdc' | 'wusdt' | 'wapt' | 'wsol'>]: string;
+};
+type VoloCoinIds = {
+    [key in PickFromUnion<SupportAssetCoins, 'vsui'>]: string;
+};
+type SuiBridgedCoinPackageIds = {
+    [key in SupportSuiBridgeCoins]: string;
+};
+
+type xOracleRules = {
+    primary: SupportOracleType[];
+    secondary: SupportOracleType[];
+};
+type xOracleRuleType = keyof xOracleRules;
+type xOracleListType = {
+    [key in SupportAssetCoins]: xOracleRules;
+};
+
+type CoreIds = {
+    protocolPkg: string;
+    market: string;
+    version: string;
+    coinDecimalsRegistry: string;
+    xOracle: string;
+};
+type NestedResult = Extract<Argument, {
+    $kind: 'NestedResult';
+}>;
+type Obligation$1 = NestedResult;
+type ObligationKey = NestedResult;
+type ObligationHotPotato = NestedResult;
+type CoreNormalMethods = {
+    openObligation: () => [Obligation$1, ObligationKey, ObligationHotPotato];
+    returnObligation: (obligation: SuiObjectArg, obligationHotPotato: SuiObjectArg) => void;
+    openObligationEntry: () => void;
+    addCollateral: (obligation: SuiObjectArg, coin: SuiObjectArg, collateralCoinName: SupportCollateralCoins) => void;
+    takeCollateral: (obligation: SuiObjectArg, obligationKey: SuiObjectArg, amount: number, collateralCoinName: SupportCollateralCoins) => TransactionResult;
+    deposit: (coin: SuiObjectArg, poolCoinName: SupportPoolCoins) => TransactionResult;
+    depositEntry: (coin: SuiObjectArg, poolCoinName: SupportPoolCoins) => TransactionResult;
+    withdraw: (marketCoin: SuiObjectArg, poolCoinName: SupportPoolCoins) => TransactionResult;
+    withdrawEntry: (marketCoin: SuiObjectArg, poolCoinName: SupportPoolCoins) => TransactionResult;
+    borrow: (obligation: SuiObjectArg, obligationKey: SuiObjectArg, amount: number, poolCoinName: SupportPoolCoins) => TransactionResult;
+    borrowWithReferral: (obligation: SuiObjectArg, obligationKey: SuiObjectArg, borrowReferral: SuiObjectArg, amount: number | SuiTxArg, poolCoinName: SupportPoolCoins) => TransactionResult;
+    borrowEntry: (obligation: SuiObjectArg, obligationKey: SuiObjectArg, amount: number, poolCoinName: SupportPoolCoins) => TransactionResult;
+    repay: (obligation: SuiObjectArg, coin: SuiObjectArg, poolCoinName: SupportPoolCoins) => void;
+    borrowFlashLoan: (amount: number | SuiTxArg, poolCoinName: SupportPoolCoins) => TransactionResult;
+    repayFlashLoan: (coin: SuiObjectArg, loan: SuiObjectArg, poolCoinName: SupportPoolCoins) => void;
+};
+type CoreQuickMethods = {
+    addCollateralQuick: (amount: number, collateralCoinName: SupportCollateralCoins, obligationId?: SuiObjectArg) => Promise<void>;
+    takeCollateralQuick: (amount: number, collateralCoinName: SupportCollateralCoins, obligationId?: SuiObjectArg, obligationKey?: SuiObjectArg) => Promise<TransactionResult>;
+    borrowQuick: (amount: number, poolCoinName: SupportPoolCoins, obligationId?: SuiObjectArg, obligationKey?: SuiObjectArg) => Promise<TransactionResult>;
+    borrowWithReferralQuick: (amount: number, poolCoinName: SupportPoolCoins, borrowReferral: SuiObjectArg, obligationId?: SuiObjectArg, obligationKey?: SuiObjectArg) => Promise<TransactionResult>;
+    depositQuick: (amount: number, poolCoinName: SupportPoolCoins, returnSCoin?: boolean) => Promise<TransactionResult>;
+    withdrawQuick: (amount: number, poolCoinName: SupportPoolCoins) => Promise<TransactionResult>;
+    repayQuick: (amount: number, poolCoinName: SupportPoolCoins, obligationId?: SuiObjectArg) => Promise<void>;
+    updateAssetPricesQuick: (assetCoinNames?: SupportAssetCoins[]) => Promise<void>;
+};
+type SuiTxBlockWithCoreNormalMethods = SuiTxBlock & SuiTxBlockWithSpool & CoreNormalMethods;
+type CoreTxBlock = SuiTxBlockWithCoreNormalMethods & CoreQuickMethods;
+type GenerateCoreNormalMethod = (params: {
+    builder: ScallopBuilder;
+    txBlock: SuiTxBlock;
+}) => CoreNormalMethods;
+type GenerateCoreQuickMethod = (params: {
+    builder: ScallopBuilder;
+    txBlock: SuiTxBlockWithCoreNormalMethods;
+}) => CoreQuickMethods;
+
+type SpoolIds = {
+    spoolPkg: string;
+};
+type SpoolNormalMethods = {
+    createStakeAccount: (stakeMarketCoinName: SupportStakeMarketCoins) => TransactionResult;
+    stake: (stakeAccount: SuiAddressArg, coin: SuiObjectArg, stakeMarketCoinName: SupportStakeMarketCoins) => void;
+    unstake: (stakeAccount: SuiAddressArg, amount: number, stakeMarketCoinName: SupportStakeMarketCoins) => TransactionResult;
+    claim: (stakeAccount: SuiAddressArg, stakeMarketCoinName: SupportStakeMarketCoins) => TransactionResult;
+};
+type SpoolQuickMethods = {
+    stakeQuick(amountOrMarketCoin: SuiObjectArg | number, stakeMarketCoinName: SupportStakeMarketCoins, stakeAccountId?: SuiAddressArg): Promise<void>;
+    unstakeQuick(amount: number, stakeMarketCoinName: SupportStakeMarketCoins, stakeAccountId?: SuiAddressArg, returnSCoin?: boolean): Promise<TransactionResult | undefined>;
+    claimQuick(stakeMarketCoinName: SupportStakeMarketCoins, stakeAccountId?: SuiAddressArg): Promise<TransactionResult[]>;
+};
+type SuiTxBlockWithSpoolNormalMethods = SuiTxBlock & SuiTxBlockWithSCoin & SpoolNormalMethods;
+type SpoolTxBlock = SuiTxBlockWithSpoolNormalMethods & SpoolQuickMethods;
+type GenerateSpoolNormalMethod = (params: {
+    builder: ScallopBuilder;
+    txBlock: SuiTxBlock;
+}) => SpoolNormalMethods;
+type GenerateSpoolQuickMethod = (params: {
+    builder: ScallopBuilder;
+    txBlock: SuiTxBlockWithSpoolNormalMethods;
+}) => SpoolQuickMethods;
+
+type BorrowIncentiveIds = {
+    borrowIncentivePkg: string;
+    query: string;
+    config: string;
+    incentivePools: string;
+    incentiveAccounts: string;
+    obligationAccessStore: string;
+};
+type BorrowIncentiveNormalMethods = {
+    stakeObligation: (obligation: SuiObjectArg, obligationKey: SuiObjectArg) => void;
+    stakeObligationWithVesca: (obligation: SuiObjectArg, obligationKey: SuiObjectArg, veScaKey: SuiObjectArg) => void;
+    unstakeObligation: (obligation: SuiObjectArg, obligationKey: SuiObjectArg) => void;
+    claimBorrowIncentive: (obligation: SuiObjectArg, obligationKey: SuiObjectArg, rewardType: SupportBorrowIncentiveRewardCoins) => TransactionResult;
+    deactivateBoost: (obligation: SuiObjectArg, veScaKey: SuiObjectArg) => void;
+};
+type BorrowIncentiveQuickMethods = {
+    stakeObligationQuick(obligation?: string, obligationKey?: string): Promise<void>;
+    stakeObligationWithVeScaQuick(obligation?: string, obligationKey?: string, veScaKey?: string): Promise<void>;
+    unstakeObligationQuick(obligation?: string, obligationKey?: string): Promise<void>;
+    claimBorrowIncentiveQuick(rewardType: SupportBorrowIncentiveRewardCoins, obligation?: string, obligationKey?: string): Promise<TransactionResult>;
+};
+type SuiTxBlockWithBorrowIncentiveNormalMethods = SuiTxBlock & BorrowIncentiveNormalMethods;
+type BorrowIncentiveTxBlock = SuiTxBlockWithBorrowIncentiveNormalMethods & BorrowIncentiveQuickMethods;
+type GenerateBorrowIncentiveNormalMethod = (params: {
+    builder: ScallopBuilder;
+    txBlock: SuiTxBlock;
+}) => BorrowIncentiveNormalMethods;
+type GenerateBorrowIncentiveQuickMethod = (params: {
+    builder: ScallopBuilder;
+    txBlock: SuiTxBlockWithBorrowIncentiveNormalMethods;
+}) => BorrowIncentiveQuickMethods;
+
+type VescaIds = {
+    pkgId: string;
+    table: string;
+    treasury: string;
+    config: string;
+};
+type VeScaNormalMethods = {
+    lockSca: (scaCoin: SuiObjectArg, unlockAtInSecondTimestamp: number) => TransactionResult;
+    extendLockPeriod: (veScaKey: SuiObjectArg, newUnlockAtInSecondTimestamp: number) => void;
+    extendLockAmount: (veScaKey: SuiObjectArg, scaCoin: SuiObjectArg) => void;
+    renewExpiredVeSca: (veScaKey: SuiObjectArg, scaCoin: SuiObjectArg, newUnlockAtInSecondTimestamp: number) => void;
+    redeemSca: (veScaKey: SuiObjectArg) => TransactionResult;
+    mintEmptyVeSca: () => TransactionResult;
+};
+type RedeemScaQuickReturnType<T extends boolean> = T extends true ? void : TransactionResult | undefined;
+type VeScaQuickMethods = {
+    /**
+     * Quick methods to automate
+     * lock initial SCA, extend lock period, lock more SCA, renew expired VeSCA, and redeem SCA
+     *
+     * **Flow:**
+     * - If only `amountOrCoin` is provided, it will lock the amount of existing not expired veSCA
+     * - If only `lockPeriodInDays` is provided, it will extend the lock period of existing not expired veSCA
+     *
+     * **Note:**
+     * - If one or both flow above is used on a expired veSCA, it will claim the unlocked SCA
+     *   and renew the veSCA first, and then flow continues
+     * - If users has no veSCA yet, they need to provide both `amountOrCoin` and `lockPeriodInDays` for initial lock
+     * @param amountOrCoin
+     * @param lockPeriodInDays
+     * @param autoCheck
+     */
+    lockScaQuick(amountOrCoin?: SuiObjectArg | number, lockPeriodInDays?: number, autoCheck?: boolean): Promise<void>;
+    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: <T extends boolean>(veSCaKey?: SuiObjectArg, transferSca?: T) => Promise<RedeemScaQuickReturnType<T>>;
+};
+type SuiTxBlockWithVeScaNormalMethods = SuiTxBlock & VeScaNormalMethods;
+type VeScaTxBlock = SuiTxBlockWithVeScaNormalMethods & VeScaQuickMethods;
+type GenerateVeScaNormalMethod = (params: {
+    builder: ScallopBuilder;
+    txBlock: SuiTxBlock;
+}) => VeScaNormalMethods;
+type GenerateVeScaQuickMethod = (params: {
+    builder: ScallopBuilder;
+    txBlock: SuiTxBlockWithVeScaNormalMethods;
+}) => VeScaQuickMethods;
+
+type ReferralNormalMethods = {
+    bindToReferral: (veScaKeyId: string) => void;
+    claimReferralTicket: (poolCoinName: SupportPoolCoins) => TransactionResult$1;
+    burnReferralTicket: (ticket: SuiObjectArg, poolCoinName: SupportPoolCoins) => void;
+    claimReferralRevenue: (veScaKey: SuiObjectArg, poolCoinName: SupportPoolCoins) => TransactionResult$1;
+};
+type ReferralQuickMethods = {
+    claimReferralRevenueQuick: (veScaKey: SuiObjectArg, coinNames: SupportPoolCoins[]) => Promise<void>;
+};
+type SuiTxBlockWithReferralNormalMethods = SuiTxBlock & ReferralNormalMethods;
+type ReferralTxBlock = SuiTxBlockWithReferralNormalMethods & ReferralQuickMethods;
+
+type LoyaltyProgramIds = {
+    loyaltyProgramPkgId: string;
+    rewardPool: string;
+    userRewardTableId: string;
+};
+type LoyaltyProgramNormalMethods = {
+    claimLoyaltyRevenue: (veScaKey: SuiObjectArg) => TransactionResult$1;
+};
+type LoyaltyProgramQuickMethods = {
+    claimLoyaltyRevenueQuick: (veScaKey?: SuiObjectArg) => Promise<void>;
+};
+type SuiTxBlockWithLoyaltyProgramNormalMethods = SuiTxBlock & LoyaltyProgramNormalMethods;
+type LoyaltyProgramTxBlock = SuiTxBlockWithLoyaltyProgramNormalMethods & LoyaltyProgramQuickMethods;
+type GenerateLoyaltyProgramNormalMethod = (params: {
+    builder: ScallopBuilder;
+    txBlock: SuiTxBlock;
+}) => LoyaltyProgramNormalMethods;
+type GenerateLoyaltyProgramQuickMethod = (params: {
+    builder: ScallopBuilder;
+    txBlock: SuiTxBlockWithLoyaltyProgramNormalMethods;
+}) => LoyaltyProgramQuickMethods;
+
+type sCoinPkgIds = {
+    pkgId: string;
+};
+type sCoinNormalMethods = {
+    /**
+     * Lock marketCoin and return sCoin
+     * @param marketCoinName
+     * @param marketCoin
+     * @returns
+     */
+    mintSCoin: (marketCoinName: SupportSCoin, marketCoin: SuiObjectArg) => TransactionResult$1;
+    /**
+     * Burn sCoin and return marketCoin
+     * @param sCoinName
+     * @param sCoin
+     * @returns
+     */
+    burnSCoin: (sCoinName: SupportSCoin, sCoin: SuiObjectArg) => TransactionResult$1;
+};
+type sCoinQuickMethods = {
+    mintSCoinQuick: (marketCoinName: SupportSCoin, amount: number) => Promise<TransactionResult$1>;
+    burnSCoinQuick: (sCoinName: SupportSCoin, amount: number) => Promise<TransactionResult$1>;
+};
+type SuiTxBlockWithSCoinNormalMethods = SuiTxBlock & BaseScallopTxBlock & sCoinNormalMethods;
+type SCoinTxBlock = SuiTxBlockWithSCoinNormalMethods & sCoinQuickMethods;
+type GenerateSCoinNormalMethod = (params: {
+    builder: ScallopBuilder;
+    txBlock: SuiTxBlock;
+}) => sCoinNormalMethods;
+type GenerateSCoinQuickMethod = (params: {
+    builder: ScallopBuilder;
+    txBlock: SuiTxBlockWithSCoinNormalMethods;
+}) => sCoinQuickMethods;
+
+type BaseScallopTxBlock = ReferralTxBlock & LoyaltyProgramTxBlock & BorrowIncentiveTxBlock & VeScaTxBlock;
+type SuiTxBlockWithSCoin = BaseScallopTxBlock & SCoinTxBlock;
+type SuiTxBlockWithSpool = SuiTxBlockWithSCoin & SpoolTxBlock;
+type ScallopTxBlock = SuiTxBlockWithSpool & CoreTxBlock;
+type SelectCoinReturnType<T extends SupportAssetCoins> = T extends 'sui' ? {
+    takeCoin: NestedResult;
+} : {
+    takeCoin: NestedResult;
+    leftCoin: NestedResult;
+};
+
+interface BorrowIncentiveAccountKey {
+    id: string;
+    onwerId: string;
+}
+type OptionalKeys$4<T> = {
+    [K in keyof T]?: T[K];
+};
+type BorrowIncentivePools = OptionalKeys$4<Record<SupportBorrowIncentiveCoins, BorrowIncentivePool>>;
+type BorrowIncentivePoolPoints = {
+    symbol: string;
+    coinName: SupportBorrowIncentiveRewardCoins;
+    coinType: string;
+    coinDecimal: number;
+    coinPrice: number;
+} & Required<Pick<ParsedBorrowIncentivePoolPointData, 'points' | 'distributedPoint' | 'weightedAmount'>> & CalculatedBorrowIncentivePoolPointData;
+type BorrowIncentivePool = {
+    coinName: SupportBorrowIncentiveCoins;
+    symbol: string;
+    coinType: string;
+    coinDecimal: number;
+    coinPrice: number;
+    stakedAmount: number;
+    stakedCoin: number;
+    stakedValue: number;
+    points: OptionalKeys$4<Record<SupportBorrowIncentiveRewardCoins, BorrowIncentivePoolPoints>>;
+};
+type OriginBorrowIncentivePoolPointData = {
+    point_type: {
+        name: string;
+    };
+    distributed_point_per_period: string;
+    point_distribution_time: string;
+    distributed_point: string;
+    points: string;
+    index: string;
+    base_weight: string;
+    weighted_amount: string;
+    last_update: string;
+    created_at: string;
+};
+type OriginBorrowIncentivePoolData = {
+    pool_type: {
+        name: string;
+    };
+    points: OriginBorrowIncentivePoolPointData[];
+    min_stakes: string;
+    max_stakes: string;
+    stakes: string;
+    created_at: string;
+};
+type ParsedBorrowIncentivePoolPointData = {
+    pointType: string;
+    distributedPointPerPeriod: number;
+    period: number;
+    distributedPoint: number;
+    points: number;
+    index: number;
+    baseWeight: number;
+    weightedAmount: number;
+    lastUpdate: number;
+    createdAt: number;
+};
+type ParsedBorrowIncentivePoolData = {
+    poolType: string;
+    poolPoints: OptionalKeys$4<Record<SupportBorrowIncentiveRewardCoins, ParsedBorrowIncentivePoolPointData>>;
+    minStakes: number;
+    maxStakes: number;
+    staked: number;
+};
+type CalculatedBorrowIncentivePoolPointData = {
+    baseWeight: number;
+    weightedStakedAmount: number;
+    weightedStakedCoin: number;
+    weightedStakedValue: number;
+    distributedPointPerSec: number;
+    accumulatedPoints: number;
+    currentPointIndex: number;
+    currentTotalDistributedPoint: number;
+    rewardApr: number;
+    rewardPerSec: number;
+};
+type BorrowIncentiveAccounts = OptionalKeys$4<Record<SupportBorrowIncentiveCoins, ParsedBorrowIncentiveAccountData>>;
+type OriginBorrowIncentiveAccountPoolData = {
+    point_type: {
+        name: string;
+    };
+    weighted_amount: string;
+    points: string;
+    total_points: string;
+    index: string;
+};
+type OriginBorrowIncentiveAccountData = {
+    points_list: OriginBorrowIncentiveAccountPoolData[];
+    pool_type: {
+        name: string;
+    };
+    debt_amount: string;
+};
+type ParsedBorrowIncentiveAccountPoolData = {
+    pointType: string;
+    weightedAmount: number;
+    points: number;
+    totalPoints: number;
+    index: number;
+};
+type ParsedBorrowIncentiveAccountData = {
+    pointList: OptionalKeys$4<Record<SupportBorrowIncentiveRewardCoins, ParsedBorrowIncentiveAccountPoolData>>;
+    poolType: string;
+    debtAmount: number;
+};
+/**
+ * The query interface for `incentive_pools_query::incentive_pools_data` inspectTxn.
+ */
+interface BorrowIncentivePoolsQueryInterface {
+    incentive_pools: OriginBorrowIncentivePoolData[];
+}
+/**
+ * The query interface for `incentive_account_query::incentive_account_data` inspectTxn.
+ */
+interface BorrowIncentiveAccountsQueryInterface {
+    pool_records: OriginBorrowIncentiveAccountData[];
+}
+
+type OptionalKeys$3<T> = {
+    [K in keyof T]?: T[K];
+};
+type MarketPools = OptionalKeys$3<Record<SupportPoolCoins, MarketPool>>;
+type MarketCollaterals = OptionalKeys$3<Record<SupportCollateralCoins, MarketCollateral>>;
+type CoinAmounts = OptionalKeys$3<Record<SupportPoolCoins, number>>;
+type MarketCoinAmounts = OptionalKeys$3<Record<SupportMarketCoins, number>>;
+type SCoinAmounts = OptionalKeys$3<Record<SupportSCoin, number>>;
+type BalanceSheet = {
+    cash: string;
+    debt: string;
+    market_coin_supply: string;
+    revenue: string;
+};
+type BorrowDynamic = {
+    borrow_index: string;
+    interest_rate: {
+        fields: {
+            value: string;
+        };
+    };
+    interest_rate_scale: string;
+    last_updated: string;
+};
+type BorrowFee = {
+    value: string;
+};
+type InterestModel = {
+    base_borrow_rate_per_sec: {
+        fields: {
+            value: string;
+        };
+    };
+    borrow_rate_on_high_kink: {
+        fields: {
+            value: string;
+        };
+    };
+    borrow_rate_on_mid_kink: {
+        fields: {
+            value: string;
+        };
+    };
+    borrow_weight: {
+        fields: {
+            value: string;
+        };
+    };
+    borrow_fee_rate: {
+        fields: {
+            value: string;
+        };
+    };
+    high_kink: {
+        fields: {
+            value: string;
+        };
+    };
+    interest_rate_scale: string;
+    max_borrow_rate: {
+        fields: {
+            value: string;
+        };
+    };
+    mid_kink: {
+        fields: {
+            value: string;
+        };
+    };
+    min_borrow_amount: string;
+    revenue_factor: {
+        fields: {
+            value: string;
+        };
+    };
+    type: {
+        fields: {
+            name: string;
+        };
+    };
+};
+type RiskModel = {
+    collateral_factor: {
+        fields: {
+            value: string;
+        };
+    };
+    liquidation_discount: {
+        fields: {
+            value: string;
+        };
+    };
+    liquidation_factor: {
+        fields: {
+            value: string;
+        };
+    };
+    liquidation_penalty: {
+        fields: {
+            value: string;
+        };
+    };
+    liquidation_revenue_factor: {
+        fields: {
+            value: string;
+        };
+    };
+    max_collateral_amount: string;
+    type: {
+        fields: {
+            name: string;
+        };
+    };
+};
+type CollateralStat = {
+    amount: string;
+};
+type MarketPool = {
+    coinName: SupportPoolCoins;
+    symbol: string;
+    coinType: string;
+    marketCoinType: string;
+    sCoinType: string;
+    coinWrappedType: CoinWrappedType;
+    coinDecimal: number;
+    coinPrice: number;
+    maxSupplyCoin: number;
+    maxBorrowCoin: number;
+    isIsolated: boolean;
+} & Required<Pick<ParsedMarketPoolData, 'highKink' | 'midKink' | 'reserveFactor' | 'borrowWeight' | 'borrowFee' | 'marketCoinSupplyAmount' | 'minBorrowAmount'>> & CalculatedMarketPoolData;
+type MarketCollateral = {
+    coinName: SupportCollateralCoins;
+    symbol: string;
+    coinType: string;
+    marketCoinType: string;
+    coinWrappedType: CoinWrappedType;
+    coinDecimal: number;
+    coinPrice: number;
+    isIsolated: boolean;
+} & Required<Pick<ParsedMarketCollateralData, 'collateralFactor' | 'liquidationFactor' | 'liquidationDiscount' | 'liquidationPenalty' | 'liquidationReserveFactor'>> & CalculatedMarketCollateralData;
+type OriginMarketPoolData = {
+    type: {
+        name: string;
+    };
+    maxBorrowRate: {
+        value: string;
+    };
+    interestRate: {
+        value: string;
+    };
+    interestRateScale: string;
+    borrowIndex: string;
+    lastUpdated: string;
+    cash: string;
+    debt: string;
+    marketCoinSupply: string;
+    reserve: string;
+    reserveFactor: {
+        value: string;
+    };
+    borrowWeight: {
+        value: string;
+    };
+    borrowFeeRate: {
+        value: string;
+    };
+    baseBorrowRatePerSec: {
+        value: string;
+    };
+    borrowRateOnHighKink: {
+        value: string;
+    };
+    borrowRateOnMidKink: {
+        value: string;
+    };
+    highKink: {
+        value: string;
+    };
+    midKink: {
+        value: string;
+    };
+    minBorrowAmount: string;
+    isIsolated: boolean;
+    supplyLimit: string;
+    borrowLimit: string;
+};
+type ParsedMarketPoolData = {
+    coinType: string;
+    maxBorrowRate: number;
+    borrowRate: number;
+    borrowRateScale: number;
+    borrowIndex: number;
+    lastUpdated: number;
+    cashAmount: number;
+    debtAmount: number;
+    marketCoinSupplyAmount: number;
+    reserveAmount: number;
+    reserveFactor: number;
+    borrowWeight: number;
+    borrowFee: number;
+    baseBorrowRate: number;
+    borrowRateOnHighKink: number;
+    borrowRateOnMidKink: number;
+    highKink: number;
+    midKink: number;
+    minBorrowAmount: number;
+    isIsolated: boolean;
+    supplyLimit: number;
+    borrowLimit: number;
+};
+type CalculatedMarketPoolData = {
+    baseBorrowApr: number;
+    baseBorrowApy: number;
+    borrowAprOnHighKink: number;
+    borrowApyOnHighKink: number;
+    borrowAprOnMidKink: number;
+    borrowApyOnMidKink: number;
+    coinDecimal: number;
+    conversionRate: number;
+    maxBorrowApr: number;
+    maxBorrowApy: number;
+    borrowApr: number;
+    borrowApy: number;
+    borrowIndex: number;
+    growthInterest: number;
+    supplyAmount: number;
+    supplyCoin: number;
+    borrowAmount: number;
+    borrowCoin: number;
+    reserveAmount: number;
+    reserveCoin: number;
+    utilizationRate: number;
+    supplyApr: number;
+    supplyApy: number;
+    isIsolated: boolean;
+    maxSupplyCoin: number;
+    maxBorrowCoin: number;
+};
+type OriginMarketCollateralData = {
+    type: {
+        name: string;
+    };
+    isIsolated: boolean;
+    collateralFactor: {
+        value: string;
+    };
+    liquidationFactor: {
+        value: string;
+    };
+    liquidationDiscount: {
+        value: string;
+    };
+    liquidationPenalty: {
+        value: string;
+    };
+    liquidationReserveFactor: {
+        value: string;
+    };
+    maxCollateralAmount: string;
+    totalCollateralAmount: string;
+};
+type ParsedMarketCollateralData = {
+    coinType: string;
+    collateralFactor: number;
+    liquidationFactor: number;
+    liquidationDiscount: number;
+    liquidationPenalty: number;
+    liquidationReserveFactor: number;
+    maxCollateralAmount: number;
+    totalCollateralAmount: number;
+    isIsolated: boolean;
+};
+type CalculatedMarketCollateralData = {
+    coinDecimal: number;
+    isIsolated: boolean;
+    maxDepositAmount: number;
+    maxDepositCoin: number;
+    depositAmount: number;
+    depositCoin: number;
+};
+type Market = {
+    pools: MarketPools;
+    collaterals: MarketCollaterals;
+    data?: MarketQueryInterface;
+};
+type Obligation = {
+    id: string;
+    keyId: string;
+    locked: boolean;
+};
+/**
+ * The query interface for `market_query::market_data` inspectTxn.
+ */
+interface MarketQueryInterface {
+    collaterals: {
+        collateralFactor: {
+            value: string;
+        };
+        liquidationDiscount: {
+            value: string;
+        };
+        liquidationFactor: {
+            value: string;
+        };
+        liquidationPanelty: {
+            value: string;
+        };
+        liquidationReserveFactor: {
+            value: string;
+        };
+        maxCollateralAmount: string;
+        totalCollateralAmount: string;
+        type: {
+            name: string;
+        };
+    }[];
+    pools: {
+        baseBorrowRatePerSec: {
+            value: string;
+        };
+        borrowRateOnHighKink: {
+            value: string;
+        };
+        borrowRateOnMidKink: {
+            value: string;
+        };
+        maxBorrowRate: {
+            value: string;
+        };
+        highKink: {
+            value: string;
+        };
+        midKink: {
+            value: string;
+        };
+        interestRate: {
+            value: string;
+        };
+        interestRateScale: string;
+        borrowIndex: string;
+        lastUpdated: string;
+        cash: string;
+        debt: string;
+        marketCoinSupply: string;
+        minBorrowAmount: string;
+        reserve: string;
+        reserveFactor: {
+            value: string;
+        };
+        borrowWeight: {
+            value: string;
+        };
+        borrowFeeRate: {
+            value: string;
+        };
+        type: {
+            name: string;
+        };
+    }[];
+}
+/**
+ * The query interface for `obligation_query::obligation_data` inspectTxn.
+ */
+interface ObligationQueryInterface {
+    collaterals: {
+        type: {
+            name: string;
+        };
+        amount: string;
+    }[];
+    debts: {
+        type: {
+            name: string;
+        };
+        amount: string;
+        borrowIndex: string;
+    }[];
+}
+
+type LoyaltyProgramInfo = {
+    pendingReward: number;
+    totalPoolReward: number;
+    isClaimEnabled: boolean;
+};
+
+type OptionalKeys$2<T> = {
+    [K in keyof T]?: T[K];
+};
+type Spools = OptionalKeys$2<Record<SupportStakeMarketCoins, Spool>>;
+type Spool = {
+    marketCoinName: SupportStakeMarketCoins;
+    symbol: string;
+    coinType: string;
+    marketCoinType: string;
+    rewardCoinType: string;
+    sCoinType: string;
+    coinDecimal: number;
+    rewardCoinDecimal: number;
+    coinPrice: number;
+    marketCoinPrice: number;
+    rewardCoinPrice: number;
+} & Required<Pick<ParsedSpoolData, 'maxPoint' | 'distributedPoint' | 'maxStake'>> & CalculatedSpoolData & SpoolRewardPool;
+type OriginSpoolData = {
+    stakeType: {
+        fields: {
+            name: string;
+        };
+    };
+    maxDistributedPoint: string;
+    distributedPoint: string;
+    distributedPointPerPeriod: string;
+    pointDistributionTime: string;
+    maxStake: string;
+    stakes: string;
+    index: string;
+    createdAt: string;
+    lastUpdate: string;
+};
+type SpoolData = {
+    created_at: string;
+    distributed_point: string;
+    distributed_point_per_period: string;
+    id: {
+        id: string;
+    };
+    index: string;
+    last_update: string;
+    max_distributed_point: string;
+    max_stakes: string;
+    point_distribution_time: string;
+    stake_type: {
+        type: string;
+        fields: {
+            name: string;
+        };
+    };
+    stakes: string;
+};
+type ParsedSpoolData = {
+    stakeType: string;
+    maxPoint: number;
+    distributedPoint: number;
+    pointPerPeriod: number;
+    period: number;
+    maxStake: number;
+    staked: number;
+    index: number;
+    createdAt: number;
+    lastUpdate: number;
+};
+type CalculatedSpoolData = {
+    stakedAmount: number;
+    stakedCoin: number;
+    stakedValue: number;
+    distributedPointPerSec: number;
+    accumulatedPoints: number;
+    currentPointIndex: number;
+    currentTotalDistributedPoint: number;
+    startDate: Date;
+    endDate: Date;
+};
+type SpoolRewardPool = Required<Pick<ParsedSpoolRewardPoolData, 'exchangeRateNumerator' | 'exchangeRateDenominator'>> & CalculatedSpoolRewardPoolData;
+type OriginSpoolRewardPoolData = {
+    claimed_rewards: string;
+    exchange_rate_denominator: string;
+    exchange_rate_numerator: string;
+    rewards: string;
+    spool_id: string;
+};
+type ParsedSpoolRewardPoolData = {
+    claimedRewards: number;
+    exchangeRateDenominator: number;
+    exchangeRateNumerator: number;
+    rewards: number;
+    spoolId: string;
+};
+type CalculatedSpoolRewardPoolData = {
+    rewardApr: number;
+    totalRewardAmount: number;
+    totalRewardCoin: number;
+    totalRewardValue: number;
+    remaindRewardAmount: number;
+    remaindRewardCoin: number;
+    remaindRewardValue: number;
+    claimedRewardAmount: number;
+    claimedRewardCoin: number;
+    claimedRewardValue: number;
+    rewardPerSec: number;
+};
+type StakePools = OptionalKeys$2<Record<SupportStakeMarketCoins, StakePool>>;
+type StakeRewardPools = OptionalKeys$2<Record<SupportStakeMarketCoins, StakeRewardPool>>;
+type StakeAccounts = Record<SupportStakeMarketCoins, StakeAccount[]>;
+interface StakeAccount {
+    id: string;
+    type: string;
+    stakePoolId: string;
+    stakeType: string;
+    staked: number;
+    index: number;
+    points: number;
+    totalPoints: number;
+}
+interface StakePool {
+    id: string;
+    type: string;
+    maxPoint: number;
+    distributedPoint: number;
+    pointPerPeriod: number;
+    period: number;
+    maxStake: number;
+    stakeType: string;
+    totalStaked: number;
+    index: number;
+    createdAt: number;
+    lastUpdate: number;
+}
+interface StakeRewardPool {
+    id: string;
+    type: string;
+    stakePoolId: string;
+    ratioDenominator: number;
+    ratioNumerator: number;
+    rewards: number;
+    claimedRewards: number;
+}
+
+type OptionalKeys$1<T> = {
+    [K in keyof T]?: T[K];
+};
+type Lendings = OptionalKeys$1<Record<SupportPoolCoins, Lending>>;
+type ObligationAccounts = OptionalKeys$1<Record<string, ObligationAccount>>;
+type Lending = Required<Pick<MarketPool, 'coinName' | 'symbol' | 'coinType' | 'marketCoinType' | 'sCoinType' | 'coinDecimal' | 'coinPrice' | 'conversionRate' | 'isIsolated'> & Pick<Spool, 'marketCoinPrice'>> & {
+    supplyApr: number;
+    supplyApy: number;
+    rewardApr: number;
+    suppliedAmount: number;
+    suppliedCoin: number;
+    suppliedValue: number;
+    stakedMarketAmount: number;
+    stakedMarketCoin: number;
+    stakedAmount: number;
+    stakedCoin: number;
+    stakedValue: number;
+    unstakedMarketAmount: number;
+    unstakedMarketCoin: number;
+    unstakedAmount: number;
+    unstakedCoin: number;
+    unstakedValue: number;
+    availableSupplyAmount: number;
+    availableSupplyCoin: number;
+    availableWithdrawAmount: number;
+    availableWithdrawCoin: number;
+    availableStakeAmount: number;
+    availableStakeCoin: number;
+    availableUnstakeAmount: number;
+    availableUnstakeCoin: number;
+    availableClaimAmount: number;
+    availableClaimCoin: number;
+};
+type ObligationAccount = {
+    obligationId: string;
+    totalDepositedValue: number;
+    totalBorrowedValue: number;
+    totalBalanceValue: number;
+    totalBorrowCapacityValue: number;
+    totalAvailableCollateralValue: number;
+    totalBorrowedValueWithWeight: number;
+    totalRequiredCollateralValue: number;
+    totalUnhealthyCollateralValue: number;
+    totalRiskLevel: number;
+    totalDepositedPools: number;
+    totalBorrowedPools: number;
+    totalRewardedPools: number;
+    collaterals: OptionalKeys$1<Record<SupportCollateralCoins, ObligationCollateral>>;
+    debts: OptionalKeys$1<Record<SupportPoolCoins, ObligationDebt>>;
+    borrowIncentives: OptionalKeys$1<Record<SupportPoolCoins, ObligationBorrowIncentive>>;
+};
+type ObligationCollateral = {
+    coinName: SupportCollateralCoins;
+    coinType: string;
+    symbol: string;
+    coinDecimal: number;
+    coinPrice: number;
+    depositedAmount: number;
+    depositedCoin: number;
+    depositedValue: number;
+    borrowCapacityValue: number;
+    requiredCollateralValue: number;
+    availableDepositAmount: number;
+    availableDepositCoin: number;
+    availableWithdrawAmount: number;
+    availableWithdrawCoin: number;
+};
+type ObligationDebt = {
+    coinName: SupportPoolCoins;
+    coinType: string;
+    symbol: string;
+    coinDecimal: number;
+    coinPrice: number;
+    borrowedAmount: number;
+    borrowedCoin: number;
+    borrowedValue: number;
+    borrowedValueWithWeight: number;
+    borrowIndex: number;
+    requiredRepayAmount: number;
+    requiredRepayCoin: number;
+    availableBorrowAmount: number;
+    availableBorrowCoin: number;
+    availableRepayAmount: number;
+    availableRepayCoin: number;
+};
+type ObligationBorrowIcentiveReward = {
+    coinName: SupportBorrowIncentiveRewardCoins;
+    coinType: string;
+    symbol: string;
+    coinDecimal: number;
+    coinPrice: number;
+    availableClaimCoin: number;
+    availableClaimAmount: number;
+    boostValue: number;
+};
+type ObligationBorrowIncentive = {
+    coinName: SupportPoolCoins;
+    coinType: string;
+    symbol: string;
+    coinDecimal: number;
+    coinPrice: number;
+    rewards: ObligationBorrowIcentiveReward[];
+};
+type TotalValueLocked = {
+    supplyLendingValue: number;
+    supplyCollateralValue: number;
+    supplyValue: number;
+    borrowValue: number;
+    totalValue: number;
+    supplyValueChangeRatio?: number;
+    supplyLendingValueChangeRatio?: number;
+    supplyCollateralValueChangeRatio?: number;
+    borrowValueChangeRatio?: number;
+    totalValueChangeRatio?: number;
+};
+
+type sCoinBalance = number;
+
+type Vesca = {
+    id: string;
+    keyId: string;
+    keyObject?: SuiObjectRef;
+    object: SuiObjectRef;
+    lockedScaAmount: string;
+    lockedScaCoin: number;
+    currentVeScaBalance: number;
+    unlockAt: number;
+};
+type VeScaTreasuryFields = {
+    total_ve_sca_amount: string;
+    sca_balance: string;
+    unlock_schedule: {
+        fields: {
+            locked_sca_amount: string;
+        };
+    };
+};
+type VeScaTreasuryInfo = {
+    totalLockedSca: number;
+    totalVeSca: number;
+    averageLockingPeriod: number;
+    averageLockingPeriodUnit: string;
+};
+
+interface AddressesInterface {
+    core: {
+        version: string;
+        versionCap: string;
+        object: string;
+        market: string;
+        adminCap: string;
+        coinDecimalsRegistry: string;
+        obligationAccessStore: string;
+        coins: Partial<Record<SupportAssetCoins, {
+            id: string;
+            treasury: string;
+            metaData: string;
+            oracle: {
+                [K in SupportOracleType]: K extends (typeof SUPPORT_ORACLES)[0] ? string : K extends (typeof SUPPORT_ORACLES)[1] ? string : K extends (typeof SUPPORT_ORACLES)[2] ? {
+                    feed: string;
+                    feedObject: string;
+                } : never;
+            };
+        }>>;
+        oracles: {
+            [K in SupportOracleType]: K extends (typeof SUPPORT_ORACLES)[0] ? {
+                registry: string;
+                registryCap: string;
+                holder: string;
+            } : K extends (typeof SUPPORT_ORACLES)[1] ? {
+                registry: string;
+                registryCap: string;
+            } : K extends (typeof SUPPORT_ORACLES)[2] ? {
+                registry: string;
+                registryCap: string;
+                state: string;
+                wormhole: string;
+                wormholeState: string;
+            } : never;
+        } & {
+            xOracle: string;
+            xOracleCap: string;
+        };
+        packages: Partial<Record<SupportPackageType, {
+            id: string;
+            object?: string;
+            upgradeCap: string;
+        }>>;
+    };
+    spool: {
+        id: string;
+        adminCap: string;
+        object: string;
+        config: string;
+        pools: Partial<Record<SupportStakeMarketCoins, {
+            id: string;
+            rewardPoolId: string;
+        }>>;
+    };
+    borrowIncentive: {
+        id: string;
+        adminCap: string;
+        object: string;
+        query: string;
+        config: string;
+        incentivePools: string;
+        incentiveAccounts: string;
+    };
+    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;
+    };
+    loyaltyProgram: {
+        id: string;
+        object: string;
+        rewardPool: string;
+        userRewardTableId: string;
+    };
+    scoin: {
+        id: string;
+        coins: Partial<Record<SupportSCoin, {
+            coinType: string;
+            treasury: string;
+            metaData: string;
+        }>>;
+    };
+}
+type AddressPathsProps<T> = T extends string ? [] : {
+    [K in Extract<keyof T, string>]: [K, ...AddressPathsProps<T[K]>];
+}[Extract<keyof T, string>];
+type Join<T extends string[], D extends string> = T extends [] ? never : T extends [infer F] ? F : T extends [infer F, ...infer R] ? F extends string ? `${F}${D}${Join<Extract<R, string[]>, D>}` : never : string;
+type AddressStringPath = Join<AddressPathsProps<AddressesInterface>, '.'>;
+
+type ScallopClientFnReturnType<T extends boolean> = T extends true ? SuiTransactionBlockResponse : Transaction;
+type ScallopClientVeScaReturnType<T extends boolean> = T extends true ? SuiTransactionBlockResponse : {
+    tx: Transaction;
+    scaCoin: TransactionResult;
+};
+type ScallopBaseInstanceParams = {
+    suiKit?: SuiKit;
+};
+type ScallopCacheInstanceParams = ScallopBaseInstanceParams & {
+    queryClient?: QueryClient;
+};
+type ScallopAddressInstanceParams = ScallopBaseInstanceParams & {
+    cache?: ScallopCache;
+};
+type ScallopIndexerInstanceParams = {
+    cache?: ScallopCache;
+};
+type ScallopUtilsInstanceParams = ScallopBaseInstanceParams & {
+    address?: ScallopAddress;
+};
+type ScallopQueryInstanceParams = ScallopBaseInstanceParams & {
+    utils?: ScallopUtils;
+    indexer?: ScallopIndexer;
+};
+type ScallopBuilderInstanceParams = ScallopBaseInstanceParams & {
+    query?: ScallopQuery;
+};
+type ScallopClientInstanceParams = ScallopBaseInstanceParams & {
+    builder?: ScallopBuilder;
+};
+type ScallopAddressParams = {
+    id: string;
+    auth?: string;
+    network?: NetworkType;
+    forceInterface?: Partial<Record<NetworkType, AddressesInterface>>;
+};
+type ScallopParams = {
+    addressesId?: string;
+    forceAddressesInterface?: Partial<Record<NetworkType, AddressesInterface>>;
+    walletAddress?: string;
+} & SuiKitParams;
+type ScallopClientParams = ScallopParams & ScallopBuilderParams & ScallopQueryParams & ScallopUtilsParams & ScallopCacheParams;
+type ScallopBuilderParams = ScallopParams & {
+    pythEndpoints?: string[];
+    usePythPullModel?: boolean;
+} & ScallopQueryParams;
+type ScallopQueryParams = ScallopParams & ScallopUtilsParams;
+type ScallopUtilsParams = ScallopParams & {
+    pythEndpoints?: string[];
+};
+type ScallopCacheParams = Omit<ScallopParams, 'addressId' | 'forceAddressesInterface'> & {
+    cacheOptions?: QueryClientConfig;
+};
+
+type OptionalKeys<T> = {
+    [K in keyof T]?: T[K];
+};
+type CoinPrices = OptionalKeys<Record<SupportCoins, number>>;
+type PoolAddressInfo = {
+    name: string;
+    coingeckoId: string;
+    decimal: number;
+    pythFeedId: string;
+    lendingPoolAddress?: string;
+    collateralPoolAddress?: string;
+    borrowDynamic?: string;
+    interestModelId?: string;
+    borrowFeeKey?: string;
+    supplyLimitKey?: string;
+    borrowLimitKey?: string;
+    isolatedAssetKey?: string;
+    sCoinAddress: string | undefined;
+    marketCoinAddress: string;
+    sCoinName: string | undefined;
+};
+
+declare const coinDecimals: SupportCoinDecimals;
+declare const assetCoins: AssetCoins;
+declare const marketCoins: MarketCoins;
+declare const sCoins: SCoins;
+declare const stakeMarketCoins: StakeMarketCoins;
+declare const spoolRewardCoins: StakeRewardCoins;
+declare const suiBridgeCoins: SuiBridgeCoins;
+declare const coinIds: AssetCoinIds;
+declare const wormholeCoinIds: WormholeCoinIds;
+declare const voloCoinIds: VoloCoinIds;
+declare const sCoinIds: SCoinIds;
+declare const sCoinTypeToName: Record<string, "susdc" | "ssbeth" | "ssbusdt" | "ssbwbtc" | "sweth" | "swbtc" | "swusdc" | "swusdt" | "ssui" | "swsol" | "scetus" | "safsui" | "shasui" | "svsui" | "ssca" | "sfud" | "sdeep" | "sfdusd" | "sblub" | "smusd" | "sns" | "susdy">;
+declare const sCoinRawNameToName: Record<string, "susdc" | "ssbeth" | "ssbusdt" | "ssbwbtc" | "sweth" | "swbtc" | "swusdc" | "swusdt" | "ssui" | "swsol" | "scetus" | "safsui" | "shasui" | "svsui" | "ssca" | "sfud" | "sdeep" | "sfdusd" | "sblub" | "smusd" | "sns" | "susdy">;
+
+declare const FlashLoanFeeObjectMap: OptionalKeys<Record<SupportPoolCoins, string>>;
+
+declare const POOL_ADDRESSES: OptionalKeys<Record<SupportPoolCoins, {
+    coinName: string;
+    symbol: string;
+    coinType: string;
+    lendingPoolAddress: string;
+    borrowDynamic: string;
+    interestModel: string;
+    borrowFeeKey: string;
+    coinMetadataId: string;
+    decimals: number;
+    pythFeed: string;
+    pythFeedObjectId: string;
+    collateralPoolAddress?: string;
+    riskModel?: string;
+    supplyLimitKey?: string;
+    borrowLimitKey?: string;
+    sCoinType?: string;
+    sCoinName?: string;
+    sCoinSymbol?: string;
+    sCoinMetadataId?: string;
+    sCoinTreasury?: string;
+    isolatedAssetKey?: string;
+    spool?: string;
+    spoolReward?: string;
+    spoolName?: string;
+}>>;
+
+declare const PYTH_ENDPOINTS: {
+    [k in 'mainnet' | 'testnet']: string[];
+};
+declare const PYTH_FEED_IDS: Record<SupportPoolCoins, string>;
+
+declare const queryKeys: {
+    api: {
+        getAddresses: (addressesId?: string) => (string | {
+            addressesId: string | undefined;
+        })[];
+        getMarket: () => string[];
+        getSpools: () => string[];
+        getBorrowIncentivePool: () => string[];
+        getTotalValueLocked: () => string[];
+    };
+    rpc: {
+        getInspectTxn: (queryTarget?: string, args?: SuiObjectArg[], typeArgs?: any[]) => (string | {
+            queryTarget: string | undefined;
+            args: string;
+            typeArgs: string | undefined;
+        })[];
+        getObject: (objectId?: string, options?: SuiObjectDataOptions) => (string | {
+            objectId: string | undefined;
+            options: SuiObjectDataOptions | undefined;
+        })[];
+        getObjects: (objectIds?: string[]) => (string | {
+            objectIds: string;
+        })[];
+        getOwnedObjects: (input?: Partial<GetOwnedObjectsParams>) => (string | {
+            walletAddress: string | undefined;
+            cursor: string | undefined;
+            options: SuiObjectDataOptions | undefined;
+            filter: string;
+            limit: number | undefined;
+        })[];
+        getDynamicFields: (input?: Partial<GetDynamicFieldsParams>) => (string | {
+            parentId: string | undefined;
+            cursor: string | undefined;
+            limit: number | undefined;
+        })[];
+        getDynamicFieldObject: (input?: Partial<GetDynamicFieldObjectParams>) => (string | {
+            parentId: string | undefined;
+            name: string;
+        })[];
+        getTotalVeScaTreasuryAmount: (refreshArgs?: any[], vescaAmountArgs?: (string | SuiObjectData | SuiTxArg)[]) => (string | {
+            refreshArgs: string;
+            vescaAmountArgs: string;
+        })[];
+        getAllCoinBalances: (owner?: string) => (string | {
+            owner: string | undefined;
+        })[];
+        getNormalizedMoveFunction: (target?: string) => (string | undefined)[];
+    };
+    oracle: {
+        getPythLatestPriceFeeds: () => string[];
+    };
+};
+
+declare const RPC_PROVIDERS: string[];
+
+declare const TEST_ADDRESSES: AddressesInterface;
+
+declare const UNLOCK_ROUND_DURATION: number;
+declare const MAX_LOCK_ROUNDS: 1460;
+declare const MAX_LOCK_DURATION: number;
+declare const MIN_INITIAL_LOCK_AMOUNT: 10000000000;
+declare const MIN_TOP_UP_AMOUNT: 1000000000;
+
+declare const xOracleList: xOracleListType;
+
+export { ADDRESSES_ID, API_BASE_URL, type AddressStringPath, type AddressesInterface, type AssetCoinIds, type AssetCoins, BORROW_FEE_PROTOCOL_ID, type BalanceSheet, type BaseScallopTxBlock, type BorrowDynamic, type BorrowFee, type BorrowIncentiveAccountKey, type BorrowIncentiveAccounts, type BorrowIncentiveAccountsQueryInterface, type BorrowIncentiveIds, type BorrowIncentiveNormalMethods, type BorrowIncentivePool, type BorrowIncentivePoolPoints, type BorrowIncentivePools, type BorrowIncentivePoolsQueryInterface, type BorrowIncentiveQuickMethods, type BorrowIncentiveRewardCoins, type BorrowIncentiveTxBlock, COIN_GECKGO_IDS, type CalculatedBorrowIncentivePoolPointData, type CalculatedMarketCollateralData, type CalculatedMarketPoolData, type CalculatedSpoolData, type CalculatedSpoolRewardPoolData, type CoinAmounts, type CoinPrices, type CoinWrappedType, type Coins, type CollateralStat, type CoreIds, type CoreNormalMethods, type CoreQuickMethods, type CoreTxBlock, DEFAULT_CACHE_OPTIONS, FlashLoanFeeObjectMap, type GenerateBorrowIncentiveNormalMethod, type GenerateBorrowIncentiveQuickMethod, type GenerateCoreNormalMethod, type GenerateCoreQuickMethod, type GenerateLoyaltyProgramNormalMethod, type GenerateLoyaltyProgramQuickMethod, type GenerateSCoinNormalMethod, type GenerateSCoinQuickMethod, type GenerateSpoolNormalMethod, type GenerateSpoolQuickMethod, type GenerateVeScaNormalMethod, type GenerateVeScaQuickMethod, IS_VE_SCA_TEST, type InterestModel, type Lending, type Lendings, type LoyaltyProgramIds, type LoyaltyProgramInfo, type LoyaltyProgramNormalMethods, type LoyaltyProgramQuickMethods, type LoyaltyProgramTxBlock, MAX_LOCK_DURATION, MAX_LOCK_ROUNDS, MIN_INITIAL_LOCK_AMOUNT, MIN_TOP_UP_AMOUNT, type Market, type MarketCoinAmounts, type MarketCoins, type MarketCollateral, type MarketCollaterals, type MarketPool, type MarketPools, type MarketQueryInterface, type NestedResult, OLD_BORROW_INCENTIVE_PROTOCOL_ID, type Obligation, type ObligationAccount, type ObligationAccounts, type ObligationBorrowIcentiveReward, type ObligationBorrowIncentive, type ObligationCollateral, type ObligationDebt, type ObligationQueryInterface, type OptionalKeys, type OriginBorrowIncentiveAccountData, type OriginBorrowIncentiveAccountPoolData, type OriginBorrowIncentivePoolData, type OriginBorrowIncentivePoolPointData, type OriginMarketCollateralData, type OriginMarketPoolData, type OriginSpoolData, type OriginSpoolRewardPoolData, POOL_ADDRESSES, PROTOCOL_OBJECT_ID, PYTH_ENDPOINTS, PYTH_FEED_IDS, type ParsedBorrowIncentiveAccountData, type ParsedBorrowIncentiveAccountPoolData, type ParsedBorrowIncentivePoolData, type ParsedBorrowIncentivePoolPointData, type ParsedMarketCollateralData, type ParsedMarketPoolData, type ParsedSpoolData, type ParsedSpoolRewardPoolData, type PoolAddressInfo, RPC_PROVIDERS, type RedeemScaQuickReturnType, type RiskModel, SCA_COIN_TYPE, type SCoinAmounts, type SCoinConverterTreasury, type SCoinIds, type SCoinTreasuryCaps, type SCoinTxBlock, type SCoins, SDK_API_BASE_URL, SUPPORT_BORROW_INCENTIVE_POOLS, SUPPORT_BORROW_INCENTIVE_REWARDS, SUPPORT_COLLATERALS, SUPPORT_ORACLES, SUPPORT_PACKAGES, SUPPORT_POOLS, SUPPORT_SCOIN, SUPPORT_SPOOLS, SUPPORT_SPOOLS_REWARDS, SUPPORT_SUI_BRIDGE, SUPPORT_WORMHOLE, Scallop, ScallopAddress, type ScallopAddressInstanceParams, type ScallopAddressParams, type ScallopBaseInstanceParams, ScallopBuilder, type ScallopBuilderInstanceParams, type ScallopBuilderParams, ScallopCache, type ScallopCacheInstanceParams, type ScallopCacheParams, ScallopClient, type ScallopClientFnReturnType, type ScallopClientInstanceParams, type ScallopClientParams, type ScallopClientVeScaReturnType, ScallopIndexer, type ScallopIndexerInstanceParams, type ScallopParams, ScallopQuery, type ScallopQueryInstanceParams, type ScallopQueryParams, type ScallopTxBlock, ScallopUtils, type ScallopUtilsInstanceParams, type ScallopUtilsParams, type SelectCoinReturnType, type Spool, type SpoolData, type SpoolIds, type SpoolNormalMethods, type SpoolQuickMethods, type SpoolRewardPool, type SpoolTxBlock, type Spools, type StakeAccount, type StakeAccounts, type StakeMarketCoins, type StakePool, type StakePools, type StakeRewardCoins, type StakeRewardPool, type StakeRewardPools, type SuiBridgeCoins, type SuiBridgedCoinPackageIds, type SuiTxBlockWithBorrowIncentiveNormalMethods, type SuiTxBlockWithCoreNormalMethods, type SuiTxBlockWithLoyaltyProgramNormalMethods, type SuiTxBlockWithSCoin, type SuiTxBlockWithSCoinNormalMethods, type SuiTxBlockWithSpool, type SuiTxBlockWithSpoolNormalMethods, type SuiTxBlockWithVeScaNormalMethods, type SupportAssetCoins, type SupportBorrowIncentiveCoins, type SupportBorrowIncentiveRewardCoins, type SupportCoinDecimals, type SupportCoins, type SupportCollateralCoins, type SupportMarketCoins, type SupportOracleType, type SupportPackageType, type SupportPoolCoins, type SupportSCoin, type SupportStakeCoins, type SupportStakeMarketCoins, type SupportStakeRewardCoins, type SupportSuiBridgeCoins, type SupportWormholeCoins, TEST_ADDRESSES, type TotalValueLocked, UNLOCK_ROUND_DURATION, USE_TEST_ADDRESS, type VeScaNormalMethods, type VeScaQuickMethods, type VeScaTreasuryFields, type VeScaTreasuryInfo, type VeScaTxBlock, type Vesca, type VescaIds, type VoloCoinIds, type WormholeCoinIds, assetCoins, coinDecimals, coinIds, marketCoins, queryKeys, type sCoinBalance, sCoinIds, type sCoinNormalMethods, type sCoinPkgIds, type sCoinQuickMethods, sCoinRawNameToName, sCoinTypeToName, sCoins, spoolRewardCoins, stakeMarketCoins, suiBridgeCoins, voloCoinIds, wormholeCoinIds, xOracleList, type xOracleListType, type xOracleRuleType, type xOracleRules };