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

package/dist/models/scallopQuery.d.ts

@@ -0,0 +1,489 @@
+import { SuiKit } from '@scallop-io/sui-kit';
+import { ScallopQueryParams, SupportStakeMarketCoins, SupportAssetCoins, SupportPoolCoins, SupportCollateralCoins, SupportMarketCoins, SupportBorrowIncentiveCoins, SupportSCoin, ScallopQueryInstanceParams, MarketPool, CoinPrices, MarketPools } from '../types';
+import { ScallopAddress } from './scallopAddress';
+import { ScallopUtils } from './scallopUtils';
+import { ScallopIndexer } from './scallopIndexer';
+import { ScallopCache } from './scallopCache';
+import { SuiObjectData } from '@mysten/sui/client';
+/**
+ * @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>();
+ * ```
+ */
+export 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>;
+    /**
+     * Query market data.
+     * @param indexer - Whether to use indexer.
+     * @return Market data.
+     */
+    queryMarket(indexer?: boolean, args?: {
+        coinPrices: CoinPrices;
+    }): Promise<import("../types").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[], indexer?: boolean, args?: {
+        coinPrices?: CoinPrices;
+    }): Promise<{
+        usdc?: MarketPool | undefined;
+        sbeth?: MarketPool | undefined;
+        weth?: MarketPool | undefined;
+        wbtc?: MarketPool | undefined;
+        wusdc?: MarketPool | undefined;
+        wusdt?: MarketPool | undefined;
+        sui?: MarketPool | undefined;
+        wapt?: MarketPool | undefined;
+        wsol?: MarketPool | undefined;
+        cetus?: MarketPool | undefined;
+        afsui?: MarketPool | undefined;
+        hasui?: MarketPool | undefined;
+        vsui?: MarketPool | undefined;
+        sca?: MarketPool | undefined;
+    }>;
+    /**
+     * Get  market pool
+     *
+     * @param poolCoinName - Specific support pool coin name.
+     * @param indexer - Whether to use indexer.
+     * @return Market pool data.
+     */
+    getMarketPool(poolCoinName: SupportPoolCoins, indexer?: boolean, args?: {
+        marketObject?: SuiObjectData | null;
+        coinPrice?: number;
+    }): 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[], indexer?: boolean): Promise<{
+        usdc?: import("../types").MarketCollateral | undefined;
+        sbeth?: import("../types").MarketCollateral | undefined;
+        weth?: import("../types").MarketCollateral | undefined;
+        wbtc?: import("../types").MarketCollateral | undefined;
+        wusdc?: import("../types").MarketCollateral | undefined;
+        wusdt?: import("../types").MarketCollateral | undefined;
+        sui?: import("../types").MarketCollateral | undefined;
+        wapt?: import("../types").MarketCollateral | undefined;
+        wsol?: import("../types").MarketCollateral | undefined;
+        cetus?: import("../types").MarketCollateral | undefined;
+        afsui?: import("../types").MarketCollateral | undefined;
+        hasui?: import("../types").MarketCollateral | undefined;
+        vsui?: import("../types").MarketCollateral | undefined;
+        sca?: import("../types").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, indexer?: boolean): Promise<import("../types").MarketCollateral | undefined>;
+    /**
+     * Get obligations data.
+     *
+     * @param ownerAddress - The owner address.
+     * @return Obligations data.
+     */
+    getObligations(ownerAddress?: string): Promise<import("../types").Obligation[]>;
+    /**
+     * Query obligation data.
+     *
+     * @param obligationId - The obligation id.
+     * @return Obligation data.
+     */
+    queryObligation(obligationId: string): Promise<import("../types").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<import("../types").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<import("../types").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[], indexer?: boolean, args?: {
+        marketPools?: MarketPools;
+        coinPrices?: CoinPrices;
+    }): Promise<{
+        susdc?: import("../types").Spool | undefined;
+        sweth?: import("../types").Spool | undefined;
+        swusdc?: import("../types").Spool | undefined;
+        swusdt?: import("../types").Spool | undefined;
+        ssui?: import("../types").Spool | undefined;
+        scetus?: import("../types").Spool | undefined;
+        safsui?: import("../types").Spool | undefined;
+        shasui?: import("../types").Spool | undefined;
+        svsui?: import("../types").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, indexer?: boolean, args?: {
+        marketPool?: MarketPool;
+        coinPrices?: CoinPrices;
+    }): Promise<import("../types").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<import("../types").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<import("../types").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?: import("../types").StakePool | undefined;
+        sweth?: import("../types").StakePool | undefined;
+        swusdc?: import("../types").StakePool | undefined;
+        swusdt?: import("../types").StakePool | undefined;
+        ssui?: import("../types").StakePool | undefined;
+        scetus?: import("../types").StakePool | undefined;
+        safsui?: import("../types").StakePool | undefined;
+        shasui?: import("../types").StakePool | undefined;
+        svsui?: import("../types").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<import("../types").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?: import("../types").StakeRewardPool | undefined;
+        sweth?: import("../types").StakeRewardPool | undefined;
+        swusdc?: import("../types").StakeRewardPool | undefined;
+        swusdt?: import("../types").StakeRewardPool | undefined;
+        ssui?: import("../types").StakeRewardPool | undefined;
+        scetus?: import("../types").StakeRewardPool | undefined;
+        safsui?: import("../types").StakeRewardPool | undefined;
+        shasui?: import("../types").StakeRewardPool | undefined;
+        svsui?: import("../types").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<import("../types").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[], indexer?: boolean, args?: {
+        coinPrices: CoinPrices;
+    }): Promise<{
+        usdc?: import("../types").BorrowIncentivePool | undefined;
+        sbeth?: import("../types").BorrowIncentivePool | undefined;
+        weth?: import("../types").BorrowIncentivePool | undefined;
+        wusdc?: import("../types").BorrowIncentivePool | undefined;
+        wusdt?: import("../types").BorrowIncentivePool | undefined;
+        sui?: import("../types").BorrowIncentivePool | undefined;
+        afsui?: import("../types").BorrowIncentivePool | undefined;
+        hasui?: import("../types").BorrowIncentivePool | undefined;
+        vsui?: import("../types").BorrowIncentivePool | undefined;
+        sca?: import("../types").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, coinNames?: SupportBorrowIncentiveCoins[]): Promise<{
+        usdc?: import("../types").ParsedBorrowIncentiveAccountData | undefined;
+        sbeth?: import("../types").ParsedBorrowIncentiveAccountData | undefined;
+        weth?: import("../types").ParsedBorrowIncentiveAccountData | undefined;
+        wusdc?: import("../types").ParsedBorrowIncentiveAccountData | undefined;
+        wusdt?: import("../types").ParsedBorrowIncentiveAccountData | undefined;
+        sui?: import("../types").ParsedBorrowIncentiveAccountData | undefined;
+        afsui?: import("../types").ParsedBorrowIncentiveAccountData | undefined;
+        hasui?: import("../types").ParsedBorrowIncentiveAccountData | undefined;
+        vsui?: import("../types").ParsedBorrowIncentiveAccountData | undefined;
+        sca?: import("../types").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, indexer?: boolean): Promise<{
+        usdc?: import("../types").Lending | undefined;
+        sbeth?: import("../types").Lending | undefined;
+        weth?: import("../types").Lending | undefined;
+        wbtc?: import("../types").Lending | undefined;
+        wusdc?: import("../types").Lending | undefined;
+        wusdt?: import("../types").Lending | undefined;
+        sui?: import("../types").Lending | undefined;
+        wapt?: import("../types").Lending | undefined;
+        wsol?: import("../types").Lending | undefined;
+        cetus?: import("../types").Lending | undefined;
+        afsui?: import("../types").Lending | undefined;
+        hasui?: import("../types").Lending | undefined;
+        vsui?: import("../types").Lending | undefined;
+        sca?: import("../types").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, indexer?: boolean): Promise<import("../types").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, indexer?: boolean): Promise<{
+        [x: string]: import("../types").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, indexer?: boolean): Promise<import("../types").ObligationAccount>;
+    /**
+     * Get total value locked.
+     *
+     * @param indexer - Whether to use indexer.
+     * @description
+     * Include total supplied value and total borrowed value.
+     *
+     * @return Total value locked.
+     */
+    getTvl(indexer?: boolean): Promise<import("../types").TotalValueLocked>;
+    /**
+     * Get veSca data.
+     * @param veScaKey
+     * @returns veSca
+     */
+    getVeSca(veScaKey: string | SuiObjectData): Promise<import("../types").Vesca | undefined>;
+    /**
+     * Get all veSca from walletAdddress
+     * @param walletAddress
+     * @returns array of veSca
+     */
+    getVeScas({ walletAddress, excludeEmpty, }?: {
+        walletAddress?: string;
+        excludeEmpty?: boolean;
+    }): Promise<import("../types").Vesca[]>;
+    /**
+     * Get total vesca treasury with movecall
+     * @returns Promise<string | undefined>
+     */
+    getVeScaTreasuryInfo(): Promise<import("../types").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<import("../types").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<import("../types").OptionalKeys<Record<"susdc" | "ssbeth" | "sweth" | "swbtc" | "swusdc" | "swusdt" | "ssui" | "swsol" | "scetus" | "safsui" | "shasui" | "svsui" | "ssca", 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" | "weth" | "wbtc" | "wusdc" | "wusdt" | "sui" | "wapt" | "wsol" | "cetus" | "afsui" | "hasui" | "vsui" | "sca", number>>;
+    /**
+     * Get supply limit of supply pool
+     */
+    getPoolSupplyLimit(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>;
+}