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

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 type { ScallopClientFnReturnType, ScallopClientParams, SupportPoolCoins, SupportCollateralCoins, SupportAssetCoins, SupportStakeCoins, SupportStakeMarketCoins, ScallopTxBlock, ScallopClientVeScaReturnType, ScallopClientInstanceParams } from '../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("../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("../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("../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("../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("../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("../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("../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>>;
-    /**
-     * 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>>;
-}

package/dist/models/scallopIndexer.d.ts

@@ -1,90 +0,0 @@
-import type { Market, MarketPools, MarketPool, MarketCollaterals, MarketCollateral, Spools, Spool, BorrowIncentivePools, BorrowIncentivePool, SupportPoolCoins, SupportCollateralCoins, SupportStakeMarketCoins, SupportBorrowIncentiveCoins, TotalValueLocked, ScallopQueryParams, ScallopParams, ScallopIndexerInstanceParams } from '../types';
-/**
- * @description
- * It provides methods to obtain sdk index data from mainnet.
- *
- *
- * @example
- * ```typescript
- * const scallopIndexer = new scallopIndexer(<parameters>);
- * scallopIndexer.<indexer functions>();
- * await scallopIndexer.<indexer async functions>();
- * ```
- */
-export 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>>;
-}