@scallop-io/sui-scallop-sdk 1.3.4-alpha.5 → 1.3.4-alpha.6

package/dist/models/scallopAddress.d.ts

@@ -1,150 +0,0 @@
-import { type NetworkType } from '@scallop-io/sui-kit';
-import { ScallopAddressParams, AddressesInterface, AddressStringPath, ScallopAddressInstanceParams } from 'src/types';
-import { ScallopCache } from './scallopCache';
-/**
- * @description
- * It provides methods for managing addresses.
- *
- * @example
- * ```typescript
- * const scallopAddress = new ScallopAddress(<parameters>);
- * scallopAddress.<address functions>();
- * await scallopAddress.<address async functions>();
- * ```
- */
-export 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>;
-}

package/dist/models/scallopBuilder.d.ts

@@ -1,89 +0,0 @@
-import { SuiKit } from '@scallop-io/sui-kit';
-import { ScallopAddress } from './scallopAddress';
-import { ScallopQuery } from './scallopQuery';
-import { ScallopUtils } from './scallopUtils';
-import type { SuiTransactionBlockResponse } from '@mysten/sui/client';
-import type { Transaction } from '@mysten/sui/transactions';
-import type { SuiTxBlock as SuiKitTxBlock } from '@scallop-io/sui-kit';
-import { ScallopBuilderParams, ScallopTxBlock, SupportMarketCoins, SupportAssetCoins, SupportSCoin, ScallopBuilderInstanceParams, SelectCoinReturnType } from 'src/types';
-import { ScallopCache } from './scallopCache';
-/**
- * @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>();
- * ```
- */
-export 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 | SuiKitTxBlock | 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 | SuiKitTxBlock, 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 | SuiKitTxBlock, marketCoinName: SupportMarketCoins, amount: number, sender?: string): Promise<{
-        takeCoin: import("@scallop-io/sui-kit").TransactionObjectArgument;
-        leftCoin: import("@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 | SuiKitTxBlock, sCoinName: SupportSCoin, amount: number, sender?: string): Promise<{
-        takeCoin: import("@scallop-io/sui-kit").TransactionObjectArgument;
-        leftCoin: import("@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 | SuiKitTxBlock | Transaction): Promise<SuiTransactionBlockResponse>;
-}

package/dist/models/scallopCache.d.ts

@@ -1,74 +0,0 @@
-import { QueryClient, QueryClientConfig } from '@tanstack/query-core';
-import { SuiObjectArg } from '@scallop-io/sui-kit';
-import { SuiKit } from '@scallop-io/sui-kit';
-import type { SuiObjectResponse, SuiObjectDataOptions, SuiObjectData, GetOwnedObjectsParams, DevInspectResults, GetDynamicFieldsParams, DynamicFieldPage, GetDynamicFieldObjectParams, GetBalanceParams } from '@mysten/sui/client';
-import { TokenBucket } from 'src/utils';
-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>();
- * ```
- */
-export declare class ScallopCache {
-    readonly queryClient: QueryClient;
-    readonly _suiKit: SuiKit;
-    private tokenBucket;
-    walletAddress: string;
-    constructor(suiKit: SuiKit, walletAddress?: string, cacheOptions?: QueryClientConfig, tokenBucket?: TokenBucket, queryClient?: QueryClient);
-    private get suiKit();
-    private get client();
-    /**
-     * @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.
-     */
-    invalidateAllCache(): Promise<Promise<void>[]>;
-    /**
-     * @description Provides cache for inspectTxn of the SuiKit.
-     * @param QueryInspectTxnParams
-     * @param txBlock
-     * @returns Promise<DevInspectResults>
-     */
-    queryInspectTxn({ queryTarget, args, typeArgs, }: QueryInspectTxnParams): Promise<DevInspectResults | 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[], options?: SuiObjectDataOptions): Promise<SuiObjectData[]>;
-    /**
-     * @description Provides cache for getOwnedObjects of the SuiKit.
-     * @param input
-     * @returns Promise<PaginatedObjectsResponse>
-     */
-    queryGetOwnedObjects(input: GetOwnedObjectsParams): Promise<import("@mysten/sui/client").PaginatedObjectsResponse | null>;
-    queryGetDynamicFields(input: GetDynamicFieldsParams): Promise<DynamicFieldPage | null>;
-    queryGetDynamicFieldObject(input: GetDynamicFieldObjectParams): Promise<SuiObjectResponse | null>;
-    queryGetAllCoinBalances(owner: string): Promise<{
-        [k: string]: string;
-    }>;
-    queryGetCoinBalance(input: GetBalanceParams): Promise<string>;
-}
-export {};

package/dist/models/scallopClient.d.ts

@@ -1,321 +0,0 @@
-import { SuiKit } from '@scallop-io/sui-kit';
-import { ScallopAddress } from './scallopAddress';
-import { ScallopUtils } from './scallopUtils';
-import { ScallopBuilder } from './scallopBuilder';
-import { ScallopQuery } from './scallopQuery';
-import type { SuiTransactionBlockResponse } from '@mysten/sui/client';
-import type { TransactionObjectArgument } from '@mysten/sui/transactions';
-import { ScallopCache } from './scallopCache';
-import type { SuiObjectArg } from '@scallop-io/sui-kit';
-import { ScallopClientFnReturnType, ScallopClientParams, SupportPoolCoins, SupportCollateralCoins, SupportAssetCoins, SupportStakeCoins, SupportStakeMarketCoins, SupportBorrowIncentiveCoins, ScallopTxBlock, ScallopClientVeScaReturnType, ScallopClientInstanceParams } from 'src/types';
-/**
- * @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>();
- * ```
- */
-export 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<import("src/types").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<import("src/types").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<import("src/types").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<import("src/types").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<import("src/types").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<import("src/types").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<import("src/types").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>>;
-    /**
-     * unstake market coin from the specific spool.
-     *
-     * @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
-     */
-    claimBorrowIncentive<S extends boolean>(coinName: SupportBorrowIncentiveCoins, 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>>;
-}