@scallop-io/sui-scallop-sdk 2.3.0-lst-x-oracle-alpha.3 → 2.3.0-lst-x-oracle-alpha.5

package/dist/models/index.d.ts

@@ -1,393 +0,0 @@
-import { bc as ScallopClientInterface, S as ScallopBuilder, e as ScallopQuery, g as ScallopUtils, c as ScallopConstants, h as ScallopSuiKit, aE as Market, aF as Obligation, aH as ObligationQueryInterface, b3 as StakeAccounts, b4 as StakeAccount, b5 as StakePool, b6 as StakeRewardPool, k as ScallopTxBlock, bd as ScallopBuilderParams, d as ScallopIndexer } from '../scallopUtils-BZLZd2z8.js';
-export { a as ScallopAddress, b as ScallopAxios, f as ScallopQueryClient } from '../scallopUtils-BZLZd2z8.js';
-import { NetworkType, SuiObjectArg } from '@scallop-io/sui-kit';
-import { SuiTransactionBlockResponse } from '@mysten/sui/client';
-import { TransactionObjectArgument, Transaction, TransactionResult } from '@mysten/sui/transactions';
-import '@tanstack/query-core';
-import '../address-CW2IpaLn.js';
-import 'axios';
-import '@mysten/sui/dist/cjs/client';
-
-type ScallopClientParams = {
-    networkType?: NetworkType;
-    builder?: ScallopBuilder;
-} & ScallopBuilderParams;
-type ScallopClientFnReturnType<T extends boolean> = T extends true ? SuiTransactionBlockResponse : Transaction;
-type ScallopClientVeScaReturnType<T extends boolean> = T extends true ? SuiTransactionBlockResponse : {
-    tx: Transaction;
-    scaCoin: 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 implements ScallopClientInterface {
-    readonly builder: ScallopBuilder;
-    networkType: NetworkType;
-    constructor(params: ScallopClientParams);
-    get query(): ScallopQuery;
-    get utils(): ScallopUtils;
-    get constants(): ScallopConstants;
-    get walletAddress(): string;
-    get scallopSuiKit(): ScallopSuiKit;
-    get address(): ScallopConstants;
-    /**
-     * 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: string, 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: string): 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: string): 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: string, amount: number): Promise<SuiTransactionBlockResponse>;
-    depositCollateral<S extends boolean>(collateralCoinName: string, 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: string, 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: string, amount: number): Promise<SuiTransactionBlockResponse>;
-    deposit<S extends boolean>(poolCoinName: string, 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: string, amount: number): Promise<SuiTransactionBlockResponse>;
-    depositAndStake<S extends boolean>(stakeCoinName: string, 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: string, amount: number): Promise<SuiTransactionBlockResponse>;
-    withdraw<S extends boolean>(poolCoinName: string, 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: string, 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: string, 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: string, amount: number, callback: (txBlock: ScallopTxBlock, coin: TransactionObjectArgument | string) => SuiObjectArg): Promise<SuiTransactionBlockResponse>;
-    flashLoan<S extends boolean>(poolCoinName: string, 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: string): Promise<SuiTransactionBlockResponse>;
-    createStakeAccount<S extends boolean>(marketCoinName: string, 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: string, amount: number): Promise<SuiTransactionBlockResponse>;
-    stake<S extends boolean>(stakeMarketCoinName: string, 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: string, amount: number): Promise<SuiTransactionBlockResponse>;
-    unstake<S extends boolean>(stakeMarketCoinName: string, 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: string, amount: number): Promise<SuiTransactionBlockResponse>;
-    unstakeAndWithdraw<S extends boolean>(stakeMarketCoinName: string, 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: string): Promise<SuiTransactionBlockResponse>;
-    claim<S extends boolean>(stakeMarketCoinName: string, 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, walletAddress?: string): Promise<ScallopClientFnReturnType<S>>;
-    /**
-     * Claim unlocked SCA from all veSCA accounts.
-     */
-    claimAllUnlockedSca(): Promise<SuiTransactionBlockResponse>;
-    claimAllUnlockedSca<S extends boolean>(sign?: S, walletAddress?: string): 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<string, 'sui'>, amount: number): Promise<SuiTransactionBlockResponse>;
-    mintTestCoin<S extends boolean>(assetCoinName: Exclude<string, '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();
- * ```
- */
-type ScallopParams = {
-    client?: ScallopClient;
-} & ScallopClientParams;
-declare class Scallop {
-    readonly client: ScallopClient;
-    constructor(params: ScallopParams);
-    init(force?: boolean): Promise<void>;
-    /**
-     * Create a scallop client instance that already has initial data.
-     *
-     * @return Scallop Client.
-     */
-    createScallopClient(): Promise<ScallopClient>;
-    /**
-     * Create a scallop builder instance that already has initial data.
-     *
-     * @return Scallop Builder.
-     */
-    createScallopBuilder(): Promise<ScallopBuilder>;
-    /**
-     * Create a scallop query instance.
-     *
-     * @return Scallop Query.
-     */
-    createScallopQuery(): Promise<ScallopQuery>;
-    /**
-     * Create a scallop utils instance.
-     *
-     * @return Scallop Utils.
-     */
-    createScallopUtils(): Promise<ScallopUtils>;
-    /**
-     * Create a scallop indexer instance.
-     *
-     * @return Scallop Indexer.
-     */
-    createScallopIndexer(): Promise<ScallopIndexer>;
-    /**
-     * Get a scallop constants instance that already has initial data.
-     * @returns Scallop Constants
-     */
-    getScallopConstants(): Promise<ScallopConstants>;
-}
-
-export { Scallop, ScallopBuilder, ScallopClient, ScallopConstants, ScallopIndexer, ScallopQuery, ScallopSuiKit, ScallopUtils };