@scallop-io/sui-scallop-sdk 3.0.2 → 4.1.0

package/dist/client.d.cts

@@ -0,0 +1,401 @@
+import { S as ScallopBuilder, f as ScallopQuery, g as ScallopUtils, h as ScallopConstants, be as TransactionExecutor, bf as DefaultTxInclude, a as ScallopTxBlock, e as SuiObjectData, b as ScallopBuilderConstructorParams, bg as ScallopClientInterface, bh as OnChainDataSource, aw as ScallopAddress } from './query-DkitepDi.js';
+import * as _scallop_io_sui_kit from '@scallop-io/sui-kit';
+import { SuiObjectArg, SuiTransactionBlockResponse, NetworkType } from '@scallop-io/sui-kit';
+import { Transaction, TransactionObjectArgument, TransactionResult } from '@mysten/sui/transactions';
+import { SuiClientTypes } from '@mysten/sui/client';
+import '@tanstack/query-core';
+import './Logger-Cg2iFdpH.js';
+import 'axios';
+import '@mysten/sui/cryptography';
+import '@pythnetwork/pyth-sui-js';
+
+type ClientTxResult<S extends boolean, Include extends DefaultTxInclude = DefaultTxInclude> = S extends true ? SuiClientTypes.TransactionResult<Include> : Transaction;
+/**
+ * The exact surface that client-side application services consume. Derived
+ * structurally from the concrete model classes so the types stay in sync.
+ *
+ * `ScallopClient` is structurally assignable to this interface (it already
+ * exposes every member via fields/getters), which lets services accept either
+ * a `ScallopClient` or a hand-built fake without depending on the concrete
+ * class.
+ */
+interface ClientServiceContext {
+    readonly walletAddress: string;
+    readonly builder: Pick<ScallopBuilder, 'createTxBlock'>;
+    readonly query: Pick<ScallopQuery, 'getObligations' | 'getObligationAccount' | 'getStakeAccounts' | 'getVeScas'>;
+    readonly utils: Pick<ScallopUtils, 'logger' | 'mergeSimilarCoins' | 'parseCoinName' | 'parseCoinType' | 'parseMarketCoinName' | 'parseSCoinType'>;
+    readonly constants: Pick<ScallopConstants, 'whitelist'>;
+    readonly executor: TransactionExecutor;
+}
+
+declare class CollateralService {
+    private readonly ctx;
+    constructor(ctx: ClientServiceContext);
+    depositCollateral<S extends boolean>(collateralCoinName: string, amount: number, sign?: S, obligationId?: string, walletAddress?: string, isSponsoredTx?: boolean): Promise<ClientTxResult<S>>;
+    withdrawCollateral<S extends boolean>(collateralCoinName: string, amount: number, sign?: S, obligationId?: string, obligationKey?: string, walletAddress?: string, isSponsoredTx?: boolean): Promise<ClientTxResult<S>>;
+}
+
+declare class LendingService {
+    private readonly ctx;
+    constructor(ctx: ClientServiceContext);
+    supply<S extends boolean>(poolCoinName: string, amount: number, sign?: S, walletAddress?: string): Promise<ClientTxResult<S>>;
+    withdraw<S extends boolean>(poolCoinName: string, amount: number, sign?: S, walletAddress?: string): Promise<ClientTxResult<S>>;
+    flashLoan<S extends boolean>(poolCoinName: string, amount: number, callback: (txBlock: ScallopTxBlock, coin: TransactionObjectArgument | string) => SuiObjectArg | Promise<SuiObjectArg>, sign?: S, walletAddress?: string): Promise<ClientTxResult<S>>;
+}
+
+/**
+ * Application service for borrow-side lifecycle operations:
+ *  - obligation creation
+ *  - borrow / repay
+ *  - supply + auto-stake convenience
+ *  - borrow-incentive stake / unstake / claim
+ *
+ * Each method preserves the public ScallopClient signature one-to-one.
+ */
+declare class BorrowService {
+    private readonly ctx;
+    constructor(ctx: ClientServiceContext);
+    openObligation<S extends boolean>(sign?: S): Promise<ClientTxResult<S>>;
+    borrow<S extends boolean>(poolCoinName: string, amount: number, sign: S | undefined, obligationId: string, obligationKey: string, walletAddress?: string, isSponsoredTx?: boolean): Promise<ClientTxResult<S>>;
+    repay<S extends boolean>(poolCoinName: string, amount: number, sign: S | undefined, obligationId: string, obligationKey: string, walletAddress?: string, isSponsoredTx?: boolean): Promise<ClientTxResult<S>>;
+    supplyAndStake<S extends boolean>(stakeCoinName: string, amount: number, sign?: S, stakeAccountId?: string, walletAddress?: string): Promise<ClientTxResult<S>>;
+    stakeObligation<S extends boolean>(obligationId: string, obligationKeyId: string, sign?: S, walletAddress?: string): Promise<ClientTxResult<S>>;
+    unstakeObligation<S extends boolean>(obligationId: string, obligationKeyId: string, sign?: S, walletAddress?: string): Promise<ClientTxResult<S>>;
+    claimBorrowIncentive<S extends boolean>(obligationId: string, obligationKeyId: string, sign?: S, walletAddress?: string): Promise<ClientTxResult<S>>;
+}
+
+/**
+ * Application service for spool lifecycle:
+ *  - createStakeAccount
+ *  - stake / unstake
+ *  - unstake + auto-withdraw convenience
+ *  - claim spool rewards
+ */
+declare class SpoolService {
+    private readonly ctx;
+    constructor(ctx: ClientServiceContext);
+    createStakeAccount<S extends boolean>(marketCoinName: string, sign?: S, walletAddress?: string): Promise<ClientTxResult<S>>;
+    stake<S extends boolean>(stakeMarketCoinName: string, amount: number, sign?: S, stakeAccountId?: string, walletAddress?: string): Promise<ClientTxResult<S>>;
+    unstake<S extends boolean>(stakeMarketCoinName: string, amount: number, sign?: S, stakeAccountId?: string, walletAddress?: string): Promise<ClientTxResult<S>>;
+    unstakeAndWithdraw<S extends boolean>(stakeMarketCoinName: string, amount: number, sign?: S, stakeAccountId?: string, walletAddress?: string): Promise<ClientTxResult<S>>;
+    claim<S extends boolean>(stakeMarketCoinName: string, sign?: S, stakeAccountId?: string, walletAddress?: string): Promise<ClientTxResult<S>>;
+}
+
+type VeScaClaimResult<S extends boolean> = S extends true ? SuiTransactionBlockResponse : {
+    tx: Transaction;
+    scaCoin: TransactionResult;
+};
+type SignedOrTx<S extends boolean> = S extends true ? SuiTransactionBlockResponse : Transaction;
+/**
+ * Application service for veSCA operations:
+ *  - lock / extend / claim helpers (thin wrappers over the tx-block quick
+ *    methods, so callers can stay on the service object instead of touching
+ *    `tx` directly).
+ *  - claim-all-unlocked-SCA aggregation across every veSCA owned by the
+ *    wallet (parity with the legacy ScallopClient method).
+ */
+declare class VeScaService {
+    private readonly ctx;
+    constructor(ctx: ClientServiceContext);
+    lockSca<S extends boolean>(params: {
+        amountOrCoin?: SuiObjectArg | number;
+        lockPeriodInDays?: number;
+        autoCheck?: boolean;
+        veScaKey?: SuiObjectData | string;
+    }, sign?: S, walletAddress?: string): Promise<SignedOrTx<S>>;
+    extendLockPeriod<S extends boolean>(params: {
+        lockPeriodInDays: number;
+        autoCheck?: boolean;
+        veScaKey?: SuiObjectData | string;
+    }, sign?: S, walletAddress?: string): Promise<SignedOrTx<S>>;
+    extendLockAmount<S extends boolean>(params: {
+        scaAmount: number;
+        autoCheck?: boolean;
+        veScaKey?: SuiObjectData | string;
+    }, sign?: S, walletAddress?: string): Promise<SignedOrTx<S>>;
+    claimAllUnlockedSca<S extends boolean>(sign?: S, walletAddress?: string): Promise<VeScaClaimResult<S>>;
+}
+
+/**
+ * Application service for referral lifecycle:
+ *  - bindToReferral
+ *  - claimReferralRevenue
+ *  - burnReferralTicket
+ *
+ * Thin wrappers around the tx-block referral methods so callers can stay on
+ * the service object instead of touching `tx` directly.
+ */
+declare class ReferralService {
+    private readonly ctx;
+    constructor(ctx: ClientServiceContext);
+    bindToReferral<S extends boolean>(veScaKeyId: string, sign?: S, walletAddress?: string): Promise<ClientTxResult<S>>;
+    claimReferralRevenue<S extends boolean>(veScaKey: SuiObjectArg, coinNames?: string[], sign?: S, walletAddress?: string): Promise<ClientTxResult<S>>;
+    burnReferralTicket<S extends boolean>(ticket: SuiObjectArg, poolCoinName: string, sign?: S, walletAddress?: string): Promise<ClientTxResult<S>>;
+}
+
+type ScallopClientConstructorParams = {
+    networkType?: SuiClientTypes.Network;
+    builder?: ScallopBuilder;
+} & ScallopBuilderConstructorParams;
+type ScallopClientFnReturnType<T extends boolean, Include extends DefaultTxInclude = DefaultTxInclude> = T extends true ? SuiClientTypes.TransactionResult<Include> : Transaction;
+type ScallopClientVeScaReturnType<T extends boolean, Include extends DefaultTxInclude = DefaultTxInclude> = T extends true ? SuiClientTypes.TransactionResult<Include> : {
+    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;
+    readonly collateralService: CollateralService;
+    readonly lendingService: LendingService;
+    readonly borrowService: BorrowService;
+    readonly spoolService: SpoolService;
+    readonly veScaService: VeScaService;
+    readonly referralService: ReferralService;
+    networkType: NetworkType;
+    constructor({ builder, networkType, ...scallopBuilderArgs }: ScallopClientConstructorParams);
+    get query(): ScallopQuery;
+    get utils(): ScallopUtils;
+    get constants(): ScallopConstants;
+    get walletAddress(): string;
+    get suiKit(): _scallop_io_sui_kit.SuiKit;
+    get onchain(): OnChainDataSource;
+    get executor(): TransactionExecutor;
+    get address(): ScallopAddress;
+    /**
+     * Request the scallop API to initialize data.
+     *
+     * @param force - Whether to force initialization.
+     */
+    init(force?: boolean): Promise<void>;
+    /**
+     * 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.
+     * @param isSponsoredTx - Whether the transaction is sponsored.
+     * @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, isSponsoredTx?: boolean): 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.
+     * @param isSponsoredTx - Whether the transaction is sponsored.
+     * @return Transaction block response or transaction block.
+     */
+    withdrawCollateral(collateralCoinName: string, amount: number): Promise<SuiTransactionBlockResponse>;
+    withdrawCollateral<S extends boolean>(collateralCoinName: string, amount: number, sign?: S, obligationId?: string, obligationKey?: string, walletAddress?: string, isSponsoredTx?: boolean): Promise<ScallopClientFnReturnType<S>>;
+    /**
+     * Supply asset into the specific lending 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.
+     */
+    supply(poolCoinName: string, amount: number): Promise<SuiTransactionBlockResponse>;
+    supply<S extends boolean>(poolCoinName: string, amount: number, sign?: S, walletAddress?: string): Promise<ScallopClientFnReturnType<S>>;
+    /**
+     * Supply asset into the specific lending pool and stake market coin into the corresponding staking pool (spool).
+     *
+     * @param stakeCoinName - Types of stake coin.
+     * @param amount - The amount of coins would supply.
+     * @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.
+     */
+    supplyAndStake(stakeCoinName: string, amount: number): Promise<SuiTransactionBlockResponse>;
+    supplyAndStake<S extends boolean>(stakeCoinName: string, amount: number, sign?: S, stakeAccountId?: string, walletAddress?: string): Promise<ScallopClientFnReturnType<S>>;
+    /**
+     * Withdraw asset from the specific lending 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.
+     * @param isSponsoredTx - Whether the transaction is sponsored.
+     * @return Transaction block response or transaction block.
+     */
+    borrow<S extends boolean>(poolCoinName: string, amount: number, sign: S | undefined, obligationId: string, obligationKey: string, walletAddress?: string, isSponsoredTx?: boolean): 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.
+     * @param isSponsoredTx - Whether the transaction is sponsored.
+     * @return Transaction block response or transaction block.
+     */
+    repay<S extends boolean>(poolCoinName: string, amount: number, sign: S | undefined, obligationId: string, obligationKey: string, walletAddress?: string, isSponsoredTx?: boolean): 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>>;
+}
+
+export { ScallopClient, type ScallopClientConstructorParams };